diff options
Diffstat (limited to 'doc/source/command-objects')
| -rw-r--r-- | doc/source/command-objects/address-scope.rst | 29 | ||||
| -rw-r--r-- | doc/source/command-objects/consistency-group-snapshot.rst | 96 | ||||
| -rw-r--r-- | doc/source/command-objects/consistency-group.rst | 103 | ||||
| -rw-r--r-- | doc/source/command-objects/floating-ip.rst | 49 | ||||
| -rw-r--r-- | doc/source/command-objects/image.rst | 8 | ||||
| -rw-r--r-- | doc/source/command-objects/port.rst | 30 | ||||
| -rw-r--r-- | doc/source/command-objects/router.rst | 10 | ||||
| -rw-r--r-- | doc/source/command-objects/security-group.rst | 14 | ||||
| -rw-r--r-- | doc/source/command-objects/snapshot.rst | 6 | ||||
| -rw-r--r-- | doc/source/command-objects/subnet.rst | 7 | ||||
| -rw-r--r-- | doc/source/command-objects/volume-host.rst | 30 | ||||
| -rw-r--r-- | doc/source/command-objects/volume-qos.rst | 9 | ||||
| -rw-r--r-- | doc/source/command-objects/volume-snapshot.rst | 201 | ||||
| -rw-r--r-- | doc/source/command-objects/volume-type.rst | 8 | ||||
| -rw-r--r-- | doc/source/command-objects/volume.rst | 34 |
15 files changed, 629 insertions, 5 deletions
diff --git a/doc/source/command-objects/address-scope.rst b/doc/source/command-objects/address-scope.rst index 7481ed53..f7572d97 100644 --- a/doc/source/command-objects/address-scope.rst +++ b/doc/source/command-objects/address-scope.rst @@ -72,6 +72,35 @@ List address scopes .. code:: bash os address scope list + [--name <name>] + [--ip-version <ip-version>] + [--project <project> [--project-domain <project-domain>]] + [--share | --no-share] + +.. option:: --name <name> + + List only address scopes of given name in output + +.. option:: --ip-version <ip-version> + + List address scopes of given IP version networks (4 or 6) + +.. option:: --project <project> + + List address scopes according to their project (name or ID) + +.. option:: --project-domain <project-domain> + + Domain the project belongs to (name or ID). + This can be used in case collisions between project names exist. + +.. option:: --share + + List address scopes shared between projects + +.. option:: --no-share + + List address scopes not shared between projects address scope set ----------------- 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..910fbba9 100644 --- a/doc/source/command-objects/consistency-group.rst +++ b/doc/source/command-objects/consistency-group.rst @@ -4,6 +4,67 @@ 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> | --consistency-group-snapshot <consistency-group-snapshot> + [--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:: --consistency-group-snapshot <consistency-group-snapshot> + + Existing consistency group snapshot (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 +85,45 @@ List consistency groups. .. option:: --long List additional fields in output + +consistency group set +--------------------- + +Set consistency group properties. + +.. program:: consistency group set + .. code:: bash + + os consistency group set + [--name <name>] + [--description <description>] + <consistency-group> + +.. option:: --name <name> + + New consistency group name + +.. option:: --description <description> + + New consistency group description + +.. _consistency_group_set-consistency-group: +.. describe:: <consistency-group> + + Consistency group to modify (name or ID) + +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 b2cc8af0..57dc0ccb 100644 --- a/doc/source/command-objects/floating-ip.rst +++ b/doc/source/command-objects/floating-ip.rst @@ -18,6 +18,7 @@ Create floating IP [--floating-ip-address <floating-ip-address>] [--fixed-ip-address <fixed-ip-address>] [--description <description>] + [--project <project> [--project-domain <project-domain>]] <network> .. option:: --subnet <subnet> @@ -45,6 +46,19 @@ Create floating IP Set floating IP description *Network version 2 only* +.. option:: --project <project> + + Owner's 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* + .. describe:: <network> Network to allocate floating IP from (name or ID) @@ -75,6 +89,10 @@ List floating IP(s) [--network <network>] [--port <port>] [--fixed-ip-address <fixed-ip-address>] + [--long] + [--status <status>] + [--project <project> [--project-domain <project-domain>]] + [--router <router>] .. option:: --network <network> @@ -94,6 +112,37 @@ List floating IP(s) *Network version 2 only* +.. option:: --long + + List additional fields in output + + *Network version 2 only* + +.. option:: --status <status> + + List floating IP(s) according to given status ('ACTIVE', 'DOWN') + + *Network version 2 only* + +.. option:: --project <project> + + List floating IP(s) according to given 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:: --router <router> + + List floating IP(s) according to given router (name or ID) + + *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..9564f099 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, iso, and ploop. 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, iso, and ploop. .. option:: --size <size> diff --git a/doc/source/command-objects/port.rst b/doc/source/command-objects/port.rst index 173d99b1..73c53290 100644 --- a/doc/source/command-objects/port.rst +++ b/doc/source/command-objects/port.rst @@ -28,7 +28,9 @@ Create new port [--enable | --disable] [--mac-address <mac-address>] [--security-group <security-group> | --no-security-group] + [--dns-name <dns-name>] [--project <project> [--project-domain <project-domain>]] + [--enable-port-security | --disable-port-security] <name> .. option:: --network <network> @@ -90,6 +92,11 @@ Create new port Associate no security groups with this port +.. option:: --dns-name <dns-name> + + Set DNS name to this port + (requires DNS integration extension) + .. option:: --project <project> Owner's project (name or ID) @@ -99,6 +106,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> @@ -182,6 +197,8 @@ Set port properties [--name <name>] [--security-group <security-group>] [--no-security-group] + [--enable-port-security | --disable-port-security] + [--dns-name <dns-name>] <port> .. option:: --description <description> @@ -251,6 +268,19 @@ 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 + +.. option:: --dns-name <dns-name> + + Set DNS name to this port + (requires DNS integration extension) + .. _port_set-port: .. describe:: <port> diff --git a/doc/source/command-objects/router.rst b/doc/source/command-objects/router.rst index 22c41490..16a8258d 100644 --- a/doc/source/command-objects/router.rst +++ b/doc/source/command-objects/router.rst @@ -137,6 +137,7 @@ List routers [--name <name>] [--enable | --disable] [--long] + [--project <project> [--project-domain <project-domain>]] .. option:: --long @@ -154,6 +155,15 @@ List routers List disabled routers +.. option:: --project <project> + + List routers according to their project (name or ID) + +.. option:: --project-domain <project-domain> + + Domain the project belongs to (name or ID). + This can be used in case collisions between project names exist. + router remove port ------------------ diff --git a/doc/source/command-objects/security-group.rst b/doc/source/command-objects/security-group.rst index ba054554..5157f530 100644 --- a/doc/source/command-objects/security-group.rst +++ b/doc/source/command-objects/security-group.rst @@ -67,6 +67,7 @@ List security groups os security group list [--all-projects] + [--project <project> [--project-domain <project-domain>]] .. option:: --all-projects @@ -75,6 +76,19 @@ List security groups *Network version 2 ignores this option and will always display information* *for all projects (admin only).* +.. option:: --project <project> + + List security groups according to the 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* + security group set ------------------ diff --git a/doc/source/command-objects/snapshot.rst b/doc/source/command-objects/snapshot.rst index a2709adb..e75693ca 100644 --- a/doc/source/command-objects/snapshot.rst +++ b/doc/source/command-objects/snapshot.rst @@ -8,6 +8,7 @@ snapshot create --------------- Create new snapshot +(Deprecated, please use ``volume snapshot create`` instead) .. program:: snapshot create .. code:: bash @@ -46,6 +47,7 @@ snapshot delete --------------- Delete snapshot(s) +(Deprecated, please use ``volume snapshot delete`` instead) .. program:: snapshot delete .. code:: bash @@ -62,6 +64,7 @@ snapshot list ------------- List snapshots +(Deprecated, please use ``volume snapshot list`` instead) .. program:: snapshot list .. code:: bash @@ -96,6 +99,7 @@ snapshot set ------------ Set snapshot properties +(Deprecated, please use ``volume snapshot set`` instead) .. program:: snapshot set .. code:: bash @@ -137,6 +141,7 @@ snapshot show ------------- Display snapshot details +(Deprecated, please use ``volume snapshot show`` instead) .. program:: snapshot show .. code:: bash @@ -153,6 +158,7 @@ snapshot unset -------------- Unset snapshot properties +(Deprecated, please use ``volume snapshot unset`` instead) .. program:: snapshot unset .. code:: bash diff --git a/doc/source/command-objects/subnet.rst b/doc/source/command-objects/subnet.rst index c4c980f6..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: diff --git a/doc/source/command-objects/volume-host.rst b/doc/source/command-objects/volume-host.rst new file mode 100644 index 00000000..956fce52 --- /dev/null +++ b/doc/source/command-objects/volume-host.rst @@ -0,0 +1,30 @@ +=========== +volume host +=========== + +Volume v2 + +volume host set +--------------- + +Set volume host properties + +.. program:: volume host set +.. code:: bash + + os volume host set + [--enable | --disable] + <host-name> + +.. option:: --enable + + Thaw and enable the specified volume host + +.. option:: --disable + + Freeze and disable the specified volume host + +.. _volume-host-set: +.. describe:: <host-name> + + Name of volume host diff --git a/doc/source/command-objects/volume-qos.rst b/doc/source/command-objects/volume-qos.rst index 54e50966..620c26ba 100644 --- a/doc/source/command-objects/volume-qos.rst +++ b/doc/source/command-objects/volume-qos.rst @@ -16,6 +16,7 @@ Associate a QoS specification to a volume type <qos-spec> <volume-type> +.. _volume_qos_associate: .. describe:: <qos-spec> QoS specification to modify (name or ID) @@ -45,6 +46,7 @@ Create new QoS Specification Set a property on this QoS specification (repeat option to set multiple properties) +.. _volume_qos_create-name: .. describe:: <name> New QoS specification name @@ -65,6 +67,7 @@ Delete QoS specification Allow to delete in-use QoS specification(s) +.. _volume_qos_delete-qos-spec: .. describe:: <qos-spec> QoS specification(s) to delete (name or ID) @@ -89,6 +92,7 @@ Disassociate a QoS specification from a volume type Disassociate the QoS from every volume type +.. _volume_qos_disassociate-qos-spec: .. describe:: <qos-spec> QoS specification to modify (name or ID) @@ -119,6 +123,7 @@ Set QoS specification properties Property to add or modify for this QoS specification (repeat option to set multiple properties) +.. _volume_qos_set-qos-spec: .. describe:: <qos-spec> QoS specification to modify (name or ID) @@ -134,6 +139,7 @@ Display QoS specification details os volume qos show <qos-spec> +.. _volume_qos_show-qos-spec: .. describe:: <qos-spec> QoS specification to display (name or ID) @@ -147,13 +153,14 @@ Unset QoS specification properties .. code:: bash os volume qos unset - [--property <key>] + [--property <key> [...] ] <qos-spec> .. option:: --property <key> Property to remove from QoS specification (repeat option to remove multiple properties) +.. _volume_qos_unset-qos-spec: .. describe:: <qos-spec> QoS specification to modify (name or ID) diff --git a/doc/source/command-objects/volume-snapshot.rst b/doc/source/command-objects/volume-snapshot.rst new file mode 100644 index 00000000..17449035 --- /dev/null +++ b/doc/source/command-objects/volume-snapshot.rst @@ -0,0 +1,201 @@ +=============== +volume snapshot +=============== + +Block Storage v1, v2 + +volume snapshot create +---------------------- + +Create new volume snapshot + +.. program:: volume snapshot create +.. code:: bash + + os volume snapshot create + [--volume <volume>] + [--description <description>] + [--force] + [--property <key=value> [...] ] + [--remote-source <key=value> [...]] + <snapshot-name> + +.. option:: --volume <volume> + + Volume to snapshot (name or ID) (default is <snapshot-name>) + +.. option:: --description <description> + + Description of the snapshot + +.. option:: --force + + Create a snapshot attached to an instance. Default is False + +.. option:: --property <key=value> + + Set a property to this snapshot (repeat option to set multiple properties) + + *Volume version 2 only* + +.. option:: --remote-source <key=value> + + The attribute(s) of the exsiting remote volume snapshot + (admin required) (repeat option to specify multiple attributes) + e.g.: '--remote-source source-name=test_name --remote-source source-id=test_id' + + *Volume version 2 only* + +.. _volume_snapshot_create-snapshot-name: +.. describe:: <snapshot-name> + + Name of the new snapshot (default to None) + +volume snapshot delete +---------------------- + +Delete volume snapshot(s) + +.. program:: volume snapshot delete +.. code:: bash + + os volume snapshot delete + [--force] + <snapshot> [<snapshot> ...] + +.. option:: --force + + Attempt forced removal of snapshot(s), regardless of state (defaults to False) + +.. _volume_snapshot_delete-snapshot: +.. describe:: <snapshot> + + Snapshot(s) to delete (name or ID) + +volume snapshot list +-------------------- + +List volume snapshots + +.. program:: volume snapshot list +.. code:: bash + + os volume snapshot list + [--all-projects] + [--long] + [--limit <limit>] + [--marker <marker>] + [--name <name>] + [--status <status>] + [--volume <volume>] + +.. option:: --all-projects + + Include all projects (admin only) + +.. option:: --long + + List additional fields in output + +.. option:: --status <status> + + Filters results by a status. + ('available', 'error', 'creating', 'deleting' or 'error-deleting') + +.. option:: --name <name> + + Filters results by a name. + +.. option:: --volume <volume> + + Filters results by a volume (name or ID). + +.. option:: --limit <limit> + + Maximum number of snapshots to display + + *Volume version 2 only* + +.. option:: --marker <marker> + + The last snapshot ID of the previous page + + *Volume version 2 only* + +volume snapshot set +------------------- + +Set volume snapshot properties + +.. program:: volume snapshot set +.. code:: bash + + os volume snapshot set + [--name <name>] + [--description <description>] + [--property <key=value> [...] ] + [--state <state>] + <snapshot> + +.. option:: --name <name> + + New snapshot name + +.. option:: --description <description> + + New snapshot description + +.. option:: --property <key=value> + + Property to add or modify for this snapshot (repeat option to set multiple properties) + +.. option:: --state <state> + + New snapshot state. + ("available", "error", "creating", "deleting", or "error_deleting") (admin only) + (This option simply changes the state of the snapshot in the database with + no regard to actual status, exercise caution when using) + + *Volume version 2 only* + +.. _volume_snapshot_set-snapshot: +.. describe:: <snapshot> + + Snapshot to modify (name or ID) + +volume snapshot show +-------------------- + +Display volume snapshot details + +.. program:: volume snapshot show +.. code:: bash + + os volume snapshot show + <snapshot> + +.. _volume_snapshot_show-snapshot: +.. describe:: <snapshot> + + Snapshot to display (name or ID) + +volume snapshot unset +--------------------- + +Unset volume snapshot properties + +.. program:: volume snapshot unset +.. code:: bash + + os volume snapshot unset + [--property <key>] + <snapshot> + +.. option:: --property <key> + + Property to remove from snapshot (repeat option to remove multiple properties) + +.. _volume_snapshot_unset-snapshot: +.. describe:: <snapshot> + + Snapshot to modify (name or ID) diff --git a/doc/source/command-objects/volume-type.rst b/doc/source/command-objects/volume-type.rst index d93532c7..72422b5c 100644 --- a/doc/source/command-objects/volume-type.rst +++ b/doc/source/command-objects/volume-type.rst @@ -87,7 +87,7 @@ List volume types os volume type list [--long] - [--public | --private] + [--default | --public | --private] .. option:: --long @@ -105,6 +105,12 @@ List volume types *Volume version 2 only* +.. option:: --default + + List the default volume type + + *Volume version 2 only* + volume type set --------------- diff --git a/doc/source/command-objects/volume.rst b/doc/source/command-objects/volume.rst index abd433b6..5383386f 100644 --- a/doc/source/command-objects/volume.rst +++ b/doc/source/command-objects/volume.rst @@ -24,6 +24,8 @@ Create new volume [--property <key=value> [...] ] [--hint <key=value> [...] ] [--multi-attach] + [--bootable | --non-bootable] + [--read-only | --read-write] <name> .. option:: --size <size> @@ -89,6 +91,22 @@ Create new volume Allow volume to be attached more than once (default to False) +.. option:: --bootable + + Mark volume as bootable + +.. option:: --non-bootable + + Mark volume as non-bootable (default) + +.. option:: --read-only + + Set volume to read-only access mode + +.. option:: --read-write + + Set volume to read-write access mode (default) + .. _volume_create-name: .. describe:: <name> @@ -254,6 +272,8 @@ 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> @@ -274,6 +294,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 |