From bccc2e266fcc9dd47dd63d0f4de1dc5acf6be01f Mon Sep 17 00:00:00 2001 From: KATO Tomoyuki Date: Tue, 21 Mar 2017 10:30:00 +0900 Subject: [PATCH] [cli-ref] Update python-cinderclient to 2.0.1 Change-Id: I6bb718151dd9141c65d159cc7af2d9abed597b5b --- doc/cli-reference/source/cinder.rst | 1277 ++++++++++++++++++++++++++- 1 file changed, 1262 insertions(+), 15 deletions(-) diff --git a/doc/cli-reference/source/cinder.rst b/doc/cli-reference/source/cinder.rst index 4baedcd8b8..2ff6f341e4 100644 --- a/doc/cli-reference/source/cinder.rst +++ b/doc/cli-reference/source/cinder.rst @@ -20,10 +20,11 @@ Block Storage service (cinder) command-line client ================================================== -The cinder client is the command-line interface (CLI) for -the Block Storage service (cinder) API and its extensions. +The cinder client is the command-line interface (CLI) for the +Block Storage service (cinder) API +and its extensions. -This chapter documents :command:`cinder` version ``1.11.0``. +This chapter documents :command:`cinder` version ``2.0.1``. For help on a specific :command:`cinder` command, enter: @@ -66,6 +67,106 @@ cinder usage ``absolute-limits`` Lists absolute limits for a user. +``api-version`` + Display the server API version information. (Supported + by + API + versions + 3.0 + - + 3.latest) + [hint: + use + '--os-volume-api-version' + flag + to + show + help + message + for + proper version] + +``attachment-create`` + Create an attachment for a cinder volume. (Supported + by + API + versions + 3.27 + - + 3.latest) + [hint: + use + '--os-volume-api-version' + flag + to + show + help + message + for + proper version] + +``attachment-delete`` + Delete an attachment for a cinder volume. (Supported + by + API + versions + 3.27 + - + 3.latest) + [hint: + use + '--os-volume-api-version' + flag + to + show + help + message + for + proper version] + +``attachment-list`` + Lists all attachments. (Supported by API versions 3.27 + - 3.latest) [hint: use '--os-volume-api-version' flag + to show help message for proper version] + +``attachment-show`` + Show detailed information for attachment. (Supported + by + API + versions + 3.27 + - + 3.latest) + [hint: + use + '--os-volume-api-version' + flag + to + show + help + message + for + proper version] + +``attachment-update`` + Update an attachment for a cinder volume. (Supported + by + API + versions + 3.27 + - + 3.latest) + [hint: + use + '--os-volume-api-version' + flag + to + show + help + message + for + proper version] + ``availability-zone-list`` Lists all availability zones. @@ -93,6 +194,23 @@ cinder usage ``backup-show`` Shows backup details. +``backup-update`` + Renames + a + backup. + (Supported + by + API + versions + 3.9 + -3.latest) + [hint: + use + '--os-volume-api-version' + flag + to + show help message for proper version] + ``cgsnapshot-create`` Creates a cgsnapshot. @@ -105,6 +223,41 @@ cinder usage ``cgsnapshot-show`` Shows cgsnapshot details. +``cluster-disable`` + Disables clustered services. (Supported by API + versions + 3.7 + - + 3.latest) + [hint: + use + '--os-volume-api-version' + flag + to + show + help + message + for + proper + version] + +``cluster-enable`` + Enables clustered services. (Supported by API versions + 3.7 - 3.latest) [hint: use '--os-volume-api-version' + flag to show help message for proper version] + +``cluster-list`` + Lists clustered services with optional filtering. + (Supported by API versions 3.7 - 3.latest) [hint: use + '--os-volume-api-version' flag to show help message + for proper version] + +``cluster-show`` + Show detailed information on a clustered service. + (Supported by API versions 3.7 - 3.latest) [hint: use + '--os-volume-api-version' flag to show help message + for proper version] + ``consisgroup-create`` Creates a consistency group. @@ -176,8 +329,224 @@ cinder usage ``get-pools`` Show pool information for backends. Admin only. +``group-create`` + Creates + a + group. + (Supported + by + API + versions + 3.13 + -3.latest) + [hint: + use + '--os-volume-api-version' + flag + to + show help message for proper version] + +``group-create-from-src`` + Creates a group from a group snapshot or a source + group. (Supported by API versions 3.14 - 3.latest) + [hint: use '--os-volume-api-version' flag to show help + message for proper version] + +``group-delete`` + Removes one or more groups. (Supported by API versions + 3.13 - 3.latest) [hint: use '--os-volume-api-version' + flag to show help message for proper version] + +``group-list`` + Lists + all + groups. + (Supported + by + API + versions + 3.13 + -3.latest) + [hint: + use + '--os-volume-api-version' + flag + to + show help message for proper version] + ``group-show`` - Shows details of a group. + Shows details of a group. (Supported by API versions + 3.13 - 3.latest) [hint: use '--os-volume-api-version' + flag to show help message for proper version] + +``group-snapshot-create`` + Creates a group snapshot. (Supported by API versions + 3.14 - 3.latest) [hint: use '--os-volume-api-version' + flag to show help message for proper version] + +``group-snapshot-delete`` + Removes one or more group snapshots. (Supported by API + versions + 3.14 + - + 3.latest) + [hint: + use + '--os-volume-api-version' + flag + to + show + help + message + for + proper + version] + +``group-snapshot-list`` + Lists all group snapshots. (Supported by API versions + 3.14 - 3.latest) [hint: use '--os-volume-api-version' + flag to show help message for proper version] + +``group-snapshot-show`` + Shows group snapshot details. (Supported by API + versions + 3.14 + - + 3.latest) + [hint: + use + '--os-volume-api-version' + flag + to + show + help + message + for + proper + version] + +``group-specs-list`` + Lists current group types and specs. (Supported by API + versions + 3.11 + - + 3.latest) + [hint: + use + '--os-volume-api-version' + flag + to + show + help + message + for + proper + version] + +``group-type-create`` + Creates a group type. (Supported by API versions 3.11 + - 3.latest) [hint: use '--os-volume-api-version' flag + to show help message for proper version] + +``group-type-default`` + List the default group type. (Supported by API + versions + 3.11 + - + 3.latest) + [hint: + use + '--os-volume-api-version' + flag + to + show + help + message + for + proper + version] + +``group-type-delete`` + Deletes group type or types. (Supported by API + versions + 3.11 + - + 3.latest) + [hint: + use + '--os-volume-api-version' + flag + to + show + help + message + for + proper + version] + +``group-type-key`` + Sets or unsets group_spec for a group type. (Supported + by + API + versions + 3.11 + - + 3.latest) + [hint: + use + '--os-volume-api-version' + flag + to + show + help + message + for + proper version] + +``group-type-list`` + Lists available 'group types'. (Admin only will see + private + types) + (Supported + by + API + versions + 3.11 + -3.latest) + [hint: + use + '--os-volume-api-version' + flag + to + show help message for proper version] + +``group-type-show`` + Show group type details. (Supported by API versions + 3.11 - 3.latest) [hint: use '--os-volume-api-version' + flag to show help message for proper version] + +``group-type-update`` + Updates group type name, description, and/or + is_public. (Supported by API versions 3.11 - 3.latest) + [hint: use '--os-volume-api-version' flag to show help + message for proper version] + +``group-update`` + Updates + a + group. + (Supported + by + API + versions + 3.13 + -3.latest) + [hint: + use + '--os-volume-api-version' + flag + to + show help message for proper version] ``image-metadata`` Sets or deletes volume image metadata. @@ -192,7 +561,62 @@ cinder usage Manage an existing volume. ``manageable-list`` - Lists all manageable volumes. + Lists all manageable volumes. (Supported by API + versions + 3.8 + - + 3.latest) + [hint: + use + '--os-volume-api-version' + flag + to + show + help + message + for + proper + version] + +``message-delete`` + Removes one or more messages. (Supported by API + versions + 3.3 + - + 3.latest) + [hint: + use + '--os-volume-api-version' + flag + to + show + help + message + for + proper + version] + +``message-list`` + Lists + all + messages. + (Supported + by + API + versions + 3.3 + -3.latest) + [hint: + use + '--os-volume-api-version' + flag + to + show help message for proper version] + +``message-show`` + Shows message details. (Supported by API versions 3.3 + - 3.latest) [hint: use '--os-volume-api-version' flag + to show help message for proper version] ``metadata`` Sets or deletes volume metadata. @@ -286,6 +710,9 @@ cinder usage ``service-list`` Lists all services. Filter by host and service binary. + (Supported by API versions 3.0 - 3.latest) [hint: use + '--os-volume-api-version' flag to show help message + for proper version] ``set-bootable`` Update bootable status of a volume. @@ -306,7 +733,22 @@ cinder usage Manage an existing snapshot. ``snapshot-manageable-list`` - Lists all manageable snapshots. + Lists all manageable snapshots. (Supported by API + versions + 3.8 + - + 3.latest) + [hint: + use + '--os-volume-api-version' + flag + to + show + help + message + for + proper + version] ``snapshot-metadata`` Sets or deletes snapshot metadata. @@ -384,6 +826,11 @@ cinder usage ``upload-to-image`` Uploads volume to Image Service as an image. +``version-list`` + List all API versions. (Supported by API versions 3.0 + - 3.latest) [hint: use '--os-volume-api-version' flag + to show help message for proper version] + ``bash-completion`` Prints arguments for bash_completion. @@ -517,6 +964,189 @@ Lists absolute limits for a user. ```` Display information for a single tenant (Admin only). +.. _cinder_api-version: + +cinder api-version +------------------ + +.. code-block:: console + + usage: cinder api-version + +Display the server API version information. + +.. _cinder_attachment-create: + +cinder attachment-create +------------------------ + +.. code-block:: console + + usage: cinder attachment-create [--instance ] [--connect ] + [--initiator ] [--ip ] + [--host ] [--platform ] + [--ostype ] [--multipath ] + [--mountpoint ] + + +Create an attachment for a cinder volume. + +**Positional arguments:** + +```` + Name or ID of volume or volumes to attach. + +**Optional arguments:** + +``--instance `` + UUID of Instance attaching to. Default=None. + +``--connect `` + Make an active connection using provided connector + info (True or False). + +``--initiator `` + iqn of the initiator attaching to. Default=None. + +``--ip `` + ip of the system attaching to. Default=None. + +``--host `` + Name of the host attaching to. Default=None. + +``--platform `` + Platform type. Default=x86_64. + +``--ostype `` + OS type. Default=linux2. + +``--multipath `` + OS type. Default=False. + +``--mountpoint `` + Mountpoint volume will be attached at. Default=None. + +.. _cinder_attachment-delete: + +cinder attachment-delete +------------------------ + +.. code-block:: console + + usage: cinder attachment-delete [ ...] + +Delete an attachment for a cinder volume. + +**Positional arguments:** + +```` + ID of attachment or attachments to delete. + +.. _cinder_attachment-list: + +cinder attachment-list +---------------------- + +.. code-block:: console + + usage: cinder attachment-list [--all-tenants [<0|1>]] + [--volume-id ] [--status ] + [--marker ] [--limit ] + [--sort [:]] + [--tenant []] + +Lists all attachments. + +**Optional arguments:** + +``--all-tenants [<0|1>]`` + Shows details for all tenants. Admin only. + +``--volume-id `` + Filters results by a volume ID. Default=None. + +``--status `` + Filters results by a status. Default=None. + +``--marker `` + Begin returning attachments that appear later in + attachment list than that represented by this id. + Default=None. + +``--limit `` + Maximum number of attachemnts to return. Default=None. + +``--sort [:]`` + Comma-separated list of sort keys and directions in + the form of [:]. Valid keys: id, + status, size, availability_zone, name, bootable, + created_at, reference. Default=None. + +``--tenant []`` + Display information from single tenant (Admin only). + +.. _cinder_attachment-show: + +cinder attachment-show +---------------------- + +.. code-block:: console + + usage: cinder attachment-show + +Show detailed information for attachment. + +**Positional arguments:** + +```` + ID of attachment. + +.. _cinder_attachment-update: + +cinder attachment-update +------------------------ + +.. code-block:: console + + usage: cinder attachment-update [--initiator ] [--ip ] + [--host ] [--platform ] + [--ostype ] [--multipath ] + [--mountpoint ] + + +Update an attachment for a cinder volume. This call is designed to be more of +an attachment completion than anything else. It expects the value of a +connector object to notify the driver that the volume is going to be connected +and where it's being connected to. + +**Positional arguments:** + +```` + ID of attachment. + +**Optional arguments:** + +``--initiator `` + iqn of the initiator attaching to. Default=None. + +``--ip `` + ip of the system attaching to. Default=None. + +``--host `` + Name of the host attaching to. Default=None. + +``--platform `` + Platform type. Default=x86_64. + +``--ostype `` + OS type. Default=linux2. + +``--multipath `` + OS type. Default=False. + +``--mountpoint `` + Mountpoint volume will be attached at. Default=None. + .. _cinder_availability-zone-list: cinder availability-zone-list @@ -753,6 +1383,31 @@ Shows backup details. ```` Name or ID of backup. +.. _cinder_backup-update: + +cinder backup-update +-------------------- + +.. code-block:: console + + usage: cinder backup-update [--name []] [--description ] + + +Renames a backup. + +**Positional arguments:** + +```` + Name or ID of backup to rename. + +**Optional arguments:** + +``--name []`` + New name for backup. + +``--description `` + Backup description. Default=None. + .. _cinder_cgsnapshot-create: cinder cgsnapshot-create @@ -834,6 +1489,109 @@ Shows cgsnapshot details. ```` Name or ID of cgsnapshot. +.. _cinder_cluster-disable: + +cinder cluster-disable +---------------------- + +.. code-block:: console + + usage: cinder cluster-disable [--reason ] [] + +Disables clustered services. + +**Positional arguments:** + +```` + Binary to filter by. Default: cinder-volume. + +```` + Name of the clustered services to update. + +**Optional arguments:** + +``--reason `` + Reason for disabling clustered service. + +.. _cinder_cluster-enable: + +cinder cluster-enable +--------------------- + +.. code-block:: console + + usage: cinder cluster-enable [] + +Enables clustered services. + +**Positional arguments:** + +```` + Binary to filter by. Default: cinder-volume. + +```` + Name of the clustered services to update. + +.. _cinder_cluster-list: + +cinder cluster-list +------------------- + +.. code-block:: console + + usage: cinder cluster-list [--name ] [--binary ] + [--is-up ] + [--disabled ] + [--num-hosts ] + [--num-down-hosts ] [--detailed] + +Lists clustered services with optional filtering. + +**Optional arguments:** + +``--name `` + Filter by cluster name, without backend will list all + clustered services from the same cluster. + Default=None. + +``--binary `` + Cluster binary. Default=None. + +``--is-up `` + Filter by up/dow status. Default=None. + +``--disabled `` + Filter by disabled status. Default=None. + +``--num-hosts `` + Filter by number of hosts in the cluster. + +``--num-down-hosts `` + Filter by number of hosts that are down. + +``--detailed`` + Get detailed clustered service information + (Default=False). + +.. _cinder_cluster-show: + +cinder cluster-show +------------------- + +.. code-block:: console + + usage: cinder cluster-show [] + +Show detailed information on a clustered service. + +**Positional arguments:** + +```` + Binary to filter by. Default: cinder-volume. + +```` + Name of the clustered service to show. + .. _cinder_consisgroup-create: cinder consisgroup-create @@ -992,7 +1750,7 @@ cinder create .. code-block:: console usage: cinder create [--consisgroup-id ] - [--snapshot-id ] + [--group-id ] [--snapshot-id ] [--source-volid ] [--source-replica ] [--image-id ] [--image ] [--name ] @@ -1017,6 +1775,11 @@ Creates a volume. ID of a consistency group where the new volume belongs to. Default=None. +``--group-id `` + ID of a group where the new volume belongs to. + Default=None. (Supported by API version 3.13 and + later) + ``--snapshot-id `` Creates volume from snapshot ID. Default=None. @@ -1355,6 +2118,107 @@ Show pool information for backends. Admin only. ``--detail`` Show detailed information about pools. +.. _cinder_group-create: + +cinder group-create +------------------- + +.. code-block:: console + + usage: cinder group-create [--name ] [--description ] + [--availability-zone ] + + +Creates a group. + +**Positional arguments:** + +```` + Group type. + +```` + Comma-separated list of volume types. + +**Optional arguments:** + +``--name `` + Name of a group. + +``--description `` + Description of a group. Default=None. + +``--availability-zone `` + Availability zone for group. Default=None. + +.. _cinder_group-create-from-src: + +cinder group-create-from-src +---------------------------- + +.. code-block:: console + + usage: cinder group-create-from-src [--group-snapshot ] + [--source-group ] + [--name ] + [--description ] + +Creates a group from a group snapshot or a source group. + +**Optional arguments:** + +``--group-snapshot `` + Name or ID of a group snapshot. Default=None. + +``--source-group `` + Name or ID of a source group. Default=None. + +``--name `` + Name of a group. Default=None. + +``--description `` + Description of a group. Default=None. + +.. _cinder_group-delete: + +cinder group-delete +------------------- + +.. code-block:: console + + usage: cinder group-delete [--delete-volumes] [ ...] + +Removes one or more groups. + +**Positional arguments:** + +```` + Name or ID of one or more groups to be deleted. + +**Optional arguments:** + +``--delete-volumes`` + Allows or disallows groups to be deleted if they are not + empty. If the group is empty, it can be deleted without + the delete-volumes flag. If the group is not empty, the + delete-volumes flag is required for it to be deleted. If + True, all volumes in the group will also be deleted. + +.. _cinder_group-list: + +cinder group-list +----------------- + +.. code-block:: console + + usage: cinder group-list [--all-tenants [<0|1>]] + +Lists all groups. + +**Optional arguments:** + +``--all-tenants [<0|1>]`` + Shows details for all tenants. Admin only. + .. _cinder_group-show: cinder group-show @@ -1371,6 +2235,265 @@ Shows details of a group. ```` Name or ID of a group. +.. _cinder_group-snapshot-create: + +cinder group-snapshot-create +---------------------------- + +.. code-block:: console + + usage: cinder group-snapshot-create [--name ] + [--description ] + + +Creates a group snapshot. + +**Positional arguments:** + +```` + Name or ID of a group. + +**Optional arguments:** + +``--name `` + Group snapshot name. Default=None. + +``--description `` + Group snapshot description. Default=None. + +.. _cinder_group-snapshot-delete: + +cinder group-snapshot-delete +---------------------------- + +.. code-block:: console + + usage: cinder group-snapshot-delete [ ...] + +Removes one or more group snapshots. + +**Positional arguments:** + +```` + Name or ID of one or more group snapshots to be deleted. + +.. _cinder_group-snapshot-list: + +cinder group-snapshot-list +-------------------------- + +.. code-block:: console + + usage: cinder group-snapshot-list [--all-tenants [<0|1>]] [--status ] + [--group-id ] + +Lists all group snapshots. + +**Optional arguments:** + +``--all-tenants [<0|1>]`` + Shows details for all tenants. Admin only. + +``--status `` + Filters results by a status. Default=None. + +``--group-id `` + Filters results by a group ID. Default=None. + +.. _cinder_group-snapshot-show: + +cinder group-snapshot-show +-------------------------- + +.. code-block:: console + + usage: cinder group-snapshot-show + +Shows group snapshot details. + +**Positional arguments:** + +```` + Name or ID of group snapshot. + +.. _cinder_group-specs-list: + +cinder group-specs-list +----------------------- + +.. code-block:: console + + usage: cinder group-specs-list + +Lists current group types and specs. + +.. _cinder_group-type-create: + +cinder group-type-create +------------------------ + +.. code-block:: console + + usage: cinder group-type-create [--description ] + [--is-public ] + + +Creates a group type. + +**Positional arguments:** + +```` + Name of new group type. + +**Optional arguments:** + +``--description `` + Description of new group type. + +``--is-public `` + Make type accessible to the public (default true). + +.. _cinder_group-type-default: + +cinder group-type-default +------------------------- + +.. code-block:: console + + usage: cinder group-type-default + +List the default group type. + +.. _cinder_group-type-delete: + +cinder group-type-delete +------------------------ + +.. code-block:: console + + usage: cinder group-type-delete [ ...] + +Deletes group type or types. + +**Positional arguments:** + +```` + Name or ID of group type or types to delete. + +.. _cinder_group-type-key: + +cinder group-type-key +--------------------- + +.. code-block:: console + + usage: cinder group-type-key [ ...] + +Sets or unsets group_spec for a group type. + +**Positional arguments:** + +```` + Name or ID of group type. + +```` + The action. Valid values are "set" or "unset." + +```` + The group specs key and value pair to set or unset. For unset, + specify only the key. + +.. _cinder_group-type-list: + +cinder group-type-list +---------------------- + +.. code-block:: console + + usage: cinder group-type-list + +Lists available 'group types'. (Admin only will see private types) + +.. _cinder_group-type-show: + +cinder group-type-show +---------------------- + +.. code-block:: console + + usage: cinder group-type-show + +Show group type details. + +**Positional arguments:** + +```` + Name or ID of the group type. + +.. _cinder_group-type-update: + +cinder group-type-update +------------------------ + +.. code-block:: console + + usage: cinder group-type-update [--name ] [--description ] + [--is-public ] + + +Updates group type name, description, and/or is_public. + +**Positional arguments:** + +```` + ID of the group type. + +**Optional arguments:** + +``--name `` + Name of the group type. + +``--description `` + Description of the group type. + +``--is-public `` + Make type accessible to the public or not. + +.. _cinder_group-update: + +cinder group-update +------------------- + +.. code-block:: console + + usage: cinder group-update [--name ] [--description ] + [--add-volumes ] + [--remove-volumes ] + + +Updates a group. + +**Positional arguments:** + +```` + Name or ID of a group. + +**Optional arguments:** + +``--name `` + New name for group. Default=None. + +``--description `` + New description for group. Default=None. + +``--add-volumes `` + UUID of one or more volumes to be added to the group, + separated by commas. Default=None. + +``--remove-volumes `` + UUID of one or more volumes to be removed from the + group, separated by commas. Default=None. + .. _cinder_image-metadata: cinder image-metadata @@ -1417,9 +2540,11 @@ cinder list .. code-block:: console - usage: cinder list [--all-tenants [<0|1>]] [--name ] [--status ] + usage: cinder list [--group_id ] [--all-tenants [<0|1>]] + [--name ] [--status ] [--bootable []] [--migration_status ] + [--metadata [ [ ...]]] [--image_metadata [ [ ...]]] [--marker ] [--limit ] [--fields ] [--sort [:]] [--tenant []] @@ -1428,6 +2553,10 @@ Lists all volumes. **Optional arguments:** +``--group_id `` + Filters results by a group_id. Default=None. + (Supported by API version 3.10 and later) + ``--all-tenants [<0|1>]`` Shows details for all tenants. Admin only. @@ -1444,9 +2573,14 @@ Lists all volumes. Filters results by a migration status. Default=None. Admin only. +``--metadata [ [ ...]]`` + Filters results by a metadata key and value pair. + Default=None. + ``--image_metadata [ [ ...]]`` Filters results by a image metadata key and value - pair. Default=None. + pair. Require volume api version >=3.4. Default=None. + (Supported by API version 3.4 and later) ``--marker `` Begin returning volumes that appear later in the @@ -1567,11 +2701,90 @@ Lists all manageable volumes. ``--offset `` Number of volumes to skip after marker. Default=None. +``--sort [:]`` + Comma-separated list of sort keys and directions in + the form of [:]. Valid keys: size, + reference. Default=None. + +.. _cinder_message-delete: + +cinder message-delete +--------------------- + +.. code-block:: console + + usage: cinder message-delete [ ...] + +Removes one or more messages. + +**Positional arguments:** + +```` + ID of one or more message to be deleted. + +.. _cinder_message-list: + +cinder message-list +------------------- + +.. code-block:: console + + usage: cinder message-list [--marker ] [--limit ] + [--sort [:]] + [--resource_uuid ] + [--resource_type ] [--event_id ] + [--request_id ] [--level ] + +Lists all messages. + +**Optional arguments:** + +``--marker `` + Begin returning message that appear later in the + message list than that represented by this id. + Default=None. (Supported by API version 3.5 and later) + +``--limit `` + Maximum number of messages to return. Default=None. + (Supported by API version 3.5 and later) + ``--sort [:]`` Comma-separated list of sort keys and directions in the form of [:]. Valid keys: id, status, size, availability_zone, name, bootable, - created_at, reference. Default=None. + created_at, reference. Default=None. (Supported by API + version 3.5 and later) + +``--resource_uuid `` + Filters results by a resource uuid. Default=None. + +``--resource_type `` + Filters results by a resource type. Default=None. + +``--event_id `` + Filters results by event id. Default=None. + +``--request_id `` + Filters results by request id. Default=None. + +``--level `` + Filters results by the message level. Default=None. + +.. _cinder_message-show: + +cinder message-show +------------------- + +.. code-block:: console + + usage: cinder message-show + +Shows message details. + +**Positional arguments:** + +```` + ID of message. .. _cinder_metadata: @@ -1594,7 +2807,8 @@ Sets or deletes volume metadata. ```` Metadata key and value pair to set or unset. For unset, specify - only the key. + only the key(s): (Supported by API version 3.15 and + later) .. _cinder_metadata-show: @@ -1949,6 +3163,7 @@ cinder quota-update [--gigabytes ] [--backups ] [--backup-gigabytes ] [--consistencygroups ] + [--groups ] [--volume-type ] [--per-volume-gigabytes ] @@ -1980,6 +3195,10 @@ Updates quotas for a tenant. ``--consistencygroups `` The new "consistencygroups" quota value. Default=None. +``--groups `` + The new "groups" quota value. Default=None. (Supported + by API version 3.13 and later) + ``--volume-type `` Volume type. Default=None. @@ -2254,7 +3473,8 @@ Lists all services. Filter by host and service binary. ``--withreplication []`` Enables or disables display of Replication info for - c-vol services. Default=False. + c-vol services. Default=False. (Supported by API + version 3.7 and later) .. _cinder_set-bootable: @@ -2361,6 +3581,7 @@ cinder snapshot-list [--status ] [--volume-id ] [--marker ] [--limit ] [--sort [:]] [--tenant []] + [--metadata [ [ ...]]] Lists all snapshots. @@ -2395,6 +3616,11 @@ Lists all snapshots. ``--tenant []`` Display information from single tenant (Admin only). +``--metadata [ [ ...]]`` + Filters results by a metadata key and value pair. + Require volume api version >=3.22. Default=None. + (Supported by API version 3.22 and later) + .. _cinder_snapshot-manage: cinder snapshot-manage @@ -2471,9 +3697,8 @@ Lists all manageable snapshots. ``--sort [:]`` Comma-separated list of sort keys and directions in - the form of [:]. Valid keys: id, - status, size, availability_zone, name, bootable, - created_at, reference. Default=None. + the form of [:]. Valid keys: size, + reference. Default=None. .. _cinder_snapshot-metadata: @@ -2940,6 +4165,8 @@ cinder upload-to-image usage: cinder upload-to-image [--force []] [--container-format ] [--disk-format ] + [--visibility ] + [--protected ] Uploads volume to Image Service as an image. @@ -2965,3 +4192,23 @@ Uploads volume to Image Service as an image. ``--disk-format `` Disk format type. Default is raw. +``--visibility `` + Set image visibility to either public or private. + Default=private. (Supported by API version 3.1 and + later) + +``--protected `` + Prevents image from being deleted. Default=False. + (Supported by API version 3.1 and later) + +.. _cinder_version-list: + +cinder version-list +------------------- + +.. code-block:: console + + usage: cinder version-list + +List all API versions. +