Command Reference

List of released CLI commands available in openstack client. These commands can be referenced by executing openstack help share.

shares

share create

Create new share

share create
    [-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>

-f <FORMATTER>, --format <FORMATTER>

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.

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

share_protocol

Share protocol (NFS, CIFS, CephFS, GlusterFS or HDFS)

size

Share size in GiB.

This command is provided by the python-manilaclient plugin.

share list

List shares

share list
    [-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>]

-f <FORMATTER>, --format <FORMATTER>

the output format, defaults to table

-c COLUMN, --column COLUMN

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

--quote <QUOTE_MODE>

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.

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

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

This command is provided by the python-manilaclient plugin.

share show

Display share details

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

-f <FORMATTER>, --format <FORMATTER>

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

This command is provided by the python-manilaclient plugin.

share delete

Delete a share

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

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

Share(s) to delete (name or ID)

This command is provided by the python-manilaclient plugin.

share set

Set share properties

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

--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 modify (name or ID)

This command is provided by the python-manilaclient plugin.

share unset

Unset share properties

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

--property <key>

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

--name

Unset share name.

--description

Unset share description.

share

Share to modify (name or ID)

This command is provided by the python-manilaclient plugin.

share properties show

Show share properties

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

-f <FORMATTER>, --format <FORMATTER>

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

This command is provided by the python-manilaclient plugin.

share resize

Resize a share

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

--wait

Wait for share resize

share

Name or ID of share to resize

new-size

New size of share, in GiBs

This command is provided by the python-manilaclient plugin.

share adopt

Adopt a share

share adopt
    [-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> [<key=value> ...]]]
    [--public]
    [--share-server-id <share-server-id>]
    [--wait]
    <service-host>
    <protocol>
    <export-path>

-f <FORMATTER>, --format <FORMATTER>

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.

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

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

This command is provided by the python-manilaclient plugin.

share abandon

Abandon a share

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

--wait

Wait until share is abandoned

share

Name or ID of the share(s)

This command is provided by the python-manilaclient plugin.

share export location show

Show export location of a share

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

-f <FORMATTER>, --format <FORMATTER>

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

export-location

ID of the share export location

This command is provided by the python-manilaclient plugin.

share export location list

List export location of a share

share export location list
    [-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>

-f <FORMATTER>, --format <FORMATTER>

the output format, defaults to table

-c COLUMN, --column COLUMN

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

--quote <QUOTE_MODE>

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.

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

share

Name or ID of share

This command is provided by the python-manilaclient plugin.

share revert

Revert a share to the specified snapshot.

share revert <snapshot>

snapshot

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

This command is provided by the python-manilaclient plugin.

share instances

share instance delete

Forces the deletion of a share instance

share instance delete [--wait] <instance> [<instance> ...]

--wait

Wait for share instance deletion.

instance

ID of the share instance to delete.

This command is provided by the python-manilaclient plugin.

share instance list

List share instances

share instance list
    [-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 <share>]
    [--export-location <export-location>]

-f <FORMATTER>, --format <FORMATTER>

the output format, defaults to table

-c COLUMN, --column COLUMN

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

--quote <QUOTE_MODE>

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.

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

--share <share>

Name or ID of the share to list instances for.

--export-location <export-location>

Export location to list instances for.

This command is provided by the python-manilaclient plugin.

share instance set

Explicitly reset share instance status

share instance set [--status <status>] <instance>

--status <status>

Indicate which state to assign the instance. Options are: available, error, creating, deleting,error_deleting, migrating, migrating_to, server_migrating.

instance

Instance to be modified.

This command is provided by the python-manilaclient plugin.

share instance show

Show share instance

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

-f <FORMATTER>, --format <FORMATTER>

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.

instance

ID of the share instance.

This command is provided by the python-manilaclient plugin.

share access rules

share access create

Create new share access rule

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

-f <FORMATTER>, --format <FORMATTER>

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.

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

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.

This command is provided by the python-manilaclient plugin.

share access delete

Delete a share access rule

share access delete <share> <id>

share

Name or ID of the NAS share to modify.

id

ID of the access rule to be deleted.

This command is provided by the python-manilaclient plugin.

share access list

List share access rule

share access list
    [-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> [<key=value> ...]]]
    <share>

