The cinder client is the command-line interface (CLI) for the OpenStack Block Storage API and its extensions. This chapter documents cinder version 1.4.0. For help on a specific cinder command, enter: $ cinder help COMMAND

usage: cinder [--version] [-d] [--os-auth-system <auth-system>] [--service-type <service-type>] [--service-name <service-name>] [--volume-service-name <volume-service-name>] [--endpoint-type <endpoint-type>] [--os-endpoint-type <os-endpoint-type>] [--os-volume-api-version <volume-api-ver>] [--bypass-url <bypass-url>] [--retries <retries>] [--os-auth-strategy <auth-strategy>] [--os-username <auth-user-name>] [--os-password <auth-password>] [--os-tenant-name <auth-tenant-name>] [--os-tenant-id <auth-tenant-id>] [--os-auth-url <auth-url>] [--os-user-id <auth-user-id>] [--os-user-domain-id <auth-user-domain-id>] [--os-user-domain-name <auth-user-domain-name>] [--os-project-id <auth-project-id>] [--os-project-name <auth-project-name>] [--os-project-domain-id <auth-project-domain-id>] [--os-project-domain-name <auth-project-domain-name>] [--os-region-name <region-name>] [--os-token <token>] [--os-url <url>] [--insecure] [--os-cacert <ca-certificate>] [--os-cert <certificate>] [--os-key <key>] [--timeout <seconds>] <subcommand> ... absolute-limits Lists absolute limits for a user. availability-zone-list Lists all availability zones. backup-create Creates a volume backup. backup-delete Removes a backup. backup-export Export backup metadata record. backup-import Import backup metadata record. backup-list Lists all backups. backup-restore Restores a backup. backup-show 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. create Creates a volume. credentials Shows user credentials returned from auth. delete Removes one or more volumes. encryption-type-create Creates encryption type for a volume type. Admin only. encryption-type-delete Deletes encryption type for a volume type. Admin only. encryption-type-list Shows encryption type details for volume types. Admin only. encryption-type-show Shows encryption type details for a volume type. Admin only. encryption-type-update Update encryption type information for a volume type (Admin Only). endpoints Discovers endpoints registered by authentication service. extend Attempts to extend size of an existing volume. extra-specs-list Lists current volume types and extra specs. force-delete Attempts force-delete of volume, regardless of state. 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 Lists all volumes. manage Manage an existing volume. metadata Sets or deletes volume metadata. metadata-show Shows volume metadata. metadata-update-all Updates volume metadata. migrate Migrates volume to a new host. qos-associate Associates qos specs with specified volume type. qos-create Creates a qos specs. qos-delete Deletes a specified qos specs. qos-disassociate Disassociates qos specs from specified volume type. qos-disassociate-all Disassociates qos specs from all its associations. qos-get-association Lists all associations for specified qos specs. qos-key Sets or unsets specifications for a qos spec. qos-list Lists qos specs. qos-show Shows qos specs details. quota-class-show Lists quotas for a quota class. quota-class-update Updates quotas for a quota class. quota-defaults Lists default quotas for a tenant. quota-delete Delete the quotas for a tenant. quota-show Lists quotas for a tenant. quota-update Updates quotas for a tenant. quota-usage Lists quota usage for a tenant. rate-limits Lists rate limits for a user. readonly-mode-update Updates volume read-only access-mode flag. rename Renames a volume. 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 in the Cinder database. retype Changes the volume type for a volume. service-disable Disables the service. service-enable Enables the service. service-list Lists all services. Filter by host and service binary. set-bootable Update bootable status of a volume. show Shows volume details. snapshot-create Creates a snapshot. snapshot-delete Removes one or more snapshots. snapshot-list Lists all snapshots. snapshot-metadata Sets or deletes snapshot metadata. snapshot-metadata-show Shows snapshot metadata. snapshot-metadata-update-all Updates snapshot metadata. snapshot-rename Renames a snapshot. snapshot-reset-state Explicitly updates the snapshot state. snapshot-show Shows snapshot details. transfer-accept Accepts a volume transfer. transfer-create Creates a volume transfer. transfer-delete Undoes a transfer. transfer-list Lists all transfers. transfer-show 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. type-create Creates a volume type. type-default List the default volume type. type-delete Deletes a volume type. type-key Sets or unsets extra_spec for a volume type. type-list Lists available 'volume types'. (Admin only will see private types) type-update Updates volume type name and/or description. unmanage Stop managing a volume. upload-to-image Uploads volume to Image Service as an image. bash-completion Prints arguments for bash_completion. help Shows help about this program or one of its subcommands. list-extensions Lists all available os-api extensions.

