Block Storage v2 Commands¶

block storage¶

block storage cleanup¶

Do block storage cleanup.

This command requires --os-volume-api-version 3.24 or greater.

openstack block storage cleanup
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--cluster <cluster>]
    [--host <host>]
    [--binary <binary>]
    [--up | --down]
    [--disabled | --enabled]
    [--resource-id <resource-id>]
    [--resource-type <Volume|Snapshot>]
    [--service-id SERVICE_ID]

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

--cluster <cluster>¶: Name of block storage cluster in which cleanup needs to be performed (name only)

--host <host>¶: Host where the service resides. (name only)

--binary <binary>¶: Name of the service binary.

--up¶: Filter by up status. If this is set, services need to be up.

--down¶: Filter by down status. If this is set, services need to be down.

--disabled¶: Filter by disabled status.

--enabled¶: Filter by enabled status.

--resource-id <resource-id>¶: UUID of a resource to cleanup.

--resource-type <Volume|Snapshot>¶: Type of resource to cleanup.

--service-id <SERVICE_ID>¶: The service ID field from the DB, not the UUID of the service.

block storage cluster¶

block storage cluster list¶

List block storage clusters.

This command requires --os-volume-api-version 3.7 or greater.

openstack block storage cluster list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--cluster <name>]
    [--binary <binary>]
    [--up]
    [--down]
    [--disabled]
    [--enabled]
    [--num-hosts <hosts>]
    [--num-down-hosts <hosts>]
    [--long]

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

--cluster <name>¶: Filter by cluster name, without backend will list all clustered services from the same cluster.

--binary <binary>¶: Cluster binary.

--up¶: Filter by up status.

--down¶: Filter by down status.

--disabled¶: Filter by disabled status.

--enabled¶: Filter by enabled status.

--num-hosts <hosts>¶: Filter by number of hosts in the cluster.

--num-down-hosts <hosts>¶: Filter by number of hosts that are down.

--long¶: List additional fields in output

block storage cluster set¶

Set block storage cluster properties.

This command requires --os-volume-api-version 3.7 or greater.

openstack block storage cluster set
    [--binary <binary>]
    [--enable | --disable]
    [--disable-reason <reason>]
    <cluster>

--binary <binary>¶: Name of binary to filter by; defaults to ‘cinder-volume’ (optional)

--enable¶: Enable cluster

--disable¶: Disable cluster

--disable-reason <reason>¶: Reason for disabling the cluster (should be used with –disable option)

cluster¶: Name of block storage cluster to update (name only)

block storage cluster show¶

Show detailed information for a block storage cluster.

This command requires --os-volume-api-version 3.7 or greater.

openstack block storage cluster show [--binary <binary>] <cluster>

--binary <binary>¶: Service binary.

cluster¶: Name of block storage cluster.

Block Storage Log Level¶

block storage log level list¶

List log levels of block storage service.

Supported by –os-volume-api-version 3.32 or greater.

openstack block storage log level list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--host <host>]
    [--service <service>]
    [--log-prefix <log-prefix>]

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

--host <host>¶: List block storage service log level of specified host (name only)

--service <service>¶: List block storage service log level of the specified service (name only)

--log-prefix <log-prefix>¶: Prefix for the log, e.g. ‘sqlalchemy’

block storage log level set¶

Set log level of block storage service

Supported by –os-volume-api-version 3.32 or greater.

openstack block storage log level set
    [--host <host>]
    [--service <service>]
    [--log-prefix <log-prefix>]
    <log-level>

--host <host>¶: Set block storage service log level of specified host (name only)

--service <service>¶: Set block storage service log level of specified service (name only)

--log-prefix <log-prefix>¶: Prefix for the log, e.g. ‘sqlalchemy’

log-level¶: Desired log level

Block Storage Manage¶

block storage volume manageable list¶

List manageable volumes.

Supported by –os-volume-api-version 3.8 or greater.

openstack block storage volume manageable list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--cluster <cluster>]
    [--long]
    [--marker <marker>]
    [--limit <limit>]
    [--offset <offset>]
    [--sort <key>[:<direction>]]
    [<host>]

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

--cluster <cluster>¶: Cinder cluster on which to list manageable volumes. Takes the form: cluster@backend-name#pool. (supported by –os-volume-api-version 3.17 or later)

--long¶: List additional fields in output

--marker <marker>¶: Begin returning volumes that appear later in the volume list than that represented by this reference. This reference should be json like. Default=None.

--limit <limit>¶: Maximum number of volumes to return. Default=None.

--offset <offset>¶: Number of volumes to skip after marker. Default=None.

--sort <key>[:<direction>]¶: Comma-separated list of sort keys and directions in the form of <key>[:<asc|desc>]. Valid keys: size, reference. Default=None.

host¶: Cinder host on which to list manageable volumes. Takes the form: host@backend-name#pool

block storage snapshot manageable list¶

List manageable snapshots.

Supported by –os-volume-api-version 3.8 or greater.

openstack block storage snapshot manageable list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--cluster <cluster>]
    [--long]
    [--marker <marker>]
    [--limit <limit>]
    [--offset <offset>]
    [--sort <key>[:<direction>]]
    [<host>]

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

--cluster <cluster>¶: Cinder cluster on which to list manageable snapshots. Takes the form: cluster@backend-name#pool. (supported by –os-volume-api-version 3.17 or later)

--long¶: List additional fields in output

--marker <marker>¶: Begin returning snapshots that appear later in the snapshot list than that represented by this reference. This reference should be json like. Default=None.

--limit <limit>¶: Maximum number of snapshots to return. Default=None.

--offset <offset>¶: Number of snapshots to skip after marker. Default=None.

--sort <key>[:<direction>]¶: Comma-separated list of sort keys and directions in the form of <key>[:<asc|desc>]. Valid keys: size, reference. Default=None.

host¶: Cinder host on which to list manageable snapshots. Takes the form: host@backend-name#pool

block storage resource filter¶

block storage resource filter show¶

Show filters for a block storage resource type

openstack block storage resource filter show <resource>

resource¶: Resource to show filters for (name).

consistency group snapshot¶

consistency group snapshot create¶

Create new consistency group snapshot.

