The cinder client is the command-line interface (CLI) for the Block Storage service API and its extensions.
This chapter documents cinder version 1.6.0.
For help on a specific cinder command, enter:
$ cinder help COMMAND
usage: cinder [--version] [-d] [--os-auth-system <auth-system>]
[--service-type <service-type>] [--service-name <service-name>]
[--volume-service-name <volume-service-name>]
[--os-endpoint-type <os-endpoint-type>]
[--endpoint-type <endpoint-type>]
[--os-volume-api-version <volume-api-ver>]
[--bypass-url <bypass-url>] [--retries <retries>]
[--os-auth-strategy <auth-strategy>]
[--os-username <auth-user-name>] [--os-password <auth-password>]
[--os-tenant-name <auth-tenant-name>]
[--os-tenant-id <auth-tenant-id>] [--os-auth-url <auth-url>]
[--os-user-id <auth-user-id>]
[--os-user-domain-id <auth-user-domain-id>]
[--os-user-domain-name <auth-user-domain-name>]
[--os-project-id <auth-project-id>]
[--os-project-name <auth-project-name>]
[--os-project-domain-id <auth-project-domain-id>]
[--os-project-domain-name <auth-project-domain-name>]
[--os-region-name <region-name>] [--os-token <token>]
[--os-url <url>] [--insecure] [--os-cacert <ca-certificate>]
[--os-cert <certificate>] [--os-key <key>] [--timeout <seconds>]
<subcommand> ...
Subcommands:
failover-host
freeze-host
thaw-host
You can select an API version to use by adding the --os-volume-api-version parameter or by setting the corresponding environment variable:
export OS_VOLUME_API_VERSION=2
usage: cinder --os-volume-api-version 2 absolute-limits
Lists absolute limits for a user.
usage: cinder --os-volume-api-version 2 availability-zone-list
Lists all availability zones.
usage: cinder --os-volume-api-version 2 backup-create [--container <container>] [--name <name>]
[--description <description>] [--incremental]
[--force] [--snapshot-id <snapshot-id>]
<volume>
Creates a volume backup.
Positional arguments:
Optional arguments:
usage: cinder --os-volume-api-version 2 backup-delete <backup> [<backup> ...]
Removes one or more backups.
Positional arguments:
usage: cinder --os-volume-api-version 2 backup-export <backup>
Export backup metadata record.
Positional arguments:
usage: cinder --os-volume-api-version 2 backup-import <backup_service> <backup_url>
Import backup metadata record.
Positional arguments:
usage: cinder --os-volume-api-version 2 backup-list [--all-tenants [<all_tenants>]] [--name <name>]
[--status <status>] [--volume-id <volume-id>]
[--marker <marker>] [--limit <limit>]
[--sort <key>[:<direction>]]
Lists all backups.
Optional arguments:
usage: cinder --os-volume-api-version 2 backup-reset-state [--state <state>] <backup> [<backup> ...]
Explicitly updates the backup state.
Positional arguments:
Optional arguments:
usage: cinder --os-volume-api-version 2 backup-restore [--volume <volume>] <backup>
Restores a backup.
Positional arguments:
Optional arguments:
usage: cinder --os-volume-api-version 2 backup-show <backup>
Shows backup details.
Positional arguments:
usage: cinder --os-volume-api-version 2 cgsnapshot-create [--name <name>] [--description <description>]
<consistencygroup>
Creates a cgsnapshot.
Positional arguments:
Optional arguments:
usage: cinder --os-volume-api-version 2 cgsnapshot-delete <cgsnapshot> [<cgsnapshot> ...]
Removes one or more cgsnapshots.
Positional arguments:
usage: cinder --os-volume-api-version 2 cgsnapshot-list [--all-tenants [<0|1>]] [--status <status>]
[--consistencygroup-id <consistencygroup_id>]
Lists all cgsnapshots.
Optional arguments:
usage: cinder --os-volume-api-version 2 cgsnapshot-show <cgsnapshot>
Shows cgsnapshot details.
Positional arguments:
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:
Optional arguments:
usage: cinder --os-volume-api-version 2 consisgroup-create-from-src [--cgsnapshot <cgsnapshot>]
[--source-cg <source-cg>]
[--name <name>]
[--description <description>]
Creates a consistency group from a cgsnapshot or a source CG.
Optional arguments:
usage: cinder --os-volume-api-version 2 consisgroup-delete [--force]
<consistencygroup> [<consistencygroup> ...]
Removes one or more consistency groups.
Positional arguments:
Optional arguments:
usage: cinder --os-volume-api-version 2 consisgroup-list [--all-tenants [<0|1>]]
Lists all consistencygroups.
Optional arguments:
usage: cinder --os-volume-api-version 2 consisgroup-show <consistencygroup>
Shows details of a consistency group.
Positional arguments:
usage: cinder --os-volume-api-version 2 consisgroup-update [--name <name>] [--description <description>]
[--add-volumes <uuid1,uuid2,......>]
[--remove-volumes <uuid3,uuid4,......>]
<consistencygroup>
Updates a consistencygroup.
Positional arguments:
Optional arguments:
usage: cinder --os-volume-api-version 2 create [--consisgroup-id <consistencygroup-id>]
[--snapshot-id <snapshot-id>]
[--source-volid <source-volid>]
[--source-replica <source-replica>]
[--image-id <image-id>] [--image <image>] [--name <name>]
[--description <description>]
[--volume-type <volume-type>]
[--availability-zone <availability-zone>]
[--metadata [<key=value> [<key=value> ...]]]
[--hint <key=value>] [--allow-multiattach]
[<size>]
Creates a volume.
Positional arguments:
Optional arguments:
usage: cinder --os-volume-api-version 2 credentials
Shows user credentials returned from auth.
usage: cinder --os-volume-api-version 2 delete <volume> [<volume> ...]
Removes one or more volumes.
Positional arguments:
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:
Optional arguments:
usage: cinder --os-volume-api-version 2 encryption-type-delete <volume_type>
Deletes encryption type for a volume type. Admin only.
Positional arguments:
usage: cinder --os-volume-api-version 2 encryption-type-list
Shows encryption type details for volume types. Admin only.
usage: cinder --os-volume-api-version 2 encryption-type-show <volume_type>
Shows encryption type details for a volume type. Admin only.
Positional arguments:
usage: cinder --os-volume-api-version 2 encryption-type-update [--provider <provider>]
[--cipher [<cipher>]]
[--key-size [<key-size>]]
[--control-location <control-location>]
<volume-type>
Update encryption type information for a volume type (Admin Only).
Positional arguments:
Optional arguments:
usage: cinder --os-volume-api-version 2 endpoints
Discovers endpoints registered by authentication service.
usage: cinder --os-volume-api-version 2 extend <volume> <new_size>
Attempts to extend size of an existing volume.
Positional arguments:
usage: cinder --os-volume-api-version 2 extra-specs-list
Lists current volume types and extra specs.
usage: cinder --os-volume-api-version 2 failover-host [--backend_id <backend-id>] <hostname>
Positional arguments:
Optional arguments:
usage: cinder --os-volume-api-version 2 force-delete <volume> [<volume> ...]
Attempts force-delete of volume, regardless of state.
Positional arguments:
usage: cinder --os-volume-api-version 2 freeze-host <hostname>
Positional arguments:
usage: cinder --os-volume-api-version 2 get-capabilities <host>
Show backend volume stats and properties. Admin only.
Positional arguments:
usage: cinder --os-volume-api-version 2 get-pools [--detail]
Show pool information for backends. Admin only.
Optional arguments:
usage: cinder --os-volume-api-version 2 image-metadata <volume> <action> <key=value> [<key=value> ...]
Sets or deletes volume image metadata.
Positional arguments:
usage: cinder --os-volume-api-version 2 image-metadata-show <volume>
Shows volume image metadata.
Positional arguments:
usage: cinder --os-volume-api-version 2 list [--all-tenants [<0|1>]] [--name <name>] [--status <status>]
[--bootable [<True|true|False|false>]]
[--migration_status <migration_status>]
[--metadata [<key=value> [<key=value> ...]]]
[--marker <marker>] [--limit <limit>] [--fields <fields>]
[--sort <key>[:<direction>]] [--tenant [<tenant>]]
Lists all volumes.
Optional arguments:
usage: cinder --os-volume-api-version 2 list-extensions
Lists all available os-api extensions.
usage: cinder --os-volume-api-version 2 manage [--id-type <id-type>] [--name <name>]
[--description <description>]
[--volume-type <volume-type>]
[--availability-zone <availability-zone>]
[--metadata [<key=value> [<key=value> ...]]] [--bootable]
<host> <identifier>
Manage an existing volume.
Positional arguments:
Optional arguments:
usage: cinder --os-volume-api-version 2 metadata <volume> <action> <key=value> [<key=value> ...]
Sets or deletes volume metadata.
Positional arguments:
usage: cinder --os-volume-api-version 2 metadata-show <volume>
Shows volume metadata.
Positional arguments:
usage: cinder --os-volume-api-version 2 metadata-update-all <volume> <key=value> [<key=value> ...]
Updates volume metadata.
Positional arguments:
usage: cinder --os-volume-api-version 2 migrate [--force-host-copy [<True|False>]]
[--lock-volume [<True|False>]]
<volume> <host>
Migrates volume to a new host.
Positional arguments:
Optional arguments:
usage: cinder --os-volume-api-version 2 qos-associate <qos_specs> <volume_type_id>
Associates qos specs with specified volume type.
Positional arguments:
usage: cinder --os-volume-api-version 2 qos-create <name> <key=value> [<key=value> ...]
Creates a qos specs.
Positional arguments:
usage: cinder --os-volume-api-version 2 qos-delete [--force [<True|False>]] <qos_specs>
Deletes a specified qos specs.
Positional arguments:
Optional arguments:
usage: cinder --os-volume-api-version 2 qos-disassociate <qos_specs> <volume_type_id>
Disassociates qos specs from specified volume type.
Positional arguments:
usage: cinder --os-volume-api-version 2 qos-disassociate-all <qos_specs>
Disassociates qos specs from all its associations.
Positional arguments:
usage: cinder --os-volume-api-version 2 qos-get-association <qos_specs>
Lists all associations for specified qos specs.
Positional arguments:
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:
usage: cinder --os-volume-api-version 2 qos-show <qos_specs>
Shows qos specs details.
Positional arguments:
usage: cinder --os-volume-api-version 2 quota-class-show <class>
Lists quotas for a quota class.
Positional arguments:
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:
Optional arguments:
usage: cinder --os-volume-api-version 2 quota-defaults <tenant_id>
Lists default quotas for a tenant.
Positional arguments:
usage: cinder --os-volume-api-version 2 quota-delete <tenant_id>
Delete the quotas for a tenant.
Positional arguments:
usage: cinder --os-volume-api-version 2 quota-show <tenant_id>
Lists quotas for a tenant.
Positional arguments:
usage: cinder --os-volume-api-version 2 quota-update [--volumes <volumes>] [--snapshots <snapshots>]
[--gigabytes <gigabytes>] [--backups <backups>]
[--backup-gigabytes <backup_gigabytes>]
[--consistencygroups <consistencygroups>]
[--volume-type <volume_type_name>]
[--per-volume-gigabytes <per_volume_gigabytes>]
<tenant_id>
Updates quotas for a tenant.
Positional arguments:
Optional arguments:
usage: cinder --os-volume-api-version 2 quota-usage <tenant_id>
Lists quota usage for a tenant.
Positional arguments:
usage: cinder --os-volume-api-version 2 rate-limits
Lists rate limits for a user.
usage: cinder --os-volume-api-version 2 readonly-mode-update <volume> <True|true|False|false>
Updates volume read-only access-mode flag.
Positional arguments:
usage: cinder --os-volume-api-version 2 rename [--description <description>] <volume> [<name>]
Renames a volume.
Positional arguments:
Optional arguments:
usage: cinder --os-volume-api-version 2 replication-promote <volume>
Promote a secondary volume to primary for a relationship.
Positional arguments:
usage: cinder --os-volume-api-version 2 replication-reenable <volume>
Sync the secondary volume with primary for a relationship.
Positional arguments:
usage: cinder --os-volume-api-version 2 reset-state [--state <state>] [--attach-status <attach-status>]
[--reset-migration-status]
<volume> [<volume> ...]
Explicitly updates the volume state in the Cinder database. Note that this does not affect whether the volume is actually attached to the Nova compute host or instance and can result in an unusable volume. Being a database change only, this has no impact on the true state of the volume and may not match the actual state. This can render a volume unusable in the case of change to the ‘available’ state.
Positional arguments:
Optional arguments:
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:
Optional arguments:
usage: cinder --os-volume-api-version 2 service-disable [--reason <reason>] <hostname> <binary>
Disables the service.
Positional arguments:
Optional arguments:
usage: cinder --os-volume-api-version 2 service-enable <hostname> <binary>
Enables the service.
Positional arguments:
usage: cinder --os-volume-api-version 2 service-list [--host <hostname>] [--binary <binary>]
[--withreplication [<True|False>]]
Lists all services. Filter by host and service binary.
Optional arguments:
usage: cinder --os-volume-api-version 2 set-bootable <volume> <True|true|False|false>
Update bootable status of a volume.
Positional arguments:
usage: cinder --os-volume-api-version 2 show <volume>
Shows volume details.
Positional arguments:
usage: cinder --os-volume-api-version 2 snapshot-create [--force [<True|False>]] [--name <name>]
[--description <description>]
[--metadata [<key=value> [<key=value> ...]]]
<volume>
Creates a snapshot.
Positional arguments:
Optional arguments:
usage: cinder --os-volume-api-version 2 snapshot-delete <snapshot> [<snapshot> ...]
Removes one or more snapshots.
Positional arguments:
usage: cinder --os-volume-api-version 2 snapshot-list [--all-tenants [<0|1>]] [--name <name>]
[--status <status>] [--volume-id <volume-id>]
[--marker <marker>] [--limit <limit>]
[--sort <key>[:<direction>]] [--tenant [<tenant>]]
Lists all snapshots.
Optional arguments:
usage: cinder --os-volume-api-version 2 snapshot-manage [--id-type <id-type>] [--name <name>]
[--description <description>]
[--metadata [<key=value> [<key=value> ...]]]
<volume> <identifier>
Manage an existing snapshot.
Positional arguments:
Optional arguments:
usage: cinder --os-volume-api-version 2 snapshot-metadata <snapshot> <action> <key=value>
[<key=value> ...]
Sets or deletes snapshot metadata.
Positional arguments:
usage: cinder --os-volume-api-version 2 snapshot-metadata-show <snapshot>
Shows snapshot metadata.
Positional arguments:
usage: cinder --os-volume-api-version 2 snapshot-metadata-update-all <snapshot> <key=value>
[<key=value> ...]
Updates snapshot metadata.
Positional arguments:
usage: cinder --os-volume-api-version 2 snapshot-rename [--description <description>]
<snapshot> [<name>]
Renames a snapshot.
Positional arguments:
Optional arguments:
usage: cinder --os-volume-api-version 2 snapshot-reset-state [--state <state>]
<snapshot> [<snapshot> ...]
Explicitly updates the snapshot state.
Positional arguments:
Optional arguments:
usage: cinder --os-volume-api-version 2 snapshot-show <snapshot>
Shows snapshot details.
Positional arguments:
usage: cinder --os-volume-api-version 2 snapshot-unmanage <snapshot>
Stop managing a snapshot.
Positional arguments:
usage: cinder --os-volume-api-version 2 thaw-host <hostname>
Positional arguments:
usage: cinder --os-volume-api-version 2 transfer-accept <transfer> <auth_key>
Accepts a volume transfer.
Positional arguments:
usage: cinder --os-volume-api-version 2 transfer-create [--name <name>] <volume>
Creates a volume transfer.
Positional arguments:
Optional arguments:
usage: cinder --os-volume-api-version 2 transfer-delete <transfer>
Undoes a transfer.
Positional arguments:
usage: cinder --os-volume-api-version 2 transfer-list [--all-tenants [<0|1>]]
Lists all transfers.
Optional arguments:
usage: cinder --os-volume-api-version 2 transfer-show <transfer>
Shows transfer details.
Positional arguments:
usage: cinder --os-volume-api-version 2 type-access-add --volume-type <volume_type> --project-id
<project_id>
Adds volume type access for the given project.
Optional arguments:
usage: cinder --os-volume-api-version 2 type-access-list --volume-type <volume_type>
Print access information about the given volume type.
Optional arguments:
usage: cinder --os-volume-api-version 2 type-access-remove --volume-type <volume_type> --project-id
<project_id>
Removes volume type access for the given project.
Optional arguments:
usage: cinder --os-volume-api-version 2 type-create [--description <description>]
[--is-public <is-public>]
<name>
Creates a volume type.
Positional arguments:
Optional arguments:
usage: cinder --os-volume-api-version 2 type-default
List the default volume type.
usage: cinder --os-volume-api-version 2 type-delete <id>
Deletes a volume type.
Positional arguments:
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:
usage: cinder --os-volume-api-version 2 type-list
Lists available ‘volume types’. (Admin only will see private types)
usage: cinder --os-volume-api-version 2 type-show <volume_type>
Show volume type details.
Positional arguments:
usage: cinder --os-volume-api-version 2 type-update [--name <name>] [--description <description>]
[--is-public <is-public>]
<id>
Updates volume type name, description, and/or is_public.
Positional arguments:
Optional arguments:
usage: cinder --os-volume-api-version 2 unmanage <volume>
Stop managing a volume.
Positional arguments:
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:
Optional arguments:
usage: cinder availability-zone-list
Lists all availability zones.
usage: cinder backup-create [--container <container>] [--name <name>]
[--description <description>] [--incremental]
[--force] [--snapshot-id <snapshot-id>]
<volume>
Creates a volume backup.
Positional arguments:
Optional arguments:
usage: cinder backup-delete <backup> [<backup> ...]
Removes one or more backups.
Positional arguments:
usage: cinder backup-export <backup>
Export backup metadata record.
Positional arguments:
usage: cinder backup-import <backup_service> <backup_url>
Import backup metadata record.
Positional arguments:
usage: cinder backup-list [--all-tenants [<all_tenants>]] [--name <name>]
[--status <status>] [--volume-id <volume-id>]
[--marker <marker>] [--limit <limit>]
[--sort <key>[:<direction>]]
Lists all backups.
Optional arguments:
usage: cinder backup-reset-state [--state <state>] <backup> [<backup> ...]
Explicitly updates the backup state.
Positional arguments:
Optional arguments:
usage: cinder backup-restore [--volume <volume>] <backup>
Restores a backup.
Positional arguments:
Optional arguments:
usage: cinder backup-show <backup>
Shows backup details.
Positional arguments:
usage: cinder cgsnapshot-create [--name <name>] [--description <description>]
<consistencygroup>
Creates a cgsnapshot.
Positional arguments:
Optional arguments:
usage: cinder cgsnapshot-delete <cgsnapshot> [<cgsnapshot> ...]
Removes one or more cgsnapshots.
Positional arguments:
usage: cinder cgsnapshot-list [--all-tenants [<0|1>]] [--status <status>]
[--consistencygroup-id <consistencygroup_id>]
Lists all cgsnapshots.
Optional arguments:
usage: cinder cgsnapshot-show <cgsnapshot>
Shows cgsnapshot details.
Positional arguments:
usage: cinder consisgroup-create [--name <name>] [--description <description>]
[--availability-zone <availability-zone>]
<volume-types>
Creates a consistency group.
Positional arguments:
Optional arguments:
usage: cinder consisgroup-create-from-src [--cgsnapshot <cgsnapshot>]
[--source-cg <source-cg>]
[--name <name>]
[--description <description>]
Creates a consistency group from a cgsnapshot or a source CG.
Optional arguments:
usage: cinder consisgroup-delete [--force]
<consistencygroup> [<consistencygroup> ...]
Removes one or more consistency groups.
Positional arguments:
Optional arguments:
usage: cinder consisgroup-list [--all-tenants [<0|1>]]
Lists all consistencygroups.
Optional arguments:
usage: cinder consisgroup-show <consistencygroup>
Shows details of a consistency group.
Positional arguments:
usage: cinder consisgroup-update [--name <name>] [--description <description>]
[--add-volumes <uuid1,uuid2,......>]
[--remove-volumes <uuid3,uuid4,......>]
<consistencygroup>
Updates a consistencygroup.
Positional arguments:
Optional arguments:
usage: cinder create [--consisgroup-id <consistencygroup-id>]
[--snapshot-id <snapshot-id>]
[--source-volid <source-volid>]
[--source-replica <source-replica>]
[--image-id <image-id>] [--image <image>] [--name <name>]
[--description <description>]
[--volume-type <volume-type>]
[--availability-zone <availability-zone>]
[--metadata [<key=value> [<key=value> ...]]]
[--hint <key=value>] [--allow-multiattach]
[<size>]
Creates a volume.
Positional arguments:
Optional arguments:
usage: cinder delete <volume> [<volume> ...]
Removes one or more volumes.
Positional arguments:
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:
Optional arguments:
usage: cinder encryption-type-delete <volume_type>
Deletes encryption type for a volume type. Admin only.
Positional arguments:
usage: cinder encryption-type-list
Shows encryption type details for volume types. Admin only.
usage: cinder encryption-type-show <volume_type>
Shows encryption type details for a volume type. Admin only.
Positional arguments:
usage: cinder encryption-type-update [--provider <provider>]
[--cipher [<cipher>]]
[--key-size [<key-size>]]
[--control-location <control-location>]
<volume-type>
Update encryption type information for a volume type (Admin Only).
Positional arguments:
Optional arguments:
usage: cinder endpoints
Discovers endpoints registered by authentication service.
usage: cinder extend <volume> <new_size>
Attempts to extend size of an existing volume.
Positional arguments:
usage: cinder extra-specs-list
Lists current volume types and extra specs.
usage: cinder failover-host [--backend_id <backend-id>] <hostname>
Positional arguments:
Optional arguments:
usage: cinder force-delete <volume> [<volume> ...]
Attempts force-delete of volume, regardless of state.
Positional arguments:
usage: cinder freeze-host <hostname>
Positional arguments:
usage: cinder get-capabilities <host>
Show backend volume stats and properties. Admin only.
Positional arguments:
usage: cinder get-pools [--detail]
Show pool information for backends. Admin only.
Optional arguments:
usage: cinder image-metadata <volume> <action> <key=value> [<key=value> ...]
Sets or deletes volume image metadata.
Positional arguments:
usage: cinder image-metadata-show <volume>
Shows volume image metadata.
Positional arguments:
usage: cinder list [--all-tenants [<0|1>]] [--name <name>] [--status <status>]
[--bootable [<True|true|False|false>]]
[--migration_status <migration_status>]
[--metadata [<key=value> [<key=value> ...]]]
[--marker <marker>] [--limit <limit>] [--fields <fields>]
[--sort <key>[:<direction>]] [--tenant [<tenant>]]
Lists all volumes.
Optional arguments:
usage: cinder manage [--id-type <id-type>] [--name <name>]
[--description <description>]
[--volume-type <volume-type>]
[--availability-zone <availability-zone>]
[--metadata [<key=value> [<key=value> ...]]] [--bootable]
<host> <identifier>
Manage an existing volume.
Positional arguments:
Optional arguments:
usage: cinder metadata <volume> <action> <key=value> [<key=value> ...]
Sets or deletes volume metadata.
Positional arguments:
usage: cinder metadata-show <volume>
Shows volume metadata.
Positional arguments:
usage: cinder metadata-update-all <volume> <key=value> [<key=value> ...]
Updates volume metadata.
Positional arguments:
usage: cinder migrate [--force-host-copy [<True|False>]]
[--lock-volume [<True|False>]]
<volume> <host>
Migrates volume to a new host.
Positional arguments:
Optional arguments:
usage: cinder qos-associate <qos_specs> <volume_type_id>
Associates qos specs with specified volume type.
Positional arguments:
usage: cinder qos-create <name> <key=value> [<key=value> ...]
Creates a qos specs.
Positional arguments:
usage: cinder qos-delete [--force [<True|False>]] <qos_specs>
Deletes a specified qos specs.
Positional arguments:
Optional arguments:
usage: cinder qos-disassociate <qos_specs> <volume_type_id>
Disassociates qos specs from specified volume type.
Positional arguments:
usage: cinder qos-disassociate-all <qos_specs>
Disassociates qos specs from all its associations.
Positional arguments:
usage: cinder qos-get-association <qos_specs>
Lists all associations for specified qos specs.
Positional arguments:
usage: cinder qos-key <qos_specs> <action> key=value [key=value ...]
Sets or unsets specifications for a qos spec.
Positional arguments:
usage: cinder qos-show <qos_specs>
Shows qos specs details.
Positional arguments:
usage: cinder quota-class-show <class>
Lists quotas for a quota class.
Positional arguments:
usage: cinder quota-class-update [--volumes <volumes>]
[--snapshots <snapshots>]
[--gigabytes <gigabytes>]
[--volume-type <volume_type_name>]
<class_name>
Updates quotas for a quota class.
Positional arguments:
Optional arguments:
usage: cinder quota-defaults <tenant_id>
Lists default quotas for a tenant.
Positional arguments:
usage: cinder quota-delete <tenant_id>
Delete the quotas for a tenant.
Positional arguments:
usage: cinder quota-show <tenant_id>
Lists quotas for a tenant.
Positional arguments:
usage: cinder quota-update [--volumes <volumes>] [--snapshots <snapshots>]
[--gigabytes <gigabytes>] [--backups <backups>]
[--backup-gigabytes <backup_gigabytes>]
[--consistencygroups <consistencygroups>]
[--volume-type <volume_type_name>]
[--per-volume-gigabytes <per_volume_gigabytes>]
<tenant_id>
Updates quotas for a tenant.
Positional arguments:
Optional arguments:
usage: cinder quota-usage <tenant_id>
Lists quota usage for a tenant.
Positional arguments:
usage: cinder readonly-mode-update <volume> <True|true|False|false>
Updates volume read-only access-mode flag.
Positional arguments:
usage: cinder rename [--description <description>] <volume> [<name>]
Renames a volume.
Positional arguments:
Optional arguments:
usage: cinder replication-promote <volume>
Promote a secondary volume to primary for a relationship.
Positional arguments:
usage: cinder replication-reenable <volume>
Sync the secondary volume with primary for a relationship.
Positional arguments:
usage: cinder reset-state [--state <state>] [--attach-status <attach-status>]
[--reset-migration-status]
<volume> [<volume> ...]
Explicitly updates the volume state in the Cinder database. Note that this does not affect whether the volume is actually attached to the Nova compute host or instance and can result in an unusable volume. Being a database change only, this has no impact on the true state of the volume and may not match the actual state. This can render a volume unusable in the case of change to the ‘available’ state.
Positional arguments:
Optional arguments:
usage: cinder retype [--migration-policy <never|on-demand>]
<volume> <volume-type>
Changes the volume type for a volume.
Positional arguments:
Optional arguments:
usage: cinder service-disable [--reason <reason>] <hostname> <binary>
Disables the service.
Positional arguments:
Optional arguments:
usage: cinder service-enable <hostname> <binary>
Enables the service.
Positional arguments:
usage: cinder service-list [--host <hostname>] [--binary <binary>]
[--withreplication [<True|False>]]
Lists all services. Filter by host and service binary.
Optional arguments:
usage: cinder set-bootable <volume> <True|true|False|false>
Update bootable status of a volume.
Positional arguments:
usage: cinder show <volume>
Shows volume details.
Positional arguments:
usage: cinder snapshot-create [--force [<True|False>]] [--name <name>]
[--description <description>]
[--metadata [<key=value> [<key=value> ...]]]
<volume>
Creates a snapshot.
Positional arguments:
Optional arguments:
usage: cinder snapshot-delete <snapshot> [<snapshot> ...]
Removes one or more snapshots.
Positional arguments:
usage: cinder snapshot-list [--all-tenants [<0|1>]] [--name <name>]
[--status <status>] [--volume-id <volume-id>]
[--marker <marker>] [--limit <limit>]
[--sort <key>[:<direction>]] [--tenant [<tenant>]]
Lists all snapshots.
Optional arguments:
usage: cinder snapshot-manage [--id-type <id-type>] [--name <name>]
[--description <description>]
[--metadata [<key=value> [<key=value> ...]]]
<volume> <identifier>
Manage an existing snapshot.
Positional arguments:
Optional arguments:
usage: cinder snapshot-metadata <snapshot> <action> <key=value>
[<key=value> ...]
Sets or deletes snapshot metadata.
Positional arguments:
usage: cinder snapshot-metadata-show <snapshot>
Shows snapshot metadata.
Positional arguments:
usage: cinder snapshot-metadata-update-all <snapshot> <key=value>
[<key=value> ...]
Updates snapshot metadata.
Positional arguments:
usage: cinder snapshot-rename [--description <description>]
<snapshot> [<name>]
Renames a snapshot.
Positional arguments:
Optional arguments:
usage: cinder snapshot-reset-state [--state <state>]
<snapshot> [<snapshot> ...]
Explicitly updates the snapshot state.
Positional arguments:
Optional arguments:
usage: cinder snapshot-show <snapshot>
Shows snapshot details.
Positional arguments:
usage: cinder snapshot-unmanage <snapshot>
Stop managing a snapshot.
Positional arguments:
usage: cinder thaw-host <hostname>
Positional arguments:
usage: cinder transfer-accept <transfer> <auth_key>
Accepts a volume transfer.
Positional arguments:
usage: cinder transfer-create [--name <name>] <volume>
Creates a volume transfer.
Positional arguments:
Optional arguments:
usage: cinder transfer-delete <transfer>
Undoes a transfer.
Positional arguments:
usage: cinder transfer-list [--all-tenants [<0|1>]]
Lists all transfers.
Optional arguments:
usage: cinder transfer-show <transfer>
Shows transfer details.
Positional arguments:
usage: cinder type-access-add --volume-type <volume_type> --project-id
<project_id>
Adds volume type access for the given project.
Optional arguments:
usage: cinder type-access-list --volume-type <volume_type>
Print access information about the given volume type.
Optional arguments:
usage: cinder type-access-remove --volume-type <volume_type> --project-id
<project_id>
Removes volume type access for the given project.
Optional arguments:
usage: cinder type-create [--description <description>]
[--is-public <is-public>]
<name>
Creates a volume type.
Positional arguments:
Optional arguments:
usage: cinder type-delete <id>
Deletes a volume type.
Positional arguments:
usage: cinder type-key <vtype> <action> <key=value> [<key=value> ...]
Sets or unsets extra_spec for a volume type.
Positional arguments:
usage: cinder type-list
Lists available ‘volume types’. (Admin only will see private types)
usage: cinder type-show <volume_type>
Show volume type details.
Positional arguments:
usage: cinder type-update [--name <name>] [--description <description>]
[--is-public <is-public>]
<id>
Updates volume type name, description, and/or is_public.
Positional arguments:
Optional arguments:
usage: cinder unmanage <volume>
Stop managing a volume.
Positional arguments:
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:
Optional arguments:
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.