--version show program's version number and exit -d, --debug Shows debugging output. --os-auth-system <auth-system> Defaults to env[OS_AUTH_SYSTEM]. --service-type <service-type> Service type. For most actions, default is volume. --service-name <service-name> Service name. Default=env[CINDER_SERVICE_NAME]. --volume-service-name <volume-service-name> Volume service name. Default=env[CINDER_VOLUME_SERVICE_NAME]. --endpoint-type <endpoint-type> DEPRECATED! Use --os-endpoint-type. --os-endpoint-type <os-endpoint-type> Endpoint type, which is publicURL or internalURL. Default=env[OS_ENDPOINT_TYPE] or nova env[CINDER_ENDPOINT_TYPE] or publicURL. --os-volume-api-version <volume-api-ver> Block Storage API version. Valid values are 1 or 2. Default=env[OS_VOLUME_API_VERSION]. --bypass-url <bypass-url> Use this API endpoint instead of the Service Catalog. Defaults to env[CINDERCLIENT_BYPASS_URL] --retries <retries> Number of retries. --os-auth-strategy <auth-strategy> Authentication strategy (Env: OS_AUTH_STRATEGY, default keystone). For now, any other value will disable the authentication --os-username <auth-user-name> OpenStack user name. Default=env[OS_USERNAME]. --os-password <auth-password> Password for OpenStack user. Default=env[OS_PASSWORD]. --os-tenant-name <auth-tenant-name> Tenant name. Default=env[OS_TENANT_NAME]. --os-tenant-id <auth-tenant-id> ID for the tenant. Default=env[OS_TENANT_ID]. --os-auth-url <auth-url> URL for the authentication service. Default=env[OS_AUTH_URL]. --os-user-id <auth-user-id> Authentication user ID (Env: OS_USER_ID) --os-user-domain-id <auth-user-domain-id> OpenStack user domain ID. Defaults to env[OS_USER_DOMAIN_ID]. --os-user-domain-name <auth-user-domain-name> OpenStack user domain name. Defaults to env[OS_USER_DOMAIN_NAME]. --os-project-id <auth-project-id> Another way to specify tenant ID. This option is mutually exclusive with --os-tenant-id. Defaults to env[OS_PROJECT_ID]. --os-project-name <auth-project-name> Another way to specify tenant name. This option is mutually exclusive with --os-tenant-name. Defaults to env[OS_PROJECT_NAME]. --os-project-domain-id <auth-project-domain-id> Defaults to env[OS_PROJECT_DOMAIN_ID]. --os-project-domain-name <auth-project-domain-name> Defaults to env[OS_PROJECT_DOMAIN_NAME]. --os-region-name <region-name> Region name. Default=env[OS_REGION_NAME]. --os-token <token> Defaults to env[OS_TOKEN] --os-url <url> Defaults to env[OS_URL] --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]. --os-cert <certificate> Defaults to env[OS_CERT]. --os-key <key> Defaults to env[OS_KEY]. --timeout <seconds> Set request timeout (in seconds).

usage: cinder absolute-limits Lists absolute limits for a user.

usage: cinder availability-zone-list Lists all availability zones.

usage: cinder backup-create [--container <container>] [--name <name>] [--description <description>] [--incremental] [--force] <volume> Creates a volume backup. <volume> Name or ID of volume to backup. --container <container> Backup container name. Default=None. --name <name> Backup name. Default=None. --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.

usage: cinder backup-delete <backup> Removes a backup. <backup> Name or ID of backup to delete.

usage: cinder backup-export <backup> Export backup metadata record. <backup> ID of the backup to export.

usage: cinder backup-import <backup_service> <backup_url> Import backup metadata record. <backup_service> Backup service to use for importing the backup. <backup_url> Backup URL for importing the backup metadata.

usage: cinder backup-list [--all-tenants [<all_tenants>]] [--name <name>] [--status <status>] [--volume-id <volume-id>] Lists all backups. --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.

usage: cinder backup-restore [--volume <volume>] <backup> Restores a backup. <backup> ID of backup to restore. --volume <volume> Name or ID of volume to which to restore. Default=None.

usage: cinder backup-show <backup> Shows backup details. <backup> Name or ID of backup.

usage: cinder cgsnapshot-create [--name <name>] [--description <description>] <consistencygroup> Creates a cgsnapshot. <consistencygroup> Name or ID of a consistency group. --name <name> Cgsnapshot name. Default=None. --description <description> Cgsnapshot description. Default=None.

usage: cinder cgsnapshot-delete <cgsnapshot> [<cgsnapshot> ...] Removes one or more cgsnapshots. <cgsnapshot> Name or ID of one or more cgsnapshots to be deleted.

usage: cinder cgsnapshot-list [--all-tenants [<0|1>]] [--status <status>] [--consistencygroup-id <consistencygroup_id>] Lists all cgsnapshots. --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.

usage: cinder cgsnapshot-show <cgsnapshot> Shows cgsnapshot details. <cgsnapshot> Name or ID of cgsnapshot.

usage: cinder consisgroup-create [--name <name>] [--description <description>] [--availability-zone <availability-zone>] <volume-types> Creates a consistency group. <volume-types> Volume types. --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.

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. --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.

usage: cinder consisgroup-delete [--force] <consistencygroup> [<consistencygroup> ...] Removes one or more consistency groups. <consistencygroup> Name or ID of one or more consistency groups to be deleted. --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.

usage: cinder consisgroup-list [--all-tenants [<0|1>]] Lists all consistencygroups. --all-tenants [<0|1>] Shows details for all tenants. Admin only.

usage: cinder consisgroup-show <consistencygroup> Shows details of a consistency group. <consistencygroup> Name or ID of a consistency group.

usage: cinder consisgroup-update [--name <name>] [--description <description>] [--add-volumes <uuid1,uuid2,......>] [--remove-volumes <uuid3,uuid4,......>] <consistencygroup> Updates a consistencygroup. <consistencygroup> Name or ID of a consistency group. --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.

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> ...]]] [--hint <key=value>] [--allow-multiattach] [<size>] Creates a volume. <size> Size of volume, in GBs. (Required unless snapshot-id /source-volid is specified). --consisgroup-id <consistencygroup-id> ID of a consistency group where the new volume belongs to. Default=None. --snapshot-id <snapshot-id> Creates volume from snapshot ID. Default=None. --source-volid <source-volid> Creates volume from volume ID. Default=None. --source-replica <source-replica> Creates volume from replicated volume ID. Default=None. --image-id <image-id> Creates volume from image ID. Default=None. --image <image> Creates a volume from image (ID or name). Default=None. --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 and value pairs. Default=None. --hint <key=value> Scheduler hint, like in nova. --allow-multiattach Allow volume to be attached more than once. Default=False