openstack consistency group snapshot create
    [--consistency-group <consistency-group>]
    [--description <description>]
    [<snapshot-name>]

--consistency-group <consistency-group>¶: Consistency group to snapshot (name or ID) (default to be the same as <snapshot-name>)

--description <description>¶: Description of this consistency group snapshot

snapshot-name¶: Name of new consistency group snapshot (default to None)

consistency group snapshot delete¶

Delete consistency group snapshot(s).

openstack consistency group snapshot delete
    <consistency-group-snapshot>
    [<consistency-group-snapshot> ...]

consistency-group-snapshot¶: Consistency group snapshot(s) to delete (name or ID)

consistency group snapshot list¶

List consistency group snapshots.

openstack consistency group snapshot list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--all-projects]
    [--long]
    [--status <status>]
    [--consistency-group <consistency-group>]

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

--all-projects¶: Show detail for all projects (admin only) (defaults to False)

--long¶: List additional fields in output

--status <status>¶: Filters results by a status (“available”, “error”, “creating”, “deleting” or “error_deleting”)

--consistency-group <consistency-group>¶: Filters results by a consistency group (name or ID)

consistency group snapshot show¶

Display consistency group snapshot details

openstack consistency group snapshot show <consistency-group-snapshot>

consistency-group-snapshot¶: Consistency group snapshot to display (name or ID)

consistency group¶

consistency group add volume¶

Add volume(s) to consistency group

openstack consistency group add volume
    <consistency-group>
    <volume>
    [<volume> ...]

consistency-group¶: Consistency group to contain <volume> (name or ID)

volume¶: Volume(s) to add to <consistency-group> (name or ID) (repeat option to add multiple volumes)

consistency group create¶

Create new consistency group.

openstack consistency group create
    (--volume-type <volume-type> | --source <consistency-group> | --snapshot <consistency-group-snapshot>)
    [--description <description>]
    [--availability-zone <availability-zone>]
    [<name>]

--volume-type <volume-type>¶: Volume type of this consistency group (name or ID)

--source <consistency-group>¶: Existing consistency group (name or ID)

--snapshot <consistency-group-snapshot>¶: Existing consistency group snapshot (name or ID)

--description <description>¶: Description of this consistency group

--availability-zone <availability-zone>¶: Availability zone for this consistency group (not available if creating consistency group from source)

name¶: Name of new consistency group (default to None)

consistency group delete¶

Delete consistency group(s).

openstack consistency group delete
    [--force]
    <consistency-group>
    [<consistency-group> ...]

--force¶: Allow delete in state other than error or available

consistency-group¶: Consistency group(s) to delete (name or ID)

consistency group list¶

List consistency groups.

openstack consistency group list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--all-projects]
    [--long]

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

--all-projects¶: Show details for all projects. Admin only. (defaults to False)

--long¶: List additional fields in output

consistency group remove volume¶

Remove volume(s) from consistency group

openstack consistency group remove volume
    <consistency-group>
    <volume>
    [<volume> ...]

consistency-group¶: Consistency group containing <volume> (name or ID)

volume¶: Volume(s) to remove from <consistency-group> (name or ID) (repeat option to remove multiple volumes)

consistency group set¶

Set consistency group properties

openstack consistency group set
    [--name <name>]
    [--description <description>]
    <consistency-group>

--name <name>¶: New consistency group name

--description <description>¶: New consistency group description

consistency-group¶: Consistency group to modify (name or ID)

consistency group show¶

Display consistency group details.

openstack consistency group show <consistency-group>

consistency-group¶: Consistency group to display (name or ID)

volume attachment¶

volume attachment complete¶

Complete an attachment for a volume.

openstack volume attachment complete <attachment>

attachment¶: ID of volume attachment to mark as completed

volume attachment create¶

Create an attachment for a volume.

This command will only create a volume attachment in the Volume service. It will not invoke the necessary Compute service actions to actually attach the volume to the server at the hypervisor level. As a result, it should typically only be used for troubleshooting issues with an existing server in combination with other tooling. For all other use cases, the ‘server add volume’ command should be preferred.

openstack volume attachment create
    [--connect]
    [--no-connect]
    [--initiator <initiator>]
    [--ip <ip>]
    [--host <host>]
    [--platform <platform>]
    [--os-type <ostype>]
    [--multipath]
    [--no-multipath]
    [--mountpoint <mountpoint>]
    [--mode <mode>]
    <volume>
    <server>

--connect¶: Make an active connection using provided connector info

--no-connect¶: Do not make an active connection using provided connector info

--initiator <initiator>¶: IQN of the initiator attaching to

--ip <ip>¶: IP of the system attaching to

--host <host>¶: Name of the host attaching to

--platform <platform>¶: Platform type

--os-type <ostype>¶: OS type

--multipath¶: Use multipath

--no-multipath¶: Use multipath

--mountpoint <mountpoint>¶: Mountpoint volume will be attached at

--mode <mode>¶: Mode of volume attachment, rw, ro and null, where null indicates we want to honor any existing admin-metadata settings (supported by –os-volume-api-version 3.54 or later)

volume¶: Name or ID of volume to attach to server.

server¶: Name or ID of server to attach volume to.

volume attachment delete¶

Delete an attachment for a volume.

Similarly to the ‘volume attachment create’ command, this command will only delete the volume attachment record in the Volume service. It will not invoke the necessary Compute service actions to actually attach the volume to the server at the hypervisor level. As a result, it should typically only be used for troubleshooting issues with an existing server in combination with other tooling. For all other use cases, the ‘server volume remove’ command should be preferred.

openstack volume attachment delete <attachment>

attachment¶: ID of volume attachment to delete

volume attachment list¶

Lists all volume attachments.

openstack volume attachment list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--project <project>]
    [--project-domain <project-domain>]
    [--all-projects]
    [--volume-id <volume-id>]
    [--status <status>]
    [--limit <limit>]
    [--marker <marker>]
    [--max-items <max-items>]

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

--project <project>¶: Filter results by project (name or ID) (admin only)

--project-domain <project-domain>¶: Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.

--all-projects¶: Shows details for all projects (admin only).

--volume-id <volume-id>¶: Filters results by a volume ID. This option is deprecated. Consider using the ‘–filters’ option which was introduced in microversion 3.33 instead.

