Chapter 71. volume

--print-empty

Print empty table if there is no data to show.

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

<volume>

Volume to backup (name or 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

--force

Allow to back up an in-use volume

--incremental

Perform an incremental backup

--name <name>

Name of the backup

--container <container>

Optional backup container name

--snapshot <snapshot>

Snapshot to backup (name or id)

-h, --help

Show this help message and exit

--description <description>

Description of the backup

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

Add a prefix to all variable names

<backup>

Backup(s) to delete (name or id)

--force

Allow delete in state other than error or available

-h, --help

Show this help message and exit

--print-empty

Print empty table if there is no data to show.

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

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

When to include quotes, defaults to nonnumeric

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

--noindent

Whether to disable indenting the json

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

--volume <volume>

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

--long

List additional fields in output

--status <status>

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

--name <name>

Filters results by the backup name

-h, --help

Show this help message and exit

--print-empty

Print empty table if there is no data to show.

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

<volume>

Volume to restore to (name or id)

<backup>

Backup to restore (name or 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

-h, --help

Show this help message and exit

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

Add a prefix to all variable names

<backup>

Backup to modify (name or id)

--name <name>

New backup name

-h, --help

Show this help message and exit

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

--print-empty

Print empty table if there is no data to show.

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

<backup>

Backup to display (name or 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

-h, --help

Show this help message and exit

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

Add a prefix to all variable names

--print-empty

Print empty table if there is no data to show.

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

<name>

Volume name

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

--property <key=value>

Set a property to this volume (repeat option to set multiple properties)

--bootable

Mark volume as bootable

--non-bootable

Mark volume as non-bootable (default)

--type <volume-type>

Set the type of volume

--availability-zone <availability-zone>

Create volume in <availability-zone>

--read-only

Set volume to read-only access mode

--consistency-group consistency-group>

Consistency group where the new volume belongs to

--size <size>

Volume size in gb (required unless --snapshot or --source or --source-replicated is specified)

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

--read-write

Set volume to read-write access mode (default)

--image <image>

Use <image> as source of volume (name or id)

--source <volume>

Volume to clone (name or id)

--user <user>

Specify an alternate user (name or id)

--snapshot <snapshot>

Use <snapshot> as source of volume (name or id)

-h, --help

Show this help message and exit

--description <description>

Volume description

--project <project>

Specify an alternate project (name or id)

--source-replicated <replicated-volume>

Replicated volume to clone (name or id)

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

Add a prefix to all variable names

<volume>

Volume(s) to delete (name or id)

--force

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

-h, --help

Show this help message and exit

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

--print-empty

Print empty table if there is no data to show.

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

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

When to include quotes, defaults to nonnumeric

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

--noindent

Whether to disable indenting the json

--limit <num-volumes>

Maximum number of volumes to display

--name <name>

Filter results by volume name

--all-projects

Include all projects (admin only)

--user <user>

Filter results by user (name or id) (admin only)

--long

List additional fields in output

--project-domain <project-domain>

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

--status <status>

Filter results by status

--marker <volume>

The last volume id of the previous page

--user-domain <user-domain>

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

-h, --help

Show this help message and exit

--project <project>

Filter results by project (name or id) (admin only)

<volume>

Volume to migrate (name or id)

-h, --help

Show this help message and exit

--lock-volume

If specified, the volume state will be locked and will not allow a migration to be aborted (possibly by another operation)

--host <host>

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

--unlock-volume

If specified, the volume state will not be locked and the a migration can be aborted (default) (possibly by another operation)

--force-host-copy

Enable generic host-based force-migration, which bypasses driver optimizations

<volume-type>

Volume type to associate the qos (name or id)

<qos-spec>

Qos specification to modify (name or id)

-h, --help

Show this help message and exit

--print-empty

Print empty table if there is no data to show.

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

<name>

New qos specification name

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

--consumer <consumer>

Consumer of the qos. valid consumers: back-end, both, front-end (defaults to both)

-h, --help

Show this help message and exit

--property <key=value>

Set a qos specification property (repeat option to set multiple properties)

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

Add a prefix to all variable names

<qos-spec>

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

--force

Allow to delete in-use qos specification(s)

-h, --help

Show this help message and exit

<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

--print-empty

Print empty table if there is no data to show.

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

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

When to include quotes, defaults to nonnumeric

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

--noindent

Whether to disable indenting the json

-h, --help

Show this help message and exit

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

--print-empty

Print empty table if there is no data to show.

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

<qos-spec>

Qos specification to display (name or 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

-h, --help

Show this help message and exit

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

Add a prefix to all variable names

<qos-spec>

Qos specification to modify (name or id)

--property <key>

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

-h, --help

Show this help message and exit

--print-empty

Print empty table if there is no data to show.

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

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

When to include quotes, defaults to nonnumeric

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

--noindent

Whether to disable indenting the json

-h, --help

Show this help message and exit

--host <host>

List services on specified host (name only)

--long

List additional fields in output

--service <service>

List only specified service (name only)

<service>

Name of service (binary name)

<host>

Name of host

-h, --help

Show this help message and exit

--disable

Disable volume service

--disable-reason <reason>

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

--enable

Enable volume service

<volume>

Volume to modify (name or id)

--bootable

Mark volume as bootable

--non-bootable

Mark volume as non-bootable

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

--name <name>

New volume name

--property <key=value>

Set a property on this volume (repeat option to set multiple properties)

--size <size>

Extend volume size in gb

--read-only

Set volume to read-only access mode

--read-write

Set volume to read-write access mode

--no-property

Remove all properties from <volume> (specify both --no-property and --property to remove the current properties before setting new properties.)

--type <volume-type>

New volume type (name or id)

--image-property <key=value>

Set an image property on this volume (repeat option to set multiple image properties)

-h, --help

Show this help message and exit

--description <description>

New volume description

--retype-policy <retype-policy>

Migration policy while re-typing volume ("never" or "on-demand", default is "never" ) (available only when --type option is specified)

--print-empty

Print empty table if there is no data to show.

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

<volume>

Volume to display (name or 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

-h, --help

Show this help message and exit

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

Add a prefix to all variable names

--print-empty

Print empty table if there is no data to show.

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

<snapshot-name>

Name of the new snapshot

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

--force

Create a snapshot attached to an instance. default is False

--volume <volume>

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

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

-h, --help

Show this help message and exit

--description <description>

Description of the snapshot

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

Add a prefix to all variable names

<snapshot>

Snapshot(s) to delete (name or id)

--force

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

-h, --help

Show this help message and exit

--print-empty

Print empty table if there is no data to show.

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

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

When to include quotes, defaults to nonnumeric

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

--noindent

Whether to disable indenting the json

--status <status>

Filters results by a status. (available, error, creating, deleting or error-deleting)

--all-projects

Include all projects (admin only)

--name <name>

Filters results by a name.

--long

List additional fields in output

--project-domain <project-domain>

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

--marker <volume-snapshot>

The last snapshot id of the previous page

--limit <num-snapshots>

Maximum number of snapshots to display

--volume <volume>

Filters results by a volume (name or id).

-h, --help

Show this help message and exit

--project <project>

Filter results by project (name or id) (admin only)

<snapshot>

Snapshot to modify (name or id)

--name <name>

New snapshot name

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

--no-property

Remove all properties from <snapshot> (specify both --no-property and --property to remove the current properties before setting new properties.)

-h, --help

Show this help message and exit

--description <description>

New snapshot description

--print-empty

Print empty table if there is no data to show.

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

<snapshot>

Snapshot to display (name or 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

-h, --help

Show this help message and exit

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

Add a prefix to all variable names

<snapshot>

Snapshot to modify (name or id)

--property <key>

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

-h, --help

Show this help message and exit

--print-empty

Print empty table if there is no data to show.

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

<transfer-request-id>

Volume transfer request to accept (id 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

-h, --help

Show this help message and exit

--auth-key <key>

Volume transfer request authentication key

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

Add a prefix to all variable names

--print-empty

Print empty table if there is no data to show.

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

<volume>

Volume to transfer (name or 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

--name <name>

New transfer request name (default to none)

-h, --help

Show this help message and exit

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

Add a prefix to all variable names

<transfer-request>

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

-h, --help

Show this help message and exit

--print-empty

Print empty table if there is no data to show.

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

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

When to include quotes, defaults to nonnumeric

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

--noindent

Whether to disable indenting the json

--all-projects

Include all projects (admin only)

-h, --help

Show this help message and exit

--print-empty

Print empty table if there is no data to show.

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

<transfer-request>

Volume transfer request to display (name or 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

-h, --help

Show this help message and exit

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

Add a prefix to all variable names

--print-empty

Print empty table if there is no data to show.

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

<name>

Volume type name

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

--public

Volume type is accessible to the public

--private

Volume type is not accessible to the public

--encryption-key-size <key-size>

Set the size of the encryption key of this volume type (e.g "128" or "256") (admin only)

--property <key=value>

Set a property on this volume type (repeat option to set multiple properties)

--project-domain <project-domain>

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

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

--encryption-provider <provider>

Set the class that provides encryption support for this volume type (e.g "LuksEncryptor") (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)

-h, --help

Show this help message and exit

--description <description>

Volume type description

--project <project>

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

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

Add a prefix to all variable names

<volume-type>

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

-h, --help

Show this help message and exit

--print-empty

Print empty table if there is no data to show.

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

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

When to include quotes, defaults to nonnumeric

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

--noindent

Whether to disable indenting the json

--public

List only public types

--private

List only private types (admin only)

--long

List additional fields in output

--default

List the default volume type

-h, --help

Show this help message and exit

--encryption-type

Display encryption information for each volume type (admin only)

<volume-type>

Volume type to modify (name or id)

--encryption-key-size <key-size>

Set the size of the encryption key of this volume type (e.g "128" or "256") (admin only)

--name <name>

Set volume type name

--property <key=value>

Set a property on this volume type (repeat option to set multiple properties)

--project-domain <project-domain>

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

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

--encryption-provider <provider>

Set the class that provides encryption support for this volume type (e.g "LuksEncryptor") (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)

-h, --help

Show this help message and exit

--description <description>

Set volume type description

--project <project>

Set volume type access to project (name or id) (admin only)

--print-empty

Print empty table if there is no data to show.

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

<volume-type>

Volume type to display (name or 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

-h, --help

Show this help message and exit

--encryption-type

Display encryption information of this volume type (admin only)

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

Add a prefix to all variable names

<volume-type>

Volume type to modify (name or id)

--property <key>

Remove a property from this volume type (repeat option to remove multiple properties)

-h, --help

Show this help message and exit

--encryption-type

Remove the encryption type for this volume type (admin only)

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

<volume>

Volume to modify (name or id)

--property <key>

Remove a property from volume (repeat option to remove multiple properties)

-h, --help

Show this help message and exit

--image-property <key>

Remove an image property from volume (repeat option to remove multiple image properties)