manilaclient(1)
| PYTHON-MANILACLIENT(1) | python-manilaclient | PYTHON-MANILACLIENT(1) |
NAME
python-manilaclient - python-manilaclient 4.5.0
This is a client for OpenStack Manila API. There's a Python API (the manilaclient module), and a command-line script (installed as manila). Each implements the entire OpenStack Manila API. See Project Structure for more information.
You'll need credentials for an OpenStack cloud that implements the Manila API in order to use the manila client.
COMMAND-LINE REFERENCE
There are two shell implementations supported by python-manilaclient. The "manila" client supports full feature parity with the manila API:
The manila shell utility
The manila shell utility interacts with the OpenStack Manila API from the command line. It supports the entirety of the OpenStack Manila API.
You'll need to provide manila with your OpenStack username and API key. You can do this with the --os-username, --os-password and --os-tenant-name options, but it's easier to just set them as environment variables by setting two environment variables:
- OS_USERNAME or MANILA_USERNAME
- Your OpenStack Manila username.
- OS_PASSWORD or MANILA_PASSWORD
- Your password.
- OS_TENANT_NAME or MANILA_PROJECT_ID
- Project for work.
- OS_AUTH_URL or MANILA_URL
- The OpenStack API server URL.
- OS_SHARE_API_VERSION
- The OpenStack Shared Filesystems API version.
For example, in Bash you'd use:
export OS_USERNAME=foo export OS_PASSWORD=bar export OS_TENANT_NAME=foobarproject export OS_AUTH_URL=http://... export OS_SHARE_API_VERSION=2
From there, all shell commands take the form:
manila <command> [arguments...]
Run manila help to get a full list of all possible commands, and run manila help <command> to get detailed help for that command.
- System Message: ERROR/6 (/usr/src/RPM/BUILD/manilaclient-4.5.0/doc/source/user/shell.rst:, line 51)
- Command ['manila', '--help'] failed: [Errno 2] No such file or directory:
'manila'
From version 2.0.0, there is a growing support for the OpenStack client. It does not yet have full feature parity with the manila API:
openstack share Command-Line Interface (CLI)
Synopsis
openstack [options] share <command> [command-options]
openstack help share <command>
Description
The OpenStack Client plugin interacts with the Manila service through the openstack share command line interface (CLI).
To use the CLI, you must provide your OpenStack username, password, project, auth endpoint and the share API version. You can use configuration options --os-username, --os-password, --os-project-name, --os-auth-url and --os-share-api-version, or set the corresponding environment variables:
export OS_USERNAME=foo export OS_PASSWORD=bar export OS_TENANT_NAME=foobarproject export OS_AUTH_URL=http://... export OS_SHARE_API_VERSION=2.51
Getting help
To get a full list of all possible commands, run:
$ openstack help share
To get detailed help for one command, run:
$ openstack help share <command>
Examples
Get information about the openstack share create command:
$ openstack help share create
Create one share:
$ openstack share create NFS 1 --name "myshare"
List shares:
$ openstack share list
Display a share:
$ openstack share show myshare
Delete a share:
$ openstack share delete myshare
Extend a 1gb share to 2gb:
$ openstack share resize myshare 2
Shrink a 2gb share to 1gb:
$ openstack share resize myshare 1
Command Reference
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>]
<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)
- 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 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 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]
[--soft]
<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
- --soft
- Soft delete one or more shares.
- 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>]
[--task-state <task-state>]
<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.
- --task-state <task-state>
- Indicate which task state to assign the share. Options include migration_starting, migration_in_progress, migration_completing, migration_success, migration_error, migration_cancelled, migration_driver_in_progress, migration_driver_phase1_done, data_copying_starting, data_copying_in_progress, data_copying_completing, data_copying_completed, data_copying_cancelled, data_copying_error.
- 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 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.
- Name or ID of share
This command is provided by the python-manilaclient plugin.
share resize
Resize a share
share resize [--wait] [--force] <share> <new-size>
- --wait
- Wait for share resize
- --force
- Only applicable when increasing the size of the share，only available with microversion 2.64 and higher. (admin only)
- 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> ...]]
[--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
- 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.
- 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
- 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 [--wait] <snapshot>
- --wait
- Wait for share revert
- 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 restore
Restores this share or more shares from the recycle bin
share restore <share> [<share> ...]
- Name or ID of the share(s)
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> ...]]
[--access-level <access_level>]
[--wait]
<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.
- --wait
- Wait for share access rule creation.
- 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 [--wait] <share> <id>
- --wait
- Wait for share access rule deletion
- 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> ...]]
<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
- 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 migration
share migration start
Migrates share to a new host.
share migration start
[--force-host-assisted-migration <force-host-assisted-migration>]
--preserve-metadata <preserve-metadata>
--preserve-snapshots <preserve-snapshots>
--writable <writable>
--nondisruptive <nondisruptive>
[--new-share-network <new_share_network>]
[--new-share-type <new-share-type>]
<share>
<host>
- --force-host-assisted-migration <force-host-assisted-migration>
- Enforces the use of the host-assisted migration approach, which bypasses driver optimizations. Default=False.
- --preserve-metadata <preserve-metadata>
- Enforces migration to preserve all file metadata when moving its contents. If set to True, host-assistedmigration will not be attempted.
- --preserve-snapshots <preserve-snapshots>
- Enforces migration of the share snapshots to the destination. If set to True, host-assisted migrationwill not be attempted.
- --writable <writable>
- Enforces migration to keep the share writable while contents are being moved. If set to True, host-assistedmigration will not be attempted.
- --nondisruptive <nondisruptive>
- Enforces migration to be nondisruptive. If set to True, host-assisted migration will not be attempted.
- --new-share-network <new_share_network>
- Specify the new share network for the share. Do not specify this parameter if the migrating share has to beretained within its current share network.
- --new-share-type <new-share-type>
- Specify the new share type for the share. Do not specify this parameter if the migrating share has to be retained with its current share type.
- Name or ID of share to migrate.
- host
- Destination host where share will be migrated to. Use the format 'host@backend#pool'.
This command is provided by the python-manilaclient plugin.
share migration cancel
Cancels migration of a given share when copying
share migration cancel <share>
- Name or ID of share to migrate.
This command is provided by the python-manilaclient plugin.
share migration complete
Completes migration for a given share
share migration complete <share>
- Name or ID of share to migrate.
This command is provided by the python-manilaclient plugin.
share migration show
Gets migration progress of a given share when copying
share migration 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.
- Name or ID of the share to get share migration progress information.
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 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 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 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 subnets
share network subnet create
Create a share network subnet
share network subnet create
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--neutron-net-id <neutron-net-id>]
[--neutron-subnet-id <neutron-subnet-id>]
[--availability-zone <availability-zone>]
[--check-only]
[--restart-check]
[--property <key=value>]
<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.
- --neutron-net-id <neutron-net-id>
- Neutron network ID. Used to set up network for share servers (optional). Should be defined together with '--neutron-subnet-id'.
- --neutron-subnet-id <neutron-subnet-id>
- Neutron subnet ID. Used to set up network for share servers (optional). Should be defined together with '--neutron-net-id' to which this subnet belongs to.
- --availability-zone <availability-zone>
- Optional availability zone that the subnet is available within (Default=None). If None, the subnet will be considered as being available across all availability zones.
- --check-only
- Run a dry-run of a share network subnet create. Available only for microversion >= 2.70.
- --restart-check
- Restart a dry-run of a share network subnet create. Helpful when check results are stale. Available only for microversion >= 2.70.
- --property <key=value>
- Set a property to this share network subnet (repeat option to set multiple properties). Available only for microversion >= 2.78.
- share-network
- Share network name or ID.
This command is provided by the python-manilaclient plugin.
share network subnet delete
Delete a share network subnet
share network subnet delete
<share-network>
<share-network-subnet>
[<share-network-subnet> ...]
- share-network
- Share network name or ID.
- share-network-subnet
- ID(s) of share network subnet(s) to be deleted.
This command is provided by the python-manilaclient plugin.
share network subnet set
Set share network subnet properties
share network subnet set
[--property <key=value>]
<share-network>
<share-network-subnet>
- --property <key=value>
- Set a property to this share network subnet (repeat option to set multiple properties). Available only for microversion >= 2.78.
- share-network
- Share network name or ID.
- share-network-subnet
- ID of share network subnet to set a property.
This command is provided by the python-manilaclient plugin.
share network subnet show
Show share network subnet
share network subnet show
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
<share-network>
<share-network-subnet>
- -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
- Share network name or ID.
- share-network-subnet
- ID of share network subnet to show.
This command is provided by the python-manilaclient plugin.
share network subnet unset
Unset a share network subnet property
share network subnet unset
[--property <key>]
<share-network>
<share-network-subnet>
- --property <key>
- Remove a property from share network subnet (repeat option to remove multiple properties). Available only for microversion >= 2.78.
- share-network
- Share network name or ID.
- share-network-subnet
- ID of share network subnet to set a property.
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 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 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 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> ...]]
[--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
- 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> ...]
- 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> ...]]
- -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> ...]]
[--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
- 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 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> ...]
- 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
[--user <user> | --share-type <share-type>]
<project>
- --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
- project
- Name or ID of the project to delete quotas for.
This command is provided by the python-manilaclient plugin.
share quota set
Set Quota for a project, or project/user or project/share-type or a class.
share quota set
[--class | --user <user> | --share-type <share-type>]
[--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>]
[--per-share-gigabytes <per-share-gigabytes>]
[--force]
<project/class>
- --class
- Update class quota to all projects. Mutually exclusive with '--user' and '--share-type'.
- --user <user>
- Name or ID of a user to set the quotas for. Mutually exclusive with '--share-type' and '--class'.
- --share-type <share-type>
- Name or ID of a share type to set the quotas for. Mutually exclusive with '--user' and '--class'. Available only for microversion >= 2.39
- --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. Available only for microversion >= 2.40
- --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
- --per-share-gigabytes <per-share-gigabytes>
- New value for the 'per-share-gigabytes' quota.Available only for microversion >= 2.62
- --force
- Force update the quota. Not applicable for class update.
- project/class
- A project (name/ID) or a class (e.g.: default).
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]
[--user <user> | --share-type <share-type>]
[--detail]
[--defaults]
<project>
- -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.
- --user <user>
- Name or ID of user to list the quotas for. Optional. Mutually exclusive with '--share-type'.
- --share-type <share-type>
- Name or ID 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.
- project
- Name or ID of the project to list quotas for.
This command is provided by the python-manilaclient plugin.
share snapshots
share snapshot abandon
Abandon share snapshot(s)
share snapshot abandon [--wait] <snapshot> [<snapshot> ...]
- --wait
- Wait until share snapshot is abandoned
- 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>]
[--wait]
<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)
- --wait
- Wait until share snapshot is adopted
- 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>]
[--wait]
[--property <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
- --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).
- --wait
- Wait for share snapshot creation
- --property <key=value>
- Set a property to this snapshot (repeat option to set multiple properties).Available only for microversion >= 2.73
- 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] [--wait] <snapshot> [<snapshot> ...]
- --force
- Delete the snapshot(s) ignoring the current state.
- --wait
- Wait for share snapshot deletion
- 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]
[--property <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-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
- --property <key=value>
- Filter snapshots having a given metadata key=value property. (repeat option to filter by multiple properties)
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>]
[--property <key=value>]
<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.
- --property <key=value>
- Set a property to this snapshot (repeat option to set multiple properties)
- 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]
[--property <key>]
<snapshot>
- --name
- Unset snapshot name.
- --description
- Unset snapshot description.
- --property <key>
- Remove a property from snapshot (repeat option to remove multiple properties)
- 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]
[--scheduler-hint <key=value>]
[--share-network <share-network-name-or-id>]
<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
- --scheduler-hint <key=value>
- Scheduler hint for the share replica as key=value pairs, Supported key is only_host. Available for microversion >= 2.67.
- --share-network <share-network-name-or-id>
- Optional network info ID or name. Available for microversion >= 2.72
- 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
[--quiesce-wait-time <quiesce-wait-time>]
<replica>
- --quiesce-wait-time <quiesce-wait-time>
- Quiesce wait time in seconds. Available for microversion >= 2.75
- 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. Available only for microversion >= 2.47.
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 security services
share security service create
Create security service used by project.
share security service create
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--dns-ip <dns-ip>]
[--ou <ou>]
[--server <server>]
[--domain <domain>]
[--user <user]
[--password <password>]
[--name <name>]
[--description <description>]
[--default-ad-site <default_ad_site>]
<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.
- --dns-ip <dns-ip>
- DNS IP address of the security service used inside project's network.
- --ou <ou>
- Security service OU (Organizational Unit). Available only for microversion >= 2.44.
- --server <server>
- Security service IP address or hostname.
- --domain <domain>
- Security service domain.
- --user <user
- Security service user or group used by project.
- --password <password>
- Password used by user.
- --name <name>
- Security service name.
- --description <description>
- Security service description.
- --default-ad-site <default_ad_site>
- Default AD site. Available only for microversion >= 2.76. Can be provided in the place of '--server' but not along with it.
- type
- Security service type. Possible options are: 'ldap', 'kerberos', 'active_directory'.
This command is provided by the python-manilaclient plugin.
share security service delete
Delete one or more security services.
share security service delete
<security-service>
[<security-service> ...]
- security-service
- Name or ID of the security service(s) to delete.
This command is provided by the python-manilaclient plugin.
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 security service set
Set security service.
share security service set
[--dns-ip <dns-ip>]
[--ou <ou>]
[--server <server>]
[--domain <domain>]
[--user <user]
[--password <password>]
[--name <name>]
[--description <description>]
[--default-ad-site <default_ad_site>]
<security-service>
- --dns-ip <dns-ip>
- Set DNS IP address used inside project's network.
- --ou <ou>
- Set security service OU (Organizational Unit). Available only for microversion >= 2.44.
- --server <server>
- Set security service IP address or hostname.
- --domain <domain>
- Set security service domain.
- --user <user
- Set security service user or group used by project.
- --password <password>
- Set password used by user.
- --name <name>
- Set security service name.
- --description <description>
- Set security service description.
- --default-ad-site <default_ad_site>
- Default AD site. Available only for microversion >= 2.76.
- security-service
- Security service name or ID.
This command is provided by the python-manilaclient plugin.
share security service show
Show security service.
share security service show
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
<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
- --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.
- security-service
- Security service name or ID to show.
This command is provided by the python-manilaclient plugin.
share security service unset
Unset security service.
share security service unset
[--dns-ip]
[--ou]
[--server]
[--domain]
[--user]
[--password]
[--name]
[--description]
[--default-ad-site]
<security-service>
- --dns-ip
- Unset DNS IP address used inside project's network.
- --ou
- Unset security service OU (Organizational Unit). Available only for microversion >= 2.44.
- --server
- Unset security service IP address or hostname.
- --domain
- Unset security service domain.
- --user
- Unset security service user or group used by project.
- --password
- Unset password used by user.
- --name
- Unset security service name.
- --description
- Unset security service description.
- --default-ad-site
- Default AD site. Available only for microversion >= 2.76.
- security-service
- Security service name or ID.
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
- 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 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.
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 types
share group type access create
Allow a project to access a share group type (Admin only).
share group type access create
[--project-domain <project-domain>]
<share-group-type>
<project>
[<project> ...]
- --project-domain <project-domain>
- Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.
- share-group-type
- Share group type name or ID to allow access to.
- project
- Project Name or ID to add share group type access for.
This command is provided by the python-manilaclient plugin.
share group type access delete
Deny a project to access a share group type (Admin only).
share group type access delete
[--project-domain <project-domain>]
<share-group-type>
<project>
[<project> ...]
- --project-domain <project-domain>
- Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.
- share-group-type
- Share group type name or ID to deny access from
- project
- Project Name(s) or ID(s) to deny share group type access for.
This command is provided by the python-manilaclient plugin.
share group type access list
Get access list for share group type (Admin only).
share group 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-group-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-group-type
- Filter results by share group type name or ID.
This command is provided by the python-manilaclient plugin.
share group type create
Create new share group type
share group type create
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--group-specs [<key=value> ...]]
[--public <public>]
<name>
<share-types>
[<share-types> ...]
- -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.
- --group-specs <key=value>
- Share Group type extra specs by key and value. OPTIONAL: Default=None. Example: --group-specs consistent_snapshot_support=host.
- --public <public>
- Make type accessible to the public (default true).
- name
- Share group type name
- share-types
- List of share type names or IDs. Example: my-share-type-1 my-share-type-2
This command is provided by the python-manilaclient plugin.
share group type delete
Delete a share group type
share group type delete <share-group-types> [<share-group-types> ...]
- share-group-types
- Name or ID of the share group type(s) to delete
This command is provided by the python-manilaclient plugin.
share group type list
List share types
share group 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]
[--group-specs [<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 group types whether public or private. Default=False. (Admin only)
- --group-specs <key=value>
- Filter share group types with group specs (key=value).
This command is provided by the python-manilaclient plugin.
share group type set
Set share group type properties
share group type set
[--group-specs [<key=value> ...]]
<share-group-type>
- --group-specs <key=value>
- Extra specs key and value of share group type that will be used for share type creation. OPTIONAL: Default=None. Example: --group-specs consistent-snapshot-support=True
- share-group-type
- Name or ID of the share group type to modify
This command is provided by the python-manilaclient plugin.
share group type show
Show share group types
share group type show
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
<share-group-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-group-type
- Name or ID of the share group type to show
This command is provided by the python-manilaclient plugin.
share group type unset
Unset share group type extra specs
share group type unset <share-group-type> <key> [<key> ...]
- share-group-type
- Name or ID of the share grouptype to modify
- key
- Remove group specs from this share group type
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.
share servers
share server abandon
Remove one or more share server(s) (Admin only).
share server abandon
[--force]
[--wait]
<share-server>
[<share-server> ...]
- --force
- Enforces the unmanage share server operation, even if the backend driver does not support it.
- --wait
- Wait until share server is abandoned
- share-server
- ID of the server(s) to be abandoned.
This command is provided by the python-manilaclient plugin.
share server adopt
Adopt share server not handled by Manila (Admin only).
share server adopt
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--driver-options <key=value>]
[--share-network-subnet <share-network-subnet>]
[--wait]
<host>
<share-network>
<identifier>
- -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.
- --driver-options <key=value>
- One or more driver-specific key=value pairs that may be necessary to manage the share server (Optional, Default=None).
- --share-network-subnet <share-network-subnet>
- Share network subnet where share server has network allocations in.The default subnet will be used if it's not specified. Available for microversion >= 2.51 (Optional, Default=None).
- --wait
- Wait until share server is adopted
- host
- Backend name as "<node_hostname>@<backend_name>".
- share-network
- Share network where share server has network allocations in.
- identifier
- A driver-specific share server identifier required by the driver to manage the share server.
This command is provided by the python-manilaclient plugin.
share server delete
Delete one or more share servers
share server delete [--wait] <share-server> [<share-server> ...]
- --wait
- Wait for share server deletion.
- share-server
- ID(s) of the server(s) to delete
This command is provided by the python-manilaclient plugin.
share server list
List all share servers (Admin only).
share server 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 <hostname>]
[--status <status>]
[--share-network <share-network>]
[--project <project>]
[--share-network-subnet <share-network-subnet>]
[--project-domain <project-domain>]
- -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 <hostname>
- Filter results by name of host.
- --status <status>
- Filter results by status.
- --share-network <share-network>
- Filter results by share network name or ID.
- --project <project>
- Filter results by project name or ID.
- --share-network-subnet <share-network-subnet>
- Filter results by share network subnet that the share server's network allocation exists within. Available for microversion >= 2.51 (Optional, Default=None)
- --project-domain <project-domain>
- Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.
This command is provided by the python-manilaclient plugin.
share server migration cancel
Cancels migration of a given share server when copying
share server migration cancel <share_server>
- ID of share server to cancel migration.
This command is provided by the python-manilaclient plugin.
share server migration complete
Completes migration for a given share server
share server migration complete <share_server>
- ID of share server to complete migration.
This command is provided by the python-manilaclient plugin.
share server migration show
Gets migration progress of a given share server when copying
share server migration show
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
<share_server>
- -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.
- ID of share server to show migration progress for.
This command is provided by the python-manilaclient plugin.
share server migration start
Migrates share server to a new host.
share server migration start
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
--preserve-snapshots <True
|False>
--writable <True
|False>
--nondisruptive <True
|False>
[--new-share-network <new_share_network>]
[--check-only]
<share_server>
<host@backend>
- -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.
- --preserve-snapshots <True|False>
- Set to True if snapshots must be preserved at the migration destination.
- --writable <True|False>
- Enforces migration to keep all its shares writable while contents are being moved.
- --nondisruptive <True|False>
- Enforces migration to be nondisruptive.
- --new-share-network <new_share_network>
- Specify a new share network for the share server. Do not specify this parameter if the migrating share server has to be retained within its current share network.
- --check-only
- Run a dry-run of the share server migration.
- ID of share server to start migration.
- host@backend
- Destination to migrate the share server to. Use the format '<node_hostname>@<backend_name>'.
This command is provided by the python-manilaclient plugin.
share server set
Set share server properties (Admin only).
share server set
[--status <status>]
[--task-state <task-state>]
<share-server>
- --status <status>
- Assign a status to the share server. Options include: unmanage_starting, server_migrating_to, error, unmanage_error, manage_error, inactive, active, server_migrating, manage_starting, deleting, network_change. If no state is provided, active will be used.
- --task-state <task-state>
- Indicate which task state to assign the share server. Options include migration_starting, migration_in_progress, migration_completing, migration_success, migration_error, migration_cancelled, migration_driver_in_progress, migration_driver_phase1_done, data_copying_starting, data_copying_in_progress, data_copying_completing, data_copying_completed, data_copying_cancelled, data_copying_error.
- share-server
- ID of the share server to modify.
This command is provided by the python-manilaclient plugin.
share server show
Show details about a share server (Admin only).
share server show
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
<share-server>
- -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-server
- ID of share server.
This command is provided by the python-manilaclient plugin.
USING THE PYTHON MODULE
The manilaclient Python API
Usage
In order to use the Python API directly, you must first obtain an auth token and identify which endpoint you wish to speak to. Once you have done so, you can use the API like so:
>>> from manilaclient import client
>>> manila = client.Client('1', $OS_USER_NAME, $OS_PASSWORD, $OS_TENANT_NAME, $OS_AUTH_URL)
>>> manila.shares.list()
[]
>>> share = manila.shares.create(share_proto="nfs", size=1, share_network_id="some_share_network_id")
>>> share.id
ce06d0a8-5c1b-4e2c-81d2-39eca6bbfb70
>>> manila.shares.list()
[<Share: ce06d0a8-5c1b-4e2c-81d2-39eca6bbfb70>]
>>> share.delete
In addition to creating and deleting shares, the manilaclient can manage share-types, access controls, and more! Using CephFS with Ganesha for NFS support as an example (assuumes this continues from the above initialization):
>>> share_type = client.share_types.create(
>>> name="cephfsnfstype", spec_driver_handles_share_servers=False,
>>> extra_specs={
>>> 'vendor_name': 'Ceph',
>>> 'storage_protocol': 'NFS',
>>> 'snapshot_support': False,
>>> })
>>> share_type
<ShareType: cephfsnfstype>
>>> share = client.shares.create(
>>> share_type='cephfsnfstype', name='cephnfsshare1',
>>> share_proto="nfs", size=1)
>>> share.allow(access_type='ip', access="192.168.0.0/24", access_level='rw')
{'id': '29bc4b66-d55d-424d-8107-aee96d1c562b', 'share_id': '0ac95dd2-afba-4ba3-8934-721b29492f04', 'access_level': 'rw', 'access_to': '192.168.0.0/24', 'access_type': 'ip', 'state': 'new'}
>>> share.export_locations
['10.5.0.22:/volumes/_nogroup/cf0451b6-0a95-4982-a801-2e212e9c9b96']
In the above example, Manila will be setup with an NFS share type, backed by CephFS. A share is then created, and then access controls are added giving the 192.168.0/24 subnet read/write access to the share.
CONTRIBUTING
Contributing
Basic Information
So You Want to Contribute...
For general information on contributing to OpenStack, check out the contributor guide to get started. It covers all the basics that are common to all OpenStack projects: the accounts you need, the basics of interacting with our Gerrit review system, how we communicate as a community, etc.
This project contains a python SDK and command line clients to interact with the API exposed by Manila, the OpenStack Shared File Systems service. Refer to the Contributor guide for Manila for information regarding the team's task trackers, communicating with other project developers and contacting the core team.
Bugs
You found an issue and want to make sure we are aware of it? You can do so on Launchpad.
If you're looking to contribute, search for the low-hanging-fruit tag to see issues that are easier to get started with.
Project Structure
This project includes three distinct components:
- manilaclient SDK: python bindings for Manila API version V1 and version V2
- manilaclient shell: A command line utility (manila)
- OpenStack client shell: A plugin to support the OpenStack Client Command Line Interface.
The version 2 of the API for Manila supports microversions. The manilaclient library is expected to handle these for complete backwards compatibility. All versions of the Manila API are currently supported, however, future releases of manilaclient may drop support for older versions of the API.
If you're working on the OpenStack Client command line interface plugin that exists in this project, do read the OpenStack Client Developer Documentation. This includes the Human Interface Guide and some design priciples including command structure and command specs that you will find helpful.
Testing
Manilaclient has two types of tests - 'unit' and 'functional'.
The preferred way to run tests is using tox.
See Consistent Testing Interface for more details.
Functional tests
There is a suite of functional tests under the python-manilaclient/tests/functional directory. Unlike unit tests, these tests perform API calls to Manila and are designed to run on a DevStack.
Adding functional tests to your changes is not mandatory but it's certainly a good practice and it's encouraged.
Prerequisite
You need to have manila running somewhere. If you wish to use DevStack to run manila, a good place to start would be the manila contributor guide.
NOTE:
We absolutely recommend using a fake shared file
system back end as opposed to a real storage system, because our tests are
written with the assumption that all APIs manila exposes are usable. In
reality, different real world storage back ends have different
capabilities and this project doesn't need to worry about them to provide
a general purpose interface to Manila. A fake driver provides fake storage, so
don't expect to be able to mount or use the shared file systems that you
create with it.
You can use the following local.conf file to configure DevStack including Manila using a few fake back ends:
[[local|localrc]] # auth ADMIN_PASSWORD=nomoresecret DATABASE_PASSWORD=$ADMIN_PASSWORD RABBIT_PASSWORD=$ADMIN_PASSWORD SERVICE_PASSWORD=$ADMIN_PASSWORD # enable logging for DevStack LOGFILE=/opt/stack/logs/stack.sh.log # Logging mode for DevStack services VERBOSE=True # manila enable_plugin manila https://opendev.org/openstack/manila # python-manilaclient LIBS_FROM_GIT=python-manilaclient # share driver SHARE_DRIVER=manila.tests.share.drivers.dummy.DummyDriver # share types MANILA_DEFAULT_SHARE_TYPE_EXTRA_SPECS='snapshot_support=True create_share_from_snapshot_support=True revert_to_snapshot_support=True mount_snapshot_support=True' MANILA_CONFIGURE_DEFAULT_TYPES=True # backends and groups MANILA_ENABLED_BACKENDS=alpha,beta,gamma,delta MANILA_CONFIGURE_GROUPS=alpha,beta,gamma,delta,membernet,adminnet # alpha MANILA_OPTGROUP_alpha_share_driver=manila.tests.share.drivers.dummy.DummyDriver MANILA_OPTGROUP_alpha_driver_handles_share_servers=True MANILA_OPTGROUP_alpha_share_backend_name=ALPHA MANILA_OPTGROUP_alpha_network_config_group=membernet MANILA_OPTGROUP_alpha_admin_network_config_group=adminnet # beta MANILA_OPTGROUP_beta_share_driver=manila.tests.share.drivers.dummy.DummyDriver MANILA_OPTGROUP_beta_driver_handles_share_servers=True MANILA_OPTGROUP_beta_share_backend_name=BETA MANILA_OPTGROUP_beta_network_config_group=membernet MANILA_OPTGROUP_beta_admin_network_config_group=adminnet # gamma MANILA_OPTGROUP_gamma_share_driver=manila.tests.share.drivers.dummy.DummyDriver MANILA_OPTGROUP_gamma_driver_handles_share_servers=False MANILA_OPTGROUP_gamma_share_backend_name=GAMMA MANILA_OPTGROUP_gamma_replication_domain=DUMMY_DOMAIN # delta MANILA_OPTGROUP_delta_share_driver=manila.tests.share.drivers.dummy.DummyDriver MANILA_OPTGROUP_delta_driver_handles_share_servers=False MANILA_OPTGROUP_delta_share_backend_name=DELTA MANILA_OPTGROUP_delta_replication_domain=DUMMY_DOMAIN # membernet MANILA_OPTGROUP_membernet_network_api_class=manila.network.standalone_network_plugin.StandaloneNetworkPlugin MANILA_OPTGROUP_membernet_standalone_network_plugin_gateway=10.0.0.1 MANILA_OPTGROUP_membernet_standalone_network_plugin_mask=24 MANILA_OPTGROUP_membernet_standalone_network_plugin_network_type=vlan MANILA_OPTGROUP_membernet_standalone_network_plugin_segmentation_id=1010 MANILA_OPTGROUP_membernet_standalone_network_plugin_allowed_ip_ranges=10.0.0.10-10.0.0.209 MANILA_OPTGROUP_membernet_network_plugin_ipv4_enabled=True # adminnet MANILA_OPTGROUP_adminnet_network_api_class=manila.network.standalone_network_plugin.StandaloneNetworkPlugin MANILA_OPTGROUP_adminnet_standalone_network_plugin_gateway=11.0.0.1 MANILA_OPTGROUP_adminnet_standalone_network_plugin_mask=24 MANILA_OPTGROUP_adminnet_standalone_network_plugin_network_type=vlan MANILA_OPTGROUP_adminnet_standalone_network_plugin_segmentation_id=1011 MANILA_OPTGROUP_adminnet_standalone_network_plugin_allowed_ip_ranges=11.0.0.10-11.0.0.19,11.0.0.30-11.0.0.39,11.0.0.50-11.0.0.199 MANILA_OPTGROUP_adminnet_network_plugin_ipv4_enabled=True
Configuration
The functional tests require a couple of configuration files, so you will need to generate them before running the tests.
For DevStack
On your DevStack machine, you can run the following script. It assumes that devstack is cloned onto your base folder.
DEST=${DEST:-/opt/stack}
MANILACLIENT_DIR=${MANILACLIENT_DIR:-$DEST/python-manilaclient}
MANILACLIENT_CONF="$MANILACLIENT_DIR/etc/manilaclient/manilaclient.conf"
# Go to the manilaclient dir
cd $MANILACLIENT_DIR
# Give permissions
sudo chown -R $USER:stack .
# Create manilaclient config file
touch $MANILACLIENT_CONF
# Import functions from devstack
source $HOME/devstack/functions
# Set options to config client.
source $HOME/devstack/openrc demo demo
export OS_TENANT_NAME=${OS_PROJECT_NAME:-$OS_TENANT_NAME}
iniset $MANILACLIENT_CONF DEFAULT username $OS_USERNAME
iniset $MANILACLIENT_CONF DEFAULT tenant_name $OS_TENANT_NAME
iniset $MANILACLIENT_CONF DEFAULT password $OS_PASSWORD
iniset $MANILACLIENT_CONF DEFAULT auth_url $OS_AUTH_URL
iniset $MANILACLIENT_CONF DEFAULT project_domain_name $OS_PROJECT_DOMAIN_NAME
iniset $MANILACLIENT_CONF DEFAULT user_domain_name $OS_USER_DOMAIN_NAME
iniset $MANILACLIENT_CONF DEFAULT project_domain_id $OS_PROJECT_DOMAIN_ID
iniset $MANILACLIENT_CONF DEFAULT user_domain_id $OS_USER_DOMAIN_ID
source $HOME/devstack/openrc admin demo
export OS_TENANT_NAME=${OS_PROJECT_NAME:-$OS_TENANT_NAME}
iniset $MANILACLIENT_CONF DEFAULT admin_username $OS_USERNAME
iniset $MANILACLIENT_CONF DEFAULT admin_tenant_name $OS_TENANT_NAME
iniset $MANILACLIENT_CONF DEFAULT admin_password $OS_PASSWORD
iniset $MANILACLIENT_CONF DEFAULT admin_auth_url $OS_AUTH_URL
iniset $MANILACLIENT_CONF DEFAULT admin_project_domain_name $OS_PROJECT_DOMAIN_NAME
iniset $MANILACLIENT_CONF DEFAULT admin_user_domain_name $OS_USER_DOMAIN_NAME
iniset $MANILACLIENT_CONF DEFAULT admin_project_domain_id $OS_PROJECT_DOMAIN_ID
iniset $MANILACLIENT_CONF DEFAULT admin_user_domain_id $OS_USER_DOMAIN_ID
# Suppress errors in cleanup of resources
SUPPRESS_ERRORS=${SUPPRESS_ERRORS_IN_CLEANUP:-False}
iniset $MANILACLIENT_CONF DEFAULT suppress_errors_in_cleanup $SUPPRESS_ERRORS
# Set access type usage specific to dummy driver that we are using in CI
iniset $MANILACLIENT_CONF DEFAULT access_types_mapping "nfs:ip,cifs:user"
# Dummy driver is capable of running share migration tests
iniset $MANILACLIENT_CONF DEFAULT run_migration_tests "True"
# Running mountable snapshot tests in dummy driver
iniset $MANILACLIENT_CONF DEFAULT run_mount_snapshot_tests "True"
# Create share network and use it for functional tests if required
USE_SHARE_NETWORK=$(trueorfalse True USE_SHARE_NETWORK)
if [[ ${USE_SHARE_NETWORK} = True ]]; then
SHARE_NETWORK_NAME=${SHARE_NETWORK_NAME:-ci}
DEFAULT_NEUTRON_NET=$(openstack network show private -c id -f value)
DEFAULT_NEUTRON_SUBNET=$(openstack subnet show private-subnet -c id -f value)
NEUTRON_NET=${NEUTRON_NET:-$DEFAULT_NEUTRON_NET}
NEUTRON_SUBNET=${NEUTRON_SUBNET:-$DEFAULT_NEUTRON_SUBNET}
manila share-network-create --name $SHARE_NETWORK_NAME --neutron-net $NEUTRON_NET --neutron-subnet $NEUTRON_SUBNET
iniset $MANILACLIENT_CONF DEFAULT share_network $SHARE_NETWORK_NAME
iniset $MANILACLIENT_CONF DEFAULT admin_share_network $SHARE_NETWORK_NAME
fi
# Set share type if required if [[ "$SHARE_TYPE" ]]; then
iniset $MANILACLIENT_CONF DEFAULT share_type $SHARE_TYPE fi
Running the tests
To run all functional tests make sure you are in the top level of your python-manilaclient module (e.g. /opt/stack/python-manilaclient/) and simply run:
tox -e functional
This will create a virtual environment, load all the packages from test-requirements.txt and run all functional tests.
AUTHOR
unknown
COPYRIGHT
Rackspace, based on work by Jacob Kaplan-Moss
| October 16, 2023 | 4.5.0 |