usage: cinder credentials Shows user credentials returned from auth.

usage: cinder delete <volume> [<volume> ...] Removes one or more volumes. <volume> Name or ID of volume or volumes to delete.

usage: cinder encryption-type-create [--cipher <cipher>] [--key_size <key_size>] [--control_location <control_location>] <volume_type> <provider> Creates encryption type for a volume type. Admin only. <volume_type> Name or ID of volume type. <provider> The class that provides encryption support. For example, LuksEncryptor. --cipher <cipher> The encryption algorithm or mode. For example, aes- xts-plain64. Default=None. --key_size <key_size> Size of encryption key, in bits. For example, 128 or 256. Default=None. --control_location <control_location> Notional service where encryption is performed. Valid values are "front-end" or "back-end." For example, front-end=Nova. Default is "front-end."

usage: cinder encryption-type-delete <volume_type> Deletes encryption type for a volume type. Admin only. <volume_type> Name or ID of volume type.

usage: cinder encryption-type-list Shows encryption type details for volume types. Admin only.

usage: cinder encryption-type-show <volume_type> Shows encryption type details for a volume type. Admin only. <volume_type> Name or ID of volume type.

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). <volume-type> Name or ID of the volume type --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)

usage: cinder endpoints Discovers endpoints registered by authentication service.

usage: cinder extend <volume> <new_size> Attempts to extend size of an existing volume. <volume> Name or ID of volume to extend. <new_size> New size of volume, in GBs.

usage: cinder extra-specs-list Lists current volume types and extra specs.

usage: cinder force-delete <volume> [<volume> ...] Attempts force-delete of volume, regardless of state. <volume> Name or ID of volume or volumes to delete.

usage: cinder get-capabilities <host> Show backend volume stats and properties. Admin only. <host> Cinder host to show backend volume stats and properties; takes the form: host@backend-name

usage: cinder get-pools [--detail] Show pool information for backends. Admin only. --detail Show detailed information about pools.

usage: cinder image-metadata <volume> <action> <key=value> [<key=value> ...] Sets or deletes volume image metadata. <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.

usage: cinder 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>]] Lists all volumes. --all-tenants [<0|1>] 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. --migration_status <migration_status> Filters results by a migration status. Default=None. Admin only. --metadata [<key=value> [<key=value> ...]] 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>] Display information from single tenant (Admin only).

usage: cinder list-extensions Lists all available os-api extensions.

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. <host> Cinder host on which the existing volume resides; takes the form: host@backend-name#pool <identifier> Name or other Identifier for existing volume --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

usage: cinder metadata <volume> <action> <key=value> [<key=value> ...] Sets or deletes volume metadata. <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.

usage: cinder metadata-show <volume> Shows volume metadata. <volume> ID of volume.

usage: cinder metadata-update-all <volume> <key=value> [<key=value> ...] Updates volume metadata. <volume> ID of volume for which to update metadata. <key=value> Metadata key and value pair or pairs to update.

usage: cinder migrate [--force-host-copy [<True|False>]] [--lock-volume [<True|False>]] <volume> <host> Migrates volume to a new host. <volume> ID of volume to migrate. <host> Destination host. --force-host-copy [<True|False>] Enables or disables generic host-based force- migration, which bypasses driver optimizations. Default=False. --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.

usage: cinder qos-associate <qos_specs> <volume_type_id> Associates qos specs with specified volume type. <qos_specs> ID of QoS specifications. <volume_type_id> ID of volume type with which to associate QoS specifications.

usage: cinder qos-create <name> <key=value> [<key=value> ...] Creates a qos specs. <name> Name of new QoS specifications. <key=value> QoS specifications.

usage: cinder qos-delete [--force [<True|False>]] <qos_specs> Deletes a specified qos specs. <qos_specs> ID of QoS specifications to delete. --force [<True|False>] Enables or disables deletion of in-use QoS specifications. Default=False.

usage: cinder qos-disassociate <qos_specs> <volume_type_id> Disassociates qos specs from specified volume type. <qos_specs> ID of QoS specifications. <volume_type_id> ID of volume type with which to associate QoS specifications.

usage: cinder qos-disassociate-all <qos_specs> Disassociates qos specs from all its associations. <qos_specs> ID of QoS specifications on which to operate.

usage: cinder qos-get-association <qos_specs> Lists all associations for specified qos specs. <qos_specs> ID of QoS specifications.

usage: cinder qos-key <qos_specs> <action> key=value [key=value ...] Sets or unsets specifications for a qos spec. <qos_specs> ID of QoS specifications. <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.

usage: cinder qos-list Lists qos specs.

usage: cinder qos-show <qos_specs> Shows qos specs details. <qos_specs> ID of QoS specifications to show.

usage: cinder quota-class-show <class> Lists quotas for a quota class. <class> Name of quota class for which to list quotas.

