Chapter 4. Block Storage command-line client

The cinder client is the command-line interface (CLI) for the OpenStack Block Storage API and its extensions. This chapter documents cinder version 1.1.1.

For help on a specific cinder command, enter:

$ cinder help COMMAND

4.1. cinder usage

usage: cinder [--version] [--debug] [--os-auth-system <auth-system>] [--service-type <service-type>] [--service-name <service-name>] [--volume-service-name <volume-service-name>] [--endpoint-type <endpoint-type>] [--os-volume-api-version <volume-api-ver>] [--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-cert <certificate>] [--os-key <key>] [--os-region-name <region-name>] [--os-token <token>] [--os-url <url>] [--os-cacert <ca-certificate>] <subcommand> ...

Subcommands

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-list: Lists all backups.
backup-restore: Restores a backup.
backup-show: Show backup details.
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 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.
list: Lists all volumes.
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 associations.
qos-get-association: Gets all associations for specified qos specs.
qos-key: Sets or unsets specifications for a qos spec.
qos-list: Lists qos specs.
qos-show: Shows a specified qos specs.
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.
reset-state: Explicitly updates the volume state.
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: Remove 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: Show transfer details.
type-create: Creates a volume type.
type-delete: Deletes a specified volume type.
type-key: Sets or unsets extra_spec for a volume type.
type-list: Lists available 'volume types'.
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.

4.2. cinder optional arguments

--version: show program's version number and exit
--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>: Endpoint type, which is publicURL or internalURL. Default=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].
--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-cert <certificate>: Defaults to env[OS_CERT].
--os-key <key>: Defaults to env[OS_KEY].
--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]
--os-cacert <ca-certificate>: Specify a CA bundle file to use in verifying a TLS (https) server certificate. Defaults to env[OS_CACERT]

4.3. Block Storage API v1 commands

4.3.1. cinder absolute-limits

usage: cinder absolute-limits

Lists absolute limits for a user.

4.3.2. cinder availability-zone-list

usage: cinder availability-zone-list

Lists all availability zones.

4.3.3. cinder backup-create

usage: cinder backup-create [--container <container>] [--display-name <display-name>] [--display-description <display-description>] <volume>

Creates a volume backup.

Positional arguments

<volume>: Name or ID of volume to back up.

Optional arguments

--container <container>: Backup container name. Default=None.
--display-name <display-name>: Backup name. Default=None.
--display-description <display-description>: Backup description. Default=None.

4.3.4. cinder backup-delete

usage: cinder backup-delete <backup>

Removes a backup.

Positional arguments

<backup>: Name or ID of backup to delete.

4.3.5. cinder backup-list

usage: cinder backup-list

Lists all backups.

4.3.6. cinder backup-restore

usage: cinder backup-restore [--volume-id <volume>] <backup>

Restores a backup.

Positional arguments

<backup>: ID of backup to restore.

Optional arguments

--volume-id <volume> ID: or name of backup volume to which to restore. Default=None.

4.3.7. cinder backup-show

usage: cinder backup-show <backup>

Show backup details.

Positional arguments

<backup>: Name or ID of backup.

4.3.8. 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>] [--volume-type <volume-type>] [--availability-zone <availability-zone>] [--metadata [<key=value> [<key=value> ...]]] <size>

Creates a volume.

Positional arguments

<size>: Volume size, in GBs.

Optional arguments

--snapshot-id <snapshot-id>: Creates volume from snapshot ID. Default=None.
--source-volid <source-volid>: Creates volume from volume ID. Default=None.
--image-id <image-id>: Creates volume from image ID. Default=None.
--display-name <display-name>: Volume name. Default=None.
--display-description <display-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.

4.3.9. cinder credentials

usage: cinder credentials

Shows user credentials returned from auth.

4.3.10. cinder delete

usage: cinder delete <volume> [<volume> ...]

Removes one or more volumes.

Positional arguments

<volume>: Name or ID of volume to delete. Separate multiple volumes with a space.

4.3.11. cinder encryption-type-create

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.

Positional arguments

<volume_type>: Name or ID of volume type.
<provider>: The class that provides encryption support. For example, a volume driver class path.

Optional arguments

--cipher <cipher>: The encryption algorithm and 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."

4.3.12. cinder encryption-type-delete

usage: cinder encryption-type-delete <volume_type>

Deletes encryption type for a volume type. Admin only.

Positional arguments

<volume_type>: Name or ID of volume type.

4.3.13. cinder encryption-type-list

usage: cinder encryption-type-list

Shows encryption type details for volume types. Admin only.

4.3.14. cinder encryption-type-show

usage: cinder encryption-type-show <volume_type>

Shows encryption type details for volume type. Admin only.

Positional arguments

<volume_type>: Name or ID of volume type.

4.3.15. cinder endpoints

usage: cinder endpoints

Discovers endpoints registered by authentication service.

4.3.16. cinder extend

usage: cinder extend <volume> <new-size>

Attempts to extend size of an existing volume.

Positional arguments

<volume>: Name or ID of volume to extend.
<new-size>: Size of volume, in GBs.

4.3.17. cinder extra-specs-list

usage: cinder extra-specs-list

Lists current volume types and extra specs.