--status <status>¶: Filters results by a status. This option is deprecated. Consider using the ‘–filters’ option which was introduced in microversion 3.33 instead.

--limit <limit>¶: The maximum number of entries to return per page. If the value exceeds the server-defined maximum, then the server-defined value will be used. Note that this controls the page size, not the total number of entries returned. Use –max-items to limit the total number of entries returned.

--marker <marker>¶: The first position in the collection to return results from. This should be a value that was returned in a previous request.

--max-items <max-items>¶: The maximum number of entries to return in total, paging through multiple requests if needed. Use –limit to control the page size.

volume attachment set¶

Update an attachment for a volume.

This call is designed to be more of an volume 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.

openstack volume attachment set
    [--initiator <initiator>]
    [--ip <ip>]
    [--host <host>]
    [--platform <platform>]
    [--os-type <ostype>]
    [--multipath]
    [--no-multipath]
    [--mountpoint <mountpoint>]
    <attachment>

--initiator <initiator>¶: IQN of the initiator attaching to

--ip <ip>¶: IP of the system attaching to

--host <host>¶: Name of the host attaching to

--platform <platform>¶: Platform type

--os-type <ostype>¶: OS type

--multipath¶: Use multipath

--no-multipath¶: Use multipath

--mountpoint <mountpoint>¶: Mountpoint volume will be attached at

attachment¶: ID of volume attachment.

volume attachment show¶

Show detailed information for a volume attachment.

openstack volume attachment show <attachment>

attachment¶: ID of volume attachment.

volume backend¶

volume backend capability show¶

Show capability command

openstack volume backend capability show
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    <host>

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

host¶: List capabilities of specified host (host@backend-name)

volume backend pool list¶

List pool command

openstack volume backend pool list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--long]

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

--long¶: Show detailed information about pools.

volume backup¶

volume backup create¶

Create new volume backup

openstack volume backup create
    [--name <name>]
    [--description <description>]
    [--container <container>]
    [--snapshot <snapshot>]
    [--force]
    [--incremental]
    [--no-incremental]
    [--property <key=value>]
    [--availability-zone <zone-name>]
    <volume>

--name <name>¶: Name of the backup

--description <description>¶: Description of the backup

--container <container>¶: Optional backup container name

--snapshot <snapshot>¶: Snapshot to backup (name or ID)

--force¶: Allow to back up an in-use volume

--incremental¶: Perform an incremental backup

--no-incremental¶: Do not perform an incremental backup

--property <key=value>¶: Set a property on this backup (repeat option to remove multiple values) (supported by –os-volume-api-version 3.43 or above)

--availability-zone <zone-name>¶: AZ where the backup should be stored; by default it will be the same as the source (supported by –os-volume-api-version 3.51 or above)

volume¶: Volume to backup (name or ID)

volume backup delete¶

Delete volume backup(s)

openstack volume backup delete [--force] <backup> [<backup> ...]

--force¶: Allow delete in state other than error or available

backup¶: Backup(s) to delete (name or ID)

volume backup list¶

List volume backups

openstack volume backup list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--project <project>]
    [--long]
    [--name <name>]
    [--status <status>]
    [--volume <volume>]
    [--limit <limit>]
    [--marker <marker>]
    [--max-items <max-items>]
    [--all-projects]

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

--project <project>¶: Filter results by project (name or ID) (admin only)

--long¶: List additional fields in output

--name <name>¶: Filters results by the backup name

--status <status>¶: Filters results by the backup status, one of: creating, available, deleting, error, restoring or error_restoring

--volume <volume>¶: Filters results by the volume which they backup (name or ID)

--limit <limit>¶: The maximum number of entries to return per page. If the value exceeds the server-defined maximum, then the server-defined value will be used. Note that this controls the page size, not the total number of entries returned. Use –max-items to limit the total number of entries returned.

--marker <marker>¶: The first position in the collection to return results from. This should be a value that was returned in a previous request.

--max-items <max-items>¶: The maximum number of entries to return in total, paging through multiple requests if needed. Use –limit to control the page size.

--all-projects¶: Include all projects (admin only)

volume backup record export¶

Export volume backup details.

Backup information can be imported into a new service instance to be able to restore.

openstack volume backup record export <backup>

backup¶: Backup to export (name or ID)

volume backup record import¶

Import volume backup details.

Exported backup details contain the metadata necessary to restore to a new or rebuilt service instance

openstack volume backup record import
    <backup_service>
    <backup_metadata>

backup_service¶: Backup service containing the backup.

backup_metadata¶: Encoded backup metadata from export.

volume backup restore¶

Restore volume backup

openstack volume backup restore [--force] <backup> [<volume>]

--force¶: Restore the backup to an existing volume (default to False)

backup¶: Backup to restore (name or ID)

volume¶: Volume to restore to (name or ID for existing volume, name only for new volume) (default to None)

volume backup set¶

Set volume backup properties

openstack volume backup set
    [--name <name>]
    [--description <description>]
    [--state <state>]
    [--no-property]
    [--property <key=value>]
    <backup>

--name <name>¶: New backup name (supported by –os-volume-api-version 3.9 or above)

--description <description>¶: New backup description (supported by –os-volume-api-version 3.9 or above)

--state <state>¶: New backup state (“available” or “error”) (admin only) (This option simply changes the state of the backup in the database with no regard to actual status; exercise caution when using)

--no-property¶: Remove all properties from this backup (specify both –no-property and –property to remove the current properties before setting new properties)

--property <key=value>¶: Set a property on this backup (repeat option to set multiple values) (supported by –os-volume-api-version 3.43 or above)

backup¶: Backup to modify (name or ID)

volume backup show¶

Display volume backup details

openstack volume backup show <backup>

backup¶: Backup to display (name or ID)

volume backup unset¶

Unset volume backup properties.

This command requires --os-volume-api-version 3.43 or greater.

openstack volume backup unset [--property <key>] <backup>

--property <key>¶: Property to remove from this backup (repeat option to unset multiple values)

backup¶: Backup to modify (name or ID)

volume group snapshot¶

volume group snapshot create¶

Create a volume group snapshot.

This command requires --os-volume-api-version 3.13 or greater.