usage: cinder quota-class-update [--volumes <volumes>] [--snapshots <snapshots>] [--gigabytes <gigabytes>] [--volume-type <volume_type_name>] <class_name> Updates quotas for a quota class. <class_name> Name of quota class for which to set quotas. --volumes <volumes> The new "volumes" quota value. Default=None. --snapshots <snapshots> The new "snapshots" quota value. Default=None. --gigabytes <gigabytes> The new "gigabytes" quota value. Default=None. --volume-type <volume_type_name> Volume type. Default=None.

usage: cinder quota-defaults <tenant_id> Lists default quotas for a tenant. <tenant_id> ID of tenant for which to list quota defaults.

usage: cinder quota-delete <tenant_id> Delete the quotas for a tenant. <tenant_id> UUID of tenant to delete the quotas for.

usage: cinder quota-show <tenant_id> Lists quotas for a tenant. <tenant_id> ID of tenant for which to list quotas.

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. <tenant_id> ID of tenant for which to set quotas. --volumes <volumes> The new "volumes" quota value. Default=None. --snapshots <snapshots> The new "snapshots" quota value. Default=None. --gigabytes <gigabytes> The new "gigabytes" quota value. Default=None. --backups <backups> The new "backups" quota value. Default=None. --backup-gigabytes <backup_gigabytes> The new "backup_gigabytes" quota value. Default=None. --consistencygroups <consistencygroups> The new "consistencygroups" quota value. Default=None. --volume-type <volume_type_name> Volume type. Default=None. --per-volume-gigabytes <per_volume_gigabytes> Set max volume size limit. Default=None.

usage: cinder quota-usage <tenant_id> Lists quota usage for a tenant. <tenant_id> ID of tenant for which to list quota usage.

usage: cinder rate-limits Lists rate limits for a user.

usage: cinder readonly-mode-update <volume> <True|true|False|false> Updates volume read-only access-mode flag. <volume> ID of volume to update. <True|true|False|false> Enables or disables update of volume to read-only access mode.

usage: cinder rename [--description <description>] <volume> [<name>] Renames a volume. <volume> Name or ID of volume to rename. <name> New name for volume. --description <description> Volume description. Default=None.

usage: cinder replication-promote <volume> Promote a secondary volume to primary for a relationship. <volume> Name or ID of the volume to promote. The volume should have the replica volume created with source-replica argument.

usage: cinder replication-reenable <volume> Sync the secondary volume with primary for a relationship. <volume> Name or ID of the volume to reenable replication. The replication- status of the volume should be inactive.

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. <volume> Name or ID of volume to modify. --state <state> The state to assign to the volume. Valid values are "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.

usage: cinder retype [--migration-policy <never|on-demand>] <volume> <volume-type> Changes the volume type for a volume. <volume> Name or ID of volume for which to modify type. <volume-type> New volume type. --migration-policy <never|on-demand> Migration policy during retype of volume.

usage: cinder service-disable [--reason <reason>] <hostname> <binary> Disables the service. <hostname> Host name. <binary> Service binary. --reason <reason> Reason for disabling service.

usage: cinder service-enable <hostname> <binary> Enables the service. <hostname> Host name. <binary> Service binary.

usage: cinder service-list [--host <hostname>] [--binary <binary>] Lists all services. Filter by host and service binary. --host <hostname> Host name. Default=None. --binary <binary> Service binary. Default=None.

usage: cinder set-bootable <volume> <True|true|False|false> Update bootable status of a volume. <volume> ID of the volume to update. <True|true|False|false> Flag to indicate whether volume is bootable.

usage: cinder show <volume> Shows volume details. <volume> Name or ID of volume.

usage: cinder snapshot-create [--force [<True|False>]] [--name <name>] [--description <description>] [--metadata [<key=value> [<key=value> ...]]] <volume> Creates a snapshot. <volume> Name or ID of volume to snapshot. --force [<True|False>] 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 available. Default=False. --name <name> Snapshot name. Default=None. --description <description> Snapshot description. Default=None. --metadata [<key=value> [<key=value> ...]] Snapshot metadata key and value pairs. Default=None.

usage: cinder snapshot-delete <snapshot> [<snapshot> ...] Removes one or more snapshots. <snapshot> Name or ID of the snapshot(s) to delete.

usage: cinder snapshot-list [--all-tenants [<0|1>]] [--name <name>] [--status <status>] [--volume-id <volume-id>] Lists all snapshots. --all-tenants [<0|1>] 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.

usage: cinder snapshot-metadata <snapshot> <action> <key=value> [<key=value> ...] Sets or deletes snapshot metadata. <snapshot> ID of snapshot 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.

usage: cinder snapshot-metadata-show <snapshot> Shows snapshot metadata. <snapshot> ID of snapshot.

usage: cinder snapshot-metadata-update-all <snapshot> <key=value> [<key=value> ...] Updates snapshot metadata. <snapshot> ID of snapshot for which to update metadata. <key=value> Metadata key and value pair to update.

usage: cinder snapshot-rename [--description <description>] <snapshot> [<name>] Renames a snapshot. <snapshot> Name or ID of snapshot. <name> New name for snapshot. --description <description> Snapshot description. Default=None.

usage: cinder snapshot-reset-state [--state <state>] <snapshot> [<snapshot> ...] Explicitly updates the snapshot state. <snapshot> Name or ID of snapshot to modify. --state <state> The state to assign to the snapshot. Valid values are "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.

usage: cinder snapshot-show <snapshot> Shows snapshot details. <snapshot> Name or ID of snapshot.

usage: cinder transfer-accept <transfer> <auth_key> Accepts a volume transfer. <transfer> ID of transfer to accept. <auth_key> Authentication key of transfer to accept.

