- cinder usage
- cinder optional arguments
- cinder absolute-limits command
- cinder availability-zone-list command
- cinder backup-create command
- cinder backup-delete command
- cinder backup-list command
- cinder backup-restore command
- cinder backup-show command
- cinder create command
- cinder credentials command
- cinder delete command
- cinder encryption-type-create command
- cinder encryption-type-list command
- cinder encryption-type-show command
- cinder endpoints command
- cinder extend command
- cinder extra-specs-list command
- cinder force-delete command
- cinder list command
- cinder list-extensions command
- cinder metadata command
- cinder metadata-show command
- cinder metadata-update-all command
- cinder migrate command
- cinder qos-associate command
- cinder qos-create command
- cinder qos-delete command
- cinder qos-disassociate command
- cinder qos-disassociate-all command
- cinder qos-get-association command
- cinder qos-key command
- cinder qos-list command
- cinder qos-show command
- cinder quota-class-show command
- cinder quota-class-update command
- cinder quota-defaults command
- cinder quota-show command
- cinder quota-update command
- cinder quota-usage command
- cinder rate-limits command
- cinder readonly-mode-update command
- cinder rename command
- cinder reset-state command
- cinder service-disable command
- cinder service-enable command
- cinder service-list command
- cinder show command
- cinder snapshot-create command
- cinder snapshot-delete command
- cinder snapshot-list command
- cinder snapshot-metadata command
- cinder snapshot-metadata-show command
- cinder snapshot-metadata-update-all command
- cinder snapshot-rename command
- cinder snapshot-reset-state command
- cinder snapshot-show command
- cinder transfer-accept command
- cinder transfer-create command
- cinder transfer-delete command
- cinder transfer-list command
- cinder transfer-show command
- cinder type-create command
- cinder type-delete command
- cinder type-key command
- cinder type-list command
- cinder upload-to-image command
The cinder client is the command-line interface (CLI) for the OpenStack Block Storage API and its extensions.
For help on a specific cinder command, enter:
$ cinder help COMMAND
[--os-password <auth-password>] [--os-tenant-name <auth-tenant-name>] [--os-tenant-id <auth-tenant-id>] [--os-auth-url <auth-url>] [--os-region-name <region-name>] [--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>] [--os-cacert <ca-certificate>] [--retries <retries>] <subcommand> ...
Subcommands
- absolute-limits
Print a list of absolute limits for a user
- availability-zone-list
List all the availability zones.
- backup-create
Creates a backup.
- backup-delete
Remove a backup.
- backup-list
List all the backups.
- backup-restore
Restore a backup.
- backup-show
Show details about a backup.
- create
Add a new volume.
- credentials
Show user credentials returned from auth.
- delete
Remove volume(s).
- encryption-type-create
Create a new encryption type for a volume type (Admin Only).
- encryption-type-list
List encryption type information for all volume types (Admin Only).
- encryption-type-show
Show the encryption type information for a volume type (Admin Only).
- endpoints
Discover endpoints that get returned from the authenticate services.
- extend
Attempt to extend the size of an existing volume.
- extra-specs-list
Print a list of current 'volume types and extra specs' (Admin Only).
- force-delete
Attempt forced removal of volume(s), regardless of the state(s).
- list
List all the volumes.
- metadata
Set or Delete metadata on a volume.
- metadata-show
Show metadata of given volume.
- metadata-update-all
Update all metadata of a volume.
- migrate
Migrate the volume to the new host.
- qos-associate
Associate qos specs with specific volume type.
- qos-create
Create a new qos specs.
- qos-delete
Delete a specific qos specs.
- qos-disassociate
Disassociate qos specs from specific volume type.
- qos-disassociate-all
Disassociate qos specs from all of its associations.
- qos-get-association
Get all associations of specific qos specs.
- qos-key
Set or unset specifications for a qos spec.
- qos-list
Get full list of qos specs.
- qos-show
Get a specific qos specs.
- quota-class-show
List the quotas for a quota class.
- quota-class-update
Update the quotas for a quota class.
- quota-defaults
List the default quotas for a tenant.
- quota-show
List the quotas for a tenant.
- quota-update
Update the quotas for a tenant.
- quota-usage
List the quota usage for a tenant.
- rate-limits
Print a list of rate limits for a user
- readonly-mode-update
Update volume read-only access mode read_only.
- rename
Rename a volume.
- reset-state
Explicitly update the state of a volume.
- service-disable
Disable the service.
- service-enable
Enable the service.
- service-list
List all the services. Filter by host & service binary.
- show
Show details about a volume.
- snapshot-create
Add a new snapshot.
- snapshot-delete
Remove a snapshot.
- snapshot-list
List all the snapshots.
- snapshot-metadata
Set or Delete metadata of a snapshot.
- snapshot-metadata-show
Show metadata of given snapshot.
- snapshot-metadata-update-all
Update all metadata of a snapshot.
- snapshot-rename
Rename a snapshot.
- snapshot-reset-state
Explicitly update the state of a snapshot.
- snapshot-show
Show details about a snapshot.
- transfer-accept
Accepts a volume transfer.
- transfer-create
Creates a volume transfer.
- transfer-delete
Undo a transfer.
- transfer-list
List all the transfers.
- transfer-show
Show details about a transfer.
- type-create
Create a new volume type.
- type-delete
Delete a specific volume type.
- type-key
Set or unset extra_spec for a volume type.
- type-list
Print a list of available 'volume types'.
- upload-to-image
Upload volume to image service as image.
- bash-completion
Print arguments for bash_completion.
- help
Display help about this program or one of its subcommands.
- list-extensions
List all the os-api extensions that are available.
- --version
show program's version number and exit
- --debug
Print debugging output
- --os-username <auth-user-name>
Defaults to
env[OS_USERNAME]
.- --os-password <auth-password>
Defaults to
env[OS_PASSWORD]
.- --os-tenant-name <auth-tenant-name>
Defaults to
env[OS_TENANT_NAME]
.- --os-tenant-id <auth-tenant-id>
Defaults to
env[OS_TENANT_ID]
.- --os-auth-url <auth-url>
Defaults to
env[OS_AUTH_URL]
.- --os-region-name <region-name>
Defaults to
env[OS_REGION_NAME]
.- --service-type <service-type>
Defaults to volume for most actions
- --service-name <service-name>
Defaults to
env[CINDER_SERVICE_NAME]
- --volume-service-name <volume-service-name>
Defaults to
env[CINDER_VOLUME_SERVICE_NAME]
- --endpoint-type <endpoint-type>
Defaults to
env[CINDER_ENDPOINT_TYPE]
or publicURL.- --os-volume-api-version <volume-api-ver>
Accepts 1 or 2,defaults to
env[OS_VOLUME_API_VERSION]
.- --os-cacert <ca-certificate>
Specify a CA bundle file to use in verifying a TLS (https) server certificate. Defaults to
env[OS_CACERT]
- --retries <retries>
Number of retries.
usage: cinder absolute-limits
Print a list of absolute limits for a user
usage: cinder availability-zone-list
List all the availability zones.
usage: cinder backup-create [--container <container>] [--display-name <display-name>] [--display-description <display-description>] <volume>
Creates a backup.
Positional arguments
- <volume>
Name or ID of the volume to backup.
Optional arguments
- --container <container>
Optional Backup container name. (Default=None)
- --display-name <display-name>
Optional backup name. (Default=None)
- --display-description <display-description>
Optional backup description. (Default=None)
usage: cinder backup-delete <backup>
Remove a backup.
Positional arguments
- <backup>
Name or ID of the backup to delete.
usage: cinder backup-restore [--volume-id <volume>] <backup>
Restore a backup.
Positional arguments
- <backup>
ID of the backup to restore.
Optional arguments
- --volume-id <volume>
Optional ID(or name) of the volume to restore to.
usage: cinder backup-show <backup>
Show details about a backup.
Positional arguments
- <backup>
Name or ID of the backup.
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>
Add a new volume.
Positional arguments
- <size>
Size of volume in GB
Optional arguments
- --snapshot-id <snapshot-id>
Create volume from snapshot id (Optional, Default=None)
- --source-volid <source-volid>
Create volume from volume id (Optional, Default=None)
- --image-id <image-id>
Create volume from image id (Optional, Default=None)
- --display-name <display-name>
Volume name (Optional, Default=None)
- --display-description <display-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)
usage: cinder delete <volume> [<volume> ...]
Remove volume(s).
Positional arguments
- <volume>
Name or ID of the volume(s) to delete.
usage: cinder encryption-type-create [--cipher <cipher>] [--key_size <key_size>] [--control_location <control_location>] <volume_type> <provider>
Create a new encryption type for a volume type (Admin Only).
Positional arguments
- <volume_type>
Name or ID of the volume type
- <provider>
Class providing encryption support (e.g. LuksEncryptor)
Optional arguments
- --cipher <cipher>
Encryption algorithm/mode to use (e.g., aes-xts- plain64) (Optional, Default=None)
- --key_size <key_size>
Size of the encryption key, in bits (e.g., 128, 256) (Optional, Default=None)
- --control_location <control_location>
Notional service where encryption is performed (e.g., front-end=Nova). Values: 'front-end', 'back-end' (Optional, Default=None)
usage: cinder encryption-type-list
List encryption type information for all volume types (Admin Only).
usage: cinder encryption-type-show <volume_type>
Show the encryption type information for a volume type (Admin Only).
Positional arguments
- <volume_type>
Name or ID of the volume type
usage: cinder endpoints
Discover endpoints that get returned from the authenticate services.
usage: cinder extend <volume> <new-size>
Attempt to extend the size of an existing volume.
Positional arguments
- <volume>
Name or ID of the volume to extend.
- <new-size>
New size of volume in GB
usage: cinder extra-specs-list
Print a list of current 'volume types and extra specs' (Admin Only).
usage: cinder force-delete <volume> [<volume> ...]
Attempt forced removal of volume(s), regardless of the state(s).
Positional arguments
- <volume>
Name or ID of the volume(s) to delete.
usage: cinder list [--all-tenants [<0|1>]] [--display-name <display-name>] [--status <status>] [--metadata [<key=value> [<key=value> ...]]]
List all the volumes.
Optional arguments
- --all-tenants [<0|1>]
Display information from all tenants (Admin only).
- --display-name <display-name>
Filter results by display-name
- --status <status>
Filter results by status
- --metadata [<key=value> [<key=value>
...]] Filter results by metadata
usage: cinder list-extensions
List all the os-api extensions that are available.
usage: cinder metadata <volume> <action> <key=value> [<key=value> ...]
Set or Delete metadata on a volume.
Positional arguments
- <volume>
Name or ID of the volume to update metadata on.
- <action>
Actions: 'set' or 'unset'
- <key=value>
Metadata to set/unset (only key is necessary on unset)
usage: cinder metadata-show <volume>
Show metadata of given volume.
Positional arguments
- <volume>
ID of volume
usage: cinder metadata-update-all <volume> <key=value> [<key=value> ...]
Update all metadata of a volume.
Positional arguments
- <volume>
ID of the volume to update metadata on.
- <key=value>
Metadata entry/entries to update.
usage: cinder migrate [--force-host-copy <True|False>] <volume> <host>
Migrate the volume to the new host.
Positional arguments
- <volume>
ID of the volume to migrate
- <host>
Destination host
Optional arguments
- --force-host-copy <True|False>
Optional flag to force the use of the generic host- based migration mechanism, bypassing driver optimizations (Default=False).
usage: cinder qos-associate <qos_specs> <volume_type_id>
Associate qos specs with specific volume type.
Positional arguments
- <qos_specs>
ID of qos_specs.
- <volume_type_id>
ID of volume type to be associated with.
usage: cinder qos-create <name> <key=value> [<key=value> ...]
Create a new qos specs.
Positional arguments
- <name>
Name of the new QoS specs
- <key=value>
Specifications for QoS
usage: cinder qos-delete [--force <True|False>] <qos_specs>
Delete a specific qos specs.
Positional arguments
- <qos_specs>
ID of the qos_specs to delete.
Optional arguments
- --force <True|False>
Optional flag that indicates whether to delete specified qos specs even if it is in-use.
usage: cinder qos-disassociate <qos_specs> <volume_type_id>
Disassociate qos specs from specific volume type.
Positional arguments
- <qos_specs>
ID of qos_specs.
- <volume_type_id>
ID of volume type to be associated with.
usage: cinder qos-disassociate-all <qos_specs>
Disassociate qos specs from all of its associations.
Positional arguments
- <qos_specs>
ID of qos_specs to be operate on.
usage: cinder qos-get-association <qos_specs>
Get all associations of specific qos specs.
Positional arguments
- <qos_specs>
ID of the qos_specs.
usage: cinder qos-key <qos_specs> <action> key=value [key=value ...]
Set or unset specifications for a qos spec.
Positional arguments
- <qos_specs>
ID of qos specs
- <action>
Actions: 'set' or 'unset'
- key=value
QoS specs to set/unset (only key is necessary on unset)
usage: cinder qos-show <qos_specs>
Get a specific qos specs.
Positional arguments
- <qos_specs>
ID of the qos_specs to show.
usage: cinder quota-class-show <class>
List the quotas for a quota class.
Positional arguments
- <class>
Name of quota class to list the quotas for.
usage: cinder quota-class-update [--volumes <volumes>] [--snapshots <snapshots>] [--gigabytes <gigabytes>] [--volume-type <volume_type_name>] <class>
Update the quotas for a quota class.
Positional arguments
- <class>
Name of quota class to set the quotas for.
Optional arguments
- --volumes <volumes>
New value for the "volumes" quota.
- --snapshots <snapshots>
New value for the "snapshots" quota.
- --gigabytes <gigabytes>
New value for the "gigabytes" quota.
- --volume-type <volume_type_name>
Volume type (Optional, Default=None)
usage: cinder quota-defaults <tenant_id>
List the default quotas for a tenant.
Positional arguments
- <tenant_id>
UUID of tenant to list the default quotas for.
usage: cinder quota-show <tenant_id>
List the quotas for a tenant.
Positional arguments
- <tenant_id>
UUID of tenant to list the quotas for.
usage: cinder quota-update [--volumes <volumes>] [--snapshots <snapshots>] [--gigabytes <gigabytes>] [--volume-type <volume_type_name>] <tenant_id>
Update the quotas for a tenant.
Positional arguments
- <tenant_id>
UUID of tenant to set the quotas for.
Optional arguments
- --volumes <volumes>
New value for the "volumes" quota.
- --snapshots <snapshots>
New value for the "snapshots" quota.
- --gigabytes <gigabytes>
New value for the "gigabytes" quota.
- --volume-type <volume_type_name>
Volume type (Optional, Default=None)
usage: cinder quota-usage <tenant_id>
List the quota usage for a tenant.
Positional arguments
- <tenant_id>
UUID of tenant to list the quota usage for.
usage: cinder readonly-mode-update <volume> <True|true|False|false>
Update volume read-only access mode read_only.
Positional arguments
- <volume>
ID of the volume to update.
- <True|true|False|false>
Flag to indicate whether to update volume to read-only access mode.
usage: cinder rename [--display-description <display-description>] <volume> [<display-name>]
Rename a volume.
Positional arguments
- <volume>
Name or ID of the volume to rename.
- <display-name>
New display-name for the volume.
Optional arguments
- --display-description <display-description>
Optional volume description. (Default=None)
usage: cinder reset-state [--state <state>] <volume> [<volume> ...]
Explicitly update the state of a volume.
Positional arguments
- <volume>
Name or ID of the volume to modify.
Optional arguments
- --state <state>
Indicate which state to assign the volume. Options include available, error, creating, deleting, error_deleting. If no state is provided, available will be used.
usage: cinder service-disable <hostname> <binary>
Disable the service.
Positional arguments
- <hostname>
Name of host.
- <binary>
Service binary.
usage: cinder service-enable <hostname> <binary>
Enable the service.
Positional arguments
- <hostname>
Name of host.
- <binary>
Service binary.
usage: cinder service-list [--host <hostname>] [--binary <binary>]
List all the services. Filter by host & service binary.
Optional arguments
- --host <hostname>
Name of host.
- --binary <binary>
Service binary.
usage: cinder show <volume>
Show details about a volume.
Positional arguments
- <volume>
Name or ID of the volume.
usage: cinder snapshot-create [--force <True|False>] [--display-name <display-name>] [--display-description <display-description>] <volume>
Add a new snapshot.
Positional arguments
- <volume>
Name or ID of the volume to snapshot
Optional arguments
- --force <True|False>
Optional flag to indicate whether to snapshot a volume even if it's attached to an instance. (Default=False)
- --display-name <display-name>
Optional snapshot name. (Default=None)
- --display-description <display-description>
Optional snapshot description. (Default=None)
usage: cinder snapshot-delete <snapshot>
Remove a snapshot.
Positional arguments
- <snapshot>
Name or ID of the snapshot to delete.
usage: cinder snapshot-list [--all-tenants [<0|1>]] [--display-name <display-name>] [--status <status>] [--volume-id <volume-id>]
List all the snapshots.
Optional arguments
- --all-tenants [<0|1>]
Display information from all tenants (Admin only).
- --display-name <display-name>
Filter results by display-name
- --status <status>
Filter results by status
- --volume-id <volume-id>
Filter results by volume-id
usage: cinder snapshot-metadata <snapshot> <action> <key=value> [<key=value> ...]
Set or Delete metadata of a snapshot.
Positional arguments
- <snapshot>
ID of the snapshot to update metadata on.
- <action>
Actions: 'set' or 'unset'
- <key=value>
Metadata to set/unset (only key is necessary on unset)
usage: cinder snapshot-metadata-show <snapshot>
Show metadata of given snapshot.
Positional arguments
- <snapshot>
ID of snapshot
usage: cinder snapshot-metadata-update-all <snapshot> <key=value> [<key=value> ...]
Update all metadata of a snapshot.
Positional arguments
- <snapshot>
ID of the snapshot to update metadata on.
- <key=value>
Metadata entry/entries to update.
usage: cinder snapshot-rename [--display-description <display-description>] <snapshot> [<display-name>]
Rename a snapshot.
Positional arguments
- <snapshot>
Name or ID of the snapshot.
- <display-name>
New display-name for the snapshot.
Optional arguments
- --display-description <display-description>
Optional snapshot description. (Default=None)
usage: cinder snapshot-reset-state [--state <state>] <snapshot> [<snapshot> ...]
Explicitly update the state of a snapshot.
Positional arguments
- <snapshot>
Name or ID of the snapshot to modify.
Optional arguments
- --state <state>
Indicate which state to assign the snapshot. Options include available, error, creating, deleting, error_deleting. If no state is provided, available will be used.
usage: cinder snapshot-show <snapshot>
Show details about a snapshot.
Positional arguments
- <snapshot>
Name or ID of the snapshot.
usage: cinder transfer-accept <transfer> <auth_key>
Accepts a volume transfer.
Positional arguments
- <transfer>
ID of the transfer to accept.
- <auth_key>
Auth key of the transfer to accept.
usage: cinder transfer-create [--display-name <display-name>] <volume>
Creates a volume transfer.
Positional arguments
- <volume>
Name or ID of the volume to transfer.
Optional arguments
- --display-name <display-name>
Optional transfer name. (Default=None)
usage: cinder transfer-delete <transfer>
Undo a transfer.
Positional arguments
- <transfer>
Name or ID of the transfer to delete.
usage: cinder transfer-show <transfer>
Show details about a transfer.
Positional arguments
- <transfer>
Name or ID of the transfer to accept.
usage: cinder type-create <name>
Create a new volume type.
Positional arguments
- <name>
Name of the new volume type
usage: cinder type-delete <id>
Delete a specific volume type.
Positional arguments
- <id>
Unique ID of the volume type to delete
usage: cinder type-key <vtype> <action> [<key=value> [<key=value> ...]]
Set or unset extra_spec for a volume type.
Positional arguments
- <vtype>
Name or ID of the volume type
- <action>
Actions: 'set' or 'unset'
- <key=value>
Extra_specs to set/unset (only key is necessary on unset)
usage: cinder upload-to-image [--force <True|False>] [--container-format <container-format>] [--disk-format <disk-format>] <volume> <image-name>
Upload volume to image service as image.
Positional arguments
- <volume>
Name or ID of the volume to upload to an image
- <image-name>
Name for created image
Optional arguments
- --force <True|False>
Optional flag to indicate whether to upload a volume even if it's attached to an instance. (Default=False)
- --container-format <container-format>
Optional type for container format (Default=bare)
- --disk-format <disk-format>
Optional type for disk format (Default=raw)