-f <FORMATTER>, --format <FORMATTER>

the output format, defaults to table

-c COLUMN, --column COLUMN

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

--quote <QUOTE_MODE>

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.

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

--properties <key=value>

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

share

Name or ID of the share.

This command is provided by the python-manilaclient plugin.

share access set

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

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

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

This command is provided by the python-manilaclient plugin.

share access show

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

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

-f <FORMATTER>, --format <FORMATTER>

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.

This command is provided by the python-manilaclient plugin.

share access unset

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

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

--property <key>

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

access_id

ID of the NAS share access rule.

This command is provided by the python-manilaclient plugin.

share networks

share network create

Create a share network

share network create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--name <share-network>]
    [--description <description>]
    [--neutron-net-id <neutron-net-id>]
    [--neutron-subnet-id <neutron-subnet-id>]
    [--availability-zone <availability-zone>]

-f <FORMATTER>, --format <FORMATTER>

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.

--name <share-network>

Add a name to the share network (Optional)

--description <description>

Add a description to the share network (Optional).

--neutron-net-id <neutron-net-id>

ID of the neutron network that must be associated with the share network (Optional). The network specified will be associated with the ‘default’ share network subnet, unless ‘availability-zone’ is also specified.

--neutron-subnet-id <neutron-subnet-id>

ID of the neutron sub-network that must be associated with the share network (Optional). The subnet specified will be associated with the ‘default’ share network subnet, unless ‘availability-zone’ is also specified.

--availability-zone <availability-zone>

Name or ID of the avalilability zone to assign the specified network subnet parameters to. Must be used in conjunction with ‘neutron-net-id’ and ‘neutron-subnet-id’. Do not specify this parameter if the network must be available across all availability zones (‘default’ share network subnet). Available only for microversion >= 2.51.

This command is provided by the python-manilaclient plugin.

share network delete

Delete one or more share networks

share network delete [--wait] <share-network> [<share-network> ...]

--wait

Wait for the share network(s) to be deleted

share-network

Name or ID of the share network(s) to delete

This command is provided by the python-manilaclient plugin.

share network list

List share networks

share network list
    [-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-network>]
    [--name~ <share-network-name-pattern>]
    [--description <share-network-description>]
    [--description~ <share-network-description-pattern>]
    [--all-projects]
    [--project <project>]
    [--project-domain <project-domain>]
    [--created-since <yyyy-mm-dd>]
    [--created-before <yyyy-mm-dd>]
    [--security-service <security-service>]
    [--neutron-net-id <neutron-net-id>]
    [--neutron-subnet-id <neutron-subnet-id>]
    [--network-type <network-type>]
    [--segmentation-id <segmentation-id>]
    [--cidr <X.X.X.X/X>]
    [--ip-version 4/6]
    [--detail]

-f <FORMATTER>, --format <FORMATTER>

the output format, defaults to table

-c COLUMN, --column COLUMN

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

--quote <QUOTE_MODE>

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.

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

--name <share-network>

Filter share networks by name

--name~ <share-network-name-pattern>

Filter share networks by name-pattern. Available only for microversion >= 2.36.

--description <share-network-description>

Filter share networks by description. Available only for microversion >= 2.36

--description~ <share-network-description-pattern>

Filter share networks by description-pattern. Available only for microversion >= 2.36.

--all-projects

Include all projects (admin only)

--project <project>

Filter share networks 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.

--created-since <yyyy-mm-dd>

Filter share networks by date they were created after. The date can be in the format yyyy-mm-dd.

--created-before <yyyy-mm-dd>

Filter share networks by date they were created before. The date can be in the format yyyy-mm-dd.

--security-service <security-service>

Filter share networks by the name or ID of a security service attached to the network.

