openstack/openstack-manuals
Code Issues Proposed changes
f979536d5b
openstack-manuals/doc/common/ch_cli_cinder_commands.xml
Andreas Jaeger 33a92f1b1b Update cli commands with updated auto-command 
Regenerated with proposed fix for openstack-doc-tools.

This changes the </computeroutput></screen> to be
on the last line of each change.

Also, the swift commands now do not use screen anymore.

Change-Id: I87f3c0acedc50798d1829966d62a393f49fad534
2014-05-01 08:56:51 +02:00

2345 lines
69 KiB
XML
Raw Blame History

<?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="cinderclient_commands">
<!-- This file is automatically generated, do not edit -->
<?dbhtml stop-chunking?>
<title>Block Storage command-line client</title>
<para>The <command>cinder</command> client is the command-line interface
(CLI) for the OpenStack Block Storage API and its extensions. This chapter documents
<command>cinder</command> version 1.0.8.
</para>
<para>For help on a specific <command>cinder</command>
command, enter:
</para>
<screen><prompt>$</prompt> <userinput><command>cinder</command> <option>help</option> <replaceable>COMMAND</replaceable></userinput></screen>
<section xml:id="cinderclient_command_usage">
<title>cinder usage</title>
<screen><computeroutput>usage: cinder [--version] [--debug] [--os-username &lt;auth-user-name&gt;]
[--os-password &lt;auth-password&gt;]
[--os-tenant-name &lt;auth-tenant-name&gt;]
[--os-tenant-id &lt;auth-tenant-id&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;]
[--volume-service-name &lt;volume-service-name&gt;]
[--endpoint-type &lt;endpoint-type&gt;]
[--os-volume-api-version &lt;volume-api-ver&gt;]
[--os-cacert &lt;ca-certificate&gt;] [--retries &lt;retries&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>availability-zone-list</command></term>
<listitem>
<para>
List all the availability zones.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>backup-create</command></term>
<listitem>
<para>
Creates a backup.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>backup-delete</command></term>
<listitem>
<para>
Remove a backup.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>backup-list</command></term>
<listitem>
<para>
List all the backups.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>backup-restore</command></term>
<listitem>
<para>
Restore a backup.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>backup-show</command></term>
<listitem>
<para>
Show details about a backup.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>create</command></term>
<listitem>
<para>
Add a new volume.
</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 volume(s).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>encryption-type-create</command></term>
<listitem>
<para>
Create a new encryption type for a volume type (Admin
Only).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>encryption-type-delete</command></term>
<listitem>
<para>
Delete the encryption type for a volume type (Admin
Only).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>encryption-type-list</command></term>
<listitem>
<para>
List encryption type information for all volume types
(Admin Only).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>encryption-type-show</command></term>
<listitem>
<para>
Show the encryption type information for a volume type
(Admin Only).
</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>
Attempt to extend the size of an existing volume.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>extra-specs-list</command></term>
<listitem>
<para>
Print a list of current 'volume types and extra specs'
(Admin Only).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>force-delete</command></term>
<listitem>
<para>
Attempt forced removal of volume(s), regardless of the
state(s).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>list</command></term>
<listitem>
<para>
List all the volumes.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>metadata</command></term>
<listitem>
<para>
Set or Delete metadata on a volume.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>metadata-show</command></term>
<listitem>
<para>
Show metadata of given volume.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>metadata-update-all</command></term>
<listitem>
<para>
Update all metadata of a volume.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>migrate</command></term>
<listitem>
<para>
Migrate the volume to the new host.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>qos-associate</command></term>
<listitem>
<para>
Associate qos specs with specific volume type.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>qos-create</command></term>
<listitem>
<para>
Create a new qos specs.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>qos-delete</command></term>
<listitem>
<para>
Delete a specific qos specs.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>qos-disassociate</command></term>
<listitem>
<para>
Disassociate qos specs from specific volume type.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>qos-disassociate-all</command></term>
<listitem>
<para>
Disassociate qos specs from all of its associations.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>qos-get-association</command></term>
<listitem>
<para>
Get all associations of specific qos specs.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>qos-key</command></term>
<listitem>
<para>
Set or unset specifications for a qos spec.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>qos-list</command></term>
<listitem>
<para>
Get full list of qos specs.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>qos-show</command></term>
<listitem>
<para>
Get a specific qos specs.
</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-show</command></term>
<listitem>
<para>
List the quotas for a tenant.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>quota-update</command></term>
<listitem>
<para>
Update the quotas for a tenant.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>quota-usage</command></term>
<listitem>
<para>
List the quota usage for a tenant.
</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>readonly-mode-update</command></term>
<listitem>
<para>
Update volume read-only access mode read_only.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>rename</command></term>
<listitem>
<para>
Rename a volume.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>reset-state</command></term>
<listitem>
<para>
Explicitly update the state of a volume.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>service-disable</command></term>
<listitem>
<para>
Disable the service.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>service-enable</command></term>
<listitem>
<para>
Enable the service.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>service-list</command></term>
<listitem>
<para>
List all the services. Filter by host &amp; service
binary.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>show</command></term>
<listitem>
<para>
Show details about a volume.
</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-list</command></term>
<listitem>
<para>
List all the snapshots.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>snapshot-metadata</command></term>
<listitem>
<para>
Set or Delete metadata of a snapshot.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>snapshot-metadata-show</command></term>
<listitem>
<para>
Show metadata of given snapshot.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>snapshot-metadata-update-all</command></term>
<listitem>
<para>
Update all metadata of a snapshot.
</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>transfer-accept</command></term>
<listitem>
<para>
Accepts a volume transfer.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>transfer-create</command></term>
<listitem>
<para>
Creates a volume transfer.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>transfer-delete</command></term>
<listitem>
<para>
Undo a transfer.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>transfer-list</command></term>
<listitem>
<para>
List all the transfers.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>transfer-show</command></term>
<listitem>
<para>
Show details about a transfer.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>type-create</command></term>
<listitem>
<para>
Create a new volume type.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>type-delete</command></term>
<listitem>
<para>
Delete a specific volume type.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>type-key</command></term>
<listitem>
<para>
Set or unset extra_spec for a volume type.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>type-list</command></term>
<listitem>
<para>
Print a list of available 'volume types'.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>upload-to-image</command></term>
<listitem>
<para>
Upload volume to image service as image.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>bash-completion</command></term>
<listitem>
<para>
Print arguments for bash_completion.
</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="cinderclient_command_optional">
<title>cinder 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>--debug</command></term>
<listitem>
<para>
Print debugging output
</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-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-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 volume for most actions
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--service-name &lt;service-name&gt;</command></term>
<listitem>
<para>
Defaults to <code>env[CINDER_SERVICE_NAME]</code>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--volume-service-name &lt;volume-service-name&gt;</command></term>
<listitem>
<para>
Defaults to <code>env[CINDER_VOLUME_SERVICE_NAME]</code>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--endpoint-type &lt;endpoint-type&gt;</command></term>
<listitem>
<para>
Defaults to <code>env[CINDER_ENDPOINT_TYPE]</code> or publicURL.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-volume-api-version &lt;volume-api-ver&gt;</command></term>
<listitem>
<para>
Accepts 1 or 2,defaults to <code>env[OS_VOLUME_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>
</variablelist>
</section>
<section xml:id="cinderclient_subcommand_absolute-limits">
<title>cinder absolute-limits command</title>
<screen><computeroutput>usage: cinder absolute-limits</computeroutput></screen>
<para>
Print a list of absolute limits for a user
</para>
</section>
<section xml:id="cinderclient_subcommand_availability-zone-list">
<title>cinder availability-zone-list command</title>
<screen><computeroutput>usage: cinder availability-zone-list</computeroutput></screen>
<para>
List all the availability zones.
</para>
</section>
<section xml:id="cinderclient_subcommand_backup-create">
<title>cinder backup-create command</title>
<screen><computeroutput>usage: cinder backup-create [--container &lt;container&gt;]
[--display-name &lt;display-name&gt;]
[--display-description &lt;display-description&gt;]
&lt;volume&gt;</computeroutput></screen>
<para>
Creates a backup.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;volume&gt;</command></term>
<listitem>
<para>
Name or ID of the volume to backup.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--container &lt;container&gt;</command></term>
<listitem>
<para>
Optional Backup container name. (Default=None)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--display-name &lt;display-name&gt;</command></term>
<listitem>
<para>
Optional backup name. (Default=None)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--display-description &lt;display-description&gt;</command></term>
<listitem>
<para>
Optional backup description. (Default=None)
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cinderclient_subcommand_backup-delete">
<title>cinder backup-delete command</title>
<screen><computeroutput>usage: cinder backup-delete &lt;backup&gt;</computeroutput></screen>
<para>
Remove a backup.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;backup&gt;</command></term>
<listitem>
<para>
Name or ID of the backup to delete.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cinderclient_subcommand_backup-list">
<title>cinder backup-list command</title>
<screen><computeroutput>usage: cinder backup-list</computeroutput></screen>
<para>
List all the backups.
</para>
</section>
<section xml:id="cinderclient_subcommand_backup-restore">
<title>cinder backup-restore command</title>
<screen><computeroutput>usage: cinder backup-restore [--volume-id &lt;volume&gt;] &lt;backup&gt;</computeroutput></screen>
<para>
Restore a backup.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;backup&gt;</command></term>
<listitem>
<para>
ID of the backup to restore.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--volume-id &lt;volume&gt;</command></term>
<listitem>
<para>
Optional ID(or name) of the volume to restore to.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cinderclient_subcommand_backup-show">
<title>cinder backup-show command</title>
<screen><computeroutput>usage: cinder backup-show &lt;backup&gt;</computeroutput></screen>
<para>
Show details about a backup.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;backup&gt;</command></term>
<listitem>
<para>
Name or ID of the backup.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cinderclient_subcommand_create">
<title>cinder create command</title>
<screen><computeroutput>usage: cinder create [--snapshot-id &lt;snapshot-id&gt;]
[--source-volid &lt;source-volid&gt;] [--image-id &lt;image-id&gt;]
[--display-name &lt;display-name&gt;]
[--display-description &lt;display-description&gt;]
[--volume-type &lt;volume-type&gt;]
[--availability-zone &lt;availability-zone&gt;]
[--metadata [&lt;key=value&gt; [&lt;key=value&gt; ...]]]
&lt;size&gt;</computeroutput></screen>
<para>
Add a new volume.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;size&gt;</command></term>
<listitem>
<para>
Size of volume 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>
Create volume from snapshot id (Optional,
Default=None)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--source-volid &lt;source-volid&gt;</command></term>
<listitem>
<para>
Create volume from volume id (Optional, Default=None)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--image-id &lt;image-id&gt;</command></term>
<listitem>
<para>
Create volume from image id (Optional, Default=None)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--display-name &lt;display-name&gt;</command></term>
<listitem>
<para>
Volume name (Optional, Default=None)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--display-description &lt;display-description&gt;</command></term>
<listitem>
<para>
Volume description (Optional, Default=None)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--volume-type &lt;volume-type&gt;</command></term>
<listitem>
<para>
Volume type (Optional, Default=None)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--availability-zone &lt;availability-zone&gt;</command></term>
<listitem>
<para>
Availability zone for volume (Optional, 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>
</variablelist>
</section>
<section xml:id="cinderclient_subcommand_credentials">
<title>cinder credentials command</title>
<screen><computeroutput>usage: cinder credentials</computeroutput></screen>
<para>
Show user credentials returned from auth.
</para>
</section>
<section xml:id="cinderclient_subcommand_delete">
<title>cinder delete command</title>
<screen><computeroutput>usage: cinder delete &lt;volume&gt; [&lt;volume&gt; ...]</computeroutput></screen>
<para>
Remove volume(s).
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;volume&gt;</command></term>
<listitem>
<para>
Name or ID of the volume(s) to delete.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cinderclient_subcommand_encryption-type-create">
<title>cinder encryption-type-create command</title>
<screen><computeroutput>usage: cinder encryption-type-create [--cipher &lt;cipher&gt;]
[--key_size &lt;key_size&gt;]
[--control_location &lt;control_location&gt;]
&lt;volume_type&gt; &lt;provider&gt;</computeroutput></screen>
<para>
Create a new encryption type for a volume type (Admin Only).
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;volume_type&gt;</command></term>
<listitem>
<para>
Name or ID of the volume type
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;provider&gt;</command></term>
<listitem>
<para>
Class providing encryption support (e.g.
LuksEncryptor)
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--cipher &lt;cipher&gt;</command></term>
<listitem>
<para>
Encryption algorithm/mode to use (e.g., aes-xts-
plain64) (Optional, Default=None)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--key_size &lt;key_size&gt;</command></term>
<listitem>
<para>
Size of the encryption key, in bits (e.g., 128, 256)
(Optional, Default=None)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--control_location &lt;control_location&gt;</command></term>
<listitem>
<para>
Notional service where encryption is performed (e.g.,
front-end=Nova). Values: 'front-end', 'back-end'
(Optional, Default=None)
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cinderclient_subcommand_encryption-type-delete">
<title>cinder encryption-type-delete command</title>
<screen><computeroutput>usage: cinder encryption-type-delete &lt;volume_type&gt;</computeroutput></screen>
<para>
Delete the encryption type for a volume type (Admin Only).
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;volume_type&gt;</command></term>
<listitem>
<para>
Name or ID of the volume type
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cinderclient_subcommand_encryption-type-list">
<title>cinder encryption-type-list command</title>
<screen><computeroutput>usage: cinder encryption-type-list</computeroutput></screen>
<para>
List encryption type information for all volume types (Admin Only).
</para>
</section>
<section xml:id="cinderclient_subcommand_encryption-type-show">
<title>cinder encryption-type-show command</title>
<screen><computeroutput>usage: cinder encryption-type-show &lt;volume_type&gt;</computeroutput></screen>
<para>
Show the encryption type information for a volume type (Admin Only).
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;volume_type&gt;</command></term>
<listitem>
<para>
Name or ID of the volume type
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cinderclient_subcommand_endpoints">
<title>cinder endpoints command</title>
<screen><computeroutput>usage: cinder endpoints</computeroutput></screen>
<para>
Discover endpoints that get returned from the authenticate services.
</para>
</section>
<section xml:id="cinderclient_subcommand_extend">
<title>cinder extend command</title>
<screen><computeroutput>usage: cinder extend &lt;volume&gt; &lt;new-size&gt;</computeroutput></screen>
<para>
Attempt to extend the size of an existing volume.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;volume&gt;</command></term>
<listitem>
<para>
Name or ID of the volume to extend.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;new-size&gt;</command></term>
<listitem>
<para>
New size of volume in GB
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cinderclient_subcommand_extra-specs-list">
<title>cinder extra-specs-list command</title>
<screen><computeroutput>usage: cinder extra-specs-list</computeroutput></screen>
<para>
Print a list of current 'volume types and extra specs' (Admin Only).
</para>
</section>
<section xml:id="cinderclient_subcommand_force-delete">
<title>cinder force-delete command</title>
<screen><computeroutput>usage: cinder force-delete &lt;volume&gt; [&lt;volume&gt; ...]</computeroutput></screen>
<para>
Attempt forced removal of volume(s), regardless of the state(s).
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;volume&gt;</command></term>
<listitem>
<para>
Name or ID of the volume(s) to delete.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cinderclient_subcommand_list">
<title>cinder list command</title>
<screen><computeroutput>usage: cinder list [--all-tenants [&lt;0|1&gt;]] [--display-name &lt;display-name&gt;]
[--status &lt;status&gt;]
[--metadata [&lt;key=value&gt; [&lt;key=value&gt; ...]]]</computeroutput></screen>
<para>
List all the volumes.
</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>--display-name &lt;display-name&gt;</command></term>
<listitem>
<para>
Filter results by display-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>--metadata [&lt;key=value&gt; [&lt;key=value&gt; ...]]</command></term>
<listitem>
<para>
Filter results by metadata
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cinderclient_subcommand_list-extensions">
<title>cinder list-extensions command</title>
<screen><computeroutput>usage: cinder list-extensions</computeroutput></screen>
<para>
List all the os-api extensions that are available.
</para>
</section>
<section xml:id="cinderclient_subcommand_metadata">
<title>cinder metadata command</title>
<screen><computeroutput>usage: cinder metadata &lt;volume&gt; &lt;action&gt; &lt;key=value&gt; [&lt;key=value&gt; ...]</computeroutput></screen>
<para>
Set or Delete metadata on a volume.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;volume&gt;</command></term>
<listitem>
<para>
Name or ID of the volume 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/unset (only key is necessary on unset)
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cinderclient_subcommand_metadata-show">
<title>cinder metadata-show command</title>
<screen><computeroutput>usage: cinder metadata-show &lt;volume&gt;</computeroutput></screen>
<para>
Show metadata of given volume.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;volume&gt;</command></term>
<listitem>
<para>
ID of volume
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cinderclient_subcommand_metadata-update-all">
<title>cinder metadata-update-all command</title>
<screen><computeroutput>usage: cinder metadata-update-all &lt;volume&gt; &lt;key=value&gt; [&lt;key=value&gt; ...]</computeroutput></screen>
<para>
Update all metadata of a volume.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;volume&gt;</command></term>
<listitem>
<para>
ID of the volume to update metadata on.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;key=value&gt;</command></term>
<listitem>
<para>
Metadata entry/entries to update.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cinderclient_subcommand_migrate">
<title>cinder migrate command</title>
<screen><computeroutput>usage: cinder migrate [--force-host-copy &lt;True|False&gt;] &lt;volume&gt; &lt;host&gt;</computeroutput></screen>
<para>
Migrate the volume to the new host.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;volume&gt;</command></term>
<listitem>
<para>
ID of the volume to migrate
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;host&gt;</command></term>
<listitem>
<para>
Destination host
</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>
Optional flag to force the use of the generic host-
based migration mechanism, bypassing driver
optimizations (Default=False).
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cinderclient_subcommand_qos-associate">
<title>cinder qos-associate command</title>
<screen><computeroutput>usage: cinder qos-associate &lt;qos_specs&gt; &lt;volume_type_id&gt;</computeroutput></screen>
<para>
Associate qos specs with specific volume type.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;qos_specs&gt;</command></term>
<listitem>
<para>
ID of qos_specs.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;volume_type_id&gt;</command></term>
<listitem>
<para>
ID of volume type to be associated with.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cinderclient_subcommand_qos-create">
<title>cinder qos-create command</title>
<screen><computeroutput>usage: cinder qos-create &lt;name&gt; &lt;key=value&gt; [&lt;key=value&gt; ...]</computeroutput></screen>
<para>
Create a new qos specs.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;name&gt;</command></term>
<listitem>
<para>
Name of the new QoS specs
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;key=value&gt;</command></term>
<listitem>
<para>
Specifications for QoS
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cinderclient_subcommand_qos-delete">
<title>cinder qos-delete command</title>
<screen><computeroutput>usage: cinder qos-delete [--force &lt;True|False&gt;] &lt;qos_specs&gt;</computeroutput></screen>
<para>
Delete a specific qos specs.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;qos_specs&gt;</command></term>
<listitem>
<para>
ID of the qos_specs to delete.
</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 that indicates whether to delete
specified qos specs even if it is in-use.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cinderclient_subcommand_qos-disassociate">
<title>cinder qos-disassociate command</title>
<screen><computeroutput>usage: cinder qos-disassociate &lt;qos_specs&gt; &lt;volume_type_id&gt;</computeroutput></screen>
<para>
Disassociate qos specs from specific volume type.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;qos_specs&gt;</command></term>
<listitem>
<para>
ID of qos_specs.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;volume_type_id&gt;</command></term>
<listitem>
<para>
ID of volume type to be associated with.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cinderclient_subcommand_qos-disassociate-all">
<title>cinder qos-disassociate-all command</title>
<screen><computeroutput>usage: cinder qos-disassociate-all &lt;qos_specs&gt;</computeroutput></screen>
<para>
Disassociate qos specs from all of its associations.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;qos_specs&gt;</command></term>
<listitem>
<para>
ID of qos_specs to be operate on.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cinderclient_subcommand_qos-get-association">
<title>cinder qos-get-association command</title>
<screen><computeroutput>usage: cinder qos-get-association &lt;qos_specs&gt;</computeroutput></screen>
<para>
Get all associations of specific qos specs.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;qos_specs&gt;</command></term>
<listitem>
<para>
ID of the qos_specs.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cinderclient_subcommand_qos-key">
<title>cinder qos-key command</title>
<screen><computeroutput>usage: cinder qos-key &lt;qos_specs&gt; &lt;action&gt; key=value [key=value ...]</computeroutput></screen>
<para>
Set or unset specifications for a qos spec.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;qos_specs&gt;</command></term>
<listitem>
<para>
ID of qos specs
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;action&gt;</command></term>
<listitem>
<para>
Actions: 'set' or 'unset'
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>key=value</command></term>
<listitem>
<para>
QoS specs to set/unset (only key is necessary on unset)
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cinderclient_subcommand_qos-list">
<title>cinder qos-list command</title>
<screen><computeroutput>usage: cinder qos-list</computeroutput></screen>
<para>
Get full list of qos specs.
</para>
</section>
<section xml:id="cinderclient_subcommand_qos-show">
<title>cinder qos-show command</title>
<screen><computeroutput>usage: cinder qos-show &lt;qos_specs&gt;</computeroutput></screen>
<para>
Get a specific qos specs.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;qos_specs&gt;</command></term>
<listitem>
<para>
ID of the qos_specs to show.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cinderclient_subcommand_quota-class-show">
<title>cinder quota-class-show command</title>
<screen><computeroutput>usage: cinder 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="cinderclient_subcommand_quota-class-update">
<title>cinder quota-class-update command</title>
<screen><computeroutput>usage: cinder quota-class-update [--volumes &lt;volumes&gt;]
[--snapshots &lt;snapshots&gt;]
[--gigabytes &lt;gigabytes&gt;]
[--volume-type &lt;volume_type_name&gt;]
&lt;class&gt;</computeroutput></screen>
<para>
Update 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 set the quotas for.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--volumes &lt;volumes&gt;</command></term>
<listitem>
<para>
New value for the "volumes" 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>--volume-type &lt;volume_type_name&gt;</command></term>
<listitem>
<para>
Volume type (Optional, Default=None)
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cinderclient_subcommand_quota-defaults">
<title>cinder quota-defaults command</title>
<screen><computeroutput>usage: cinder quota-defaults &lt;tenant_id&gt;</computeroutput></screen>
<para>
List the default quotas for a tenant.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;tenant_id&gt;</command></term>
<listitem>
<para>
UUID of tenant to list the default quotas for.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cinderclient_subcommand_quota-show">
<title>cinder quota-show command</title>
<screen><computeroutput>usage: cinder quota-show &lt;tenant_id&gt;</computeroutput></screen>
<para>
List the quotas for a tenant.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;tenant_id&gt;</command></term>
<listitem>
<para>
UUID of tenant to list the quotas for.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cinderclient_subcommand_quota-update">
<title>cinder quota-update command</title>
<screen><computeroutput>usage: cinder quota-update [--volumes &lt;volumes&gt;] [--snapshots &lt;snapshots&gt;]
[--gigabytes &lt;gigabytes&gt;]
[--volume-type &lt;volume_type_name&gt;]
&lt;tenant_id&gt;</computeroutput></screen>
<para>
Update the quotas for a tenant.
</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>--volumes &lt;volumes&gt;</command></term>
<listitem>
<para>
New value for the "volumes" 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>--volume-type &lt;volume_type_name&gt;</command></term>
<listitem>
<para>
Volume type (Optional, Default=None)
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cinderclient_subcommand_quota-usage">
<title>cinder quota-usage command</title>
<screen><computeroutput>usage: cinder quota-usage &lt;tenant_id&gt;</computeroutput></screen>
<para>
List the quota usage for a tenant.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;tenant_id&gt;</command></term>
<listitem>
<para>
UUID of tenant to list the quota usage for.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cinderclient_subcommand_rate-limits">
<title>cinder rate-limits command</title>
<screen><computeroutput>usage: cinder rate-limits</computeroutput></screen>
<para>
Print a list of rate limits for a user
</para>
</section>
<section xml:id="cinderclient_subcommand_readonly-mode-update">
<title>cinder readonly-mode-update command</title>
<screen><computeroutput>usage: cinder readonly-mode-update &lt;volume&gt; &lt;True|true|False|false&gt;</computeroutput></screen>
<para>
Update volume read-only access mode read_only.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;volume&gt;</command></term>
<listitem>
<para>
ID of the volume to update.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;True|true|False|false&gt;</command></term>
<listitem>
<para>
Flag to indicate whether to update volume to read-only
access mode.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cinderclient_subcommand_rename">
<title>cinder rename command</title>
<screen><computeroutput>usage: cinder rename [--display-description &lt;display-description&gt;]
&lt;volume&gt; [&lt;display-name&gt;]</computeroutput></screen>
<para>
Rename a volume.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;volume&gt;</command></term>
<listitem>
<para>
Name or ID of the volume to rename.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;display-name&gt;</command></term>
<listitem>
<para>
New display-name for the volume.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--display-description &lt;display-description&gt;</command></term>
<listitem>
<para>
Optional volume description. (Default=None)
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cinderclient_subcommand_reset-state">
<title>cinder reset-state command</title>
<screen><computeroutput>usage: cinder reset-state [--state &lt;state&gt;] &lt;volume&gt; [&lt;volume&gt; ...]</computeroutput></screen>
<para>
Explicitly update the state of a volume.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;volume&gt;</command></term>
<listitem>
<para>
Name or ID of the volume 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 volume. 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="cinderclient_subcommand_service-disable">
<title>cinder service-disable command</title>
<screen><computeroutput>usage: cinder service-disable &lt;hostname&gt; &lt;binary&gt;</computeroutput></screen>
<para>
Disable the service.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;hostname&gt;</command></term>
<listitem>
<para>
Name of host.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;binary&gt;</command></term>
<listitem>
<para>
Service binary.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cinderclient_subcommand_service-enable">
<title>cinder service-enable command</title>
<screen><computeroutput>usage: cinder service-enable &lt;hostname&gt; &lt;binary&gt;</computeroutput></screen>
<para>
Enable the service.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;hostname&gt;</command></term>
<listitem>
<para>
Name of host.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;binary&gt;</command></term>
<listitem>
<para>
Service binary.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cinderclient_subcommand_service-list">
<title>cinder service-list command</title>
<screen><computeroutput>usage: cinder service-list [--host &lt;hostname&gt;] [--binary &lt;binary&gt;]</computeroutput></screen>
<para>
List all the services. Filter by host &amp; service binary.
</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>
</variablelist>
</section>
<section xml:id="cinderclient_subcommand_show">
<title>cinder show command</title>
<screen><computeroutput>usage: cinder show &lt;volume&gt;</computeroutput></screen>
<para>
Show details about a volume.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;volume&gt;</command></term>
<listitem>
<para>
Name or ID of the volume.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cinderclient_subcommand_snapshot-create">
<title>cinder snapshot-create command</title>
<screen><computeroutput>usage: cinder snapshot-create [--force &lt;True|False&gt;]
[--display-name &lt;display-name&gt;]
[--display-description &lt;display-description&gt;]
&lt;volume&gt;</computeroutput></screen>
<para>
Add a new snapshot.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;volume&gt;</command></term>
<listitem>
<para>
Name or ID of the volume 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 volume
even if it's attached to an instance. (Default=False)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--display-name &lt;display-name&gt;</command></term>
<listitem>
<para>
Optional snapshot name. (Default=None)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--display-description &lt;display-description&gt;</command></term>
<listitem>
<para>
Optional snapshot description. (Default=None)
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cinderclient_subcommand_snapshot-delete">
<title>cinder snapshot-delete command</title>
<screen><computeroutput>usage: cinder 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="cinderclient_subcommand_snapshot-list">
<title>cinder snapshot-list command</title>
<screen><computeroutput>usage: cinder snapshot-list [--all-tenants [&lt;0|1&gt;]]
[--display-name &lt;display-name&gt;]
[--status &lt;status&gt;] [--volume-id &lt;volume-id&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>--display-name &lt;display-name&gt;</command></term>
<listitem>
<para>
Filter results by display-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>--volume-id &lt;volume-id&gt;</command></term>
<listitem>
<para>
Filter results by volume-id
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cinderclient_subcommand_snapshot-metadata">
<title>cinder snapshot-metadata command</title>
<screen><computeroutput>usage: cinder snapshot-metadata &lt;snapshot&gt; &lt;action&gt; &lt;key=value&gt;
[&lt;key=value&gt; ...]</computeroutput></screen>
<para>
Set or Delete metadata of a snapshot.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;snapshot&gt;</command></term>
<listitem>
<para>
ID of the snapshot 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/unset (only key is necessary on unset)
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cinderclient_subcommand_snapshot-metadata-show">
<title>cinder snapshot-metadata-show command</title>
<screen><computeroutput>usage: cinder snapshot-metadata-show &lt;snapshot&gt;</computeroutput></screen>
<para>
Show metadata of given snapshot.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;snapshot&gt;</command></term>
<listitem>
<para>
ID of snapshot
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cinderclient_subcommand_snapshot-metadata-update-all">
<title>cinder snapshot-metadata-update-all command</title>
<screen><computeroutput>usage: cinder snapshot-metadata-update-all &lt;snapshot&gt; &lt;key=value&gt;
[&lt;key=value&gt; ...]</computeroutput></screen>
<para>
Update all metadata of a snapshot.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;snapshot&gt;</command></term>
<listitem>
<para>
ID of the snapshot to update metadata on.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;key=value&gt;</command></term>
<listitem>
<para>
Metadata entry/entries to update.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cinderclient_subcommand_snapshot-rename">
<title>cinder snapshot-rename command</title>
<screen><computeroutput>usage: cinder snapshot-rename [--display-description &lt;display-description&gt;]
&lt;snapshot&gt; [&lt;display-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.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;display-name&gt;</command></term>
<listitem>
<para>
New display-name for the snapshot.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--display-description &lt;display-description&gt;</command></term>
<listitem>
<para>
Optional snapshot description. (Default=None)
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cinderclient_subcommand_snapshot-reset-state">
<title>cinder snapshot-reset-state command</title>
<screen><computeroutput>usage: cinder snapshot-reset-state [--state &lt;state&gt;]
&lt;snapshot&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="cinderclient_subcommand_snapshot-show">
<title>cinder snapshot-show command</title>
<screen><computeroutput>usage: cinder 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="cinderclient_subcommand_transfer-accept">
<title>cinder transfer-accept command</title>
<screen><computeroutput>usage: cinder transfer-accept &lt;transfer&gt; &lt;auth_key&gt;</computeroutput></screen>
<para>
Accepts a volume transfer.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;transfer&gt;</command></term>
<listitem>
<para>
ID of the transfer to accept.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;auth_key&gt;</command></term>
<listitem>
<para>
Auth key of the transfer to accept.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cinderclient_subcommand_transfer-create">
<title>cinder transfer-create command</title>
<screen><computeroutput>usage: cinder transfer-create [--display-name &lt;display-name&gt;] &lt;volume&gt;</computeroutput></screen>
<para>
Creates a volume transfer.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;volume&gt;</command></term>
<listitem>
<para>
Name or ID of the volume to transfer.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--display-name &lt;display-name&gt;</command></term>
<listitem>
<para>
Optional transfer name. (Default=None)
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cinderclient_subcommand_transfer-delete">
<title>cinder transfer-delete command</title>
<screen><computeroutput>usage: cinder transfer-delete &lt;transfer&gt;</computeroutput></screen>
<para>
Undo a transfer.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;transfer&gt;</command></term>
<listitem>
<para>
Name or ID of the transfer to delete.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cinderclient_subcommand_transfer-list">
<title>cinder transfer-list command</title>
<screen><computeroutput>usage: cinder transfer-list</computeroutput></screen>
<para>
List all the transfers.
</para>
</section>
<section xml:id="cinderclient_subcommand_transfer-show">
<title>cinder transfer-show command</title>
<screen><computeroutput>usage: cinder transfer-show &lt;transfer&gt;</computeroutput></screen>
<para>
Show details about a transfer.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;transfer&gt;</command></term>
<listitem>
<para>
Name or ID of the transfer to accept.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cinderclient_subcommand_type-create">
<title>cinder type-create command</title>
<screen><computeroutput>usage: cinder type-create &lt;name&gt;</computeroutput></screen>
<para>
Create a new volume type.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;name&gt;</command></term>
<listitem>
<para>
Name of the new volume type
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cinderclient_subcommand_type-delete">
<title>cinder type-delete command</title>
<screen><computeroutput>usage: cinder type-delete &lt;id&gt;</computeroutput></screen>
<para>
Delete a specific volume type.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;id&gt;</command></term>
<listitem>
<para>
Unique ID of the volume type to delete
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cinderclient_subcommand_type-key">
<title>cinder type-key command</title>
<screen><computeroutput>usage: cinder type-key &lt;vtype&gt; &lt;action&gt; [&lt;key=value&gt; [&lt;key=value&gt; ...]]</computeroutput></screen>
<para>
Set or unset extra_spec for a volume type.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;vtype&gt;</command></term>
<listitem>
<para>
Name or ID of the volume 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/unset (only key is necessary on unset)
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cinderclient_subcommand_type-list">
<title>cinder type-list command</title>
<screen><computeroutput>usage: cinder type-list</computeroutput></screen>
<para>
Print a list of available 'volume types'.
</para>
</section>
<section xml:id="cinderclient_subcommand_upload-to-image">
<title>cinder upload-to-image command</title>
<screen><computeroutput>usage: cinder upload-to-image [--force &lt;True|False&gt;]
[--container-format &lt;container-format&gt;]
[--disk-format &lt;disk-format&gt;]
&lt;volume&gt; &lt;image-name&gt;</computeroutput></screen>
<para>
Upload volume to image service as image.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;volume&gt;</command></term>
<listitem>
<para>
Name or ID of the volume to upload to an image
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;image-name&gt;</command></term>
<listitem>
<para>
Name for created image
</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 upload a volume
even if it's attached to an instance. (Default=False)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--container-format &lt;container-format&gt;</command></term>
<listitem>
<para>
Optional type for container format (Default=bare)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--disk-format &lt;disk-format&gt;</command></term>
<listitem>
<para>
Optional type for disk format (Default=raw)
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
</chapter>
View Git Blame Copy Permalink