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]
    [--scheduler-hint <key=value>]
    [--mount-point-name <mount_point_name>]
    <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>¶: The share type to create the share with. If not specified, unless creating from a snapshot, the default share type will be used.

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

--scheduler-hint <key=value>¶: Set Scheduler hints for the share as key=value pairs, possible keys are same_host, different_host.(repeat option to set multiple hints)

--mount-point-name <mount_point_name>¶: Optional custom export location. Available for microversion >= 2.84

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>]
    [--export-location <export-location>]
    [--soft-deleted]
    [--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>]
    [--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

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

--export-location <export-location>¶: Filter shares by export location id or path. Available only for microversion >= 2.35

--soft-deleted¶: Get shares in recycle bin. If this parameter is set to True (Default=False), only shares in the recycle bin will be displayed. Available only for microversion >= 2.69.

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

--name~ <name~>¶: Filter results matching a share name pattern. Available only for microversion >= 2.36.

--description~ <description~>¶: Filter results matching a share description pattern.Available only for microversion >= 2.36.

This command is provided by the python-manilaclient plugin.

share instances¶

share access rules¶

share migration¶

share networks¶

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

share quotas¶

share snapshot instances¶

user messages¶

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

share security services¶

share security service list¶

List security services.

share security 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]
    [--all-projects]
    [--share-network <share-network>]
    [--status <status>]
    [--name <name>]
    [--type <type>]
    [--user <user]
    [--dns-ip <dns-ip>]
    [--ou <ou>]
    [--default-ad-site <default_ad_site>]
    [--server <server>]
    [--domain <domain>]
    [--detail]
    [--limit <num-security-services>]
    [--marker <security-service>]

-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 information from all projects (Admin only).

--share-network <share-network>¶: Filter results by share network name or ID.

--status <status>¶: Filter results by status.

--name <name>¶: Filter results by security service name.

--type <type>¶: Filter results by security service type.

--user <user¶: Filter results by security service user or group used by project.

--dns-ip <dns-ip>¶: Filter results by DNS IP address used inside project’s network.

--ou <ou>¶: Filter results by security service OU (Organizational Unit). Available only for microversion >= 2.44.

--default-ad-site <default_ad_site>¶: Filter results by security service default_ad_site. Available only for microversion >= 2.76.

--server <server>¶: Filter results by security service IP address or hostname.

--domain <domain>¶: Filter results by security service domain.

--detail¶: Show detailed information about filtered security services.

--limit <num-security-services>¶: Limit the number of security services returned

--marker <security-service>¶: The last security service ID of the previous page

This command is provided by the python-manilaclient plugin.

share instance export location¶

share groups¶

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

share group snapshot create¶

Create a share group snapshot of the given share group
share group snapshot create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--name <name>]
    [--description <description>]
    [--wait]
    <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.

--name <name>¶

Optional share group snapshot name. (Default=None)

--description <description>¶

Optional share group snapshot description. (Default=None)

--wait¶

Wait for share group snapshot creation

share-group¶

Name or ID of the share group.

This command is provided by the python-manilaclient plugin.
share group snapshot delete¶

Delete one or more share group snapshot
share group snapshot delete
    [--force]
    [--wait]
    <share-group-snapshot>
    [<share-group-snapshot> ...]
--force¶

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

--wait¶

Wait for share group snapshot deletion

share-group-snapshot¶

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

This command is provided by the python-manilaclient plugin.
share group snapshot list¶

