Chapter 5. Block Storage service command-line client
1.4.0
.
$
cinder
help
COMMAND
5.1. cinder usage
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>] [--profile HMAC_KEY] [--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> ...
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-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.
5.2. cinder optional arguments
- --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 novaenv[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.
- --profile HMAC_KEY
- HMAC key to use for encrypting context data for performance profiling of operation. This key needs to match the one configured on the cinder api server. Without key the profiling will not be triggered even if osprofiler is enabled on server side.
- --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).
5.3. Block Storage API v1 commands (DEPRECATED)
5.3.1. cinder absolute-limits
usage: cinder absolute-limits
5.3.2. cinder availability-zone-list
usage: cinder availability-zone-list
5.3.3. cinder backup-create
usage: cinder backup-create [--container <container>] [--name <name>] [--description <description>] [--incremental] [--force] <volume>
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.
- --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.
5.3.4. cinder backup-delete
usage: cinder backup-delete <backup>
Positional arguments
- <backup>
- Name or ID of backup to delete.
5.3.5. cinder backup-export
usage: cinder backup-export <backup>
Positional arguments
- <backup>
- ID of the backup to export.
5.3.6. cinder backup-import
usage: cinder backup-import <backup_service> <backup_url>
Positional arguments
- <backup_service>
- Backup service to use for importing the backup.
- <backup_url>
- Backup URL for importing the backup metadata.
5.3.7. cinder backup-list
usage: cinder backup-list [--all-tenants [<all_tenants>]] [--name <name>] [--status <status>] [--volume-id <volume-id>]
Optional arguments
- --all-tenants [<all_tenants>]
- Shows details for all tenants. Admin only.
- --name <name>
- Filters results by a name. Default=None.
- --status <status>
- Filters results by a status. Default=None.
- --volume-id <volume-id>
- Filters results by a volume ID. Default=None.
5.3.8. cinder backup-restore
usage: cinder backup-restore [--volume <volume>] <backup>
Positional arguments
- <backup>
- ID of backup to restore.
Optional arguments
- --volume <volume>
- Name or ID of volume to which to restore. Default=None.
5.3.9. cinder backup-show
usage: cinder backup-show <backup>
Positional arguments
- <backup>
- Name or ID of backup.
5.3.10. cinder cgsnapshot-create
usage: cinder cgsnapshot-create [--name <name>] [--description <description>] <consistencygroup>
Positional arguments
- <consistencygroup>
- Name or ID of a consistency group.
Optional arguments
- --name <name>
- Cgsnapshot name. Default=None.
- --description <description>
- Cgsnapshot description. Default=None.
5.3.11. cinder cgsnapshot-delete
usage: cinder cgsnapshot-delete <cgsnapshot> [<cgsnapshot> ...]
Positional arguments
- <cgsnapshot>
- Name or ID of one or more cgsnapshots to be deleted.
5.3.12. cinder cgsnapshot-list
usage: cinder cgsnapshot-list [--all-tenants [<0|1>]] [--status <status>] [--consistencygroup-id <consistencygroup_id>]
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.
5.3.13. cinder cgsnapshot-show
usage: cinder cgsnapshot-show <cgsnapshot>
Positional arguments
- <cgsnapshot>
- Name or ID of cgsnapshot.
5.3.14. cinder consisgroup-create
usage: cinder consisgroup-create [--name <name>] [--description <description>] [--availability-zone <availability-zone>] <volume-types>
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.
5.3.15. cinder consisgroup-create-from-src
usage: cinder consisgroup-create-from-src [--cgsnapshot <cgsnapshot>] [--source-cg <source-cg>] [--name <name>] [--description <description>]
Optional arguments
- --cgsnapshot <cgsnapshot>
- Name or ID of a cgsnapshot. Default=None.
- --source-cg <source-cg>
- Name or ID of a source CG. Default=None.
- --name <name>
- Name of a consistency group. Default=None.
- --description <description>
- Description of a consistency group. Default=None.
5.3.16. cinder consisgroup-delete
usage: cinder consisgroup-delete [--force] <consistencygroup> [<consistencygroup> ...]
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.
5.3.17. cinder consisgroup-list
usage: cinder consisgroup-list [--all-tenants [<0|1>]]
Optional arguments
- --all-tenants [<0|1>]
- Shows details for all tenants. Admin only.
5.3.18. cinder consisgroup-show
usage: cinder consisgroup-show <consistencygroup>
Positional arguments
- <consistencygroup>
- Name or ID of a consistency group.
5.3.19. cinder consisgroup-update
usage: cinder consisgroup-update [--name <name>] [--description <description>] [--add-volumes <uuid1,uuid2,......>] [--remove-volumes <uuid3,uuid4,......>] <consistencygroup>
Positional arguments
- <consistencygroup>
- Name or ID of a consistency group.
Optional arguments
- --name <name>
- New name for consistency group. Default=None.
- --description <description>
- New description for consistency group. Default=None.
- --add-volumes <uuid1,uuid2,......>
- UUID of one or more volumes to be added to the consistency group, separated by commas. Default=None.
- --remove-volumes <uuid3,uuid4,......>
- UUID of one or more volumes to be removed from the consistency group, separated by commas. Default=None.
5.3.20. cinder create
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>]
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.
- --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
5.3.21. cinder credentials
usage: cinder credentials
5.3.22. cinder delete
usage: cinder delete <volume> [<volume> ...]
Positional arguments
- <volume>
- Name or ID of volume or volumes to delete.
5.3.23. cinder encryption-type-create
usage: cinder encryption-type-create [--cipher <cipher>] [--key_size <key_size>] [--control_location <control_location>] <volume_type> <provider>
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."
5.3.24. cinder encryption-type-delete
usage: cinder encryption-type-delete <volume_type>
Positional arguments
- <volume_type>
- Name or ID of volume type.
5.3.25. cinder encryption-type-list
usage: cinder encryption-type-list
5.3.26. cinder encryption-type-show
usage: cinder encryption-type-show <volume_type>
Positional arguments
- <volume_type>
- Name or ID of volume type.
5.3.27. cinder encryption-type-update
usage: cinder encryption-type-update [--provider <provider>] [--cipher [<cipher>]] [--key-size [<key-size>]] [--control-location <control-location>] <volume-type>
Positional arguments
- <volume-type>
- Name or ID of the volume type
Optional arguments
- --provider <provider>
- Class providing encryption support (e.g. LuksEncryptor) (Optional)
- --cipher [<cipher>]
- Encryption algorithm/mode to use (e.g., aes-xts- plain64). Provide parameter without value to set to provider default. (Optional)
- --key-size [<key-size>]
- Size of the encryption key, in bits (e.g., 128, 256). Provide parameter without value to set to provider default. (Optional)
- --control-location <control-location>
- Notional service where encryption is performed (e.g., front-end=Nova). Values: 'front-end', 'back-end' (Optional)
5.3.28. cinder endpoints
usage: cinder endpoints
5.3.29. cinder extend
usage: cinder extend <volume> <new_size>
Positional arguments
- <volume>
- Name or ID of volume to extend.
- <new_size>
- New size of volume, in GBs.
5.3.30. cinder extra-specs-list
usage: cinder extra-specs-list
5.3.31. cinder force-delete
usage: cinder force-delete <volume> [<volume> ...]
Positional arguments
- <volume>
- Name or ID of volume or volumes to delete.
5.3.32. cinder get-capabilities
usage: cinder get-capabilities <host>
Positional arguments
- <host>
- Cinder host to show backend volume stats and properties; takes the form: host@backend-name
5.3.33. cinder get-pools
usage: cinder get-pools [--detail]
Optional arguments
- --detail
- Show detailed information about pools.
5.3.34. cinder image-metadata
usage: cinder image-metadata <volume> <action> <key=value> [<key=value> ...]
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.
5.3.35. cinder list
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>]]
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.
- --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).
5.3.36. cinder list-extensions
usage: cinder list-extensions
5.3.37. cinder manage
usage: cinder manage [--id-type <id-type>] [--name <name>] [--description <description>] [--volume-type <volume-type>] [--availability-zone <availability-zone>] [--metadata [<key=value> [<key=value> ...]]] [--bootable] <host> <identifier>
Positional arguments
- <host>
- Cinder host on which the existing volume resides; takes the form: host@backend-name#pool
- <identifier>
- Name or other Identifier for existing volume
Optional arguments
- --id-type <id-type>
- Type of backend device identifier provided, typically source-name or source-id (Default=source-name)
- --name <name>
- Volume name (Default=None)
- --description <description>
- Volume description (Default=None)
- --volume-type <volume-type>
- Volume type (Default=None)
- --availability-zone <availability-zone>
- Availability zone for volume (Default=None)
- --metadata [<key=value> [<key=value> ...]]
- Metadata key=value pairs (Default=None)
- --bootable
- Specifies that the newly created volume should be marked as bootable
5.3.38. cinder metadata
usage: cinder metadata <volume> <action> <key=value> [<key=value> ...]
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.
5.3.39. cinder metadata-show
usage: cinder metadata-show <volume>
Positional arguments
- <volume>
- ID of volume.
5.3.40. cinder metadata-update-all
usage: cinder metadata-update-all <volume> <key=value> [<key=value> ...]
Positional arguments
- <volume>
- ID of volume for which to update metadata.
- <key=value>
- Metadata key and value pair or pairs to update.
5.3.41. cinder migrate
usage: cinder migrate [--force-host-copy [<True|False>]] [--lock-volume [<True|False>]] <volume> <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.
- --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.
5.3.42. cinder qos-associate
usage: cinder qos-associate <qos_specs> <volume_type_id>
Positional arguments
- <qos_specs>
- ID of QoS specifications.
- <volume_type_id>
- ID of volume type with which to associate QoS specifications.
5.3.43. cinder qos-create
usage: cinder qos-create <name> <key=value> [<key=value> ...]
Positional arguments
- <name>
- Name of new QoS specifications.
- <key=value>
- QoS specifications.
5.3.44. cinder qos-delete
usage: cinder qos-delete [--force [<True|False>]] <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.
5.3.45. cinder qos-disassociate
usage: cinder qos-disassociate <qos_specs> <volume_type_id>
Positional arguments
- <qos_specs>
- ID of QoS specifications.
- <volume_type_id>
- ID of volume type with which to associate QoS specifications.
5.3.46. cinder qos-disassociate-all
usage: cinder qos-disassociate-all <qos_specs>
Positional arguments
- <qos_specs>
- ID of QoS specifications on which to operate.
5.3.47. cinder qos-get-association
usage: cinder qos-get-association <qos_specs>
Positional arguments
- <qos_specs>
- ID of QoS specifications.
5.3.48. cinder qos-key
usage: cinder qos-key <qos_specs> <action> key=value [key=value ...]
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.
5.3.49. cinder qos-list
usage: cinder qos-list
5.3.50. cinder qos-show
usage: cinder qos-show <qos_specs>
Positional arguments
- <qos_specs>
- ID of QoS specifications to show.
5.3.51. cinder quota-class-show
usage: cinder quota-class-show <class>
Positional arguments
- <class>
- Name of quota class for which to list quotas.
5.3.52. cinder quota-class-update
usage: cinder quota-class-update [--volumes <volumes>] [--snapshots <snapshots>] [--gigabytes <gigabytes>] [--volume-type <volume_type_name>] <class_name>
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.
5.3.53. cinder quota-defaults
usage: cinder quota-defaults <tenant_id>
Positional arguments
- <tenant_id>
- ID of tenant for which to list quota defaults.
5.3.54. cinder quota-delete
usage: cinder quota-delete <tenant_id>
Positional arguments
- <tenant_id>
- UUID of tenant to delete the quotas for.
5.3.55. cinder quota-show
usage: cinder quota-show <tenant_id>
Positional arguments
- <tenant_id>
- ID of tenant for which to list quotas.
5.3.56. cinder quota-update
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>
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.
- --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.
5.3.57. cinder quota-usage
usage: cinder quota-usage <tenant_id>
Positional arguments
- <tenant_id>
- ID of tenant for which to list quota usage.
5.3.58. cinder rate-limits
usage: cinder rate-limits
5.3.59. cinder readonly-mode-update
usage: cinder readonly-mode-update <volume> <True|true|False|false>
Positional arguments
- <volume>
- ID of volume to update.
- <True|true|False|false>
- Enables or disables update of volume to read-only access mode.
5.3.60. cinder rename
usage: cinder rename [--description <description>] <volume> [<name>]
Positional arguments
- <volume>
- Name or ID of volume to rename.
- <name>
- New name for volume.
Optional arguments
- --description <description>
- Volume description. Default=None.
5.3.61. cinder replication-promote
usage: cinder replication-promote <volume>
Positional arguments
- <volume>
- Name or ID of the volume to promote. The volume should have the replica volume created with source-replica argument.
5.3.62. cinder replication-reenable
usage: cinder replication-reenable <volume>
Positional arguments
- <volume>
- Name or ID of the volume to reenable replication. The replication- status of the volume should be inactive.
5.3.63. cinder reset-state
usage: cinder reset-state [--state <state>] [--attach-status <attach-status>] [--reset-migration-status] <volume> [<volume> ...]
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", "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.
5.3.64. cinder retype
usage: cinder retype [--migration-policy <never|on-demand>] <volume> <volume-type>
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.
5.3.65. cinder service-disable
usage: cinder service-disable [--reason <reason>] <hostname> <binary>
Positional arguments
- <hostname>
- Host name.
- <binary>
- Service binary.
Optional arguments
- --reason <reason>
- Reason for disabling service.
5.3.66. cinder service-enable
usage: cinder service-enable <hostname> <binary>
Positional arguments
- <hostname>
- Host name.
- <binary>
- Service binary.
5.3.67. cinder service-list
usage: cinder service-list [--host <hostname>] [--binary <binary>]
Optional arguments
- --host <hostname>
- Host name. Default=None.
- --binary <binary>
- Service binary. Default=None.
5.3.68. cinder set-bootable
usage: cinder set-bootable <volume> <True|true|False|false>
Positional arguments
- <volume>
- ID of the volume to update.
- <True|true|False|false>
- Flag to indicate whether volume is bootable.
5.3.69. cinder show
usage: cinder show <volume>
Positional arguments
- <volume>
- Name or ID of volume.
5.3.70. cinder snapshot-create
usage: cinder snapshot-create [--force [<True|False>]] [--name <name>] [--description <description>] [--metadata [<key=value> [<key=value> ...]]] <volume>
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.
- --metadata [<key=value> [<key=value> ...]]
- Snapshot metadata key and value pairs. Default=None.
5.3.71. cinder snapshot-delete
usage: cinder snapshot-delete <snapshot> [<snapshot> ...]
Positional arguments
- <snapshot>
- Name or ID of the snapshot(s) to delete.
5.3.72. cinder snapshot-list
usage: cinder snapshot-list [--all-tenants [<0|1>]] [--name <name>] [--status <status>] [--volume-id <volume-id>]
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.
5.3.73. cinder snapshot-metadata
usage: cinder snapshot-metadata <snapshot> <action> <key=value> [<key=value> ...]
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.
5.3.74. cinder snapshot-metadata-show
usage: cinder snapshot-metadata-show <snapshot>
Positional arguments
- <snapshot>
- ID of snapshot.
5.3.75. cinder snapshot-metadata-update-all
usage: cinder snapshot-metadata-update-all <snapshot> <key=value> [<key=value> ...]
Positional arguments
- <snapshot>
- ID of snapshot for which to update metadata.
- <key=value>
- Metadata key and value pair to update.
5.3.76. cinder snapshot-rename
usage: cinder snapshot-rename [--description <description>] <snapshot> [<name>]
Positional arguments
- <snapshot>
- Name or ID of snapshot.
- <name>
- New name for snapshot.
Optional arguments
- --description <description>
- Snapshot description. Default=None.
5.3.77. cinder snapshot-reset-state
usage: cinder snapshot-reset-state [--state <state>] <snapshot> [<snapshot> ...]
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". 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.
5.3.78. cinder snapshot-show
usage: cinder snapshot-show <snapshot>
Positional arguments
- <snapshot>
- Name or ID of snapshot.
5.3.79. cinder transfer-accept
usage: cinder transfer-accept <transfer> <auth_key>
Positional arguments
- <transfer>
- ID of transfer to accept.
- <auth_key>
- Authentication key of transfer to accept.
5.3.80. cinder transfer-create
usage: cinder transfer-create [--name <name>] <volume>
Positional arguments
- <volume>
- Name or ID of volume to transfer.
Optional arguments
- --name <name>
- Transfer name. Default=None.
5.3.81. cinder transfer-delete
usage: cinder transfer-delete <transfer>
Positional arguments
- <transfer>
- Name or ID of transfer to delete.
5.3.82. cinder transfer-list
usage: cinder transfer-list [--all-tenants [<0|1>]]
Optional arguments
- --all-tenants [<0|1>]
- Shows details for all tenants. Admin only.
5.3.83. cinder transfer-show
usage: cinder transfer-show <transfer>
Positional arguments
- <transfer>
- Name or ID of transfer to accept.
5.3.84. cinder type-access-add
usage: cinder type-access-add --volume-type <volume_type> --project-id <project_id>
Optional arguments
- --volume-type <volume_type>
- Volume type name or ID to add access for the given project.
- --project-id <project_id>
- Project ID to add volume type access for.
5.3.85. cinder type-access-list
usage: cinder type-access-list --volume-type <volume_type>
Optional arguments
- --volume-type <volume_type>
- Filter results by volume type name or ID.
5.3.86. cinder type-access-remove
usage: cinder type-access-remove --volume-type <volume_type> --project-id <project_id>
Optional arguments
- --volume-type <volume_type>
- Volume type name or ID to remove access for the given project.
- --project-id <project_id>
- Project ID to remove volume type access for.
5.3.87. cinder type-create
usage: cinder type-create [--description <description>] [--is-public <is-public>] <name>
Positional arguments
- <name>
- Name of new volume type.
Optional arguments
- --description <description>
- Description of new volume type.
- --is-public <is-public>
- Make type accessible to the public (default true).
5.3.88. cinder type-default
usage: cinder type-default
5.3.89. cinder type-delete
usage: cinder type-delete <id>
Positional arguments
- <id>
- ID of volume type to delete.
5.3.90. cinder type-key
usage: cinder type-key <vtype> <action> <key=value> [<key=value> ...]
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.
5.3.91. cinder type-list
usage: cinder type-list
5.3.92. cinder type-update
usage: cinder type-update [--name <name>] [--description <description>] <id>
Positional arguments
- <id>
- ID of the volume type.
Optional arguments
- --name <name>
- Name of the volume type.
- --description <description>
- Description of the volume type.
5.3.93. cinder unmanage
usage: cinder unmanage <volume>
Positional arguments
- <volume>
- Name or ID of the volume to unmanage.
5.3.94. cinder upload-to-image
usage: cinder upload-to-image [--force [<True|False>]] [--container-format <container-format>] [--disk-format <disk-format>] <volume> <image-name>
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.
5.4. Block Storage API v2 commands
--os-volume-api-version
parameter or by setting the corresponding environment variable:
$
export OS_VOLUME_API_VERSION=2
5.4.1. cinder absolute-limits (v2)
usage: cinder --os-volume-api-version 2 absolute-limits
5.4.2. cinder availability-zone-list (v2)
usage: cinder --os-volume-api-version 2 availability-zone-list
5.4.3. cinder backup-create (v2)
usage: cinder --os-volume-api-version 2 backup-create [--container <container>] [--name <name>] [--description <description>] [--incremental] [--force] <volume>
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.
- --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.
5.4.4. cinder backup-delete (v2)
usage: cinder --os-volume-api-version 2 backup-delete <backup>
Positional arguments
- <backup>
- Name or ID of backup to delete.
5.4.5. cinder backup-export (v2)
usage: cinder --os-volume-api-version 2 backup-export <backup>
Positional arguments
- <backup>
- ID of the backup to export.
5.4.6. cinder backup-import (v2)
usage: cinder --os-volume-api-version 2 backup-import <backup_service> <backup_url>
Positional arguments
- <backup_service>
- Backup service to use for importing the backup.
- <backup_url>
- Backup URL for importing the backup metadata.
5.4.7. cinder backup-list (v2)
usage: cinder --os-volume-api-version 2 backup-list [--all-tenants [<all_tenants>]] [--name <name>] [--status <status>] [--volume-id <volume-id>]
Optional arguments
- --all-tenants [<all_tenants>]
- Shows details for all tenants. Admin only.
- --name <name>
- Filters results by a name. Default=None.
- --status <status>
- Filters results by a status. Default=None.
- --volume-id <volume-id>
- Filters results by a volume ID. Default=None.
5.4.8. cinder backup-restore (v2)
usage: cinder --os-volume-api-version 2 backup-restore [--volume <volume>] <backup>
Positional arguments
- <backup>
- ID of backup to restore.
Optional arguments
- --volume <volume>
- Name or ID of volume to which to restore. Default=None.
5.4.9. cinder backup-show (v2)
usage: cinder --os-volume-api-version 2 backup-show <backup>
Positional arguments
- <backup>
- Name or ID of backup.
5.4.10. cinder cgsnapshot-create (v2)
usage: cinder --os-volume-api-version 2 cgsnapshot-create [--name <name>] [--description <description>] <consistencygroup>
Positional arguments
- <consistencygroup>
- Name or ID of a consistency group.
Optional arguments
- --name <name>
- Cgsnapshot name. Default=None.
- --description <description>
- Cgsnapshot description. Default=None.
5.4.11. cinder cgsnapshot-delete (v2)
usage: cinder --os-volume-api-version 2 cgsnapshot-delete <cgsnapshot> [<cgsnapshot> ...]
Positional arguments
- <cgsnapshot>
- Name or ID of one or more cgsnapshots to be deleted.
5.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>]
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.
5.4.13. cinder cgsnapshot-show (v2)
usage: cinder --os-volume-api-version 2 cgsnapshot-show <cgsnapshot>
Positional arguments
- <cgsnapshot>
- Name or ID of cgsnapshot.
5.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>
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.
5.4.15. cinder consisgroup-create-from-src (v2)
usage: cinder --os-volume-api-version 2 consisgroup-create-from-src [--cgsnapshot <cgsnapshot>] [--source-cg <source-cg>] [--name <name>] [--description <description>]
Optional arguments
- --cgsnapshot <cgsnapshot>
- Name or ID of a cgsnapshot. Default=None.
- --source-cg <source-cg>
- Name or ID of a source CG. Default=None.
- --name <name>
- Name of a consistency group. Default=None.
- --description <description>
- Description of a consistency group. Default=None.
5.4.16. cinder consisgroup-delete (v2)
usage: cinder --os-volume-api-version 2 consisgroup-delete [--force] <consistencygroup> [<consistencygroup> ...]
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.
5.4.17. cinder consisgroup-list (v2)
usage: cinder --os-volume-api-version 2 consisgroup-list [--all-tenants [<0|1>]]
Optional arguments
- --all-tenants [<0|1>]
- Shows details for all tenants. Admin only.
5.4.18. cinder consisgroup-show (v2)
usage: cinder --os-volume-api-version 2 consisgroup-show <consistencygroup>
Positional arguments
- <consistencygroup>
- Name or ID of a consistency group.
5.4.19. cinder consisgroup-update (v2)
usage: cinder --os-volume-api-version 2 consisgroup-update [--name <name>] [--description <description>] [--add-volumes <uuid1,uuid2,......>] [--remove-volumes <uuid3,uuid4,......>] <consistencygroup>
Positional arguments
- <consistencygroup>
- Name or ID of a consistency group.
Optional arguments
- --name <name>
- New name for consistency group. Default=None.
- --description <description>
- New description for consistency group. Default=None.
- --add-volumes <uuid1,uuid2,......>
- UUID of one or more volumes to be added to the consistency group, separated by commas. Default=None.
- --remove-volumes <uuid3,uuid4,......>
- UUID of one or more volumes to be removed from the consistency group, separated by commas. Default=None.
5.4.20. 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>] [--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>]
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.
- --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
5.4.21. cinder credentials (v2)
usage: cinder --os-volume-api-version 2 credentials
5.4.22. cinder delete (v2)
usage: cinder --os-volume-api-version 2 delete <volume> [<volume> ...]
Positional arguments
- <volume>
- Name or ID of volume or volumes to delete.
5.4.23. 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>
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."
5.4.24. cinder encryption-type-delete (v2)
usage: cinder --os-volume-api-version 2 encryption-type-delete <volume_type>
Positional arguments
- <volume_type>
- Name or ID of volume type.
5.4.25. cinder encryption-type-list (v2)
usage: cinder --os-volume-api-version 2 encryption-type-list
5.4.26. cinder encryption-type-show (v2)
usage: cinder --os-volume-api-version 2 encryption-type-show <volume_type>
Positional arguments
- <volume_type>
- Name or ID of volume type.
5.4.27. cinder encryption-type-update (v2)
usage: cinder --os-volume-api-version 2 encryption-type-update [--provider <provider>] [--cipher [<cipher>]] [--key-size [<key-size>]] [--control-location <control-location>] <volume-type>
Positional arguments
- <volume-type>
- Name or ID of the volume type
Optional arguments
- --provider <provider>
- Class providing encryption support (e.g. LuksEncryptor) (Optional)
- --cipher [<cipher>]
- Encryption algorithm/mode to use (e.g., aes-xts- plain64). Provide parameter without value to set to provider default. (Optional)
- --key-size [<key-size>]
- Size of the encryption key, in bits (e.g., 128, 256). Provide parameter without value to set to provider default. (Optional)
- --control-location <control-location>
- Notional service where encryption is performed (e.g., front-end=Nova). Values: 'front-end', 'back-end' (Optional)
5.4.28. cinder endpoints (v2)
usage: cinder --os-volume-api-version 2 endpoints
5.4.29. cinder extend (v2)
usage: cinder --os-volume-api-version 2 extend <volume> <new_size>
Positional arguments
- <volume>
- Name or ID of volume to extend.
- <new_size>
- New size of volume, in GBs.
5.4.30. cinder extra-specs-list (v2)
usage: cinder --os-volume-api-version 2 extra-specs-list
5.4.31. cinder force-delete (v2)
usage: cinder --os-volume-api-version 2 force-delete <volume> [<volume> ...]
Positional arguments
- <volume>
- Name or ID of volume or volumes to delete.
5.4.32. cinder get-capabilities (v2)
usage: cinder --os-volume-api-version 2 get-capabilities <host>
Positional arguments
- <host>
- Cinder host to show backend volume stats and properties; takes the form: host@backend-name
5.4.33. cinder get-pools (v2)
usage: cinder --os-volume-api-version 2 get-pools [--detail]
Optional arguments
- --detail
- Show detailed information about pools.
5.4.34. cinder image-metadata (v2)
usage: cinder --os-volume-api-version 2 image-metadata <volume> <action> <key=value> [<key=value> ...]
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.
5.4.35. cinder list (v2)
usage: cinder --os-volume-api-version 2 list [--all-tenants [<0|1>]] [--name <name>] [--status <status>] [--migration_status <migration_status>] [--metadata [<key=value> [<key=value> ...]]] [--marker <marker>] [--limit <limit>] [--sort <key>[:<direction>]] [--tenant [<tenant>]]
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.
- --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).
5.4.36. cinder list-extensions (v2)
usage: cinder --os-volume-api-version 2 list-extensions
5.4.37. cinder manage (v2)
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>
Positional arguments
- <host>
- Cinder host on which the existing volume resides; takes the form: host@backend-name#pool
- <identifier>
- Name or other Identifier for existing volume
Optional arguments
- --id-type <id-type>
- Type of backend device identifier provided, typically source-name or source-id (Default=source-name)
- --name <name>
- Volume name (Default=None)
- --description <description>
- Volume description (Default=None)
- --volume-type <volume-type>
- Volume type (Default=None)
- --availability-zone <availability-zone>
- Availability zone for volume (Default=None)
- --metadata [<key=value> [<key=value> ...]]
- Metadata key=value pairs (Default=None)
- --bootable
- Specifies that the newly created volume should be marked as bootable
5.4.38. cinder metadata (v2)
usage: cinder --os-volume-api-version 2 metadata <volume> <action> <key=value> [<key=value> ...]
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.
5.4.39. cinder metadata-show (v2)
usage: cinder --os-volume-api-version 2 metadata-show <volume>
Positional arguments
- <volume>
- ID of volume.
5.4.40. cinder metadata-update-all (v2)
usage: cinder --os-volume-api-version 2 metadata-update-all <volume> <key=value> [<key=value> ...]
Positional arguments
- <volume>
- ID of volume for which to update metadata.
- <key=value>
- Metadata key and value pair or pairs to update.
5.4.41. cinder migrate (v2)
usage: cinder --os-volume-api-version 2 migrate [--force-host-copy [<True|False>]] [--lock-volume [<True|False>]] <volume> <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.
- --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.
5.4.42. cinder qos-associate (v2)
usage: cinder --os-volume-api-version 2 qos-associate <qos_specs> <volume_type_id>
Positional arguments
- <qos_specs>
- ID of QoS specifications.
- <volume_type_id>
- ID of volume type with which to associate QoS specifications.
5.4.43. cinder qos-create (v2)
usage: cinder --os-volume-api-version 2 qos-create <name> <key=value> [<key=value> ...]
Positional arguments
- <name>
- Name of new QoS specifications.
- <key=value>
- QoS specifications.
5.4.44. cinder qos-delete (v2)
usage: cinder --os-volume-api-version 2 qos-delete [--force [<True|False>]] <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.
5.4.45. cinder qos-disassociate (v2)
usage: cinder --os-volume-api-version 2 qos-disassociate <qos_specs> <volume_type_id>
Positional arguments
- <qos_specs>
- ID of QoS specifications.
- <volume_type_id>
- ID of volume type with which to associate QoS specifications.
5.4.46. cinder qos-disassociate-all (v2)
usage: cinder --os-volume-api-version 2 qos-disassociate-all <qos_specs>
Positional arguments
- <qos_specs>
- ID of QoS specifications on which to operate.
5.4.47. cinder qos-get-association (v2)
usage: cinder --os-volume-api-version 2 qos-get-association <qos_specs>
Positional arguments
- <qos_specs>
- ID of QoS specifications.
5.4.48. cinder qos-key (v2)
usage: cinder --os-volume-api-version 2 qos-key <qos_specs> <action> key=value [key=value ...]
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.
5.4.49. cinder qos-list (v2)
usage: cinder --os-volume-api-version 2 qos-list
5.4.50. cinder qos-show (v2)
usage: cinder --os-volume-api-version 2 qos-show <qos_specs>
Positional arguments
- <qos_specs>
- ID of QoS specifications to show.
5.4.51. cinder quota-class-show (v2)
usage: cinder --os-volume-api-version 2 quota-class-show <class>
Positional arguments
- <class>
- Name of quota class for which to list quotas.
5.4.52. 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>
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.
5.4.53. cinder quota-defaults (v2)
usage: cinder --os-volume-api-version 2 quota-defaults <tenant_id>
Positional arguments
- <tenant_id>
- ID of tenant for which to list quota defaults.
5.4.54. cinder quota-delete (v2)
usage: cinder --os-volume-api-version 2 quota-delete <tenant_id>
Positional arguments
- <tenant_id>
- UUID of tenant to delete the quotas for.
5.4.55. cinder quota-show (v2)
usage: cinder --os-volume-api-version 2 quota-show <tenant_id>
Positional arguments
- <tenant_id>
- ID of tenant for which to list quotas.
5.4.56. cinder quota-update (v2)
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>
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.
- --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.
5.4.57. cinder quota-usage (v2)
usage: cinder --os-volume-api-version 2 quota-usage <tenant_id>
Positional arguments
- <tenant_id>
- ID of tenant for which to list quota usage.
5.4.58. cinder rate-limits (v2)
usage: cinder --os-volume-api-version 2 rate-limits
5.4.59. cinder readonly-mode-update (v2)
usage: cinder --os-volume-api-version 2 readonly-mode-update <volume> <True|true|False|false>
Positional arguments
- <volume>
- ID of volume to update.
- <True|true|False|false>
- Enables or disables update of volume to read-only access mode.
5.4.60. cinder rename (v2)
usage: cinder --os-volume-api-version 2 rename [--description <description>] <volume> [<name>]
Positional arguments
- <volume>
- Name or ID of volume to rename.
- <name>
- New name for volume.
Optional arguments
- --description <description>
- Volume description. Default=None.
5.4.61. cinder replication-promote (v2)
usage: cinder --os-volume-api-version 2 replication-promote <volume>
Positional arguments
- <volume>
- Name or ID of the volume to promote. The volume should have the replica volume created with source-replica argument.
5.4.62. cinder replication-reenable (v2)
usage: cinder --os-volume-api-version 2 replication-reenable <volume>
Positional arguments
- <volume>
- Name or ID of the volume to reenable replication. The replication- status of the volume should be inactive.
5.4.63. cinder reset-state (v2)
usage: cinder --os-volume-api-version 2 reset-state [--state <state>] [--attach-status <attach-status>] [--reset-migration-status] <volume> [<volume> ...]
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", "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.
5.4.64. cinder retype (v2)
usage: cinder --os-volume-api-version 2 retype [--migration-policy <never|on-demand>] <volume> <volume-type>
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.
5.4.65. cinder service-disable (v2)
usage: cinder --os-volume-api-version 2 service-disable [--reason <reason>] <hostname> <binary>
Positional arguments
- <hostname>
- Host name.
- <binary>
- Service binary.
Optional arguments
- --reason <reason>
- Reason for disabling service.
5.4.66. cinder service-enable (v2)
usage: cinder --os-volume-api-version 2 service-enable <hostname> <binary>
Positional arguments
- <hostname>
- Host name.
- <binary>
- Service binary.
5.4.67. cinder service-list (v2)
usage: cinder --os-volume-api-version 2 service-list [--host <hostname>] [--binary <binary>]
Optional arguments
- --host <hostname>
- Host name. Default=None.
- --binary <binary>
- Service binary. Default=None.
5.4.68. cinder set-bootable (v2)
usage: cinder --os-volume-api-version 2 set-bootable <volume> <True|true|False|false>
Positional arguments
- <volume>
- ID of the volume to update.
- <True|true|False|false>
- Flag to indicate whether volume is bootable.
5.4.69. cinder show (v2)
usage: cinder --os-volume-api-version 2 show <volume>
Positional arguments
- <volume>
- Name or ID of volume.
5.4.70. cinder snapshot-create (v2)
usage: cinder --os-volume-api-version 2 snapshot-create [--force [<True|False>]] [--name <name>] [--description <description>] [--metadata [<key=value> [<key=value> ...]]] <volume>
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.
- --metadata [<key=value> [<key=value> ...]]
- Snapshot metadata key and value pairs. Default=None.
5.4.71. cinder snapshot-delete (v2)
usage: cinder --os-volume-api-version 2 snapshot-delete <snapshot> [<snapshot> ...]
Positional arguments
- <snapshot>
- Name or ID of the snapshot(s) to delete.
5.4.72. 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>]
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.
5.4.73. cinder snapshot-metadata (v2)
usage: cinder --os-volume-api-version 2 snapshot-metadata <snapshot> <action> <key=value> [<key=value> ...]
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.
5.4.74. cinder snapshot-metadata-show (v2)
usage: cinder --os-volume-api-version 2 snapshot-metadata-show <snapshot>
Positional arguments
- <snapshot>
- ID of snapshot.
5.4.75. cinder snapshot-metadata-update-all (v2)
usage: cinder --os-volume-api-version 2 snapshot-metadata-update-all <snapshot> <key=value> [<key=value> ...]
Positional arguments
- <snapshot>
- ID of snapshot for which to update metadata.
- <key=value>
- Metadata key and value pair to update.
5.4.76. cinder snapshot-rename (v2)
usage: cinder --os-volume-api-version 2 snapshot-rename [--description <description>] <snapshot> [<name>]
Positional arguments
- <snapshot>
- Name or ID of snapshot.
- <name>
- New name for snapshot.
Optional arguments
- --description <description>
- Snapshot description. Default=None.
5.4.77. cinder snapshot-reset-state (v2)
usage: cinder --os-volume-api-version 2 snapshot-reset-state [--state <state>] <snapshot> [<snapshot> ...]
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". 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.
5.4.78. cinder snapshot-show (v2)
usage: cinder --os-volume-api-version 2 snapshot-show <snapshot>
Positional arguments
- <snapshot>
- Name or ID of snapshot.
5.4.79. cinder transfer-accept (v2)
usage: cinder --os-volume-api-version 2 transfer-accept <transfer> <auth_key>
Positional arguments
- <transfer>
- ID of transfer to accept.
- <auth_key>
- Authentication key of transfer to accept.
5.4.80. cinder transfer-create (v2)
usage: cinder --os-volume-api-version 2 transfer-create [--name <name>] <volume>
Positional arguments
- <volume>
- Name or ID of volume to transfer.
Optional arguments
- --name <name>
- Transfer name. Default=None.
5.4.81. cinder transfer-delete (v2)
usage: cinder --os-volume-api-version 2 transfer-delete <transfer>
Positional arguments
- <transfer>
- Name or ID of transfer to delete.
5.4.82. cinder transfer-list (v2)
usage: cinder --os-volume-api-version 2 transfer-list [--all-tenants [<0|1>]]
Optional arguments
- --all-tenants [<0|1>]
- Shows details for all tenants. Admin only.
5.4.83. cinder transfer-show (v2)
usage: cinder --os-volume-api-version 2 transfer-show <transfer>
Positional arguments
- <transfer>
- Name or ID of transfer to accept.
5.4.84. cinder type-access-add (v2)
usage: cinder --os-volume-api-version 2 type-access-add --volume-type <volume_type> --project-id <project_id>
Optional arguments
- --volume-type <volume_type>
- Volume type name or ID to add access for the given project.
- --project-id <project_id>
- Project ID to add volume type access for.
5.4.85. cinder type-access-list (v2)
usage: cinder --os-volume-api-version 2 type-access-list --volume-type <volume_type>
Optional arguments
- --volume-type <volume_type>
- Filter results by volume type name or ID.
5.4.86. cinder type-access-remove (v2)
usage: cinder --os-volume-api-version 2 type-access-remove --volume-type <volume_type> --project-id <project_id>
Optional arguments
- --volume-type <volume_type>
- Volume type name or ID to remove access for the given project.
- --project-id <project_id>
- Project ID to remove volume type access for.
5.4.87. cinder type-create (v2)
usage: cinder --os-volume-api-version 2 type-create [--description <description>] [--is-public <is-public>] <name>
Positional arguments
- <name>
- Name of new volume type.
Optional arguments
- --description <description>
- Description of new volume type.
- --is-public <is-public>
- Make type accessible to the public (default true).
5.4.88. cinder type-default (v2)
usage: cinder --os-volume-api-version 2 type-default
5.4.89. cinder type-delete (v2)
usage: cinder --os-volume-api-version 2 type-delete <id>
Positional arguments
- <id>
- ID of volume type to delete.
5.4.90. cinder type-key (v2)
usage: cinder --os-volume-api-version 2 type-key <vtype> <action> <key=value> [<key=value> ...]
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.
5.4.91. cinder type-list (v2)
usage: cinder --os-volume-api-version 2 type-list
5.4.92. cinder type-update (v2)
usage: cinder --os-volume-api-version 2 type-update [--name <name>] [--description <description>] <id>
Positional arguments
- <id>
- ID of the volume type.
Optional arguments
- --name <name>
- Name of the volume type.
- --description <description>
- Description of the volume type.
5.4.93. cinder unmanage (v2)
usage: cinder --os-volume-api-version 2 unmanage <volume>
Positional arguments
- <volume>
- Name or ID of the volume to unmanage.
5.4.94. 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>
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.