--neutron-net-id <neutron-net-id>

Filter share networks by the ID of a neutron network.

--neutron-subnet-id <neutron-subnet-id>

Filter share networks by the ID of a neutron sub network.

--network-type <network-type>

Filter share networks by the type of network. Examples include “flat”, “vlan”, “vxlan”, “geneve”, etc.

--segmentation-id <segmentation-id>

Filter share networks by the segmentation ID of network. Relevant only for segmented networks such as “vlan”, “vxlan”, “geneve”, etc.

--cidr <X.X.X.X/X>

Filter share networks by the CIDR of network.

--ip-version 4/6

Filter share networks by the IP Version of the network, either 4 or 6.

--detail

List share networks with details

This command is provided by the python-manilaclient plugin.

share network set

Set share network properties

share network set
    [--name <name>]
    [--description <description>]
    [--status <status>]
    [--neutron-net-id <neutron-net-id>]
    [--neutron-subnet-id <neutron-subnet-id>]
    [--current-security-service <security-service>]
    [--new-security-service <security-service>]
    [--check-only]
    [--restart-check]
    <share-network>

--name <name>

Set a new name to the share network.

--description <description>

Set a new description to the share network.

--status <status>

Assign a status to the share network (Admin only). Options include : active, error, network_change. Available only for microversion >= 2.63.

--neutron-net-id <neutron-net-id>

Update the neutron network associated with the default share network subnet. If a default share network subnet is not present or if the share network is in use, setting this will fail.

--neutron-subnet-id <neutron-subnet-id>

Update the neutron subnetwork associated with the default share network subnet. If a default share network subnet is not present or if the share network is in use, setting this will fail.

--current-security-service <security-service>

Name or ID of a security service that is currently associated with a share network that must be replaced. Replacing a security service is only available for microversions >= 2.63.

--new-security-service <security-service>

Name or ID of a security service that must be associated with the share network. When replacing a security service, the current security service must also be provided with the ‘–current-security-service’ option. Replacing a security service is only available for microversions >= 2.63.

--check-only

Run a dry-run of a security service replacement. Available only for microversion >=2.63

--restart-check

Restart a dry-run of a security service replacement. Helpful when check results are stale. Available only for microversion >=2.63.

share-network

Name or ID of the share network to set a property for

This command is provided by the python-manilaclient plugin.

share network show

Show details about a share network

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

-f <FORMATTER>, --format <FORMATTER>

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

Name or ID of the share network to display

This command is provided by the python-manilaclient plugin.

share network unset

Unset a share network property

share network unset
    [--name]
    [--description]
    [--security-service <security-service>]
    <share-network>

--name

Unset share network name.

--description

Unset share network description.

--security-service <security-service>

Disassociate a security service from the share network. This is only possible with unused share networks.

share-network

Name or ID of the share network to unset a property of

This command is provided by the python-manilaclient plugin.

share types

share type access create

Add access for share type

share type access create <share_type> <project_id>

share_type

Share type name or ID to add access to

project_id

Project ID to add share type access for

This command is provided by the python-manilaclient plugin.

share type access delete

Delete access from share type

share type access delete <share_type> <project_id>

share_type

Share type name or ID to delete access from

project_id

Project ID to delete share type access for

This command is provided by the python-manilaclient plugin.

share type access list

Get access list for share type

share type access list
    [-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>

-f <FORMATTER>, --format <FORMATTER>

the output format, defaults to table

-c COLUMN, --column COLUMN

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

--quote <QUOTE_MODE>

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.

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

share_type

Share type name or ID to get access list for

This command is provided by the python-manilaclient plugin.

share type create

Create new share type

share type create
    [-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> [<key=value> ...]]]
    [--public <public>]
    <name>
    <spec_driver_handles_share_servers>

-f <FORMATTER>, --format <FORMATTER>

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.

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

name

Share type name

spec_driver_handles_share_servers

Required extra specification. Valid values are ‘true’ and ‘false’