List share group snapshots
share group 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>]
    [--status <status>]
    [--share-group <share-group>]
    [--limit <limit>]
    [--marker <marker>]
    [--sort <key>[:<direction>]]
    [--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

--all-projects¶

Display information from all projects (Admin only).

--name <name>¶

Filter results by name.

--status <status>¶

Filter results by status.

--share-group <share-group>¶

Filter results by share group name or ID.

--limit <limit>¶

Limit the number of share groups returned

--marker <marker>¶

The last share group snapshot 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

--detailed¶

Show detailed information about share group snapshot.

This command is provided by the python-manilaclient plugin.
share group snapshot members list¶

List members of share group snapshot
share group snapshot members 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-group-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

share-group-snapshot¶

Name or ID of the group snapshot to list members for

This command is provided by the python-manilaclient plugin.
share group snapshot set¶

Set share group snapshot properties
share group snapshot set
    [--name <name>]
    [--description <description>]
    [--status <status>]
    <share-group-snapshot>
--name <name>¶

Set a name to the snapshot.

--description <description>¶

Set a description to the snapshot.

--status <status>¶

Explicitly set the state of a share group snapshot(Admin only). Options include : available, error, creating, deleting, error_deleting.

share-group-snapshot¶

Name or ID of the snapshot to set a property for

This command is provided by the python-manilaclient plugin.
share group snapshot show¶

Show details about a share group snapshot
share group snapshot show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    <share-group-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.

share-group-snapshot¶

Name or ID of the share group snapshot to display

This command is provided by the python-manilaclient plugin.
share group snapshot unset¶

Unset a share group snapshot property
share group snapshot unset
    [--name]
    [--description]
    <share-group-snapshot>
--name¶

Unset share group snapshot name.

--description¶

Unset share group snapshot description.

share-group-snapshot¶

Name or ID of the group snapshot to unset a property of

This command is provided by the python-manilaclient plugin.

resource locks¶

share lock list¶

Lists all resource locks

share lock 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]
    [--project PROJECT]
    [--user USER]
    [--id <id>]
    [--resource <resource-id>]
    [--resource-type <resource_type>]
    [--resource-action <resource_action>]
    [--lock-context <lock_context>]
    [--since <created_since>]
    [--before <created_before>]
    [--limit <limit>]
    [--offset <offset>]
    [--sort-key <sort_key>]
    [--sort-dir <sort_dir>]
    [--detailed [<0|1>]]

-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¶: Filter resource locks for all projects. (Admin only).

--project <PROJECT>¶: Filter resource locks for specific project by name or ID, combine with –all-projects (Admin only).

--user <USER>¶: Filter resource locks for specific user by name or ID, combine with –all-projects to search across projects (Admin only).

--id <id>¶: Filter resource locks by ID. Default=None.

--resource <resource-id>, --resource-id <resource-id>, --resource_id <resource-id>¶: Filter resource locks for a resource by ID, specify –resource-type to look up by name.

--resource-type <resource_type>, --resource_type <resource_type>¶: Filter resource locks by type of resource.

--resource-action <resource_action>, --resource_action <resource_action>¶: Filter resource locks by resource action.

--lock-context <lock_context>, --lock_context <lock_context>, --context <lock_context>¶: Filter resource locks by context.

--since <created_since>¶: Filter resource locks created since given date. The date format must be conforming to ISO8601.

--before <created_before>¶: Filter resource locks created before given date. The date format must be conforming to ISO8601.

--limit <limit>¶: Number of resource locks to list. (Default=None)

--offset <offset>¶: Starting position of resource lock records in a paginated list.

--sort-key <sort_key>, --sort_key <sort_key>¶: Key to be sorted, available keys are (‘id’, ‘created_at’, ‘updated_at’, ‘resource_id’, ‘resource_type’, ‘resource_actionlock_reason’). Default=None.

--sort-dir <sort_dir>, --sort_dir <sort_dir>¶: Sort direction, available values are (‘asc’, ‘desc’). OPTIONAL: Default=None.

--detailed <0|1>¶: Show detailed information about filtered resource locks.

This command is provided by the python-manilaclient plugin.

Command Reference

Command Reference¶

shares¶

user messages¶

resource locks¶

python-manilaclient 5.1.0.dev7

Page Contents

Command Reference

Command Reference¶

shares¶

share create¶

share list¶

share show¶

share delete¶

share set¶

share unset¶

share properties show¶

share resize¶

share adopt¶

share abandon¶

share export location show¶

share export location list¶

share revert¶

share restore¶

share instances¶

share instance delete¶

share instance list¶

share instance set¶

share instance show¶

share access rules¶

share access create¶

share access delete¶

share access list¶

share access set¶

share access show¶

share access unset¶

share migration¶

share migration start¶

share migration cancel¶

share migration complete¶

share migration show¶

share networks¶

share network create¶

share network delete¶

share network list¶

share network unset¶

share network show¶

share network set¶

share network subnets¶

share network subnet create¶

share network subnet delete¶

share network subnet set¶

share network subnet show¶

share network subnet unset¶

share types¶

share type access create¶

share type access delete¶

share type access list¶

share type create¶

share type delete¶

share type list¶

share type set¶

share type show¶

share type unset¶

share quotas¶

share quota delete¶

share quota set¶

share quota show¶

share snapshots¶

share snapshot abandon¶

share snapshot access create¶

share snapshot access delete¶

share snapshot access list¶

share snapshot adopt¶

share snapshot create¶

share snapshot delete¶

share snapshot export location list¶

share snapshot export location show¶

share snapshot list¶

share snapshot set¶

share snapshot show¶

share snapshot unset¶

share snapshot instances¶

share snapshot instance export location list¶

share snapshot instance export location show¶

share snapshot instance list¶

share snapshot instance set¶