Chapter 76. volume
This chapter describes the commands under the volume
command.
76.1. volume backup create Copy linkLink copied to clipboard!
Usage:
Create new volume backup
Value | Summary |
---|---|
<volume> | Volume to backup (name or id) |
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 |
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 |
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. |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
76.2. volume backup delete Copy linkLink copied to clipboard!
Usage:
openstack volume backup delete [-h] [--force] <backup> [<backup> ...]
openstack volume backup delete [-h] [--force] <backup> [<backup> ...]
Delete volume backup(s)
Value | Summary |
---|---|
<backup> | Backup(s) to delete (name or id) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--force | Allow delete in state other than error or available |
76.3. volume backup list Copy linkLink copied to clipboard!
Usage:
List volume backups
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) |
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 |
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. |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | when to include quotes, defaults to nonnumeric |
76.4. volume backup restore Copy linkLink copied to clipboard!
Usage:
Restore volume backup
Value | Summary |
---|---|
<backup> | Backup to restore (name or id) |
<volume> | Volume to restore to (name or id) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
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 |
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. |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
76.5. volume backup set Copy linkLink copied to clipboard!
Usage:
openstack volume backup set [-h] [--name <name>] [--description <description>] [--state <state>] <backup>
openstack volume backup set [-h] [--name <name>]
[--description <description>]
[--state <state>]
<backup>
Set volume backup properties
Value | Summary |
---|---|
<backup> | Backup to modify (name or id) |
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) |
76.6. volume backup show Copy linkLink copied to clipboard!
Usage:
Display volume backup details
Value | Summary |
---|---|
<backup> | Backup to display (name or id) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
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 |
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. |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
76.7. volume create Copy linkLink copied to clipboard!
Usage:
Create new volume
Value | Summary |
---|---|
<name> | Volume name |
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 |
--user <user> | Specify an alternate user (name or id) |
--project <project> | Specify an alternate project (name or id) |
--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) |
--multi-attach | Allow volume to be attached more than once (default to False) |
--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) |
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 |
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. |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
76.8. volume delete Copy linkLink copied to clipboard!
Usage:
openstack volume delete [-h] [--force | --purge] <volume> [<volume> ...]
openstack volume delete [-h] [--force | --purge]
<volume> [<volume> ...]
Delete volume(s)
Value | Summary |
---|---|
<volume> | Volume(s) to delete (name or id) |
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) |
76.9. volume host failover Copy linkLink copied to clipboard!
Usage:
openstack volume host failover [-h] --volume-backend <backend-id> <host-name>
openstack volume host failover [-h] --volume-backend <backend-id>
<host-name>
Failover volume host to different backend
Value | Summary |
---|---|
<host-name> | Name of volume host |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--volume-backend <backend-id> | The ID of the volume backend replication target where the host will failover to (required) |
76.10. volume host set Copy linkLink copied to clipboard!
Usage:
openstack volume host set [-h] [--disable | --enable] <host-name>
openstack volume host set [-h] [--disable | --enable] <host-name>
Set volume host properties
Value | Summary |
---|---|
<host-name> | Name of volume host |
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 |
76.11. volume list Copy linkLink copied to clipboard!
Usage:
List volumes
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 |
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 |
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. |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | when to include quotes, defaults to nonnumeric |
76.12. volume migrate Copy linkLink copied to clipboard!
Usage:
openstack volume migrate [-h] --host <host> [--force-host-copy] [--lock-volume | --unlock-volume] <volume>
openstack volume migrate [-h] --host <host> [--force-host-copy]
[--lock-volume | --unlock-volume]
<volume>
Migrate volume to a new host
Value | Summary |
---|---|
<volume> | Volume to migrate (name or id) |
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) |
--unlock-volume | If specified, the volume state will not be locked and the a migration can be aborted (default) (possibly by another operation) |
76.13. volume qos associate Copy linkLink copied to clipboard!
Usage:
openstack volume qos associate [-h] <qos-spec> <volume-type>
openstack volume qos associate [-h] <qos-spec> <volume-type>
Associate a QoS specification to a volume type
Value | Summary |
---|---|
<qos-spec> | Qos specification to modify (name or id) |
<volume-type> | Volume type to associate the qos (name or id) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
76.14. volume qos create Copy linkLink copied to clipboard!
Usage:
Create new QoS specification
Value | Summary |
---|---|
<name> | New qos specification name |
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) |
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 |
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. |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
76.15. volume qos delete Copy linkLink copied to clipboard!
Usage:
openstack volume qos delete [-h] [--force] <qos-spec> [<qos-spec> ...]
openstack volume qos delete [-h] [--force] <qos-spec> [<qos-spec> ...]
Delete QoS specification
Value | Summary |
---|---|
<qos-spec> | Qos specification(s) to delete (name or id) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--force | Allow to delete in-use qos specification(s) |
76.16. volume qos disassociate Copy linkLink copied to clipboard!
Usage:
openstack volume qos disassociate [-h] [--volume-type <volume-type> | --all] <qos-spec>
openstack volume qos disassociate [-h]
[--volume-type <volume-type> | --all]
<qos-spec>
Disassociate a QoS specification from a volume type
Value | Summary |
---|---|
<qos-spec> | Qos specification to modify (name or id) |
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 |
76.17. volume qos list Copy linkLink copied to clipboard!
Usage:
List QoS specifications
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
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 |
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. |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | when to include quotes, defaults to nonnumeric |
76.18. volume qos set Copy linkLink copied to clipboard!
Usage:
openstack volume qos set [-h] [--property <key=value>] <qos-spec>
openstack volume qos set [-h] [--property <key=value>] <qos-spec>
Set QoS specification properties
Value | Summary |
---|---|
<qos-spec> | Qos specification to modify (name or id) |
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) |
76.19. volume qos show Copy linkLink copied to clipboard!
Usage:
Display QoS specification details
Value | Summary |
---|---|
<qos-spec> | Qos specification to display (name or id) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
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 |
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. |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
76.20. volume qos unset Copy linkLink copied to clipboard!
Usage:
openstack volume qos unset [-h] [--property <key>] <qos-spec>
openstack volume qos unset [-h] [--property <key>] <qos-spec>
Unset QoS specification properties
Value | Summary |
---|---|
<qos-spec> | Qos specification to modify (name or id) |
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) |
76.21. volume service list Copy linkLink copied to clipboard!
Usage:
List service command
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 |
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 |
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. |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | when to include quotes, defaults to nonnumeric |
76.22. volume service set Copy linkLink copied to clipboard!
Usage:
openstack volume service set [-h] [--enable | --disable] [--disable-reason <reason>] <host> <service>
openstack volume service set [-h] [--enable | --disable]
[--disable-reason <reason>]
<host> <service>
Set volume service properties
Value | Summary |
---|---|
<host> | Name of host |
<service> | Name of service (binary name) |
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) |
76.23. volume set Copy linkLink copied to clipboard!
Usage:
Set volume properties
Value | Summary |
---|---|
<volume> | Volume to modify (name or id) |
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) |
--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 |
76.24. volume show Copy linkLink copied to clipboard!
Usage:
openstack volume show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] <volume>
openstack volume show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--fit-width]
[--print-empty] [--noindent] [--prefix PREFIX]
<volume>
Display volume details
Value | Summary |
---|---|
<volume> | Volume to display (name or id) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
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 |
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. |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
76.25. volume snapshot create Copy linkLink copied to clipboard!
Usage:
Create new volume snapshot
Value | Summary |
---|---|
<snapshot-name> | Name of the new snapshot |
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' |
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 |
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. |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
76.26. volume snapshot delete Copy linkLink copied to clipboard!
Usage:
openstack volume snapshot delete [-h] [--force] <snapshot> [<snapshot> ...]
openstack volume snapshot delete [-h] [--force]
<snapshot> [<snapshot> ...]
Delete volume snapshot(s)
Value | Summary |
---|---|
<snapshot> | Snapshot(s) to delete (name or id) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--force | Attempt forced removal of snapshot(s), regardless of state (defaults to False) |
76.27. volume snapshot list Copy linkLink copied to clipboard!
Usage:
List volume snapshots
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). |
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 |
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. |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | when to include quotes, defaults to nonnumeric |
76.28. volume snapshot set Copy linkLink copied to clipboard!
Usage:
Set volume snapshot properties
Value | Summary |
---|---|
<snapshot> | Snapshot to modify (name or id) |
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) |
76.29. volume snapshot show Copy linkLink copied to clipboard!
Usage:
Display volume snapshot details
Value | Summary |
---|---|
<snapshot> | Snapshot to display (name or id) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
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 |
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. |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
76.30. volume snapshot unset Copy linkLink copied to clipboard!
Usage:
openstack volume snapshot unset [-h] [--property <key>] <snapshot>
openstack volume snapshot unset [-h] [--property <key>] <snapshot>
Unset volume snapshot properties
Value | Summary |
---|---|
<snapshot> | Snapshot to modify (name or id) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--property <key> | Property to remove from snapshot (repeat option to remove multiple properties) |
76.31. volume transfer request accept Copy linkLink copied to clipboard!
Usage:
Accept volume transfer request.
Value | Summary |
---|---|
<transfer-request-id> | Volume transfer request to accept (ID only) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--auth-key <key> | Volume transfer request authentication key |
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 |
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. |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
76.32. volume transfer request create Copy linkLink copied to clipboard!
Usage:
Create volume transfer request.
Value | Summary |
---|---|
<volume> | Volume to transfer (name or id) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--name <name> | New transfer request name (default to none) |
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 |
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. |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
76.33. volume transfer request delete Copy linkLink copied to clipboard!
Usage:
openstack volume transfer request delete [-h] <transfer-request> [<transfer-request> ...]
openstack volume transfer request delete [-h]
<transfer-request>
[<transfer-request> ...]
Delete volume transfer request(s).
Value | Summary |
---|---|
<transfer-request> | Volume transfer request(s) to delete (name or id) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
76.34. volume transfer request list Copy linkLink copied to clipboard!
Usage:
Lists all volume transfer requests.
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--all-projects | Include all projects (admin only) |
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 |
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. |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | when to include quotes, defaults to nonnumeric |
76.35. volume transfer request show Copy linkLink copied to clipboard!
Usage:
Show volume transfer request details.
Value | Summary |
---|---|
<transfer-request> | Volume transfer request to display (name or id) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
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 |
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. |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
76.36. volume type create Copy linkLink copied to clipboard!
Usage:
Create new volume type
Value | Summary |
---|---|
<name> | Volume type name |
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. |
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 |
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. |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
76.37. volume type delete Copy linkLink copied to clipboard!
Usage:
openstack volume type delete [-h] <volume-type> [<volume-type> ...]
openstack volume type delete [-h] <volume-type> [<volume-type> ...]
Delete volume type(s)
Value | Summary |
---|---|
<volume-type> | Volume type(s) to delete (name or id) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
76.38. volume type list Copy linkLink copied to clipboard!
Usage:
List volume types
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) |
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 |
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. |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | when to include quotes, defaults to nonnumeric |
76.39. volume type set Copy linkLink copied to clipboard!
Usage:
Set volume type properties
Value | Summary |
---|---|
<volume-type> | Volume type to modify (name or id) |
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") |
76.40. volume type show Copy linkLink copied to clipboard!
Usage:
Display volume type details
Value | Summary |
---|---|
<volume-type> | Volume type to display (name or id) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--encryption-type | Display encryption information of this volume type (admin only) |
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 |
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. |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
76.41. volume type unset Copy linkLink copied to clipboard!
Usage:
Unset volume type properties
Value | Summary |
---|---|
<volume-type> | Volume type to modify (name or id) |
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) |
76.42. volume unset Copy linkLink copied to clipboard!
Usage:
openstack volume unset [-h] [--property <key>] [--image-property <key>] <volume>
openstack volume unset [-h] [--property <key>] [--image-property <key>]
<volume>
Unset volume properties
Value | Summary |
---|---|
<volume> | Volume to modify (name or id) |
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) |