usage: cinder transfer-create [--name <name>] <volume> Creates a volume transfer. <volume> Name or ID of volume to transfer. --name <name> Transfer name. Default=None.

usage: cinder transfer-delete <transfer> Undoes a transfer. <transfer> Name or ID of transfer to delete.

usage: cinder transfer-list [--all-tenants [<0|1>]] Lists all transfers. --all-tenants [<0|1>] Shows details for all tenants. Admin only.

usage: cinder transfer-show <transfer> Shows transfer details. <transfer> Name or ID of transfer to accept.

usage: cinder type-access-add --volume-type <volume_type> --project-id <project_id> Adds volume type access for the given project. --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.

usage: cinder type-access-list --volume-type <volume_type> Print access information about the given volume type. --volume-type <volume_type> Filter results by volume type name or ID.

usage: cinder type-access-remove --volume-type <volume_type> --project-id <project_id> Removes volume type access for the given project. --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.

usage: cinder type-create [--description <description>] [--is-public <is-public>] <name> Creates a volume type. <name> Name of new volume type. --description <description> Description of new volume type. --is-public <is-public> Make type accessible to the public (default true).

usage: cinder type-default List the default volume type.

usage: cinder type-delete <id> Deletes a volume type. <id> ID of volume type to delete.

usage: cinder type-key <vtype> <action> <key=value> [<key=value> ...] Sets or unsets extra_spec for a volume type. <vtype> Name or ID of volume type. <action> The action. Valid values are "set" or "unset." <key=value> The extra specs key and value pair to set or unset. For unset, specify only the key.

usage: cinder type-list Lists available 'volume types'. (Admin only will see private types)

usage: cinder type-update [--name <name>] [--description <description>] <id> Updates volume type name and/or description. <id> ID of the volume type. --name <name> Name of the volume type. --description <description> Description of the volume type.

usage: cinder unmanage <volume> Stop managing a volume. <volume> Name or ID of the volume to unmanage.

usage: cinder upload-to-image [--force [<True|False>]] [--container-format <container-format>] [--disk-format <disk-format>] <volume> <image-name> Uploads volume to Image Service as an image. <volume> Name or ID of volume to snapshot. <image-name> The new image name. --force [<True|False>] Enables or disables upload of a volume that is attached to an instance. Default=False. --container-format <container-format> Container format type. Default is bare. --disk-format <disk-format> Disk format type. Default is raw.

You can select an API version to use by adding the --os-volume-api-version parameter or by setting the corresponding environment variable: $ export OS_VOLUME_API_VERSION=2

usage: cinder --os-volume-api-version 2 absolute-limits Lists absolute limits for a user.

usage: cinder --os-volume-api-version 2 availability-zone-list Lists all availability zones.

usage: cinder --os-volume-api-version 2 backup-create [--container <container>] [--name <name>] [--description <description>] [--incremental] [--force] <volume> Creates a volume backup. <volume> Name or ID of volume to backup. --container <container> Backup container name. Default=None. --name <name> Backup name. Default=None. --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.

usage: cinder --os-volume-api-version 2 backup-delete <backup> Removes a backup. <backup> Name or ID of backup to delete.

usage: cinder --os-volume-api-version 2 backup-export <backup> Export backup metadata record. <backup> ID of the backup to export.

usage: cinder --os-volume-api-version 2 backup-import <backup_service> <backup_url> Import backup metadata record. <backup_service> Backup service to use for importing the backup. <backup_url> Backup URL for importing the backup metadata.

usage: cinder --os-volume-api-version 2 backup-list [--all-tenants [<all_tenants>]] [--name <name>] [--status <status>] [--volume-id <volume-id>] Lists all backups. --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.

usage: cinder --os-volume-api-version 2 backup-restore [--volume <volume>] <backup> Restores a backup. <backup> ID of backup to restore. --volume <volume> Name or ID of volume to which to restore. Default=None.

usage: cinder --os-volume-api-version 2 backup-show <backup> Shows backup details. <backup> Name or ID of backup.

usage: cinder --os-volume-api-version 2 cgsnapshot-create [--name <name>] [--description <description>] <consistencygroup> Creates a cgsnapshot. <consistencygroup> Name or ID of a consistency group. --name <name> Cgsnapshot name. Default=None. --description <description> Cgsnapshot description. Default=None.

usage: cinder --os-volume-api-version 2 cgsnapshot-delete <cgsnapshot> [<cgsnapshot> ...] Removes one or more cgsnapshots. <cgsnapshot> Name or ID of one or more cgsnapshots to be deleted.

usage: cinder --os-volume-api-version 2 cgsnapshot-list [--all-tenants [<0|1>]] [--status <status>] [--consistencygroup-id <consistencygroup_id>] Lists all cgsnapshots. --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.

usage: cinder --os-volume-api-version 2 cgsnapshot-show <cgsnapshot> Shows cgsnapshot details. <cgsnapshot> Name or ID of cgsnapshot.

usage: cinder --os-volume-api-version 2 consisgroup-create [--name <name>] [--description <description>] [--availability-zone <availability-zone>] <volume-types> Creates a consistency group. <volume-types> Volume types. --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.

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 or a source CG. --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.

usage: cinder --os-volume-api-version 2 consisgroup-delete [--force] <consistencygroup> [<consistencygroup> ...] Removes one or more consistency groups. <consistencygroup> Name or ID of one or more consistency groups to be deleted. --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.

