Chapter 75. share

<share>

Name or id of the share(s)

-h, --help

Show this help message and exit

--wait

Wait until share is abandoned

<share>

Name or id of the nas share to modify.

<access_type>

Access rule type (only "ip", "user" (user or group), "cert" or "cephx" are supported).

<access_to>

Value that defines access.

-h, --help

Show this help message and exit

--properties [<key=value> …​]

Space separated list of key=value pairs of properties. OPTIONAL: Default=None. Available only for API microversion >= 2.45.

--access-level <access_level>

Share access level ("rw" and "ro" access levels are supported). Defaults to rw.

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--noindent

Whether to disable indenting the json

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

<share>

Name or id of the nas share to modify.

<id>

Id of the access rule to be deleted.

-h, --help

Show this help message and exit

<share>

Name or id of the share.

-h, --help

Show this help message and exit

--properties [<key=value> …​]

Filters results by properties (key=value). optional: Default=None. Available only for API microversion >= 2.45

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

--sort-ascending

Sort the column(s) in ascending order

--sort-descending

Sort the column(s) in descending order

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

<access_id>

Id of the nas share access rule.

-h, --help

Show this help message and exit

--property <key=value>

Set a property to this share access rule. (repeat option to set multiple properties) Available only for API microversion >= 2.45.

<access_id>

Id of the nas share access rule.

-h, --help

Show this help message and exit

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--noindent

Whether to disable indenting the json

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

<access_id>

Id of the nas share access rule.

-h, --help

Show this help message and exit

--property <key>

Remove property from share access rule. (repeat option to remove multiple properties) Available only for API microversion >= 2.45.

<service-host>

Service host: some.host@driver#pool.

<protocol>

Protocol of the share to manage, such as nfs or cifs.

<export-path>

Share export path, nfs share such as: 10.0.0.1:/example_path, CIFS share such as: \\10.0.0.1\example_cifs_share.

-h, --help

Show this help message and exit

--name <name>

Optional share name. (default=none)

--description <description>

Optional share description. (default=none)

--share-type <share-type>

Optional share type assigned to share. (default=none)

--driver-options [<key=value> …​]

Optional driver options as key=value pairs (Default=None).

--public

Level of visibility for share. defines whether other projects are able to see it or not. Available only for microversion >= 2.8. (Default=False)

--share-server-id <share-server-id>

Share server associated with share when using a share type with "driver_handles_share_servers" extra_spec set to True. Available only for microversion >= 2.49. (Default=None)

--wait

Wait until share is adopted

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--noindent

Whether to disable indenting the json

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

<share_protocol>

Share protocol (nfs, cifs, cephfs, glusterfs or hdfs)

<size>

Share size in gib.

-h, --help

Show this help message and exit

--name <name>

Optional share name. (default=none)

--snapshot-id <snapshot-id>

Optional snapshot id to create the share from. (Default=None)

--property <key=value>

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

--share-network <network-info>

Optional network info id or name.

--description <description>

Optional share description. (default=none)

--public <public>

Level of visibility for share. defines whether other tenants are able to see it or not. (Default = False)

--share-type <share-type>

Optional share type. use of optional shares type is deprecated. (Default=Default)

--availability-zone <availability-zone>

Availability zone in which share should be created.

--share-group <share-group>

Optional share group name or id in which to create the share. (Default=None).

--wait

Wait for share creation

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--noindent

Whether to disable indenting the json

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

<share>

Share(s) to delete (name or id)

-h, --help

Show this help message and exit

--share-group <share-group>

Optional share group (name or id)which contains the share

--force

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

--wait

Wait for share deletion

<share>

Name or id of share

-h, --help

Show this help message and exit

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

--sort-ascending

Sort the column(s) in ascending order

--sort-descending

Sort the column(s) in descending order

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

<share>

Name or id of share

<export-location>

Id of the share export location

-h, --help

Show this help message and exit

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--noindent

