Chapter 2. Block Storage command-line client

Subcommands

absolute-limits

Print a list of absolute limits for a user

availability-zone-list

List all the availability zones.

backup-create

Creates a backup.

backup-delete

Remove a backup.

backup-list

List all the backups.

backup-restore

Restore a backup.

backup-show

Show details about a backup.

create

Add a new volume.

credentials

Show user credentials returned from auth.

delete

Remove volume(s).

encryption-type-create

Create a new encryption type for a volume type (Admin Only).

encryption-type-delete

Delete the encryption type for a volume type (Admin Only).

encryption-type-list

List encryption type information for all volume types (Admin Only).

encryption-type-show

Show the encryption type information for a volume type (Admin Only).

endpoints

Discover endpoints that get returned from the authenticate services.

extend

Attempt to extend the size of an existing volume.

extra-specs-list

Print a list of current 'volume types and extra specs' (Admin Only).

force-delete

Attempt forced removal of volume(s), regardless of the state(s).

list

List all the volumes.

metadata

Set or Delete metadata on a volume.

metadata-show

Show metadata of given volume.

metadata-update-all

Update all metadata of a volume.

migrate

Migrate the volume to the new host.

qos-associate

Associate qos specs with specific volume type.

qos-create

Create a new qos specs.

qos-delete

Delete a specific qos specs.

qos-disassociate

Disassociate qos specs from specific volume type.

qos-disassociate-all

Disassociate qos specs from all of its associations.

qos-get-association

Get all associations of specific qos specs.

qos-key

Set or unset specifications for a qos spec.

qos-list

Get full list of qos specs.

qos-show

Get a specific qos specs.

quota-class-show

List the quotas for a quota class.

quota-class-update

Update the quotas for a quota class.

quota-defaults

List the default quotas for a tenant.

quota-show

List the quotas for a tenant.

quota-update

Update the quotas for a tenant.

quota-usage

List the quota usage for a tenant.

rate-limits

Print a list of rate limits for a user

readonly-mode-update

Update volume read-only access mode read_only.

rename

Rename a volume.

reset-state

Explicitly update the state of a volume.

service-disable

Disable the service.

service-enable

Enable the service.

service-list

List all the services. Filter by host & service binary.

show

Show details about a volume.

snapshot-create

Add a new snapshot.

snapshot-delete

Remove a snapshot.

snapshot-list

List all the snapshots.

snapshot-metadata

Set or Delete metadata of a snapshot.

snapshot-metadata-show

Show metadata of given snapshot.

snapshot-metadata-update-all

Update all metadata of a snapshot.

snapshot-rename

Rename a snapshot.

snapshot-reset-state

Explicitly update the state of a snapshot.

snapshot-show

Show details about a snapshot.

transfer-accept

Accepts a volume transfer.

transfer-create

Creates a volume transfer.

transfer-delete

Undo a transfer.

transfer-list

List all the transfers.

transfer-show

Show details about a transfer.

type-create

Create a new volume type.

type-delete

Delete a specific volume type.

type-key

Set or unset extra_spec for a volume type.

type-list

Print a list of available 'volume types'.

upload-to-image

Upload volume to image service as image.

bash-completion

Print arguments for bash_completion.

help

Display help about this program or one of its subcommands.

list-extensions

List all the os-api extensions that are available.

--version

show program's version number and exit

--debug

Print debugging output

--os-username <auth-user-name>

Defaults to env[OS_USERNAME].

--os-password <auth-password>

Defaults to env[OS_PASSWORD].

--os-tenant-name <auth-tenant-name>

Defaults to env[OS_TENANT_NAME].

--os-tenant-id <auth-tenant-id>

Defaults to env[OS_TENANT_ID].

--os-auth-url <auth-url>

Defaults to env[OS_AUTH_URL].

--os-region-name <region-name>

Defaults to env[OS_REGION_NAME].

--service-type <service-type>

Defaults to volume for most actions

--service-name <service-name>

Defaults to env[CINDER_SERVICE_NAME]

--volume-service-name <volume-service-name>

Defaults to env[CINDER_VOLUME_SERVICE_NAME]

--endpoint-type <endpoint-type>

Defaults to env[CINDER_ENDPOINT_TYPE] or publicURL.

