Chapter 75. share

This chapter describes the commands under the share command.

75.1. share abandon

Abandon a share

Usage:

openstack share abandon [-h] [--wait] <share> [<share> ...]

Table 75.1. Positional arguments

ValueSummary

<share>

Name or id of the share(s)

Table 75.2. Command arguments

ValueSummary

-h, --help

Show this help message and exit

--wait

Wait until share is abandoned

75.2. share access create

Create new share access rule

Usage:

openstack share access create [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--properties [<key=value> ...]]
                                     [--access-level <access_level>]
                                     <share> <access_type> <access_to>

Table 75.3. Positional arguments

ValueSummary

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

Table 75.4. Command arguments

ValueSummary

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

Table 75.5. Output formatter options

ValueSummary

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 75.6. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 75.7. Shell formatter options

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 75.8. Table formatter options

ValueSummary

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

75.3. share access delete

Delete a share access rule

Usage:

openstack share access delete [-h] <share> <id>

Table 75.9. Positional arguments

ValueSummary

<share>

Name or id of the nas share to modify.

<id>

Id of the access rule to be deleted.

Table 75.10. Command arguments

ValueSummary

-h, --help

Show this help message and exit

75.4. share access list

List share access rule

Usage:

openstack share access list [-h] [-f {csv,json,table,value,yaml}]
                                   [-c COLUMN]
                                   [--quote {all,minimal,none,nonnumeric}]
                                   [--noindent] [--max-width <integer>]
                                   [--fit-width] [--print-empty]
                                   [--sort-column SORT_COLUMN]
                                   [--sort-ascending | --sort-descending]
                                   [--properties [<key=value> ...]]
                                   <share>

Table 75.11. Positional arguments

ValueSummary

<share>

Name or id of the share.

Table 75.12. Command arguments

ValueSummary

-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

Table 75.13. Output formatter options

ValueSummary

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

--sort-ascending

Sort the column(s) in ascending order

--sort-descending

Sort the column(s) in descending order

Table 75.14. CSV formatter options

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 75.15. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 75.16. Table formatter options

ValueSummary

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

75.5. share access set

Set properties to share access rule. Available for API microversion 2.45 and higher

Usage:

openstack share access set [-h] [--property <key=value>] <access_id>

Table 75.17. Positional arguments

ValueSummary

<access_id>

Id of the nas share access rule.

Table 75.18. Command arguments

ValueSummary

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

75.6. share access show

Display a share access rule. Available for API microversion 2.45 and higher

Usage:

openstack share access show [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--noindent] [--prefix PREFIX]
                                   [--max-width <integer>] [--fit-width]
                                   [--print-empty]
                                   <access_id>

Table 75.19. Positional arguments

ValueSummary

<access_id>

Id of the nas share access rule.

Table 75.20. Command arguments

ValueSummary

-h, --help

Show this help message and exit

Table 75.21. Output formatter options

ValueSummary

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 75.22. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 75.23. Shell formatter options

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 75.24. Table formatter options

ValueSummary

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

75.7. share access unset

Unset properties of share access rule. Available for API microversion 2.45 and higher

Usage:

openstack share access unset [-h] [--property <key>] <access_id>

Table 75.25. Positional arguments

ValueSummary

<access_id>

Id of the nas share access rule.

Table 75.26. Command arguments

ValueSummary

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

75.8. share adopt

Adopt a share

Usage:

openstack share adopt [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] [--name <name>]
                             [--description <description>]
                             [--share-type <share-type>]
                             [--driver-options [<key=value> ...]] [--public]
                             [--share-server-id <share-server-id>] [--wait]
                             <service-host> <protocol> <export-path>

Table 75.27. Positional arguments

ValueSummary

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

Table 75.28. Command arguments

ValueSummary

-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

Table 75.29. Output formatter options

ValueSummary

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 75.30. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 75.31. Shell formatter options

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 75.32. Table formatter options

ValueSummary

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

75.9. share create

Create new share

Usage:

openstack share create [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty] [--name <name>]
                              [--snapshot-id <snapshot-id>]
                              [--property <key=value>]
                              [--share-network <network-info>]
                              [--description <description>]
                              [--public <public>] [--share-type <share-type>]
                              [--availability-zone <availability-zone>]
                              [--share-group <share-group>] [--wait]
                              <share_protocol> <size>