Whether to disable indenting the json

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

-h, --help

Show this help message and exit

--name <share-name>

Filter shares by share name

--status <share-status>

Filter shares by status

--snapshot <share-network-id>

Filter shares by snapshot name or id.

--public

Include public shares

--share-network <share-network-name-or-id>

Filter shares exported on a given share network

--share-type <share-type-name-or-id>

Filter shares of a given share type

--share-group <share-group-name-or-id>

Filter shares belonging to a given share group

--host <share-host>

Filter shares belonging to a given host (admin only)

--share-server <share-server-id>

Filter shares exported via a given share server (admin only)

--project <project>

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

--all-projects

Include all projects (admin only)

--property <key=value>

Filter shares having a given metadata key=value property (repeat option to filter by multiple properties)

--extra-spec <key=value>

Filter shares with extra specs (key=value) of the share type that they belong to. (repeat option to filter by multiple extra specs)

--long

List additional fields in output

--sort <key>[:<direction>]

Sort output by selected keys and directions(asc or desc) (default: name:asc), multiple keys and directions can be specified separated by comma

--limit <num-shares>

Maximum number of shares to display

--marker <share>

The last share id of the previous page

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

--sort-ascending

Sort the column(s) in ascending order

--sort-descending

Sort the column(s) in descending order

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

<message>

Id of the message(s).

-h, --help

Show this help message and exit

-h, --help

Show this help message and exit

--resource-id <resource-id>

Filters results by a resource uuid. default=none.

--resource-type <resource-type>

Filters results by a resource type. default=none. Example: "openstack message list --resource-type share"

--action-id <action-id>

Filters results by action id. default=none.

--detail-id <detail-id>

Filters results by detail id. default=none.

--request-id <request-id>

Filters results by request id. default=none.

--message-level <message-level>

Filters results by the message level. default=none. Example: "openstack message list --message-level ERROR".

--limit <limit>

Maximum number of messages to return. (default=none)

--since <since>

Return only user messages created since given date. The date format must be conforming to ISO8601. Available only for microversion >= 2.52.

--before <before>

Return only user messages created before given date. The date format must be conforming to ISO8601. Available only for microversion >= 2.52.

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

--sort-ascending

Sort the column(s) in ascending order

--sort-descending

Sort the column(s) in descending order

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

<message>

Id of the message.

-h, --help

Show this help message and exit

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--noindent

Whether to disable indenting the json

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

<share>

Name or id of share

-h, --help

Show this help message and exit

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--noindent

Whether to disable indenting the json

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

-h, --help

Show this help message and exit

--project <project>

Name or id of the project to delete quotas for.

--user <user>

Name or id of user to delete the quotas for. optional. Mutually exclusive with --share-type.

--share-type <share-type>

Name or id of a share type to delete the quotas for. Optional. Mutually exclusive with --user. Available only for microversion >= 2.39

-h, --help

Show this help message and exit

--project <project>

Name or id of the project to set the quotas for.

--user <user>

Name or id of a user to set the quotas for. optional. Mutually exclusive with --share-type.

--shares <shares>

New value for the "shares" quota.

--snapshots <snapshots>

New value for the "snapshots" quota.

--gigabytes <gigabytes>

New value for the "gigabytes" quota.

--snapshot-gigabytes <snapshot-gigabytes>

New value for the "snapshot-gigabytes" quota.

--share-networks <share-networks>

New value for the "share-networks" quota.

--share-groups <share-groups>

New value for the "share-groups" quota.available only for microversion >= 2.40

--share-group-snapshots <share-group-snapshots>

New value for the "share-group-snapshots" quota.

--share-replicas <share-replicas>

Number of share replicas. available only for microversion >= 2.53

--replica-gigabytes <replica-gigabytes>

Capacity of share replicas in total. available only for microversion >= 2.53

--share-type <share-type>

Name or id of a share type to set the quotas for. Optional. Mutually exclusive with --user. Available only for microversion >= 2.39