--os-volume-api-version <volume-api-ver>

Accepts 1 or 2,defaults to env[OS_VOLUME_API_VERSION].

--os-cacert <ca-certificate>

Specify a CA bundle file to use in verifying a TLS (https) server certificate. Defaults to env[OS_CACERT]

--retries <retries>

Number of retries.

Positional arguments

<volume>

Name or ID of the volume to backup.

Optional arguments

--container <container>

Optional Backup container name. (Default=None)

--display-name <display-name>

Optional backup name. (Default=None)

--display-description <display-description>

Optional backup description. (Default=None)

Positional arguments

<backup>

Name or ID of the backup to delete.

Positional arguments

<backup>

ID of the backup to restore.

Optional arguments

--volume-id <volume>

Optional ID(or name) of the volume to restore to.

Positional arguments

<backup>

Name or ID of the backup.

Positional arguments

<size>

Size of volume in GB

Optional arguments

--snapshot-id <snapshot-id>

Create volume from snapshot id (Optional, Default=None)

--source-volid <source-volid>

Create volume from volume id (Optional, Default=None)

--image-id <image-id>

Create volume from image id (Optional, Default=None)

--display-name <display-name>

Volume name (Optional, Default=None)

--display-description <display-description>

Volume description (Optional, Default=None)

--volume-type <volume-type>

Volume type (Optional, Default=None)

--availability-zone <availability-zone>

Availability zone for volume (Optional, Default=None)

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

Metadata key=value pairs (Optional, Default=None)

Positional arguments

<volume>

Name or ID of the volume(s) to delete.

Positional arguments

<volume_type>

Name or ID of the volume type

<provider>

Class providing encryption support (e.g. LuksEncryptor)

Optional arguments

--cipher <cipher>

Encryption algorithm/mode to use (e.g., aes-xts- plain64) (Optional, Default=None)

--key_size <key_size>

Size of the encryption key, in bits (e.g., 128, 256) (Optional, Default=None)

--control_location <control_location>

Notional service where encryption is performed (e.g., front-end=Nova). Values: 'front-end', 'back-end' (Optional, Default=None)

Positional arguments

<volume_type>

Name or ID of the volume type

Positional arguments

<volume_type>

Name or ID of the volume type

Positional arguments

<volume>

Name or ID of the volume to extend.

<new-size>

New size of volume in GB

Positional arguments

<volume>

Name or ID of the volume(s) to delete.

Optional arguments

--all-tenants [<0|1>]

Display information from all tenants (Admin only).

--display-name <display-name>

Filter results by display-name

--status <status>

Filter results by status

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

Filter results by metadata

Positional arguments

<volume>

Name or ID of the volume to update metadata on.

<action>

Actions: 'set' or 'unset'

<key=value>

Metadata to set/unset (only key is necessary on unset)

Positional arguments

<volume>

ID of volume

Positional arguments

<volume>

ID of the volume to update metadata on.

<key=value>

Metadata entry/entries to update.

Positional arguments

<volume>

ID of the volume to migrate

<host>

Destination host

Optional arguments

--force-host-copy <True|False>

Optional flag to force the use of the generic host- based migration mechanism, bypassing driver optimizations (Default=False).

Positional arguments

<qos_specs>

ID of qos_specs.

<volume_type_id>

ID of volume type to be associated with.

Positional arguments

<name>

Name of the new QoS specs

<key=value>

Specifications for QoS

Positional arguments

<qos_specs>

ID of the qos_specs to delete.

Optional arguments

--force <True|False>

Optional flag that indicates whether to delete specified qos specs even if it is in-use.

Positional arguments

<qos_specs>

ID of qos_specs.

<volume_type_id>

ID of volume type to be associated with.

Positional arguments

<qos_specs>

ID of qos_specs to be operate on.

Positional arguments

<qos_specs>

ID of the qos_specs.

Positional arguments

<qos_specs>

ID of qos specs

<action>

Actions: 'set' or 'unset'

key=value

QoS specs to set/unset (only key is necessary on unset)

Positional arguments

<qos_specs>

ID of the qos_specs to show.

Positional arguments

<class>

Name of quota class to list the quotas for.

Positional arguments

<class>

Name of quota class to set the quotas for.

Optional arguments

--volumes <volumes>

