diff options
Diffstat (limited to 'doc/source/command-objects')
| -rw-r--r-- | doc/source/command-objects/consistency-group.rst | 33 | ||||
| -rw-r--r-- | doc/source/command-objects/port.rst | 12 | ||||
| -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 | 21 |
5 files changed, 102 insertions, 3 deletions
diff --git a/doc/source/command-objects/consistency-group.rst b/doc/source/command-objects/consistency-group.rst index 46682a56..910fbba9 100644 --- a/doc/source/command-objects/consistency-group.rst +++ b/doc/source/command-objects/consistency-group.rst @@ -13,7 +13,7 @@ Create new consistency group. .. code:: bash os consistency group create - --volume-type <volume-type> | --consistency-group-source <consistency-group> + --volume-type <volume-type> | --consistency-group-source <consistency-group> | --consistency-group-snapshot <consistency-group-snapshot> [--description <description>] [--availability-zone <availability-zone>] [<name>] @@ -26,6 +26,10 @@ Create new 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 @@ -82,6 +86,32 @@ List consistency groups. 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 ---------------------- @@ -97,4 +127,3 @@ Display consistency group details. .. describe:: <consistency-group> Consistency group to display (name or ID) - diff --git a/doc/source/command-objects/port.rst b/doc/source/command-objects/port.rst index 3aff2f77..73c53290 100644 --- a/doc/source/command-objects/port.rst +++ b/doc/source/command-objects/port.rst @@ -28,6 +28,7 @@ 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> @@ -91,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) @@ -192,6 +198,7 @@ Set port properties [--security-group <security-group>] [--no-security-group] [--enable-port-security | --disable-port-security] + [--dns-name <dns-name>] <port> .. option:: --description <description> @@ -269,6 +276,11 @@ Set port properties 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/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 index b84601f4..141e9f78 100644 --- a/doc/source/command-objects/volume-snapshot.rst +++ b/doc/source/command-objects/volume-snapshot.rst @@ -51,8 +51,13 @@ Delete volume snapshot(s) .. 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> @@ -71,6 +76,9 @@ List volume snapshots [--long] [--limit <limit>] [--marker <marker>] + [--name <name>] + [--status <status>] + [--volume <volume>] .. option:: --all-projects @@ -80,6 +88,19 @@ List volume snapshots 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 |