openstack-manuals/doc/cli-reference/generated/ch_cli_manila_commands.xml
Atsushi SAKAI 4ce6c85cee Update CLI reference for python-manilaclient 1.5.0
Change-Id: I574f8510e3a9b7517121100671df1649a3a0e2c5
2015-10-20 11:40:28 +09:00

3797 lines
116 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0"
xml:id="manilaclient_commands">
<!-- This file is automatically generated, do not edit -->
<?dbhtml stop-chunking?>
<title>Shared file systems command-line client</title>
<para>The <command>manila</command> client is the command-line
interface (CLI) for the Shared file systems API and its extensions.
This chapter documents <command>manila</command> version
<literal>1.5.0</literal>.
</para>
<para>For help on a specific <command>manila</command>
command, enter:
</para>
<screen><prompt>$</prompt> <userinput><command>manila</command> <option>help</option> <replaceable>COMMAND</replaceable></userinput></screen>
<section xml:id="manilaclient_command_usage">
<title>manila usage</title>
<screen><computeroutput>usage: manila [--version] [-d] [--os-cache] [--os-reset-cache]
[--os-user-id &lt;auth-user-id&gt;] [--os-username &lt;auth-user-name&gt;]
[--os-password &lt;auth-password&gt;]
[--os-tenant-name &lt;auth-tenant-name&gt;]
[--os-project-name &lt;auth-project-name&gt;]
[--os-tenant-id &lt;auth-tenant-id&gt;]
[--os-project-id &lt;auth-project-id&gt;]
[--os-user-domain-id &lt;auth-user-domain-id&gt;]
[--os-user-domain-name &lt;auth-user-domain-name&gt;]
[--os-project-domain-id &lt;auth-project-domain-id&gt;]
[--os-project-domain-name &lt;auth-project-domain-name&gt;]
[--os-auth-url &lt;auth-url&gt;] [--os-region-name &lt;region-name&gt;]
[--service-type &lt;service-type&gt;] [--service-name &lt;service-name&gt;]
[--share-service-name &lt;share-service-name&gt;]
[--endpoint-type &lt;endpoint-type&gt;]
[--os-share-api-version &lt;share-api-ver&gt;]
[--os-cacert &lt;ca-certificate&gt;] [--retries &lt;retries&gt;]
[--os-cert &lt;certificate&gt;]
&lt;subcommand&gt; ...</computeroutput></screen>
<variablelist wordsize="10">
<title>Subcommands</title>
<varlistentry>
<term><command>absolute-limits</command></term>
<listitem>
<para>
Print a list of absolute limits for a user.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>access-allow</command></term>
<listitem>
<para>
Allow access to the share.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>access-deny</command></term>
<listitem>
<para>
Deny access to a share.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>access-list</command></term>
<listitem>
<para>
Show access list for share.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>api-version</command></term>
<listitem>
<para>
Display the API version information.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>cg-create</command></term>
<listitem>
<para>
Creates a new consistency group.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>cg-delete</command></term>
<listitem>
<para>
Remove one or more consistency groups.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>cg-list</command></term>
<listitem>
<para>
List consistency groups with filters.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>cg-reset-state</command></term>
<listitem>
<para>
Explicitly update the state of a consistency group.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>cg-show</command></term>
<listitem>
<para>
Show details about a consistency group.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>cg-snapshot-create</command></term>
<listitem>
<para>
Creates a new consistency group.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>cg-snapshot-delete</command></term>
<listitem>
<para>
Remove one or more consistency group snapshots.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>cg-snapshot-list</command></term>
<listitem>
<para>
List consistency group snapshots with filters.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>cg-snapshot-members</command></term>
<listitem>
<para>
Get member details for a consistency group snapshot.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>cg-snapshot-reset-state</command></term>
<listitem>
<para>
Explicitly update the state of a consistency group.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>cg-snapshot-show</command></term>
<listitem>
<para>
Show details about a consistency group snapshot.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>cg-snapshot-update</command></term>
<listitem>
<para>
Update a consistency group snapshot.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>cg-update</command></term>
<listitem>
<para>
Update a consistency group.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>create</command></term>
<listitem>
<para>
Creates a new share (NFS, CIFS, GlusterFS or HDFS).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>credentials</command></term>
<listitem>
<para>
Show user credentials returned from auth.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>delete</command></term>
<listitem>
<para>
Remove one or more shares.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>endpoints</command></term>
<listitem>
<para>
Discover endpoints that get returned from the
authenticate services.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>extend</command></term>
<listitem>
<para>
Increases the size of an existing share.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>extra-specs-list</command></term>
<listitem>
<para>
Print a list of current 'share types and extra specs'
(Admin Only).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>force-delete</command></term>
<listitem>
<para>
Attempt force-delete of share, regardless of state.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>list</command></term>
<listitem>
<para>
List NAS shares with filters.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>manage</command></term>
<listitem>
<para>
Manage share not handled by Manila.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>metadata</command></term>
<listitem>
<para>
Set or delete metadata on a share.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>metadata-show</command></term>
<listitem>
<para>
Show metadata of given share.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>metadata-update-all</command></term>
<listitem>
<para>
Update all metadata of a share.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>migrate</command></term>
<listitem>
<para>
Migrates share to a new host.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>pool-list</command></term>
<listitem>
<para>
List all backend storage pools known to the scheduler
(Admin only).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>quota-class-show</command></term>
<listitem>
<para>
List the quotas for a quota class.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>quota-class-update</command></term>
<listitem>
<para>
Update the quotas for a quota class.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>quota-defaults</command></term>
<listitem>
<para>
List the default quotas for a tenant.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>quota-delete</command></term>
<listitem>
<para>
Delete quota for a tenant/user. The quota will revert
back to default.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>quota-show</command></term>
<listitem>
<para>
List the quotas for a tenant/user.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>quota-update</command></term>
<listitem>
<para>
Update the quotas for a tenant/user.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>rate-limits</command></term>
<listitem>
<para>
Print a list of rate limits for a user.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>reset-state</command></term>
<listitem>
<para>
Explicitly update the state of a share.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>security-service-create</command></term>
<listitem>
<para>
Create security service used by tenant.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>security-service-delete</command></term>
<listitem>
<para>
Delete security service.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>security-service-list</command></term>
<listitem>
<para>
Get a list of security services.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>security-service-show</command></term>
<listitem>
<para>
Show security service.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>security-service-update</command></term>
<listitem>
<para>
Update security service.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>service-list</command></term>
<listitem>
<para>
List all services.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>share-instance-force-delete</command></term>
<listitem>
<para>
Attempt force-delete of share instance, regardless of
state.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>share-instance-list</command></term>
<listitem>
<para>
List share instances.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>share-instance-reset-state</command></term>
<listitem>
<para>
Explicitly update the state of a share instance.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>share-instance-show</command></term>
<listitem>
<para>
Show details about a share instance.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>share-network-create</command></term>
<listitem>
<para>
Create description for network used by the tenant.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>share-network-delete</command></term>
<listitem>
<para>
Delete share network.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>share-network-list</command></term>
<listitem>
<para>
Get a list of network info.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>share-network-security-service-add</command></term>
<listitem>
<para>
Associate security service with share network.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>share-network-security-service-list</command></term>
<listitem>
<para>
Get list of security services associated with a given
share network.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>share-network-security-service-remove</command></term>
<listitem>
<para>
Dissociate security service from share network.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>share-network-show</command></term>
<listitem>
<para>
Get a description for network used by the tenant.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>share-network-update</command></term>
<listitem>
<para>
Update share network data.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>share-server-delete</command></term>
<listitem>
<para>
Delete share server.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>share-server-details</command></term>
<listitem>
<para>
Show share server details.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>share-server-list</command></term>
<listitem>
<para>
List all share servers.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>share-server-show</command></term>
<listitem>
<para>
Show share server info.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>show</command></term>
<listitem>
<para>
Show details about a NAS share.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>shrink</command></term>
<listitem>
<para>
Decreases the size of an existing share.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>snapshot-create</command></term>
<listitem>
<para>
Add a new snapshot.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>snapshot-delete</command></term>
<listitem>
<para>
Remove a snapshot.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>snapshot-force-delete</command></term>
<listitem>
<para>
Attempt force-delete of snapshot, regardless of state.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>snapshot-list</command></term>
<listitem>
<para>
List all the snapshots.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>snapshot-rename</command></term>
<listitem>
<para>
Rename a snapshot.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>snapshot-reset-state</command></term>
<listitem>
<para>
Explicitly update the state of a snapshot.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>snapshot-show</command></term>
<listitem>
<para>
Show details about a snapshot.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>type-access-add</command></term>
<listitem>
<para>
Adds share type access for the given project.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>type-access-list</command></term>
<listitem>
<para>
Print access information about the given share type.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>type-access-remove</command></term>
<listitem>
<para>
Removes share type access for the given project.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>type-create</command></term>
<listitem>
<para>
Create a new share type.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>type-delete</command></term>
<listitem>
<para>
Delete a specific share type.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>type-key</command></term>
<listitem>
<para>
Set or unset extra_spec for a share type.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>type-list</command></term>
<listitem>
<para>
Print a list of available 'share types'.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>unmanage</command></term>
<listitem>
<para>
Unmanage share.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>update</command></term>
<listitem>
<para>
Rename a share.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>bash-completion</command></term>
<listitem>
<para>
Print arguments for bash_completion. Prints all of the
commands and options to stdout so that the
manila.bash_completion script doesn't have to hard
code them.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>help</command></term>
<listitem>
<para>
Display help about this program or one of its
subcommands.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>list-extensions</command></term>
<listitem>
<para>
List all the os-api extensions that are available.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_command_optional">
<title>manila optional arguments</title>
<variablelist wordsize="10">
<varlistentry>
<term><command>--version</command></term>
<listitem>
<para>
show program's version number and exit
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-d, --debug</command></term>
<listitem>
<para>
Print debugging output.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-cache</command></term>
<listitem>
<para>
Use the auth token cache. Defaults to <code>env[OS_CACHE]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-reset-cache</command></term>
<listitem>
<para>
Delete cached password and auth token.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-user-id &lt;auth-user-id&gt;</command></term>
<listitem>
<para>
Defaults to env [OS_USER_ID].
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-username &lt;auth-user-name&gt;</command></term>
<listitem>
<para>
Defaults to <code>env[OS_USERNAME]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-password &lt;auth-password&gt;</command></term>
<listitem>
<para>
Defaults to <code>env[OS_PASSWORD]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-tenant-name &lt;auth-tenant-name&gt;</command></term>
<listitem>
<para>
Defaults to <code>env[OS_TENANT_NAME]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-project-name &lt;auth-project-name&gt;</command></term>
<listitem>
<para>
Another way to specify tenant name. This option is
mutually exclusive with --os-tenant-name. Defaults to
<code>env[OS_PROJECT_NAME]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-tenant-id &lt;auth-tenant-id&gt;</command></term>
<listitem>
<para>
Defaults to <code>env[OS_TENANT_ID]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-project-id &lt;auth-project-id&gt;</command></term>
<listitem>
<para>
Another way to specify tenant ID. This option is
mutually exclusive with --os-tenant-id. Defaults to
<code>env[OS_PROJECT_ID]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-user-domain-id &lt;auth-user-domain-id&gt;</command></term>
<listitem>
<para>
OpenStack user domain ID. Defaults to
<code>env[OS_USER_DOMAIN_ID]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-user-domain-name &lt;auth-user-domain-name&gt;</command></term>
<listitem>
<para>
OpenStack user domain name. Defaults to
<code>env[OS_USER_DOMAIN_NAME]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-project-domain-id &lt;auth-project-domain-id&gt;</command></term>
<listitem>
<para>
Defaults to <code>env[OS_PROJECT_DOMAIN_ID]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-project-domain-name &lt;auth-project-domain-name&gt;</command></term>
<listitem>
<para>
Defaults to <code>env[OS_PROJECT_DOMAIN_NAME]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-auth-url &lt;auth-url&gt;</command></term>
<listitem>
<para>
Defaults to <code>env[OS_AUTH_URL]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-region-name &lt;region-name&gt;</command></term>
<listitem>
<para>
Defaults to <code>env[OS_REGION_NAME]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--service-type &lt;service-type&gt;</command></term>
<listitem>
<para>
Defaults to compute for most actions.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--service-name &lt;service-name&gt;</command></term>
<listitem>
<para>
Defaults to <code>env[MANILA_SERVICE_NAME]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--share-service-name &lt;share-service-name&gt;</command></term>
<listitem>
<para>
Defaults to <code>env[MANILA_share_service_name]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--endpoint-type &lt;endpoint-type&gt;</command></term>
<listitem>
<para>
Defaults to <code>env[MANILA_ENDPOINT_TYPE]</code> or publicURL.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-share-api-version &lt;share-api-ver&gt;</command></term>
<listitem>
<para>
Accepts 1.x to override default to
<code>env[OS_SHARE_API_VERSION]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-cacert &lt;ca-certificate&gt;</command></term>
<listitem>
<para>
Specify a CA bundle file to use in verifying a TLS
(https) server certificate. Defaults to
<code>env[OS_CACERT]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--retries &lt;retries&gt;</command></term>
<listitem>
<para>
Number of retries.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-cert &lt;certificate&gt;</command></term>
<listitem>
<para>
Defaults to <code>env[OS_CERT]</code>.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_absolute-limits">
<title>manila absolute-limits</title>
<screen><computeroutput>usage: manila absolute-limits</computeroutput></screen>
<para>
Print a list of absolute limits for a user.
</para>
</section>
<section xml:id="manilaclient_subcommand_access-allow">
<title>manila access-allow</title>
<screen><computeroutput>usage: manila access-allow [--access-level &lt;access_level&gt;]
&lt;share&gt; &lt;access_type&gt; &lt;access_to&gt;</computeroutput></screen>
<para>
Allow access to the share.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;share&gt;</command></term>
<listitem>
<para>
Name or ID of the NAS share to modify.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;access_type&gt;</command></term>
<listitem>
<para>
Access rule type (only "ip", "user"(user or group),
and "cert" are supported).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;access_to&gt;</command></term>
<listitem>
<para>
Value that defines access.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--access-level &lt;access_level&gt;, --access_level &lt;access_level&gt;</command></term>
<listitem>
<para>
Share access level ("rw" and "ro" access levels are
supported). Defaults to None.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_access-deny">
<title>manila access-deny</title>
<screen><computeroutput>usage: manila access-deny &lt;share&gt; &lt;id&gt;</computeroutput></screen>
<para>
Deny access to a share.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;share&gt;</command></term>
<listitem>
<para>
Name or ID of the NAS share to modify.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;id&gt;</command></term>
<listitem>
<para>
ID of the access rule to be deleted.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_access-list">
<title>manila access-list</title>
<screen><computeroutput>usage: manila access-list &lt;share&gt;</computeroutput></screen>
<para>
Show access list for share.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;share&gt;</command></term>
<listitem>
<para>
Name or ID of the share.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_api-version">
<title>manila api-version</title>
<screen><computeroutput>usage: manila api-version</computeroutput></screen>
<para>
Display the API version information.
</para>
</section>
<section xml:id="manilaclient_subcommand_cg-create">
<title>manila cg-create</title>
<screen><computeroutput>usage: manila cg-create [--name &lt;name&gt;] [--description &lt;description&gt;]
[--share-types &lt;share_types&gt;]
[--share-network &lt;share_network&gt;]
[--source-cgsnapshot-id &lt;source_cgsnapshot_id&gt;]</computeroutput></screen>
<para>
Creates a new consistency group.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--name &lt;name&gt;</command></term>
<listitem>
<para>
Optional consistency group name. (Default=None)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--description &lt;description&gt;</command></term>
<listitem>
<para>
Optional consistency group description. (Default=None)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--share-types &lt;share_types&gt;, --share_types &lt;share_types&gt;</command></term>
<listitem>
<para>
Optional list of share types. (Default=None)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--share-network &lt;share_network&gt;, --share_network &lt;share_network&gt;</command></term>
<listitem>
<para>
Specify share-network name or id.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--source-cgsnapshot-id &lt;source_cgsnapshot_id&gt;, --source_cgsnapshot_id &lt;source_cgsnapshot_id&gt;</command></term>
<listitem>
<para>
Optional snapshot ID to create the share from.
(Default=None)
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_cg-delete">
<title>manila cg-delete</title>
<screen><computeroutput>usage: manila cg-delete [--force]
&lt;consistency_group&gt; [&lt;consistency_group&gt; ...]</computeroutput></screen>
<para>
Remove one or more consistency groups.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;consistency_group&gt;</command></term>
<listitem>
<para>
Name or ID of the consistency group(s).
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--force</command></term>
<listitem>
<para>
Attempt to force delete the consistency group
(Default=False).
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_cg-list">
<title>manila cg-list</title>
<screen><computeroutput>usage: manila cg-list [--all-tenants [&lt;0|1&gt;]] [--limit &lt;limit&gt;]
[--offset &lt;offset&gt;]</computeroutput></screen>
<para>
List consistency groups with filters.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--all-tenants [&lt;0|1&gt;]</command></term>
<listitem>
<para>
Display information from all tenants (Admin only).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--limit &lt;limit&gt;</command></term>
<listitem>
<para>
Maximum number of consistency groups to return.
(Default=None)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--offset &lt;offset&gt;</command></term>
<listitem>
<para>
Start position of consistency group listing.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_cg-reset-state">
<title>manila cg-reset-state</title>
<screen><computeroutput>usage: manila cg-reset-state [--state &lt;state&gt;] &lt;consistency_group&gt;</computeroutput></screen>
<para>
Explicitly update the state of a consistency group.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;consistency_group&gt;</command></term>
<listitem>
<para>
Name or ID of the consistency group state to modify.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--state &lt;state&gt;</command></term>
<listitem>
<para>
Indicate which state to assign the consistency group.
Options include available, error, creating, deleting,
error_deleting. If no state is provided, available will
be used.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_cg-show">
<title>manila cg-show</title>
<screen><computeroutput>usage: manila cg-show &lt;consistency_group&gt;</computeroutput></screen>
<para>
Show details about a consistency group.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;consistency_group&gt;</command></term>
<listitem>
<para>
Name or ID of the consistency group.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_cg-snapshot-create">
<title>manila cg-snapshot-create</title>
<screen><computeroutput>usage: manila cg-snapshot-create [--name &lt;name&gt;] [--description &lt;description&gt;]
&lt;consistency_group&gt;</computeroutput></screen>
<para>
Creates a new consistency group.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;consistency_group&gt;</command></term>
<listitem>
<para>
Name or ID of the consistency group.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--name &lt;name&gt;</command></term>
<listitem>
<para>
Optional consistency group snapshot name.
(Default=None)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--description &lt;description&gt;</command></term>
<listitem>
<para>
Optional consistency group snapshot description.
(Default=None)
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_cg-snapshot-delete">
<title>manila cg-snapshot-delete</title>
<screen><computeroutput>usage: manila cg-snapshot-delete [--force] &lt;cg_snapshot&gt; [&lt;cg_snapshot&gt; ...]</computeroutput></screen>
<para>
Remove one or more consistency group snapshots.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;cg_snapshot&gt;</command></term>
<listitem>
<para>
Name or ID of the consistency group snapshot.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--force</command></term>
<listitem>
<para>
Attempt to force delete the cg snapshot(s) (Default=False).
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_cg-snapshot-list">
<title>manila cg-snapshot-list</title>
<screen><computeroutput>usage: manila cg-snapshot-list [--all-tenants [&lt;0|1&gt;]] [--limit &lt;limit&gt;]
[--offset &lt;offset&gt;] [--detailed DETAILED]</computeroutput></screen>
<para>
List consistency group snapshots with filters.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--all-tenants [&lt;0|1&gt;]</command></term>
<listitem>
<para>
Display information from all tenants (Admin only).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--limit &lt;limit&gt;</command></term>
<listitem>
<para>
Maximum number of consistency group snapshots to
return.(Default=None)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--offset &lt;offset&gt;</command></term>
<listitem>
<para>
Start position of consistency group snapshot listing.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--detailed DETAILED</command></term>
<listitem>
<para>
Show detailed information about snapshots.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_cg-snapshot-members">
<title>manila cg-snapshot-members</title>
<screen><computeroutput>usage: manila cg-snapshot-members [--limit &lt;limit&gt;] [--offset &lt;offset&gt;]
&lt;cg_snapshot&gt;</computeroutput></screen>
<para>
Get member details for a consistency group snapshot.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;cg_snapshot&gt;</command></term>
<listitem>
<para>
Name or ID of the consistency group snapshot.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--limit &lt;limit&gt;</command></term>
<listitem>
<para>
Maximum number of shares to return. (Default=None)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--offset &lt;offset&gt;</command></term>
<listitem>
<para>
Start position of security services listing.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_cg-snapshot-reset-state">
<title>manila cg-snapshot-reset-state</title>
<screen><computeroutput>usage: manila cg-snapshot-reset-state [--state &lt;state&gt;] &lt;cg_snapshot&gt;</computeroutput></screen>
<para>
Explicitly update the state of a consistency group.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;cg_snapshot&gt;</command></term>
<listitem>
<para>
Name or ID of the consistency group snapshot.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--state &lt;state&gt;</command></term>
<listitem>
<para>
Indicate which state to assign the consistency group.
Options include available, error, creating, deleting,
error_deleting. If no state is provided, available will be
used.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_cg-snapshot-show">
<title>manila cg-snapshot-show</title>
<screen><computeroutput>usage: manila cg-snapshot-show &lt;cg_snapshot&gt;</computeroutput></screen>
<para>
Show details about a consistency group snapshot.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;cg_snapshot&gt;</command></term>
<listitem>
<para>
Name or ID of the consistency group snapshot.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_cg-snapshot-update">
<title>manila cg-snapshot-update</title>
<screen><computeroutput>usage: manila cg-snapshot-update [--name &lt;name&gt;] [--description &lt;description&gt;]
&lt;cg_snapshot&gt;</computeroutput></screen>
<para>
Update a consistency group snapshot.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;cg_snapshot&gt;</command></term>
<listitem>
<para>
Name or ID of the cg snapshot to update.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--name &lt;name&gt;</command></term>
<listitem>
<para>
Optional new name for the cg snapshot. (Default=None
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--description &lt;description&gt;</command></term>
<listitem>
<para>
Optional cg snapshot description. (Default=None)
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_cg-update">
<title>manila cg-update</title>
<screen><computeroutput>usage: manila cg-update [--name &lt;name&gt;] [--description &lt;description&gt;]
&lt;consistency_group&gt;</computeroutput></screen>
<para>
Update a consistency group.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;consistency_group&gt;</command></term>
<listitem>
<para>
Name or ID of the consistency group to update.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--name &lt;name&gt;</command></term>
<listitem>
<para>
Optional new name for the consistency group.
(Default=None)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--description &lt;description&gt;</command></term>
<listitem>
<para>
Optional consistency group description. (Default=None)
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_create">
<title>manila create</title>
<screen><computeroutput>usage: manila create [--snapshot-id &lt;snapshot-id&gt;] [--name &lt;name&gt;]
[--metadata [&lt;key=value&gt; [&lt;key=value&gt; ...]]]
[--share-network &lt;network-info&gt;]
[--description &lt;description&gt;] [--share-type &lt;share-type&gt;]
[--public] [--availability-zone &lt;availability-zone&gt;]
[--consistency-group &lt;consistency-group&gt;]
&lt;share_protocol&gt; &lt;size&gt;</computeroutput></screen>
<para>
Creates a new share (NFS, CIFS, GlusterFS or HDFS).
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;share_protocol&gt;</command></term>
<listitem>
<para>
Share type (NFS, CIFS, GlusterFS or HDFS).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;size&gt;</command></term>
<listitem>
<para>
Share size in GB.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--snapshot-id &lt;snapshot-id&gt;</command></term>
<listitem>
<para>
Optional snapshot ID to create the share from.
(Default=None)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--name &lt;name&gt;</command></term>
<listitem>
<para>
Optional share name. (Default=None)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--metadata [&lt;key=value&gt; [&lt;key=value&gt; ...]]</command></term>
<listitem>
<para>
Metadata key=value pairs (Optional, Default=None).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--share-network &lt;network-info&gt;</command></term>
<listitem>
<para>
Optional network info ID or name.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--description &lt;description&gt;</command></term>
<listitem>
<para>
Optional share description. (Default=None)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--share-type &lt;share-type&gt;, --share_type &lt;share-type&gt;, --volume-type &lt;share-type&gt;, --volume_type &lt;share-type&gt;</command></term>
<listitem>
<para>
Optional share type. Use of optional volume type is
deprecated(Default=None)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--public</command></term>
<listitem>
<para>
Level of visibility for share. Defines whether other
tenants are able to see it or not.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--availability-zone &lt;availability-zone&gt;, --availability_zone &lt;availability-zone&gt;, --az &lt;availability-zone&gt;</command></term>
<listitem>
<para>
Availability zone in which share should be created.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--consistency-group &lt;consistency-group&gt;, --consistency_group &lt;consistency-group&gt;, --cg &lt;consistency-group&gt;</command></term>
<listitem>
<para>
Optional consistency group name or ID in which to
create the share. (Default=None)
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_credentials">
<title>manila credentials</title>
<screen><computeroutput>usage: manila credentials</computeroutput></screen>
<para>
Show user credentials returned from auth.
</para>
</section>
<section xml:id="manilaclient_subcommand_delete">
<title>manila delete</title>
<screen><computeroutput>usage: manila delete [--consistency-group &lt;consistency-group&gt;]
&lt;share&gt; [&lt;share&gt; ...]</computeroutput></screen>
<para>
Remove one or more shares.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;share&gt;</command></term>
<listitem>
<para>
Name or ID of the share(s).
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--consistency-group &lt;consistency-group&gt;, --consistency_group &lt;consistency-group&gt;, --cg &lt;consistency-group&gt;</command></term>
<listitem>
<para>
Optional consistency group name or ID which contains
the share. (Default=None)
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_endpoints">
<title>manila endpoints</title>
<screen><computeroutput>usage: manila endpoints</computeroutput></screen>
<para>
Discover endpoints that get returned from the authenticate services.
</para>
</section>
<section xml:id="manilaclient_subcommand_extend">
<title>manila extend</title>
<screen><computeroutput>usage: manila extend &lt;share&gt; &lt;new_size&gt;</computeroutput></screen>
<para>
Increases the size of an existing share.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;share&gt;</command></term>
<listitem>
<para>
Name or ID of share to extend.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;new_size&gt;</command></term>
<listitem>
<para>
New size of share, in GBs.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_extra-specs-list">
<title>manila extra-specs-list</title>
<screen><computeroutput>usage: manila extra-specs-list</computeroutput></screen>
<para>
Print a list of current 'share types and extra specs' (Admin Only).
</para>
</section>
<section xml:id="manilaclient_subcommand_force-delete">
<title>manila force-delete</title>
<screen><computeroutput>usage: manila force-delete &lt;share&gt; [&lt;share&gt; ...]</computeroutput></screen>
<para>
Attempt force-delete of share, regardless of state.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;share&gt;</command></term>
<listitem>
<para>
Name or ID of the share(s) to force delete.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_list">
<title>manila list</title>
<screen><computeroutput>usage: manila list [--all-tenants [&lt;0|1&gt;]] [--name &lt;name&gt;] [--status &lt;status&gt;]
[--share-server-id &lt;share_server_id&gt;]
[--metadata [&lt;key=value&gt; [&lt;key=value&gt; ...]]]
[--extra-specs [&lt;key=value&gt; [&lt;key=value&gt; ...]]]
[--share-type &lt;share_type&gt;] [--limit &lt;limit&gt;]
[--offset &lt;offset&gt;] [--sort-key &lt;sort_key&gt;]
[--sort-dir &lt;sort_dir&gt;] [--snapshot &lt;snapshot&gt;]
[--host &lt;host&gt;] [--share-network &lt;share_network&gt;]
[--project-id &lt;project_id&gt;] [--public]
[--consistency-group &lt;consistency_group&gt;]</computeroutput></screen>
<para>
List NAS shares with filters.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--all-tenants [&lt;0|1&gt;]</command></term>
<listitem>
<para>
Display information from all tenants (Admin only).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--name &lt;name&gt;</command></term>
<listitem>
<para>
Filter results by name.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--status &lt;status&gt;</command></term>
<listitem>
<para>
Filter results by status.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--share-server-id &lt;share_server_id&gt;, --share-server_id &lt;share_server_id&gt;, --share_server-id &lt;share_server_id&gt;, --share_server_id &lt;share_server_id&gt;</command></term>
<listitem>
<para>
Filter results by share server ID.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--metadata [&lt;key=value&gt; [&lt;key=value&gt; ...]]</command></term>
<listitem>
<para>
Filters results by a metadata key and value. OPTIONAL:
Default=None
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--extra-specs [&lt;key=value&gt; [&lt;key=value&gt; ...]], --extra_specs [&lt;key=value&gt; [&lt;key=value&gt; ...]]</command></term>
<listitem>
<para>
Filters results by a extra specs key and value of
share type that was used for share creation. OPTIONAL:
Default=None
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--share-type &lt;share_type&gt;, --volume-type--share_type &lt;share_type&gt;, --share-type-id &lt;share_type&gt;, --volume-type-id &lt;share_type&gt;, --share-type_id &lt;share_type&gt;, --share_type-id &lt;share_type&gt;, --share_type_id &lt;share_type&gt;, --volume_type &lt;share_type&gt;, --volume_type_id &lt;share_type&gt;</command></term>
<listitem>
<para>
Filter results by a share type id or name that was
used for share creation.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--limit &lt;limit&gt;</command></term>
<listitem>
<para>
Maximum number of shares to return. OPTIONAL:
Default=None.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--offset &lt;offset&gt;</command></term>
<listitem>
<para>
Set offset to define start point of share listing.
OPTIONAL: Default=None.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--sort-key &lt;sort_key&gt;, --sort_key &lt;sort_key&gt;</command></term>
<listitem>
<para>
Key to be sorted, available keys are ('id', 'status',
'size', 'host', 'share_proto', 'export_location',
'availability_zone', 'user_id', 'project_id',
'created_at', 'updated_at', 'display_name', 'name',
'share_type_id', 'share_type', 'share_network_id',
'share_network', 'snapshot_id', 'snapshot'). OPTIONAL:
Default=None.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--sort-dir &lt;sort_dir&gt;, --sort_dir &lt;sort_dir&gt;</command></term>
<listitem>
<para>
Sort direction, available values are ('asc', 'desc').
OPTIONAL: Default=None.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--snapshot &lt;snapshot&gt;</command></term>
<listitem>
<para>
Filer results by snapshot name or id, that was used
for share.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--host &lt;host&gt;</command></term>
<listitem>
<para>
Filter results by host.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--share-network &lt;share_network&gt;, --share_network &lt;share_network&gt;</command></term>
<listitem>
<para>
Filter results by share-network name or id.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--project-id &lt;project_id&gt;, --project_id &lt;project_id&gt;</command></term>
<listitem>
<para>
Filter results by project id. Useful with set key
'--all-tenants'.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--public</command></term>
<listitem>
<para>
Add public shares from all tenants to result.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--consistency-group &lt;consistency_group&gt;, --consistency_group &lt;consistency_group&gt;, --cg &lt;consistency_group&gt;</command></term>
<listitem>
<para>
Filter results by consistency group name or ID.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_list-extensions">
<title>manila list-extensions</title>
<screen><computeroutput>usage: manila list-extensions</computeroutput></screen>
<para>
List all the os-api extensions that are available.
</para>
</section>
<section xml:id="manilaclient_subcommand_manage">
<title>manila manage</title>
<screen><computeroutput>usage: manila manage [--name &lt;name&gt;] [--description &lt;description&gt;]
[--share_type &lt;share-type&gt;]
[--driver_options [&lt;key=value&gt; [&lt;key=value&gt; ...]]]
&lt;service_host&gt; &lt;protocol&gt; &lt;export_path&gt;</computeroutput></screen>
<para>
Manage share not handled by Manila.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;service_host&gt;</command></term>
<listitem>
<para>
manage-share service host: some.host@driver#pool
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;protocol&gt;</command></term>
<listitem>
<para>
Protocol of the share to manage, such as NFS or CIFS.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;export_path&gt;</command></term>
<listitem>
<para>
Share export path, NFS share such as:
10.0.0.1:/foo_path, CIFS share such as:
\\10.0.0.1\foo_name_of_cifs_share
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--name &lt;name&gt;</command></term>
<listitem>
<para>
Optional share name. (Default=None)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--description &lt;description&gt;</command></term>
<listitem>
<para>
Optional share description. (Default=None)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--share_type &lt;share-type&gt;, --share-type &lt;share-type&gt;</command></term>
<listitem>
<para>
Optional share type assigned to share. (Default=None)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--driver_options [&lt;key=value&gt; [&lt;key=value&gt; ...]], --driver-options [&lt;key=value&gt; [&lt;key=value&gt; ...]]</command></term>
<listitem>
<para>
Driver option key=value pairs (Optional,
Default=None).
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_metadata">
<title>manila metadata</title>
<screen><computeroutput>usage: manila metadata &lt;share&gt; &lt;action&gt; &lt;key=value&gt; [&lt;key=value&gt; ...]</computeroutput></screen>
<para>
Set or delete metadata on a share.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;share&gt;</command></term>
<listitem>
<para>
Name or ID of the share to update metadata on.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;action&gt;</command></term>
<listitem>
<para>
Actions: 'set' or 'unset'.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;key=value&gt;</command></term>
<listitem>
<para>
Metadata to set or unset (key is only necessary on unset).
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_metadata-show">
<title>manila metadata-show</title>
<screen><computeroutput>usage: manila metadata-show &lt;share&gt;</computeroutput></screen>
<para>
Show metadata of given share.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;share&gt;</command></term>
<listitem>
<para>
Name or ID of the share.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_metadata-update-all">
<title>manila metadata-update-all</title>
<screen><computeroutput>usage: manila metadata-update-all &lt;share&gt; &lt;key=value&gt; [&lt;key=value&gt; ...]</computeroutput></screen>
<para>
Update all metadata of a share.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;share&gt;</command></term>
<listitem>
<para>
Name or ID of the share to update metadata on.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;key=value&gt;</command></term>
<listitem>
<para>
Metadata entry or entries to update.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_migrate">
<title>manila migrate</title>
<screen><computeroutput>usage: manila migrate [--force-host-copy &lt;True|False&gt;] &lt;share&gt; &lt;host#pool&gt;</computeroutput></screen>
<para>
Migrates share to a new host.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;share&gt;</command></term>
<listitem>
<para>
Name or ID of share to migrate.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;host#pool&gt;</command></term>
<listitem>
<para>
Destination host and pool.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--force-host-copy &lt;True|False&gt;</command></term>
<listitem>
<para>
Enables or disables generic host-based force-
migration, which bypasses driver optimizations.
Default=False.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_pool-list">
<title>manila pool-list</title>
<screen><computeroutput>usage: manila pool-list [--host &lt;host&gt;] [--backend &lt;backend&gt;] [--pool &lt;pool&gt;]</computeroutput></screen>
<para>
List all backend storage pools known to the scheduler (Admin only).
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--host &lt;host&gt;</command></term>
<listitem>
<para>
Filter results by host name. Regular expressions are
supported.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--backend &lt;backend&gt;</command></term>
<listitem>
<para>
Filter results by backend name. Regular expressions are
supported.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--pool &lt;pool&gt;</command></term>
<listitem>
<para>
Filter results by pool name. Regular expressions are
supported.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_quota-class-show">
<title>manila quota-class-show</title>
<screen><computeroutput>usage: manila quota-class-show &lt;class&gt;</computeroutput></screen>
<para>
List the quotas for a quota class.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;class&gt;</command></term>
<listitem>
<para>
Name of quota class to list the quotas for.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_quota-class-update">
<title>manila quota-class-update</title>
<screen><computeroutput>usage: manila quota-class-update [--shares &lt;shares&gt;] [--snapshots &lt;snapshots&gt;]
[--gigabytes &lt;gigabytes&gt;]
[--snapshot-gigabytes &lt;snapshot_gigabytes&gt;]
[--share-networks &lt;share-networks&gt;]
&lt;class-name&gt;</computeroutput></screen>
<para>
Update the quotas for a quota class.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;class-name&gt;</command></term>
<listitem>
<para>
Name of quota class to set the quotas for.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--shares &lt;shares&gt;</command></term>
<listitem>
<para>
New value for the "shares" quota.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--snapshots &lt;snapshots&gt;</command></term>
<listitem>
<para>
New value for the "snapshots" quota.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--gigabytes &lt;gigabytes&gt;</command></term>
<listitem>
<para>
New value for the "gigabytes" quota.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--snapshot-gigabytes &lt;snapshot_gigabytes&gt;, --snapshot_gigabytes &lt;snapshot_gigabytes&gt;</command></term>
<listitem>
<para>
New value for the "snapshot_gigabytes" quota.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--share-networks &lt;share-networks&gt;, --share_networks &lt;share-networks&gt;</command></term>
<listitem>
<para>
New value for the "share_networks" quota.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_quota-defaults">
<title>manila quota-defaults</title>
<screen><computeroutput>usage: manila quota-defaults [--tenant &lt;tenant-id&gt;]</computeroutput></screen>
<para>
List the default quotas for a tenant.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--tenant &lt;tenant-id&gt;</command></term>
<listitem>
<para>
ID of tenant to list the default quotas for.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_quota-delete">
<title>manila quota-delete</title>
<screen><computeroutput>usage: manila quota-delete [--tenant &lt;tenant-id&gt;] [--user &lt;user-id&gt;]</computeroutput></screen>
<para>
Delete quota for a tenant/user. The quota will revert back to default.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--tenant &lt;tenant-id&gt;</command></term>
<listitem>
<para>
ID of tenant to delete quota for.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--user &lt;user-id&gt;</command></term>
<listitem>
<para>
ID of user to delete quota for.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_quota-show">
<title>manila quota-show</title>
<screen><computeroutput>usage: manila quota-show [--tenant &lt;tenant-id&gt;] [--user &lt;user-id&gt;]</computeroutput></screen>
<para>
List the quotas for a tenant/user.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--tenant &lt;tenant-id&gt;</command></term>
<listitem>
<para>
ID of tenant to list the quotas for.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--user &lt;user-id&gt;</command></term>
<listitem>
<para>
ID of user to list the quotas for.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_quota-update">
<title>manila quota-update</title>
<screen><computeroutput>usage: manila quota-update [--user &lt;user-id&gt;] [--shares &lt;shares&gt;]
[--snapshots &lt;snapshots&gt;] [--gigabytes &lt;gigabytes&gt;]
[--snapshot-gigabytes &lt;snapshot_gigabytes&gt;]
[--share-networks &lt;share-networks&gt;] [--force]
&lt;tenant_id&gt;</computeroutput></screen>
<para>
Update the quotas for a tenant/user.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;tenant_id&gt;</command></term>
<listitem>
<para>
UUID of tenant to set the quotas for.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--user &lt;user-id&gt;</command></term>
<listitem>
<para>
ID of user to set the quotas for.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--shares &lt;shares&gt;</command></term>
<listitem>
<para>
New value for the "shares" quota.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--snapshots &lt;snapshots&gt;</command></term>
<listitem>
<para>
New value for the "snapshots" quota.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--gigabytes &lt;gigabytes&gt;</command></term>
<listitem>
<para>
New value for the "gigabytes" quota.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--snapshot-gigabytes &lt;snapshot_gigabytes&gt;, --snapshot_gigabytes &lt;snapshot_gigabytes&gt;</command></term>
<listitem>
<para>
New value for the "snapshot_gigabytes" quota.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--share-networks &lt;share-networks&gt;</command></term>
<listitem>
<para>
New value for the "share_networks" quota.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--force</command></term>
<listitem>
<para>
Whether force update the quota even if the already
used and reserved exceeds the new quota.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_rate-limits">
<title>manila rate-limits</title>
<screen><computeroutput>usage: manila rate-limits</computeroutput></screen>
<para>
Print a list of rate limits for a user.
</para>
</section>
<section xml:id="manilaclient_subcommand_reset-state">
<title>manila reset-state</title>
<screen><computeroutput>usage: manila reset-state [--state &lt;state&gt;] &lt;share&gt;</computeroutput></screen>
<para>
Explicitly update the state of a share.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;share&gt;</command></term>
<listitem>
<para>
Name or ID of the share to modify.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--state &lt;state&gt;</command></term>
<listitem>
<para>
Indicate which state to assign the share. Options include
available, error, creating, deleting, error_deleting. If no
state is provided, available will be used.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_security-service-create">
<title>manila security-service-create</title>
<screen><computeroutput>usage: manila security-service-create [--dns-ip &lt;dns_ip&gt;] [--server &lt;server&gt;]
[--domain &lt;domain&gt;] [--user &lt;user&gt;]
[--password &lt;password&gt;] [--name &lt;name&gt;]
[--description &lt;description&gt;]
&lt;type&gt;</computeroutput></screen>
<para>
Create security service used by tenant.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;type&gt;</command></term>
<listitem>
<para>
Security service type: 'ldap', 'kerberos' or
'active_directory'.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--dns-ip &lt;dns_ip&gt;</command></term>
<listitem>
<para>
DNS IP address used inside tenant's network.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--server &lt;server&gt;</command></term>
<listitem>
<para>
Security service IP address or hostname.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--domain &lt;domain&gt;</command></term>
<listitem>
<para>
Security service domain.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--user &lt;user&gt;</command></term>
<listitem>
<para>
Security service user or group used by tenant.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--password &lt;password&gt;</command></term>
<listitem>
<para>
Password used by user.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--name &lt;name&gt;</command></term>
<listitem>
<para>
Security service name.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--description &lt;description&gt;</command></term>
<listitem>
<para>
Security service description.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_security-service-delete">
<title>manila security-service-delete</title>
<screen><computeroutput>usage: manila security-service-delete &lt;security-service&gt;</computeroutput></screen>
<para>
Delete security service.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;security-service&gt;</command></term>
<listitem>
<para>
Security service name or ID to delete.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_security-service-list">
<title>manila security-service-list</title>
<screen><computeroutput>usage: manila security-service-list [--all-tenants [&lt;0|1&gt;]]
[--share-network &lt;share_network&gt;]
[--status &lt;status&gt;] [--name &lt;name&gt;]
[--type &lt;type&gt;] [--user &lt;user&gt;]
[--dns-ip &lt;dns_ip&gt;] [--server &lt;server&gt;]
[--domain &lt;domain&gt;] [--detailed [&lt;0|1&gt;]]
[--offset &lt;offset&gt;] [--limit &lt;limit&gt;]</computeroutput></screen>
<para>
Get a list of security services.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--all-tenants [&lt;0|1&gt;]</command></term>
<listitem>
<para>
Display information from all tenants (Admin only).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--share-network &lt;share_network&gt;, --share_network &lt;share_network&gt;</command></term>
<listitem>
<para>
Filter results by share network id or name.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--status &lt;status&gt;</command></term>
<listitem>
<para>
Filter results by status.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--name &lt;name&gt;</command></term>
<listitem>
<para>
Filter results by name.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--type &lt;type&gt;</command></term>
<listitem>
<para>
Filter results by type.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--user &lt;user&gt;</command></term>
<listitem>
<para>
Filter results by user or group used by tenant.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--dns-ip &lt;dns_ip&gt;, --dns_ip &lt;dns_ip&gt;</command></term>
<listitem>
<para>
Filter results by DNS IP address used inside tenant's
network.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--server &lt;server&gt;</command></term>
<listitem>
<para>
Filter results by security service IP address or
hostname.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--domain &lt;domain&gt;</command></term>
<listitem>
<para>
Filter results by domain.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--detailed [&lt;0|1&gt;]</command></term>
<listitem>
<para>
Show detailed information about filtered security
services.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--offset &lt;offset&gt;</command></term>
<listitem>
<para>
Start position of security services listing.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--limit &lt;limit&gt;</command></term>
<listitem>
<para>
Number of security services to return per request.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_security-service-show">
<title>manila security-service-show</title>
<screen><computeroutput>usage: manila security-service-show &lt;security-service&gt;</computeroutput></screen>
<para>
Show security service.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;security-service&gt;</command></term>
<listitem>
<para>
Security service name or ID to show.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_security-service-update">
<title>manila security-service-update</title>
<screen><computeroutput>usage: manila security-service-update [--dns-ip &lt;dns-ip&gt;] [--server &lt;server&gt;]
[--domain &lt;domain&gt;] [--user &lt;user&gt;]
[--password &lt;password&gt;] [--name &lt;name&gt;]
[--description &lt;description&gt;]
&lt;security-service&gt;</computeroutput></screen>
<para>
Update security service.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;security-service&gt;</command></term>
<listitem>
<para>
Security service name or ID to update.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--dns-ip &lt;dns-ip&gt;</command></term>
<listitem>
<para>
DNS IP address used inside tenant's network.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--server &lt;server&gt;</command></term>
<listitem>
<para>
Security service IP address or hostname.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--domain &lt;domain&gt;</command></term>
<listitem>
<para>
Security service domain.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--user &lt;user&gt;</command></term>
<listitem>
<para>
Security service user or group used by tenant.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--password &lt;password&gt;</command></term>
<listitem>
<para>
Password used by user.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--name &lt;name&gt;</command></term>
<listitem>
<para>
Security service name.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--description &lt;description&gt;</command></term>
<listitem>
<para>
Security service description.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_service-list">
<title>manila service-list</title>
<screen><computeroutput>usage: manila service-list [--host &lt;hostname&gt;] [--binary &lt;binary&gt;]
[--status &lt;status&gt;] [--state &lt;state&gt;]
[--zone &lt;zone&gt;]</computeroutput></screen>
<para>
List all services.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--host &lt;hostname&gt;</command></term>
<listitem>
<para>
Name of host.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--binary &lt;binary&gt;</command></term>
<listitem>
<para>
Service binary.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--status &lt;status&gt;</command></term>
<listitem>
<para>
Filter results by status.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--state &lt;state&gt;</command></term>
<listitem>
<para>
Filter results by state.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--zone &lt;zone&gt;</command></term>
<listitem>
<para>
Availability zone.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_share-instance-force-delete">
<title>manila share-instance-force-delete</title>
<screen><computeroutput>usage: manila share-instance-force-delete &lt;instance&gt; [&lt;instance&gt; ...]</computeroutput></screen>
<para>
Attempt force-delete of share instance, regardless of state.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;instance&gt;</command></term>
<listitem>
<para>
Name or ID of the instance(s) to force delete.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_share-instance-list">
<title>manila share-instance-list</title>
<screen><computeroutput>usage: manila share-instance-list [--share-id &lt;share_id&gt;]</computeroutput></screen>
<para>
List share instances.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--share-id &lt;share_id&gt;, --share_id &lt;share_id&gt;</command></term>
<listitem>
<para>
Filter results by share ID.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_share-instance-reset-state">
<title>manila share-instance-reset-state</title>
<screen><computeroutput>usage: manila share-instance-reset-state [--state &lt;state&gt;] &lt;instance&gt;</computeroutput></screen>
<para>
Explicitly update the state of a share instance.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;instance&gt;</command></term>
<listitem>
<para>
Name or ID of the share instance to modify.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--state &lt;state&gt;</command></term>
<listitem>
<para>
Indicate which state to assign the instance. Options
include available, error, creating, deleting,
error_deleting. If no state is provided, available will be
used.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_share-instance-show">
<title>manila share-instance-show</title>
<screen><computeroutput>usage: manila share-instance-show &lt;instance&gt;</computeroutput></screen>
<para>
Show details about a share instance.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;instance&gt;</command></term>
<listitem>
<para>
Name or ID of the share instance.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_share-network-create">
<title>manila share-network-create</title>
<screen><computeroutput>usage: manila share-network-create [--nova-net-id &lt;nova-net-id&gt;]
[--neutron-net-id &lt;neutron-net-id&gt;]
[--neutron-subnet-id &lt;neutron-subnet-id&gt;]
[--name &lt;name&gt;]
[--description &lt;description&gt;]</computeroutput></screen>
<para>
Create description for network used by the tenant.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--nova-net-id &lt;nova-net-id&gt;, --nova-net_id &lt;nova-net-id&gt;, --nova_net_id &lt;nova-net-id&gt;, --nova_net-id &lt;nova-net-id&gt;</command></term>
<listitem>
<para>
Nova net ID. Used to set up network for share servers.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--neutron-net-id &lt;neutron-net-id&gt;, --neutron-net_id &lt;neutron-net-id&gt;, --neutron_net_id &lt;neutron-net-id&gt;, --neutron_net-id &lt;neutron-net-id&gt;</command></term>
<listitem>
<para>
Neutron network ID. Used to set up network for share
servers.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--neutron-subnet-id &lt;neutron-subnet-id&gt;, --neutron-subnet_id &lt;neutron-subnet-id&gt;, --neutron_subnet_id &lt;neutron-subnet-id&gt;, --neutron_subnet-id &lt;neutron-subnet-id&gt;</command></term>
<listitem>
<para>
Neutron subnet ID. Used to set up network for share
servers. This subnet should belong to specified
neutron network.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--name &lt;name&gt;</command></term>
<listitem>
<para>
Share network name.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--description &lt;description&gt;</command></term>
<listitem>
<para>
Share network description.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_share-network-delete">
<title>manila share-network-delete</title>
<screen><computeroutput>usage: manila share-network-delete &lt;share-network&gt;</computeroutput></screen>
<para>
Delete share network.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;share-network&gt;</command></term>
<listitem>
<para>
Name or ID of share network to be deleted.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_share-network-list">
<title>manila share-network-list</title>
<screen><computeroutput>usage: manila share-network-list [--all-tenants [&lt;0|1&gt;]]
[--project-id &lt;project_id&gt;] [--name &lt;name&gt;]
[--created-since &lt;created_since&gt;]
[--created-before &lt;created_before&gt;]
[--security-service &lt;security_service&gt;]
[--nova-net-id &lt;nova_net_id&gt;]
[--neutron-net-id &lt;neutron_net_id&gt;]
[--neutron-subnet-id &lt;neutron_subnet_id&gt;]
[--network-type &lt;network_type&gt;]
[--segmentation-id &lt;segmentation_id&gt;]
[--cidr &lt;cidr&gt;] [--ip-version &lt;ip_version&gt;]
[--offset &lt;offset&gt;] [--limit &lt;limit&gt;]</computeroutput></screen>
<para>
Get a list of network info.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--all-tenants [&lt;0|1&gt;]</command></term>
<listitem>
<para>
Display information from all tenants (Admin only).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--project-id &lt;project_id&gt;, --project_id &lt;project_id&gt;</command></term>
<listitem>
<para>
Filter results by project ID.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--name &lt;name&gt;</command></term>
<listitem>
<para>
Filter results by name.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--created-since &lt;created_since&gt;, --created_since &lt;created_since&gt;</command></term>
<listitem>
<para>
Return only share networks created since given date.
The date is in the format 'yyyy-mm-dd'.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--created-before &lt;created_before&gt;, --created_before &lt;created_before&gt;</command></term>
<listitem>
<para>
Return only share networks created until given date.
The date is in the format 'yyyy-mm-dd'.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--security-service &lt;security_service&gt;, --security_service &lt;security_service&gt;</command></term>
<listitem>
<para>
Filter results by attached security service.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--nova-net-id &lt;nova_net_id&gt;, --nova_net_id &lt;nova_net_id&gt;, --nova_net-id &lt;nova_net_id&gt;, --nova-net_id &lt;nova_net_id&gt;</command></term>
<listitem>
<para>
Filter results by Nova net ID.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--neutron-net-id &lt;neutron_net_id&gt;, --neutron_net_id &lt;neutron_net_id&gt;, --neutron_net-id &lt;neutron_net_id&gt;, --neutron-net_id &lt;neutron_net_id&gt;</command></term>
<listitem>
<para>
Filter results by neutron net ID.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--neutron-subnet-id &lt;neutron_subnet_id&gt;, --neutron_subnet_id &lt;neutron_subnet_id&gt;, --neutron-subnet_id &lt;neutron_subnet_id&gt;, --neutron_subnet-id &lt;neutron_subnet_id&gt;</command></term>
<listitem>
<para>
Filter results by neutron subnet ID.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--network-type &lt;network_type&gt;, --network_type &lt;network_type&gt;</command></term>
<listitem>
<para>
Filter results by network type.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--segmentation-id &lt;segmentation_id&gt;, --segmentation_id &lt;segmentation_id&gt;</command></term>
<listitem>
<para>
Filter results by segmentation ID.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--cidr &lt;cidr&gt;</command></term>
<listitem>
<para>
Filter results by CIDR.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--ip-version &lt;ip_version&gt;, --ip_version &lt;ip_version&gt;</command></term>
<listitem>
<para>
Filter results by IP version.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--offset &lt;offset&gt;</command></term>
<listitem>
<para>
Start position of share networks listing.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--limit &lt;limit&gt;</command></term>
<listitem>
<para>
Number of share networks to return per request.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_share-network-security-service-add">
<title>manila share-network-security-service-add</title>
<screen><computeroutput>usage: manila share-network-security-service-add &lt;share-network&gt;
&lt;security-service&gt;</computeroutput></screen>
<para>
Associate security service with share network.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;share-network&gt;</command></term>
<listitem>
<para>
Share network name or ID.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;security-service&gt;</command></term>
<listitem>
<para>
Security service name or ID to associate with.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_share-network-security-service-list">
<title>manila share-network-security-service-list</title>
<screen><computeroutput>usage: manila share-network-security-service-list &lt;share-network&gt;</computeroutput></screen>
<para>
Get list of security services associated with a given share network.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;share-network&gt;</command></term>
<listitem>
<para>
Share network name or ID.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_share-network-security-service-remove">
<title>manila share-network-security-service-remove</title>
<screen><computeroutput>usage: manila share-network-security-service-remove &lt;share-network&gt;
&lt;security-service&gt;</computeroutput></screen>
<para>
Dissociate security service from share network.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;share-network&gt;</command></term>
<listitem>
<para>
Share network name or ID.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;security-service&gt;</command></term>
<listitem>
<para>
Security service name or ID to dissociate.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_share-network-show">
<title>manila share-network-show</title>
<screen><computeroutput>usage: manila share-network-show &lt;share-network&gt;</computeroutput></screen>
<para>
Get a description for network used by the tenant.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;share-network&gt;</command></term>
<listitem>
<para>
Name or ID of the share network to show.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_share-network-update">
<title>manila share-network-update</title>
<screen><computeroutput>usage: manila share-network-update [--nova-net-id &lt;nova-net-id&gt;]
[--neutron-net-id &lt;neutron-net-id&gt;]
[--neutron-subnet-id &lt;neutron-subnet-id&gt;]
[--name &lt;name&gt;]
[--description &lt;description&gt;]
&lt;share-network&gt;</computeroutput></screen>
<para>
Update share network data.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;share-network&gt;</command></term>
<listitem>
<para>
Name or ID of share network to update.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--nova-net-id &lt;nova-net-id&gt;, --nova-net_id &lt;nova-net-id&gt;, --nova_net_id &lt;nova-net-id&gt;, --nova_net-id &lt;nova-net-id&gt;</command></term>
<listitem>
<para>
Nova net ID. Used to set up network for share servers.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--neutron-net-id &lt;neutron-net-id&gt;, --neutron-net_id &lt;neutron-net-id&gt;, --neutron_net_id &lt;neutron-net-id&gt;, --neutron_net-id &lt;neutron-net-id&gt;</command></term>
<listitem>
<para>
Neutron network ID. Used to set up network for share
servers.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--neutron-subnet-id &lt;neutron-subnet-id&gt;, --neutron-subnet_id &lt;neutron-subnet-id&gt;, --neutron_subnet_id &lt;neutron-subnet-id&gt;, --neutron_subnet-id &lt;neutron-subnet-id&gt;</command></term>
<listitem>
<para>
Neutron subnet ID. Used to set up network for share
servers. This subnet should belong to specified
neutron network.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--name &lt;name&gt;</command></term>
<listitem>
<para>
Share network name.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--description &lt;description&gt;</command></term>
<listitem>
<para>
Share network description.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_share-server-delete">
<title>manila share-server-delete</title>
<screen><computeroutput>usage: manila share-server-delete &lt;id&gt;</computeroutput></screen>
<para>
Delete share server.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;id&gt;</command></term>
<listitem>
<para>
ID of share server.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_share-server-details">
<title>manila share-server-details</title>
<screen><computeroutput>usage: manila share-server-details &lt;id&gt;</computeroutput></screen>
<para>
Show share server details.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;id&gt;</command></term>
<listitem>
<para>
ID of share server.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_share-server-list">
<title>manila share-server-list</title>
<screen><computeroutput>usage: manila share-server-list [--host &lt;hostname&gt;] [--status &lt;status&gt;]
[--share-network &lt;share_network&gt;]
[--project-id &lt;project_id&gt;]</computeroutput></screen>
<para>
List all share servers.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--host &lt;hostname&gt;</command></term>
<listitem>
<para>
Filter results by name of host.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--status &lt;status&gt;</command></term>
<listitem>
<para>
Filter results by status.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--share-network &lt;share_network&gt;</command></term>
<listitem>
<para>
Filter results by share network.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--project-id &lt;project_id&gt;</command></term>
<listitem>
<para>
Filter results by project ID.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_share-server-show">
<title>manila share-server-show</title>
<screen><computeroutput>usage: manila share-server-show &lt;id&gt;</computeroutput></screen>
<para>
Show share server info.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;id&gt;</command></term>
<listitem>
<para>
ID of share server.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_show">
<title>manila show</title>
<screen><computeroutput>usage: manila show &lt;share&gt;</computeroutput></screen>
<para>
Show details about a NAS share.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;share&gt;</command></term>
<listitem>
<para>
Name or ID of the NAS share.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_shrink">
<title>manila shrink</title>
<screen><computeroutput>usage: manila shrink &lt;share&gt; &lt;new_size&gt;</computeroutput></screen>
<para>
Decreases the size of an existing share.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;share&gt;</command></term>
<listitem>
<para>
Name or ID of share to shrink.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;new_size&gt;</command></term>
<listitem>
<para>
New size of share, in GBs.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_snapshot-create">
<title>manila snapshot-create</title>
<screen><computeroutput>usage: manila snapshot-create [--force &lt;True|False&gt;] [--name &lt;name&gt;]
[--description &lt;description&gt;]
&lt;share&gt;</computeroutput></screen>
<para>
Add a new snapshot.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;share&gt;</command></term>
<listitem>
<para>
Name or ID of the share to snapshot.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--force &lt;True|False&gt;</command></term>
<listitem>
<para>
Optional flag to indicate whether to snapshot a share
even if it's busy. (Default=False)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--name &lt;name&gt;</command></term>
<listitem>
<para>
Optional snapshot name. (Default=None)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--description &lt;description&gt;</command></term>
<listitem>
<para>
Optional snapshot description. (Default=None)
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_snapshot-delete">
<title>manila snapshot-delete</title>
<screen><computeroutput>usage: manila snapshot-delete &lt;snapshot&gt;</computeroutput></screen>
<para>
Remove a snapshot.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;snapshot&gt;</command></term>
<listitem>
<para>
Name or ID of the snapshot to delete.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_snapshot-force-delete">
<title>manila snapshot-force-delete</title>
<screen><computeroutput>usage: manila snapshot-force-delete &lt;snapshot&gt;</computeroutput></screen>
<para>
Attempt force-delete of snapshot, regardless of state.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;snapshot&gt;</command></term>
<listitem>
<para>
Name or ID of the snapshot to force delete.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_snapshot-list">
<title>manila snapshot-list</title>
<screen><computeroutput>usage: manila snapshot-list [--all-tenants [&lt;0|1&gt;]] [--name &lt;name&gt;]
[--status &lt;status&gt;] [--share-id &lt;share_id&gt;]
[--usage [any|used|unused]] [--limit &lt;limit&gt;]
[--offset &lt;offset&gt;] [--sort-key &lt;sort_key&gt;]
[--sort-dir &lt;sort_dir&gt;]</computeroutput></screen>
<para>
List all the snapshots.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--all-tenants [&lt;0|1&gt;]</command></term>
<listitem>
<para>
Display information from all tenants (Admin only).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--name &lt;name&gt;</command></term>
<listitem>
<para>
Filter results by name.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--status &lt;status&gt;</command></term>
<listitem>
<para>
Filter results by status.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--share-id &lt;share_id&gt;, --share_id &lt;share_id&gt;</command></term>
<listitem>
<para>
Filter results by source share ID.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--usage [any|used|unused]</command></term>
<listitem>
<para>
Either filter or not snapshots by its usage. OPTIONAL:
Default=any.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--limit &lt;limit&gt;</command></term>
<listitem>
<para>
Maximum number of share snapshots to return. OPTIONAL:
Default=None.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--offset &lt;offset&gt;</command></term>
<listitem>
<para>
Set offset to define start point of share snapshots
listing. OPTIONAL: Default=None.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--sort-key &lt;sort_key&gt;, --sort_key &lt;sort_key&gt;</command></term>
<listitem>
<para>
Key to be sorted, available keys are ('id', 'status',
'size', 'share_id', 'user_id', 'project_id',
'progress', 'name', 'display_name'). Default=None.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--sort-dir &lt;sort_dir&gt;, --sort_dir &lt;sort_dir&gt;</command></term>
<listitem>
<para>
Sort direction, available values are ('asc', 'desc').
OPTIONAL: Default=None.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_snapshot-rename">
<title>manila snapshot-rename</title>
<screen><computeroutput>usage: manila snapshot-rename [--description &lt;description&gt;]
&lt;snapshot&gt; [&lt;name&gt;]</computeroutput></screen>
<para>
Rename a snapshot.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;snapshot&gt;</command></term>
<listitem>
<para>
Name or ID of the snapshot to rename.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;name&gt;</command></term>
<listitem>
<para>
New name for the snapshot.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--description &lt;description&gt;</command></term>
<listitem>
<para>
Optional snapshot description. (Default=None)
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_snapshot-reset-state">
<title>manila snapshot-reset-state</title>
<screen><computeroutput>usage: manila snapshot-reset-state [--state &lt;state&gt;] &lt;snapshot&gt;</computeroutput></screen>
<para>
Explicitly update the state of a snapshot.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;snapshot&gt;</command></term>
<listitem>
<para>
Name or ID of the snapshot to modify.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--state &lt;state&gt;</command></term>
<listitem>
<para>
Indicate which state to assign the snapshot. Options
include available, error, creating, deleting,
error_deleting. If no state is provided, available will be
used.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_snapshot-show">
<title>manila snapshot-show</title>
<screen><computeroutput>usage: manila snapshot-show &lt;snapshot&gt;</computeroutput></screen>
<para>
Show details about a snapshot.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;snapshot&gt;</command></term>
<listitem>
<para>
Name or ID of the snapshot.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_type-access-add">
<title>manila type-access-add</title>
<screen><computeroutput>usage: manila type-access-add &lt;share_type&gt; &lt;project_id&gt;</computeroutput></screen>
<para>
Adds share type access for the given project.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;share_type&gt;</command></term>
<listitem>
<para>
Share type name or ID to add access for the given project.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;project_id&gt;</command></term>
<listitem>
<para>
Project ID to add share type access for.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_type-access-list">
<title>manila type-access-list</title>
<screen><computeroutput>usage: manila type-access-list &lt;share_type&gt;</computeroutput></screen>
<para>
Print access information about the given share type.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;share_type&gt;</command></term>
<listitem>
<para>
Filter results by share type name or ID.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_type-access-remove">
<title>manila type-access-remove</title>
<screen><computeroutput>usage: manila type-access-remove &lt;share_type&gt; &lt;project_id&gt;</computeroutput></screen>
<para>
Removes share type access for the given project.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;share_type&gt;</command></term>
<listitem>
<para>
Share type name or ID to remove access for the given project.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;project_id&gt;</command></term>
<listitem>
<para>
Project ID to remove share type access for.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_type-create">
<title>manila type-create</title>
<screen><computeroutput>usage: manila type-create [--snapshot_support &lt;snapshot_support&gt;]
[--is_public &lt;is_public&gt;]
&lt;name&gt; &lt;spec_driver_handles_share_servers&gt;</computeroutput></screen>
<para>
Create a new share type.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;name&gt;</command></term>
<listitem>
<para>
Name of the new share type.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;spec_driver_handles_share_servers&gt;</command></term>
<listitem>
<para>
Required extra specification. Valid values are
'true'/'1' and 'false'/'0'
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--snapshot_support &lt;snapshot_support&gt;, --snapshot-support &lt;snapshot_support&gt;</command></term>
<listitem>
<para>
Boolean extra spec that used for filtering of back
ends by their capability to create share snapshots.
(Default is True).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--is_public &lt;is_public&gt;, --is-public &lt;is_public&gt;</command></term>
<listitem>
<para>
Make type accessible to the public (default true).
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_type-delete">
<title>manila type-delete</title>
<screen><computeroutput>usage: manila type-delete &lt;id&gt;</computeroutput></screen>
<para>
Delete a specific share type.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;id&gt;</command></term>
<listitem>
<para>
Name or ID of the share type to delete.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_type-key">
<title>manila type-key</title>
<screen><computeroutput>usage: manila type-key &lt;stype&gt; &lt;action&gt; [&lt;key=value&gt; [&lt;key=value&gt; ...]]</computeroutput></screen>
<para>
Set or unset extra_spec for a share type.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;stype&gt;</command></term>
<listitem>
<para>
Name or ID of the share type.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;action&gt;</command></term>
<listitem>
<para>
Actions: 'set' or 'unset'.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;key=value&gt;</command></term>
<listitem>
<para>
Extra_specs to set or unset (key is only necessary on unset).
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_type-list">
<title>manila type-list</title>
<screen><computeroutput>usage: manila type-list [--all]</computeroutput></screen>
<para>
Print a list of available 'share types'.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--all</command></term>
<listitem>
<para>
Display all share types (Admin only).
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_unmanage">
<title>manila unmanage</title>
<screen><computeroutput>usage: manila unmanage &lt;share&gt;</computeroutput></screen>
<para>
Unmanage share.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;share&gt;</command></term>
<listitem>
<para>
Name or ID of the share(s).
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="manilaclient_subcommand_update">
<title>manila update</title>
<screen><computeroutput>usage: manila update [--name &lt;name&gt;] [--description &lt;description&gt;]
[--is-public &lt;is_public&gt;]
&lt;share&gt;</computeroutput></screen>
<para>
Rename a share.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;share&gt;</command></term>
<listitem>
<para>
Name or ID of the share to rename.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--name &lt;name&gt;</command></term>
<listitem>
<para>
New name for the share.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--description &lt;description&gt;</command></term>
<listitem>
<para>
Optional share description. (Default=None)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--is-public &lt;is_public&gt;, --is_public &lt;is_public&gt;</command></term>
<listitem>
<para>
Public share is visible for all tenants.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
</chapter>