1. Manuals
  2. Leap-15.6
  3. python3-cinderclient
  4. cinder(1)

Scroll to navigation

CINDER(1) Python CINDER(1)

NAME

cinder - Client for OpenStack Block Storage API

The cinder client is the command-line interface (CLI) for the Block Storage service (cinder) API and its extensions.

For help on a specific cinder command, enter:

$ cinder help COMMAND


CINDER USAGE

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


              [--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:

Lists absolute limits for a user.
Display the server API version information. (Supported by API versions 3.0 - 3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
Create an attachment for a cinder volume. (Supported by API versions 3.27 - 3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
Delete an attachment for a cinder volume. (Supported by API versions 3.27 - 3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
Lists all attachments. (Supported by API versions 3.27 - 3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
Show detailed information for attachment. (Supported by API versions 3.27 - 3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
Update an attachment for a cinder volume. (Supported by API versions 3.27 - 3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
Lists all availability zones.
Creates a volume backup.
Removes one or more backups.
Export backup metadata record.
Import backup metadata record.
Lists all backups.
Explicitly updates the backup state.
Restores a backup.
Shows backup details.
Renames a backup. (Supported by API versions 3.9 -3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
Creates a cgsnapshot.
Removes one or more cgsnapshots.
Lists all cgsnapshots.
Shows cgsnapshot details.
Disables clustered services. (Supported by API versions 3.7 - 3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
Enables clustered services. (Supported by API versions 3.7 - 3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
Lists clustered services with optional filtering. (Supported by API versions 3.7 - 3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
Show detailed information on a clustered service. (Supported by API versions 3.7 - 3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
Creates a consistency group.
Creates a consistency group from a cgsnapshot or a source CG.
Removes one or more consistency groups.
Lists all consistency groups.
Shows details of a consistency group.
Updates a consistency group.
Creates a volume.
Shows user credentials returned from auth.
Removes one or more volumes.
Creates encryption type for a volume type. Admin only.
Deletes encryption type for a volume type. Admin only.
Shows encryption type details for volume types. Admin only.
Shows encryption type details for a volume type. Admin only.
Update encryption type information for a volume type (Admin Only).
Discovers endpoints registered by authentication service.
Attempts to extend size of an existing volume.
Lists current volume types and extra specs.
Failover a replicating cinder-volume host.
Attempts force-delete of volume, regardless of state.
Freeze and disable the specified cinder-volume host.
Show backend volume stats and properties. Admin only.
Show pool information for backends. Admin only.
Creates a group. (Supported by API versions 3.13 -3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
Creates a group from a group snapshot or a source group. (Supported by API versions 3.14 - 3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
Removes one or more groups. (Supported by API versions 3.13 - 3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
Lists all groups. (Supported by API versions 3.13 -3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
Shows details of a group. (Supported by API versions 3.13 - 3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
Creates a group snapshot. (Supported by API versions 3.14 - 3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
Removes one or more group snapshots. (Supported by API versions 3.14 - 3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
Lists all group snapshots. (Supported by API versions 3.14 - 3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
Shows group snapshot details. (Supported by API versions 3.14 - 3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
Lists current group types and specs. (Supported by API versions 3.11 - 3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
Creates a group type. (Supported by API versions 3.11 - 3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
List the default group type. (Supported by API versions 3.11 - 3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
Deletes group type or types. (Supported by API versions 3.11 - 3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
Sets or unsets group_spec for a group type. (Supported by API versions 3.11 - 3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
Lists available 'group types'. (Admin only will see private types) (Supported by API versions 3.11 -3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
Show group type details. (Supported by API versions 3.11 - 3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
Updates group type name, description, and/or is_public. (Supported by API versions 3.11 - 3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
Updates a group. (Supported by API versions 3.13 -3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
Sets or deletes volume image metadata.
Shows volume image metadata.
Lists all volumes.
(Supported by API versions 3.33 - 3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
Manage an existing volume.
Lists all manageable volumes. (Supported by API versions 3.8 - 3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
Removes one or more messages. (Supported by API versions 3.3 - 3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
Lists all messages. (Supported by API versions 3.3 -3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
Shows message details. (Supported by API versions 3.3 - 3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
Sets or deletes volume metadata.
Shows volume metadata.
Updates volume metadata.
Migrates volume to a new host.
Associates qos specs with specified volume type.
Creates a qos specs.
Deletes a specified qos specs.
Disassociates qos specs from specified volume type.
Disassociates qos specs from all its associations.
Lists all associations for specified qos specs.
Sets or unsets specifications for a qos spec.
Lists qos specs.
Shows qos specs details.
Lists quotas for a quota class.
Updates quotas for a quota class.
Lists default quotas for a tenant.
Delete the quotas for a tenant.
Lists quotas for a tenant.
Updates quotas for a tenant.
Lists quota usage for a tenant.
Lists rate limits for a user.
Updates volume read-only access-mode flag.
Renames a volume.
Explicitly updates the entity state in the Cinder database.
Changes the volume type for a volume.
Disables the service.
Enables the service.
Lists all services. Filter by host and service binary. (Supported by API versions 3.0 - 3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
Update bootable status of a volume.
Shows volume details.
Creates a snapshot.
Removes one or more snapshots.
Lists all snapshots.
Manage an existing snapshot.
Lists all manageable snapshots. (Supported by API versions 3.8 - 3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
Sets or deletes snapshot metadata.
Shows snapshot metadata.
Updates snapshot metadata.
Renames a snapshot.
Explicitly updates the snapshot state.
Shows snapshot details.
Stop managing a snapshot.
Thaw and enable the specified cinder-volume host.
Accepts a volume transfer.
Creates a volume transfer.
Undoes a transfer.
Lists all transfers.
Shows transfer details.
Adds volume type access for the given project.
Print access information about the given volume type.
Removes volume type access for the given project.
Creates a volume type.
List the default volume type.
Deletes volume type or types.
Sets or unsets extra_spec for a volume type.
Lists available 'volume types'.
Show volume type details.
Updates volume type name, description, and/or is_public.
Stop managing a volume.
Uploads volume to Image Service as an image.
List all API versions. (Supported by API versions 3.0 - 3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
Prints arguments for bash_completion.
Shows help about this program or one of its subcommands.

list-extensions

CINDER OPTIONAL ARGUMENTS

show program's version number and exit
Shows debugging output.
DEPRECATED! Use --os-auth-type. Defaults to env[OS_AUTH_SYSTEM].
Defaults to env[OS_AUTH_TYPE].
Service type. For most actions, default is volume.
Service name. Default= env[CINDER_SERVICE_NAME].
Volume service name. Default= env[CINDER_VOLUME_SERVICE_NAME].
Endpoint type, which is publicURL or internalURL. Default= env[OS_ENDPOINT_TYPE] or nova env[CINDER_ENDPOINT_TYPE] or publicURL.
DEPRECATED! Use --os-endpoint-type.
Block Storage API version. Accepts X, X.Y (where X is major and Y is minor part).Default= env[OS_VOLUME_API_VERSION].
Use this API endpoint instead of the Service Catalog. Default=``env[CINDER_ENDPOINT]``
Number of retries.
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.
Authentication strategy (Env: OS_AUTH_STRATEGY, default keystone). For now, any other value will disable the authentication.
OpenStack user name. Default= env[OS_USERNAME].
Password for OpenStack user. Default= env[OS_PASSWORD].
Tenant name. Default= env[OS_TENANT_NAME].
ID for the tenant. Default= env[OS_TENANT_ID].
URL for the authentication service. Default= env[OS_AUTH_URL].
Authentication user ID (Env: OS_USER_ID).
OpenStack user domain ID. Defaults to env[OS_USER_DOMAIN_ID].
OpenStack user domain name. Defaults to env[OS_USER_DOMAIN_NAME].
Another way to specify tenant ID. This option is mutually exclusive with --os-tenant-id. Defaults to env[OS_PROJECT_ID].
Another way to specify tenant name. This option is mutually exclusive with --os-tenant-name. Defaults to env[OS_PROJECT_NAME].
Defaults to env[OS_PROJECT_DOMAIN_ID].
Defaults to env[OS_PROJECT_DOMAIN_NAME].
Region name. Default= env[OS_REGION_NAME].
Defaults to env[OS_TOKEN].
Defaults to env[OS_URL].

cinder absolute-limits

usage: cinder absolute-limits [<tenant_id>]


Lists absolute limits for a user.

Positional arguments:

<tenant_id>
Display information for a single tenant (Admin only).

cinder api-version

usage: cinder api-version


Display the server API version information.

cinder attachment-create

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>
Name or ID of volume or volumes to attach.
<server_id>
ID of server attaching to.

Optional arguments:

Make an active connection using provided connector info (True or False).
iqn of the initiator attaching to. Default=None.
ip of the system attaching to. Default=None.
Name of the host attaching to. Default=None.
Platform type. Default=x86_64.
OS type. Default=linux2.
Use multipath. Default=False.
Mountpoint volume will be attached at. Default=None.

cinder attachment-delete

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


Delete an attachment for a cinder volume.

Positional arguments:

<attachment>
ID of attachment or attachments to delete.

cinder attachment-list

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:

Shows details for all tenants. Admin only.
Filters results by a volume ID. Default=None. This option is deprecated and will be removed in newer release. Please use '--filters' option which is introduced since 3.33 instead.
Filters results by a status. Default=None. This option is deprecated and will be removed in newer release. Please use '--filters' option which is introduced since 3.33 instead.
Begin returning attachments that appear later in attachment list than that represented by this id. Default=None.
Maximum number of attachments to return. Default=None.
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, reference. Default=None.
Display information from single tenant (Admin only).
Filter key and value pairs. Please use 'cinder list-filters' to check enabled filters from server, Default=None. (Supported by API version 3.33 and later)

cinder attachment-show

usage: cinder attachment-show <attachment>


Show detailed information for attachment.

Positional arguments:

<attachment>
ID of attachment.

cinder attachment-update

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>
ID of attachment.

Optional arguments:

iqn of the initiator attaching to. Default=None.
ip of the system attaching to. Default=None.
Name of the host attaching to. Default=None.
Platform type. Default=x86_64.
OS type. Default=linux2.
Use multipath. Default=False.
Mountpoint volume will be attached at. Default=None.

cinder availability-zone-list

usage: cinder availability-zone-list


Lists all availability zones.

cinder backup-create

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


                            [--description <description>] [--incremental]


                            [--force] [--snapshot-id <snapshot-id>]


                            <volume>


Creates a volume backup.

Positional arguments:

<volume>
Name or ID of volume to backup.

Optional arguments:

Backup container name. Default=None.
Backup name. Default=None.
Backup description. Default=None.
Incremental backup. Default=False.
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.
ID of snapshot to backup. Default=None.

cinder backup-delete

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


Removes one or more backups.

Positional arguments:

<backup>
Name or ID of backup(s) to delete.

Optional arguments:

Allows deleting backup of a volume when its status is other than "available" or "error". Default=False.

cinder backup-export

usage: cinder backup-export <backup>


Export backup metadata record.

Positional arguments:

<backup>
ID of the backup to export.

cinder backup-import

usage: cinder backup-import <backup_service> <backup_url>


Import backup metadata record.

Positional arguments:

<backup_service>
Backup service to use for importing the backup.
<backup_url>
Backup URL for importing the backup metadata.

cinder backup-list

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:

Shows details for all tenants. Admin only.
Filters results by a name. Default=None. This option is deprecated and will be removed in newer release. Please use '--filters' option which is introduced since 3.33 instead.
Filters results by a status. Default=None. This option is deprecated and will be removed in newer release. Please use '--filters' option which is introduced since 3.33 instead.
Filters results by a volume ID. Default=None. This option is deprecated and will be removed in newer release. Please use '--filters' option which is introduced since 3.33 instead.
Begin returning backups that appear later in the backup list than that represented by this id. Default=None.
Maximum number of backups to return. Default=None.
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, reference. Default=None.
Filter key and value pairs. Please use 'cinder list-filters' to check enabled filters from server, Default=None. (Supported by API version 3.33 and later)

cinder backup-reset-state

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


Explicitly updates the backup state.

Positional arguments:

<backup>
Name or ID of the backup to modify.

Optional arguments:

The state to assign to the backup. Valid values are "available", "error". Default=available.

cinder backup-restore

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


Restores a backup.

Positional arguments:

<backup>
Name or ID of backup to restore.

Optional arguments:

Name or ID of existing volume to which to restore. This is mutually exclusive with --name and takes priority. Default=None.
Use the name for new volume creation to restore. This is mutually exclusive with --volume (or the deprecated --volume-id) and --volume (or --volume-id) takes priority. Default=None.

cinder backup-show

usage: cinder backup-show <backup>


Shows backup details.

Positional arguments:

<backup>
Name or ID of backup.

cinder backup-update

usage: cinder backup-update [--name [<name>]] [--description <description>]


                            <backup>


Renames a backup.

Positional arguments:

<backup>
Name or ID of backup to rename.

Optional arguments:

New name for backup.
Backup description. Default=None.

cinder cgsnapshot-create

usage: cinder cgsnapshot-create [--name <name>] [--description <description>]


                                <consistencygroup>


Creates a cgsnapshot.

Positional arguments:

<consistencygroup>
Name or ID of a consistency group.

Optional arguments:

Cgsnapshot name. Default=None.
Cgsnapshot description. Default=None.

cinder cgsnapshot-delete

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


Removes one or more cgsnapshots.

Positional arguments:

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

cinder cgsnapshot-list

usage: cinder cgsnapshot-list [--all-tenants [<0|1>]] [--status <status>]


                              [--consistencygroup-id <consistencygroup_id>]


Lists all cgsnapshots.

Optional arguments:

Shows details for all tenants. Admin only.
Filters results by a status. Default=None.
Filters results by a consistency group ID. Default=None.

cinder cgsnapshot-show

usage: cinder cgsnapshot-show <cgsnapshot>


Shows cgsnapshot details.

Positional arguments:

<cgsnapshot>
Name or ID of cgsnapshot.

cinder cluster-disable

usage: cinder cluster-disable [--reason <reason>] [<binary>] <cluster-name>


Disables clustered services.

Positional arguments:

<binary>
Binary to filter by. Default: cinder-volume.
<cluster-name>
Name of the clustered services to update.

Optional arguments:

Reason for disabling clustered service.

cinder cluster-enable

usage: cinder cluster-enable [<binary>] <cluster-name>


Enables clustered services.

Positional arguments:

<binary>
Binary to filter by. Default: cinder-volume.
<cluster-name>
Name of the clustered services to update.

cinder cluster-list

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:

Filter by cluster name, without backend will list all clustered services from the same cluster. Default=None.
Cluster binary. Default=None.
Filter by up/dow status. Default=None.
Filter by disabled status. Default=None.
Filter by number of hosts in the cluster.
Filter by number of hosts that are down.
Get detailed clustered service information (Default=False).

cinder cluster-show

usage: cinder cluster-show [<binary>] <cluster-name>


Show detailed information on a clustered service.

Positional arguments:

<binary>
Binary to filter by. Default: cinder-volume.
<cluster-name>
Name of the clustered service to show.

cinder consisgroup-create

usage: cinder consisgroup-create [--name <name>] [--description <description>]


                                 [--availability-zone <availability-zone>]


                                 <volume-types>


Creates a consistency group.

Positional arguments:

<volume-types>
Volume types.

Optional arguments:

Name of a consistency group.
Description of a consistency group. Default=None.
Availability zone for volume. Default=None.

cinder consisgroup-create-from-src

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:

Name or ID of a cgsnapshot. Default=None.
Name or ID of a source CG. Default=None.
Name of a consistency group. Default=None.
Description of a consistency group. Default=None.

cinder consisgroup-delete

usage: cinder consisgroup-delete [--force]


                                 <consistencygroup> [<consistencygroup> ...]


Removes one or more consistency groups.

Positional arguments:

<consistencygroup>
Name or ID of one or more consistency groups to be deleted.

Optional arguments:

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.

cinder consisgroup-list

usage: cinder consisgroup-list [--all-tenants [<0|1>]]


Lists all consistency groups.

Optional arguments:

Shows details for all tenants. Admin only.

cinder consisgroup-show

usage: cinder consisgroup-show <consistencygroup>


Shows details of a consistency group.

Positional arguments:

<consistencygroup>
Name or ID of a consistency group.

cinder consisgroup-update

usage: cinder consisgroup-update [--name <name>] [--description <description>]


                                 [--add-volumes <uuid1,uuid2,......>]


                                 [--remove-volumes <uuid3,uuid4,......>]


                                 <consistencygroup>


Updates a consistency group.

Positional arguments:

<consistencygroup>
Name or ID of a consistency group.

Optional arguments:

New name for consistency group. Default=None.
New description for consistency group. Default=None.
UUID of one or more volumes to be added to the consistency group, separated by commas. Default=None.
UUID of one or more volumes to be removed from the consistency group, separated by commas. Default=None.

cinder create

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>
Size of volume, in GiBs. (Required unless snapshot-id /source-volid is specified).

Optional arguments:

ID of a consistency group where the new volume belongs to. Default=None.
ID of a group where the new volume belongs to. Default=None. (Supported by API version 3.13 and later)
Creates volume from snapshot ID. Default=None.
Creates volume from volume ID. Default=None.
Creates volume from replicated volume ID. Default=None.
Creates volume from image ID. Default=None.
Creates a volume from image (ID or name). Default=None.
Volume name. Default=None.
Volume description. Default=None.
Volume type. Default=None.
Availability zone for volume. Default=None.
Metadata key and value pairs. Default=None.
Scheduler hint, like in nova.
Allow volume to be attached more than once. Default=False

cinder credentials

usage: cinder credentials


Shows user credentials returned from auth.

cinder delete

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


Removes one or more volumes.

Positional arguments:

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

Optional arguments:

Remove any snapshots along with volume. Default=False.

cinder encryption-type-create

usage: cinder encryption-type-create [--cipher <cipher>]


                                     [--key-size <key_size>]


                                     [--control-location <control_location>]


                                     <volume_type> <provider>


Creates encryption type for a volume type. Admin only.

Positional arguments:

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

Optional arguments:

The encryption algorithm or mode. For example, aes-xts-plain64. Default=None.
Size of encryption key, in bits. For example, 128 or 256. Default=None.
Notional service where encryption is performed. Valid values are "front-end" or "back-end." For example, front-end=Nova. Default is "front-end."

cinder encryption-type-delete

usage: cinder encryption-type-delete <volume_type>


Deletes encryption type for a volume type. Admin only.

Positional arguments:

<volume_type>
Name or ID of volume type.

cinder encryption-type-list

usage: cinder encryption-type-list


Shows encryption type details for volume types. Admin only.

cinder encryption-type-show

usage: cinder encryption-type-show <volume_type>


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

Positional arguments:

<volume_type>
Name or ID of volume type.

cinder encryption-type-update

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>
Name or ID of the volume type

Optional arguments:

Class providing encryption support (e.g. LuksEncryptor)
Encryption algorithm/mode to use (e.g., aes-xts-plain64). Provide parameter without value to set to provider default.
Size of the encryption key, in bits (e.g., 128, 256). Provide parameter without value to set to provider default.
Notional service where encryption is performed (e.g., front-end=Nova). Values: 'front-end', 'back-end'

cinder endpoints

usage: cinder endpoints


Discovers endpoints registered by authentication service.

cinder extend

usage: cinder extend <volume> <new_size>


Attempts to extend size of an existing volume.

Positional arguments:

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

cinder extra-specs-list

usage: cinder extra-specs-list


Lists current volume types and extra specs.

cinder failover-host

usage: cinder failover-host [--backend_id <backend-id>] <hostname>


Failover a replicating cinder-volume host.

Positional arguments:

<hostname>
Host name.

Optional arguments:

ID of backend to failover to (Default=None)

cinder force-delete

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


Attempts force-delete of volume, regardless of state.

Positional arguments:

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

cinder freeze-host

usage: cinder freeze-host <hostname>


Freeze and disable the specified cinder-volume host.

Positional arguments:

<hostname>
Host name.

cinder get-capabilities

usage: cinder get-capabilities <host>


Show backend volume stats and properties. Admin only.

Positional arguments:

<host>
Cinder host to show backend volume stats and properties; takes the form: host@backend-name

cinder get-pools

usage: cinder get-pools [--detail] [--filters [<key=value> [<key=value> ...]]]


Show pool information for backends. Admin only.

Optional arguments:

Show detailed information about pools.
Filter key and value pairs. Please use 'cinder list-filters' to check enabled filters from server, Default=None. (Supported by API version 3.33 and later)

cinder group-create

usage: cinder group-create [--name <name>] [--description <description>]


                           [--availability-zone <availability-zone>]


                           <group-type> <volume-types>


Creates a group.

Positional arguments:

<group-type>
Group type.
<volume-types>
Comma-separated list of volume types.

Optional arguments:

Name of a group.
Description of a group. Default=None.
Availability zone for group. Default=None.

cinder group-create-from-src

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:

Name or ID of a group snapshot. Default=None.
Name or ID of a source group. Default=None.
Name of a group. Default=None.
Description of a group. Default=None.

cinder group-delete

usage: cinder group-delete [--delete-volumes] <group> [<group> ...]


Removes one or more groups.

Positional arguments:

<group>
Name or ID of one or more groups to be deleted.

Optional arguments:

Allows or disallows groups to be deleted if they are not empty. If the group is empty, it can be deleted without the delete-volumes flag. If the group is not empty, the delete-volumes flag is required for it to be deleted. If True, all volumes in the group will also be deleted.

cinder group-list

usage: cinder group-list [--all-tenants [<0|1>]]


                         [--filters [<key=value> [<key=value> ...]]]


Lists all groups.

Optional arguments:

Shows details for all tenants. Admin only.
Filter key and value pairs. Please use 'cinder list-filters' to check enabled filters from server, Default=None. (Supported by API version 3.33 and later)

cinder group-show

usage: cinder group-show <group>


Shows details of a group.

Positional arguments:

<group>
Name or ID of a group.

cinder group-snapshot-create

usage: cinder group-snapshot-create [--name <name>]


                                    [--description <description>]


                                    <group>


Creates a group snapshot.

Positional arguments:

<group>
Name or ID of a group.

Optional arguments:

Group snapshot name. Default=None.
Group snapshot description. Default=None.

cinder group-snapshot-delete

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


Removes one or more group snapshots.

Positional arguments:

<group_snapshot>
Name or ID of one or more group snapshots to be deleted.

cinder group-snapshot-list

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:

Shows details for all tenants. Admin only.
Filters results by a status. Default=None. This option is deprecated and will be removed in newer release. Please use '--filters' option which is introduced since 3.33 instead.
Filters results by a group ID. Default=None. This option is deprecated and will be removed in newer release. Please use '--filters' option which is introduced since 3.33 instead.
Filter key and value pairs. Please use 'cinder list-filters' to check enabled filters from server, Default=None. (Supported by API version 3.33 and later)

cinder group-snapshot-show

usage: cinder group-snapshot-show <group_snapshot>


Shows group snapshot details.

Positional arguments:

<group_snapshot>
Name or ID of group snapshot.

cinder group-specs-list

usage: cinder group-specs-list


Lists current group types and specs.

cinder group-type-create

usage: cinder group-type-create [--description <description>]


                                [--is-public <is-public>]


                                <name>


Creates a group type.

Positional arguments:

<name>
Name of new group type.

Optional arguments:

Description of new group type.
Make type accessible to the public (default true).

cinder group-type-default

usage: cinder group-type-default


List the default group type.

cinder group-type-delete

usage: cinder group-type-delete <group_type> [<group_type> ...]


Deletes group type or types.

Positional arguments:

<group_type>
Name or ID of group type or types to delete.

cinder group-type-key

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


Sets or unsets group_spec for a group type.

Positional arguments:

<gtype>
Name or ID of group type.
<action>
The action. Valid values are "set" or "unset."
<key=value>
The group specs key and value pair to set or unset. For unset, specify only the key.

cinder group-type-list

usage: cinder group-type-list


Lists available 'group types'. (Admin only will see private types)

cinder group-type-show

usage: cinder group-type-show <group_type>


Show group type details.

Positional arguments:

<group_type>
Name or ID of the group type.

cinder group-type-update

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>
ID of the group type.

Optional arguments:

Name of the group type.
Description of the group type.
Make type accessible to the public or not.

cinder group-update

usage: cinder group-update [--name <name>] [--description <description>]


                           [--add-volumes <uuid1,uuid2,......>]


                           [--remove-volumes <uuid3,uuid4,......>]


                           <group>


Updates a group.

Positional arguments:

<group>
Name or ID of a group.

Optional arguments:

New name for group. Default=None.
New description for group. Default=None.
UUID of one or more volumes to be added to the group, separated by commas. Default=None.
UUID of one or more volumes to be removed from the group, separated by commas. Default=None.

cinder image-metadata

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


Sets or deletes volume image metadata.

Positional arguments:

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

cinder image-metadata-show

usage: cinder image-metadata-show <volume>


Shows volume image metadata.

Positional arguments:

<volume>
ID of volume.

cinder list

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:

Filters results by a group_id. Default=None.This option is deprecated and will be removed in newer release. Please use '--filters' option which is introduced since 3.33 instead. (Supported by API version 3.10 and later)
Shows details for all tenants. Admin only.
Filters results by a name. Default=None. This option is deprecated and will be removed in newer release. Please use '--filters' option which is introduced since 3.33 instead.
Filters results by a status. Default=None. This option is deprecated and will be removed in newer release. Please use '--filters' option which is introduced since 3.33 instead.
Filters results by bootable status. Default=None. This option is deprecated and will be removed in newer release. Please use '--filters' option which is introduced since 3.33 instead.
Filters results by a migration status. Default=None. Admin only. This option is deprecated and will be removed in newer release. Please use '--filters' option which is introduced since 3.33 instead.
Filters results by a metadata key and value pair. Default=None. This option is deprecated and will be removed in newer release. Please use '--filters' option which is introduced since 3.33 instead.
Filters results by a image metadata key and value pair. Require volume api version >=3.4. Default=None.This option is deprecated and will be removed in newer release. Please use '--filters' option which is introduced since 3.33 instead. (Supported by API version 3.4 and later)
Begin returning volumes that appear later in the volume list than that represented by this volume id. Default=None.
Maximum number of volumes to return. Default=None.
Comma-separated list of fields to display. Use the show command to see which fields are available. Unavailable/non-existent fields will be ignored. Default=None.
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, reference. Default=None.
Display information from single tenant (Admin only).

Filter key and value pairs. Please use the cinder list-filters command to check enabled filters from server. Default=None. (Supported by API version 3.33 and later)

Time Comparison Filters

Beginning with API version 3.60, you can apply time comparison filtering to the created_at and updated at fields. Time must be expressed in ISO 8601 format: CCYY-MM-DDThh:mm:ss±hh:mm. The ±hh:mm value, if included, returns the time zone as an offset from UTC.

To use time comparison filtering, use the standard key=value syntax for the --filters option. The allowable keys are:

  • created_at
  • updated_at

The value is a time comparison statement, which is specified as follows: a comparison operator, followed immediately by a colon (:), followed immediately by a time expressed in ISO 8601 format. You can filter by a time range by appending a comma (,) followed a second time comparison statement.

Six comparison operators are supported:

  • gt (greater than) - return results more recent than the specified time
  • gte (greater than or equal) - return any results matching the specified time and also any more recent results
  • eq (equal) - return any results matching the specified time exactly
  • neq (not equal) - return any results that do not match the specified time
  • lt (less than) - return results older than the specified time
  • lte (less than or equal) - return any results matching the specified time and also any older results

Examples

To filter the response to volumes created before 15 January 2020:

cinder list --filters created_at=lt:2020-01-15T00:00:00


To filter the response to those volumes updated in February 2020:

cinder list --filters updated_at=gte:2020-02-01T00:00:00,lt:2020-03-01T00:00:00


See the Block Storage API v3 Reference for more information.


cinder list-extensions

usage: cinder list-extensions


cinder list-filters

usage: cinder list-filters [--resource <resource>]


Optional arguments:

Show enabled filters for specified resource. Default=None.

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>


Manage an existing volume.

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:

Type of backend device identifier provided, typically source-name or source-id (Default=source-name)
Volume name (Default=None)
Volume description (Default=None)
Volume type (Default=None)
Availability zone for volume (Default=None)
Metadata key=value pairs (Default=None)
Specifies that the newly created volume should be marked as bootable

cinder manageable-list

usage: cinder manageable-list [--detailed <detailed>] [--marker <marker>]


                              [--limit <limit>] [--offset <offset>]


                              [--sort <key>[:<direction>]]


                              <host>


Lists all manageable volumes.

Positional arguments:

<host>
Cinder host on which to list manageable volumes; takes the form: host@backend-name#pool

Optional arguments:

Returned detailed information (default true).
Begin returning volumes that appear later in the volume list than that represented by this reference. This reference should be json like. Default=None.
Maximum number of volumes to return. Default=None.
Number of volumes to skip after marker. Default=None.
Comma-separated list of sort keys and directions in the form of <key>[:<asc|desc>]. Valid keys: size, reference. Default=None.

cinder message-delete

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


Removes one or more messages.

Positional arguments:

<message>
ID of one or more message to be deleted.

cinder message-list

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:

Begin returning message that appear later in the message list than that represented by this id. Default=None. (Supported by API version 3.5 and later)
Maximum number of messages to return. Default=None. (Supported by API version 3.5 and later)
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, reference. Default=None. (Supported by API version 3.5 and later)
Filters results by a resource uuid. Default=None. This option is deprecated and will be removed in newer release. Please use '--filters' option which is introduced since 3.33 instead.
Filters results by a resource type. Default=None. This option is deprecated and will be removed in newer release. Please use '--filters' option which is introduced since 3.33 instead.
Filters results by event id. Default=None. This option is deprecated and will be removed in newer release. Please use '--filters' option which is introduced since 3.33 instead.
Filters results by request id. Default=None. This option is deprecated and will be removed in newer release. Please use '--filters' option which is introduced since 3.33 instead.
Filters results by the message level. Default=None. This option is deprecated and will be removed in newer release. Please use '--filters' option which is introduced since 3.33 instead.
Filter key and value pairs. Please use 'cinder list-filters' to check enabled filters from server, Default=None. (Supported by API version 3.33 and later)

cinder message-show

usage: cinder message-show <message>


Shows message details.

Positional arguments:

<message>
ID of message.

cinder metadata

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


Sets or deletes volume metadata.

Positional arguments:

<volume>
Name or ID of volume for which to update metadata.
<action>
The action. Valid values are "set" or "unset."
<key=value>
Metadata key and value pair to set or unset. For unset, specify only the key(s): <key key> (Supported by API version 3.15 and later)

cinder metadata-show

usage: cinder metadata-show <volume>


Shows volume metadata.

Positional arguments:

<volume>
ID of volume.

cinder metadata-update-all

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


Updates volume metadata.

Positional arguments:

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

cinder migrate

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


                      [--lock-volume [<True|False>]]


                      <volume> <host>


Migrates volume to a new host.

Positional arguments:

<volume>
ID of volume to migrate.
<host>
Destination host. Takes the form: host@backend-name#pool

Optional arguments:

Enables or disables generic host-based force-migration, which bypasses driver optimizations. Default=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.

cinder qos-associate

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


Associates qos specs with specified volume type.

Positional arguments:

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

cinder qos-create

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


Creates a qos specs.

Positional arguments:

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

cinder qos-delete

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


Deletes a specified qos specs.

Positional arguments:

<qos_specs>
ID of QoS specifications to delete.

Optional arguments:

Enables or disables deletion of in-use QoS specifications. Default=False.

cinder qos-disassociate

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


Disassociates qos specs from specified volume type.

Positional arguments:

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

cinder qos-disassociate-all

usage: cinder qos-disassociate-all <qos_specs>


Disassociates qos specs from all its associations.

Positional arguments:

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

cinder qos-get-association

usage: cinder qos-get-association <qos_specs>


Lists all associations for specified qos specs.

Positional arguments:

<qos_specs>
ID of QoS specifications.

cinder qos-key

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


Sets or unsets specifications for a qos spec.

Positional arguments:

<qos_specs>
ID of QoS specifications.
<action>
The action. Valid values are "set" or "unset."
Metadata key and value pair to set or unset. For unset, specify only the key.

cinder qos-list

usage: cinder qos-list


Lists qos specs.

cinder qos-show

usage: cinder qos-show <qos_specs>


Shows qos specs details.

Positional arguments:

<qos_specs>
ID of QoS specifications to show.

cinder quota-class-show

usage: cinder quota-class-show <class>


Lists quotas for a quota class.

Positional arguments:

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

cinder quota-class-update

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>
Name of quota class for which to set quotas.

Optional arguments:

The new "volumes" quota value. Default=None.
The new "snapshots" quota value. Default=None.
The new "gigabytes" quota value. Default=None.
Volume type. Default=None.

cinder quota-defaults

usage: cinder quota-defaults <tenant_id>


Lists default quotas for a tenant.

Positional arguments:

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

cinder quota-delete

usage: cinder quota-delete <tenant_id>


Delete the quotas for a tenant.

Positional arguments:

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

cinder quota-show

usage: cinder quota-show <tenant_id>


Lists quotas for a tenant.

Positional arguments:

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

cinder quota-update

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>
ID of tenant for which to set quotas.

Optional arguments:

The new "volumes" quota value. Default=None.
The new "snapshots" quota value. Default=None.
The new "gigabytes" quota value. Default=None.
The new "backups" quota value. Default=None.
The new "backup_gigabytes" quota value. Default=None.
The new "consistencygroups" quota value. Default=None.
The new "groups" quota value. Default=None. (Supported by API version 3.13 and later)
Volume type. Default=None.
Set max volume size limit. Default=None.

cinder quota-usage

usage: cinder quota-usage <tenant_id>


Lists quota usage for a tenant.

Positional arguments:

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

cinder rate-limits

usage: cinder rate-limits [<tenant_id>]


Lists rate limits for a user.

Positional arguments:

<tenant_id>
Display information for a single tenant (Admin only).

cinder readonly-mode-update

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


Updates volume read-only access-mode flag.

Positional arguments:

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

cinder rename

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


Renames a volume.

Positional arguments:

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

Optional arguments:

Volume description. Default=None.

cinder replication-promote

usage: cinder replication-promote <volume>


Promote a secondary volume to primary for a relationship.

Positional arguments:

<volume>
Name or ID of the volume to promote. The volume should have the replica volume created with source-replica argument.

cinder replication-reenable

usage: cinder replication-reenable <volume>


Sync the secondary volume with primary for a relationship.

Positional arguments:

<volume>
Name or ID of the volume to reenable replication. The replication-status of the volume should be inactive.

cinder reset-state

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>
Name or ID of entity to update.

Optional arguments:

Type of entity to update. Available resources are: 'volume', 'snapshot', 'backup', 'group' (since 3.20) and 'group-snapshot' (since 3.19), Default=volume.
The state to assign to the entity. NOTE: This command simply changes the state of the entity in the database with no regard to actual status, exercise caution when using. Default=None, that means the state is unchanged.
This is only used for a volume entity. 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.
This is only used for a volume entity. 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.

cinder retype

usage: cinder retype [--migration-policy <never|on-demand>]


                     <volume> <volume-type>


Changes the volume type for a volume.

Positional arguments:

<volume>
Name or ID of volume for which to modify type.
<volume-type>
New volume type.

Optional arguments:

Migration policy during retype of volume.

cinder service-disable

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


Disables the service.

Positional arguments:

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

Optional arguments:

Reason for disabling service.

cinder service-enable

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


Enables the service.

Positional arguments:

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

cinder service-list

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


                           [--withreplication [<True|False>]]


Lists all services. Filter by host and service binary.

Optional arguments:

Host name. Default=None.
Service binary. Default=None.
Enables or disables display of Replication info for c-vol services. Default=False. (Supported by API version 3.7 and later)

cinder set-bootable

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


Update bootable status of a volume.

Positional arguments:

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

cinder show

usage: cinder show <volume>


Shows volume details.

Positional arguments:

<volume>
Name or ID of volume.

cinder snapshot-create

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


                              [--description <description>]


                              [--metadata [<key=value> [<key=value> ...]]]


                              <volume>


Creates a snapshot.

Positional arguments:

<volume>
Name or ID of volume to snapshot.

Optional arguments:

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.
Snapshot name. Default=None.
Snapshot description. Default=None.
Snapshot metadata key and value pairs. Default=None.

cinder snapshot-delete

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


Removes one or more snapshots.

Positional arguments:

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

Optional arguments:

Allows deleting snapshot of a volume when its status is other than "available" or "error". Default=False.

cinder snapshot-list

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:

Shows details for all tenants. Admin only.
Filters results by a name. Default=None. This option is deprecated and will be removed in newer release. Please use '--filters' option which is introduced since 3.33 instead.
Filters results by a status. Default=None. This option is deprecated and will be removed in newer release. Please use '--filters' option which is introduced since 3.33 instead.
Filters results by a volume ID. Default=None. This option is deprecated and will be removed in newer release. Please use '--filters' option which is introduced since 3.33 instead.
Begin returning snapshots that appear later in the snapshot list than that represented by this id. Default=None.
Maximum number of snapshots to return. Default=None.
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, reference. Default=None.
Display information from single tenant (Admin only).
Filters results by a metadata key and value pair. Require volume api version >=3.22. Default=None. This option is deprecated and will be removed in newer release. Please use '--filters' option which is introduced since 3.33 instead. (Supported by API version 3.22 and later)
Filter key and value pairs. Please use 'cinder list-filters' to check enabled filters from server, Default=None. (Supported by API version 3.33 and later)

cinder snapshot-manage

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>
Cinder volume already exists in volume backend
<identifier>
Name or other Identifier for existing snapshot

Optional arguments:

Type of backend device identifier provided, typically source-name or source-id (Default=source-name)
Snapshot name (Default=None)
Snapshot description (Default=None)
Metadata key=value pairs (Default=None)

cinder snapshot-manageable-list

usage: cinder snapshot-manageable-list [--detailed <detailed>]


                                       [--marker <marker>] [--limit <limit>]


                                       [--offset <offset>]


                                       [--sort <key>[:<direction>]]


                                       <host>


Lists all manageable snapshots.

Positional arguments:

<host>
Cinder host on which to list manageable snapshots; takes the form: host@backend-name#pool

Optional arguments:

Returned detailed information (default true).
Begin returning volumes that appear later in the volume list than that represented by this reference. This reference should be json like. Default=None.
Maximum number of volumes to return. Default=None.
Number of volumes to skip after marker. Default=None.
Comma-separated list of sort keys and directions in the form of <key>[:<asc|desc>]. Valid keys: size, reference. Default=None.

cinder snapshot-metadata

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


                                [<key=value> ...]


Sets or deletes snapshot metadata.

Positional arguments:

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

cinder snapshot-metadata-show

usage: cinder snapshot-metadata-show <snapshot>


Shows snapshot metadata.

Positional arguments:

<snapshot>
ID of snapshot.

cinder snapshot-metadata-update-all

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


                                           [<key=value> ...]


Updates snapshot metadata.

Positional arguments:

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

cinder snapshot-rename

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


                              <snapshot> [<name>]


Renames a snapshot.

Positional arguments:

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

Optional arguments:

Snapshot description. Default=None.

cinder snapshot-reset-state

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


                                   <snapshot> [<snapshot> ...]


Explicitly updates the snapshot state.

Positional arguments:

<snapshot>
Name or ID of snapshot to modify.

Optional arguments:

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.

cinder snapshot-show

usage: cinder snapshot-show <snapshot>


Shows snapshot details.

Positional arguments:

<snapshot>
Name or ID of snapshot.

cinder snapshot-unmanage

usage: cinder snapshot-unmanage <snapshot>


Stop managing a snapshot.

Positional arguments:

<snapshot>
Name or ID of the snapshot to unmanage.

cinder thaw-host

usage: cinder thaw-host <hostname>


Thaw and enable the specified cinder-volume host.

Positional arguments:

<hostname>
Host name.

cinder transfer-accept

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


Accepts a volume transfer.

Positional arguments:

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

cinder transfer-create

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


Creates a volume transfer.

Positional arguments:

<volume>
Name or ID of volume to transfer.

Optional arguments:

Transfer name. Default=None.

cinder transfer-delete

usage: cinder transfer-delete <transfer>


Undoes a transfer.

Positional arguments:

<transfer>
Name or ID of transfer to delete.

cinder transfer-list

usage: cinder transfer-list [--all-tenants [<0|1>]]


Lists all transfers.

Optional arguments:

Shows details for all tenants. Admin only.

cinder transfer-show

usage: cinder transfer-show <transfer>


Shows transfer details.

Positional arguments:

<transfer>
Name or ID of transfer to accept.

cinder type-access-add

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 name or ID to add access for the given project.
Project ID to add volume type access for.

cinder type-access-list

usage: cinder type-access-list --volume-type <volume_type>


Print access information about the given volume type.

Optional arguments:

Filter results by volume type name or ID.

cinder type-access-remove

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 name or ID to remove access for the given project.
Project ID to remove volume type access for.

cinder type-create

usage: cinder type-create [--description <description>]


                          [--is-public <is-public>]


                          <name>


Creates a volume type.

Positional arguments:

<name>
Name of new volume type.

Optional arguments:

Description of new volume type.
Make type accessible to the public (default true).

cinder type-default

usage: cinder type-default


List the default volume type.

cinder type-delete

usage: cinder type-delete <vol_type> [<vol_type> ...]


Deletes volume type or types.

Positional arguments:

<vol_type>
Name or ID of volume type or types to delete.

cinder type-key

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


Sets or unsets extra_spec for a volume type.

Positional arguments:

<vtype>
Name or ID of volume type.
<action>
The action. Valid values are "set" or "unset."
<key=value>
The extra specs key and value pair to set or unset. For unset, specify only the key.

cinder type-list

usage: cinder type-list [--filters <key=value> [<key=value> ...]]


Lists available 'volume types'. (Only admin and tenant users will see private types)

Optional arguments:

Filter key and value pairs. Please use 'cinder list-filters' to check enabled filters from server, Default=None. (Supported by API version 3.52 and later)

cinder type-show

usage: cinder type-show <volume_type>


Show volume type details.

Positional arguments:

<volume_type>
Name or ID of the volume type.

cinder type-update

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>
ID of the volume type.

Optional arguments:

Name of the volume type.
Description of the volume type.
Make type accessible to the public or not.

cinder unmanage

usage: cinder unmanage <volume>


Stop managing a volume.

Positional arguments:

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

cinder upload-to-image

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>
Name or ID of volume to snapshot.
<image-name>
The new image name.

Optional arguments:

Enables or disables upload of a volume that is attached to an instance. Default=False. This option may not be supported by your cloud.
Container format type. Default is bare.
Disk format type. Default is raw.
Set image visibility to either public or private. Default=private. (Supported by API version 3.1 and later)
Prevents image from being deleted. Default=False. (Supported by API version 3.1 and later)

cinder version-list

usage: cinder version-list


List all API versions.

AUTHOR

OpenStack Contributors

COPYRIGHT

OpenStack Contributors

May 12, 2020