4.3.18. cinder force-delete

usage: cinder force-delete <volume> [<volume> ...]

Attempts force-delete of volume, regardless of state.

Positional arguments

<volume>: Name or ID of volume to delete. Separate multiple volumes with a space.

4.3.19. cinder list

usage: cinder list [--all-tenants [<0|1>]] [--display-name <display-name>] [--status <status>] [--metadata [<key=value> [<key=value> ...]]]

Lists all volumes.

Optional arguments

--all-tenants [<0|1>]: Shows details for all tenants. Admin only.
--display-name <display-name>: Filters list by a volume display name. Default=None.
--status <status>: Filters list by a status. Default=None.
--metadata [<key=value> [<key=value> ...]]: Filters list by metadata key and value pair. Default=None.

4.3.20. cinder list-extensions

usage: cinder list-extensions

Lists all available os-api extensions.

4.3.21. cinder metadata

usage: cinder metadata <volume> <action> <key=value> [<key=value> ...]

Sets or deletes volume 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>: The metadata key and pair to set or unset. For unset, specify only the key. Default=[].

4.3.22. cinder metadata-show

usage: cinder metadata-show <volume>

Shows volume metadata.

Positional arguments

<volume>: ID of volume.

4.3.23. cinder metadata-update-all

usage: cinder metadata-update-all <volume> <key=value> [<key=value> ...]

Updates volume metadata.

Positional arguments

<volume>: ID of volume for which to update metadata.
<key=value>: Metadata key and value pair or pairs to update. Default=[].

4.3.24. cinder migrate

usage: cinder migrate [--force-host-copy <True|False>] <volume> <host>

Migrates volume to a new host.

Positional arguments

<volume>: ID of volume to migrate.
<host>: Destination host.

Optional arguments

--force-host-copy <True|False>: Enables or disables generic host-based force- migration, which bypasses driver optimizations. Default=False.

4.3.25. cinder qos-associate

usage: cinder qos-associate <qos_specs> <volume_type_id>

Associates qos specs with specified volume type.

Positional arguments

<qos_specs>: ID of QoS specifications.
<volume_type_id>: ID of volume type.

4.3.26. cinder qos-create

usage: cinder qos-create <name> <key=value> [<key=value> ...]

Creates a qos specs.

Positional arguments

<name>: Name of new QoS specifications.
<key=value>: Specifications for QoS.

4.3.27. cinder qos-delete

usage: cinder qos-delete [--force <True|False>] <qos_specs>

Deletes a specified qos specs.

Positional arguments

<qos_specs>: ID of QoS specifications.

Optional arguments

--force <True|False>: Enables or disables deletion of in-use QoS specifications. Default=False.

4.3.28. cinder qos-disassociate

usage: cinder qos-disassociate <qos_specs> <volume_type_id>

Disassociates qos specs from specified volume type.

Positional arguments

<qos_specs>: ID of QoS specifications.
<volume_type_id>: ID of volume type.

4.3.29. cinder qos-disassociate-all

usage: cinder qos-disassociate-all <qos_specs>

Disassociates qos specs from all associations.

Positional arguments

<qos_specs>: ID of QoS specifications.

4.3.30. cinder qos-get-association

usage: cinder qos-get-association <qos_specs>

Gets all associations for specified qos specs.

Positional arguments

<qos_specs>: ID of QoS specifications.

4.3.31. cinder qos-key

usage: cinder qos-key <qos_specs> <action> key=value [key=value ...]

Sets or unsets specifications for a qos spec.

Positional arguments

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

4.3.32. cinder qos-list

usage: cinder qos-list

Lists qos specs.

4.3.33. cinder qos-show

usage: cinder qos-show <qos_specs>

Shows a specified qos specs.

Positional arguments

<qos_specs>: ID of QoS specifications.

4.3.34. cinder quota-class-show

usage: cinder quota-class-show <class>

Lists quotas for a quota class.

Positional arguments

<class>: Name of quota class for which to list quotas.

4.3.35. cinder quota-class-update

usage: cinder quota-class-update [--volumes <volumes>] [--snapshots <snapshots>] [--gigabytes <gigabytes>] [--volume-type <volume_type_name>] <class>

Updates quotas for a quota class.

Positional arguments

<class>: Name of quota class for which to set quotas.

Optional arguments

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

4.3.36. cinder quota-defaults

usage: cinder quota-defaults <tenant_id>

Lists default quotas for a tenant.

Positional arguments

<tenant_id>: ID of the tenant for which to list default quotas.

4.3.37. cinder quota-delete

usage: cinder quota-delete <tenant_id>

Delete the quotas for a tenant.

Positional arguments

<tenant_id>: UUID of tenant to delete the quotas for.

4.3.38. cinder quota-show

usage: cinder quota-show <tenant_id>

Lists quotas for a tenant.

Positional arguments

<tenant_id>: ID of the tenant for which to list quotas.

4.3.39. cinder quota-update

usage: cinder quota-update [--volumes <volumes>] [--snapshots <snapshots>] [--gigabytes <gigabytes>] [--volume-type <volume_type_name>] <tenant_id>

Updates quotas for a tenant.

Positional arguments

<tenant_id>: ID of the tenant for which to set quotas.

