Chapter 88. volume

This chapter describes the commands under the volume command.

88.1. volume backup create

Create new volume backup

Usage:

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

Table 88.1. Positional Arguments

ValueSummary

<volume>

Volume to backup (name or id)

Table 88.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

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

Table 88.3. Output Formatters

ValueSummary

-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 88.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 88.5. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 88.6. Table Formatter

ValueSummary

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

--print-empty

Print empty table if there is no data to show.

88.2. volume backup delete

Delete volume backup(s)

Usage:

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

Table 88.7. Positional Arguments

ValueSummary

<backup>

Backup(s) to delete (name or id)

Table 88.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--force

Allow delete in state other than error or available

88.3. volume backup list

List volume backups

Usage:

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

Table 88.9. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--long

List additional fields in output

--name <name>

Filters results by the backup name

--status <status>

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

--volume <volume>

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

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

Table 88.10. Output Formatters

ValueSummary

-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 88.11. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 88.12. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 88.13. Table Formatter

ValueSummary

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

--print-empty

Print empty table if there is no data to show.

88.4. volume backup restore

Restore volume backup

Usage:

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

Table 88.14. Positional Arguments

ValueSummary

<backup>

Backup to restore (name or id)

<volume>

Volume to restore to (name or id)

Table 88.15. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 88.16. Output Formatters

ValueSummary

-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 88.17. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 88.18. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 88.19. Table Formatter

ValueSummary

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

--print-empty

Print empty table if there is no data to show.

88.5. volume backup set

Set volume backup properties

Usage:

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

Table 88.20. Positional Arguments

ValueSummary

<backup>

Backup to modify (name or id)

Table 88.21. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

New backup name

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

88.6. volume backup show

Display volume backup details

Usage:

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

Table 88.22. Positional Arguments

ValueSummary

<backup>

Backup to display (name or id)

Table 88.23. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 88.24. Output Formatters

ValueSummary

-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 88.25. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 88.26. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 88.27. Table Formatter

ValueSummary

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

--print-empty

Print empty table if there is no data to show.

88.7. volume create

Create new volume

Usage:

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

Table 88.28. Positional Arguments

ValueSummary

<name>

Volume name

Table 88.29. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--size <size>

Volume size in gb (required unless --snapshot or --source is 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)

--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 boot an instance (repeat option to set multiple hints)

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

Table 88.30. Output Formatters

ValueSummary

-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 88.31. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 88.32. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 88.33. Table Formatter

ValueSummary

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

--print-empty

Print empty table if there is no data to show.

88.8. volume delete

Delete volume(s)

Usage:

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

Table 88.34. Positional Arguments

ValueSummary

<volume>

Volume(s) to delete (name or id)

Table 88.35. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--force

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

--purge

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

88.9. volume host set

Set volume host properties

Usage:

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

Table 88.36. Positional Arguments

ValueSummary

<host-name>

Name of volume host

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

88.10. volume list

List volumes

Usage:

openstack volume list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                             [--quote {all,minimal,none,nonnumeric}]
                             [--noindent] [--max-width <integer>]
                             [--fit-width] [--print-empty]
                             [--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 88.38. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

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

--all-projects

Include all projects (admin only)

--long

List additional fields in output

--marker <volume>

The last volume id of the previous page

--limit <num-volumes>

Maximum number of volumes to display

Table 88.39. Output Formatters

ValueSummary

-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 88.40. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 88.41. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 88.42. Table Formatter

ValueSummary

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

--print-empty

Print empty table if there is no data to show.

88.11. volume migrate

Migrate volume to a new host

Usage:

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

Table 88.43. Positional Arguments

ValueSummary

<volume>

Volume to migrate (name or id)

Table 88.44. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--host <host>

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

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

88.12. volume qos associate

Associate a QoS specification to a volume type

Usage:

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

Table 88.45. Positional Arguments

ValueSummary

<qos-spec>

Qos specification to modify (name or id)

<volume-type>

Volume type to associate the qos (name or id)

Table 88.46. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

88.13. volume qos create

Create new QoS specification

Usage:

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

Table 88.47. Positional Arguments

ValueSummary

<name>

New qos specification name

Table 88.48. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

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

Table 88.49. Output Formatters

ValueSummary

-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 88.50. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 88.51. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 88.52. Table Formatter

ValueSummary

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

--print-empty

Print empty table if there is no data to show.

88.14. volume qos delete

Delete QoS specification

Usage:

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

Table 88.53. Positional Arguments

ValueSummary

<qos-spec>

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

Table 88.54. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--force

Allow to delete in-use qos specification(s)

88.15. 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 88.55. Positional Arguments

ValueSummary

<qos-spec>

Qos specification to modify (name or id)

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

88.16. volume qos list

List QoS specifications

Usage:

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

Table 88.57. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 88.58. Output Formatters

ValueSummary

-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 88.59. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 88.60. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 88.61. Table Formatter

ValueSummary

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

--print-empty

Print empty table if there is no data to show.

88.17. volume qos set

Set QoS specification properties

Usage:

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

Table 88.62. Positional Arguments

ValueSummary

<qos-spec>

Qos specification to modify (name or id)

Table 88.63. 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)