--force

Force update the quota.

-h, --help

Show this help message and exit

--project <project>

Name or id of hte project to list quotas for.

--user <user>

Name or id of user to list the quotas for. optional. Mutually exclusive with --share-type.

--share-type <share-type>

Uuid or name of a share type to list the quotas for. Optional. Mutually exclusive with --user. Available only for microversion >= 2.39

--detail

Optional flag to indicate whether to show quota in detail. Default false, available only for microversion >= 2.25.

--defaults

Show the default quotas for the project.

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--noindent

Whether to disable indenting the json

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

<share>

Name or id of share to resize

<new-size>

New size of share, in gibs

-h, --help

Show this help message and exit

--wait

Wait for share resize

<snapshot>

Name or id of the snapshot to restore. the snapshot must be the most recent one known to manila.

-h, --help

Show this help message and exit

<share>

Share to modify (name or id)

-h, --help

Show this help message and exit

--property <key=value>

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

--name <name>

New share name. (default=none)

--description <description>

New share description. (default=none)

--public <public>

Level of visibility for share. defines whether other tenants are able to see it or not.

--status <status>

Explicitly update the status of a share (admin only). Examples include: available, error, creating, deleting, error_deleting.

<share>

Share to display (name or id)

-h, --help

Show this help message and exit

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--noindent

Whether to disable indenting the json

--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 or id of the snapshot(s) to be abandoned.

-h, --help

Show this help message and exit

<snapshot>

Name or id of the snapshot

<access_type>

Access rule type (only "ip", "user" (user or group), "cert" or "cephx" are supported).

<access_to>

Value that defines access.

-h, --help

Show this help message and exit

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--noindent

Whether to disable indenting the json

--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 or id of the share snapshot to deny access to.

<id>

Id(s) of the access rule(s) to be deleted.

-h, --help

Show this help message and exit

<snapshot>

Name or id of the share snapshot to show access list for.

-h, --help

Show this help message and exit

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

--sort-ascending

Sort the column(s) in ascending order

--sort-descending

Sort the column(s) in descending order

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

<share>

Name or id of the share that owns the snapshot to be adopted.

<provider-location>

Provider location of the snapshot on the backend.

-h, --help

Show this help message and exit

--name <name>

Optional snapshot name (default=none).

--description <description>

Optional snapshot description (default=none).

--driver-option <key=value>

Set driver options as key=value pairs.(repeat option to set multiple key=value pairs)

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--noindent

Whether to disable indenting the json

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

<share>

Name or id of the share to create snapshot of

-h, --help

Show this help message and exit

--force

Optional flag to indicate whether to snapshot a share even if it’s busy. (Default=False)

--name <name>

Add a name to the snapshot (optional).

--description <description>

Add a description to the snapshot (optional).

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--noindent

Whether to disable indenting the json

--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 or id of the snapshot(s) to delete

-h, --help

Show this help message and exit

--force

Delete the snapshot(s) ignoring the current state.

<snapshot>

Name or id of the share snapshot.

-h, --help

Show this help message and exit

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

--sort-ascending

Sort the column(s) in ascending order

--sort-descending

Sort the column(s) in descending order

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

Name or id of the share snapshot.

<export-location>

Id of the share snapshot export location.

-h, --help

Show this help message and exit

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--noindent

Whether to disable indenting the json

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

-h, --help

Show this help message and exit

--all-projects

Display snapshots from all projects (admin only).

--name <name>

Filter results by name.

--description <description>

Filter results by description. available only for microversion >= 2.36.

--status <status>

Filter results by status

--share <share>

Name or id of a share to filter results by.

--usage <usage>

Option to filter snapshots by usage.

--limit <num-snapshots>

Limit the number of snapshots returned

--marker <snapshot>

The last share id of the previous page

--sort <key>[:<direction>]

Sort output by selected keys and directions(asc or desc) (default: name:asc), multiple keys and directions can be specified separated by comma