openstack volume group snapshot create
    [--name <name>]
    [--description <description>]
    <volume_group>

--name <name>¶: Name of the volume group snapshot.

--description <description>¶: Description of a volume group snapshot.

volume_group¶: Name or ID of volume group to create a snapshot of.

volume group snapshot delete¶

Delete a volume group snapshot.

This command requires --os-volume-api-version 3.14 or greater.

openstack volume group snapshot delete <snapshot>

snapshot¶: Name or ID of volume group snapshot to delete

volume group snapshot list¶

Lists all volume group snapshot.

This command requires --os-volume-api-version 3.14 or greater.

openstack volume group snapshot list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--all-projects]

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

--all-projects¶: Shows details for all projects (admin only).

volume group snapshot show¶

Show detailed information for a volume group snapshot.

This command requires --os-volume-api-version 3.14 or greater.

openstack volume group snapshot show <snapshot>

snapshot¶: Name or ID of volume group snapshot.

volume group type¶

volume group type create¶

Create a volume group type.

This command requires --os-volume-api-version 3.11 or greater.

openstack volume group type create
    [--description <description>]
    [--public | --private]
    <name>

--description <description>¶: Description of the volume group type.

--public¶: Volume group type is available to other projects (default)

--private¶: Volume group type is not available to other projects

name¶: Name of new volume group type.

volume group type delete¶

Delete a volume group type.

This command requires --os-volume-api-version 3.11 or greater.

openstack volume group type delete <group_type>

group_type¶: Name or ID of volume group type to delete

volume group type list¶

Lists all volume group types.

This command requires --os-volume-api-version 3.11 or greater.

openstack volume group type list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--default]

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

--default¶: List the default volume group type.

volume group type set¶

Update a volume group type.

This command requires --os-volume-api-version 3.11 or greater.

openstack volume group type set
    [--name <name>]
    [--description <description>]
    [--public | --private]
    [--no-property]
    [--property <key=value>]
    <group_type>

--name <name>¶: New name for volume group type.

--description <description>¶: New description for volume group type.

--public¶: Make volume group type available to other projects.

--private¶: Make volume group type unavailable to other projects.

--no-property¶: Remove all properties from this volume group type (specify both –no-property and –property to remove the current properties before setting new properties)

--property <key=value>¶: Property to add or modify for this volume group type (repeat option to set multiple properties)

group_type¶: Name or ID of volume group type.

volume group type show¶

Show detailed information for a volume group type.

This command requires --os-volume-api-version 3.11 or greater.

openstack volume group type show <group_type>

group_type¶: Name or ID of volume group type.

volume group¶

volume group create¶

Create a volume group.

Generic volume groups enable you to create a group of volumes and manage them together.

Generic volume groups are more flexible than consistency groups. Currently volume consistency groups only support consistent group snapshot. It cannot be extended easily to serve other purposes. A project may want to put volumes used in the same application together in a group so that it is easier to manage them together, and this group of volumes may or may not support consistent group snapshot. Generic volume group solve this problem. By decoupling the tight relationship between the group construct and the consistency concept, generic volume groups can be extended to support other features in the future.

This command requires --os-volume-api-version 3.13 or greater.

openstack volume group create
    [--volume-group-type <volume_group_type>]
    [--volume-type <volume_type>]
    [--source-group <source-group>]
    [--group-snapshot <group-snapshot>]
    [--name <name>]
    [--description <description>]
    [--availability-zone <availability-zone>]

--volume-group-type <volume_group_type>¶: Volume group type to use (name or ID)

--volume-type <volume_type>¶: Volume type(s) to use (name or ID) (required with –volume-group-type)

--source-group <source-group>¶: Existing volume group to use (name or ID) (supported by –os-volume-api-version 3.14 or later)

--group-snapshot <group-snapshot>¶: Existing group snapshot to use (name or ID) (supported by –os-volume-api-version 3.14 or later)

--name <name>¶: Name of the volume group.

--description <description>¶: Description of a volume group.

--availability-zone <availability-zone>¶: Availability zone for volume group. (not available if creating group from source)

volume group delete¶

Delete a volume group.

This command requires --os-volume-api-version 3.13 or greater.

openstack volume group delete [--force] <group>

--force¶: Delete the volume group even if it contains volumes. This will delete any remaining volumes in the group.

group¶: Name or ID of volume group to delete

volume group list¶

Lists all volume groups.

This command requires --os-volume-api-version 3.13 or greater.

openstack volume group list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--all-projects]

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

--all-projects¶: Shows details for all projects (admin only).

volume group failover¶

Failover replication for a volume group.

This command requires --os-volume-api-version 3.38 or greater.

openstack volume group failover
    [--allow-attached-volume]
    [--disallow-attached-volume]
    [--secondary-backend-id <backend_id>]
    <group>

--allow-attached-volume¶: Allow group with attached volumes to be failed over.

--disallow-attached-volume¶: Disallow group with attached volumes to be failed over.

--secondary-backend-id <backend_id>¶: Secondary backend ID.

group¶: Name or ID of volume group to failover replication for.

volume group set¶

Update a volume group.

This command requires --os-volume-api-version 3.13 or greater.

openstack volume group set
    [--name <name>]
    [--description <description>]
    [--enable-replication | --disable-replication]
    <group>

--name <name>¶: New name for group.

--description <description>¶: New description for group.

--enable-replication¶: Enable replication for group. (supported by –os-volume-api-version 3.38 or above)

--disable-replication¶: Disable replication for group. (supported by –os-volume-api-version 3.38 or above)

group¶: Name or ID of volume group.

volume group show¶

Show detailed information for a volume group.

This command requires --os-volume-api-version 3.13 or greater.

openstack volume group show
    [--volumes]
    [--no-volumes]
    [--replication-targets]
    [--no-replication-targets]
    <group>

--volumes¶: Show volumes included in the group. (supported by –os-volume-api-version 3.25 or above)

--no-volumes¶: Do not show volumes included in the group. (supported by –os-volume-api-version 3.25 or above)

--replication-targets¶: Show replication targets for the group. (supported by –os-volume-api-version 3.38 or above)

--no-replication-targets¶: Do not show replication targets for the group. (supported by –os-volume-api-version 3.38 or above)