88.18. volume qos show

Display QoS specification details

Usage:

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

Table 88.64. Positional Arguments

ValueSummary

<qos-spec>

Qos specification to display (name or id)

Table 88.65. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 88.66. Output Formatters

ValueSummary

-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 88.67. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 88.68. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 88.69. Table Formatter

ValueSummary

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

--print-empty

Print empty table if there is no data to show.

88.19. volume qos unset

Unset QoS specification properties

Usage:

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

Table 88.70. Positional Arguments

ValueSummary

<qos-spec>

Qos specification to modify (name or id)

Table 88.71. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--property <key>

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

88.20. volume service list

List service command

Usage:

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

Table 88.72. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--host <host>

List services on specified host (name only)

--service <service>

List only specified service (name only)

--long

List additional fields in output

Table 88.73. Output Formatters

ValueSummary

-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 88.74. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 88.75. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 88.76. Table Formatter

ValueSummary

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

--print-empty

Print empty table if there is no data to show.

88.21. volume service set

Set volume service properties

Usage:

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

Table 88.77. Positional Arguments

ValueSummary

<host>

Name of host

<service>

Name of service (binary name)

Table 88.78. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--enable

Enable volume service

--disable

Disable volume service

--disable-reason <reason>

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

88.22. 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>]
                            [--attached | --detached] [--type <volume-type>]
                            [--retype-policy <retype-policy>]
                            [--bootable | --non-bootable]
                            [--read-only | --read-write]
                            <volume>

Table 88.79. Positional Arguments

ValueSummary

<volume>

Volume to modify (name or id)

Table 88.80. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

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

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

88.23. volume show

Display volume details

Usage:

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

Table 88.81. Positional Arguments

ValueSummary

<volume>

Volume to display (name or id)

Table 88.82. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 88.83. Output Formatters

ValueSummary

-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 88.84. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 88.85. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 88.86. Table Formatter

ValueSummary

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

--print-empty

Print empty table if there is no data to show.

88.24. volume snapshot create

Create new volume snapshot

Usage:

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

Table 88.87. Positional Arguments

ValueSummary

<snapshot-name>

Name of the new snapshot

Table 88.88. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--volume <volume>

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

--description <description>

Description of the snapshot

--force

Create a snapshot attached to an instance. default is False

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

Table 88.89. Output Formatters

ValueSummary

-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 88.90. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 88.91. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 88.92. Table Formatter

ValueSummary

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

--print-empty

Print empty table if there is no data to show.

88.25. volume snapshot delete

Delete volume snapshot(s)

Usage:

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

Table 88.93. Positional Arguments

ValueSummary

<snapshot>

Snapshot(s) to delete (name or id)

Table 88.94. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--force

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

88.26. volume snapshot list

List volume snapshots

Usage:

openstack volume snapshot list [-h] [-f {csv,json,table,value,yaml}]
                                      [-c COLUMN]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [--noindent] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--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 88.95. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

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

--marker <volume-snapshot>

The last snapshot id of the previous page

--limit <num-snapshots>

Maximum number of snapshots to display

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

Table 88.96. Output Formatters

ValueSummary

-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 88.97. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 88.98. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 88.99. Table Formatter

ValueSummary

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

--print-empty

Print empty table if there is no data to show.

88.27. 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 88.100. Positional Arguments

ValueSummary

<snapshot>

Snapshot to modify (name or id)