This command is provided by the python-manilaclient plugin.

share type delete

Delete a share type

share type delete <share_types> [<share_types> ...]

share_types

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

This command is provided by the python-manilaclient plugin.

share type list

List share types

share type list
    [-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> [<key=value> ...]]]

-f <FORMATTER>, --format <FORMATTER>

the output format, defaults to table

-c COLUMN, --column COLUMN

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

--quote <QUOTE_MODE>

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.

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

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

This command is provided by the python-manilaclient plugin.

share type set

Set share type properties

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

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

Name or ID of the share type to modify

This command is provided by the python-manilaclient plugin.

share type show

Display share type details

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

-f <FORMATTER>, --format <FORMATTER>

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

Share type to display (name or ID)

This command is provided by the python-manilaclient plugin.

share type unset

Unset share type extra specs

share type unset <share_type> <key> [<key> ...]

share_type

Name or ID of the share type to modify

key

Remove extra_specs from this share type

This command is provided by the python-manilaclient plugin.

share quotas

share quota delete

Delete Quota

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

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

This command is provided by the python-manilaclient plugin.

share quota set

Set Quota

share quota set
    [--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]
    [--per-share-gigabytes <per-share-gigabytes>]

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

--per-share-gigabytes <per-share-gigabytes>

New value for the ‘per-share-gigabytes’ quota.Available only for microversion >= 2.62

This command is provided by the python-manilaclient plugin.

share quota show

Show Quota

share quota show
    [-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]

-f <FORMATTER>, --format <FORMATTER>

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.

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

This command is provided by the python-manilaclient plugin.

share snapshots

share snapshot abandon

Abandon share snapshot(s)

share snapshot abandon <snapshot> [<snapshot> ...]

snapshot

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

This command is provided by the python-manilaclient plugin.

share snapshot access create

Allow access to a snapshot

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

-f <FORMATTER>, --format <FORMATTER>

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

access_type

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

access_to

Value that defines access.

This command is provided by the python-manilaclient plugin.

share snapshot access delete

Delete access to a snapshot

share snapshot access delete <snapshot> <id> [<id> ...]

snapshot

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

id

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

This command is provided by the python-manilaclient plugin.

share snapshot access list

Show access list for a snapshot