Table 75.33. Positional arguments

ValueSummary

<share_protocol>

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

<size>

Share size in gib.

Table 75.34. Command arguments

ValueSummary

-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

Table 75.35. Output formatter options

ValueSummary

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 75.36. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 75.37. Shell formatter options

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 75.38. Table formatter options

ValueSummary

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

75.10. share delete

Delete a share

Usage:

openstack share delete [-h] [--share-group <share-group>] [--force]
                              [--wait]
                              <share> [<share> ...]

Table 75.39. Positional arguments

ValueSummary

<share>

Share(s) to delete (name or id)

Table 75.40. Command arguments

ValueSummary

-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

75.11. share export location list

List export location of a share

Usage:

openstack share export location list [-h]
                                            [-f {csv,json,table,value,yaml}]
                                            [-c COLUMN]
                                            [--quote {all,minimal,none,nonnumeric}]
                                            [--noindent]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--sort-column SORT_COLUMN]
                                            [--sort-ascending | --sort-descending]
                                            <share>

Table 75.41. Positional arguments

ValueSummary

<share>

Name or id of share

Table 75.42. Command arguments

ValueSummary

-h, --help

Show this help message and exit

Table 75.43. Output formatter options

ValueSummary

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

--sort-ascending

Sort the column(s) in ascending order

--sort-descending

Sort the column(s) in descending order

Table 75.44. CSV formatter options

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 75.45. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 75.46. Table formatter options

ValueSummary

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

75.12. share export location show

Show export location of a share

Usage:

openstack share export location show [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN] [--noindent]
                                            [--prefix PREFIX]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            <share> <export-location>

Table 75.47. Positional arguments

ValueSummary

<share>

Name or id of share

<export-location>

Id of the share export location

Table 75.48. Command arguments

ValueSummary

-h, --help

Show this help message and exit

Table 75.49. Output formatter options

ValueSummary

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 75.50. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 75.51. Shell formatter options

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 75.52. Table formatter options

ValueSummary

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

75.13. share list

List shares

Usage:

openstack share list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                            [--quote {all,minimal,none,nonnumeric}]
                            [--noindent] [--max-width <integer>] [--fit-width]
                            [--print-empty] [--sort-column SORT_COLUMN]
                            [--sort-ascending | --sort-descending]
                            [--name <share-name>] [--status <share-status>]
                            [--snapshot <share-network-id>] [--public]
                            [--share-network <share-network-name-or-id>]
                            [--share-type <share-type-name-or-id>]
                            [--share-group <share-group-name-or-id>]
                            [--host <share-host>]
                            [--share-server <share-server-id>]
                            [--project <project>]
                            [--project-domain <project-domain>]
                            [--user <user>] [--user-domain <user-domain>]
                            [--all-projects] [--property <key=value>]
                            [--extra-spec <key=value>] [--long]
                            [--sort <key>[:<direction>]]
                            [--limit <num-shares>] [--marker <share>]

Table 75.53. Command arguments

ValueSummary

-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

Table 75.54. Output formatter options

ValueSummary

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

--sort-ascending

Sort the column(s) in ascending order

--sort-descending

Sort the column(s) in descending order

Table 75.55. CSV formatter options

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 75.56. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 75.57. Table formatter options

ValueSummary

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

75.14. share message delete

Remove one or more messages

Usage:

openstack share message delete [-h] <message> [<message> ...]

Table 75.58. Positional arguments

ValueSummary

<message>

Id of the message(s).

Table 75.59. Command arguments

ValueSummary

-h, --help

Show this help message and exit

75.15. share message list

Lists all messages

Usage:

openstack share message list [-h] [-f {csv,json,table,value,yaml}]
                                    [-c COLUMN]
                                    [--quote {all,minimal,none,nonnumeric}]
                                    [--noindent] [--max-width <integer>]
                                    [--fit-width] [--print-empty]
                                    [--sort-column SORT_COLUMN]
                                    [--sort-ascending | --sort-descending]
                                    [--resource-id <resource-id>]
                                    [--resource-type <resource-type>]
                                    [--action-id <action-id>]
                                    [--detail-id <detail-id>]
                                    [--request-id <request-id>]
                                    [--message-level <message-level>]
                                    [--limit <limit>] [--since <since>]
                                    [--before <before>]

