Chapter 71. volume

This chapter describes the commands under the volume command.

71.1. volume backup create

Create new volume backup

Usage:

openstack volume backup create [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--noindent] [--prefix PREFIX]
                                      [--name <name>]
                                      [--description <description>]
                                      [--container <container>]
                                      [--snapshot <snapshot>] [--force]
                                      [--incremental]
                                      <volume>

Table 71.1. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

Table 71.2. Positional Arguments

ValueSummary

<volume>

Volume to backup (name or id)

Table 71.3. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 71.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 71.5. Optional Arguments

ValueSummary

--force

Allow to back up an in-use volume

--incremental

Perform an incremental backup

--name <name>

Name of the backup

--container <container>

Optional backup container name

--snapshot <snapshot>

Snapshot to backup (name or id)

-h, --help

Show this help message and exit

--description <description>

Description of the backup

Table 71.6. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

71.2. volume backup delete

Delete volume backup(s)

Usage:

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

Table 71.7. Positional Arguments

ValueSummary

<backup>

Backup(s) to delete (name or id)

Table 71.8. Optional Arguments

ValueSummary

--force

Allow delete in state other than error or available

-h, --help

Show this help message and exit

71.3. volume backup list

List volume backups

Usage:

openstack volume backup list [-h] [-f {csv,json,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--fit-width] [--print-empty] [--noindent]
                                    [--quote {all,minimal,none,nonnumeric}]
                                    [--sort-column SORT_COLUMN] [--long]
                                    [--name <name>] [--status <status>]
                                    [--volume <volume>]
                                    [--marker <volume-backup>]
                                    [--limit <num-backups>] [--all-projects]

Table 71.9. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

Table 71.10. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 71.11. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

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

Table 71.12. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 71.13. Optional Arguments

ValueSummary

--marker <volume-backup>

The last backup of the previous page (name or id)

--limit <num-backups>

Maximum number of backups to display

--all-projects

Include all projects (admin only)

--volume <volume>

Filters results by the volume which they backup (name or ID)

--long

List additional fields in output

--status <status>

Filters results by the backup status (creating, available, deleting, error, restoring or error_restoring)

--name <name>

Filters results by the backup name

-h, --help

Show this help message and exit

71.4. volume backup restore

Restore volume backup

Usage:

openstack volume backup restore [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--noindent] [--prefix PREFIX]
                                       <backup> <volume>

Table 71.14. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

Table 71.15. Positional Arguments

ValueSummary

<volume>

Volume to restore to (name or id)

<backup>

Backup to restore (name or id)

Table 71.16. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 71.17. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 71.18. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 71.19. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

71.5. volume backup set

Set volume backup properties

Usage:

openstack volume backup set [-h] [--name <name>]
                                   [--description <description>]
                                   [--state <state>]
                                   <backup>

Table 71.20. Positional Arguments

ValueSummary

<backup>

Backup to modify (name or id)

Table 71.21. Optional Arguments

ValueSummary

--name <name>

New backup name

-h, --help

Show this help message and exit

--description <description>

New backup description

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

71.6. volume backup show

Display volume backup details

Usage:

openstack volume backup show [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--fit-width] [--print-empty] [--noindent]
                                    [--prefix PREFIX]
                                    <backup>

Table 71.22. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

Table 71.23. Positional Arguments

ValueSummary

<backup>

Backup to display (name or id)

Table 71.24. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 71.25. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 71.26. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 71.27. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

71.7. volume create

Create new volume

Usage:

openstack volume create [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--fit-width] [--print-empty] [--noindent]
                               [--prefix PREFIX] [--size <size>]
                               [--type <volume-type>]
                               [--image <image> | --snapshot <snapshot> | --source <volume> | --source-replicated <replicated-volume>]
                               [--description <description>] [--user <user>]
                               [--project <project>]
                               [--availability-zone <availability-zone>]
                               [--consistency-group consistency-group>]
                               [--property <key=value>] [--hint <key=value>]
                               [--multi-attach] [--bootable | --non-bootable]
                               [--read-only | --read-write]
                               <name>

Table 71.28. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

Table 71.29. Positional Arguments

ValueSummary

<name>

Volume name

Table 71.30. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 71.31. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 71.32. Optional Arguments

ValueSummary

--property <key=value>

Set a property to this volume (repeat option to set multiple properties)

--bootable

Mark volume as bootable

--non-bootable

Mark volume as non-bootable (default)

--type <volume-type>

Set the type of volume

--availability-zone <availability-zone>

Create volume in <availability-zone>

--read-only

Set volume to read-only access mode

--consistency-group consistency-group>

Consistency group where the new volume belongs to

--size <size>

Volume size in gb (required unless --snapshot or --source or --source-replicated is specified)

--hint <key=value>

Arbitrary scheduler hint key-value pairs to help boot an instance (repeat option to set multiple hints)

--multi-attach

Allow volume to be attached more than once (default to False)

--read-write

Set volume to read-write access mode (default)

--image <image>

Use <image> as source of volume (name or id)

--source <volume>

Volume to clone (name or id)

--user <user>

Specify an alternate user (name or id)

--snapshot <snapshot>

Use <snapshot> as source of volume (name or id)

-h, --help

Show this help message and exit

--description <description>

Volume description

--project <project>

Specify an alternate project (name or id)

--source-replicated <replicated-volume>

Replicated volume to clone (name or id)

Table 71.33. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

71.8. volume delete

Delete volume(s)

Usage:

openstack volume delete [-h] [--force | --purge]
                               <volume> [<volume> ...]

Table 71.34. Positional Arguments

ValueSummary

<volume>

Volume(s) to delete (name or id)

Table 71.35. Optional Arguments

ValueSummary

--force

Attempt forced removal of volume(s), regardless of state (defaults to False)

-h, --help

Show this help message and exit

--purge

Remove any snapshots along with volume(s) (defaults to false)

71.9. volume host failover

Failover volume host to different backend

Usage:

openstack volume host failover [-h] --volume-backend <backend-id>
                                      <host-name>

Table 71.36. Positional Arguments

ValueSummary

<host-name>

Name of volume host

Table 71.37. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--volume-backend <backend-id>

The id of the volume backend replication target where the host will failover to (required)

71.10. volume host set

Set volume host properties

Usage:

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

Table 71.38. Positional Arguments

ValueSummary

<host-name>

Name of volume host

Table 71.39. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--disable

Freeze and disable the specified volume host

--enable

Thaw and enable the specified volume host

71.11. volume list

List volumes

Usage:

openstack volume list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] [--noindent]
                             [--quote {all,minimal,none,nonnumeric}]
                             [--sort-column SORT_COLUMN] [--project <project>]
                             [--project-domain <project-domain>]
                             [--user <user>] [--user-domain <user-domain>]
                             [--name <name>] [--status <status>]
                             [--all-projects] [--long] [--marker <volume>]
                             [--limit <num-volumes>]