usage: cinder --os-volume-api-version 2 consisgroup-list [--all-tenants [<0|1>]] Lists all consistencygroups. --all-tenants [<0|1>] Shows details for all tenants. Admin only.

usage: cinder --os-volume-api-version 2 consisgroup-show <consistencygroup> Shows details of a consistency group. <consistencygroup> Name or ID of a consistency group.

usage: cinder --os-volume-api-version 2 consisgroup-update [--name <name>] [--description <description>] [--add-volumes <uuid1,uuid2,......>] [--remove-volumes <uuid3,uuid4,......>] <consistencygroup> Updates a consistencygroup. <consistencygroup> Name or ID of a consistency group. --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.

usage: cinder --os-volume-api-version 2 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> ...]]] [--hint <key=value>] [--allow-multiattach] [<size>] Creates a volume. <size> Size of volume, in GBs. (Required unless snapshot-id /source-volid is specified). --consisgroup-id <consistencygroup-id> ID of a consistency group where the new volume belongs to. Default=None. --snapshot-id <snapshot-id> Creates volume from snapshot ID. Default=None. --source-volid <source-volid> Creates volume from volume ID. Default=None. --source-replica <source-replica> Creates volume from replicated volume ID. Default=None. --image-id <image-id> Creates volume from image ID. Default=None. --image <image> Creates a volume from image (ID or name). Default=None. --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 and value pairs. Default=None. --hint <key=value> Scheduler hint, like in nova. --allow-multiattach Allow volume to be attached more than once. Default=False

usage: cinder --os-volume-api-version 2 credentials Shows user credentials returned from auth.

usage: cinder --os-volume-api-version 2 delete <volume> [<volume> ...] Removes one or more volumes. <volume> Name or ID of volume or volumes to delete.

usage: cinder --os-volume-api-version 2 encryption-type-create [--cipher <cipher>] [--key_size <key_size>] [--control_location <control_location>] <volume_type> <provider> Creates encryption type for a volume type. Admin only. <volume_type> Name or ID of volume type. <provider> The class that provides encryption support. For example, LuksEncryptor. --cipher <cipher> The encryption algorithm or mode. For example, aes- xts-plain64. Default=None. --key_size <key_size> Size of encryption key, in bits. For example, 128 or 256. Default=None. --control_location <control_location> Notional service where encryption is performed. Valid values are "front-end" or "back-end." For example, front-end=Nova. Default is "front-end."

usage: cinder --os-volume-api-version 2 encryption-type-delete <volume_type> Deletes encryption type for a volume type. Admin only. <volume_type> Name or ID of volume type.

usage: cinder --os-volume-api-version 2 encryption-type-list Shows encryption type details for volume types. Admin only.

usage: cinder --os-volume-api-version 2 encryption-type-show <volume_type> Shows encryption type details for a volume type. Admin only. <volume_type> Name or ID of volume type.

usage: cinder --os-volume-api-version 2 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). <volume-type> Name or ID of the volume type --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)

usage: cinder --os-volume-api-version 2 endpoints Discovers endpoints registered by authentication service.

usage: cinder --os-volume-api-version 2 extend <volume> <new_size> Attempts to extend size of an existing volume. <volume> Name or ID of volume to extend. <new_size> New size of volume, in GBs.

usage: cinder --os-volume-api-version 2 extra-specs-list Lists current volume types and extra specs.

usage: cinder --os-volume-api-version 2 force-delete <volume> [<volume> ...] Attempts force-delete of volume, regardless of state. <volume> Name or ID of volume or volumes to delete.

usage: cinder --os-volume-api-version 2 get-capabilities <host> Show backend volume stats and properties. Admin only. <host> Cinder host to show backend volume stats and properties; takes the form: host@backend-name

usage: cinder --os-volume-api-version 2 get-pools [--detail] Show pool information for backends. Admin only. --detail Show detailed information about pools.

usage: cinder --os-volume-api-version 2 image-metadata <volume> <action> <key=value> [<key=value> ...] Sets or deletes volume image metadata. <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.

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>]] Lists all volumes. --all-tenants [<0|1>] 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. --migration_status <migration_status> Filters results by a migration status. Default=None. Admin only. --metadata [<key=value> [<key=value> ...]] 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>] Display information from single tenant (Admin only).

usage: cinder --os-volume-api-version 2 list-extensions Lists all available os-api extensions.

usage: cinder --os-volume-api-version 2 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. <host> Cinder host on which the existing volume resides; takes the form: host@backend-name#pool <identifier> Name or other Identifier for existing volume --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

usage: cinder --os-volume-api-version 2 metadata <volume> <action> <key=value> [<key=value> ...] Sets or deletes volume metadata. <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.

usage: cinder --os-volume-api-version 2 metadata-show <volume> Shows volume metadata. <volume> ID of volume.

usage: cinder --os-volume-api-version 2 metadata-update-all <volume> <key=value> [<key=value> ...] Updates volume metadata. <volume> ID of volume for which to update metadata. <key=value> Metadata key and value pair or pairs to update.

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. <volume> ID of volume to migrate. <host> Destination host. --force-host-copy [<True|False>] Enables or disables generic host-based force- migration, which bypasses driver optimizations. Default=False. --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.

usage: cinder --os-volume-api-version 2 qos-associate <qos_specs> <volume_type_id> Associates qos specs with specified volume type. <qos_specs> ID of QoS specifications. <volume_type_id> ID of volume type with which to associate QoS specifications.

