diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/command-beta.rst | 12 | ||||
| -rw-r--r-- | doc/source/command-objects/compute-agent.rst | 6 | ||||
| -rw-r--r-- | doc/source/command-objects/compute-service.rst | 5 | ||||
| -rw-r--r-- | doc/source/command-objects/flavor.rst | 11 | ||||
| -rw-r--r-- | doc/source/command-objects/ip-availability.rst (renamed from doc/source/specs/ip-availability.rst) | 7 | ||||
| -rw-r--r-- | doc/source/command-objects/keypair.rst | 4 | ||||
| -rw-r--r-- | doc/source/command-objects/network-segment.rst | 4 | ||||
| -rw-r--r-- | doc/source/command-objects/volume-transfer-request.rst | 21 | ||||
| -rw-r--r-- | doc/source/command-objects/volume-type.rst | 2 | ||||
| -rw-r--r-- | doc/source/commands.rst | 2 | ||||
| -rw-r--r-- | doc/source/man/openstack.rst | 23 |
11 files changed, 61 insertions, 36 deletions
diff --git a/doc/source/command-beta.rst b/doc/source/command-beta.rst index 53a44204..f0a4f851 100644 --- a/doc/source/command-beta.rst +++ b/doc/source/command-beta.rst @@ -33,7 +33,7 @@ example list List examples .. caution:: This is a beta command and subject to change. - Use global option ``--enable-beta-commands`` to + Use global option ``--os-beta-command`` to enable this command. .. program:: example list @@ -52,7 +52,7 @@ The command help must label the command as a beta. """Display example details (Caution: This is a beta command and subject to change. - Use global option --enable-beta-commands to enable + Use global option --os-beta-command to enable this command) """ @@ -60,13 +60,9 @@ Implementation -------------- The command must raise a ``CommandError`` exception if beta commands -are not enabled via ``--enable-beta-commands`` global option. +are not enabled via ``--os-beta-command`` global option. .. code-block:: python def take_action(self, parsed_args): - if not self.app.options.enable_beta_commands: - msg = _('Caution: This is a beta command and subject to ' - 'change. Use global option --enable-beta-commands ' - 'to enable this command.') - raise exceptions.CommandError(msg) + self.validate_os_beta_command_enabled() diff --git a/doc/source/command-objects/compute-agent.rst b/doc/source/command-objects/compute-agent.rst index 395ee4f3..b00a981d 100644 --- a/doc/source/command-objects/compute-agent.rst +++ b/doc/source/command-objects/compute-agent.rst @@ -44,17 +44,17 @@ Create compute agent compute agent delete -------------------- -Delete compute agent command +Delete compute agent(s) .. program:: compute agent delete .. code:: bash - os compute agent delete <id> + os compute agent delete <id> [<id> ...] .. _compute_agent-delete: .. describe:: <id> - ID of agent to delete + ID of agent(s) to delete compute agent list ------------------ diff --git a/doc/source/command-objects/compute-service.rst b/doc/source/command-objects/compute-service.rst index bda64c81..71225bc3 100644 --- a/doc/source/command-objects/compute-service.rst +++ b/doc/source/command-objects/compute-service.rst @@ -63,7 +63,7 @@ Set service command .. _compute-service-set: .. option:: --enable - Enable service (default) + Enable service .. option:: --disable @@ -71,8 +71,7 @@ Set service command .. option:: --disable-reason <reason> - Reason for disabling the service (in quotes). Note that when the service - is enabled, this option is ignored. + Reason for disabling the service (in quotes). Should be used with --disable option. .. describe:: <host> diff --git a/doc/source/command-objects/flavor.rst b/doc/source/command-objects/flavor.rst index c6bde882..a30bedec 100644 --- a/doc/source/command-objects/flavor.rst +++ b/doc/source/command-objects/flavor.rst @@ -175,12 +175,23 @@ Unset flavor properties os flavor unset [--property <key> [...] ] + [--project <project>] + [--project-domain <project-domain>] <flavor> .. option:: --property <key> Property to remove from flavor (repeat option to remove multiple properties) +.. option:: --project <project> + + Remove flavor access from project (name or ID) (admin 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. + .. describe:: <flavor> Flavor to modify (name or ID) diff --git a/doc/source/specs/ip-availability.rst b/doc/source/command-objects/ip-availability.rst index cf0c71ff..55b78427 100644 --- a/doc/source/specs/ip-availability.rst +++ b/doc/source/command-objects/ip-availability.rst @@ -24,12 +24,12 @@ number of allocated IP addresses from that pool. .. option:: --ip-version {4,6} - List IP availability for specific version + List IP availability of given IP version networks (Default is 4) .. option:: --project <project> - List IP availability for specific project + List IP availability of given project (name or ID) ip availability show @@ -57,5 +57,4 @@ subnet within the network as well. .. _ip_availability_show-network .. describe:: <network> - Show network IP availability for specific - network (name or ID) + Show IP availability for a specific network (name or ID) diff --git a/doc/source/command-objects/keypair.rst b/doc/source/command-objects/keypair.rst index e49acace..6638b8c9 100644 --- a/doc/source/command-objects/keypair.rst +++ b/doc/source/command-objects/keypair.rst @@ -40,7 +40,7 @@ Delete public key .. describe:: <key> - Public key to delete + Public key to delete (name only) keypair list ------------ @@ -66,7 +66,7 @@ Display public key details .. option:: --public-key - Show only bare public key + Show only bare public key (name only) .. describe:: <key> diff --git a/doc/source/command-objects/network-segment.rst b/doc/source/command-objects/network-segment.rst index 8e177d6a..56a11e1e 100644 --- a/doc/source/command-objects/network-segment.rst +++ b/doc/source/command-objects/network-segment.rst @@ -15,7 +15,7 @@ network segment list List network segments .. caution:: This is a beta command and subject to change. - Use global option ``--enable-beta-commands`` to + Use global option ``--os-beta-command`` to enable this command. .. program:: network segment list @@ -39,7 +39,7 @@ network segment show Display network segment details .. caution:: This is a beta command and subject to change. - Use global option ``--enable-beta-commands`` to + Use global option ``--os-beta-command`` to enable this command. .. program:: network segment show diff --git a/doc/source/command-objects/volume-transfer-request.rst b/doc/source/command-objects/volume-transfer-request.rst new file mode 100644 index 00000000..79d84f75 --- /dev/null +++ b/doc/source/command-objects/volume-transfer-request.rst @@ -0,0 +1,21 @@ +======================= +volume transfer request +======================= + +Block Storage v1, v2 + +volume transfer request list +---------------------------- + +Lists all volume transfer requests. + +.. program:: volume transfer request list +.. code:: bash + + os volume transfer request list + --all-projects + +.. option:: --all-projects + + Shows detail for all projects. Admin only. + (defaults to False)
\ No newline at end of file diff --git a/doc/source/command-objects/volume-type.rst b/doc/source/command-objects/volume-type.rst index b7aea632..50acf9fa 100644 --- a/doc/source/command-objects/volume-type.rst +++ b/doc/source/command-objects/volume-type.rst @@ -150,7 +150,7 @@ Unset volume type properties .. code:: bash os volume type unset - [--property <key>] + [--property <key> [...] ] [--project <project>] [--project-domain <project-domain>] <volume-type> diff --git a/doc/source/commands.rst b/doc/source/commands.rst index 2d38c8a1..9fb0555d 100644 --- a/doc/source/commands.rst +++ b/doc/source/commands.rst @@ -96,6 +96,7 @@ referring to both Compute and Volume quotas. * ``hypervisor stats``: (**Compute**) hypervisor statistics over all compute nodes * ``identity provider``: (**Identity**) a source of users and authentication * ``image``: (**Image**) a disk image +* ``ip availability``: (**Network**) - details of IP usage of a network * ``ip fixed``: (**Compute**, **Network**) - an internal IP address assigned to a server * ``ip floating``: (**Compute**, **Network**) - a public IP address that can be mapped to a server * ``ip floating pool``: (**Compute**, **Network**) - a pool of public IP addresses @@ -137,6 +138,7 @@ referring to both Compute and Volume quotas. * ``volume qos``: (**Volume**) quality-of-service (QoS) specification for volumes * ``volume type``: (**Volume**) deployment-specific types of volumes available * ``volume service``: (**Volume**) services to manage block storage operations +* ``volume transfer request``: (**Volume**) volume owner transfer request Plugin Objects diff --git a/doc/source/man/openstack.rst b/doc/source/man/openstack.rst index 8cd10a79..7af380a3 100644 --- a/doc/source/man/openstack.rst +++ b/doc/source/man/openstack.rst @@ -82,7 +82,7 @@ OPTIONS Project-level authentication scope (name or ID) :option:`--os-project-domain-name` <auth-project-domain-name> | :option:`--os-project-domain-id` <auth-project-domain-id> - Domain name or id containing project + Domain name or ID containing project :option:`--os-username` <auth-username> Authentication username @@ -94,13 +94,10 @@ OPTIONS Authenticated token or service token :option:`--os-user-domain-name` <auth-user-domain-name> | :option:`--os-user-domain-id` <auth-user-domain-id> - Domain name or id containing user - -:option:`--os-user-domain-name` <auth-user-domain-name> | :option:`--os-user-domain-id` <auth-user-domain-id> Domain name or ID containing user :option:`--os-trust-id` <trust-id> - id of the trust to use as a trustee user + ID of the trust to use as a trustee user :option:`--os-default-domain` <auth-domain> Default domain ID (Default: 'default') @@ -135,6 +132,9 @@ OPTIONS This key should be the value of one of the HMAC keys defined in the configuration files of OpenStack services to be traced. +:option:`--os-beta-command` + Enable beta commands which are subject to change + :option:`--log-file` <LOGFILE> Specify a file to log output. Disabled by default. @@ -142,13 +142,10 @@ OPTIONS Increase verbosity of output. Can be repeated. :option:`-q, --quiet` - suppress output except warnings and errors + Suppress output except warnings and errors :option:`--debug` - show tracebacks on errors and set verbosity to debug - -:option:`--enable-beta-commands` - Enable beta commands which are subject to change + Show tracebacks on errors and set verbosity to debug COMMANDS ======== @@ -350,7 +347,7 @@ The following environment variables can be set to alter the behaviour of :progra Project-level authentication scope (name or ID) :envvar:`OS_PROJECT_DOMAIN_NAME` - Domain name or id containing project + Domain name or ID containing project :envvar:`OS_USERNAME` Authentication username @@ -362,10 +359,10 @@ The following environment variables can be set to alter the behaviour of :progra Authentication password :envvar:`OS_USER_DOMAIN_NAME` - Domain name or id containing user + Domain name or ID containing user :envvar:`OS_TRUST_ID` - id of the trust to use as a trustee user + ID of the trust to use as a trustee user :envvar:`OS_DEFAULT_DOMAIN` Default domain ID (Default: 'default') |