group¶: Name or ID of volume group.

volume host¶

volume host failover¶

Failover volume host to different backend

openstack volume host failover
    --volume-backend <backend-id>
    <host-name>

--volume-backend <backend-id>¶: The ID of the volume backend replication target where the host will failover to (required)

host-name¶: Name of volume host

volume host set¶

Set volume host properties

openstack volume host set [--disable | --enable] <host-name>

--disable¶: Freeze and disable the specified volume host

--enable¶: Thaw and enable the specified volume host

host-name¶: Name of volume host

volume message¶

volume message delete¶

Delete a volume failure message

openstack volume message delete <message-id> [<message-id> ...]

message-id¶: Message(s) to delete (ID)

volume message list¶

List volume failure messages

openstack volume message list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--project <project>]
    [--project-domain <project-domain>]
    [--limit <limit>]
    [--marker <marker>]

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

--project <project>¶: Filter results by project (name or ID) (admin only)

--project-domain <project-domain>¶: Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.

--limit <limit>¶: The maximum number of entries to return per page. If the value exceeds the server-defined maximum, then the server-defined value will be used. Note that this controls the page size, not the total number of entries returned. Use –max-items to limit the total number of entries returned.

--marker <marker>¶: The first position in the collection to return results from. This should be a value that was returned in a previous request.

volume message show¶

Show a volume failure message

openstack volume message show <message-id>

message-id¶: Message to show (ID).

volume qos¶

volume qos associate¶

Associate a QoS specification to a volume type

openstack volume qos associate <qos-spec> <volume-type>

qos-spec¶: QoS specification to modify (name or ID)

volume-type¶: Volume type to associate the QoS (name or ID)

volume qos create¶

Create new QoS specification

openstack volume qos create
    [--consumer <consumer>]
    [--property <key=value>]
    <name>

--consumer <consumer>¶: Consumer of the QoS. Valid consumers: back-end, both, front-end (defaults to ‘both’)

--property <key=value>¶: Set a QoS specification property (repeat option to set multiple properties)

name¶: New QoS specification name

volume qos delete¶

Delete QoS specification

openstack volume qos delete [--force] <qos-spec> [<qos-spec> ...]

--force¶: Allow to delete in-use QoS specification(s)

qos-spec¶: QoS specification(s) to delete (name or ID)

volume qos disassociate¶

Disassociate a QoS specification from a volume type

openstack volume qos disassociate
    [--volume-type <volume-type> | --all]
    <qos-spec>

--volume-type <volume-type>¶: Volume type to disassociate the QoS from (name or ID)

--all¶: Disassociate the QoS from every volume type

qos-spec¶: QoS specification to modify (name or ID)

volume qos list¶

List QoS specifications

openstack volume qos list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

volume qos set¶

Set QoS specification properties

openstack volume qos set
    [--no-property]
    [--property <key=value>]
    <qos-spec>

--no-property¶: Remove all properties from <qos-spec> (specify both –no-property and –property to remove the current properties before setting new properties)

--property <key=value>¶: Property to add or modify for this QoS specification (repeat option to set multiple properties)

qos-spec¶: QoS specification to modify (name or ID)

volume qos show¶

Display QoS specification details

openstack volume qos show <qos-spec>

qos-spec¶: QoS specification to display (name or ID)

volume qos unset¶

Unset QoS specification properties

openstack volume qos unset [--property <key>] <qos-spec>

--property <key>¶: Property to remove from the QoS specification. (repeat option to unset multiple properties)

qos-spec¶: QoS specification to modify (name or ID)

volume service¶

volume service list¶

List service command

openstack volume service list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--host <host>]
    [--service <service>]
    [--long]

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

--host <host>¶: List services on specified host (name only)

--service <service>¶: List only specified service (name only)

--long¶: List additional fields in output

volume service set¶

Set volume service properties

openstack volume service set
    [--enable | --disable]
    [--disable-reason <reason>]
    <host>
    <service>

--enable¶: Enable volume service

--disable¶: Disable volume service

--disable-reason <reason>¶: Reason for disabling the service (should be used with –disable option)

host¶: Name of host

service¶: Name of service (Binary name)

volume snapshot¶

volume snapshot create¶

Create new volume snapshot

openstack volume snapshot create
    [--volume <volume>]
    [--description <description>]
    [--force]
    [--property <key=value>]
    [--remote-source <key=value>]
    <snapshot-name>

--volume <volume>¶: Volume to snapshot (name or ID) (default is <snapshot-name>)

--description <description>¶: Description of the snapshot

--force¶: Allow snapshot of in-use (attached) volume. Only needed for microversions prior to 3.66; ignored for 3.66+

--property <key=value>¶: Set a property to this snapshot (repeat option to set multiple properties)

--remote-source <key=value>¶: The attribute(s) of the existing remote volume snapshot (admin required) (repeat option to specify multiple attributes) e.g.: ‘–remote-source source-name=test_name –remote-source source-id=test_id’

snapshot-name¶: Name of the new snapshot

volume snapshot delete¶

Delete volume snapshot(s)

openstack volume snapshot delete
    [--force]
    [--remote]
    <snapshot>
    [<snapshot> ...]

--force¶: Attempt forced removal of snapshot(s), regardless of state (defaults to False)

--remote¶: Unmanage the snapshot, removing it from the Block Storage service management but not from the backend.

snapshot¶: Snapshot(s) to delete (name or ID)

volume snapshot list¶

List volume snapshots

openstack volume snapshot list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--all-projects]
    [--project <project>]
    [--project-domain <project-domain>]
    [--long]
    [--name <name>]
    [--status <status>]
    [--volume <volume>]
    [--limit <limit>]
    [--marker <marker>]
    [--max-items <max-items>]

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

--all-projects¶: Include all projects (admin only)

--project <project>¶: Filter results by project (name or ID) (admin only)

--project-domain <project-domain>¶: Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.

--long¶: List additional fields in output

--name <name>¶: Filters results by a name.

--status <status>¶: Filters results by a status. (‘available’, ‘error’, ‘creating’, ‘deleting’ or ‘error_deleting’)

--volume <volume>¶: Filters results by a volume (name or ID).