Optional arguments

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

4.3.40. cinder quota-usage

usage: cinder quota-usage <tenant_id>

Lists quota usage for a tenant.

Positional arguments

<tenant_id>: ID of the tenant for which to list quota usage.

4.3.41. cinder rate-limits

usage: cinder rate-limits

Lists rate limits for a user.

4.3.42. cinder readonly-mode-update

usage: cinder readonly-mode-update <volume> <True|true|False|false>

Updates volume read-only access-mode flag.

Positional arguments

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

4.3.43. cinder rename

usage: cinder rename [--display-description <display-description>] <volume> [<display-name>]

Renames a volume.

Positional arguments

<volume>: Name or ID of volume to rename.
<display-name>: New display name for volume.

Optional arguments

--display-description <display-description>: Volume description. Default=None.

4.3.44. cinder reset-state

usage: cinder reset-state [--state <state>] <volume> [<volume> ...]

Explicitly updates the volume state.

Positional arguments

<volume>: Name or ID of volume to modify. Separate multiple volumes with a space.

Optional arguments

--state <state>: The state to assign to the volume. Valid values are "available," "error," "creating," "deleting," or "error_deleting." Default is "available."

4.3.45. cinder service-disable

usage: cinder service-disable [--reason <reason>] <hostname> <binary>

Disables the service.

Positional arguments

<hostname>: Host name.
<binary>: Service binary.

Optional arguments

--reason <reason>: Reason for disabling service.

4.3.46. cinder service-enable

usage: cinder service-enable <hostname> <binary>

Enables the service.

Positional arguments

<hostname>: Host name.
<binary>: Service binary.

4.3.47. cinder service-list

usage: cinder service-list [--host <hostname>] [--binary <binary>]

Lists all services. Filter by host and service binary.

Optional arguments

--host <hostname>: Host name. Default=None.
--binary <binary>: Service binary. Default=None.

4.3.48. cinder set-bootable

usage: cinder set-bootable <volume> <True|true|False|false>

Update bootable status of a volume.

Positional arguments

<volume>: ID of the volume to update.
<True|true|False|false>: Flag to indicate whether volume is bootable.

4.3.49. cinder show

usage: cinder show <volume>

Shows volume details.

Positional arguments

<volume>: Volume name or ID.

4.3.50. cinder snapshot-create

usage: cinder snapshot-create [--force <True|False>] [--display-name <display-name>] [--display-description <display-description>] <volume>

Creates a snapshot.

Positional arguments

<volume>: Name or ID of volume to snapshot.

Optional arguments

--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.
--display-name <display-name>: The snapshot name. Default=None.
--display-description <display-description>: The snapshot description. Default=None.

4.3.51. cinder snapshot-delete

usage: cinder snapshot-delete <snapshot> [<snapshot> ...]

Remove one or more snapshots.

Positional arguments

<snapshot>: Name or ID of the snapshot(s) to delete.

4.3.52. cinder snapshot-list

usage: cinder snapshot-list [--all-tenants [<0|1>]] [--display-name <display-name>] [--status <status>] [--volume-id <volume-id>]

Lists all snapshots.

Optional arguments

--all-tenants [<0|1>]: Shows details for all tenants. Admin only.
--display-name <display-name>: Filters list by a display name. Default=None.
--status <status>: Filters list by a status. Default=None.
--volume-id <volume-id>: Filters list by a volume ID. Default=None.

4.3.53. cinder snapshot-metadata

usage: cinder snapshot-metadata <snapshot> <action> <key=value> [<key=value> ...]

Sets or deletes snapshot metadata.

Positional arguments

<snapshot>: ID of snapshot for which to update metadata.
<action>: The action. Valid values are 'set' or 'unset.'
<key=value>: The metadata key and value pair to set or unset. For unset, specify only the key.

4.3.54. cinder snapshot-metadata-show

usage: cinder snapshot-metadata-show <snapshot>

Shows snapshot metadata.

Positional arguments

<snapshot>: ID of snapshot.

4.3.55. cinder snapshot-metadata-update-all

usage: cinder snapshot-metadata-update-all <snapshot> <key=value> [<key=value> ...]

Updates snapshot metadata.

Positional arguments

<snapshot>: ID of snapshot for which to update metadata.
<key=value>: Metadata key and value pair or pairs to update. Default=[].

4.3.56. cinder snapshot-rename

usage: cinder snapshot-rename [--display-description <display-description>] <snapshot> [<display-name>]

Renames a snapshot.

Positional arguments

<snapshot>: Name or ID of snapshot.
<display-name>: New display name for snapshot.

Optional arguments

--display-description <display-description>: Snapshot description. Default=None.

4.3.57. cinder snapshot-reset-state

usage: cinder snapshot-reset-state [--state <state>] <snapshot> [<snapshot> ...]

Explicitly updates the snapshot state.

Positional arguments

<snapshot>: Name or ID of snapshot to modify.

Optional arguments

--state <state>: The state to assign to the snapshot. Valid values are "available," "error," "creating," "deleting," or "error_deleting." Default is "available."

4.3.58. cinder snapshot-show

usage: cinder snapshot-show <snapshot>

Shows snapshot details.

Positional arguments