Table 71.40. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

Table 71.41. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 71.42. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

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

Table 71.43. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 71.44. Optional Arguments

ValueSummary

--limit <num-volumes>

Maximum number of volumes to display

--name <name>

Filter results by volume name

--all-projects

Include all projects (admin only)

--user <user>

Filter results by user (name or id) (admin only)

--long

List additional fields in output

--project-domain <project-domain>

Domain the project belongs to (name or id). this can be used in case collisions between project names exist.

--status <status>

Filter results by status

--marker <volume>

The last volume id of the previous page

--user-domain <user-domain>

Domain the user belongs to (name or id). this can be used in case collisions between user names exist.

-h, --help

Show this help message and exit

--project <project>

Filter results by project (name or id) (admin only)

71.12. volume migrate

Migrate volume to a new host

Usage:

openstack volume migrate [-h] --host <host> [--force-host-copy]
                                [--lock-volume | --unlock-volume]
                                <volume>

Table 71.45. Positional Arguments

ValueSummary

<volume>

Volume to migrate (name or id)

Table 71.46. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--lock-volume

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

--host <host>

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

--unlock-volume

If specified, the volume state will not be locked and the a migration can be aborted (default) (possibly by another operation)

--force-host-copy

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

71.13. volume qos associate

Associate a QoS specification to a volume type

