diff options
Diffstat (limited to 'doc/source/command-objects')
| -rw-r--r-- | doc/source/command-objects/network.rst | 12 | ||||
| -rw-r--r-- | doc/source/command-objects/project.rst | 12 | ||||
| -rw-r--r-- | doc/source/command-objects/role_assignment.rst | 5 | ||||
| -rw-r--r-- | doc/source/command-objects/server.rst | 2 | ||||
| -rw-r--r-- | doc/source/command-objects/user.rst | 2 | ||||
| -rw-r--r-- | doc/source/command-objects/volume_qos.rst | 154 |
6 files changed, 179 insertions, 8 deletions
diff --git a/doc/source/command-objects/network.rst b/doc/source/command-objects/network.rst index dcba9f82..6b63c35d 100644 --- a/doc/source/command-objects/network.rst +++ b/doc/source/command-objects/network.rst @@ -13,20 +13,20 @@ Create new network .. code:: bash os network create - [--domain <domain>] + [--project <project> [--project-domain <project-domain>]] [--enable | --disable] - [--project <project>] [--share | --no-share] <name> -.. option:: --domain <domain> - - Owner's domain (name or ID)" - .. 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. + .. option:: --enable Enable network (default) diff --git a/doc/source/command-objects/project.rst b/doc/source/command-objects/project.rst index 63796da8..637a4498 100644 --- a/doc/source/command-objects/project.rst +++ b/doc/source/command-objects/project.rst @@ -171,6 +171,18 @@ Display project details .. versionadded:: 3 +.. option:: --parents + + Show the project\'s parents as a list + + .. versionadded:: 3 + +.. option:: --children + + Show project\'s subtree (children) as a list + + .. versionadded:: 3 + .. _project_show-project: .. describe:: <project> diff --git a/doc/source/command-objects/role_assignment.rst b/doc/source/command-objects/role_assignment.rst index 749d883e..cfb1079c 100644 --- a/doc/source/command-objects/role_assignment.rst +++ b/doc/source/command-objects/role_assignment.rst @@ -19,6 +19,7 @@ List role assignments [--domain <domain>] [--project <project>] [--effective] + [--inherited] .. option:: --role <role> @@ -43,3 +44,7 @@ List role assignments .. option:: --effective Returns only effective role assignments (defaults to False) + +.. option:: --inherited + + Specifies if the role grant is inheritable to the sub projects diff --git a/doc/source/command-objects/server.rst b/doc/source/command-objects/server.rst index 10ab3065..eb61bab5 100644 --- a/doc/source/command-objects/server.rst +++ b/doc/source/command-objects/server.rst @@ -60,7 +60,7 @@ Create a new server os server create --image <image> | --volume <volume> --flavor <flavor> - [--security-group <security-group-list> [...] ] + [--security-group <security-group-name> [...] ] [--key-name <key-name>] [--property <key=value> [...] ] [--file <dest-filename=source-filename>] [...] ] diff --git a/doc/source/command-objects/user.rst b/doc/source/command-objects/user.rst index 79807b23..8aec76b4 100644 --- a/doc/source/command-objects/user.rst +++ b/doc/source/command-objects/user.rst @@ -65,7 +65,7 @@ Create new user If the username already exist return the existing user data and do not fail. -.. describe:: <name> +.. describe:: <user-name> New user name diff --git a/doc/source/command-objects/volume_qos.rst b/doc/source/command-objects/volume_qos.rst new file mode 100644 index 00000000..287059f1 --- /dev/null +++ b/doc/source/command-objects/volume_qos.rst @@ -0,0 +1,154 @@ +========== +volume qos +========== + +volume v1, v2 + +volume qos associate +-------------------- + +Associate a QoS specification to a volume type + +.. program:: volume qos associate +.. code:: bash + + os volume qos associate + <qos-specs> + <volume-type> + +.. describe:: <qos-specs> + + QoS specification to modify (name or ID) + +.. describe:: <volume-type> + + Volume type to associate the QoS (name or ID) + +volume qos create +----------------- + +Create new QoS Specification + +.. program:: volume qos create +.. code:: bash + + os volume qos create + [--consumer <consumer>] + [--property <key=value> [...] ] + <name> + +.. option:: --consumer <consumer> + + Consumer of the QoS. Valid consumers: 'front-end', 'back-end', 'both' (defaults to 'both') + +.. option:: --property <key=value> + + Set a property on this QoS specification (repeat option to set multiple properties) + +.. describe:: <name> + + New QoS specification name + +volume qos delete +----------------- + +Delete QoS specification + +.. program:: volume qos delete +.. code:: bash + + os volume qos delete + <qos-specs> + +.. describe:: <qos-specs> + + QoS specification to delete (name or ID) + +volume qos disassociate +----------------------- + +Disassociate a QoS specification from a volume type + +.. program:: volume qos disassoiate +.. code:: bash + + os volume qos disassociate + --volume-type <volume-type> | --all + <qos-specs> + +.. option:: --volume-type <volume-type> + + Volume type to disassociate the QoS from (name or ID) + +.. option:: --all + + Disassociate the QoS from every volume type + +.. describe:: <qos-specs> + + QoS specification to modify (name or ID) + +volume qos list +--------------- + +List QoS specifications + +.. program:: volume qos list +.. code:: bash + + os volume qos list + +volume qos set +-------------- + +Set QoS specification properties + +.. program:: volume qos set +.. code:: bash + + os volume qos set + [--property <key=value> [...] ] + <qos-specs> + +.. option:: --property <key=value> + + Property to add or modify for this QoS specification (repeat option to set multiple properties) + +.. describe:: <qos-specs> + + QoS specification to modify (name or ID) + +volume qos show +--------------- + +Display QoS specification details + +.. program:: volume qos show +.. code:: bash + + os volume qos show + <qos-specs> + +.. describe:: <qos-specs> + + QoS specification to display (name or ID) + +volume qos unset +---------------- + +Unset QoS specification properties + +.. program:: volume qos unset +.. code:: bash + + os volume qos unset + [--property <key>] + <qos-specs> + +.. option:: --property <key> + + Property to remove from QoS specification (repeat option to remove multiple properties) + +.. describe:: <qos-specs> + + QoS specification to modify (name or ID) |