<snapshot>: Name or ID of snapshot.

4.3.59. cinder transfer-accept

usage: cinder transfer-accept <transfer> <auth_key>

Accepts a volume transfer.

Positional arguments

<transfer>: ID of transfer to accept.
<auth_key>: Authentication key of transfer to accept.

4.3.60. cinder transfer-create

usage: cinder transfer-create [--display-name <display-name>] <volume>

Creates a volume transfer.

Positional arguments

<volume>: Name or ID of volume to transfer.

Optional arguments

--display-name <display-name>: Transfer name. Default=None.

4.3.61. cinder transfer-delete

usage: cinder transfer-delete <transfer>

Undoes a transfer.

Positional arguments

<transfer>: Name or ID of transfer to delete.

4.3.62. cinder transfer-list

usage: cinder transfer-list

Lists all transfers.

4.3.63. cinder transfer-show

usage: cinder transfer-show <transfer>

Show transfer details.

Positional arguments

<transfer>: Name or ID of transfer to accept.

4.3.64. cinder type-create

usage: cinder type-create <name>

Creates a volume type.

Positional arguments

<name>: Name for the volume type.

4.3.65. cinder type-delete

usage: cinder type-delete <id>

Deletes a specified volume type.

Positional arguments

<id>: ID of volume type to delete.

4.3.66. cinder type-key

usage: cinder type-key <vtype> <action> [<key=value> [<key=value> ...]]

Sets or unsets extra_spec for a volume type.

Positional arguments

<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. Default=None.

4.3.67. cinder type-list

usage: cinder type-list

Lists available 'volume types'.

4.3.68. cinder upload-to-image

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.

Positional arguments

<volume>: Name or ID of volume to upload to an image.
<image-name>: The new image name.

Optional arguments

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

4.4. Block Storage API v2 commands

You can select an API version to use by adding the --os-volume-api-version option or by setting the corresponding environment variable:

$ export OS_VOLUME_API_VERSION=2

4.4.1. cinder absolute-limits (v2)

usage: cinder --os-volume-api-version 2 absolute-limits

Lists absolute limits for a user.

4.4.2. cinder availability-zone-list (v2)

usage: cinder --os-volume-api-version 2 availability-zone-list

Lists all availability zones.

4.4.3. cinder backup-create (v2)

usage: cinder --os-volume-api-version 2 backup-create [--container <container>] [--name <name>] [--description <description>] <volume>

Creates a volume backup.

Positional arguments

<volume>: Name or ID of volume to backup.

Optional arguments

--container <container>: Backup container name. Default=None.
--name <name>: Backup name. Default=None.
--description <description>: Backup description. Default=None.

4.4.4. cinder backup-delete (v2)

usage: cinder --os-volume-api-version 2 backup-delete <backup>

Removes a backup.

Positional arguments

<backup>: Name or ID of backup to delete.

4.4.5. cinder backup-export (v2)

usage: cinder --os-volume-api-version 2 backup-export <backup>

Export backup metadata record.

Positional arguments

<backup>: ID of the backup to export.

4.4.6. cinder backup-import (v2)

usage: cinder --os-volume-api-version 2 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.

4.4.7. cinder backup-list (v2)

usage: cinder --os-volume-api-version 2 backup-list

Lists all backups.

4.4.8. cinder backup-restore (v2)

usage: cinder --os-volume-api-version 2 backup-restore [--volume <volume>] <backup>

Restores a backup.

Positional arguments

<backup>: ID of backup to restore.

Optional arguments

--volume <volume>: Name or ID of volume to which to restore. Default=None.

4.4.9. cinder backup-show (v2)

usage: cinder --os-volume-api-version 2 backup-show <backup>

Shows backup details.

Positional arguments

<backup>: Name or ID of backup.

4.4.10. cinder cgsnapshot-create (v2)

usage: cinder --os-volume-api-version 2 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.

4.4.11. cinder cgsnapshot-delete (v2)

usage: cinder --os-volume-api-version 2 cgsnapshot-delete <cgsnapshot> [<cgsnapshot> ...]

Removes one or more cgsnapshots.

Positional arguments

<cgsnapshot>: Name or ID of one or more cgsnapshots to be deleted.

4.4.12. cinder cgsnapshot-list (v2)

usage: cinder --os-volume-api-version 2 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.

4.4.13. cinder cgsnapshot-show (v2)

usage: cinder --os-volume-api-version 2 cgsnapshot-show <cgsnapshot>

Shows cgsnapshot details.

Positional arguments

<cgsnapshot>: Name or ID of cgsnapshot.

4.4.14. cinder consisgroup-create (v2)

usage: cinder --os-volume-api-version 2 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.

4.4.15. cinder consisgroup-delete (v2)

usage: cinder --os-volume-api-version 2 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.

4.4.16. cinder consisgroup-list (v2)

usage: cinder --os-volume-api-version 2 consisgroup-list [--all-tenants [<0|1>]]

Lists all consistencygroups.

Optional arguments

--all-tenants [<0|1>]: Shows details for all tenants. Admin only.

4.4.17. cinder consisgroup-show (v2)

usage: cinder --os-volume-api-version 2 consisgroup-show <consistencygroup>

Shows details of a consistency group.

