Chapter 89. volume This chapter describes the commands under the volume command. 89.1. volume backup create Create new volume backup Usage: Table 89.1. Positional arguments Value Summary <volume> Volume to backup (name or id) Table 89.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 89.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 to show multiple columns Table 89.4. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 89.5. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 89.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. 89.2. volume backup delete Delete volume backup(s) Usage: Table 89.7. Positional arguments Value Summary <backup> Backup(s) to delete (name or id) Table 89.8. Command arguments Value Summary -h, --help Show this help message and exit --force Allow delete in state other than error or available 89.3. volume backup list List volume backups Usage: Table 89.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 page (name or id) --limit <num-backups> Maximum number of backups to display --all-projects Include all projects (admin only) Table 89.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 to show multiple columns --sort-column SORT_COLUMN Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 89.11. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 89.12. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 89.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. 89.4. volume backup record export Export volume backup details. Backup information can be imported into a new service instance to be able to restore. Usage: Table 89.14. Positional arguments Value Summary <backup> Backup to export (name or id) Table 89.15. Command arguments Value Summary -h, --help Show this help message and exit Table 89.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 to show multiple columns Table 89.17. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 89.18. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 89.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. 89.5. volume backup record import Import volume backup details. Exported backup details contain the metadata necessary to restore to a new or rebuilt service instance Usage: Table 89.20. Positional arguments Value Summary <backup_service> Backup service containing the backup. <backup_metadata> Encoded backup metadata from export. Table 89.21. Command arguments Value Summary -h, --help Show this help message and exit Table 89.22. 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 to show multiple columns Table 89.23. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 89.24. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 89.25. 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. 89.6. volume backup restore Restore volume backup Usage: Table 89.26. Positional arguments Value Summary <backup> Backup to restore (name or id) <volume> Volume to restore to (name or id) Table 89.27. Command arguments Value Summary -h, --help Show this help message and exit Table 89.28. 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 to show multiple columns Table 89.29. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 89.30. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 89.31. 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. 89.7. volume backup set Set volume backup properties Usage: Table 89.32. Positional arguments Value Summary <backup> Backup to modify (name or id) Table 89.33. 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) 89.8. volume backup show Display volume backup details Usage: Table 89.34. Positional arguments Value Summary <backup> Backup to display (name or id) Table 89.35. Command arguments Value Summary -h, --help Show this help message and exit Table 89.36. 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 to show multiple columns Table 89.37. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 89.38. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 89.39. 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. 89.9. volume create Create new volume Usage: Table 89.40. Positional arguments Value Summary <name> Volume name Table 89.41. 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 89.42. 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 to show multiple columns Table 89.43. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 89.44. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 89.45. 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. 89.10. volume delete Delete volume(s) Usage: Table 89.46. Positional arguments Value Summary <volume> Volume(s) to delete (name or id) Table 89.47. 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) 89.11. volume host set Set volume host properties Usage: Table 89.48. Positional arguments Value Summary <host-name> Name of volume host Table 89.49. 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 89.12. volume list List volumes Usage: Table 89.50. 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 page --limit <num-volumes> Maximum number of volumes to display Table 89.51. 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 to show multiple columns --sort-column SORT_COLUMN Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 89.52. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 89.53. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 89.54. 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. 89.13. volume migrate Migrate volume to a new host Usage: Table 89.55. Positional arguments Value Summary <volume> Volume to migrate (name or id) Table 89.56. 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) 89.14. volume qos associate Associate a QoS specification to a volume type Usage: Table 89.57. 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 89.58. Command arguments Value Summary -h, --help Show this help message and exit 89.15. volume qos create Create new QoS specification Usage: Table 89.59. Positional arguments Value Summary <name> New qos specification name Table 89.60. 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 89.61. 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 to show multiple columns Table 89.62. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 89.63. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 89.64. 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. 89.16. volume qos delete Delete QoS specification Usage: Table 89.65. Positional arguments Value Summary <qos-spec> Qos specification(s) to delete (name or id) Table 89.66. Command arguments Value Summary -h, --help Show this help message and exit --force Allow to delete in-use qos specification(s) 89.17. volume qos disassociate Disassociate a QoS specification from a volume type Usage: Table 89.67. Positional arguments Value Summary <qos-spec> Qos specification to modify (name or id) Table 89.68. 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 89.18. volume qos list List QoS specifications Usage: Table 89.69. Command arguments Value Summary -h, --help Show this help message and exit Table 89.70. 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 to show multiple columns --sort-column SORT_COLUMN Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 89.71. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 89.72. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 89.73. 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. 89.19. volume qos set Set QoS specification properties Usage: Table 89.74. Positional arguments Value Summary <qos-spec> Qos specification to modify (name or id) Table 89.75. 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) 89.20. volume qos show Display QoS specification details Usage: Table 89.76. Positional arguments Value Summary <qos-spec> Qos specification to display (name or id) Table 89.77. Command arguments Value Summary -h, --help Show this help message and exit Table 89.78. 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 to show multiple columns Table 89.79. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 89.80. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 89.81. 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. 89.21. volume qos unset Unset QoS specification properties Usage: Table 89.82. Positional arguments Value Summary <qos-spec> Qos specification to modify (name or id) Table 89.83. 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) 89.22. volume service list List service command Usage: Table 89.84. 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 89.85. 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 to show multiple columns --sort-column SORT_COLUMN Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 89.86. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 89.87. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 89.88. 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. 89.23. volume service set Set volume service properties Usage: Table 89.89. Positional arguments Value Summary <host> Name of host <service> Name of service (binary name) Table 89.90. 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) 89.24. volume set Set volume properties Usage: Table 89.91. Positional arguments Value Summary <volume> Volume to modify (name or id) Table 89.92. 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 89.25. volume show Display volume details Usage: Table 89.93. Positional arguments Value Summary <volume> Volume to display (name or id) Table 89.94. Command arguments Value Summary -h, --help Show this help message and exit Table 89.95. 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 to show multiple columns Table 89.96. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 89.97. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 89.98. 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. 89.26. volume snapshot create Create new volume snapshot Usage: Table 89.99. Positional arguments Value Summary <snapshot-name> Name of the new snapshot Table 89.100. 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 89.101. 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 to show multiple columns Table 89.102. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 89.103. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 89.104. 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. 89.27. volume snapshot delete Delete volume snapshot(s) Usage: Table 89.105. Positional arguments Value Summary <snapshot> Snapshot(s) to delete (name or id) Table 89.106. 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) 89.28. volume snapshot list List volume snapshots Usage: Table 89.107. 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 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 89.108. 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 to show multiple columns --sort-column SORT_COLUMN Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 89.109. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 89.110. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 89.111. 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. 89.29. volume snapshot set Set volume snapshot properties Usage: Table 89.112. Positional arguments Value Summary <snapshot> Snapshot to modify (name or id) Table 89.113. 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) 89.30. volume snapshot show Display volume snapshot details Usage: Table 89.114. Positional arguments Value Summary <snapshot> Snapshot to display (name or id) Table 89.115. Command arguments Value Summary -h, --help Show this help message and exit Table 89.116. 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 to show multiple columns Table 89.117. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 89.118. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 89.119. 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. 89.31. volume snapshot unset Unset volume snapshot properties Usage: Table 89.120. Positional arguments Value Summary <snapshot> Snapshot to modify (name or id) Table 89.121. 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) 89.32. volume transfer request accept Accept volume transfer request. Usage: Table 89.122. Positional arguments Value Summary <transfer-request-id> Volume transfer request to accept (id only) Table 89.123. Command arguments Value Summary -h, --help Show this help message and exit --auth-key <key> Volume transfer request authentication key Table 89.124. 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 to show multiple columns Table 89.125. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 89.126. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 89.127. 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. 89.33. volume transfer request create Create volume transfer request. Usage: Table 89.128. Positional arguments Value Summary <volume> Volume to transfer (name or id) Table 89.129. Command arguments Value Summary -h, --help Show this help message and exit --name <name> New transfer request name (default to none) Table 89.130. 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 to show multiple columns Table 89.131. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 89.132. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 89.133. 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. 89.34. volume transfer request delete Delete volume transfer request(s). Usage: Table 89.134. Positional arguments Value Summary <transfer-request> Volume transfer request(s) to delete (name or id) Table 89.135. Command arguments Value Summary -h, --help Show this help message and exit 89.35. volume transfer request list Lists all volume transfer requests. Usage: Table 89.136. Command arguments Value Summary -h, --help Show this help message and exit --all-projects Include all projects (admin only) Table 89.137. 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 to show multiple columns --sort-column SORT_COLUMN Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 89.138. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 89.139. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 89.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. 89.36. volume transfer request show Show volume transfer request details. Usage: Table 89.141. Positional arguments Value Summary <transfer-request> Volume transfer request to display (name or id) Table 89.142. Command arguments Value Summary -h, --help Show this help message and exit Table 89.143. 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 to show multiple columns Table 89.144. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 89.145. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 89.146. 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. 89.37. volume type create Create new volume type Usage: Table 89.147. Positional arguments Value Summary <name> Volume type name Table 89.148. 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 89.149. 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 to show multiple columns Table 89.150. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 89.151. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 89.152. 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. 89.38. volume type delete Delete volume type(s) Usage: Table 89.153. Positional arguments Value Summary <volume-type> Volume type(s) to delete (name or id) Table 89.154. Command arguments Value Summary -h, --help Show this help message and exit 89.39. volume type list List volume types Usage: Table 89.155. 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 89.156. 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 to show multiple columns --sort-column SORT_COLUMN Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 89.157. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 89.158. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 89.159. 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. 89.40. volume type set Set volume type properties Usage: Table 89.160. Positional arguments Value Summary <volume-type> Volume type to modify (name or id) Table 89.161. 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") 89.41. volume type show Display volume type details Usage: Table 89.162. Positional arguments Value Summary <volume-type> Volume type to display (name or id) Table 89.163. Command arguments Value Summary -h, --help Show this help message and exit --encryption-type Display encryption information of this volume type (admin only) Table 89.164. 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 to show multiple columns Table 89.165. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 89.166. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 89.167. 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. 89.42. volume type unset Unset volume type properties Usage: Table 89.168. Positional arguments Value Summary <volume-type> Volume type to modify (name or id) Table 89.169. 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) 89.43. volume unset Unset volume properties Usage: Table 89.170. Positional arguments Value Summary <volume> Volume to modify (name or id) Table 89.171. 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)