--limit <limit>¶: The maximum number of entries to return per page. If the value exceeds the server-defined maximum, then the server-defined value will be used. Note that this controls the page size, not the total number of entries returned. Use –max-items to limit the total number of entries returned.

--marker <marker>¶: The first position in the collection to return results from. This should be a value that was returned in a previous request.

--max-items <max-items>¶: The maximum number of entries to return in total, paging through multiple requests if needed. Use –limit to control the page size.

volume snapshot set¶

Set volume snapshot properties

openstack volume snapshot set
    [--name <name>]
    [--description <description>]
    [--no-property]
    [--property <key=value>]
    [--state <state>]
    <snapshot>

--name <name>¶: New snapshot name

--description <description>¶: New snapshot description

--no-property¶: Remove all properties from <snapshot> (specify both –no-property and –property to remove the current properties before setting new properties.)

--property <key=value>¶: Property to add/change for this snapshot (repeat option to set multiple properties)

--state <state>¶: New snapshot state. (“available”, “error”, “creating”, “deleting”, or “error_deleting”) (admin only) (This option simply changes the state of the snapshot in the database with no regard to actual status, exercise caution when using)

snapshot¶: Snapshot to modify (name or ID)

volume snapshot show¶

Display volume snapshot details

openstack volume snapshot show <snapshot>

snapshot¶: Snapshot to display (name or ID)

volume snapshot unset¶

Unset volume snapshot properties

openstack volume snapshot unset [--property <key>] <snapshot>

--property <key>¶: Property to remove from snapshot (repeat option to remove multiple properties)

snapshot¶: Snapshot to modify (name or ID)

volume transfer request¶

volume transfer request accept¶

Accept volume transfer request.

openstack volume transfer request accept
    --auth-key <key>
    <transfer-request-id>

--auth-key <key>¶: Volume transfer request authentication key

transfer-request-id¶: Volume transfer request to accept (ID only)

volume transfer request create¶

Create volume transfer request.

openstack volume transfer request create
    [--name <name>]
    [--snapshots]
    [--no-snapshots]
    <volume>

--name <name>¶: New transfer request name (default to None)

--snapshots¶: Allow transfer volumes without snapshots (default) (supported by –os-volume-api-version 3.55 or later)

--no-snapshots¶: Disallow transfer volumes without snapshots (supported by –os-volume-api-version 3.55 or later)

volume¶: Volume to transfer (name or ID)

volume transfer request delete¶

Delete volume transfer request(s).

openstack volume transfer request delete
    <transfer-request>
    [<transfer-request> ...]

transfer-request¶: Volume transfer request(s) to delete (name or ID)

volume transfer request list¶

Lists all volume transfer requests.

openstack volume transfer request list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--all-projects]

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

--all-projects¶: Include all projects (admin only)

volume transfer request show¶

Show volume transfer request details.

openstack volume transfer request show <transfer-request>

transfer-request¶: Volume transfer request to display (name or ID)

volume type¶

volume type create¶

Create new volume type

openstack volume type create
    [--description <description>]
    [--public | --private]
    [--property <key=value>]
    [--multiattach]
    [--cacheable]
    [--replicated]
    [--availability-zone AVAILABILITY_ZONES]
    [--project <project>]
    [--project-domain <project-domain>]
    [--encryption-provider <provider>]
    [--encryption-cipher <cipher>]
    [--encryption-key-size <key-size>]
    [--encryption-control-location <control-location>]
    <name>

--description <description>¶: Volume type description

--public¶: Volume type is accessible to the public

--private¶: Volume type is not accessible to the public

--property <key=value>¶: Set a property on this volume type (repeat option to set multiple properties)

--multiattach¶: Enable multi-attach for this volume type (this is an alias for ‘–property multiattach=<is> True’) (requires driver support)

--cacheable¶: Enable caching for this volume type (this is an alias for ‘–property cacheable=<is> True’) (requires driver support)

--replicated¶: Enabled replication for this volume type (this is an alias for ‘–property replication_enabled=<is> True’) (requires driver support)

--availability-zone <AVAILABILITY_ZONES>¶: Set an availability zone for this volume type (this is an alias for ‘–property RESKEY:availability_zones:<az>’) (repeat option to set multiple availability zones)

--project <project>¶: Allow <project> to access private type (name or ID) (must be used with –private option)

--project-domain <project-domain>¶: Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.

--encryption-provider <provider>¶: Set the encryption provider format for this volume type (e.g “luks” or “plain”) (admin only) (this option is required when setting encryption type of a volume; consider using other encryption options such as: “–encryption-cipher”, “–encryption-key-size” and “–encryption-control-location”)

--encryption-cipher <cipher>¶: Set the encryption algorithm or mode for this volume type (e.g “aes-xts-plain64”) (admin only)

--encryption-key-size <key-size>¶: Set the size of the encryption key of this volume type (e.g “128” or “256”) (admin only)

--encryption-control-location <control-location>¶: Set the notional service where the encryption is performed (“front-end” or “back-end”) (admin only) (The default value for this option is “front-end” when setting encryption type of a volume. Consider using other encryption options such as: “–encryption-cipher”, “–encryption-key-size” and “–encryption-provider”)

name¶: Volume type name

volume type delete¶

Delete volume type(s)

openstack volume type delete <volume-type> [<volume-type> ...]

volume-type¶: Volume type(s) to delete (name or ID)

volume type list¶

List volume types

openstack volume type list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--long]
    [--default | --public | --private]
    [--encryption-type]
    [--property <key=value>]
    [--multiattach]
    [--cacheable]
    [--replicated]
    [--availability-zone AVAILABILITY_ZONES]

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

--long¶: List additional fields in output

--default¶: List the default volume type

--public¶: List only public types

--private¶: List only private types (admin only)

--encryption-type¶: Display encryption information for each volume type (admin only)

--property <key=value>¶: Filter by a property on the volume types (repeat option to filter by multiple properties) (admin only except for user-visible extra specs) (supported by –os-volume-api-version 3.52 or above)

--multiattach¶: List only volume types with multi-attach enabled (this is an alias for ‘–property multiattach=<is> True’) (supported by –os-volume-api-version 3.52 or above)