Positional arguments

<consistencygroup>: Name or ID of a consistency group.

4.4.18. cinder create (v2)

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>] [--name <name>] [--description <description>] [--volume-type <volume-type>] [--availability-zone <availability-zone>] [--metadata [<key=value> [<key=value> ...]]] [--hint <key=value>] [<size>]

Creates a volume.

Positional arguments

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

4.4.19. cinder credentials (v2)

usage: cinder --os-volume-api-version 2 credentials

Shows user credentials returned from auth.

4.4.20. cinder delete (v2)

usage: cinder --os-volume-api-version 2 delete <volume> [<volume> ...]

Removes one or more volumes.

Positional arguments

<volume>: Name or ID of volume or volumes to delete.

4.4.21. cinder encryption-type-create (v2)

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.

Positional arguments

<volume_type>: Name or ID of volume type.
<provider>: The class that provides encryption support. For example, LuksEncryptor.

Optional arguments

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

4.4.22. cinder encryption-type-delete (v2)

usage: cinder --os-volume-api-version 2 encryption-type-delete <volume_type>

Deletes encryption type for a volume type. Admin only.

Positional arguments

<volume_type>: Name or ID of volume type.

4.4.23. cinder encryption-type-list (v2)

usage: cinder --os-volume-api-version 2 encryption-type-list

Shows encryption type details for volume types. Admin only.

4.4.24. cinder encryption-type-show (v2)

usage: cinder --os-volume-api-version 2 encryption-type-show <volume_type>

Shows encryption type details for a volume type. Admin only.

Positional arguments

<volume_type>: Name or ID of volume type.

4.4.25. cinder endpoints (v2)

usage: cinder --os-volume-api-version 2 endpoints

Discovers endpoints registered by authentication service.

4.4.26. cinder extend (v2)

usage: cinder --os-volume-api-version 2 extend <volume> <new_size>

Attempts to extend size of an existing volume.

Positional arguments

<volume>: Name or ID of volume to extend.
<new_size>: New size of volume, in GBs.

4.4.27. cinder extra-specs-list (v2)

usage: cinder --os-volume-api-version 2 extra-specs-list

Lists current volume types and extra specs.

4.4.28. cinder force-delete (v2)

usage: cinder --os-volume-api-version 2 force-delete <volume> [<volume> ...]

Attempts force-delete of volume, regardless of state.

Positional arguments

<volume>: Name or ID of volume or volumes to delete.

4.4.29. cinder list (v2)

usage: cinder --os-volume-api-version 2 list [--all-tenants [<0|1>]] [--name <name>] [--status <status>] [--metadata [<key=value> [<key=value> ...]]] [--marker <marker>] [--limit <limit>] [--sort_key <sort_key>] [--sort_dir <sort_dir>]

Lists all volumes.

Optional arguments

--all-tenants [<0|1>]: Shows details for all tenants. Admin only.
--name <name>: Filters results by a name. OPTIONAL: Default=None.
--status <status>: Filters results by a status. OPTIONAL: Default=None.
--metadata [<key=value> [<key=value> ...]]: Filters results by a metadata key and value pair. OPTIONAL: Default=None.
--marker <marker>: Begin returning volumes that appear later in the volume list than that represented by this volume id. OPTIONAL: Default=None.
--limit <limit>: Maximum number of volumes to return. OPTIONAL: Default=None.
--sort_key <sort_key>: Key to be sorted, should be (`id`, `status`, `size`, `availability_zone`, `name`, `bootable`, `created_at`). OPTIONAL: Default=None.
--sort_dir <sort_dir>: Sort direction, should be `desc` or `asc`. OPTIONAL: Default=None.

4.4.30. cinder list-extensions (v2)

usage: cinder --os-volume-api-version 2 list-extensions

Lists all available os-api extensions.

4.4.31. cinder manage (v2)

usage: cinder --os-volume-api-version 2 manage [--source-name <source-name>] [--source-id <source-id>] [--name <name>] [--description <description>] [--volume-type <volume-type>] [--availability-zone <availability-zone>] [--metadata [<key=value> [<key=value> ...]]] [--bootable] <host> [<key=value> [<key=value> ...]]

Manage an existing volume.

Positional arguments

<host>: Cinder host on which the existing volume resides
<key=value>: Driver-specific reference to the existing volume as key=value pairs

Optional arguments

--source-name <source-name>: Name of the volume to manage (Optional)
--source-id <source-id>: ID of the volume to manage (Optional)
--name <name>: Volume name (Optional, Default=None)
--description <description>: Volume description (Optional, Default=None)
--volume-type <volume-type>: Volume type (Optional, Default=None)
--availability-zone <availability-zone>: Availability zone for volume (Optional, Default=None)
--metadata [<key=value> [<key=value> ...]]: Metadata key=value pairs (Optional, Default=None)
--bootable: Specifies that the newly created volume should be marked as bootable

4.4.32. cinder metadata (v2)

usage: cinder --os-volume-api-version 2 metadata <volume> <action> <key=value> [<key=value> ...]

Sets or deletes volume 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.

4.4.33. cinder metadata-show (v2)

usage: cinder --os-volume-api-version 2 metadata-show <volume>

Shows volume metadata.

