diff options
Diffstat (limited to 'doc/source/command-objects')
| -rw-r--r-- | doc/source/command-objects/consistency-group-snapshot.rst | 96 | ||||
| -rw-r--r-- | doc/source/command-objects/consistency-group.rst | 74 | ||||
| -rw-r--r-- | doc/source/command-objects/floating-ip.rst | 21 | ||||
| -rw-r--r-- | doc/source/command-objects/image.rst | 8 | ||||
| -rw-r--r-- | doc/source/command-objects/network-rbac.rst | 2 | ||||
| -rw-r--r-- | doc/source/command-objects/network-service-provider.rst | 18 | ||||
| -rw-r--r-- | doc/source/command-objects/network.rst | 59 | ||||
| -rw-r--r-- | doc/source/command-objects/port.rst | 33 | ||||
| -rw-r--r-- | doc/source/command-objects/security-group-rule.rst | 41 | ||||
| -rw-r--r-- | doc/source/command-objects/subnet.rst | 8 | ||||
| -rw-r--r-- | doc/source/command-objects/volume-backup.rst | 36 | ||||
| -rw-r--r-- | doc/source/command-objects/volume.rst | 67 |
12 files changed, 454 insertions, 9 deletions
diff --git a/doc/source/command-objects/consistency-group-snapshot.rst b/doc/source/command-objects/consistency-group-snapshot.rst new file mode 100644 index 00000000..b7b1423e --- /dev/null +++ b/doc/source/command-objects/consistency-group-snapshot.rst @@ -0,0 +1,96 @@ +========================== +consistency group snapshot +========================== + +Block Storage v2 + +consistency group snapshot create +--------------------------------- + +Create new consistency group snapshot. + +.. program:: consistency group snapshot create +.. code:: bash + + os consistency group snapshot create + [--consistency-group <consistency-group>] + [--description <description>] + [<snapshot-name>] + +.. option:: --consistency-group <consistency-group> + + Consistency group to snapshot (name or ID) + (default to be the same as <snapshot-name>) + +.. option:: --description <description> + + Description of this consistency group snapshot + +.. _consistency_group_snapshot_create-snapshot-name: +.. option:: <snapshot-name> + + Name of new consistency group snapshot (default to None) + +consistency group snapshot delete +--------------------------------- + +Delete consistency group snapshot(s) + +.. program:: consistency group snapshot delete +.. code:: bash + + os consistency group snapshot delete + <consistency-group-snapshot> [<consistency-group-snapshot> ...] + +.. _consistency_group_snapshot_delete-consistency-group-snapshot: +.. describe:: <consistency-group-snapshot> + + Consistency group snapshot(s) to delete (name or ID) + +consistency group snapshot list +------------------------------- + +List consistency group snapshots. + +.. program:: consistency group snapshot list +.. code:: bash + + os consistency group snapshot list + [--all-projects] + [--long] + [--status <status>] + [--consistency-group <consistency-group>] + +.. option:: --all-projects + + Show detail for all projects. Admin only. + (defaults to False) + +.. option:: --long + + List additional fields in output + +.. option:: --status <status> + + Filters results by a status + ("available", "error", "creating", "deleting" or "error_deleting") + +.. option:: --consistency-group <consistency-group> + + Filters results by a consistency group (name or ID) + +consistency group snapshot show +------------------------------- + +Display consistency group snapshot details. + +.. program:: consistency group snapshot show +.. code:: bash + + os consistency group snapshot show + <consistency-group-snapshot> + +.. _consistency_group_snapshot_show-consistency-group-snapshot: +.. describe:: <consistency-group-snapshot> + + Consistency group snapshot to display (name or ID) diff --git a/doc/source/command-objects/consistency-group.rst b/doc/source/command-objects/consistency-group.rst index f24df0d1..46682a56 100644 --- a/doc/source/command-objects/consistency-group.rst +++ b/doc/source/command-objects/consistency-group.rst @@ -4,6 +4,63 @@ consistency group Block Storage v2 +consistency group create +------------------------ + +Create new consistency group. + +.. program:: consistency group create +.. code:: bash + + os consistency group create + --volume-type <volume-type> | --consistency-group-source <consistency-group> + [--description <description>] + [--availability-zone <availability-zone>] + [<name>] + +.. option:: --volume-type <volume-type> + + Volume type of this consistency group (name or ID) + +.. option:: --consistency-group-source <consistency-group> + + Existing consistency group (name or ID) + +.. option:: --description <description> + + Description of this consistency group + +.. option:: --availability-zone <availability-zone> + + Availability zone for this consistency group + (not available if creating consistency group from source) + +.. _consistency_group_create-name: +.. option:: <name> + + Name of new consistency group (default to None) + +consistency group delete +------------------------ + +Delete consistency group(s). + +.. program:: consistency group delete +.. code:: bash + + os consistency group delete + [--force] + <consistency-group> [<consistency-group> ...] + +.. option:: --force + + Allow delete in state other than error or available + +.. _consistency_group_delete-consistency-group: +.. describe:: <consistency-group> + + Consistency group(s) to delete (name or ID) + consistency group list ---------------------- @@ -24,3 +81,20 @@ List consistency groups. .. option:: --long List additional fields in output + +consistency group show +---------------------- + +Display consistency group details. + +.. program:: consistency group show +.. code:: bash + + os consistency group show + <consistency-group> + +.. _consistency_group_show-consistency-group: +.. describe:: <consistency-group> + + Consistency group to display (name or ID) + diff --git a/doc/source/command-objects/floating-ip.rst b/doc/source/command-objects/floating-ip.rst index 2ab21f36..b2cc8af0 100644 --- a/doc/source/command-objects/floating-ip.rst +++ b/doc/source/command-objects/floating-ip.rst @@ -72,6 +72,27 @@ List floating IP(s) .. code:: bash os floating ip list + [--network <network>] + [--port <port>] + [--fixed-ip-address <fixed-ip-address>] + +.. option:: --network <network> + + List floating IP(s) according to given network (name or ID) + + *Network version 2 only* + +.. option:: --port <port> + + List floating IP(s) according to given port (name or ID) + + *Network version 2 only* + +.. option:: --fixed-ip-address <fixed-ip-address> + + List floating IP(s) according to given fixed IP address + + *Network version 2 only* floating ip show ---------------- diff --git a/doc/source/command-objects/image.rst b/doc/source/command-objects/image.rst index 842eab8d..7fc33c69 100644 --- a/doc/source/command-objects/image.rst +++ b/doc/source/command-objects/image.rst @@ -78,7 +78,8 @@ Create/upload an image .. option:: --disk-format <disk-format> - Image disk format (default: raw) + Image disk format. The supported options are: ami, ari, aki, vhd, vmdk, + raw, qcow2, vhdx, vdi, and iso. The default format is: raw .. option:: --size <size> @@ -221,7 +222,7 @@ List available images .. option:: --sort <key>[:<direction>] - Sort output by selected keys and directions(asc or desc) (default: asc), + Sort output by selected keys and directions(asc or desc) (default: name:asc), multiple keys and directions can be specified separated by comma .. option:: --limit <limit> @@ -337,7 +338,8 @@ Set image properties .. option:: --disk-format <disk-format> - Image disk format (default: raw) + Image disk format. The supported options are: ami, ari, aki, vhd, vmdk, + raw, qcow2, vhdx, vdi, and iso. .. option:: --size <size> diff --git a/doc/source/command-objects/network-rbac.rst b/doc/source/command-objects/network-rbac.rst index 8acf0979..113242f4 100644 --- a/doc/source/command-objects/network-rbac.rst +++ b/doc/source/command-objects/network-rbac.rst @@ -52,7 +52,7 @@ Create network RBAC policy .. _network_rbac_create-rbac-policy: .. describe:: <rbac-object> - The object to which this RBAC policy affects (name or ID for network objects, ID only for QoS policy objects) + The object to which this RBAC policy affects (name or ID) network rbac delete ------------------- diff --git a/doc/source/command-objects/network-service-provider.rst b/doc/source/command-objects/network-service-provider.rst new file mode 100644 index 00000000..344bb880 --- /dev/null +++ b/doc/source/command-objects/network-service-provider.rst @@ -0,0 +1,18 @@ +======================== +network service provider +======================== + +A **network service provider** is a particular driver that implements a +networking service + +Network v2 + +network service provider list +----------------------------- + +List service providers + +.. program:: network service provider list +.. code:: bash + + os network service provider list diff --git a/doc/source/command-objects/network.rst b/doc/source/command-objects/network.rst index d133674f..06a5247a 100644 --- a/doc/source/command-objects/network.rst +++ b/doc/source/command-objects/network.rst @@ -30,6 +30,7 @@ Create new network [--provider-network-type <provider-network-type>] [--provider-physical-network <provider-physical-network>] [--provider-segment <provider-segment>] + [--qos-policy <qos-policy>] [--transparent-vlan | --no-transparent-vlan] <name> @@ -144,6 +145,12 @@ Create new network *Network version 2 only* +.. option:: --qos-policy <qos-policy> + + QoS policy to attach to this network (name or ID) + + *Network version 2 only* + .. option:: --transparent-vlan Make the network VLAN transparent @@ -193,53 +200,96 @@ List networks [--project <project> [--project-domain <project-domain>]] [--share | --no-share] [--status <status>] + [--provider-network-type <provider-network-type>] + [--provider-physical-network <provider-physical-network>] + [--provider-segment <provider-segment>] .. option:: --external List external networks + *Network version 2 only* + .. option:: --internal List internal networks + *Network version 2 only* + .. option:: --long List additional fields in output + *Network version 2 only* + .. option:: --name <name> List networks according to their name + *Network version 2 only* + .. option:: --enable List enabled networks + *Network version 2 only* + .. option:: --disable List disabled networks + *Network version 2 only* + .. option:: --project <project> List networks according to their project (name or ID) + *Network version 2 only* + .. option:: --project-domain <project-domain> Domain the project belongs to (name or ID). This can be used in case collisions between project names exist. + *Network version 2 only* + .. option:: --share List networks shared between projects + *Network version 2 only* + .. option:: --no-share List networks not shared between projects + *Network version 2 only* + .. option:: --status <status> List networks according to their status ('ACTIVE', 'BUILD', 'DOWN', 'ERROR') +.. option:: --provider-network-type <provider-network-type> + + List networks according to their physical mechanisms. + The supported options are: flat, geneve, gre, local, vlan, vxlan. + + *Network version 2 only* + +.. option:: --provider-physical-network <provider-physical-network> + + List networks according to name of the physical network + + *Network version 2 only* + +.. option:: --provider-segment <provider-segment> + + List networks according to VLAN ID for VLAN networks + or Tunnel ID for GENEVE/GRE/VXLAN networks + + *Network version 2 only* + network set ----------- @@ -260,6 +310,7 @@ Set network properties [--provider-network-type <provider-network-type>] [--provider-physical-network <provider-physical-network>] [--provider-segment <provider-segment>] + [--qos-policy <qos-policy> | --no-qos-policy] [--transparent-vlan | --no-transparent-vlan] <network> @@ -327,6 +378,14 @@ Set network properties VLAN ID for VLAN networks or Tunnel ID for GRE/VXLAN networks +.. option:: --qos-policy <qos-policy> + + QoS policy to attach to this network (name or ID) + +.. option:: --no-qos-policy + + Remove the QoS policy attached to this network + .. option:: --transparent-vlan Make the network VLAN transparent diff --git a/doc/source/command-objects/port.rst b/doc/source/command-objects/port.rst index fe256d09..3aff2f77 100644 --- a/doc/source/command-objects/port.rst +++ b/doc/source/command-objects/port.rst @@ -18,6 +18,7 @@ Create new port os port create --network <network> + [--description <description>] [--fixed-ip subnet=<subnet>,ip-address=<ip-address>] [--device <device-id>] [--device-owner <device-owner>] @@ -28,12 +29,17 @@ Create new port [--mac-address <mac-address>] [--security-group <security-group> | --no-security-group] [--project <project> [--project-domain <project-domain>]] + [--enable-port-security | --disable-port-security] <name> .. option:: --network <network> Network this port belongs to (name or ID) +.. option:: --description <description> + + Description of this port + .. option:: --fixed-ip subnet=<subnet>,ip-address=<ip-address> Desired IP and/or subnet (name or ID) for this port: @@ -94,6 +100,14 @@ Create new port Domain the project belongs to (name or ID). This can be used in case collisions between project names exist. +.. option:: --enable-port-security + + Enable port security for this port (Default) + +.. option:: --disable-port-security + + Disable port security for this port + .. _port_create-name: .. describe:: <name> @@ -127,6 +141,7 @@ List ports [--device-owner <device-owner>] [--router <router> | --server <server>] [--network <network>] + [--mac-address <mac-address>] [--long] .. option:: --device-owner <device-owner> @@ -146,6 +161,10 @@ List ports List only ports attached to this network (name or ID) +.. option:: --mac-address <mac-address> + + List only ports with this MAC address + .. option:: --long List additional fields in output @@ -159,6 +178,7 @@ Set port properties .. code:: bash os port set + [--description <description>] [--fixed-ip subnet=<subnet>,ip-address=<ip-address>] [--no-fixed-ip] [--device <device-id>] @@ -171,8 +191,13 @@ Set port properties [--name <name>] [--security-group <security-group>] [--no-security-group] + [--enable-port-security | --disable-port-security] <port> +.. option:: --description <description> + + Description of this port + .. option:: --fixed-ip subnet=<subnet>,ip-address=<ip-address> Desired IP and/or subnet (name or ID) for this port: @@ -236,6 +261,14 @@ Set port properties Clear existing security groups associated with this port +.. option:: --enable-port-security + + Enable port security for this port + +.. option:: --disable-port-security + + Disable port security for this port + .. _port_set-port: .. describe:: <port> diff --git a/doc/source/command-objects/security-group-rule.rst b/doc/source/command-objects/security-group-rule.rst index 5284b2dc..f53389cc 100644 --- a/doc/source/command-objects/security-group-rule.rst +++ b/doc/source/command-objects/security-group-rule.rst @@ -16,22 +16,23 @@ Create a new security group rule .. code:: bash os security group rule create - [--src-ip <ip-address> | --src-group <group>] + [--remote-ip <ip-address> | --remote-group <group>] [--dst-port <port-range> | [--icmp-type <icmp-type> [--icmp-code <icmp-code>]]] [--protocol <protocol>] [--ingress | --egress] [--ethertype <ethertype>] [--project <project> [--project-domain <project-domain>]] + [--description <description>] <group> -.. option:: --src-ip <ip-address> +.. option:: --remote-ip <ip-address> - Source IP address block + Remote IP address block (may use CIDR notation; default for IPv4 rule: 0.0.0.0/0) -.. option:: --src-group <group> +.. option:: --remote-group <group> - Source security group (name or ID) + Remote security group (name or ID) .. option:: --dst-port <port-range> @@ -97,6 +98,12 @@ Create a new security group rule *Network version 2 only* +.. option:: --description <description> + + Set security group rule description + + *Network version 2 only* + .. describe:: <group> Create rule in this security group (name or ID) @@ -126,6 +133,8 @@ List security group rules os security group rule list [--all-projects] + [--protocol <protocol>] + [--ingress | --egress] [--long] [<group>] @@ -142,6 +151,28 @@ List security group rules *Compute version 2 does not have additional fields to display.* + +.. option:: --protocol + + List rules by the IP protocol (ah, dhcp, egp, esp, gre, icmp, igmp, + ipv6-encap, ipv6-frag, ipv6-icmp, ipv6-nonxt,ipv6-opts, ipv6-route, + ospf, pgm, rsvp, sctp, tcp, udp, udplite, vrrp and integer + representations [0-255]) + + *Network version 2* + +.. option:: --ingress + + List rules applied to incoming network traffic + + *Network version 2 only* + +.. option:: --egress + + List rules applied to outgoing network traffic + + *Network version 2 only* + .. describe:: <group> List all rules in this security group (name or ID) diff --git a/doc/source/command-objects/subnet.rst b/doc/source/command-objects/subnet.rst index e2059875..61526192 100644 --- a/doc/source/command-objects/subnet.rst +++ b/doc/source/command-objects/subnet.rst @@ -231,6 +231,7 @@ Set subnet properties [--no-allocation-pool] [--dhcp | --no-dhcp] [--dns-nameserver <dns-nameserver>] + [--no-dns-nameserver] [--gateway <gateway-ip>] [--host-route destination=<subnet>,gateway=<ip-address>] [--no-host-route] @@ -263,6 +264,12 @@ Set subnet properties DNS server for this subnet (repeat option to set multiple DNS servers) +.. option:: --no-dns-nameservers + + Clear existing information of DNS servers. + Specify both --dns-nameserver and --no-dns-nameservers + to overwrite the current DNS server information. + .. option:: --gateway <gateway> Specify a gateway for the subnet. The options are: @@ -289,6 +296,7 @@ Set subnet properties ``network:floatingip_agent_gateway``. Must be a valid device owner value for a network port (repeat option to set multiple service types) + .. option:: --description <description> Set subnet description diff --git a/doc/source/command-objects/volume-backup.rst b/doc/source/command-objects/volume-backup.rst index 246fd38e..2cccffae 100644 --- a/doc/source/command-objects/volume-backup.rst +++ b/doc/source/command-objects/volume-backup.rst @@ -88,12 +88,48 @@ List volume backups .. code:: bash os volume backup list + [--long] + [--name <name>] + [--status <status>] + [--volume <volume>] + [--marker <marker>] + [--limit <limit>] + [--all-projects] .. _volume_backup_list-backup: .. option:: --long List additional fields in output +.. options:: --name <name> + + Filters results by the backup name + +.. options:: --status <status> + + Filters results by the backup status + ('creating', 'available', 'deleting', 'error', 'restoring' or 'error_restoring') + +.. options:: --volume <volume> + + Filters results by the volume which they backup (name or ID)" + +.. options:: --marker <marker> + + The last backup of the previous page (name or ID) + + *Volume version 2 only* + +.. options:: --limit <limit> + + Maximum number of backups to display + + *Volume version 2 only* + +.. option:: --all-projects + + Include all projects (admin only) + volume backup restore --------------------- diff --git a/doc/source/command-objects/volume.rst b/doc/source/command-objects/volume.rst index 8f123361..df4d6880 100644 --- a/doc/source/command-objects/volume.rst +++ b/doc/source/command-objects/volume.rst @@ -197,6 +197,48 @@ List volumes *Volume version 2 only* +volume migrate +-------------- + +Migrate volume to a new host + +.. program:: volume migrate +.. code:: bash + + os volume migrate + --host <host> + [--force-host-copy] + [--lock-volume | --unlock-volume] + <volume> + +.. option:: --host <host> + + Destination host (takes the form: host@backend-name#pool) (required) + +.. option:: --force-host-copy + + Enable generic host-based force-migration, + which bypasses driver optimizations + +.. option:: --lock-volume + + If specified, the volume state will be locked and will not allow + a migration to be aborted (possibly by another operation) + + *Volume version 2 only* + +.. option:: --unlock-volume + + If specified, the volume state will not be locked and the a + migration can be aborted (default) (possibly by another operation) + + *Volume version 2 only* + +.. _volume_migrate-volume: +.. describe:: <volume> + + Volume to migrate (name or ID) + volume set ---------- @@ -212,7 +254,10 @@ Set volume properties [--property <key=value> [...] ] [--image-property <key=value> [...] ] [--state <state>] + [--type <volume-type>] + [--retype-policy <retype-policy>] [--bootable | --non-bootable] + [--read-only | --read-write] <volume> .. option:: --name <name> @@ -231,6 +276,20 @@ Set volume properties Set a property on this volume (repeat option to set multiple properties) +.. option:: --type <volume-type> + + New volume type (name or ID) + + *Volume version 2 only* + +.. option:: --retype-policy <retype-policy> + + Migration policy while re-typing volume + ("never" or "on-demand", default is "never" ) + (available only when "--type" option is specified) + + *Volume version 2 only* + .. option:: --bootable Mark volume as bootable @@ -239,6 +298,14 @@ Set volume properties Mark volume as non-bootable +.. option:: --read-only + + Set volume to read-only access mode + +.. option:: --read-write + + Set volume to read-write access mode + .. option:: --image-property <key=value> Set an image property on this volume |