Chapter 89. volume

<host>

List capabilities of specified host (host@backend- name)

-h, --help

Show this help message and exit

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

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

When to include quotes, defaults to nonnumeric

--noindent

Whether to disable indenting the json

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

-h, --help

Show this help message and exit

--long

Show detailed information about pools.

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

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

When to include quotes, defaults to nonnumeric

--noindent

Whether to disable indenting the json

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

<volume>

Volume to backup (name or id)

-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

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--noindent

Whether to disable indenting the json

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

Add a prefix to all variable names

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

<backup>

Backup(s) to delete (name or id)

-h, --help

Show this help message and exit

--force

Allow delete in state other than error or available

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

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

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

When to include quotes, defaults to nonnumeric

--noindent

Whether to disable indenting the json

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

<backup>

Backup to export (name or id)

-h, --help

Show this help message and exit

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--noindent

Whether to disable indenting the json

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

Add a prefix to all variable names

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

<backup_service>

Backup service containing the backup.

<backup_metadata>

Encoded backup metadata from export.

-h, --help

Show this help message and exit

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--noindent

Whether to disable indenting the json

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

Add a prefix to all variable names

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

<backup>

Backup to restore (name or id)

<volume>

Volume to restore to (name or id)

-h, --help

Show this help message and exit

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--noindent

Whether to disable indenting the json

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

Add a prefix to all variable names

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

<backup>

Backup to modify (name or id)

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

<backup>

Backup to display (name or id)

-h, --help

Show this help message and exit

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--noindent

Whether to disable indenting the json

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

Add a prefix to all variable names

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

<name>

Volume name

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

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

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--noindent

Whether to disable indenting the json

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

Add a prefix to all variable names

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

<volume>

Volume(s) to delete (name or id)

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

<host-name>

Name of volume host

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

<host-name>

Name of volume host

-h, --help

Show this help message and exit

--disable

Freeze and disable the specified volume host

--enable

Thaw and enable the specified volume host

-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

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

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

When to include quotes, defaults to nonnumeric

--noindent

Whether to disable indenting the json

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

<volume>

Volume to migrate (name or id)

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

<qos-spec>

Qos specification to modify (name or id)

<volume-type>

Volume type to associate the qos (name or id)

-h, --help

Show this help message and exit

<name>

New qos specification name

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

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--noindent

Whether to disable indenting the json

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

Add a prefix to all variable names

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

<qos-spec>

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

-h, --help

Show this help message and exit

--force

Allow to delete in-use qos specification(s)

<qos-spec>

Qos specification to modify (name or id)

-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

-h, --help

Show this help message and exit

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

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

When to include quotes, defaults to nonnumeric

--noindent

Whether to disable indenting the json

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

<qos-spec>

Qos specification to modify (name or id)

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

<qos-spec>

Qos specification to display (name or id)

-h, --help

Show this help message and exit

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--noindent

Whether to disable indenting the json

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

Add a prefix to all variable names

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

<qos-spec>

Qos specification to modify (name or id)

-h, --help

Show this help message and exit

--property <key>

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

-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

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

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

When to include quotes, defaults to nonnumeric

--noindent

Whether to disable indenting the json

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

<host>

Name of host

<service>

Name of service (binary name)

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

<volume>

Volume to modify (name or id)

-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

<volume>

Volume to display (name or id)

-h, --help

Show this help message and exit

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--noindent

Whether to disable indenting the json

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

Add a prefix to all variable names

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

<snapshot-name>

Name of the new snapshot

-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

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--noindent

Whether to disable indenting the json

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

Add a prefix to all variable names

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

<snapshot>

Snapshot(s) to delete (name or id)

-h, --help

Show this help message and exit

--force

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

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

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

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

When to include quotes, defaults to nonnumeric

--noindent

Whether to disable indenting the json

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

<snapshot>

Snapshot to modify (name or id)

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

<snapshot>

Snapshot to display (name or id)

-h, --help

Show this help message and exit

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--noindent

Whether to disable indenting the json

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

Add a prefix to all variable names

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

<snapshot>

Snapshot to modify (name or id)

-h, --help

Show this help message and exit

--property <key>

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

<transfer-request-id>

Volume transfer request to accept (id only)

-h, --help

Show this help message and exit

--auth-key <key>

Volume transfer request authentication key

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--noindent

Whether to disable indenting the json

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

Add a prefix to all variable names

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

<volume>

Volume to transfer (name or id)

-h, --help

Show this help message and exit

--name <name>

New transfer request name (default to none)

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--noindent

Whether to disable indenting the json

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

Add a prefix to all variable names

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

<transfer-request>

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

-h, --help

Show this help message and exit

-h, --help

Show this help message and exit

--all-projects

Include all projects (admin only)

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

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

When to include quotes, defaults to nonnumeric

--noindent

Whether to disable indenting the json

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

<transfer-request>

Volume transfer request to display (name or id)

-h, --help

Show this help message and exit

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--noindent

Whether to disable indenting the json

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

Add a prefix to all variable names

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

<name>

Volume type name

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

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--noindent

Whether to disable indenting the json

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

Add a prefix to all variable names

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

<volume-type>

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

-h, --help

Show this help message and exit

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

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

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

When to include quotes, defaults to nonnumeric

--noindent

Whether to disable indenting the json

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

<volume-type>

Volume type to modify (name or id)

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

<volume-type>

Volume type to display (name or id)

-h, --help

Show this help message and exit

--encryption-type

Display encryption information of this volume type (admin only)

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--noindent

Whether to disable indenting the json

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

Add a prefix to all variable names

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

<volume-type>

Volume type to modify (name or id)

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

<volume>

Volume to modify (name or id)

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