Positional arguments

<volume>: ID of volume.

4.4.34. cinder metadata-update-all (v2)

usage: cinder --os-volume-api-version 2 metadata-update-all <volume> <key=value> [<key=value> ...]

Updates volume metadata.

Positional arguments

<volume>: ID of volume for which to update metadata.
<key=value>: Metadata key and value pair or pairs to update.

4.4.35. cinder migrate (v2)

usage: cinder --os-volume-api-version 2 migrate [--force-host-copy <True|False>] <volume> <host>

Migrates volume to a new host.

Positional arguments

<volume>: ID of volume to migrate.
<host>: Destination host.

Optional arguments

--force-host-copy <True|False>: Enables or disables generic host-based force- migration, which bypasses driver optimizations. Default=False.

4.4.36. cinder qos-associate (v2)

usage: cinder --os-volume-api-version 2 qos-associate <qos_specs> <volume_type_id>

Associates qos specs with specified volume type.

Positional arguments

<qos_specs>: ID of QoS specifications.
<volume_type_id>: ID of volume type with which to associate QoS specifications.

4.4.37. cinder qos-create (v2)

usage: cinder --os-volume-api-version 2 qos-create <name> <key=value> [<key=value> ...]

Creates a qos specs.

Positional arguments

<name>: Name of new QoS specifications.
<key=value>: QoS specifications.

4.4.38. cinder qos-delete (v2)

usage: cinder --os-volume-api-version 2 qos-delete [--force <True|False>] <qos_specs>

Deletes a specified qos specs.

Positional arguments

<qos_specs>: ID of QoS specifications to delete.

Optional arguments

--force <True|False>: Enables or disables deletion of in-use QoS specifications. Default=False.

4.4.39. cinder qos-disassociate (v2)

usage: cinder --os-volume-api-version 2 qos-disassociate <qos_specs> <volume_type_id>

Disassociates qos specs from specified volume type.

Positional arguments

<qos_specs>: ID of QoS specifications.
<volume_type_id>: ID of volume type with which to associate QoS specifications.

4.4.40. cinder qos-disassociate-all (v2)

usage: cinder --os-volume-api-version 2 qos-disassociate-all <qos_specs>

Disassociates qos specs from all its associations.

Positional arguments

<qos_specs>: ID of QoS specifications on which to operate.

4.4.41. cinder qos-get-association (v2)

usage: cinder --os-volume-api-version 2 qos-get-association <qos_specs>

Lists all associations for specified qos specs.

Positional arguments

<qos_specs>: ID of QoS specifications.

4.4.42. cinder qos-key (v2)

usage: cinder --os-volume-api-version 2 qos-key <qos_specs> <action> key=value [key=value ...]

Sets or unsets specifications for a qos spec.

Positional arguments

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

4.4.43. cinder qos-list (v2)

usage: cinder --os-volume-api-version 2 qos-list

Lists qos specs.

4.4.44. cinder qos-show (v2)

usage: cinder --os-volume-api-version 2 qos-show <qos_specs>

Shows qos specs details.

Positional arguments

<qos_specs>: ID of QoS specifications to show.

4.4.45. cinder quota-class-show (v2)

usage: cinder --os-volume-api-version 2 quota-class-show <class>

Lists quotas for a quota class.

Positional arguments

<class>: Name of quota class for which to list quotas.

4.4.46. cinder quota-class-update (v2)

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.

Positional arguments

<class-name>: Name of quota class for which to set quotas.

Optional arguments

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

4.4.47. cinder quota-defaults (v2)

usage: cinder --os-volume-api-version 2 quota-defaults <tenant_id>

Lists default quotas for a tenant.

Positional arguments

<tenant_id>: ID of tenant for which to list quota defaults.

4.4.48. cinder quota-delete (v2)

usage: cinder --os-volume-api-version 2 quota-delete <tenant_id>

Delete the quotas for a tenant.

Positional arguments

<tenant_id>: UUID of tenant to delete the quotas for.

4.4.49. cinder quota-show (v2)

usage: cinder --os-volume-api-version 2 quota-show <tenant_id>

Lists quotas for a tenant.

Positional arguments

<tenant_id>: ID of tenant for which to list quotas.

4.4.50. cinder quota-update (v2)

usage: cinder --os-volume-api-version 2 quota-update [--volumes <volumes>] [--snapshots <snapshots>] [--gigabytes <gigabytes>] [--volume-type <volume_type_name>] <tenant_id>

Updates quotas for a tenant.

Positional arguments

<tenant_id>: ID of tenant for which to set quotas.

Optional arguments

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

4.4.51. cinder quota-usage (v2)

usage: cinder --os-volume-api-version 2 quota-usage <tenant_id>

Lists quota usage for a tenant.

Positional arguments

<tenant_id>: ID of tenant for which to list quota usage.

4.4.52. cinder rate-limits (v2)

usage: cinder --os-volume-api-version 2 rate-limits

Lists rate limits for a user.

4.4.53. cinder readonly-mode-update (v2)

usage: cinder --os-volume-api-version 2 readonly-mode-update <volume> <True|true|False|false>

Updates volume read-only access-mode flag.

Positional arguments

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

4.4.54. cinder rename (v2)