Table 75.60. Command arguments

ValueSummary

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

Table 75.61. Output formatter options

ValueSummary

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

--sort-ascending

Sort the column(s) in ascending order

--sort-descending

Sort the column(s) in descending order

Table 75.62. CSV formatter options

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 75.63. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 75.64. Table formatter options

ValueSummary

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

75.16. share message show

Show details about a message

Usage:

openstack share message show [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--noindent] [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty]
                                    <message>

Table 75.65. Positional arguments

ValueSummary

<message>

Id of the message.

Table 75.66. Command arguments

ValueSummary

-h, --help

Show this help message and exit

Table 75.67. Output formatter options

ValueSummary

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 75.68. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 75.69. Shell formatter options

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 75.70. Table formatter options

ValueSummary

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

75.17. share properties show

Show share properties

Usage:

openstack share properties show [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty]
                                       <share>

Table 75.71. Positional arguments

ValueSummary

<share>

Name or id of share

Table 75.72. Command arguments

ValueSummary

-h, --help

Show this help message and exit

Table 75.73. Output formatter options

ValueSummary

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 75.74. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 75.75. Shell formatter options

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 75.76. Table formatter options

ValueSummary

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

75.18. share quota delete

Delete Quota

Usage:

openstack share quota delete [-h] [--project <project>] [--user <user>]
                                    [--share-type <share-type>]

Table 75.77. Command arguments

ValueSummary

-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

75.19. share quota set

Set Quota

Usage:

openstack share quota set [-h] [--project <project>] [--user <user>]
                                 [--shares <shares>] [--snapshots <snapshots>]
                                 [--gigabytes <gigabytes>]
                                 [--snapshot-gigabytes <snapshot-gigabytes>]
                                 [--share-networks <share-networks>]
                                 [--share-groups <share-groups>]
                                 [--share-group-snapshots <share-group-snapshots>]
                                 [--share-replicas <share-replicas>]
                                 [--replica-gigabytes <replica-gigabytes>]
                                 [--share-type <share-type>] [--force]

Table 75.78. Command arguments

ValueSummary

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

75.20. share quota show

Show Quota

Usage:

openstack share quota show [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--noindent] [--prefix PREFIX]
                                  [--max-width <integer>] [--fit-width]
                                  [--print-empty] [--project <project>]
                                  [--user <user>] [--share-type <share-type>]
                                  [--detail] [--defaults]

Table 75.79. Command arguments

ValueSummary

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

Table 75.80. Output formatter options

ValueSummary

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 75.81. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 75.82. Shell formatter options

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 75.83. Table formatter options

ValueSummary

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

75.21. share resize

Resize a share

Usage:

openstack share resize [-h] [--wait] <share> <new-size>

Table 75.84. Positional arguments

ValueSummary

<share>

Name or id of share to resize

<new-size>

New size of share, in gibs

Table 75.85. Command arguments

ValueSummary

-h, --help

Show this help message and exit

--wait

Wait for share resize

75.22. share revert

Revert a share to the specified snapshot.

Usage:

openstack share revert [-h] <snapshot>

Table 75.86. Positional arguments

ValueSummary

<snapshot>

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

Table 75.87. Command arguments

ValueSummary

-h, --help

Show this help message and exit

75.23. share set

Set share properties

Usage:

openstack share set [-h] [--property <key=value>] [--name <name>]
                           [--description <description>] [--public <public>]
                           [--status <status>]
                           <share>

Table 75.88. Positional arguments

ValueSummary

<share>

Share to modify (name or id)

Table 75.89. Command arguments

ValueSummary

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

75.24. share show

Display share details

Usage:

openstack share show [-h] [-f {json,shell,table,value,yaml}]
                            [-c COLUMN] [--noindent] [--prefix PREFIX]
                            [--max-width <integer>] [--fit-width]
                            [--print-empty]
                            <share>

Table 75.90. Positional arguments

ValueSummary

<share>

Share to display (name or id)

Table 75.91. Command arguments

ValueSummary

-h, --help

Show this help message and exit

Table 75.92. Output formatter options

ValueSummary

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 75.93. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 75.94. Shell formatter options

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 75.95. Table formatter options

ValueSummary

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