Commands:
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>
openstack volume backup delete [-h] [--force] <backup> [<backup> ...]
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] [--sort-ascending | --sort-descending] [--long] [--name <name>] [--status <status>] [--volume <volume>] [--marker <volume-backup>] [--limit <num-backups>] [--all-projects]
openstack volume backup record export [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <backup>
openstack volume backup record import [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <backup_service> <backup_metadata>
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>
openstack volume backup set [-h] [--name <name>] [--description <description>] [--state <state>] <backup>
openstack volume backup show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <backup>
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>
openstack volume delete [-h] [--force | --purge] <volume> [<volume> ...]
openstack volume host set [-h] [--disable | --enable] <host-name>
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] [--sort-ascending | --sort-descending] [--project <project>] [--project-domain <project-domain>] [--user <user>] [--user-domain <user-domain>] [--name <name>] [--status <status>] [--all-projects] [--long] [--marker <volume>] [--limit <num-volumes>]
openstack volume migrate [-h] --host <host> [--force-host-copy] [--lock-volume] <volume>
openstack volume qos associate [-h] <qos-spec> <volume-type>
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>
openstack volume qos delete [-h] [--force] <qos-spec> [<qos-spec> ...]
openstack volume qos disassociate [-h] [--volume-type <volume-type> | --all] <qos-spec>
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] [--sort-ascending | --sort-descending]
openstack volume qos set [-h] [--property <key=value>] <qos-spec>
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>
openstack volume qos unset [-h] [--property <key>] <qos-spec>
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] [--sort-ascending | --sort-descending] [--host <host>] [--service <service>] [--long]
openstack volume service set [-h] [--enable | --disable] [--disable-reason <reason>] <host> <service>
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>
openstack volume show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <volume>
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>
openstack volume snapshot delete [-h] [--force] <snapshot> [<snapshot> ...]
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] [--sort-ascending | --sort-descending] [--all-projects] [--project <project>] [--project-domain <project-domain>] [--long] [--marker <volume-snapshot>] [--limit <num-snapshots>] [--name <name>] [--status <status>] [--volume <volume>]
openstack volume snapshot set [-h] [--name <name>] [--description <description>] [--no-property] [--property <key=value>] [--state <state>] <snapshot>
openstack volume snapshot show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <snapshot>
openstack volume snapshot unset [-h] [--property <key>] <snapshot>
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>
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>
openstack volume transfer request delete [-h] <transfer-request> [<transfer-request> ...]
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] [--sort-ascending | --sort-descending] [--all-projects]
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>
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>
openstack volume type delete [-h] <volume-type> [<volume-type> ...]
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] [--sort-ascending | --sort-descending] [--long] [--default | --public | --private] [--encryption-type]
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>
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>
openstack volume type unset [-h] [--property <key>] [--project <project>] [--project-domain <project-domain>] [--encryption-type] <volume-type>
openstack volume unset [-h] [--property <key>] [--image-property <key>] <volume>