The cinder client is the command-line interface (CLI) for the Block Storage service (cinder) API and its extensions.
This chapter documents cinder version 2.2.0
.
For help on a specific cinder command, enter:
$ cinder help COMMAND
usage: cinder [--version] [-d] [--os-auth-system <os-auth-system>]
[--os-auth-type <os-auth-type>] [--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>] [--os-endpoint <os-endpoint>]
[--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
api-version
attachment-create
attachment-delete
attachment-list
attachment-show
attachment-update
availability-zone-list
backup-create
backup-delete
backup-export
backup-import
backup-list
backup-reset-state
backup-restore
backup-show
backup-update
cgsnapshot-create
cgsnapshot-delete
cgsnapshot-list
cgsnapshot-show
cluster-disable
cluster-enable
cluster-list
cluster-show
consisgroup-create
consisgroup-create-from-src
consisgroup-delete
consisgroup-list
consisgroup-show
consisgroup-update
create
credentials
delete
encryption-type-create
encryption-type-delete
encryption-type-list
encryption-type-show
encryption-type-update
endpoints
extend
extra-specs-list
failover-host
force-delete
freeze-host
get-capabilities
get-pools
group-create
group-create-from-src
group-delete
group-list
group-show
group-snapshot-create
group-snapshot-delete
group-snapshot-list
group-snapshot-show
group-specs-list
group-type-create
group-type-default
group-type-delete
group-type-key
group-type-list
group-type-show
group-type-update
group-update
image-metadata
image-metadata-show
list
list-filters
manage
manageable-list
message-delete
message-list
message-show
metadata
metadata-show
metadata-update-all
migrate
qos-associate
qos-create
qos-delete
qos-disassociate
qos-disassociate-all
qos-get-association
qos-key
qos-list
qos-show
quota-class-show
quota-class-update
quota-defaults
quota-delete
quota-show
quota-update
quota-usage
rate-limits
readonly-mode-update
rename
replication-promote
replication-reenable
reset-state
retype
service-disable
service-enable
service-list
set-bootable
show
snapshot-create
snapshot-delete
snapshot-list
snapshot-manage
snapshot-manageable-list
snapshot-metadata
snapshot-metadata-show
snapshot-metadata-update-all
snapshot-rename
snapshot-reset-state
snapshot-show
snapshot-unmanage
thaw-host
transfer-accept
transfer-create
transfer-delete
transfer-list
transfer-show
type-access-add
type-access-list
type-access-remove
type-create
type-default
type-delete
type-key
type-list
type-show
type-update
unmanage
upload-to-image
version-list
bash-completion
help
list-extensions
--version
-d, --debug
--os-auth-system <os-auth-system>
env[OS_AUTH_SYSTEM]
.--os-auth-type <os-auth-type>
env[OS_AUTH_TYPE]
.--service-type <service-type>
--service-name <service-name>
env[CINDER_SERVICE_NAME]
.--volume-service-name <volume-service-name>
env[CINDER_VOLUME_SERVICE_NAME]
.--os-endpoint-type <os-endpoint-type>
env[OS_ENDPOINT_TYPE]
or nova
env[CINDER_ENDPOINT_TYPE]
or publicURL.--endpoint-type <endpoint-type>
--os-volume-api-version <volume-api-ver>
env[OS_VOLUME_API_VERSION]
.--bypass-url <bypass-url>
env[CINDERCLIENT_BYPASS_URL]
.--os-endpoint <os-endpoint>
env[CINDER_ENDPOINT]
.--retries <retries>
--profile HMAC_KEY
--os-auth-strategy <auth-strategy>
--os-username <auth-user-name>
env[OS_USERNAME]
.--os-password <auth-password>
env[OS_PASSWORD]
.--os-tenant-name <auth-tenant-name>
env[OS_TENANT_NAME]
.--os-tenant-id <auth-tenant-id>
env[OS_TENANT_ID]
.--os-auth-url <auth-url>
env[OS_AUTH_URL]
.--os-user-id <auth-user-id>
--os-user-domain-id <auth-user-domain-id>
env[OS_USER_DOMAIN_ID]
.--os-user-domain-name <auth-user-domain-name>
env[OS_USER_DOMAIN_NAME]
.--os-project-id <auth-project-id>
env[OS_PROJECT_ID]
.--os-project-name <auth-project-name>
env[OS_PROJECT_NAME]
.--os-project-domain-id <auth-project-domain-id>
env[OS_PROJECT_DOMAIN_ID]
.--os-project-domain-name <auth-project-domain-name>
env[OS_PROJECT_DOMAIN_NAME]
.--os-region-name <region-name>
env[OS_REGION_NAME]
.--os-token <token>
env[OS_TOKEN]
.--os-url <url>
env[OS_URL]
.usage: cinder absolute-limits [<tenant_id>]
Lists absolute limits for a user.
Positional arguments:
<tenant_id>
usage: cinder attachment-create [--connect <connect>]
[--initiator <initiator>] [--ip <ip>]
[--host <host>] [--platform <platform>]
[--ostype <ostype>] [--multipath <multipath>]
[--mountpoint <mountpoint>]
<volume> <server_id>
Create an attachment for a cinder volume.
Positional arguments:
<volume>
<server_id>
Optional arguments:
--connect <connect>
--initiator <initiator>
--ip <ip>
--host <host>
--platform <platform>
--ostype <ostype>
--multipath <multipath>
--mountpoint <mountpoint>
usage: cinder attachment-delete <attachment> [<attachment> ...]
Delete an attachment for a cinder volume.
Positional arguments:
<attachment>
usage: cinder attachment-list [--all-tenants [<0|1>]]
[--volume-id <volume-id>] [--status <status>]
[--marker <marker>] [--limit <limit>]
[--sort <key>[:<direction>]]
[--tenant [<tenant>]]
[--filters [<key=value> [<key=value> ...]]]
Lists all attachments.
Optional arguments:
--all-tenants [<0|1>]
--volume-id <volume-id>
--status <status>
--marker <marker>
--limit <limit>
--sort <key>[:<direction>]
--tenant [<tenant>]
--filters [<key=value> [<key=value> ...]]
usage: cinder attachment-show <attachment>
Show detailed information for attachment.
Positional arguments:
<attachment>
usage: cinder attachment-update [--initiator <initiator>] [--ip <ip>]
[--host <host>] [--platform <platform>]
[--ostype <ostype>] [--multipath <multipath>]
[--mountpoint <mountpoint>]
<attachment>
Update an attachment for a cinder volume. This call is designed to be more of an attachment completion than anything else. It expects the value of a connector object to notify the driver that the volume is going to be connected and where it’s being connected to.
Positional arguments:
<attachment>
Optional arguments:
--initiator <initiator>
--ip <ip>
--host <host>
--platform <platform>
--ostype <ostype>
--multipath <multipath>
--mountpoint <mountpoint>
usage: cinder backup-create [--container <container>] [--name <name>]
[--description <description>] [--incremental]
[--force] [--snapshot-id <snapshot-id>]
<volume>
Creates a volume backup.
Positional arguments:
<volume>
Optional arguments:
--container <container>
--name <name>
--description <description>
--incremental
--force
--snapshot-id <snapshot-id>
usage: cinder backup-delete [--force] <backup> [<backup> ...]
Removes one or more backups.
Positional arguments:
<backup>
Optional arguments:
--force
usage: cinder backup-export <backup>
Export backup metadata record.
Positional arguments:
<backup>
usage: cinder backup-import <backup_service> <backup_url>
Import backup metadata record.
Positional arguments:
<backup_service>
<backup_url>
usage: cinder backup-list [--all-tenants [<all_tenants>]] [--name <name>]
[--status <status>] [--volume-id <volume-id>]
[--marker <marker>] [--limit <limit>]
[--sort <key>[:<direction>]]
[--filters [<key=value> [<key=value> ...]]]
Lists all backups.
Optional arguments:
--all-tenants [<all_tenants>]
--name <name>
--status <status>
--volume-id <volume-id>
--marker <marker>
--limit <limit>
--sort <key>[:<direction>]
--filters [<key=value> [<key=value> ...]]
usage: cinder backup-reset-state [--state <state>] <backup> [<backup> ...]
Explicitly updates the backup state.
Positional arguments:
<backup>
Optional arguments:
--state <state>
usage: cinder backup-restore [--volume <volume>] [--name <name>] <backup>
Restores a backup.
Positional arguments:
<backup>
Optional arguments:
--volume <volume>
--name <name>
usage: cinder backup-show <backup>
Shows backup details.
Positional arguments:
<backup>
usage: cinder backup-update [--name [<name>]] [--description <description>]
<backup>
Renames a backup.
Positional arguments:
<backup>
Optional arguments:
--name [<name>]
--description <description>
usage: cinder cgsnapshot-create [--name <name>] [--description <description>]
<consistencygroup>
Creates a cgsnapshot.
Positional arguments:
<consistencygroup>
Optional arguments:
--name <name>
--description <description>
usage: cinder cgsnapshot-delete <cgsnapshot> [<cgsnapshot> ...]
Removes one or more cgsnapshots.
Positional arguments:
<cgsnapshot>
usage: cinder cgsnapshot-list [--all-tenants [<0|1>]] [--status <status>]
[--consistencygroup-id <consistencygroup_id>]
Lists all cgsnapshots.
Optional arguments:
--all-tenants [<0|1>]
--status <status>
--consistencygroup-id <consistencygroup_id>
usage: cinder cgsnapshot-show <cgsnapshot>
Shows cgsnapshot details.
Positional arguments:
<cgsnapshot>
usage: cinder cluster-disable [--reason <reason>] [<binary>] <cluster-name>
Disables clustered services.
Positional arguments:
<binary>
<cluster-name>
Optional arguments:
--reason <reason>
usage: cinder cluster-enable [<binary>] <cluster-name>
Enables clustered services.
Positional arguments:
<binary>
<cluster-name>
usage: cinder cluster-list [--name <name>] [--binary <binary>]
[--is-up <True|true|False|false>]
[--disabled <True|true|False|false>]
[--num-hosts <num-hosts>]
[--num-down-hosts <num-down-hosts>] [--detailed]
Lists clustered services with optional filtering.
Optional arguments:
--name <name>
--binary <binary>
--is-up <True|true|False|false>
--disabled <True|true|False|false>
--num-hosts <num-hosts>
--num-down-hosts <num-down-hosts>
--detailed
usage: cinder cluster-show [<binary>] <cluster-name>
Show detailed information on a clustered service.
Positional arguments:
<binary>
<cluster-name>
usage: cinder consisgroup-create [--name <name>] [--description <description>]
[--availability-zone <availability-zone>]
<volume-types>
Creates a consistency group.
Positional arguments:
<volume-types>
Optional arguments:
--name <name>
--description <description>
--availability-zone <availability-zone>
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:
--cgsnapshot <cgsnapshot>
--source-cg <source-cg>
--name <name>
--description <description>
usage: cinder consisgroup-delete [--force]
<consistencygroup> [<consistencygroup> ...]
Removes one or more consistency groups.
Positional arguments:
<consistencygroup>
Optional arguments:
--force
usage: cinder consisgroup-list [--all-tenants [<0|1>]]
Lists all consistency groups.
Optional arguments:
--all-tenants [<0|1>]
usage: cinder consisgroup-show <consistencygroup>
Shows details of a consistency group.
Positional arguments:
<consistencygroup>
usage: cinder consisgroup-update [--name <name>] [--description <description>]
[--add-volumes <uuid1,uuid2,......>]
[--remove-volumes <uuid3,uuid4,......>]
<consistencygroup>
Updates a consistency group.
Positional arguments:
<consistencygroup>
Optional arguments:
--name <name>
--description <description>
--add-volumes <uuid1,uuid2,......>
--remove-volumes <uuid3,uuid4,......>
usage: cinder create [--consisgroup-id <consistencygroup-id>]
[--group-id <group-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:
<size>
Optional arguments:
--consisgroup-id <consistencygroup-id>
--group-id <group-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
usage: cinder delete [--cascade] <volume> [<volume> ...]
Removes one or more volumes.
Positional arguments:
<volume>
Optional arguments:
--cascade
usage: cinder encryption-type-create [--cipher <cipher>]
[--key-size <key_size>]
[--control-location <control_location>]
<volume_type> <provider>
Creates encryption type for a volume type. Admin only.
Positional arguments:
<volume_type>
<provider>
Optional arguments:
--cipher <cipher>
--key-size <key_size>
--control-location <control_location>
usage: cinder encryption-type-delete <volume_type>
Deletes encryption type for a volume type. Admin only.
Positional arguments:
<volume_type>
usage: cinder encryption-type-list
Shows encryption type details for volume types. Admin only.
usage: cinder encryption-type-show <volume_type>
Shows encryption type details for a volume type. Admin only.
Positional arguments:
<volume_type>
usage: cinder encryption-type-update [--provider <provider>]
[--cipher [<cipher>]]
[--key-size [<key-size>]]
[--control-location <control-location>]
<volume-type>
Update encryption type information for a volume type (Admin Only).
Positional arguments:
<volume-type>
Optional arguments:
--provider <provider>
--cipher [<cipher>]
--key-size [<key-size>]
--control-location <control-location>
usage: cinder extend <volume> <new_size>
Attempts to extend size of an existing volume.
Positional arguments:
<volume>
<new_size>
usage: cinder failover-host [--backend_id <backend-id>] <hostname>
Failover a replicating cinder-volume host.
Positional arguments:
<hostname>
Optional arguments:
--backend_id <backend-id>
usage: cinder force-delete <volume> [<volume> ...]
Attempts force-delete of volume, regardless of state.
Positional arguments:
<volume>
usage: cinder freeze-host <hostname>
Freeze and disable the specified cinder-volume host.
Positional arguments:
<hostname>
usage: cinder get-capabilities <host>
Show backend volume stats and properties. Admin only.
Positional arguments:
<host>
usage: cinder get-pools [--detail] [--filters [<key=value> [<key=value> ...]]]
Show pool information for backends. Admin only.
Optional arguments:
--detail
--filters [<key=value> [<key=value> ...]]
usage: cinder group-create [--name <name>] [--description <description>]
[--availability-zone <availability-zone>]
<group-type> <volume-types>
Creates a group.
Positional arguments:
<group-type>
<volume-types>
Optional arguments:
--name <name>
--description <description>
--availability-zone <availability-zone>
usage: cinder group-create-from-src [--group-snapshot <group-snapshot>]
[--source-group <source-group>]
[--name <name>]
[--description <description>]
Creates a group from a group snapshot or a source group.
Optional arguments:
--group-snapshot <group-snapshot>
--source-group <source-group>
--name <name>
--description <description>
usage: cinder group-delete [--delete-volumes] <group> [<group> ...]
Removes one or more groups.
Positional arguments:
<group>
Optional arguments:
--delete-volumes
usage: cinder group-list [--all-tenants [<0|1>]]
[--filters [<key=value> [<key=value> ...]]]
Lists all groups.
Optional arguments:
--all-tenants [<0|1>]
--filters [<key=value> [<key=value> ...]]
usage: cinder group-show <group>
Shows details of a group.
Positional arguments:
<group>
usage: cinder group-snapshot-create [--name <name>]
[--description <description>]
<group>
Creates a group snapshot.
Positional arguments:
<group>
Optional arguments:
--name <name>
--description <description>
usage: cinder group-snapshot-delete <group_snapshot> [<group_snapshot> ...]
Removes one or more group snapshots.
Positional arguments:
<group_snapshot>
usage: cinder group-snapshot-list [--all-tenants [<0|1>]] [--status <status>]
[--group-id <group_id>]
[--filters [<key=value> [<key=value> ...]]]
Lists all group snapshots.
Optional arguments:
--all-tenants [<0|1>]
--status <status>
--group-id <group_id>
--filters [<key=value> [<key=value> ...]]
usage: cinder group-snapshot-show <group_snapshot>
Shows group snapshot details.
Positional arguments:
<group_snapshot>
usage: cinder group-type-create [--description <description>]
[--is-public <is-public>]
<name>
Creates a group type.
Positional arguments:
<name>
Optional arguments:
--description <description>
--is-public <is-public>
usage: cinder group-type-delete <group_type> [<group_type> ...]
Deletes group type or types.
Positional arguments:
<group_type>
usage: cinder group-type-key <gtype> <action> <key=value> [<key=value> ...]
Sets or unsets group_spec for a group type.
Positional arguments:
<gtype>
<action>
<key=value>
usage: cinder group-type-list
Lists available ‘group types’. (Admin only will see private types)
usage: cinder group-type-show <group_type>
Show group type details.
Positional arguments:
<group_type>
usage: cinder group-type-update [--name <name>] [--description <description>]
[--is-public <is-public>]
<id>
Updates group type name, description, and/or is_public.
Positional arguments:
<id>
Optional arguments:
--name <name>
--description <description>
--is-public <is-public>
usage: cinder group-update [--name <name>] [--description <description>]
[--add-volumes <uuid1,uuid2,......>]
[--remove-volumes <uuid3,uuid4,......>]
<group>
Updates a group.
Positional arguments:
<group>
Optional arguments:
--name <name>
--description <description>
--add-volumes <uuid1,uuid2,......>
--remove-volumes <uuid3,uuid4,......>
usage: cinder image-metadata <volume> <action> <key=value> [<key=value> ...]
Sets or deletes volume image metadata.
Positional arguments:
<volume>
<action>
<key=value>
usage: cinder image-metadata-show <volume>
Shows volume image metadata.
Positional arguments:
<volume>
usage: cinder list [--group_id <group_id>] [--all-tenants [<0|1>]]
[--name <name>] [--status <status>]
[--bootable [<True|true|False|false>]]
[--migration_status <migration_status>]
[--metadata [<key=value> [<key=value> ...]]]
[--image_metadata [<key=value> [<key=value> ...]]]
[--marker <marker>] [--limit <limit>] [--fields <fields>]
[--sort <key>[:<direction>]] [--tenant [<tenant>]]
[--filters [<key=value> [<key=value> ...]]]
Lists all volumes.
Optional arguments:
--group_id <group_id>
--all-tenants [<0|1>]
--name <name>
--status <status>
--bootable [<True|true|False|false>]
--migration_status <migration_status>
--metadata [<key=value> [<key=value> ...]]
--image_metadata [<key=value> [<key=value> ...]]
--marker <marker>
--limit <limit>
--fields <fields>
--sort <key>[:<direction>]
--tenant [<tenant>]
--filters [<key=value> [<key=value> ...]]
usage: cinder list-extensions
usage: cinder list-filters [--resource <resource>]
Optional arguments:
--resource <resource>
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:
<host>
<identifier>
Optional arguments:
--id-type <id-type>
--name <name>
--description <description>
--volume-type <volume-type>
--availability-zone <availability-zone>
--metadata [<key=value> [<key=value> ...]]
--bootable
usage: cinder manageable-list [--detailed <detailed>] [--marker <marker>]
[--limit <limit>] [--offset <offset>]
[--sort <key>[:<direction>]]
<host>
Lists all manageable volumes.
Positional arguments:
<host>
Optional arguments:
--detailed <detailed>
--marker <marker>
--limit <limit>
--offset <offset>
--sort <key>[:<direction>]
usage: cinder message-delete <message> [<message> ...]
Removes one or more messages.
Positional arguments:
<message>
usage: cinder message-list [--marker <marker>] [--limit <limit>]
[--sort <key>[:<direction>]]
[--resource_uuid <resource_uuid>]
[--resource_type <type>] [--event_id <id>]
[--request_id <request_id>] [--level <level>]
[--filters [<key=value> [<key=value> ...]]]
Lists all messages.
Optional arguments:
--marker <marker>
--limit <limit>
--sort <key>[:<direction>]
--resource_uuid <resource_uuid>
--resource_type <type>
--event_id <id>
--request_id <request_id>
--level <level>
--filters [<key=value> [<key=value> ...]]
usage: cinder message-show <message>
Shows message details.
Positional arguments:
<message>
usage: cinder metadata <volume> <action> <key=value> [<key=value> ...]
Sets or deletes volume metadata.
Positional arguments:
<volume>
<action>
<key=value>
usage: cinder metadata-show <volume>
Shows volume metadata.
Positional arguments:
<volume>
usage: cinder metadata-update-all <volume> <key=value> [<key=value> ...]
Updates volume metadata.
Positional arguments:
<volume>
<key=value>
usage: cinder migrate [--force-host-copy [<True|False>]]
[--lock-volume [<True|False>]]
<volume> <host>
Migrates volume to a new host.
Positional arguments:
<volume>
<host>
Optional arguments:
--force-host-copy [<True|False>]
--lock-volume [<True|False>]
usage: cinder qos-associate <qos_specs> <volume_type_id>
Associates qos specs with specified volume type.
Positional arguments:
<qos_specs>
<volume_type_id>
usage: cinder qos-create <name> <key=value> [<key=value> ...]
Creates a qos specs.
Positional arguments:
<name>
<key=value>
usage: cinder qos-delete [--force [<True|False>]] <qos_specs>
Deletes a specified qos specs.
Positional arguments:
<qos_specs>
Optional arguments:
--force [<True|False>]
usage: cinder qos-disassociate <qos_specs> <volume_type_id>
Disassociates qos specs from specified volume type.
Positional arguments:
<qos_specs>
<volume_type_id>
usage: cinder qos-disassociate-all <qos_specs>
Disassociates qos specs from all its associations.
Positional arguments:
<qos_specs>
usage: cinder qos-get-association <qos_specs>
Lists all associations for specified qos specs.
Positional arguments:
<qos_specs>
usage: cinder qos-key <qos_specs> <action> key=value [key=value ...]
Sets or unsets specifications for a qos spec.
Positional arguments:
<qos_specs>
<action>
key=value
usage: cinder qos-show <qos_specs>
Shows qos specs details.
Positional arguments:
<qos_specs>
usage: cinder quota-class-show <class>
Lists quotas for a quota class.
Positional arguments:
<class>
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:
<class_name>
Optional arguments:
--volumes <volumes>
--snapshots <snapshots>
--gigabytes <gigabytes>
--volume-type <volume_type_name>
usage: cinder quota-defaults <tenant_id>
Lists default quotas for a tenant.
Positional arguments:
<tenant_id>
usage: cinder quota-delete <tenant_id>
Delete the quotas for a tenant.
Positional arguments:
<tenant_id>
usage: cinder quota-show <tenant_id>
Lists quotas for a tenant.
Positional arguments:
<tenant_id>
usage: cinder quota-update [--volumes <volumes>] [--snapshots <snapshots>]
[--gigabytes <gigabytes>] [--backups <backups>]
[--backup-gigabytes <backup_gigabytes>]
[--consistencygroups <consistencygroups>]
[--groups <groups>]
[--volume-type <volume_type_name>]
[--per-volume-gigabytes <per_volume_gigabytes>]
<tenant_id>
Updates quotas for a tenant.
Positional arguments:
<tenant_id>
Optional arguments:
--volumes <volumes>
--snapshots <snapshots>
--gigabytes <gigabytes>
--backups <backups>
--backup-gigabytes <backup_gigabytes>
--consistencygroups <consistencygroups>
--groups <groups>
--volume-type <volume_type_name>
--per-volume-gigabytes <per_volume_gigabytes>
usage: cinder quota-usage <tenant_id>
Lists quota usage for a tenant.
Positional arguments:
<tenant_id>
usage: cinder rate-limits [<tenant_id>]
Lists rate limits for a user.
Positional arguments:
<tenant_id>
usage: cinder readonly-mode-update <volume> <True|true|False|false>
Updates volume read-only access-mode flag.
Positional arguments:
<volume>
<True|true|False|false>
usage: cinder rename [--description <description>] <volume> [<name>]
Renames a volume.
Positional arguments:
<volume>
<name>
Optional arguments:
--description <description>
usage: cinder replication-promote <volume>
Promote a secondary volume to primary for a relationship.
Positional arguments:
<volume>
usage: cinder replication-reenable <volume>
Sync the secondary volume with primary for a relationship.
Positional arguments:
<volume>
usage: cinder reset-state [--type <type>] [--state <state>]
[--attach-status <attach-status>]
[--reset-migration-status]
<entity> [<entity> ...]
Explicitly updates the entity state in the Cinder database. Being a database change only, this has no impact on the true state of the entity and may not match the actual state. This can render a entity unusable in the case of changing to the ‘available’ state.
Positional arguments:
<entity>
Optional arguments:
--type <type>
--state <state>
--attach-status <attach-status>
--reset-migration-status
usage: cinder retype [--migration-policy <never|on-demand>]
<volume> <volume-type>
Changes the volume type for a volume.
Positional arguments:
<volume>
<volume-type>
Optional arguments:
--migration-policy <never|on-demand>
usage: cinder service-disable [--reason <reason>] <hostname> <binary>
Disables the service.
Positional arguments:
<hostname>
<binary>
Optional arguments:
--reason <reason>
usage: cinder service-enable <hostname> <binary>
Enables the service.
Positional arguments:
<hostname>
<binary>
usage: cinder service-list [--host <hostname>] [--binary <binary>]
[--withreplication [<True|False>]]
Lists all services. Filter by host and service binary.
Optional arguments:
--host <hostname>
--binary <binary>
--withreplication [<True|False>]
usage: cinder set-bootable <volume> <True|true|False|false>
Update bootable status of a volume.
Positional arguments:
<volume>
<True|true|False|false>
usage: cinder show <volume>
Shows volume details.
Positional arguments:
<volume>
usage: cinder snapshot-create [--force [<True|False>]] [--name <name>]
[--description <description>]
[--metadata [<key=value> [<key=value> ...]]]
<volume>
Creates a snapshot.
Positional arguments:
<volume>
Optional arguments:
--force [<True|False>]
--name <name>
--description <description>
--metadata [<key=value> [<key=value> ...]]
usage: cinder snapshot-delete [--force] <snapshot> [<snapshot> ...]
Removes one or more snapshots.
Positional arguments:
<snapshot>
Optional arguments:
--force
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>]]
[--metadata [<key=value> [<key=value> ...]]]
[--filters [<key=value> [<key=value> ...]]]
Lists all snapshots.
Optional arguments:
--all-tenants [<0|1>]
--name <name>
--status <status>
--volume-id <volume-id>
--marker <marker>
--limit <limit>
--sort <key>[:<direction>]
--tenant [<tenant>]
--metadata [<key=value> [<key=value> ...]]
--filters [<key=value> [<key=value> ...]]
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:
<volume>
<identifier>
Optional arguments:
--id-type <id-type>
--name <name>
--description <description>
--metadata [<key=value> [<key=value> ...]]
usage: cinder snapshot-manageable-list [--detailed <detailed>]
[--marker <marker>] [--limit <limit>]
[--offset <offset>]
[--sort <key>[:<direction>]]
<host>
Lists all manageable snapshots.
Positional arguments:
<host>
Optional arguments:
--detailed <detailed>
--marker <marker>
--limit <limit>
--offset <offset>
--sort <key>[:<direction>]
usage: cinder snapshot-metadata <snapshot> <action> <key=value>
[<key=value> ...]
Sets or deletes snapshot metadata.
Positional arguments:
<snapshot>
<action>
<key=value>
usage: cinder snapshot-metadata-show <snapshot>
Shows snapshot metadata.
Positional arguments:
<snapshot>
usage: cinder snapshot-metadata-update-all <snapshot> <key=value>
[<key=value> ...]
Updates snapshot metadata.
Positional arguments:
<snapshot>
<key=value>
usage: cinder snapshot-rename [--description <description>]
<snapshot> [<name>]
Renames a snapshot.
Positional arguments:
<snapshot>
<name>
Optional arguments:
--description <description>
usage: cinder snapshot-reset-state [--state <state>]
<snapshot> [<snapshot> ...]
Explicitly updates the snapshot state.
Positional arguments:
<snapshot>
Optional arguments:
--state <state>
usage: cinder snapshot-show <snapshot>
Shows snapshot details.
Positional arguments:
<snapshot>
usage: cinder snapshot-unmanage <snapshot>
Stop managing a snapshot.
Positional arguments:
<snapshot>
usage: cinder thaw-host <hostname>
Thaw and enable the specified cinder-volume host.
Positional arguments:
<hostname>
usage: cinder transfer-accept <transfer> <auth_key>
Accepts a volume transfer.
Positional arguments:
<transfer>
<auth_key>
usage: cinder transfer-create [--name <name>] <volume>
Creates a volume transfer.
Positional arguments:
<volume>
Optional arguments:
--name <name>
usage: cinder transfer-delete <transfer>
Undoes a transfer.
Positional arguments:
<transfer>
usage: cinder transfer-list [--all-tenants [<0|1>]]
Lists all transfers.
Optional arguments:
--all-tenants [<0|1>]
usage: cinder transfer-show <transfer>
Shows transfer details.
Positional arguments:
<transfer>
usage: cinder type-access-add --volume-type <volume_type> --project-id
<project_id>
Adds volume type access for the given project.
Optional arguments:
--volume-type <volume_type>
--project-id <project_id>
usage: cinder type-access-list --volume-type <volume_type>
Print access information about the given volume type.
Optional arguments:
--volume-type <volume_type>
usage: cinder type-access-remove --volume-type <volume_type> --project-id
<project_id>
Removes volume type access for the given project.
Optional arguments:
--volume-type <volume_type>
--project-id <project_id>
usage: cinder type-create [--description <description>]
[--is-public <is-public>]
<name>
Creates a volume type.
Positional arguments:
<name>
Optional arguments:
--description <description>
--is-public <is-public>
usage: cinder type-delete <vol_type> [<vol_type> ...]
Deletes volume type or types.
Positional arguments:
<vol_type>
usage: cinder type-key <vtype> <action> <key=value> [<key=value> ...]
Sets or unsets extra_spec for a volume type.
Positional arguments:
<vtype>
<action>
<key=value>
usage: cinder type-list [--filters <key=value> [<key=value> ...]]
Lists available ‘volume types’. (Only admin and tenant users will see private types)
Optional arguments:
--filters [<key=value> [<key=value> ...]]
usage: cinder type-show <volume_type>
Show volume type details.
Positional arguments:
<volume_type>
usage: cinder type-update [--name <name>] [--description <description>]
[--is-public <is-public>]
<id>
Updates volume type name, description, and/or is_public.
Positional arguments:
<id>
Optional arguments:
--name <name>
--description <description>
--is-public <is-public>
usage: cinder unmanage <volume>
Stop managing a volume.
Positional arguments:
<volume>
usage: cinder upload-to-image [--force [<True|False>]]
[--container-format <container-format>]
[--disk-format <disk-format>]
[--visibility <public|private>]
[--protected <True|False>]
<volume> <image-name>
Uploads volume to Image Service as an image.
Positional arguments:
<volume>
<image-name>
Optional arguments:
--force [<True|False>]
--container-format <container-format>
--disk-format <disk-format>
--visibility <public|private>
--protected <True|False>
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.