75.25. share snapshot abandon

Abandon share snapshot(s)

Usage:

openstack share snapshot abandon [-h] <snapshot> [<snapshot> ...]

Table 75.96. Positional arguments

ValueSummary

<snapshot>

Name or id of the snapshot(s) to be abandoned.

Table 75.97. Command arguments

ValueSummary

-h, --help

Show this help message and exit

75.26. share snapshot access create

Allow access to a snapshot

Usage:

openstack share snapshot access create [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN] [--noindent]
                                              [--prefix PREFIX]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              <snapshot> <access_type>
                                              <access_to>

Table 75.98. Positional arguments

ValueSummary

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

Table 75.99. Command arguments

ValueSummary

-h, --help

Show this help message and exit

Table 75.100. Output formatter options

ValueSummary

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 75.101. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 75.102. Shell formatter options

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 75.103. Table formatter options

ValueSummary

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

75.27. share snapshot access delete

Delete access to a snapshot

Usage:

openstack share snapshot access delete [-h] <snapshot> <id> [<id> ...]

Table 75.104. Positional arguments

ValueSummary

<snapshot>

Name or id of the share snapshot to deny access to.

<id>

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

Table 75.105. Command arguments

ValueSummary

-h, --help

Show this help message and exit

75.28. share snapshot access list

Show access list for a snapshot

Usage:

openstack share snapshot access list [-h]
                                            [-f {csv,json,table,value,yaml}]
                                            [-c COLUMN]
                                            [--quote {all,minimal,none,nonnumeric}]
                                            [--noindent]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--sort-column SORT_COLUMN]
                                            [--sort-ascending | --sort-descending]
                                            <snapshot>

Table 75.106. Positional arguments

ValueSummary

<snapshot>

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

Table 75.107. Command arguments

ValueSummary

-h, --help

Show this help message and exit

Table 75.108. Output formatter options

ValueSummary

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

--sort-ascending

Sort the column(s) in ascending order

--sort-descending

Sort the column(s) in descending order

Table 75.109. CSV formatter options

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 75.110. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 75.111. Table formatter options

ValueSummary

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

75.29. share snapshot adopt

Adopt a share snapshot

Usage:

openstack share snapshot adopt [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty] [--name <name>]
                                      [--description <description>]
                                      [--driver-option <key=value>]
                                      <share> <provider-location>

Table 75.112. Positional arguments

ValueSummary

<share>

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

<provider-location>

Provider location of the snapshot on the backend.

Table 75.113. Command arguments

ValueSummary

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

Table 75.114. Output formatter options

ValueSummary

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 75.115. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 75.116. Shell formatter options

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 75.117. Table formatter options

ValueSummary

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

75.30. share snapshot create

Create a snapshot of the given share

Usage:

openstack share snapshot create [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty] [--force]
                                       [--name <name>]
                                       [--description <description>]
                                       <share>

Table 75.118. Positional arguments

ValueSummary

<share>

Name or id of the share to create snapshot of

Table 75.119. Command arguments

ValueSummary

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

Table 75.120. Output formatter options

ValueSummary

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 75.121. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 75.122. Shell formatter options

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 75.123. Table formatter options

ValueSummary

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

75.31. share snapshot delete

Delete one or more share snapshots

Usage:

openstack share snapshot delete [-h] [--force]
                                       <snapshot> [<snapshot> ...]

Table 75.124. Positional arguments

ValueSummary

<snapshot>

Name or id of the snapshot(s) to delete

Table 75.125. Command arguments

ValueSummary

-h, --help

Show this help message and exit

--force

Delete the snapshot(s) ignoring the current state.

75.32. share snapshot export location list

List export locations of a given snapshot

Usage:

openstack share snapshot export location list [-h]
                                                     [-f {csv,json,table,value,yaml}]
                                                     [-c COLUMN]
                                                     [--quote {all,minimal,none,nonnumeric}]
                                                     [--noindent]
                                                     [--max-width <integer>]
                                                     [--fit-width]
                                                     [--print-empty]
                                                     [--sort-column SORT_COLUMN]
                                                     [--sort-ascending | --sort-descending]
                                                     <snapshot>

Table 75.126. Positional arguments

ValueSummary

<snapshot>

Name or id of the share snapshot.