usage: cinder --os-volume-api-version 2 rename [--description <description>] <volume> [<name>]

Renames a volume.

Positional arguments

<volume>: Name or ID of volume to rename.
<name>: New name for volume.

Optional arguments

--description <description>: Volume description. Default=None.

4.4.55. cinder replication-promote (v2)

usage: cinder --os-volume-api-version 2 replication-promote <volume>

Promote a secondary volume to primary for a relationship.

Positional arguments

<volume>: Name or ID of the volume to promote.

4.4.56. cinder replication-reenable (v2)

usage: cinder --os-volume-api-version 2 replication-reenable <volume>

Sync the secondary volume with primary for a relationship.

Positional arguments

<volume>: Name or ID of the volume to reenable replication.

4.4.57. cinder reset-state (v2)

usage: cinder --os-volume-api-version 2 reset-state [--state <state>] <volume> [<volume> ...]

Explicitly updates the volume state.

Positional arguments

<volume>: Name or ID of volume to modify.

Optional arguments

--state <state>: The state to assign to the volume. Valid values are "available," "error," "creating," "deleting," and "error_deleting." Default=available.

4.4.58. cinder retype (v2)

usage: cinder --os-volume-api-version 2 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.

4.4.59. cinder service-disable (v2)

usage: cinder --os-volume-api-version 2 service-disable [--reason <reason>] <hostname> <binary>

Disables the service.

Positional arguments

<hostname>: Host name.
<binary>: Service binary.

Optional arguments

--reason <reason>: Reason for disabling service.

4.4.60. cinder service-enable (v2)

usage: cinder --os-volume-api-version 2 service-enable <hostname> <binary>

Enables the service.

Positional arguments

<hostname>: Host name.
<binary>: Service binary.

4.4.61. cinder service-list (v2)

usage: cinder --os-volume-api-version 2 service-list [--host <hostname>] [--binary <binary>]

Lists all services. Filter by host and service binary.

Optional arguments

--host <hostname>: Host name. Default=None.
--binary <binary>: Service binary. Default=None.

4.4.62. cinder set-bootable (v2)

usage: cinder --os-volume-api-version 2 set-bootable <volume> <True|true|False|false>

Update bootable status of a volume.

Positional arguments

<volume>: ID of the volume to update.
<True|true|False|false>: Flag to indicate whether volume is bootable.

4.4.63. cinder show (v2)

usage: cinder --os-volume-api-version 2 show <volume>

Shows volume details.

Positional arguments

<volume>: Name or ID of volume.

4.4.64. cinder snapshot-create (v2)

usage: cinder --os-volume-api-version 2 snapshot-create [--force <True|False>] [--name <name>] [--description <description>] <volume>

Creates a snapshot.

Positional arguments

<volume>: Name or ID of volume to snapshot.

Optional arguments

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

4.4.65. cinder snapshot-delete (v2)

usage: cinder --os-volume-api-version 2 snapshot-delete <snapshot> [<snapshot> ...]

Removes one or more snapshots.

Positional arguments

<snapshot>: Name or ID of the snapshot(s) to delete.

4.4.66. cinder snapshot-list (v2)

usage: cinder --os-volume-api-version 2 snapshot-list [--all-tenants [<0|1>]] [--name <name>] [--status <status>] [--volume-id <volume-id>]

Lists all snapshots.

Optional arguments

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

4.4.67. cinder snapshot-metadata (v2)

usage: cinder --os-volume-api-version 2 snapshot-metadata <snapshot> <action> <key=value> [<key=value> ...]

Sets or deletes snapshot metadata.

Positional arguments

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

4.4.68. cinder snapshot-metadata-show (v2)

usage: cinder --os-volume-api-version 2 snapshot-metadata-show <snapshot>

Shows snapshot metadata.

Positional arguments

<snapshot>: ID of snapshot.

4.4.69. cinder snapshot-metadata-update-all (v2)

usage: cinder --os-volume-api-version 2 snapshot-metadata-update-all <snapshot> <key=value> [<key=value> ...]

Updates snapshot metadata.

Positional arguments

<snapshot>: ID of snapshot for which to update metadata.
<key=value>: Metadata key and value pair to update.

4.4.70. cinder snapshot-rename (v2)

usage: cinder --os-volume-api-version 2 snapshot-rename [--description <description>] <snapshot> [<name>]

Renames a snapshot.

Positional arguments

<snapshot>: Name or ID of snapshot.
<name>: New name for snapshot.

Optional arguments

--description <description>: Snapshot description. Default=None.

4.4.71. cinder snapshot-reset-state (v2)

usage: cinder --os-volume-api-version 2 snapshot-reset-state [--state <state>] <snapshot> [<snapshot> ...]

Explicitly updates the snapshot state.

Positional arguments

<snapshot>: Name or ID of snapshot to modify.

Optional arguments

--state <state>: The state to assign to the snapshot. Valid values are "available," "error," "creating," "deleting," and "error_deleting." Default is "available."

4.4.72. cinder snapshot-show (v2)

usage: cinder --os-volume-api-version 2 snapshot-show <snapshot>

Shows snapshot details.

Positional arguments

<snapshot>: Name or ID of snapshot.

