diff --git a/doc/cli-reference/generated/ch_cli_cinder_commands.xml b/doc/cli-reference/generated/ch_cli_cinder_commands.xml
index a0b13a4760..c9c20118eb 100644
--- a/doc/cli-reference/generated/ch_cli_cinder_commands.xml
+++ b/doc/cli-reference/generated/ch_cli_cinder_commands.xml
@@ -15,7 +15,7 @@
interface (CLI) for the OpenStack Block Storage API and its extensions.
This chapter documents cinder version
- 1.3.1.
+ 1.4.0.
For help on a specific cinder
@@ -43,9 +43,9 @@
[--os-project-name <auth-project-name>]
[--os-project-domain-id <auth-project-domain-id>]
[--os-project-domain-name <auth-project-domain-name>]
- [--os-cert <certificate>] [--os-key <key>]
[--os-region-name <region-name>] [--os-token <token>]
- [--os-url <url>] [--os-cacert <ca-certificate>]
+ [--os-url <url>] [--insecure] [--os-cacert <ca-certificate>]
+ [--os-cert <certificate>] [--os-key <key>] [--timeout <seconds>]
<subcommand> ...
Subcommands
@@ -81,6 +81,22 @@
+
+ backup-export
+
+
+ Export backup metadata record.
+
+
+
+
+ backup-import
+
+
+ Import backup metadata record.
+
+
+
backup-list
@@ -101,7 +117,88 @@
backup-show
- Show backup details.
+ Shows backup details.
+
+
+
+
+ cgsnapshot-create
+
+
+ Creates a cgsnapshot.
+
+
+
+
+ cgsnapshot-delete
+
+
+ Removes one or more cgsnapshots.
+
+
+
+
+ cgsnapshot-list
+
+
+ Lists all cgsnapshots.
+
+
+
+
+ cgsnapshot-show
+
+
+ Shows cgsnapshot details.
+
+
+
+
+ consisgroup-create
+
+
+ Creates a consistency group.
+
+
+
+
+ consisgroup-create-from-src
+
+
+ Creates a consistency group from a cgsnapshot or a
+ source CG.
+
+
+
+
+ consisgroup-delete
+
+
+ Removes one or more consistency groups.
+
+
+
+
+ consisgroup-list
+
+
+ Lists all consistencygroups.
+
+
+
+
+ consisgroup-show
+
+
+ Shows details of a consistency group.
+
+
+
+
+ consisgroup-update
+
+
+ Updates a consistencygroup.
@@ -158,11 +255,20 @@
encryption-type-show
- Shows encryption type details for volume type. Admin
+ Shows encryption type details for a volume type. Admin
only.
+
+ encryption-type-update
+
+
+ Update encryption type information for a volume type
+ (Admin Only).
+
+
+
endpoints
@@ -196,6 +302,30 @@
+
+ get-capabilities
+
+
+ Show backend volume stats and properties. Admin only.
+
+
+
+
+ get-pools
+
+
+ Show pool information for backends. Admin only.
+
+
+
+
+ image-metadata
+
+
+ Sets or deletes volume image metadata.
+
+
+
list
@@ -204,6 +334,14 @@
+
+ manage
+
+
+ Manage an existing volume.
+
+
+
metadata
@@ -272,7 +410,7 @@
qos-disassociate-all
- Disassociates qos specs from all associations.
+ Disassociates qos specs from all its associations.
@@ -280,7 +418,7 @@
qos-get-association
- Gets all associations for specified qos specs.
+ Lists all associations for specified qos specs.
@@ -304,7 +442,7 @@
qos-show
- Shows a specified qos specs.
+ Shows qos specs details.
@@ -388,11 +526,38 @@
+
+ replication-promote
+
+
+ Promote a secondary volume to primary for a
+ relationship.
+
+
+
+
+ replication-reenable
+
+
+ Sync the secondary volume with primary for a
+ relationship.
+
+
+
reset-state
- Explicitly updates the volume state.
+ Explicitly updates the volume state in the Cinder
+ database.
+
+
+
+
+ retype
+
+
+ Changes the volume type for a volume.
@@ -448,7 +613,7 @@
snapshot-delete
- Remove one or more snapshots.
+ Removes one or more snapshots.
@@ -544,7 +709,31 @@
transfer-show
- Show transfer details.
+ Shows transfer details.
+
+
+
+
+ type-access-add
+
+
+ Adds volume type access for the given project.
+
+
+
+
+ type-access-list
+
+
+ Print access information about the given volume type.
+
+
+
+
+ type-access-remove
+
+
+ Removes volume type access for the given project.
@@ -556,11 +745,19 @@
+
+ type-default
+
+
+ List the default volume type.
+
+
+
type-delete
- Deletes a specified volume type.
+ Deletes a volume type.
@@ -576,7 +773,24 @@
type-list
- Lists available 'volume types'.
+ Lists available 'volume types'. (Admin only will see
+ private types)
+
+
+
+
+ type-update
+
+
+ Updates volume type name and/or description.
+
+
+
+
+ unmanage
+
+
+ Stop managing a volume.
@@ -824,22 +1038,6 @@
-
- --os-cert <certificate>
-
-
- Defaults to env[OS_CERT].
-
-
-
-
- --os-key <key>
-
-
- Defaults to env[OS_KEY].
-
-
-
--os-region-name <region-name>
@@ -864,12 +1062,48 @@
+
+ --insecure
+
+
+ Explicitly allow client to perform "insecure" TLS
+ (https) requests. The server's certificate will not be
+ verified against any certificate authorities. This
+ option should be used with caution.
+
+
+
--os-cacert <ca-certificate>
Specify a CA bundle file to use in verifying a TLS
- (https) server certificate. Defaults to env[OS_CACERT]
+ (https) server certificate. Defaults to
+ env[OS_CACERT].
+
+
+
+
+ --os-cert <certificate>
+
+
+ Defaults to env[OS_CERT].
+
+
+
+
+ --os-key <key>
+
+
+ Defaults to env[OS_KEY].
+
+
+
+
+ --timeout <seconds>
+
+
+ Set request timeout (in seconds).
@@ -894,9 +1128,9 @@ Lists all availability zones.
cinder backup-create
- usage: cinder backup-create [--container <container>]
- [--display-name <display-name>]
- [--display-description <display-description>]
+ usage: cinder backup-create [--container <container>] [--name <name>]
+ [--description <description>] [--incremental]
+ [--force]
<volume>
Creates a volume backup.
@@ -906,7 +1140,7 @@ Creates a volume backup.
<volume>
- Name or ID of volume to back up.
+ Name or ID of volume to backup.
@@ -922,21 +1156,41 @@ Creates a volume backup.
- --display-name <display-name>
+ --name <name>
- Backup name. Default=None.
+ Backup name. Default=None.
- --display-description <display-description>
+ --description <description>
Backup description. Default=None.
+
+ --incremental
+
+
+ Incremental backup. Default=False.
+
+
+
+
+ --force
+
+
+ Allows or disallows backup of a volume when the volume
+ is attached to an instance. If set to True, backs up
+ the volume whether its status is "available" or "in-
+ use". The backup of an "in-use" volume means your data
+ is crash consistent. Default=False.
+
+
+
@@ -954,18 +1208,95 @@ Removes a backup.
+
+
+
+ cinder backup-export
+ usage: cinder backup-export <backup>
+
+Export backup metadata record.
+
+ Positional arguments
+
+ <backup>
+
+
+ ID of the backup to export.
+
+
+
+
+
+
+ cinder backup-import
+ usage: cinder backup-import <backup_service> <backup_url>
+
+Import backup metadata record.
+
+ Positional arguments
+
+ <backup_service>
+
+
+ Backup service to use for importing the backup.
+
+
+
+
+ <backup_url>
+
+
+ Backup URL for importing the backup metadata.
+
+
+
cinder backup-list
- usage: cinder backup-list
+ usage: cinder backup-list [--all-tenants [<all_tenants>]] [--name <name>]
+ [--status <status>] [--volume-id <volume-id>]
Lists all backups.
-
+
+ Optional arguments
+
+ --all-tenants [<all_tenants>]
+
+
+ Shows details for all tenants. Admin only.
+
+
+
+
+ --name <name>
+
+
+ Filters results by a name. Default=None.
+
+
+
+
+ --status <status>
+
+
+ Filters results by a status. Default=None.
+
+
+
+
+ --volume-id <volume-id>
+
+
+ Filters results by a volume ID. Default=None.
+
+
+
+
cinder backup-restore
- usage: cinder backup-restore [--volume-id <volume>] <backup>
+ usage: cinder backup-restore [--volume <volume>] <backup>
Restores a backup.
@@ -982,11 +1313,10 @@ Restores a backup.
Optional arguments
- --volume-id <volume>
+ --volume <volume>
- ID or name of backup volume to which to restore.
- Default=None.
+ Name or ID of volume to which to restore. Default=None.
@@ -996,7 +1326,7 @@ Restores a backup.
cinder backup-show
usage: cinder backup-show <backup>
-Show backup details.
+Shows backup details.
Positional arguments
@@ -1007,18 +1337,341 @@ Show backup details.
+
+
+
+ cinder cgsnapshot-create
+ usage: cinder cgsnapshot-create [--name <name>] [--description <description>]
+ <consistencygroup>
+
+Creates a cgsnapshot.
+
+ Positional arguments
+
+ <consistencygroup>
+
+
+ Name or ID of a consistency group.
+
+
+
+
+
+ Optional arguments
+
+ --name <name>
+
+
+ Cgsnapshot name. Default=None.
+
+
+
+
+ --description <description>
+
+
+ Cgsnapshot description. Default=None.
+
+
+
+
+
+
+ cinder cgsnapshot-delete
+ usage: cinder cgsnapshot-delete <cgsnapshot> [<cgsnapshot> ...]
+
+Removes one or more cgsnapshots.
+
+ Positional arguments
+
+ <cgsnapshot>
+
+
+ Name or ID of one or more cgsnapshots to be deleted.
+
+
+
+
+
+
+ cinder cgsnapshot-list
+ usage: cinder cgsnapshot-list [--all-tenants [<0|1>]] [--status <status>]
+ [--consistencygroup-id <consistencygroup_id>]
+
+Lists all cgsnapshots.
+
+ Optional arguments
+
+ --all-tenants [<0|1>]
+
+
+ Shows details for all tenants. Admin only.
+
+
+
+
+ --status <status>
+
+
+ Filters results by a status. Default=None.
+
+
+
+
+ --consistencygroup-id <consistencygroup_id>
+
+
+ Filters results by a consistency group ID.
+ Default=None.
+
+
+
+
+
+
+ cinder cgsnapshot-show
+ usage: cinder cgsnapshot-show <cgsnapshot>
+
+Shows cgsnapshot details.
+
+ Positional arguments
+
+ <cgsnapshot>
+
+
+ Name or ID of cgsnapshot.
+
+
+
+
+
+
+ cinder consisgroup-create
+ usage: cinder consisgroup-create [--name <name>] [--description <description>]
+ [--availability-zone <availability-zone>]
+ <volume-types>
+
+Creates a consistency group.
+
+ Positional arguments
+
+ <volume-types>
+
+
+ Volume types.
+
+
+
+
+
+ Optional arguments
+
+ --name <name>
+
+
+ Name of a consistency group.
+
+
+
+
+ --description <description>
+
+
+ Description of a consistency group. Default=None.
+
+
+
+
+ --availability-zone <availability-zone>
+
+
+ Availability zone for volume. Default=None.
+
+
+
+
+
+
+ cinder consisgroup-create-from-src
+ usage: cinder consisgroup-create-from-src [--cgsnapshot <cgsnapshot>]
+ [--source-cg <source-cg>]
+ [--name <name>]
+ [--description <description>]
+
+Creates a consistency group from a cgsnapshot or a source CG.
+
+ Optional arguments
+
+ --cgsnapshot <cgsnapshot>
+
+
+ Name or ID of a cgsnapshot. Default=None.
+
+
+
+
+ --source-cg <source-cg>
+
+
+ Name or ID of a source CG. Default=None.
+
+
+
+
+ --name <name>
+
+
+ Name of a consistency group. Default=None.
+
+
+
+
+ --description <description>
+
+
+ Description of a consistency group. Default=None.
+
+
+
+
+
+
+ cinder consisgroup-delete
+ usage: cinder consisgroup-delete [--force]
+ <consistencygroup> [<consistencygroup> ...]
+
+Removes one or more consistency groups.
+
+ Positional arguments
+
+ <consistencygroup>
+
+
+ Name or ID of one or more consistency groups to be
+ deleted.
+
+
+
+
+
+ Optional arguments
+
+ --force
+
+
+ Allows or disallows consistency groups to be deleted. If
+ the consistency group is empty, it can be deleted
+ without the force flag. If the consistency group is not
+ empty, the force flag is required for it to be deleted.
+
+
+
+
+
+
+ cinder consisgroup-list
+ usage: cinder consisgroup-list [--all-tenants [<0|1>]]
+
+Lists all consistencygroups.
+
+ Optional arguments
+
+ --all-tenants [<0|1>]
+
+
+ Shows details for all tenants. Admin only.
+
+
+
+
+
+
+ cinder consisgroup-show
+ usage: cinder consisgroup-show <consistencygroup>
+
+Shows details of a consistency group.
+
+ Positional arguments
+
+ <consistencygroup>
+
+
+ Name or ID of a consistency group.
+
+
+
+
+
+
+ cinder consisgroup-update
+ usage: cinder consisgroup-update [--name <name>] [--description <description>]
+ [--add-volumes <uuid1,uuid2,......>]
+ [--remove-volumes <uuid3,uuid4,......>]
+ <consistencygroup>
+
+Updates a consistencygroup.
+
+ Positional arguments
+
+ <consistencygroup>
+
+
+ Name or ID of a consistency group.
+
+
+
+
+
+ Optional arguments
+
+ --name <name>
+
+
+ New name for consistency group. Default=None.
+
+
+
+
+ --description <description>
+
+
+ New description for consistency group. Default=None.
+
+
+
+
+ --add-volumes <uuid1,uuid2,......>
+
+
+ UUID of one or more volumes to be added to the
+ consistency group, separated by commas. Default=None.
+
+
+
+
+ --remove-volumes <uuid3,uuid4,......>
+
+
+ UUID of one or more volumes to be removed from the
+ consistency group, separated by commas. Default=None.
+
+
+
cinder create
- usage: cinder create [--snapshot-id <snapshot-id>]
- [--source-volid <source-volid>] [--image-id <image-id>]
- [--display-name <display-name>]
- [--display-description <display-description>]
+ usage: cinder create [--consisgroup-id <consistencygroup-id>]
+ [--snapshot-id <snapshot-id>]
+ [--source-volid <source-volid>]
+ [--source-replica <source-replica>]
+ [--image-id <image-id>] [--image <image>] [--name <name>]
+ [--description <description>]
[--volume-type <volume-type>]
[--availability-zone <availability-zone>]
[--metadata [<key=value> [<key=value> ...]]]
- <size>
+ [--hint <key=value>] [--allow-multiattach]
+ [<size>]
Creates a volume.
@@ -1027,13 +1680,23 @@ Creates a volume.
<size>
- Volume size, in GBs.
+ Size of volume, in GBs. (Required unless snapshot-id
+ /source-volid is specified).
Optional arguments
+
+ --consisgroup-id <consistencygroup-id>
+
+
+ ID of a consistency group where the new volume belongs
+ to. Default=None.
+
+
+
--snapshot-id <snapshot-id>
@@ -1050,6 +1713,15 @@ Creates a volume.
+
+ --source-replica <source-replica>
+
+
+ Creates volume from replicated volume ID.
+ Default=None.
+
+
+
--image-id <image-id>
@@ -1059,15 +1731,24 @@ Creates a volume.
- --display-name <display-name>
+ --image <image>
- Volume name. Default=None.
+ Creates a volume from image (ID or name).
+ Default=None.
- --display-description <display-description>
+ --name <name>
+
+
+ Volume name. Default=None.
+
+
+
+
+ --description <description>
Volume description. Default=None.
@@ -1098,6 +1779,23 @@ Creates a volume.
+
+ --hint <key=value>
+
+
+ Scheduler hint, like in nova.
+
+
+
+
+ --allow-multiattach
+
+
+ Allow volume to be attached more than once.
+ Default=False
+
+
+
@@ -1118,8 +1816,7 @@ Removes one or more volumes.
<volume>
- Name or ID of volume to delete. Separate multiple volumes with a
- space.
+ Name or ID of volume or volumes to delete.
@@ -1148,7 +1845,7 @@ Creates encryption type for a volume type. Admin only.
The class that provides encryption support. For
- example, a volume driver class path.
+ example, LuksEncryptor.
@@ -1159,7 +1856,7 @@ Creates encryption type for a volume type. Admin only.
--cipher <cipher>
- The encryption algorithm and mode. For example, aes-
+ The encryption algorithm or mode. For example, aes-
xts-plain64. Default=None.
@@ -1213,7 +1910,7 @@ Shows encryption type details for volume types. Admin only.
cinder encryption-type-show
usage: cinder encryption-type-show <volume_type>
-Shows encryption type details for volume type. Admin only.
+Shows encryption type details for a volume type. Admin only.
Positional arguments
@@ -1224,6 +1921,69 @@ Shows encryption type details for volume type. Admin only.
+
+
+
+ cinder encryption-type-update
+ usage: cinder encryption-type-update [--provider <provider>]
+ [--cipher [<cipher>]]
+ [--key-size [<key-size>]]
+ [--control-location <control-location>]
+ <volume-type>
+
+Update encryption type information for a volume type (Admin Only).
+
+ Positional arguments
+
+ <volume-type>
+
+
+ Name or ID of the volume type
+
+
+
+
+
+ Optional arguments
+
+ --provider <provider>
+
+
+ Class providing encryption support (e.g.
+ LuksEncryptor) (Optional)
+
+
+
+
+ --cipher [<cipher>]
+
+
+ Encryption algorithm/mode to use (e.g., aes-xts-
+ plain64). Provide parameter without value to set to
+ provider default. (Optional)
+
+
+
+
+ --key-size [<key-size>]
+
+
+ Size of the encryption key, in bits (e.g., 128, 256).
+ Provide parameter without value to set to provider
+ default. (Optional)
+
+
+
+
+ --control-location <control-location>
+
+
+ Notional service where encryption is performed (e.g.,
+ front-end=Nova). Values: 'front-end', 'back-end'
+ (Optional)
+
+
+
@@ -1235,7 +1995,7 @@ Discovers endpoints registered by authentication service.
cinder extend
- usage: cinder extend <volume> <new-size>
+ usage: cinder extend <volume> <new_size>
Attempts to extend size of an existing volume.
@@ -1249,10 +2009,10 @@ Attempts to extend size of an existing volume.
- <new-size>
+ <new_size>
- Size of volume, in GBs.
+ New size of volume, in GBs.
@@ -1276,8 +2036,76 @@ Attempts force-delete of volume, regardless of state.
<volume>
- Name or ID of volume to delete. Separate multiple volumes with a
- space.
+ Name or ID of volume or volumes to delete.
+
+
+
+
+
+
+ cinder get-capabilities
+ usage: cinder get-capabilities <host>
+
+Show backend volume stats and properties. Admin only.
+
+ Positional arguments
+
+ <host>
+
+
+ Cinder host to show backend volume stats and properties; takes the
+ form: host@backend-name
+
+
+
+
+
+
+ cinder get-pools
+ usage: cinder get-pools [--detail]
+
+Show pool information for backends. Admin only.
+
+ Optional arguments
+
+ --detail
+
+
+ Show detailed information about pools.
+
+
+
+
+
+
+ cinder image-metadata
+ usage: cinder image-metadata <volume> <action> <key=value> [<key=value> ...]
+
+Sets or deletes volume image metadata.
+
+ Positional arguments
+
+ <volume>
+
+
+ Name or ID of volume for which to update metadata.
+
+
+
+
+ <action>
+
+
+ The action. Valid values are 'set' or 'unset.'
+
+
+
+
+ <key=value>
+
+
+ Metadata key and value pair to set or unset. For unset, specify
+ only the key.
@@ -1285,10 +2113,11 @@ Attempts force-delete of volume, regardless of state.
cinder list
- usage: cinder list [--all-tenants [<0|1>]] [--display-name <display-name>]
- [--status <status>]
+ usage: cinder list [--all-tenants [<0|1>]] [--name <name>] [--status <status>]
+ [--migration_status <migration_status>]
[--metadata [<key=value> [<key=value> ...]]]
- [--tenant [<tenant>]] [--limit <limit>]
+ [--marker <marker>] [--limit <limit>]
+ [--sort <key>[:<direction>]] [--tenant [<tenant>]]
Lists all volumes.
@@ -1302,10 +2131,10 @@ Lists all volumes.
- --display-name <display-name>
+ --name <name>
- Filters list by a volume display name. Default=None.
+ Filters results by a name. Default=None.
@@ -1313,7 +2142,16 @@ Lists all volumes.
--status <status>
- Filters list by a status. Default=None.
+ Filters results by a status. Default=None.
+
+
+
+
+ --migration_status <migration_status>
+
+
+ Filters results by a migration status. Default=None.
+ Admin only.
@@ -1321,11 +2159,40 @@ Lists all volumes.
--metadata [<key=value> [<key=value> ...]]
- Filters list by metadata key and value pair.
+ Filters results by a metadata key and value pair.
Default=None.
+
+ --marker <marker>
+
+
+ Begin returning volumes that appear later in the
+ volume list than that represented by this volume id.
+ Default=None.
+
+
+
+
+ --limit <limit>
+
+
+ Maximum number of volumes to return. Default=None.
+
+
+
+
+ --sort <key>[:<direction>]
+
+
+ Comma-separated list of sort keys and directions in
+ the form of <key>[:<asc|desc>]. Valid keys: id,
+ status, size, availability_zone, name, bootable,
+ created_at. Default=None.
+
+
+
--tenant [<tenant>]
@@ -1334,15 +2201,6 @@ Lists all volumes.
-
- --limit <limit>
-
-
- Maximum number of volumes to return. OPTIONAL:
- Default=None.
-
-
-
@@ -1352,6 +2210,98 @@ Lists all volumes.
Lists all available os-api extensions.
+
+ cinder manage
+ usage: cinder manage [--id-type <id-type>] [--name <name>]
+ [--description <description>]
+ [--volume-type <volume-type>]
+ [--availability-zone <availability-zone>]
+ [--metadata [<key=value> [<key=value> ...]]] [--bootable]
+ <host> <identifier>
+
+Manage an existing volume.
+
+ Positional arguments
+
+ <host>
+
+
+ Cinder host on which the existing volume resides;
+ takes the form: host@backend-name#pool
+
+
+
+
+ <identifier>
+
+
+ Name or other Identifier for existing volume
+
+
+
+
+
+ Optional arguments
+
+ --id-type <id-type>
+
+
+ Type of backend device identifier provided, typically
+ source-name or source-id (Default=source-name)
+
+
+
+
+ --name <name>
+
+
+ Volume name (Default=None)
+
+
+
+
+ --description <description>
+
+
+ Volume description (Default=None)
+
+
+
+
+ --volume-type <volume-type>
+
+
+ Volume type (Default=None)
+
+
+
+
+ --availability-zone <availability-zone>
+
+
+ Availability zone for volume (Default=None)
+
+
+
+
+ --metadata [<key=value> [<key=value> ...]]
+
+
+ Metadata key=value pairs (Default=None)
+
+
+
+
+ --bootable
+
+
+ Specifies that the newly created volume should be
+ marked as bootable
+
+
+
+
+
cinder metadata
usage: cinder metadata <volume> <action> <key=value> [<key=value> ...]
@@ -1379,8 +2329,8 @@ Sets or deletes volume metadata.
<key=value>
- The metadata key and pair to set or unset. For unset, specify
- only the key. Default=[].
+ Metadata key and value pair to set or unset. For unset, specify
+ only the key.
@@ -1422,7 +2372,7 @@ Updates volume metadata.
<key=value>
- Metadata key and value pair or pairs to update. Default=[].
+ Metadata key and value pair or pairs to update.
@@ -1430,7 +2380,9 @@ Updates volume metadata.
cinder migrate
- usage: cinder migrate [--force-host-copy <True|False>] <volume> <host>
+ usage: cinder migrate [--force-host-copy [<True|False>]]
+ [--lock-volume [<True|False>]]
+ <volume> <host>
Migrates volume to a new host.
@@ -1455,7 +2407,7 @@ Migrates volume to a new host.
Optional arguments
- --force-host-copy <True|False>
+ --force-host-copy [<True|False>]
Enables or disables generic host-based force-
@@ -1464,6 +2416,21 @@ Migrates volume to a new host.
+
+ --lock-volume [<True|False>]
+
+
+ Enables or disables the termination of volume
+ migration caused by other commands. This option
+ applies to the available volume. True means it locks
+ the volume state and does not allow the migration to
+ be aborted. The volume status will be in maintenance
+ during the migration. False means it allows the volume
+ migration to be aborted. The volume status is still in
+ the original status. Default=False.
+
+
+
@@ -1485,7 +2452,8 @@ Associates qos specs with specified volume type.
<volume_type_id>
- ID of volume type.
+ ID of volume type with which to associate QoS
+ specifications.
@@ -1510,7 +2478,7 @@ Creates a qos specs.
<key=value>
- Specifications for QoS.
+ QoS specifications.
@@ -1518,7 +2486,7 @@ Creates a qos specs.
cinder qos-delete
- usage: cinder qos-delete [--force <True|False>] <qos_specs>
+ usage: cinder qos-delete [--force [<True|False>]] <qos_specs>
Deletes a specified qos specs.
@@ -1527,7 +2495,7 @@ Deletes a specified qos specs.
<qos_specs>
- ID of QoS specifications.
+ ID of QoS specifications to delete.
@@ -1535,10 +2503,10 @@ Deletes a specified qos specs.
Optional arguments
- --force <True|False>
+ --force [<True|False>]
- Enables or disables deletion of in-use QoS
+ Enables or disables deletion of in-use QoS
specifications. Default=False.
@@ -1564,7 +2532,8 @@ Disassociates qos specs from specified volume type.
<volume_type_id>
- ID of volume type.
+ ID of volume type with which to associate QoS
+ specifications.
@@ -1574,14 +2543,14 @@ Disassociates qos specs from specified volume type.
cinder qos-disassociate-all
usage: cinder qos-disassociate-all <qos_specs>
-Disassociates qos specs from all associations.
+Disassociates qos specs from all its associations.
Positional arguments
<qos_specs>
- ID of QoS specifications.
+ ID of QoS specifications on which to operate.
@@ -1591,7 +2560,7 @@ Disassociates qos specs from all associations.
cinder qos-get-association
usage: cinder qos-get-association <qos_specs>
-Gets all associations for specified qos specs.
+Lists all associations for specified qos specs.
Positional arguments
@@ -1649,14 +2618,14 @@ Lists qos specs.
cinder qos-show
usage: cinder qos-show <qos_specs>
-Shows a specified qos specs.
+Shows qos specs details.
Positional arguments
<qos_specs>
- ID of QoS specifications.
+ ID of QoS specifications to show.
@@ -1685,13 +2654,13 @@ Lists quotas for a quota class.
[--snapshots <snapshots>]
[--gigabytes <gigabytes>]
[--volume-type <volume_type_name>]
- <class>
+ <class_name>
Updates quotas for a quota class.
Positional arguments
- <class>
+ <class_name>
Name of quota class for which to set quotas.
@@ -1746,7 +2715,7 @@ Lists default quotas for a tenant.
<tenant_id>
- ID of the tenant for which to list default quotas.
+ ID of tenant for which to list quota defaults.
@@ -1780,7 +2749,7 @@ Lists quotas for a tenant.
<tenant_id>
- ID of the tenant for which to list quotas.
+ ID of tenant for which to list quotas.
@@ -1791,7 +2760,9 @@ Lists quotas for a tenant.
usage: cinder quota-update [--volumes <volumes>] [--snapshots <snapshots>]
[--gigabytes <gigabytes>] [--backups <backups>]
[--backup-gigabytes <backup_gigabytes>]
+ [--consistencygroups <consistencygroups>]
[--volume-type <volume_type_name>]
+ [--per-volume-gigabytes <per_volume_gigabytes>]
<tenant_id>
Updates quotas for a tenant.
@@ -1801,7 +2772,7 @@ Updates quotas for a tenant.
<tenant_id>
- ID of the tenant for which to set quotas.
+ ID of tenant for which to set quotas.
@@ -1848,6 +2819,14 @@ Updates quotas for a tenant.
+
+ --consistencygroups <consistencygroups>
+
+
+ The new "consistencygroups" quota value. Default=None.
+
+
+
--volume-type <volume_type_name>
@@ -1856,6 +2835,14 @@ Updates quotas for a tenant.
+
+ --per-volume-gigabytes <per_volume_gigabytes>
+
+
+ Set max volume size limit. Default=None.
+
+
+
@@ -1869,7 +2856,7 @@ Lists quota usage for a tenant.
<tenant_id>
- ID of the tenant for which to list quota usage.
+ ID of tenant for which to list quota usage.
@@ -1910,8 +2897,7 @@ Updates volume read-only access-mode flag.
cinder rename
- usage: cinder rename [--display-description <display-description>]
- <volume> [<display-name>]
+ usage: cinder rename [--description <description>] <volume> [<name>]
Renames a volume.
@@ -1925,10 +2911,10 @@ Renames a volume.
- <display-name>
+ <name>
- New display name for volume.
+ New name for volume.
@@ -1936,7 +2922,7 @@ Renames a volume.
Optional arguments
- --display-description <display-description>
+ --description <description>
Volume description. Default=None.
@@ -1945,19 +2931,61 @@ Renames a volume.
-
- cinder reset-state
- usage: cinder reset-state [--state <state>] <volume> [<volume> ...]
+
+ cinder replication-promote
+ usage: cinder replication-promote <volume>
-Explicitly updates the volume state.
+Promote a secondary volume to primary for a relationship.
Positional arguments
<volume>
- Name or ID of volume to modify. Separate multiple volumes
- with a space.
+ Name or ID of the volume to promote. The volume should have the
+ replica volume created with source-replica argument.
+
+
+
+
+
+
+ cinder replication-reenable
+ usage: cinder replication-reenable <volume>
+
+Sync the secondary volume with primary for a relationship.
+
+ Positional arguments
+
+ <volume>
+
+
+ Name or ID of the volume to reenable replication. The replication-
+ status of the volume should be inactive.
+
+
+
+
+
+
+ cinder reset-state
+ usage: cinder reset-state [--state <state>] [--attach-status <attach-status>]
+ [--reset-migration-status]
+ <volume> [<volume> ...]
+
+Explicitly updates the volume state in the Cinder database. Note that this
+does not affect whether the volume is actually attached to the Nova compute
+host or instance and can result in an unusable volume. Being a database change
+only, this has no impact on the true state of the volume and may not match the
+actual state. This can render a volume unusable in the case of change to the
+'available' state.
+
+ Positional arguments
+
+ <volume>
+
+
+ Name or ID of volume to modify.
@@ -1969,11 +2997,71 @@ Explicitly updates the volume state.
The state to assign to the volume. Valid values are
- "available," "error," "creating," "deleting," "in-use,"
- "attaching," "detaching" and "error_deleting." NOTE: This
- command simply changes the state of the Volume in the
- DataBase with no regard to actual status, exercise caution
- when using. Default=available.
+ "available", "error", "creating", "deleting", "in-
+ use", "attaching", "detaching", "error_deleting" and
+ "maintenance". NOTE: This command simply changes the
+ state of the Volume in the DataBase with no regard to
+ actual status, exercise caution when using.
+ Default=available.
+
+
+
+
+ --attach-status <attach-status>
+
+
+ The attach status to assign to the volume in the
+ DataBase, with no regard to the actual status. Valid
+ values are "attached" and "detached". Default=None,
+ that means the status is unchanged.
+
+
+
+
+ --reset-migration-status
+
+
+ Clears the migration status of the volume in the
+ DataBase that indicates the volume is source or
+ destination of volume migration, with no regard to the
+ actual status.
+
+
+
+
+
+
+ cinder retype
+ usage: cinder retype [--migration-policy <never|on-demand>]
+ <volume> <volume-type>
+
+Changes the volume type for a volume.
+
+ Positional arguments
+
+ <volume>
+
+
+ Name or ID of volume for which to modify type.
+
+
+
+
+ <volume-type>
+
+
+ New volume type.
+
+
+
+
+
+ Optional arguments
+
+ --migration-policy <never|on-demand>
+
+
+ Migration policy during retype of volume.
@@ -2101,7 +3189,7 @@ Shows volume details.
<volume>
- Volume name or ID.
+ Name or ID of volume.
@@ -2109,9 +3197,9 @@ Shows volume details.
cinder snapshot-create
- usage: cinder snapshot-create [--force <True|False>]
- [--display-name <display-name>]
- [--display-description <display-description>]
+ usage: cinder snapshot-create [--force [<True|False>]] [--name <name>]
+ [--description <description>]
+ [--metadata [<key=value> [<key=value> ...]]]
<volume>
Creates a snapshot.
@@ -2129,10 +3217,10 @@ Creates a snapshot.
Optional arguments
- --force <True|False>
+ --force [<True|False>]
- Allows or disallows snapshot of a volume when the
+ Allows or disallows snapshot of a volume when the
volume is attached to an instance. If set to True,
ignores the current status of the volume when
attempting to snapshot it rather than forcing it to be
@@ -2141,18 +3229,26 @@ Creates a snapshot.
- --display-name <display-name>
+ --name <name>
- The snapshot name. Default=None.
+ Snapshot name. Default=None.
- --display-description <display-description>
+ --description <description>
- The snapshot description. Default=None.
+ Snapshot description. Default=None.
+
+
+
+
+ --metadata [<key=value> [<key=value> ...]]
+
+
+ Snapshot metadata key and value pairs. Default=None.
@@ -2162,7 +3258,7 @@ Creates a snapshot.
cinder snapshot-delete
usage: cinder snapshot-delete <snapshot> [<snapshot> ...]
-Remove one or more snapshots.
+Removes one or more snapshots.
Positional arguments
@@ -2177,8 +3273,7 @@ Remove one or more snapshots.
cinder snapshot-list
- usage: cinder snapshot-list [--all-tenants [<0|1>]]
- [--display-name <display-name>]
+ usage: cinder snapshot-list [--all-tenants [<0|1>]] [--name <name>]
[--status <status>] [--volume-id <volume-id>]
Lists all snapshots.
@@ -2193,10 +3288,10 @@ Lists all snapshots.
- --display-name <display-name>
+ --name <name>
- Filters list by a display name. Default=None.
+ Filters results by a name. Default=None.
@@ -2204,7 +3299,7 @@ Lists all snapshots.
--status <status>
- Filters list by a status. Default=None.
+ Filters results by a status. Default=None.
@@ -2212,7 +3307,7 @@ Lists all snapshots.
--volume-id <volume-id>
- Filters list by a volume ID. Default=None.
+ Filters results by a volume ID. Default=None.
@@ -2246,8 +3341,8 @@ Sets or deletes snapshot metadata.
<key=value>
- The metadata key and value pair to set or unset. For unset,
- specify only the key.
+ Metadata key and value pair to set or unset. For unset, specify
+ only the key.
@@ -2290,7 +3385,7 @@ Updates snapshot metadata.
<key=value>
- Metadata key and value pair or pairs to update. Default=[].
+ Metadata key and value pair to update.
@@ -2298,8 +3393,8 @@ Updates snapshot metadata.
cinder snapshot-rename
- usage: cinder snapshot-rename [--display-description <display-description>]
- <snapshot> [<display-name>]
+ usage: cinder snapshot-rename [--description <description>]
+ <snapshot> [<name>]
Renames a snapshot.
@@ -2313,10 +3408,10 @@ Renames a snapshot.
- <display-name>
+ <name>
- New display name for snapshot.
+ New name for snapshot.
@@ -2324,7 +3419,7 @@ Renames a snapshot.
Optional arguments
- --display-description <display-description>
+ --description <description>
Snapshot description. Default=None.
@@ -2357,8 +3452,8 @@ Explicitly updates the snapshot state.
The state to assign to the snapshot. Valid values are
- "available," "error," "creating," "deleting," and
- "error_deleting." NOTE: This command simply changes the
+ "available", "error", "creating", "deleting", and
+ "error_deleting". NOTE: This command simply changes the
state of the Snapshot in the DataBase with no regard to
actual status, exercise caution when using.
Default=available.
@@ -2411,7 +3506,7 @@ Accepts a volume transfer.
cinder transfer-create
- usage: cinder transfer-create [--display-name <display-name>] <volume>
+ usage: cinder transfer-create [--name <name>] <volume>
Creates a volume transfer.
@@ -2428,10 +3523,10 @@ Creates a volume transfer.
Optional arguments
- --display-name <display-name>
+ --name <name>
- Transfer name. Default=None.
+ Transfer name. Default=None.
@@ -2475,7 +3570,7 @@ Lists all transfers.
cinder transfer-show
usage: cinder transfer-show <transfer>
-Show transfer details.
+Shows transfer details.
Positional arguments
@@ -2486,11 +3581,84 @@ Show transfer details.
+
+
+
+ cinder type-access-add
+ usage: cinder type-access-add --volume-type <volume_type> --project-id
+ <project_id>
+
+Adds volume type access for the given project.
+
+ Optional arguments
+
+ --volume-type <volume_type>
+
+
+ Volume type name or ID to add access for the given
+ project.
+
+
+
+
+ --project-id <project_id>
+
+
+ Project ID to add volume type access for.
+
+
+
+
+
+
+ cinder type-access-list
+ usage: cinder type-access-list --volume-type <volume_type>
+
+Print access information about the given volume type.
+
+ Optional arguments
+
+ --volume-type <volume_type>
+
+
+ Filter results by volume type name or ID.
+
+
+
+
+
+
+ cinder type-access-remove
+ usage: cinder type-access-remove --volume-type <volume_type> --project-id
+ <project_id>
+
+Removes volume type access for the given project.
+
+ Optional arguments
+
+ --volume-type <volume_type>
+
+
+ Volume type name or ID to remove access for the given
+ project.
+
+
+
+
+ --project-id <project_id>
+
+
+ Project ID to remove volume type access for.
+
+
+
cinder type-create
- usage: cinder type-create <name>
+ usage: cinder type-create [--description <description>]
+ [--is-public <is-public>]
+ <name>
Creates a volume type.
@@ -2499,17 +3667,43 @@ Creates a volume type.
<name>
- Name for the volume type.
+ Name of new volume type.
+
+
+
+
+
+ Optional arguments
+
+ --description <description>
+
+
+ Description of new volume type.
+
+
+
+
+ --is-public <is-public>
+
+
+ Make type accessible to the public (default true).
+
+ cinder type-default
+ usage: cinder type-default
+
+List the default volume type.
+
+
cinder type-delete
usage: cinder type-delete <id>
-Deletes a specified volume type.
+Deletes a volume type.
Positional arguments
@@ -2524,7 +3718,7 @@ Deletes a specified volume type.
cinder type-key
- usage: cinder type-key <vtype> <action> [<key=value> [<key=value> ...]]
+ usage: cinder type-key <vtype> <action> <key=value> [<key=value> ...]
Sets or unsets extra_spec for a volume type.
@@ -2550,7 +3744,7 @@ Sets or unsets extra_spec for a volume type.
The extra specs key and value pair to set or unset. For unset,
- specify only the key. Default=None.
+ specify only the key.
@@ -2560,12 +3754,65 @@ Sets or unsets extra_spec for a volume type.
cinder type-list
usage: cinder type-list
-Lists available 'volume types'.
+Lists available 'volume types'. (Admin only will see private types)
+
+ cinder type-update
+ usage: cinder type-update [--name <name>] [--description <description>] <id>
+
+Updates volume type name and/or description.
+
+ Positional arguments
+
+ <id>
+
+
+ ID of the volume type.
+
+
+
+
+
+ Optional arguments
+
+ --name <name>
+
+
+ Name of the volume type.
+
+
+
+
+ --description <description>
+
+
+ Description of the volume type.
+
+
+
+
+
+
+ cinder unmanage
+ usage: cinder unmanage <volume>
+
+Stop managing a volume.
+
+ Positional arguments
+
+ <volume>
+
+
+ Name or ID of the volume to unmanage.
+
+
+
+
+
cinder upload-to-image
- usage: cinder upload-to-image [--force <True|False>]
+ usage: cinder upload-to-image [--force [<True|False>]]
[--container-format <container-format>]
[--disk-format <disk-format>]
<volume> <image-name>
@@ -2577,7 +3824,7 @@ Uploads volume to Image Service as an image.
<volume>
- Name or ID of volume to upload to an image.
+ Name or ID of volume to snapshot.
@@ -2593,10 +3840,10 @@ Uploads volume to Image Service as an image.
Optional arguments
- --force <True|False>
+ --force [<True|False>]
- Enables or disables upload of a volume that is
+ Enables or disables upload of a volume that is
attached to an instance. Default=False.
@@ -2647,6 +3894,7 @@ Lists all availability zones.
cinder backup-create (v2)
usage: cinder --os-volume-api-version 2 backup-create [--container <container>] [--name <name>]
[--description <description>] [--incremental]
+ [--force]
<volume>
Creates a volume backup.
@@ -2695,6 +3943,18 @@ Creates a volume backup.
+
+ --force
+
+
+ Allows or disallows backup of a volume when the volume
+ is attached to an instance. If set to True, backs up
+ the volume whether its status is "available" or "in-
+ use". The backup of an "in-use" volume means your data
+ is crash consistent. Default=False.
+
+
+
@@ -2758,10 +4018,45 @@ Import backup metadata record.
cinder backup-list (v2)
- usage: cinder --os-volume-api-version 2 backup-list
+ usage: cinder --os-volume-api-version 2 backup-list [--all-tenants [<all_tenants>]] [--name <name>]
+ [--status <status>] [--volume-id <volume-id>]
Lists all backups.
-
+
+ Optional arguments
+
+ --all-tenants [<all_tenants>]
+
+
+ Shows details for all tenants. Admin only.
+
+
+
+
+ --name <name>
+
+
+ Filters results by a name. Default=None.
+
+
+
+
+ --status <status>
+
+
+ Filters results by a status. Default=None.
+
+
+
+
+ --volume-id <volume-id>
+
+
+ Filters results by a volume ID. Default=None.
+
+
+
+
cinder backup-restore (v2)
@@ -2963,10 +4258,11 @@ Creates a consistency group.
cinder consisgroup-create-from-src (v2)
usage: cinder --os-volume-api-version 2 consisgroup-create-from-src [--cgsnapshot <cgsnapshot>]
+ [--source-cg <source-cg>]
[--name <name>]
[--description <description>]
-Creates a consistency group from a cgsnapshot.
+Creates a consistency group from a cgsnapshot or a source CG.
Optional arguments
@@ -2977,6 +4273,14 @@ Creates a consistency group from a cgsnapshot.
+
+ --source-cg <source-cg>
+
+
+ Name or ID of a source CG. Default=None.
+
+
+
--name <name>
@@ -3500,6 +4804,24 @@ Attempts force-delete of volume, regardless of state.
+
+
+
+ cinder get-capabilities (v2)
+ usage: cinder --os-volume-api-version 2 get-capabilities <host>
+
+Show backend volume stats and properties. Admin only.
+
+ Positional arguments
+
+ <host>
+
+
+ Cinder host to show backend volume stats and properties; takes the
+ form: host@backend-name
+
+
+
@@ -3517,11 +4839,46 @@ Show pool information for backends. Admin only.
+
+
+
+ cinder image-metadata (v2)
+ usage: cinder --os-volume-api-version 2 image-metadata <volume> <action> <key=value> [<key=value> ...]
+
+Sets or deletes volume image metadata.
+
+ Positional arguments
+
+ <volume>
+
+
+ Name or ID of volume for which to update metadata.
+
+
+
+
+ <action>
+
+
+ The action. Valid values are 'set' or 'unset.'
+
+
+
+
+ <key=value>
+
+
+ Metadata key and value pair to set or unset. For unset, specify
+ only the key.
+
+
+
cinder list (v2)
usage: cinder --os-volume-api-version 2 list [--all-tenants [<0|1>]] [--name <name>] [--status <status>]
+ [--migration_status <migration_status>]
[--metadata [<key=value> [<key=value> ...]]]
[--marker <marker>] [--limit <limit>]
[--sort <key>[:<direction>]] [--tenant [<tenant>]]
@@ -3553,6 +4910,15 @@ Lists all volumes.
+
+ --migration_status <migration_status>
+
+
+ Filters results by a migration status. Default=None.
+ Admin only.
+
+
+
--metadata [<key=value> [<key=value> ...]]
@@ -3778,7 +5144,9 @@ Updates volume metadata.
cinder migrate (v2)
- usage: cinder --os-volume-api-version 2 migrate [--force-host-copy [<True|False>]] <volume> <host>
+ usage: cinder --os-volume-api-version 2 migrate [--force-host-copy [<True|False>]]
+ [--lock-volume [<True|False>]]
+ <volume> <host>
Migrates volume to a new host.
@@ -3812,6 +5180,21 @@ Migrates volume to a new host.
+
+ --lock-volume [<True|False>]
+
+
+ Enables or disables the termination of volume
+ migration caused by other commands. This option
+ applies to the available volume. True means it locks
+ the volume state and does not allow the migration to
+ be aborted. The volume status will be in maintenance
+ during the migration. False means it allows the volume
+ migration to be aborted. The volume status is still in
+ the original status. Default=False.
+
+
+
@@ -4323,7 +5706,8 @@ Promote a secondary volume to primary for a relationship.
<volume>
- Name or ID of the volume to promote.
+ Name or ID of the volume to promote. The volume should have the
+ replica volume created with source-replica argument.
@@ -4340,7 +5724,8 @@ Sync the secondary volume with primary for a relationship.
<volume>
- Name or ID of the volume to reenable replication.
+ Name or ID of the volume to reenable replication. The replication-
+ status of the volume should be inactive.
@@ -4348,7 +5733,9 @@ Sync the secondary volume with primary for a relationship.
cinder reset-state (v2)
- usage: cinder --os-volume-api-version 2 reset-state [--state <state>] <volume> [<volume> ...]
+ usage: cinder --os-volume-api-version 2 reset-state [--state <state>] [--attach-status <attach-status>]
+ [--reset-migration-status]
+ <volume> [<volume> ...]
Explicitly updates the volume state in the Cinder database. Note that this
does not affect whether the volume is actually attached to the Nova compute
@@ -4374,11 +5761,34 @@ actual state. This can render a volume unusable in the case of change to the
The state to assign to the volume. Valid values are
- "available," "error," "creating," "deleting," "in-use,"
- "attaching," "detaching" and "error_deleting." NOTE: This
- command simply changes the state of the Volume in the
- DataBase with no regard to actual status, exercise caution
- when using. Default=available.
+ "available", "error", "creating", "deleting", "in-
+ use", "attaching", "detaching", "error_deleting" and
+ "maintenance". NOTE: This command simply changes the
+ state of the Volume in the DataBase with no regard to
+ actual status, exercise caution when using.
+ Default=available.
+
+
+
+
+ --attach-status <attach-status>
+
+
+ The attach status to assign to the volume in the
+ DataBase, with no regard to the actual status. Valid
+ values are "attached" and "detached". Default=None,
+ that means the status is unchanged.
+
+
+
+
+ --reset-migration-status
+
+
+ Clears the migration status of the volume in the
+ DataBase that indicates the volume is source or
+ destination of volume migration, with no regard to the
+ actual status.
@@ -4806,8 +6216,8 @@ Explicitly updates the snapshot state.
The state to assign to the snapshot. Valid values are
- "available," "error," "creating," "deleting," and
- "error_deleting." NOTE: This command simply changes the
+ "available", "error", "creating", "deleting", and
+ "error_deleting". NOTE: This command simply changes the
state of the Snapshot in the DataBase with no regard to
actual status, exercise caution when using.
Default=available.