--cacheable¶: List only volume types with caching enabled (this is an alias for ‘–property cacheable=<is> True’) (admin only) (supported by –os-volume-api-version 3.52 or above)

--replicated¶: List only volume types with replication enabled (this is an alias for ‘–property replication_enabled=<is> True’) (supported by –os-volume-api-version 3.52 or above)

--availability-zone <AVAILABILITY_ZONES>¶: List only volume types with this availability configured (this is an alias for ‘–property RESKEY:availability_zones:<az>’) (repeat option to filter on multiple availability zones)

volume type set¶

Set volume type properties

openstack volume type set
    [--name <name>]
    [--description <description>]
    [--property <key=value>]
    [--multiattach]
    [--cacheable]
    [--replicated]
    [--availability-zone AVAILABILITY_ZONES]
    [--project <project>]
    [--public | --private]
    [--project-domain <project-domain>]
    [--encryption-provider <provider>]
    [--encryption-cipher <cipher>]
    [--encryption-key-size <key-size>]
    [--encryption-control-location <control-location>]
    <volume-type>

--name <name>¶: Set volume type name

--description <description>¶: Set volume type description

--property <key=value>¶: Set a property on this volume type (repeat option to set multiple properties)

--multiattach¶: Enable multi-attach for this volume type (this is an alias for ‘–property multiattach=<is> True’) (requires driver support)

--cacheable¶: Enable caching for this volume type (this is an alias for ‘–property cacheable=<is> True’) (requires driver support)

--replicated¶: Enabled replication for this volume type (this is an alias for ‘–property replication_enabled=<is> True’) (requires driver support)

--availability-zone <AVAILABILITY_ZONES>¶: Set an availability zone for this volume type (this is an alias for ‘–property RESKEY:availability_zones:<az>’) (repeat option to set multiple availability zones)

--project <project>¶: Set volume type access to project (name or ID) (admin only)

--public¶: Volume type is accessible to the public

--private¶: Volume type is not accessible to the public

--project-domain <project-domain>¶: Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.

--encryption-provider <provider>¶: Set the encryption provider format for this volume type (e.g “luks” or “plain”) (admin only) (This option is required when setting encryption type of a volume for the first time. Consider using other encryption options such as: “–encryption-cipher”, “–encryption-key-size” and “–encryption-control-location”)

--encryption-cipher <cipher>¶: Set the encryption algorithm or mode for this volume type (e.g “aes-xts-plain64”) (admin only)

--encryption-key-size <key-size>¶: Set the size of the encryption key of this volume type (e.g “128” or “256”) (admin only)

--encryption-control-location <control-location>¶: Set the notional service where the encryption is performed (“front-end” or “back-end”) (admin only) (The default value for this option is “front-end” when setting encryption type of a volume for the first time. Consider using other encryption options such as: “–encryption-cipher”, “–encryption-key-size” and “–encryption-provider”)

volume-type¶: Volume type to modify (name or ID)

volume type show¶

Display volume type details

openstack volume type show [--encryption-type] <volume-type>

--encryption-type¶: Display encryption information of this volume type (admin only)

volume-type¶: Volume type to display (name or ID)

volume type unset¶

Unset volume type properties

openstack volume type unset
    [--property <key>]
    [--project <project>]
    [--project-domain <project-domain>]
    [--encryption-type]
    <volume-type>

--property <key>¶: Remove a property from this volume type (repeat option to remove multiple properties)

--project <project>¶: Removes volume type access to project (name or ID) (admin only)

--project-domain <project-domain>¶: Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.

--encryption-type¶: Remove the encryption type for this volume type (admin only)

volume-type¶: Volume type to modify (name or ID)

volume¶

volume create¶

Create new volume

openstack volume create
    [--size <size>]
    [--type <volume-type>]
    [--image <image> | --snapshot <snapshot> | --source <volume> | --backup <backup> | --remote-source <key=value>]
    [--description <description>]
    [--availability-zone <availability-zone>]
    [--consistency-group consistency-group>]
    [--property <key=value>]
    [--hint <key=value>]
    [--bootable | --non-bootable]
    [--read-only | --read-write]
    [--host <host>]
    [--cluster <cluster>]
    [<name>]

--size <size>¶: Volume size in GB (required unless –snapshot or –source specified)

--type <volume-type>¶: Set the type of volume

--image <image>¶: Use <image> as source of volume (name or ID)

--snapshot <snapshot>¶: Use <snapshot> as source of volume (name or ID)

--source <volume>¶: Volume to clone (name or ID)

--backup <backup>¶: Restore backup to a volume (name or ID) (supported by –os-volume-api-version 3.47 or later)

--remote-source <key=value>¶: The attribute(s) of the existing remote volume (admin required) (repeat option to specify multiple attributes, e.g.: ‘–remote-source source-name=test_name –remote-source source-id=test_id’)

--description <description>¶: Volume description

--availability-zone <availability-zone>¶: Create volume in <availability-zone>

--consistency-group consistency-group>¶: Consistency group where the new volume belongs to

--property <key=value>¶: Set a property to this volume (repeat option to set multiple properties)

--hint <key=value>¶: Arbitrary scheduler hint key-value pairs to help creating a volume. Repeat the option to set multiple hints. ‘same_host’ and ‘different_host’ get values appended when repeated, all other keys take the last given value

--bootable¶: Mark volume as bootable

--non-bootable¶: Mark volume as non-bootable (default)

--read-only¶: Set volume to read-only access mode

--read-write¶: Set volume to read-write access mode (default)

--host <host>¶: Cinder host on which the existing volume resides; takes the form: host@backend-name#pool. This is only used along with the –remote-source option.

--cluster <cluster>¶: Cinder cluster on which the existing volume resides; takes the form: cluster@backend-name#pool. This is only used along with the –remote-source option. (supported by –os-volume-api-version 3.16 or above)

name¶: Volume name

volume delete¶

Delete volume(s)

openstack volume delete
    [--force | --cascade]
    [--remote]
    <volume>
    [<volume> ...]

--force¶: Attempt forced removal of volume(s), regardless of state (defaults to False)

--cascade¶: Remove any snapshots along with volume(s) (defaults to False)

--remote¶: Specify this parameter to unmanage a volume.

volume¶: Volume(s) to delete (name or ID)

