diff options
Diffstat (limited to 'doc/source/command-objects')
| -rw-r--r-- | doc/source/command-objects/aggregate.rst | 7 | ||||
| -rw-r--r-- | doc/source/command-objects/complete.rst | 25 | ||||
| -rw-r--r-- | doc/source/command-objects/consistency-group.rst | 26 | ||||
| -rw-r--r-- | doc/source/command-objects/container.rst | 6 | ||||
| -rw-r--r-- | doc/source/command-objects/network-qos-policy.rst | 122 | ||||
| -rw-r--r-- | doc/source/command-objects/network-segment.rst | 20 | ||||
| -rw-r--r-- | doc/source/command-objects/object.rst | 15 | ||||
| -rw-r--r-- | doc/source/command-objects/router.rst | 5 | ||||
| -rw-r--r-- | doc/source/command-objects/subnet.rst | 6 | ||||
| -rw-r--r-- | doc/source/command-objects/volume.rst | 31 |
10 files changed, 224 insertions, 39 deletions
diff --git a/doc/source/command-objects/aggregate.rst b/doc/source/command-objects/aggregate.rst index 25c7041a..642942d4 100644 --- a/doc/source/command-objects/aggregate.rst +++ b/doc/source/command-objects/aggregate.rst @@ -116,6 +116,7 @@ Set aggregate properties [--name <new-name>] [--zone <availability-zone>] [--property <key=value> [...] ] + [--no-property] <aggregate> .. option:: --name <name> @@ -131,6 +132,12 @@ Set aggregate properties Property to set on :ref:`\<aggregate\> <aggregate_set-aggregate>` (repeat option to set multiple properties) +.. option:: --no-property + + Remove all properties from :ref:`\<aggregate\> <aggregate_set-aggregate>` + (specify both --property and --no-property to + overwrite the current properties) + .. _aggregate_set-aggregate: .. describe:: <aggregate> diff --git a/doc/source/command-objects/complete.rst b/doc/source/command-objects/complete.rst new file mode 100644 index 00000000..8f84eec1 --- /dev/null +++ b/doc/source/command-objects/complete.rst @@ -0,0 +1,25 @@ +======== +complete +======== + +The ``complete`` command is inherited from the `python-cliff` library, it can +be used to generate a bash-completion script. Currently, the command will +generate a script for bash versions 3 or 4. The bash-completion script is +printed directly to standard out. + +Typical usage for this command is:: + + openstack complete | sudo tee /etc/bash_completion.d/osc.bash_completion > /dev/null + +If installing ``python-openstackclient`` from a package (``apt-get`` or ``yum``), +then this command will likely be run for you. + +complete +-------- + +print bash completion command + +.. program:: complete +.. code:: bash + + os complete diff --git a/doc/source/command-objects/consistency-group.rst b/doc/source/command-objects/consistency-group.rst new file mode 100644 index 00000000..f24df0d1 --- /dev/null +++ b/doc/source/command-objects/consistency-group.rst @@ -0,0 +1,26 @@ +================= +consistency group +================= + +Block Storage v2 + +consistency group list +---------------------- + +List consistency groups. + +.. program:: consistency group list +.. code:: bash + + os consistency group list + [--all-projects] + [--long] + +.. option:: --all-projects + + Show detail for all projects. Admin only. + (defaults to False) + +.. option:: --long + + List additional fields in output diff --git a/doc/source/command-objects/container.rst b/doc/source/command-objects/container.rst index 130a6b3d..adcf0961 100644 --- a/doc/source/command-objects/container.rst +++ b/doc/source/command-objects/container.rst @@ -104,7 +104,7 @@ Set container properties os container set [--property <key=value> [...] ] - [<container>] + <container> .. option:: --property <key=value> @@ -123,7 +123,7 @@ Display container details .. code:: bash os container show - [<container>] + <container> .. describe:: <container> @@ -139,7 +139,7 @@ Unset container properties os container unset [--property <key>] - [<container>] + <container> .. option:: --property <key> diff --git a/doc/source/command-objects/network-qos-policy.rst b/doc/source/command-objects/network-qos-policy.rst new file mode 100644 index 00000000..f1e54976 --- /dev/null +++ b/doc/source/command-objects/network-qos-policy.rst @@ -0,0 +1,122 @@ +================== +network qos policy +================== + +A **Network QoS policy** groups a number of Network QoS rules, applied to a +network or a port. + +Network v2 + +network qos policy create +------------------------- + +Create new Network QoS policy + +.. program:: network qos policy create +.. code:: bash + + os network qos policy create + [--description <description>] + [--share | --no-share] + [--project <project>] + [--project-domain <project-domain>] + <name> + +.. option:: --description <description> + + Description of the QoS policy + +.. option:: --share + + Make the QoS policy accessible by other projects + +.. option:: --no-share + + Make the QoS policy not accessible by other projects (default) + +.. option:: --project <project> + + Owner's 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. + +.. describe:: <name> + + New QoS policy specification name + +network qos policy delete +------------------------- + +Delete Network QoS policy + +.. program:: network qos policy delete +.. code:: bash + + os network qos policy delete + <qos-policy> [<qos-policy> ...] + +.. describe:: <qos-policy> + + Network QoS policy(s) to delete (name or ID) + +network qos policy list +----------------------- + +List Network QoS policies + +.. program:: network qos policy list +.. code:: bash + + os network qos policy list + +network qos policy set +---------------------- + +Set Network QoS policy properties + +.. program:: network qos policy set +.. code:: bash + + os network qos policy set + [--name <name>] + [--description <description>] + [--share | --no-share] + <qos-policy> + +.. option:: --name <name> + + Name of the QoS policy + +.. option:: --description <description> + + Description of the QoS policy + +.. option:: --share + + Make the QoS policy accessible by other projects + +.. option:: --no-share + + Make the QoS policy not accessible by other projects + +.. describe:: <qos-policy> + + Network QoS policy(s) to delete (name or ID) + +network qos policy show +----------------------- + +Display Network QoS policy details + +.. program:: network qos policy show +.. code:: bash + + os network qos policy show + <qos-policy> + +.. describe:: <qos-policy> + + Network QoS policy(s) to show (name or ID) diff --git a/doc/source/command-objects/network-segment.rst b/doc/source/command-objects/network-segment.rst index 242dcbe9..d0434651 100644 --- a/doc/source/command-objects/network-segment.rst +++ b/doc/source/command-objects/network-segment.rst @@ -14,10 +14,6 @@ network segment create Create new network segment -.. caution:: This is a beta command and subject to change. - Use global option ``--os-beta-command`` to - enable this command. - .. program:: network segment create .. code:: bash @@ -63,10 +59,6 @@ network segment delete Delete network segment(s) -.. caution:: This is a beta command and subject to change. - Use global option ``--os-beta-command`` to - enable this command. - .. program:: network segment delete .. code:: bash @@ -83,10 +75,6 @@ network segment list List network segments -.. caution:: This is a beta command and subject to change. - Use global option ``--os-beta-command`` to - enable this command. - .. program:: network segment list .. code:: bash @@ -107,10 +95,6 @@ network segment set Set network segment properties -.. caution:: This is a beta command and subject to change. - Use global option ``--os-beta-command`` to - enable this command. - .. program:: network segment set .. code:: bash @@ -137,10 +121,6 @@ network segment show Display network segment details -.. caution:: This is a beta command and subject to change. - Use global option ``--os-beta-command`` to - enable this command. - .. program:: network segment show .. code:: bash diff --git a/doc/source/command-objects/object.rst b/doc/source/command-objects/object.rst index 5aaad8a5..d02ac9bc 100644 --- a/doc/source/command-objects/object.rst +++ b/doc/source/command-objects/object.rst @@ -13,9 +13,14 @@ Upload object to container .. code:: bash os object create + [--name <name>] <container> <filename> [<filename> ...] +.. option:: --name <name> + + Upload a file and rename it. Can only be used when uploading a single object + .. describe:: <container> Container for new object @@ -60,7 +65,7 @@ List objects [--limit <limit>] [--long] [--all] - <container>] + <container> .. option:: --prefix <prefix> @@ -104,8 +109,8 @@ Save object locally os object save [--file <filename>] - [<container>] - [<object>] + <container> + <object> .. option:: --file <filename> @@ -130,7 +135,7 @@ Set object properties os object set [--property <key=value> [...] ] <container> - [<object>] + <object> .. option:: --property <key=value> @@ -175,7 +180,7 @@ Unset object properties os object unset [--property <key>] <container> - [<object>] + <object> .. option:: --property <key> diff --git a/doc/source/command-objects/router.rst b/doc/source/command-objects/router.rst index 13a75158..15163980 100644 --- a/doc/source/command-objects/router.rst +++ b/doc/source/command-objects/router.rst @@ -64,6 +64,7 @@ Create new router [--project <project> [--project-domain <project-domain>]] [--enable | --disable] [--distributed] + [--ha] [--description <description>] [--availability-zone-hint <availability-zone>] <name> @@ -89,6 +90,10 @@ Create new router Create a distributed router +.. option:: --ha + + Create a highly available router + .. option:: --description <description> Set router description diff --git a/doc/source/command-objects/subnet.rst b/doc/source/command-objects/subnet.rst index 00401dda..e2059875 100644 --- a/doc/source/command-objects/subnet.rst +++ b/doc/source/command-objects/subnet.rst @@ -116,11 +116,7 @@ Create new subnet .. option:: --network-segment <network-segment> - Network segment to associate with this subnet (ID only) - - .. caution:: This is a beta command option and subject - to change. Use global option ``--os-beta-command`` - to enable this command option. + Network segment to associate with this subnet (name or ID) .. option:: --service-type <service-type> diff --git a/doc/source/command-objects/volume.rst b/doc/source/command-objects/volume.rst index f772557f..8f123361 100644 --- a/doc/source/command-objects/volume.rst +++ b/doc/source/command-objects/volume.rst @@ -13,21 +13,23 @@ Create new volume .. code:: bash os volume create - --size <size> + [--size <size>] [--type <volume-type>] - [--image <image>] - [--snapshot <snapshot>] - [--source <volume>] + [--image <image> | --snapshot <snapshot> | --source <volume> | --source-replicated <replicated-volume>] [--description <description>] [--user <user>] [--project <project>] [--availability-zone <availability-zone>] + [--consistency-group <consistency-group>] [--property <key=value> [...] ] + [--hint <key=value> [...] ] + [--multi-attach] <name> -.. option:: --size <size> (required) +.. option:: --size <size> Volume size in GB + (Required unless --snapshot or --source or --source-replicated is specified) .. option:: --type <volume-type> @@ -46,10 +48,14 @@ Create new volume Use :option:`\<snapshot\>` as source of volume (name or ID) -.. option:: --source <source> +.. option:: --source <volume> Volume to clone (name or ID) +.. option:: --source-replicated <replicated-volume> + + Replicated volume to clone (name or ID) + .. option:: --description <description> Volume description @@ -66,10 +72,23 @@ Create new volume Create volume in :option:`\<availability-zone\>` +.. option:: --consistency-group <consistency-group> + + Consistency group where the new volume belongs to + .. option:: --property <key=value> Set a property on this volume (repeat option to set multiple properties) +.. option:: --hint <key=value> + + Arbitrary scheduler hint key-value pairs to help boot an instance + (repeat option to set multiple hints) + +.. option:: --multi-attach + + Allow volume to be attached more than once (default to False) + .. _volume_create-name: .. describe:: <name> |