Table 88.101. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

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

88.28. volume snapshot show

Display volume snapshot details

Usage:

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

Table 88.102. Positional Arguments

ValueSummary

<snapshot>

Snapshot to display (name or id)

Table 88.103. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 88.104. Output Formatters

ValueSummary

-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 88.105. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 88.106. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 88.107. Table Formatter

ValueSummary

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

--print-empty

Print empty table if there is no data to show.

88.29. volume snapshot unset

Unset volume snapshot properties

Usage:

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

Table 88.108. Positional Arguments

ValueSummary

<snapshot>

Snapshot to modify (name or id)

Table 88.109. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--property <key>

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

88.30. volume transfer request accept

Accept volume transfer request.

Usage:

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

Table 88.110. Positional Arguments

ValueSummary

<transfer-request-id>

Volume transfer request to accept (id only)

Table 88.111. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--auth-key <key>

Volume transfer request authentication key

Table 88.112. Output Formatters

ValueSummary

-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 88.113. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 88.114. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 88.115. Table Formatter

ValueSummary

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

--print-empty

Print empty table if there is no data to show.

88.31. volume transfer request create

Create volume transfer request.

Usage:

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

Table 88.116. Positional Arguments

ValueSummary

<volume>

Volume to transfer (name or id)

Table 88.117. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

New transfer request name (default to none)

Table 88.118. Output Formatters

ValueSummary

-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 88.119. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 88.120. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 88.121. Table Formatter

ValueSummary

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

--print-empty

Print empty table if there is no data to show.

88.32. volume transfer request delete

Delete volume transfer request(s).

Usage:

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

Table 88.122. Positional Arguments

ValueSummary

<transfer-request>

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

Table 88.123. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

88.33. volume transfer request list

Lists all volume transfer requests.

Usage:

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

Table 88.124. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--all-projects

Include all projects (admin only)

Table 88.125. Output Formatters

ValueSummary

-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 88.126. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 88.127. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 88.128. Table Formatter

ValueSummary

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

--print-empty

Print empty table if there is no data to show.

88.34. volume transfer request show

Show volume transfer request details.

Usage:

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

Table 88.129. Positional Arguments

ValueSummary

<transfer-request>

Volume transfer request to display (name or id)

Table 88.130. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 88.131. Output Formatters

ValueSummary

-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 88.132. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 88.133. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 88.134. Table Formatter

ValueSummary

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

--print-empty

Print empty table if there is no data to show.

88.35. volume type create

Create new volume type

Usage:

openstack volume type create [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--noindent] [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty]
                                    [--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 88.135. Positional Arguments

ValueSummary

<name>

Volume type name

Table 88.136. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

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

--project <project>

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

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

--project-domain <project-domain>

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

Table 88.137. Output Formatters

ValueSummary

-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 88.138. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 88.139. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 88.140. Table Formatter

ValueSummary

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

--print-empty

Print empty table if there is no data to show.

88.36. volume type delete

Delete volume type(s)

Usage:

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

Table 88.141. Positional Arguments

ValueSummary

<volume-type>

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

Table 88.142. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

88.37. volume type list

List volume types

Usage:

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

Table 88.143. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

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

Table 88.144. Output Formatters

ValueSummary

-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 88.145. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 88.146. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 88.147. Table Formatter

ValueSummary

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

--print-empty

Print empty table if there is no data to show.

88.38. 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 88.148. Positional Arguments

ValueSummary

<volume-type>

Volume type to modify (name or id)

Table 88.149. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

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

--project <project>

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

88.39. volume type show

Display volume type details

Usage:

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

Table 88.150. Positional Arguments

ValueSummary

<volume-type>

Volume type to display (name or id)

Table 88.151. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--encryption-type

Display encryption information of this volume type (admin only)

Table 88.152. Output Formatters

ValueSummary

-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 88.153. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 88.154. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 88.155. Table Formatter

ValueSummary

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

--print-empty

Print empty table if there is no data to show.

88.40. 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 88.156. Positional Arguments

ValueSummary

<volume-type>

Volume type to modify (name or id)

Table 88.157. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

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

88.41. volume unset

Unset volume properties

Usage:

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

Table 88.158. Positional Arguments

ValueSummary

<volume>

Volume to modify (name or id)

Table 88.159. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

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