New value for the "volumes" quota.

--snapshots <snapshots>

New value for the "snapshots" quota.

--gigabytes <gigabytes>

New value for the "gigabytes" quota.

--volume-type <volume_type_name>

Volume type (Optional, Default=None)

Positional arguments

<tenant_id>

UUID of tenant to list the default quotas for.

Positional arguments

<tenant_id>

UUID of tenant to list the quotas for.

Positional arguments

<tenant_id>

UUID of tenant to set the quotas for.

Optional arguments

--volumes <volumes>

New value for the "volumes" quota.

--snapshots <snapshots>

New value for the "snapshots" quota.

--gigabytes <gigabytes>

New value for the "gigabytes" quota.

--volume-type <volume_type_name>

Volume type (Optional, Default=None)

Positional arguments

<tenant_id>

UUID of tenant to list the quota usage for.

Positional arguments

<volume>

ID of the volume to update.

<True|true|False|false>

Flag to indicate whether to update volume to read-only access mode.

Positional arguments

<volume>

Name or ID of the volume to rename.

<display-name>

New display-name for the volume.

Optional arguments

--display-description <display-description>

Optional volume description. (Default=None)

Positional arguments

<volume>

Name or ID of the volume to modify.

Optional arguments

--state <state>

Indicate which state to assign the volume. Options include available, error, creating, deleting, error_deleting. If no state is provided, available will be used.

Positional arguments

<hostname>

Name of host.

<binary>

Service binary.

Positional arguments

<hostname>

Name of host.

<binary>

Service binary.

Optional arguments

--host <hostname>

Name of host.

--binary <binary>

Service binary.

Positional arguments

<volume>

Name or ID of the volume.

Positional arguments

<volume>

Name or ID of the volume to snapshot

Optional arguments

--force <True|False>

Optional flag to indicate whether to snapshot a volume even if it's attached to an instance. (Default=False)

--display-name <display-name>

Optional snapshot name. (Default=None)

--display-description <display-description>

Optional snapshot description. (Default=None)

Positional arguments

<snapshot>

Name or ID of the snapshot to delete.

Optional arguments

--all-tenants [<0|1>]

Display information from all tenants (Admin only).

--display-name <display-name>

Filter results by display-name

--status <status>

Filter results by status

--volume-id <volume-id>

Filter results by volume-id

Positional arguments

<snapshot>

ID of the snapshot to update metadata on.

<action>

Actions: 'set' or 'unset'

<key=value>

Metadata to set/unset (only key is necessary on unset)

Positional arguments

<snapshot>

ID of snapshot

Positional arguments

<snapshot>

ID of the snapshot to update metadata on.

<key=value>

Metadata entry/entries to update.

Positional arguments

<snapshot>

Name or ID of the snapshot.

<display-name>

New display-name for the snapshot.

Optional arguments

--display-description <display-description>

Optional snapshot description. (Default=None)

Positional arguments

<snapshot>

Name or ID of the snapshot to modify.

Optional arguments

--state <state>

Indicate which state to assign the snapshot. Options include available, error, creating, deleting, error_deleting. If no state is provided, available will be used.

Positional arguments

<snapshot>

Name or ID of the snapshot.

Positional arguments

<transfer>

ID of the transfer to accept.

<auth_key>

Auth key of the transfer to accept.

Positional arguments

<volume>

Name or ID of the volume to transfer.

Optional arguments

--display-name <display-name>

Optional transfer name. (Default=None)

Positional arguments

<transfer>

Name or ID of the transfer to delete.

Positional arguments

<transfer>

Name or ID of the transfer to accept.

Positional arguments

<name>

Name of the new volume type

Positional arguments

<id>

Unique ID of the volume type to delete

Positional arguments

<vtype>

Name or ID of the volume type

<action>

Actions: 'set' or 'unset'

<key=value>

Extra_specs to set/unset (only key is necessary on unset)

Positional arguments

<volume>

Name or ID of the volume to upload to an image

<image-name>

Name for created image

Optional arguments

--force <True|False>

Optional flag to indicate whether to upload a volume even if it's attached to an instance. (Default=False)

--container-format <container-format>

Optional type for container format (Default=bare)

--disk-format <disk-format>

Optional type for disk format (Default=raw)