4.4.73. cinder transfer-accept (v2)

usage: cinder --os-volume-api-version 2 transfer-accept <transfer> <auth_key>

Accepts a volume transfer.

Positional arguments

<transfer>: ID of transfer to accept.
<auth_key>: Authentication key of transfer to accept.

4.4.74. cinder transfer-create (v2)

usage: cinder --os-volume-api-version 2 transfer-create [--name <name>] <volume>

Creates a volume transfer.

Positional arguments

<volume>: Name or ID of volume to transfer.

Optional arguments

--name <name>: Transfer name. Default=None.

4.4.75. cinder transfer-delete (v2)

usage: cinder --os-volume-api-version 2 transfer-delete <transfer>

Undoes a transfer.

Positional arguments

<transfer>: Name or ID of transfer to delete.

4.4.76. cinder transfer-list (v2)

usage: cinder --os-volume-api-version 2 transfer-list

Lists all transfers.

4.4.77. cinder transfer-show (v2)

usage: cinder --os-volume-api-version 2 transfer-show <transfer>

Shows transfer details.

Positional arguments

<transfer>: Name or ID of transfer to accept.

4.4.78. cinder type-create (v2)

usage: cinder --os-volume-api-version 2 type-create <name>

Creates a volume type.

Positional arguments

<name>: Name of new volume type.

4.4.79. cinder type-delete (v2)

usage: cinder --os-volume-api-version 2 type-delete <id>

Deletes a volume type.

Positional arguments

<id>: ID of volume type to delete.

4.4.80. cinder type-key (v2)

usage: cinder --os-volume-api-version 2 type-key <vtype> <action> <key=value> [<key=value> ...]

Sets or unsets extra_spec for a volume type.

Positional arguments

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

4.4.81. cinder type-list (v2)

usage: cinder --os-volume-api-version 2 type-list

Lists available 'volume types'.

4.4.82. cinder unmanage (v2)

usage: cinder --os-volume-api-version 2 unmanage <volume>

Positional arguments

<volume>: Name or ID of the volume to unmanage.

4.4.83. cinder upload-to-image (v2)

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.

Positional arguments

<volume>: Name or ID of volume to snapshot.
<image-name>: The new image name.

Optional arguments

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

Language:

Language and Page Formatting Options

Language:

Chapter 4. Block Storage command-line client

4.1. cinder usage

4.2. cinder optional arguments

4.3. Block Storage API v1 commands

4.3.1. cinder absolute-limits

4.3.2. cinder availability-zone-list

4.3.3. cinder backup-create

4.3.4. cinder backup-delete

4.3.5. cinder backup-list

4.3.6. cinder backup-restore

4.3.7. cinder backup-show

4.3.8. cinder create

4.3.9. cinder credentials

4.3.10. cinder delete

4.3.11. cinder encryption-type-create

4.3.12. cinder encryption-type-delete

4.3.13. cinder encryption-type-list

4.3.14. cinder encryption-type-show

4.3.15. cinder endpoints

4.3.16. cinder extend

4.3.17. cinder extra-specs-list

4.3.18. cinder force-delete

4.3.19. cinder list

4.3.20. cinder list-extensions

4.3.21. cinder metadata

4.3.22. cinder metadata-show

4.3.23. cinder metadata-update-all

4.3.24. cinder migrate

4.3.25. cinder qos-associate

4.3.26. cinder qos-create

4.3.27. cinder qos-delete

4.3.28. cinder qos-disassociate

4.3.29. cinder qos-disassociate-all

4.3.30. cinder qos-get-association

4.3.31. cinder qos-key

4.3.32. cinder qos-list

4.3.33. cinder qos-show

4.3.34. cinder quota-class-show

4.3.35. cinder quota-class-update

4.3.36. cinder quota-defaults

4.3.37. cinder quota-delete

4.3.38. cinder quota-show

4.3.39. cinder quota-update

4.3.40. cinder quota-usage

4.3.41. cinder rate-limits

4.3.42. cinder readonly-mode-update

4.3.43. cinder rename

4.3.44. cinder reset-state

4.3.45. cinder service-disable

4.3.46. cinder service-enable

4.3.47. cinder service-list

4.3.48. cinder set-bootable

4.3.49. cinder show

4.3.50. cinder snapshot-create

4.3.51. cinder snapshot-delete

4.3.52. cinder snapshot-list

4.3.53. cinder snapshot-metadata

4.3.54. cinder snapshot-metadata-show

4.3.55. cinder snapshot-metadata-update-all

4.3.56. cinder snapshot-rename

4.3.57. cinder snapshot-reset-state

4.3.58. cinder snapshot-show

4.3.59. cinder transfer-accept

4.3.60. cinder transfer-create

4.3.61. cinder transfer-delete

4.3.62. cinder transfer-list

4.3.63. cinder transfer-show

4.3.64. cinder type-create

4.3.65. cinder type-delete

4.3.66. cinder type-key

4.3.67. cinder type-list

4.3.68. cinder upload-to-image

4.4. Block Storage API v2 commands

4.4.1. cinder absolute-limits (v2)

4.4.2. cinder availability-zone-list (v2)

4.4.3. cinder backup-create (v2)

4.4.4. cinder backup-delete (v2)