Chapter 86. volume
This chapter describes the commands under the volume
command.
86.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 86.1. Positional arguments
Value | Summary |
---|---|
<volume> | Volume to backup (name or id) |
Table 86.2. Command arguments
Value | Summary |
---|---|
-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 86.3. Output formatter options
Value | Summary |
---|---|
-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 86.4. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 86.5. Shell formatter options
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 86.6. Table formatter options
Value | Summary |
---|---|
--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. |
86.2. volume backup delete
Delete volume backup(s)
Usage:
openstack volume backup delete [-h] [--force] <backup> [<backup> ...]
Table 86.7. Positional arguments
Value | Summary |
---|---|
<backup> | Backup(s) to delete (name or id) |
Table 86.8. Command arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--force | Allow delete in state other than error or available |
86.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 86.9. Command arguments
Value | Summary |
---|---|
-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 86.10. Output formatter options
Value | Summary |
---|---|
-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 86.11. CSV formatter options
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 86.12. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 86.13. Table formatter options
Value | Summary |
---|---|
--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. |
86.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 86.14. Positional arguments
Value | Summary |
---|---|
<backup> | Backup to restore (name or id) |
<volume> | Volume to restore to (name or id) |
Table 86.15. Command arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Table 86.16. Output formatter options
Value | Summary |
---|---|
-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 86.17. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 86.18. Shell formatter options
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 86.19. Table formatter options
Value | Summary |
---|---|
--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. |
86.5. volume backup set
Set volume backup properties
Usage:
openstack volume backup set [-h] [--name <name>] [--description <description>] [--state <state>] <backup>
Table 86.20. Positional arguments
Value | Summary |
---|---|
<backup> | Backup to modify (name or id) |
Table 86.21. Command arguments
Value | Summary |
---|---|
-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) |
86.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 86.22. Positional arguments
Value | Summary |
---|---|
<backup> | Backup to display (name or id) |
Table 86.23. Command arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Table 86.24. Output formatter options
Value | Summary |
---|---|
-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 86.25. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 86.26. Shell formatter options
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 86.27. Table formatter options
Value | Summary |
---|---|
--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. |
86.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 86.28. Positional arguments
Value | Summary |
---|---|
<name> | Volume name |
Table 86.29. Command arguments
Value | Summary |
---|---|
-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 86.30. Output formatter options
Value | Summary |
---|---|
-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 86.31. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 86.32. Shell formatter options
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 86.33. Table formatter options
Value | Summary |
---|---|
--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. |
86.8. volume delete
Delete volume(s)
Usage:
openstack volume delete [-h] [--force | --purge] <volume> [<volume> ...]
Table 86.34. Positional arguments
Value | Summary |
---|---|
<volume> | Volume(s) to delete (name or id) |
Table 86.35. Command arguments
Value | Summary |
---|---|
-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) |
86.9. volume host set
Set volume host properties
Usage:
openstack volume host set [-h] [--disable | --enable] <host-name>
Table 86.36. Positional arguments
Value | Summary |
---|---|
<host-name> | Name of volume host |
Table 86.37. Command arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--disable | Freeze and disable the specified volume host |
--enable | Thaw and enable the specified volume host |
86.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 86.38. Command arguments
Value | Summary |
---|---|
-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 86.39. Output formatter options
Value | Summary |
---|---|
-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 86.40. CSV formatter options
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 86.41. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 86.42. Table formatter options
Value | Summary |
---|---|
--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. |
86.11. volume migrate
Migrate volume to a new host
Usage:
openstack volume migrate [-h] --host <host> [--force-host-copy] [--lock-volume] <volume>
Table 86.43. Positional arguments
Value | Summary |
---|---|
<volume> | Volume to migrate (name or id) |
Table 86.44. Command arguments
Value | Summary |
---|---|
-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) |
86.12. volume qos associate
Associate a QoS specification to a volume type
Usage:
openstack volume qos associate [-h] <qos-spec> <volume-type>
Table 86.45. Positional arguments
Value | Summary |
---|---|
<qos-spec> | Qos specification to modify (name or id) |
<volume-type> | Volume type to associate the qos (name or id) |
Table 86.46. Command arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
86.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 86.47. Positional arguments
Value | Summary |
---|---|
<name> | New qos specification name |
Table 86.48. Command arguments
Value | Summary |
---|---|
-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 86.49. Output formatter options
Value | Summary |
---|---|
-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 86.50. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 86.51. Shell formatter options
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 86.52. Table formatter options
Value | Summary |
---|---|
--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. |
86.14. volume qos delete
Delete QoS specification
Usage:
openstack volume qos delete [-h] [--force] <qos-spec> [<qos-spec> ...]
Table 86.53. Positional arguments
Value | Summary |
---|---|
<qos-spec> | Qos specification(s) to delete (name or id) |
Table 86.54. Command arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--force | Allow to delete in-use qos specification(s) |
86.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 86.55. Positional arguments
Value | Summary |
---|---|
<qos-spec> | Qos specification to modify (name or id) |
Table 86.56. Command arguments
Value | Summary |
---|---|
-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 |
86.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 86.57. Command arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Table 86.58. Output formatter options
Value | Summary |
---|---|
-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 86.59. CSV formatter options
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 86.60. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 86.61. Table formatter options
Value | Summary |
---|---|
--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. |
86.17. volume qos set
Set QoS specification properties
Usage:
openstack volume qos set [-h] [--property <key=value>] <qos-spec>
Table 86.62. Positional arguments
Value | Summary |
---|---|
<qos-spec> | Qos specification to modify (name or id) |
Table 86.63. Command arguments
Value | Summary |
---|---|
-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) |
86.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 86.64. Positional arguments
Value | Summary |
---|---|
<qos-spec> | Qos specification to display (name or id) |
Table 86.65. Command arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Table 86.66. Output formatter options
Value | Summary |
---|---|
-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 86.67. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 86.68. Shell formatter options
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 86.69. Table formatter options
Value | Summary |
---|---|
--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. |
86.19. volume qos unset
Unset QoS specification properties
Usage:
openstack volume qos unset [-h] [--property <key>] <qos-spec>
Table 86.70. Positional arguments
Value | Summary |
---|---|
<qos-spec> | Qos specification to modify (name or id) |
Table 86.71. Command arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--property <key> | Property to remove from the qos specification. (repeat option to unset multiple properties) |
86.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 86.72. Command arguments
Value | Summary |
---|---|
-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 86.73. Output formatter options
Value | Summary |
---|---|
-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 86.74. CSV formatter options
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 86.75. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 86.76. Table formatter options
Value | Summary |
---|---|
--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. |
86.21. volume service set
Set volume service properties
Usage:
openstack volume service set [-h] [--enable | --disable] [--disable-reason <reason>] <host> <service>
Table 86.77. Positional arguments
Value | Summary |
---|---|
<host> | Name of host |
<service> | Name of service (binary name) |
Table 86.78. Command arguments
Value | Summary |
---|---|
-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) |
86.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 86.79. Positional arguments
Value | Summary |
---|---|
<volume> | Volume to modify (name or id) |
Table 86.80. Command arguments
Value | Summary |
---|---|
-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 |
86.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 86.81. Positional arguments
Value | Summary |
---|---|
<volume> | Volume to display (name or id) |
Table 86.82. Command arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Table 86.83. Output formatter options
Value | Summary |
---|---|
-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 86.84. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 86.85. Shell formatter options
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 86.86. Table formatter options
Value | Summary |
---|---|
--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. |
86.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 86.87. Positional arguments
Value | Summary |
---|---|
<snapshot-name> | Name of the new snapshot |
Table 86.88. Command arguments
Value | Summary |
---|---|
-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 86.89. Output formatter options
Value | Summary |
---|---|
-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 86.90. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 86.91. Shell formatter options
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 86.92. Table formatter options
Value | Summary |
---|---|
--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. |
86.25. volume snapshot delete
Delete volume snapshot(s)
Usage:
openstack volume snapshot delete [-h] [--force] <snapshot> [<snapshot> ...]
Table 86.93. Positional arguments
Value | Summary |
---|---|
<snapshot> | Snapshot(s) to delete (name or id) |
Table 86.94. Command arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--force | Attempt forced removal of snapshot(s), regardless of state (defaults to False) |
86.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 86.95. Command arguments
Value | Summary |
---|---|
-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 86.96. Output formatter options
Value | Summary |
---|---|
-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 86.97. CSV formatter options
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 86.98. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 86.99. Table formatter options
Value | Summary |
---|---|
--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. |
86.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 86.100. Positional arguments
Value | Summary |
---|---|
<snapshot> | Snapshot to modify (name or id) |
Table 86.101. Command arguments
Value | Summary |
---|---|
-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) |
86.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 86.102. Positional arguments
Value | Summary |
---|---|
<snapshot> | Snapshot to display (name or id) |
Table 86.103. Command arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Table 86.104. Output formatter options
Value | Summary |
---|---|
-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 86.105. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 86.106. Shell formatter options
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 86.107. Table formatter options
Value | Summary |
---|---|
--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. |
86.29. volume snapshot unset
Unset volume snapshot properties
Usage:
openstack volume snapshot unset [-h] [--property <key>] <snapshot>
Table 86.108. Positional arguments
Value | Summary |
---|---|
<snapshot> | Snapshot to modify (name or id) |
Table 86.109. Command arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--property <key> | Property to remove from snapshot (repeat option to remove multiple properties) |
86.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 86.110. Positional arguments
Value | Summary |
---|---|
<transfer-request-id> | Volume transfer request to accept (id only) |
Table 86.111. Command arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--auth-key <key> | Volume transfer request authentication key |
Table 86.112. Output formatter options
Value | Summary |
---|---|
-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 86.113. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 86.114. Shell formatter options
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 86.115. Table formatter options
Value | Summary |
---|---|
--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. |
86.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 86.116. Positional arguments
Value | Summary |
---|---|
<volume> | Volume to transfer (name or id) |
Table 86.117. Command arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--name <name> | New transfer request name (default to none) |
Table 86.118. Output formatter options
Value | Summary |
---|---|
-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 86.119. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 86.120. Shell formatter options
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 86.121. Table formatter options
Value | Summary |
---|---|
--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. |
86.32. volume transfer request delete
Delete volume transfer request(s).
Usage:
openstack volume transfer request delete [-h] <transfer-request> [<transfer-request> ...]
Table 86.122. Positional arguments
Value | Summary |
---|---|
<transfer-request> | Volume transfer request(s) to delete (name or id) |
Table 86.123. Command arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
86.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 86.124. Command arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--all-projects | Include all projects (admin only) |
Table 86.125. Output formatter options
Value | Summary |
---|---|
-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 86.126. CSV formatter options
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 86.127. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 86.128. Table formatter options
Value | Summary |
---|---|
--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. |
86.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 86.129. Positional arguments
Value | Summary |
---|---|
<transfer-request> | Volume transfer request to display (name or id) |
Table 86.130. Command arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Table 86.131. Output formatter options
Value | Summary |
---|---|
-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 86.132. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 86.133. Shell formatter options
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 86.134. Table formatter options
Value | Summary |
---|---|
--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. |
86.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 86.135. Positional arguments
Value | Summary |
---|---|
<name> | Volume type name |
Table 86.136. Command arguments
Value | Summary |
---|---|
-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 86.137. Output formatter options
Value | Summary |
---|---|
-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 86.138. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 86.139. Shell formatter options
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 86.140. Table formatter options
Value | Summary |
---|---|
--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. |
86.36. volume type delete
Delete volume type(s)
Usage:
openstack volume type delete [-h] <volume-type> [<volume-type> ...]
Table 86.141. Positional arguments
Value | Summary |
---|---|
<volume-type> | Volume type(s) to delete (name or id) |
Table 86.142. Command arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
86.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 86.143. Command arguments
Value | Summary |
---|---|
-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 86.144. Output formatter options
Value | Summary |
---|---|
-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 86.145. CSV formatter options
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 86.146. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 86.147. Table formatter options
Value | Summary |
---|---|
--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. |
86.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 86.148. Positional arguments
Value | Summary |
---|---|
<volume-type> | Volume type to modify (name or id) |
Table 86.149. Command arguments
Value | Summary |
---|---|
-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") |
86.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 86.150. Positional arguments
Value | Summary |
---|---|
<volume-type> | Volume type to display (name or id) |
Table 86.151. Command arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--encryption-type | Display encryption information of this volume type (admin only) |
Table 86.152. Output formatter options
Value | Summary |
---|---|
-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 86.153. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 86.154. Shell formatter options
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 86.155. Table formatter options
Value | Summary |
---|---|
--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. |
86.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 86.156. Positional arguments
Value | Summary |
---|---|
<volume-type> | Volume type to modify (name or id) |
Table 86.157. Command arguments
Value | Summary |
---|---|
-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) |
86.41. volume unset
Unset volume properties
Usage:
openstack volume unset [-h] [--property <key>] [--image-property <key>] <volume>
Table 86.158. Positional arguments
Value | Summary |
---|---|
<volume> | Volume to modify (name or id) |
Table 86.159. Command arguments
Value | Summary |
---|---|
-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) |