usage: cinder --os-volume-api-version 2 qos-create <name> <key=value> [<key=value> ...] Creates a qos specs. <name> Name of new QoS specifications. <key=value> QoS specifications.

usage: cinder --os-volume-api-version 2 qos-delete [--force [<True|False>]] <qos_specs> Deletes a specified qos specs. <qos_specs> ID of QoS specifications to delete. --force [<True|False>] Enables or disables deletion of in-use QoS specifications. Default=False.

usage: cinder --os-volume-api-version 2 qos-disassociate <qos_specs> <volume_type_id> Disassociates qos specs from specified volume type. <qos_specs> ID of QoS specifications. <volume_type_id> ID of volume type with which to associate QoS specifications.

usage: cinder --os-volume-api-version 2 qos-disassociate-all <qos_specs> Disassociates qos specs from all its associations. <qos_specs> ID of QoS specifications on which to operate.

usage: cinder --os-volume-api-version 2 qos-get-association <qos_specs> Lists all associations for specified qos specs. <qos_specs> ID of QoS specifications.

usage: cinder --os-volume-api-version 2 qos-key <qos_specs> <action> key=value [key=value ...] Sets or unsets specifications for a qos spec. <qos_specs> ID of QoS specifications. <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.

usage: cinder --os-volume-api-version 2 qos-list Lists qos specs.

usage: cinder --os-volume-api-version 2 qos-show <qos_specs> Shows qos specs details. <qos_specs> ID of QoS specifications to show.

usage: cinder --os-volume-api-version 2 quota-class-show <class> Lists quotas for a quota class. <class> Name of quota class for which to list quotas.

usage: cinder --os-volume-api-version 2 quota-class-update [--volumes <volumes>] [--snapshots <snapshots>] [--gigabytes <gigabytes>] [--volume-type <volume_type_name>] <class_name> Updates quotas for a quota class. <class_name> Name of quota class for which to set quotas. --volumes <volumes> The new "volumes" quota value. Default=None. --snapshots <snapshots> The new "snapshots" quota value. Default=None. --gigabytes <gigabytes> The new "gigabytes" quota value. Default=None. --volume-type <volume_type_name> Volume type. Default=None.

usage: cinder --os-volume-api-version 2 quota-defaults <tenant_id> Lists default quotas for a tenant. <tenant_id> ID of tenant for which to list quota defaults.

usage: cinder --os-volume-api-version 2 quota-delete <tenant_id> Delete the quotas for a tenant. <tenant_id> UUID of tenant to delete the quotas for.

usage: cinder --os-volume-api-version 2 quota-show <tenant_id> Lists quotas for a tenant. <tenant_id> ID of tenant for which to list quotas.

usage: cinder --os-volume-api-version 2 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. <tenant_id> ID of tenant for which to set quotas. --volumes <volumes> The new "volumes" quota value. Default=None. --snapshots <snapshots> The new "snapshots" quota value. Default=None. --gigabytes <gigabytes> The new "gigabytes" quota value. Default=None. --backups <backups> The new "backups" quota value. Default=None. --backup-gigabytes <backup_gigabytes> The new "backup_gigabytes" quota value. Default=None. --consistencygroups <consistencygroups> The new "consistencygroups" quota value. Default=None. --volume-type <volume_type_name> Volume type. Default=None. --per-volume-gigabytes <per_volume_gigabytes> Set max volume size limit. Default=None.

usage: cinder --os-volume-api-version 2 quota-usage <tenant_id> Lists quota usage for a tenant. <tenant_id> ID of tenant for which to list quota usage.

usage: cinder --os-volume-api-version 2 rate-limits Lists rate limits for a user.

usage: cinder --os-volume-api-version 2 readonly-mode-update <volume> <True|true|False|false> Updates volume read-only access-mode flag. <volume> ID of volume to update. <True|true|False|false> Enables or disables update of volume to read-only access mode.

usage: cinder --os-volume-api-version 2 rename [--description <description>] <volume> [<name>] Renames a volume. <volume> Name or ID of volume to rename. <name> New name for volume. --description <description> Volume description. Default=None.

usage: cinder --os-volume-api-version 2 replication-promote <volume> Promote a secondary volume to primary for a relationship. <volume> Name or ID of the volume to promote. The volume should have the replica volume created with source-replica argument.

usage: cinder --os-volume-api-version 2 replication-reenable <volume> Sync the secondary volume with primary for a relationship. <volume> Name or ID of the volume to reenable replication. The replication- status of the volume should be inactive.

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 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. <volume> Name or ID of volume to modify. --state <state> The state to assign to the volume. Valid values are "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.

usage: cinder --os-volume-api-version 2 retype [--migration-policy <never|on-demand>] <volume> <volume-type> Changes the volume type for a volume. <volume> Name or ID of volume for which to modify type. <volume-type> New volume type. --migration-policy <never|on-demand> Migration policy during retype of volume.

usage: cinder --os-volume-api-version 2 service-disable [--reason <reason>] <hostname> <binary> Disables the service. <hostname> Host name. <binary> Service binary. --reason <reason> Reason for disabling service.

usage: cinder --os-volume-api-version 2 service-enable <hostname> <binary> Enables the service. <hostname> Host name. <binary> Service binary.

usage: cinder --os-volume-api-version 2 service-list [--host <hostname>] [--binary <binary>] Lists all services. Filter by host and service binary. --host <hostname> Host name. Default=None. --binary <binary> Service binary. Default=None.