Usage:

openstack volume qos associate [-h] <qos-spec> <volume-type>

Table 71.47. Positional Arguments

ValueSummary

<volume-type>

Volume type to associate the qos (name or id)

<qos-spec>

Qos specification to modify (name or id)

Table 71.48. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

71.14. volume qos create

Create new QoS specification

Usage:

openstack volume qos create [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--fit-width] [--print-empty] [--noindent]
                                   [--prefix PREFIX] [--consumer <consumer>]
                                   [--property <key=value>]
                                   <name>

Table 71.49. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

Table 71.50. Positional Arguments

ValueSummary

<name>

New qos specification name

Table 71.51. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 71.52. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 71.53. Optional Arguments

ValueSummary

--consumer <consumer>

Consumer of the qos. valid consumers: back-end, both, front-end (defaults to both)

-h, --help

Show this help message and exit

--property <key=value>

Set a qos specification property (repeat option to set multiple properties)

Table 71.54. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

71.15. volume qos delete

Delete QoS specification

Usage:

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

Table 71.55. Positional Arguments

ValueSummary

<qos-spec>

Qos specification(s) to delete (name or id)

Table 71.56. Optional Arguments

ValueSummary

--force

Allow to delete in-use qos specification(s)

-h, --help

Show this help message and exit

71.16. volume qos disassociate

Disassociate a QoS specification from a volume type

Usage:

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

Table 71.57. Positional Arguments

ValueSummary

<qos-spec>

Qos specification to modify (name or id)

Table 71.58. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--volume-type <volume-type>

Volume type to disassociate the qos from (name or id)

--all

Disassociate the qos from every volume type

71.17. volume qos list

List QoS specifications

Usage:

openstack volume qos list [-h] [-f {csv,json,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--fit-width] [--print-empty] [--noindent]
                                 [--quote {all,minimal,none,nonnumeric}]
                                 [--sort-column SORT_COLUMN]

Table 71.59. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

Table 71.60. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 71.61. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

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

Table 71.62. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 71.63. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

71.18. volume qos set

Set QoS specification properties

Usage:

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

Table 71.64. Positional Arguments

ValueSummary

<qos-spec>

Qos specification to modify (name or id)

Table 71.65. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--property <key=value>

Property to add or modify for this qos specification (repeat option to set multiple properties)

71.19. volume qos show

Display QoS specification details

Usage:

openstack volume qos show [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--fit-width] [--print-empty] [--noindent]
                                 [--prefix PREFIX]
                                 <qos-spec>

Table 71.66. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

Table 71.67. Positional Arguments

ValueSummary

<qos-spec>

Qos specification to display (name or id)

Table 71.68. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 71.69. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 71.70. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 71.71. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

71.20. volume qos unset

Unset QoS specification properties

Usage:

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

Table 71.72. Positional Arguments

ValueSummary

<qos-spec>

Qos specification to modify (name or id)

Table 71.73. Optional Arguments

ValueSummary

--property <key>

Property to remove from the qos specification. (repeat option to unset multiple properties)

-h, --help

Show this help message and exit

71.21. volume service list

List service command

Usage:

openstack volume service list [-h] [-f {csv,json,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--sort-column SORT_COLUMN]
                                     [--host <host>] [--service <service>]
                                     [--long]

Table 71.74. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

Table 71.75. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 71.76. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

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

Table 71.77. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 71.78. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--host <host>

List services on specified host (name only)

--long

List additional fields in output

--service <service>

List only specified service (name only)

71.22. volume service set

Set volume service properties

Usage:

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

Table 71.79. Positional Arguments

ValueSummary

<service>

Name of service (binary name)

<host>

Name of host

Table 71.80. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--disable

Disable volume service

--disable-reason <reason>

Reason for disabling the service (should be used with --disable option)

--enable

Enable volume service

71.23. volume set

Set volume properties

Usage:

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

Table 71.81. Positional Arguments

ValueSummary

<volume>

Volume to modify (name or id)

Table 71.82. Optional Arguments

ValueSummary

--bootable

Mark volume as bootable

--non-bootable

Mark volume as non-bootable

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

--name <name>

New volume name

--property <key=value>

Set a property on this volume (repeat option to set multiple properties)

--size <size>

Extend volume size in gb

--read-only

Set volume to read-only access mode

--read-write

Set volume to read-write access mode

--no-property

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

--type <volume-type>

New volume type (name or id)

--image-property <key=value>

Set an image property on this volume (repeat option to set multiple image properties)

-h, --help

Show this help message and exit

--description <description>

New volume description

--retype-policy <retype-policy>

Migration policy while re-typing volume ("never" or "on-demand", default is "never" ) (available only when --type option is specified)

71.24. volume show

Display volume details

Usage:

openstack volume show [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--fit-width]
                             [--print-empty] [--noindent] [--prefix PREFIX]
                             <volume>

Table 71.83. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

Table 71.84. Positional Arguments

ValueSummary

<volume>

Volume to display (name or id)

Table 71.85. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 71.86. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 71.87. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 71.88. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

71.25. volume snapshot create

Create new volume snapshot

Usage:

openstack volume snapshot create [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--noindent] [--prefix PREFIX]
                                        [--volume <volume>]
                                        [--description <description>]
                                        [--force] [--property <key=value>]
                                        [--remote-source <key=value>]
                                        <snapshot-name>

Table 71.89. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

Table 71.90. Positional Arguments

ValueSummary

<snapshot-name>

Name of the new snapshot

Table 71.91. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 71.92. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 71.93. Optional Arguments

ValueSummary

--force

Create a snapshot attached to an instance. default is False

--volume <volume>

Volume to snapshot (name or id) (default is <snapshot- name>)

--property <key=value>

Set a property to this snapshot (repeat option to set multiple properties)

--remote-source <key=value>

The attribute(s) of the exsiting 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

-h, --help

Show this help message and exit

--description <description>

Description of the snapshot

Table 71.94. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

71.26. volume snapshot delete

Delete volume snapshot(s)

Usage:

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

Table 71.95. Positional Arguments

ValueSummary

<snapshot>

Snapshot(s) to delete (name or id)

Table 71.96. Optional Arguments

ValueSummary

--force

Attempt forced removal of snapshot(s), regardless of state (defaults to False)

-h, --help

Show this help message and exit

71.27. volume snapshot list

List volume snapshots

Usage:

openstack volume snapshot list [-h] [-f {csv,json,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--noindent]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [--sort-column SORT_COLUMN]
                                      [--all-projects] [--project <project>]
                                      [--project-domain <project-domain>]
                                      [--long] [--marker <volume-snapshot>]
                                      [--limit <num-snapshots>]
                                      [--name <name>] [--status <status>]
                                      [--volume <volume>]

Table 71.97. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

Table 71.98. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 71.99. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

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

Table 71.100. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 71.101. Optional Arguments

ValueSummary

--status <status>

Filters results by a status. (available, error, creating, deleting or error-deleting)

--all-projects

Include all projects (admin only)

--name <name>

Filters results by a name.

--long

List additional fields in output

--project-domain <project-domain>

Domain the project belongs to (name or id). this can be used in case collisions between project names exist.

--marker <volume-snapshot>

The last snapshot id of the previous page

--limit <num-snapshots>

Maximum number of snapshots to display

--volume <volume>

Filters results by a volume (name or id).

-h, --help

Show this help message and exit

--project <project>

Filter results by project (name or id) (admin only)

71.28. volume snapshot set

Set volume snapshot properties

Usage:

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

Table 71.102. Positional Arguments

ValueSummary

<snapshot>

Snapshot to modify (name or id)

Table 71.103. Optional Arguments

ValueSummary

--name <name>

New snapshot name

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

--no-property

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

-h, --help

Show this help message and exit

--description <description>

New snapshot description

71.29. volume snapshot show

Display volume snapshot details

Usage:

openstack volume snapshot show [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--noindent] [--prefix PREFIX]
                                      <snapshot>

Table 71.104. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

Table 71.105. Positional Arguments

ValueSummary

<snapshot>

Snapshot to display (name or id)

Table 71.106. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 71.107. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 71.108. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 71.109. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

71.30. volume snapshot unset

Unset volume snapshot properties

Usage:

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

Table 71.110. Positional Arguments

ValueSummary

<snapshot>

Snapshot to modify (name or id)

Table 71.111. Optional Arguments

ValueSummary

--property <key>

Property to remove from snapshot (repeat option to remove multiple properties)

-h, --help

Show this help message and exit

71.31. volume transfer request accept

Accept volume transfer request.

Usage:

openstack volume transfer request accept [-h]
                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                [--noindent] [--prefix PREFIX]
                                                [--auth-key <key>]
                                                <transfer-request-id>

Table 71.112. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

Table 71.113. Positional Arguments

ValueSummary

<transfer-request-id>

Volume transfer request to accept (id only)

Table 71.114. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 71.115. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 71.116. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--auth-key <key>

Volume transfer request authentication key

Table 71.117. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

71.32. volume transfer request create

Create volume transfer request.

Usage:

openstack volume transfer request create [-h]
                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                [--noindent] [--prefix PREFIX]
                                                [--name <name>]
                                                <volume>

Table 71.118. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

Table 71.119. Positional Arguments

ValueSummary

<volume>

Volume to transfer (name or id)

Table 71.120. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 71.121. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 71.122. Optional Arguments

ValueSummary

--name <name>

New transfer request name (default to none)

-h, --help

Show this help message and exit

Table 71.123. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

71.33. volume transfer request delete

Delete volume transfer request(s).

Usage:

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

Table 71.124. Positional Arguments

ValueSummary

<transfer-request>

Volume transfer request(s) to delete (name or id)

Table 71.125. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

71.34. volume transfer request list

Lists all volume transfer requests.

Usage:

openstack volume transfer request list [-h]
                                              [-f {csv,json,table,value,yaml}]
                                              [-c COLUMN]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--noindent]
                                              [--quote {all,minimal,none,nonnumeric}]
                                              [--sort-column SORT_COLUMN]
                                              [--all-projects]

Table 71.126. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

Table 71.127. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 71.128. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

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

Table 71.129. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 71.130. Optional Arguments

ValueSummary

--all-projects

Include all projects (admin only)

-h, --help

Show this help message and exit

71.35. volume transfer request show

Show volume transfer request details.

Usage:

openstack volume transfer request show [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--noindent] [--prefix PREFIX]
                                              <transfer-request>

Table 71.131. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

Table 71.132. Positional Arguments

ValueSummary

<transfer-request>

Volume transfer request to display (name or id)

Table 71.133. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 71.134. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 71.135. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 71.136. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

71.36. volume type create

Create new volume type

Usage:

openstack volume type create [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--fit-width] [--print-empty] [--noindent]
                                    [--prefix PREFIX]
                                    [--description <description>]
                                    [--public | --private]
                                    [--property <key=value>]
                                    [--project <project>]
                                    [--encryption-provider <provider>]
                                    [--encryption-cipher <cipher>]
                                    [--encryption-key-size <key-size>]
                                    [--encryption-control-location <control-location>]
                                    [--project-domain <project-domain>]
                                    <name>

Table 71.137. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

Table 71.138. Positional Arguments

ValueSummary

<name>

Volume type name

Table 71.139. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 71.140. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 71.141. Optional Arguments

ValueSummary

--public

Volume type is accessible to the public

--private

Volume type is not accessible to the public

--encryption-key-size <key-size>

Set the size of the encryption key of this volume type (e.g "128" or "256") (admin only)

--property <key=value>

Set a property on this volume type (repeat option to set multiple properties)

--project-domain <project-domain>

Domain the project belongs to (name or id). this can be used in case collisions between project names exist.

--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")

--encryption-provider <provider>

Set the class that provides encryption support for this volume type (e.g "LuksEncryptor") (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)

-h, --help

Show this help message and exit

--description <description>

Volume type description

--project <project>

Allow <project> to access private type (name or id) (Must be used with --private option)

Table 71.142. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

71.37. volume type delete

Delete volume type(s)

Usage:

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

Table 71.143. Positional Arguments

ValueSummary

<volume-type>

Volume type(s) to delete (name or id)

Table 71.144. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

71.38. volume type list

List volume types

Usage:

openstack volume type list [-h] [-f {csv,json,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--fit-width] [--print-empty] [--noindent]
                                  [--quote {all,minimal,none,nonnumeric}]
                                  [--sort-column SORT_COLUMN] [--long]
                                  [--default | --public | --private]
                                  [--encryption-type]

Table 71.145. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

Table 71.146. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 71.147. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

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

Table 71.148. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 71.149. Optional Arguments

ValueSummary

--public

List only public types

--private

List only private types (admin only)

--long

List additional fields in output

--default

List the default volume type

-h, --help

Show this help message and exit

--encryption-type

Display encryption information for each volume type (admin only)

71.39. volume type set

Set volume type properties

Usage:

openstack volume type set [-h] [--name <name>]
                                 [--description <description>]
                                 [--property <key=value>]
                                 [--project <project>]
                                 [--project-domain <project-domain>]
                                 [--encryption-provider <provider>]
                                 [--encryption-cipher <cipher>]
                                 [--encryption-key-size <key-size>]
                                 [--encryption-control-location <control-location>]
                                 <volume-type>

Table 71.150. Positional Arguments

ValueSummary

<volume-type>

Volume type to modify (name or id)

Table 71.151. Optional Arguments

ValueSummary

--encryption-key-size <key-size>

Set the size of the encryption key of this volume type (e.g "128" or "256") (admin only)

--name <name>

Set volume type name

--property <key=value>

Set a property on this volume type (repeat option to set multiple properties)

--project-domain <project-domain>

Domain the project belongs to (name or id). this can be used in case collisions between project names exist.

--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")

--encryption-provider <provider>

Set the class that provides encryption support for this volume type (e.g "LuksEncryptor") (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)

-h, --help

Show this help message and exit

--description <description>

Set volume type description

--project <project>

Set volume type access to project (name or id) (admin only)

71.40. volume type show

Display volume type details

Usage:

openstack volume type show [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--fit-width] [--print-empty] [--noindent]
                                  [--prefix PREFIX] [--encryption-type]
                                  <volume-type>

Table 71.152. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

Table 71.153. Positional Arguments

ValueSummary

<volume-type>

Volume type to display (name or id)

Table 71.154. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 71.155. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 71.156. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--encryption-type

Display encryption information of this volume type (admin only)

Table 71.157. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

71.41. volume type unset

Unset volume type properties

Usage:

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

Table 71.158. Positional Arguments

ValueSummary

<volume-type>

Volume type to modify (name or id)

Table 71.159. Optional Arguments

ValueSummary

--property <key>

Remove a property from this volume type (repeat option to remove multiple properties)

-h, --help

Show this help message and exit

--encryption-type

Remove the encryption type for this volume type (admin only)

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

71.42. volume unset

Unset volume properties

Usage:

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

Table 71.160. Positional Arguments

ValueSummary

<volume>

Volume to modify (name or id)

Table 71.161. Optional Arguments

ValueSummary

--property <key>

Remove a property from volume (repeat option to remove multiple properties)

-h, --help

Show this help message and exit

--image-property <key>

Remove an image property from volume (repeat option to remove multiple image properties)