volume list¶

List volumes

openstack volume list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--project <project>]
    [--project-domain <project-domain>]
    [--user <user>]
    [--user-domain <user-domain>]
    [--name <name>]
    [--status <status>]
    [--property <key=value>]
    [--all-projects]
    [--long]
    [--limit <limit>]
    [--marker <marker>]

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

--project <project>¶: Filter results by project (name or ID) (admin only)

--project-domain <project-domain>¶: Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.

--user <user>¶: Filter results by user (name or ID) (admin only)

--user-domain <user-domain>¶: Domain the user belongs to (name or ID). This can be used in case collisions between user names exist.

--name <name>¶: Filter results by volume name

--status <status>¶: Filter results by status

--property <key=value>¶: Filter by a property on the volume list (repeat option to filter by multiple properties)

--all-projects¶: Include all projects (admin only)

--long¶: List additional fields in output

--limit <limit>¶: The maximum number of entries to return per page. If the value exceeds the server-defined maximum, then the server-defined value will be used. Note that this controls the page size, not the total number of entries returned. Use –max-items to limit the total number of entries returned.

--marker <marker>¶: The first position in the collection to return results from. This should be a value that was returned in a previous request.

volume migrate¶

Migrate volume to a new host

openstack volume migrate
    (--host <host> | --cluster <cluster>)
    [--force-host-copy]
    [--lock-volume]
    <volume>

--host <host>¶: Destination host (takes the form: host@backend-name#pool)

--cluster <cluster>¶: Destination cluster to migrate the volume to (requires –os-volume-api-version 3.16 or higher)

--force-host-copy¶: Enable generic host-based force-migration, which bypasses driver optimizations

--lock-volume¶: If specified, the volume state will be locked and will not allow a migration to be aborted (possibly by another operation)

volume¶: Volume to migrate (name or ID)

volume set¶

Set volume properties

openstack volume set
    [--name <name>]
    [--size <size>]
    [--description <description>]
    [--no-property]
    [--property <key=value>]
    [--image-property <key=value>]
    [--state <state>]
    [--attached | --detached]
    [--type <volume-type>]
    [--migration-policy <migration-policy>]
    [--bootable | --non-bootable]
    [--read-only | --read-write]
    <volume>

--name <name>¶: New volume name

--size <size>¶: Extend volume size in GB

--description <description>¶: New volume description

--no-property¶: Remove all properties from <volume> (specify both –no-property and –property to remove the current properties before setting new properties.)

--property <key=value>¶: Set a property on this volume (repeat option to set multiple properties)

--image-property <key=value>¶: Set an image property on this volume (repeat option to set multiple image properties)

--state <state>¶: New volume state (“available”, “error”, “creating”, “deleting”, “in-use”, “attaching”, “detaching”, “error_deleting” or “maintenance”) (admin only) (This option simply changes the state of the volume in the database with no regard to actual status, exercise caution when using)

--attached¶: Set volume attachment status to “attached” (admin only) (This option simply changes the state of the volume in the database with no regard to actual status, exercise caution when using)

--detached¶: Set volume attachment status to “detached” (admin only) (This option simply changes the state of the volume in the database with no regard to actual status, exercise caution when using)

--type <volume-type>¶: New volume type (name or ID)

--migration-policy <migration-policy>¶: Migration policy while re-typing volume (“never” or “on-demand”, default is “never” ) (available only when –type option is specified)

--bootable¶: Mark volume as bootable

--non-bootable¶: Mark volume as non-bootable

--read-only¶: Set volume to read-only access mode

--read-write¶: Set volume to read-write access mode

volume¶: Volume to modify (name or ID)

volume show¶

Display volume details

openstack volume show <volume>

volume¶: Volume to display (name or ID)

volume unset¶

Unset volume properties

openstack volume unset
    [--property <key>]
    [--image-property <key>]
    <volume>

--property <key>¶: Remove a property from volume (repeat option to remove multiple properties)

--image-property <key>¶: Remove an image property from volume (repeat option to remove multiple image properties)

volume¶: Volume to modify (name or ID)

volume summary¶

Show a summary of all volumes in this deployment.

openstack volume summary [--all-projects]

--all-projects¶: Include all projects (admin only)

volume revert¶

Revert a volume to a snapshot.

openstack volume revert <snapshot>

snapshot¶: Name or ID of the snapshot to restore. The snapshot must be the most recent one known to cinder.

Block Storage v2 Commands

Block Storage v2 Commands¶

block storage¶

block storage cleanup¶

block storage cluster¶

block storage cluster list¶

block storage cluster set¶

block storage cluster show¶

Block Storage Log Level¶

block storage log level list¶

block storage log level set¶

Block Storage Manage¶

block storage volume manageable list¶

block storage snapshot manageable list¶

block storage resource filter¶

block storage resource filter list¶

block storage resource filter show¶

consistency group snapshot¶

consistency group snapshot create¶

consistency group snapshot delete¶

consistency group snapshot list¶

consistency group snapshot show¶

consistency group¶

consistency group add volume¶

consistency group create¶

consistency group delete¶

consistency group list¶

consistency group remove volume¶

consistency group set¶

consistency group show¶

volume attachment¶

volume attachment complete¶

volume attachment create¶

volume attachment delete¶

volume attachment list¶

volume attachment set¶

volume attachment show¶

volume backend¶

volume backend capability show¶

volume backend pool list¶

volume backup¶

volume backup create¶

volume backup delete¶

volume backup list¶

volume backup record export¶

volume backup record import¶

volume backup restore¶

volume backup set¶

volume backup show¶

volume backup unset¶

volume group snapshot¶

volume group snapshot create¶

volume group snapshot delete¶

volume group snapshot list¶

volume group snapshot show¶

volume group type¶

volume group type create¶

volume group type delete¶

volume group type list¶

volume group type set¶

volume group type show¶

volume group¶

volume group create¶

volume group delete¶

volume group list¶

volume group failover¶

volume group set¶

volume group show¶

volume host¶

volume host failover¶

volume host set¶

volume message¶

volume message delete¶

volume message list¶

volume message show¶

volume qos¶

volume qos associate¶

volume qos create¶

volume qos delete¶

volume qos disassociate¶