Table 75.127. Command arguments

ValueSummary

-h, --help

Show this help message and exit

Table 75.128. Output formatter options

ValueSummary

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

--sort-ascending

Sort the column(s) in ascending order

--sort-descending

Sort the column(s) in descending order

Table 75.129. CSV formatter options

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 75.130. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 75.131. Table formatter options

ValueSummary

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

75.33. share snapshot export location show

Show export location of the share snapshot

Usage:

openstack share snapshot export location show [-h]
                                                     [-f {json,shell,table,value,yaml}]
                                                     [-c COLUMN] [--noindent]
                                                     [--prefix PREFIX]
                                                     [--max-width <integer>]
                                                     [--fit-width]
                                                     [--print-empty]
                                                     <snapshot>
                                                     <export-location>

Table 75.132. Positional arguments

ValueSummary

<snapshot>

Name or id of the share snapshot.

<export-location>

Id of the share snapshot export location.

Table 75.133. Command arguments

ValueSummary

-h, --help

Show this help message and exit

Table 75.134. Output formatter options

ValueSummary

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 75.135. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 75.136. Shell formatter options

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 75.137. Table formatter options

ValueSummary

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

75.34. share snapshot list

List snapshots

Usage:

openstack share snapshot list [-h] [-f {csv,json,table,value,yaml}]
                                     [-c COLUMN]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--noindent] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--sort-column SORT_COLUMN]
                                     [--sort-ascending | --sort-descending]
                                     [--all-projects] [--name <name>]
                                     [--description <description>]
                                     [--status <status>] [--share <share>]
                                     [--usage <usage>]
                                     [--limit <num-snapshots>]
                                     [--marker <snapshot>]
                                     [--sort <key>[:<direction>]]
                                     [--name~ <name~>]
                                     [--description~ <description~>]
                                     [--detail]

Table 75.138. Command arguments

ValueSummary

-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

Table 75.139. Output formatter options

ValueSummary

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

--sort-ascending

Sort the column(s) in ascending order

--sort-descending

Sort the column(s) in descending order

Table 75.140. CSV formatter options

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 75.141. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 75.142. Table formatter options

ValueSummary

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

75.35. share snapshot set

Set share snapshot properties

Usage:

openstack share snapshot set [-h] [--name <name>]
                                    [--description <description>]
                                    [--status <status>]
                                    <snapshot>

Table 75.143. Positional arguments

ValueSummary

<snapshot>

Name or id of the snapshot to set a property for

Table 75.144. Command arguments

ValueSummary

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

75.36. share snapshot show

Show details about a share snapshot

Usage:

openstack share snapshot show [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     <snapshot>

Table 75.145. Positional arguments

ValueSummary

<snapshot>

Name or id of the snapshot to display

Table 75.146. Command arguments

ValueSummary

-h, --help

Show this help message and exit

Table 75.147. Output formatter options

ValueSummary

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 75.148. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 75.149. Shell formatter options

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 75.150. Table formatter options

ValueSummary

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

75.37. share snapshot unset

Unset a share snapshot property

Usage:

openstack share snapshot unset [-h] [--name] [--description] <snapshot>

Table 75.151. Positional arguments

ValueSummary

<snapshot>

Name or id of the snapshot to set a property for

Table 75.152. Command arguments

ValueSummary

-h, --help

Show this help message and exit

--name

Unset snapshot name.

--description

Unset snapshot description.

75.38. share type access create

Add access for share type

Usage:

openstack share type access create [-h] <share_type> <project_id>

Table 75.153. Positional arguments

ValueSummary

<share_type>

Share type name or id to add access to

<project_id>

Project id to add share type access for

Table 75.154. Command arguments

ValueSummary

-h, --help

Show this help message and exit

75.39. share type access delete

Delete access from share type

Usage:

openstack share type access delete [-h] <share_type> <project_id>

Table 75.155. Positional arguments

ValueSummary

<share_type>

Share type name or id to delete access from

<project_id>

Project id to delete share type access for

Table 75.156. Command arguments

ValueSummary

-h, --help

Show this help message and exit

75.40. share type access list

Get access list for share type

Usage:

openstack share type access list [-h] [-f {csv,json,table,value,yaml}]
                                        [-c COLUMN]
                                        [--quote {all,minimal,none,nonnumeric}]
                                        [--noindent] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--sort-column SORT_COLUMN]
                                        [--sort-ascending | --sort-descending]
                                        <share_type>