share snapshot access list
    [-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>

-f <FORMATTER>, --format <FORMATTER>

the output format, defaults to table

-c COLUMN, --column COLUMN

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

--quote <QUOTE_MODE>

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.

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

snapshot

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

This command is provided by the python-manilaclient plugin.

share snapshot adopt

Adopt a share snapshot

share snapshot adopt
    [-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>

-f <FORMATTER>, --format <FORMATTER>

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.

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

share

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

provider-location

Provider location of the snapshot on the backend.

This command is provided by the python-manilaclient plugin.

share snapshot create

Create a snapshot of the given share

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

-f <FORMATTER>, --format <FORMATTER>

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.

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

share

Name or ID of the share to create snapshot of

This command is provided by the python-manilaclient plugin.

share snapshot delete

Delete one or more share snapshots

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

--force

Delete the snapshot(s) ignoring the current state.

snapshot

Name or ID of the snapshot(s) to delete

This command is provided by the python-manilaclient plugin.

share snapshot export location list

List export locations of a given snapshot

share snapshot export location list
    [-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>

-f <FORMATTER>, --format <FORMATTER>

the output format, defaults to table

-c COLUMN, --column COLUMN

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

--quote <QUOTE_MODE>

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.

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

snapshot

Name or ID of the share snapshot.

This command is provided by the python-manilaclient plugin.

share snapshot export location show

Show export location of the share snapshot

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

-f <FORMATTER>, --format <FORMATTER>

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.

export-location

ID of the share snapshot export location.

This command is provided by the python-manilaclient plugin.

share snapshot list

List snapshots

share snapshot list
    [-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]

-f <FORMATTER>, --format <FORMATTER>

the output format, defaults to table

-c COLUMN, --column COLUMN

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

--quote <QUOTE_MODE>

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.

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

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

This command is provided by the python-manilaclient plugin.

share snapshot set

Set share snapshot properties

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

--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 set a property for

This command is provided by the python-manilaclient plugin.

share snapshot show

Show details about a share snapshot

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

-f <FORMATTER>, --format <FORMATTER>

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 display

This command is provided by the python-manilaclient plugin.

share snapshot unset

Unset a share snapshot property

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

--name

Unset snapshot name.

--description

Unset snapshot description.

snapshot

Name or ID of the snapshot to set a property for

This command is provided by the python-manilaclient plugin.

share snapshot instances

share snapshot instance export location list

List export locations from a share snapshot instance.

share snapshot instance export location list
    [-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]
    <instance>

-f <FORMATTER>, --format <FORMATTER>

the output format, defaults to table

-c COLUMN, --column COLUMN

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

--quote <QUOTE_MODE>

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.

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

instance

Name or ID of the share instance.

This command is provided by the python-manilaclient plugin.

share snapshot instance export location show

Show export location of the share snapshot instance.

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

-f <FORMATTER>, --format <FORMATTER>

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_instance

ID of the share snapshot instance.

export_location

ID of the share snapshot instance export location.

This command is provided by the python-manilaclient plugin.

share snapshot instance list

List all share snapshot instances

share snapshot instance list
    [-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 <snapshot>]
    [--detailed]

-f <FORMATTER>, --format <FORMATTER>

the output format, defaults to table

-c COLUMN, --column COLUMN

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

--quote <QUOTE_MODE>

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.

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

--snapshot <snapshot>

Filter results by share snapshot ID.

--detailed

Show detailed information about snapshot instances.

This command is provided by the python-manilaclient plugin.

share snapshot instance set

Explicitly update the state of a share snapshot instance.

share snapshot instance set [--status <status>] <snapshot_instance>

--status <status>

Indicate state to update the snapshot instance to. Default is available.

snapshot_instance

ID of the share snapshot instance to update.

This command is provided by the python-manilaclient plugin.

share snapshot instance show

Show details about a share snapshot instance.

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

-f <FORMATTER>, --format <FORMATTER>

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_instance

ID of the share snapshot instance.

This command is provided by the python-manilaclient plugin.

user messages

share message delete

Remove one or more messages

share message delete <message> [<message> ...]

message

ID of the message(s).

This command is provided by the python-manilaclient plugin.

share message list

Lists all messages

share message list
    [-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>]

-f <FORMATTER>, --format <FORMATTER>

the output format, defaults to table

-c COLUMN, --column COLUMN

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

--quote <QUOTE_MODE>

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.

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

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

This command is provided by the python-manilaclient plugin.

share message show

Show details about a message

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

-f <FORMATTER>, --format <FORMATTER>

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.

message

ID of the message.

This command is provided by the python-manilaclient plugin.

share replicas

share replica create

Create a replica of the given share

share replica create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--availability-zone <availability-zone>]
    [--wait]
    <share>

-f <FORMATTER>, --format <FORMATTER>

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.

--availability-zone <availability-zone>

Availability zone in which the replica should be created.

--wait

Wait for replica creation

share

Name or ID of the share to replicate.

This command is provided by the python-manilaclient plugin.

share replica delete

Delete one or more share replicas

share replica delete [--force] [--wait] <replica> [<replica> ...]

--force

Attempt to force delete a replica on its backend. Using this option will purge the replica from Manila even if it is not cleaned up on the backend.

--wait

Wait for share replica deletion

replica

Name or ID of the replica(s) to delete

This command is provided by the python-manilaclient plugin.

share replica export location list

List export locations of a share replica.

share replica export location list
    [-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]
    <replica>

-f <FORMATTER>, --format <FORMATTER>

the output format, defaults to table

-c COLUMN, --column COLUMN

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

--quote <QUOTE_MODE>

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.

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

replica

ID of the share replica.

This command is provided by the python-manilaclient plugin.

share replica export location show

Show details of a share replica’s export location.

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

-f <FORMATTER>, --format <FORMATTER>

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.

replica

ID of the share replica.

export-location

ID of the share replica export location.

This command is provided by the python-manilaclient plugin.

share replica list

List share replicas

share replica list
    [-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 <share>]

-f <FORMATTER>, --format <FORMATTER>

the output format, defaults to table

-c COLUMN, --column COLUMN

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

--quote <QUOTE_MODE>

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.

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

--share <share>

Name or ID of the share to list replicas for.

This command is provided by the python-manilaclient plugin.

share replica promote

Promote specified replica to ‘active’ replica_state.

share replica promote <replica>

replica

ID of the share replica.

This command is provided by the python-manilaclient plugin.

share replica resync

Attempt to update the share replica with its ‘active’ mirror.

share replica resync <replica>

replica

ID of the share replica to resync.

This command is provided by the python-manilaclient plugin.

share replica set

Explicitly set share replica status and/or replica-state

share replica set
    [--replica-state <replica-state>]
    [--status <status>]
    <replica>

--replica-state <replica-state>

Indicate which replica_state to assign the replica. Options include in_sync, out_of_sync, active and error.

--status <status>

Indicate which status to assign the replica. Options include available, error, creating, deleting and error_deleting.

replica

ID of the share replica to modify.

This command is provided by the python-manilaclient plugin.

share replica show

Show details about a replica

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

-f <FORMATTER>, --format <FORMATTER>

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.

replica

ID of the share replica.

This command is provided by the python-manilaclient plugin.

share availability zones

share availability zone list

List all availability zones

share availability zone list
    [-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]

-f <FORMATTER>, --format <FORMATTER>

the output format, defaults to table

-c COLUMN, --column COLUMN

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

--quote <QUOTE_MODE>

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.

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

This command is provided by the python-manilaclient plugin.

share services

share service list

List share services (Admin only).

share service list
    [-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]
    [--host <host>]
    [--binary <binary>]
    [--status <status>]
    [--state <state>]
    [--zone <zone>]

-f <FORMATTER>, --format <FORMATTER>

the output format, defaults to table

-c COLUMN, --column COLUMN

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

--quote <QUOTE_MODE>

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.

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

--host <host>

Filter services by name of the host.

--binary <binary>

Filter services by the name of the service.

--status <status>

Filter results by status.

--state <state>

Filter results by state.

--zone <zone>

Filter services by their availability zone.

This command is provided by the python-manilaclient plugin.

share service set

Enable/Disable share service (Admin only).

share service set [--enable | --disable] <host> <binary>

--enable

Enable share service

--disable

Disable share service

host

Host name as ‘example_host@example_backend’.

binary

Service binary, could be ‘manila-share’, ‘manila-scheduler’ or ‘manila-data’

This command is provided by the python-manilaclient plugin.

share pools

share pool list

List all backend storage pools known to the scheduler (Admin only).

share pool list
    [-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]
    [--host <host>]
    [--backend <backend>]
    [--pool <pool>]
    [--detail]
    [--share-type <share-type>]

-f <FORMATTER>, --format <FORMATTER>

the output format, defaults to table

-c COLUMN, --column COLUMN

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

--quote <QUOTE_MODE>

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.

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

--host <host>

Filter results by host name. Regular expressions are supported.

--backend <backend>

Filter results by backend name. Regular expressions are supported.

--pool <pool>

Filter results by pool name. Regular expressions are supported.

--detail

Show detailed information about pools.

--share-type <share-type>

Filter results by share type name or ID. Available only for microversion >= 2.23

This command is provided by the python-manilaclient plugin.

share limits

share limits show

Show a list of share limits for a user.

share limits show
    [-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]
    (--absolute | --rate)

-f <FORMATTER>, --format <FORMATTER>

the output format, defaults to table

-c COLUMN, --column COLUMN

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

--quote <QUOTE_MODE>

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.

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

--absolute

Get the absolute limits for the user

--rate

Get the API rate limits for the user

This command is provided by the python-manilaclient plugin.

share instance export location

share instance export location list

List share instance export locations

share instance export location list
    [-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]
    <instance>

-f <FORMATTER>, --format <FORMATTER>

the output format, defaults to table

-c COLUMN, --column COLUMN

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

--quote <QUOTE_MODE>

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.

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

instance

ID of the share instance.

This command is provided by the python-manilaclient plugin.

share instance export location show

Show export location for a share instance.

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

-f <FORMATTER>, --format <FORMATTER>

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.

instance

Name or ID of the share instance

export_location

ID of the share instance export location.

This command is provided by the python-manilaclient plugin.

share groups

share group create

Create new share group

share group create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--name <name>]
    [--description <description>]
    [--share-types <share-types> [<share-types> ...]]
    [--share-group-type <share-group-type>]
    [--share-network <share-network>]
    [--source-share-group-snapshot <source-share-group-snapshot>]
    [--availability-zone <availability-zone>]
    [--wait]

-f <FORMATTER>, --format <FORMATTER>

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.

--name <name>

Share group name

--description <description>

Share group description.

--share-types <share-types>

Name or ID of share type(s).

--share-group-type <share-group-type>

Share group type name or ID of the share group to be created.

--share-network <share-network>

Specify share network name or id

--source-share-group-snapshot <source-share-group-snapshot>

Share group snapshot name or ID to create the share group from.

--availability-zone <availability-zone>

Optional availability zone in which group should be created

--wait

Wait for share group creation

This command is provided by the python-manilaclient plugin.

share group delete

Delete one or more share groups

share group delete [--force] [--wait] <share_group> [<share_group> ...]

--force

Attempt to force delete the share group (Default=False) (Admin only).

--wait

Wait for share group to delete

share_group

Name or ID of the share group(s) to delete

This command is provided by the python-manilaclient plugin.

share group list

List share groups

share group list
    [-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-server <share-server-id>]
    [--share-group-type <share-group-type>]
    [--snapshot <snapshot>]
    [--host <host>]
    [--share-network <share-network>]
    [--project <project>]
    [--project-domain <project-domain>]
    [--limit <limit>]
    [--marker <marker>]
    [--sort <key>[:<direction>]]
    [--name~ <name~>]
    [--description~ <description~>]

-f <FORMATTER>, --format <FORMATTER>

the output format, defaults to table

-c COLUMN, --column COLUMN

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

--quote <QUOTE_MODE>

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.

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

--all-projects

Display share groups 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-server <share-server-id>

Filter results by share server ID.

--share-group-type <share-group-type>

Filter results by a share group type ID or name that was used for share group creation.

--snapshot <snapshot>

Filter results by share group snapshot name or ID that was used to create the share group.

--host <host>

Filter results by host.

--share-network <share-network>

Filter results by share-network name or ID.

--project <project>

Filter results by project name or ID. Useful with set key ‘–all-projects’.

--project-domain <project-domain>

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

--limit <limit>

Limit the number of share groups returned

--marker <marker>

The last share group 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 group name pattern. Available only for microversion >= 2.36.

--description~ <description~>

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

This command is provided by the python-manilaclient plugin.

share group set

Explicitly set share group status

share group set
    [--name <name>]
    [--description <description>]
    [--status <status>]
    <share-group>

--name <name>

New name for the share group. (Default=None)

--description <description>

Share group description. (Default=None)

--status <status>

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

share-group

Name or ID of the share group to update.

This command is provided by the python-manilaclient plugin.

share group show

Show details about a share group

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

-f <FORMATTER>, --format <FORMATTER>

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

Name or ID of the share group.

This command is provided by the python-manilaclient plugin.

share group unset

Unset a share group property

share group unset [--name] [--description] <share-group>

--name

Unset share group name.

--description

Unset share group description.

share-group

Name or ID of the share group to set a property for.

This command is provided by the python-manilaclient plugin.