usage: cinder --os-volume-api-version 2 set-bootable <volume> <True|true|False|false> Update bootable status of a volume. <volume> ID of the volume to update. <True|true|False|false> Flag to indicate whether volume is bootable.

usage: cinder --os-volume-api-version 2 show <volume> Shows volume details. <volume> Name or ID of volume.

usage: cinder --os-volume-api-version 2 snapshot-create [--force [<True|False>]] [--name <name>] [--description <description>] [--metadata [<key=value> [<key=value> ...]]] <volume> Creates a snapshot. <volume> Name or ID of volume to snapshot. --force [<True|False>] 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 available. Default=False. --name <name> Snapshot name. Default=None. --description <description> Snapshot description. Default=None. --metadata [<key=value> [<key=value> ...]] Snapshot metadata key and value pairs. Default=None.

usage: cinder --os-volume-api-version 2 snapshot-delete <snapshot> [<snapshot> ...] Removes one or more snapshots. <snapshot> Name or ID of the snapshot(s) to delete.

usage: cinder --os-volume-api-version 2 snapshot-list [--all-tenants [<0|1>]] [--name <name>] [--status <status>] [--volume-id <volume-id>] Lists all snapshots. --all-tenants [<0|1>] 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.

usage: cinder --os-volume-api-version 2 snapshot-metadata <snapshot> <action> <key=value> [<key=value> ...] Sets or deletes snapshot metadata. <snapshot> ID of snapshot 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.

usage: cinder --os-volume-api-version 2 snapshot-metadata-show <snapshot> Shows snapshot metadata. <snapshot> ID of snapshot.

usage: cinder --os-volume-api-version 2 snapshot-metadata-update-all <snapshot> <key=value> [<key=value> ...] Updates snapshot metadata. <snapshot> ID of snapshot for which to update metadata. <key=value> Metadata key and value pair to update.

usage: cinder --os-volume-api-version 2 snapshot-rename [--description <description>] <snapshot> [<name>] Renames a snapshot. <snapshot> Name or ID of snapshot. <name> New name for snapshot. --description <description> Snapshot description. Default=None.

usage: cinder --os-volume-api-version 2 snapshot-reset-state [--state <state>] <snapshot> [<snapshot> ...] Explicitly updates the snapshot state. <snapshot> Name or ID of snapshot to modify. --state <state> The state to assign to the snapshot. Valid values are "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.

usage: cinder --os-volume-api-version 2 snapshot-show <snapshot> Shows snapshot details. <snapshot> Name or ID of snapshot.

usage: cinder --os-volume-api-version 2 transfer-accept <transfer> <auth_key> Accepts a volume transfer. <transfer> ID of transfer to accept. <auth_key> Authentication key of transfer to accept.

usage: cinder --os-volume-api-version 2 transfer-create [--name <name>] <volume> Creates a volume transfer. <volume> Name or ID of volume to transfer. --name <name> Transfer name. Default=None.

usage: cinder --os-volume-api-version 2 transfer-delete <transfer> Undoes a transfer. <transfer> Name or ID of transfer to delete.

usage: cinder --os-volume-api-version 2 transfer-list [--all-tenants [<0|1>]] Lists all transfers. --all-tenants [<0|1>] Shows details for all tenants. Admin only.

usage: cinder --os-volume-api-version 2 transfer-show <transfer> Shows transfer details. <transfer> Name or ID of transfer to accept.

usage: cinder --os-volume-api-version 2 type-access-add --volume-type <volume_type> --project-id <project_id> Adds volume type access for the given project. --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.

usage: cinder --os-volume-api-version 2 type-access-list --volume-type <volume_type> Print access information about the given volume type. --volume-type <volume_type> Filter results by volume type name or ID.

usage: cinder --os-volume-api-version 2 type-access-remove --volume-type <volume_type> --project-id <project_id> Removes volume type access for the given project. --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.

usage: cinder --os-volume-api-version 2 type-create [--description <description>] [--is-public <is-public>] <name> Creates a volume type. <name> Name of new volume type. --description <description> Description of new volume type. --is-public <is-public> Make type accessible to the public (default true).

usage: cinder --os-volume-api-version 2 type-default List the default volume type.

usage: cinder --os-volume-api-version 2 type-delete <id> Deletes a volume type. <id> ID of volume type to delete.

usage: cinder --os-volume-api-version 2 type-key <vtype> <action> <key=value> [<key=value> ...] Sets or unsets extra_spec for a volume type. <vtype> Name or ID of volume type. <action> The action. Valid values are "set" or "unset." <key=value> The extra specs key and value pair to set or unset. For unset, specify only the key.

usage: cinder --os-volume-api-version 2 type-list Lists available 'volume types'. (Admin only will see private types)

usage: cinder --os-volume-api-version 2 type-update [--name <name>] [--description <description>] <id> Updates volume type name and/or description. <id> ID of the volume type. --name <name> Name of the volume type. --description <description> Description of the volume type.

usage: cinder --os-volume-api-version 2 unmanage <volume> Stop managing a volume. <volume> Name or ID of the volume to unmanage.

usage: cinder --os-volume-api-version 2 upload-to-image [--force [<True|False>]] [--container-format <container-format>] [--disk-format <disk-format>] <volume> <image-name> Uploads volume to Image Service as an image. <volume> Name or ID of volume to snapshot. <image-name> The new image name. --force [<True|False>] Enables or disables upload of a volume that is attached to an instance. Default=False. --container-format <container-format> Container format type. Default is bare. --disk-format <disk-format> Disk format type. Default is raw.