Table 75.157. Positional arguments

ValueSummary

<share_type>

Share type name or id to get access list for

Table 75.158. Command arguments

ValueSummary

-h, --help

Show this help message and exit

Table 75.159. Output formatter options

ValueSummary

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

--sort-ascending

Sort the column(s) in ascending order

--sort-descending

Sort the column(s) in descending order

Table 75.160. CSV formatter options

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 75.161. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 75.162. Table formatter options

ValueSummary

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

75.41. share type create

Create new share type

Usage:

openstack share type create [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--noindent] [--prefix PREFIX]
                                   [--max-width <integer>] [--fit-width]
                                   [--print-empty]
                                   [--description <description>]
                                   [--snapshot-support <snapshot_support>]
                                   [--create-share-from-snapshot-support <create_share_from_snapshot_support>]
                                   [--revert-to-snapshot-support <revert_to_snapshot_support>]
                                   [--mount-snapshot-support <mount_snapshot_support>]
                                   [--extra-specs [<key=value> ...]]
                                   [--public <public>]
                                   <name> <spec_driver_handles_share_servers>

Table 75.163. Positional arguments

ValueSummary

<name>

Share type name

<spec_driver_handles_share_servers>

Required extra specification. valid values are true and false

Table 75.164. Command arguments

ValueSummary

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

Table 75.165. Output formatter options

ValueSummary

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 75.166. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 75.167. Shell formatter options

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 75.168. Table formatter options

ValueSummary

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

75.42. share type delete

Delete a share type

Usage:

openstack share type delete [-h] <share_types> [<share_types> ...]

Table 75.169. Positional arguments

ValueSummary

<share_types>

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

Table 75.170. Command arguments

ValueSummary

-h, --help

Show this help message and exit

75.43. share type list

List share types

Usage:

openstack share type list [-h] [-f {csv,json,table,value,yaml}]
                                 [-c COLUMN]
                                 [--quote {all,minimal,none,nonnumeric}]
                                 [--noindent] [--max-width <integer>]
                                 [--fit-width] [--print-empty]
                                 [--sort-column SORT_COLUMN]
                                 [--sort-ascending | --sort-descending]
                                 [--all] [--extra-specs [<key=value> ...]]

Table 75.171. Command arguments

ValueSummary

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

Table 75.172. Output formatter options

ValueSummary

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

--sort-ascending

Sort the column(s) in ascending order

--sort-descending

Sort the column(s) in descending order

Table 75.173. CSV formatter options

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 75.174. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 75.175. Table formatter options

ValueSummary

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

75.44. share type set

Set share type properties

Usage:

openstack share type set [-h] [--extra-specs [<key=value> ...]]
                                [--public <public>]
                                [--description <description>] [--name <name>]
                                <share_type>

Table 75.176. Positional arguments

ValueSummary

<share_type>

Name or id of the share type to modify

Table 75.177. Command arguments

ValueSummary

-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

75.45. share type show

Display share type details

Usage:

openstack share type show [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--noindent] [--prefix PREFIX]
                                 [--max-width <integer>] [--fit-width]
                                 [--print-empty]
                                 <share_type>

Table 75.178. Positional arguments

ValueSummary

<share_type>

Share type to display (name or id)

Table 75.179. Command arguments

ValueSummary

-h, --help

Show this help message and exit

Table 75.180. Output formatter options

ValueSummary

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 75.181. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 75.182. Shell formatter options

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 75.183. Table formatter options

ValueSummary

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

75.46. share type unset

Unset share type extra specs

Usage:

openstack share type unset [-h] <share_type> <key> [<key> ...]

Table 75.184. Positional arguments

ValueSummary

<share_type>

Name or id of the share type to modify

<key>

Remove extra_specs from this share type

Table 75.185. Command arguments

ValueSummary

-h, --help

Show this help message and exit

75.47. share unset

Unset share properties

Usage:

openstack share unset [-h] [--property <key>] [--name] [--description]
                             <share>

Table 75.186. Positional arguments

ValueSummary

<share>

Share to modify (name or id)

Table 75.187. Command arguments

ValueSummary

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