--name~ <name~>

Filter results matching a share snapshot name pattern. Available only for microversion >= 2.36.

--description~ <description~>

Filter results matching a share snapshot description pattern. Available only for microversion >= 2.36.

--detail

List share snapshots with details

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

--sort-ascending

Sort the column(s) in ascending order

--sort-descending

Sort the column(s) in descending order

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

Name or id of the snapshot to set a property for

-h, --help

Show this help message and exit

--name <name>

Set a name to the snapshot.

--description <description>

Set a description to the snapshot.

--status <status>

Assign a status to the snapshot (admin only). options include : available, error, creating, deleting, manage_starting, manage_error, unmanage_starting, unmanage_error, error_deleting.

<snapshot>

Name or id of the snapshot to display

-h, --help

Show this help message and exit

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--noindent

Whether to disable indenting the json

--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 or id of the snapshot to set a property for

-h, --help

Show this help message and exit

--name

Unset snapshot name.

--description

Unset snapshot description.

<share_type>

Share type name or id to add access to

<project_id>

Project id to add share type access for

-h, --help

Show this help message and exit

<share_type>

Share type name or id to delete access from

<project_id>

Project id to delete share type access for

-h, --help

Show this help message and exit

<share_type>

Share type name or id to get access list for

-h, --help

Show this help message and exit

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

--sort-ascending

Sort the column(s) in ascending order

--sort-descending

Sort the column(s) in descending order

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

<name>

Share type name

<spec_driver_handles_share_servers>

Required extra specification. valid values are true and false

-h, --help

Show this help message and exit

--description <description>

Share type description. available only for microversion >= 2.41.

--snapshot-support <snapshot_support>

Boolean extra spec used for filtering of back ends by their capability to create share snapshots.

--create-share-from-snapshot-support <create_share_from_snapshot_support>

Boolean extra spec used for filtering of back ends by their capability to create shares from snapshots.

--revert-to-snapshot-support <revert_to_snapshot_support>

Boolean extra spec used for filtering of back ends by their capability to revert shares to snapshots. (Default is False).

--mount-snapshot-support <mount_snapshot_support>

Boolean extra spec used for filtering of back ends by their capability to mount share snapshots. (Default is False).

--extra-specs [<key=value> …​]

Extra specs key and value of share type that will be used for share type creation. OPTIONAL: Default=None. example --extra-specs thin_provisioning=<is> True, replication_type=readable.

--public <public>

Make type accessible to the public (default true).

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--noindent

Whether to disable indenting the json

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

<share_types>

Name or id of the share type(s) to delete

-h, --help

Show this help message and exit

-h, --help

Show this help message and exit

--all

Display all share types whatever public or private. Default=False. (Admin only)

--extra-specs [<key=value> …​]

Filter share types with extra specs (key=value). Available only for API microversion >= 2.43. OPTIONAL: Default=None.

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

--sort-ascending

Sort the column(s) in ascending order

--sort-descending

Sort the column(s) in descending order

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

<share_type>

Name or id of the share type to modify

-h, --help

Show this help message and exit

--extra-specs [<key=value> …​]

Extra specs key and value of share type that will be used for share type creation. OPTIONAL: Default=None. example --extra-specs thin_provisioning=<is> True, replication_type=readable.

--public <public>

New visibility of the share type. if set to true, share type will be available to all projects in the cloud. Available only for microversion >= 2.50

--description <description>

New description of share type. available only for microversion >= 2.50

--name <name>

New name of share type. available only for microversion >= 2.50

<share_type>

Share type to display (name or id)

-h, --help

Show this help message and exit

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--noindent

Whether to disable indenting the json

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

<share_type>

Name or id of the share type to modify

<key>

Remove extra_specs from this share type

-h, --help

Show this help message and exit

<share>

Share to modify (name or id)

-h, --help

Show this help message and exit

--property <key>

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

--name

Unset share name.

--description

Unset share description.