5144 lines
160 KiB
XML
5144 lines
160 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="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
|
|
<literal>1.2.1</literal>.
|
|
</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] [-d] [--os-auth-system <auth-system>]
|
|
[--service-type <service-type>] [--service-name <service-name>]
|
|
[--volume-service-name <volume-service-name>]
|
|
[--endpoint-type <endpoint-type>]
|
|
[--os-volume-api-version <volume-api-ver>]
|
|
[--bypass-url <bypass-url>] [--retries <retries>]
|
|
[--os-auth-strategy <auth-strategy>]
|
|
[--os-username <auth-user-name>] [--os-password <auth-password>]
|
|
[--os-tenant-name <auth-tenant-name>]
|
|
[--os-tenant-id <auth-tenant-id>] [--os-auth-url <auth-url>]
|
|
[--os-user-id <auth-user-id>]
|
|
[--os-user-domain-id <auth-user-domain-id>]
|
|
[--os-user-domain-name <auth-user-domain-name>]
|
|
[--os-project-id <auth-project-id>]
|
|
[--os-project-name <auth-project-name>]
|
|
[--os-project-domain-id <auth-project-domain-id>]
|
|
[--os-project-domain-name <auth-project-domain-name>]
|
|
[--os-cert <certificate>] [--os-key <key>]
|
|
[--os-region-name <region-name>] [--os-token <token>]
|
|
[--os-url <url>] [--os-cacert <ca-certificate>]
|
|
<subcommand> ...</computeroutput></screen>
|
|
<variablelist wordsize="10">
|
|
<title>Subcommands</title>
|
|
<varlistentry>
|
|
<term><command>absolute-limits</command></term>
|
|
<listitem>
|
|
<para>
|
|
Lists absolute limits for a user.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>availability-zone-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
Lists all availability zones.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>backup-create</command></term>
|
|
<listitem>
|
|
<para>
|
|
Creates a volume backup.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>backup-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Removes a backup.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>backup-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
Lists all backups.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>backup-restore</command></term>
|
|
<listitem>
|
|
<para>
|
|
Restores a backup.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>backup-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show backup details.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>create</command></term>
|
|
<listitem>
|
|
<para>
|
|
Creates a volume.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>credentials</command></term>
|
|
<listitem>
|
|
<para>
|
|
Shows user credentials returned from auth.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Removes one or more volumes.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>encryption-type-create</command></term>
|
|
<listitem>
|
|
<para>
|
|
Creates encryption type for a volume type. Admin only.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>encryption-type-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Deletes encryption type for a volume type. Admin only.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>encryption-type-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
Shows encryption type details for volume types. Admin
|
|
only.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>encryption-type-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Shows encryption type details for volume type. Admin
|
|
only.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>endpoints</command></term>
|
|
<listitem>
|
|
<para>
|
|
Discovers endpoints registered by authentication
|
|
service.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>extend</command></term>
|
|
<listitem>
|
|
<para>
|
|
Attempts to extend size of an existing volume.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>extra-specs-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
Lists current volume types and extra specs.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>force-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Attempts force-delete of volume, regardless of state.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>list</command></term>
|
|
<listitem>
|
|
<para>
|
|
Lists all volumes.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>metadata</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sets or deletes volume metadata.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>metadata-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Shows volume metadata.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>metadata-update-all</command></term>
|
|
<listitem>
|
|
<para>
|
|
Updates volume metadata.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>migrate</command></term>
|
|
<listitem>
|
|
<para>
|
|
Migrates volume to a new host.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>qos-associate</command></term>
|
|
<listitem>
|
|
<para>
|
|
Associates qos specs with specified volume type.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>qos-create</command></term>
|
|
<listitem>
|
|
<para>
|
|
Creates a qos specs.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>qos-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Deletes a specified qos specs.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>qos-disassociate</command></term>
|
|
<listitem>
|
|
<para>
|
|
Disassociates qos specs from specified volume type.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>qos-disassociate-all</command></term>
|
|
<listitem>
|
|
<para>
|
|
Disassociates qos specs from all associations.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>qos-get-association</command></term>
|
|
<listitem>
|
|
<para>
|
|
Gets all associations for specified qos specs.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>qos-key</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sets or unsets specifications for a qos spec.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>qos-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
Lists qos specs.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>qos-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Shows a specified qos specs.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>quota-class-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Lists quotas for a quota class.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>quota-class-update</command></term>
|
|
<listitem>
|
|
<para>
|
|
Updates quotas for a quota class.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>quota-defaults</command></term>
|
|
<listitem>
|
|
<para>
|
|
Lists default quotas for a tenant.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>quota-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Delete the quotas for a tenant.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>quota-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Lists quotas for a tenant.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>quota-update</command></term>
|
|
<listitem>
|
|
<para>
|
|
Updates quotas for a tenant.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>quota-usage</command></term>
|
|
<listitem>
|
|
<para>
|
|
Lists quota usage for a tenant.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>rate-limits</command></term>
|
|
<listitem>
|
|
<para>
|
|
Lists rate limits for a user.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>readonly-mode-update</command></term>
|
|
<listitem>
|
|
<para>
|
|
Updates volume read-only access-mode flag.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>rename</command></term>
|
|
<listitem>
|
|
<para>
|
|
Renames a volume.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>reset-state</command></term>
|
|
<listitem>
|
|
<para>
|
|
Explicitly updates the volume state.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>service-disable</command></term>
|
|
<listitem>
|
|
<para>
|
|
Disables the service.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>service-enable</command></term>
|
|
<listitem>
|
|
<para>
|
|
Enables the service.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>service-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
Lists all services. Filter by host and service binary.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>set-bootable</command></term>
|
|
<listitem>
|
|
<para>
|
|
Update bootable status of a volume.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Shows volume details.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>snapshot-create</command></term>
|
|
<listitem>
|
|
<para>
|
|
Creates a snapshot.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>snapshot-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Remove one or more snapshots.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>snapshot-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
Lists all snapshots.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>snapshot-metadata</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sets or deletes snapshot metadata.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>snapshot-metadata-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Shows snapshot metadata.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>snapshot-metadata-update-all</command></term>
|
|
<listitem>
|
|
<para>
|
|
Updates snapshot metadata.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>snapshot-rename</command></term>
|
|
<listitem>
|
|
<para>
|
|
Renames a snapshot.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>snapshot-reset-state</command></term>
|
|
<listitem>
|
|
<para>
|
|
Explicitly updates the snapshot state.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>snapshot-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Shows snapshot details.
|
|
</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>
|
|
Undoes a transfer.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>transfer-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
Lists all transfers.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>transfer-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show transfer details.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>type-create</command></term>
|
|
<listitem>
|
|
<para>
|
|
Creates a volume type.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>type-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Deletes a specified volume type.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>type-key</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sets or unsets extra_spec for a volume type.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>type-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
Lists available 'volume types'.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>upload-to-image</command></term>
|
|
<listitem>
|
|
<para>
|
|
Uploads volume to Image Service as an image.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>bash-completion</command></term>
|
|
<listitem>
|
|
<para>
|
|
Prints arguments for bash_completion.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>help</command></term>
|
|
<listitem>
|
|
<para>
|
|
Shows help about this program or one of its
|
|
subcommands.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>list-extensions</command></term>
|
|
<listitem>
|
|
<para>
|
|
Lists all available os-api extensions.
|
|
</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>-d, --debug</command></term>
|
|
<listitem>
|
|
<para>
|
|
Shows debugging output.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-auth-system <auth-system></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_AUTH_SYSTEM]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--service-type <service-type></command></term>
|
|
<listitem>
|
|
<para>
|
|
Service type. For most actions, default is volume.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--service-name <service-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Service name. Default=<code>env[CINDER_SERVICE_NAME]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--volume-service-name <volume-service-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Volume service name.
|
|
Default=<code>env[CINDER_VOLUME_SERVICE_NAME]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--endpoint-type <endpoint-type></command></term>
|
|
<listitem>
|
|
<para>
|
|
Endpoint type, which is publicURL or internalURL.
|
|
Default=nova <code>env[CINDER_ENDPOINT_TYPE]</code> or publicURL.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-volume-api-version <volume-api-ver></command></term>
|
|
<listitem>
|
|
<para>
|
|
Block Storage API version. Valid values are 1 or 2.
|
|
Default=<code>env[OS_VOLUME_API_VERSION]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--bypass-url <bypass-url></command></term>
|
|
<listitem>
|
|
<para>
|
|
Use this API endpoint instead of the Service Catalog.
|
|
Defaults to <code>env[CINDERCLIENT_BYPASS_URL]</code>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--retries <retries></command></term>
|
|
<listitem>
|
|
<para>
|
|
Number of retries.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-auth-strategy <auth-strategy></command></term>
|
|
<listitem>
|
|
<para>
|
|
Authentication strategy (Env: OS_AUTH_STRATEGY,
|
|
default keystone). For now, any other value will
|
|
disable the authentication
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-username <auth-user-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
OpenStack user name. Default=<code>env[OS_USERNAME]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-password <auth-password></command></term>
|
|
<listitem>
|
|
<para>
|
|
Password for OpenStack user. Default=<code>env[OS_PASSWORD]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-tenant-name <auth-tenant-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Tenant name. Default=<code>env[OS_TENANT_NAME]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-tenant-id <auth-tenant-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID for the tenant. Default=<code>env[OS_TENANT_ID]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-auth-url <auth-url></command></term>
|
|
<listitem>
|
|
<para>
|
|
URL for the authentication service.
|
|
Default=<code>env[OS_AUTH_URL]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-user-id <auth-user-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
Authentication user ID (Env: OS_USER_ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-user-domain-id <auth-user-domain-id></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 <auth-user-domain-name></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-id <auth-project-id></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-project-name <auth-project-name></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-project-domain-id <auth-project-domain-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_PROJECT_DOMAIN_ID]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-project-domain-name <auth-project-domain-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_PROJECT_DOMAIN_NAME]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-cert <certificate></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_CERT]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-key <key></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_KEY]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-region-name <region-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Region name. Default=<code>env[OS_REGION_NAME]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-token <token></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_TOKEN]</code>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-url <url></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_URL]</code>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-cacert <ca-certificate></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>
|
|
</variablelist>
|
|
</section>
|
|
|
|
<section xml:id="cinder_cli_v1">
|
|
<title>Block Storage API v1 commands</title>
|
|
<section xml:id="cinderclient_subcommand_absolute-limits">
|
|
<title>cinder absolute-limits</title>
|
|
<screen><computeroutput>usage: cinder absolute-limits</computeroutput></screen>
|
|
<para>
|
|
Lists absolute limits for a user.
|
|
</para>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_availability-zone-list">
|
|
<title>cinder availability-zone-list</title>
|
|
<screen><computeroutput>usage: cinder availability-zone-list</computeroutput></screen>
|
|
<para>
|
|
Lists all availability zones.
|
|
</para>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_backup-create">
|
|
<title>cinder backup-create</title>
|
|
<screen><computeroutput>usage: cinder backup-create [--container <container>]
|
|
[--display-name <display-name>]
|
|
[--display-description <display-description>]
|
|
<volume></computeroutput></screen>
|
|
<para>
|
|
Creates a volume backup.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of volume to back up.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--container <container></command></term>
|
|
<listitem>
|
|
<para>
|
|
Backup container name. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--display-name <display-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Backup name. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--display-description <display-description></command></term>
|
|
<listitem>
|
|
<para>
|
|
Backup description. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_backup-delete">
|
|
<title>cinder backup-delete</title>
|
|
<screen><computeroutput>usage: cinder backup-delete <backup></computeroutput></screen>
|
|
<para>
|
|
Removes a backup.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><backup></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of backup to delete.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_backup-list">
|
|
<title>cinder backup-list</title>
|
|
<screen><computeroutput>usage: cinder backup-list</computeroutput></screen>
|
|
<para>
|
|
Lists all backups.
|
|
</para>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_backup-restore">
|
|
<title>cinder backup-restore</title>
|
|
<screen><computeroutput>usage: cinder backup-restore [--volume-id <volume>] <backup></computeroutput></screen>
|
|
<para>
|
|
Restores a backup.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><backup></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of backup to restore.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--volume-id <volume> ID</command></term>
|
|
<listitem>
|
|
<para>
|
|
or name of backup volume to which to restore.
|
|
Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_backup-show">
|
|
<title>cinder backup-show</title>
|
|
<screen><computeroutput>usage: cinder backup-show <backup></computeroutput></screen>
|
|
<para>
|
|
Show backup details.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><backup></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of backup.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_create">
|
|
<title>cinder create</title>
|
|
<screen><computeroutput>usage: cinder create [--snapshot-id <snapshot-id>]
|
|
[--source-volid <source-volid>] [--image-id <image-id>]
|
|
[--display-name <display-name>]
|
|
[--display-description <display-description>]
|
|
[--volume-type <volume-type>]
|
|
[--availability-zone <availability-zone>]
|
|
[--metadata [<key=value> [<key=value> ...]]]
|
|
<size></computeroutput></screen>
|
|
<para>
|
|
Creates a volume.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><size></command></term>
|
|
<listitem>
|
|
<para>
|
|
Volume size, in GBs.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--snapshot-id <snapshot-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
Creates volume from snapshot ID. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--source-volid <source-volid></command></term>
|
|
<listitem>
|
|
<para>
|
|
Creates volume from volume ID. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--image-id <image-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
Creates volume from image ID. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--display-name <display-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Volume name. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--display-description <display-description></command></term>
|
|
<listitem>
|
|
<para>
|
|
Volume description. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--volume-type <volume-type></command></term>
|
|
<listitem>
|
|
<para>
|
|
Volume type. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--availability-zone <availability-zone></command></term>
|
|
<listitem>
|
|
<para>
|
|
Availability zone for volume. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--metadata [<key=value> [<key=value> ...]]</command></term>
|
|
<listitem>
|
|
<para>
|
|
Metadata key and value pairs. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_credentials">
|
|
<title>cinder credentials</title>
|
|
<screen><computeroutput>usage: cinder credentials</computeroutput></screen>
|
|
<para>
|
|
Shows user credentials returned from auth.
|
|
</para>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_delete">
|
|
<title>cinder delete</title>
|
|
<screen><computeroutput>usage: cinder delete <volume> [<volume> ...]</computeroutput></screen>
|
|
<para>
|
|
Removes one or more volumes.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of volume to delete. Separate multiple volumes with a
|
|
space.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_encryption-type-create">
|
|
<title>cinder encryption-type-create</title>
|
|
<screen><computeroutput>usage: cinder encryption-type-create [--cipher <cipher>]
|
|
[--key_size <key_size>]
|
|
[--control_location <control_location>]
|
|
<volume_type> <provider></computeroutput></screen>
|
|
<para>
|
|
Creates encryption type for a volume type. Admin only.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume_type></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of volume type.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><provider></command></term>
|
|
<listitem>
|
|
<para>
|
|
The class that provides encryption support. For
|
|
example, a volume driver class path.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--cipher <cipher></command></term>
|
|
<listitem>
|
|
<para>
|
|
The encryption algorithm and mode. For example, aes-
|
|
xts-plain64. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--key_size <key_size></command></term>
|
|
<listitem>
|
|
<para>
|
|
Size of encryption key, in bits. For example, 128 or
|
|
256. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--control_location <control_location></command></term>
|
|
<listitem>
|
|
<para>
|
|
Notional service where encryption is performed. Valid
|
|
values are "front-end" or "back-end." For example,
|
|
front-end=Nova. Default is "front-end."
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_encryption-type-delete">
|
|
<title>cinder encryption-type-delete</title>
|
|
<screen><computeroutput>usage: cinder encryption-type-delete <volume_type></computeroutput></screen>
|
|
<para>
|
|
Deletes encryption type for a volume type. Admin only.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume_type></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of volume type.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_encryption-type-list">
|
|
<title>cinder encryption-type-list</title>
|
|
<screen><computeroutput>usage: cinder encryption-type-list</computeroutput></screen>
|
|
<para>
|
|
Shows encryption type details for volume types. Admin only.
|
|
</para>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_encryption-type-show">
|
|
<title>cinder encryption-type-show</title>
|
|
<screen><computeroutput>usage: cinder encryption-type-show <volume_type></computeroutput></screen>
|
|
<para>
|
|
Shows encryption type details for volume type. Admin only.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume_type></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of volume type.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_endpoints">
|
|
<title>cinder endpoints</title>
|
|
<screen><computeroutput>usage: cinder endpoints</computeroutput></screen>
|
|
<para>
|
|
Discovers endpoints registered by authentication service.
|
|
</para>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_extend">
|
|
<title>cinder extend</title>
|
|
<screen><computeroutput>usage: cinder extend <volume> <new-size></computeroutput></screen>
|
|
<para>
|
|
Attempts to extend size of an existing volume.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of volume to extend.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><new-size></command></term>
|
|
<listitem>
|
|
<para>
|
|
Size of volume, in GBs.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_extra-specs-list">
|
|
<title>cinder extra-specs-list</title>
|
|
<screen><computeroutput>usage: cinder extra-specs-list</computeroutput></screen>
|
|
<para>
|
|
Lists current volume types and extra specs.
|
|
</para>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_force-delete">
|
|
<title>cinder force-delete</title>
|
|
<screen><computeroutput>usage: cinder force-delete <volume> [<volume> ...]</computeroutput></screen>
|
|
<para>
|
|
Attempts force-delete of volume, regardless of state.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of volume to delete. Separate multiple volumes with a
|
|
space.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_list">
|
|
<title>cinder list</title>
|
|
<screen><computeroutput>usage: cinder list [--all-tenants [<0|1>]] [--display-name <display-name>]
|
|
[--status <status>]
|
|
[--metadata [<key=value> [<key=value> ...]]]
|
|
[--tenant [<tenant>]] [--limit <limit>]</computeroutput></screen>
|
|
<para>
|
|
Lists all volumes.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--all-tenants [<0|1>]</command></term>
|
|
<listitem>
|
|
<para>
|
|
Shows details for all tenants. Admin only.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--display-name <display-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Filters list by a volume display name. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--status <status></command></term>
|
|
<listitem>
|
|
<para>
|
|
Filters list by a status. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--metadata [<key=value> [<key=value> ...]]</command></term>
|
|
<listitem>
|
|
<para>
|
|
Filters list by metadata key and value pair.
|
|
Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--tenant [<tenant>]</command></term>
|
|
<listitem>
|
|
<para>
|
|
Display information from single tenant (Admin only).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--limit <limit></command></term>
|
|
<listitem>
|
|
<para>
|
|
Maximum number of volumes to return. OPTIONAL:
|
|
Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_list-extensions">
|
|
<title>cinder list-extensions</title>
|
|
<screen><computeroutput>usage: cinder list-extensions</computeroutput></screen>
|
|
<para>
|
|
Lists all available os-api extensions.
|
|
</para>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_metadata">
|
|
<title>cinder metadata</title>
|
|
<screen><computeroutput>usage: cinder metadata <volume> <action> <key=value> [<key=value> ...]</computeroutput></screen>
|
|
<para>
|
|
Sets or deletes volume metadata.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of volume for which to update metadata.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><action></command></term>
|
|
<listitem>
|
|
<para>
|
|
The action. Valid values are "set" or "unset."
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><key=value></command></term>
|
|
<listitem>
|
|
<para>
|
|
The metadata key and pair to set or unset. For unset, specify
|
|
only the key. Default=[].
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_metadata-show">
|
|
<title>cinder metadata-show</title>
|
|
<screen><computeroutput>usage: cinder metadata-show <volume></computeroutput></screen>
|
|
<para>
|
|
Shows volume metadata.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume></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</title>
|
|
<screen><computeroutput>usage: cinder metadata-update-all <volume> <key=value> [<key=value> ...]</computeroutput></screen>
|
|
<para>
|
|
Updates volume metadata.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of volume for which to update metadata.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><key=value></command></term>
|
|
<listitem>
|
|
<para>
|
|
Metadata key and value pair or pairs to update. Default=[].
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_migrate">
|
|
<title>cinder migrate</title>
|
|
<screen><computeroutput>usage: cinder migrate [--force-host-copy <True|False>] <volume> <host></computeroutput></screen>
|
|
<para>
|
|
Migrates volume to a new host.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of volume to migrate.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><host></command></term>
|
|
<listitem>
|
|
<para>
|
|
Destination host.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--force-host-copy <True|False></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="cinderclient_subcommand_qos-associate">
|
|
<title>cinder qos-associate</title>
|
|
<screen><computeroutput>usage: cinder qos-associate <qos_specs> <volume_type_id></computeroutput></screen>
|
|
<para>
|
|
Associates qos specs with specified volume type.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><qos_specs></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of QoS specifications.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><volume_type_id></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of volume type.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_qos-create">
|
|
<title>cinder qos-create</title>
|
|
<screen><computeroutput>usage: cinder qos-create <name> <key=value> [<key=value> ...]</computeroutput></screen>
|
|
<para>
|
|
Creates a qos specs.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of new QoS specifications.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><key=value></command></term>
|
|
<listitem>
|
|
<para>
|
|
Specifications for QoS.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_qos-delete">
|
|
<title>cinder qos-delete</title>
|
|
<screen><computeroutput>usage: cinder qos-delete [--force <True|False>] <qos_specs></computeroutput></screen>
|
|
<para>
|
|
Deletes a specified qos specs.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><qos_specs></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of QoS specifications.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--force <True|False></command></term>
|
|
<listitem>
|
|
<para>
|
|
Enables or disables deletion of in-use QoS
|
|
specifications. Default=False.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_qos-disassociate">
|
|
<title>cinder qos-disassociate</title>
|
|
<screen><computeroutput>usage: cinder qos-disassociate <qos_specs> <volume_type_id></computeroutput></screen>
|
|
<para>
|
|
Disassociates qos specs from specified volume type.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><qos_specs></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of QoS specifications.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><volume_type_id></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of volume type.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_qos-disassociate-all">
|
|
<title>cinder qos-disassociate-all</title>
|
|
<screen><computeroutput>usage: cinder qos-disassociate-all <qos_specs></computeroutput></screen>
|
|
<para>
|
|
Disassociates qos specs from all associations.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><qos_specs></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of QoS specifications.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_qos-get-association">
|
|
<title>cinder qos-get-association</title>
|
|
<screen><computeroutput>usage: cinder qos-get-association <qos_specs></computeroutput></screen>
|
|
<para>
|
|
Gets all associations for specified qos specs.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><qos_specs></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of QoS specifications.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_qos-key">
|
|
<title>cinder qos-key</title>
|
|
<screen><computeroutput>usage: cinder qos-key <qos_specs> <action> key=value [key=value ...]</computeroutput></screen>
|
|
<para>
|
|
Sets or unsets specifications for a qos spec.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><qos_specs></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of QoS specifications.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><action></command></term>
|
|
<listitem>
|
|
<para>
|
|
The action. Valid values are "set" or "unset."
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>key=value</command></term>
|
|
<listitem>
|
|
<para>
|
|
Metadata key and value pair to set or unset. For unset, specify
|
|
only the key.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_qos-list">
|
|
<title>cinder qos-list</title>
|
|
<screen><computeroutput>usage: cinder qos-list</computeroutput></screen>
|
|
<para>
|
|
Lists qos specs.
|
|
</para>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_qos-show">
|
|
<title>cinder qos-show</title>
|
|
<screen><computeroutput>usage: cinder qos-show <qos_specs></computeroutput></screen>
|
|
<para>
|
|
Shows a specified qos specs.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><qos_specs></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of QoS specifications.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_quota-class-show">
|
|
<title>cinder quota-class-show</title>
|
|
<screen><computeroutput>usage: cinder quota-class-show <class></computeroutput></screen>
|
|
<para>
|
|
Lists quotas for a quota class.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><class></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of quota class for which to list quotas.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_quota-class-update">
|
|
<title>cinder quota-class-update</title>
|
|
<screen><computeroutput>usage: cinder quota-class-update [--volumes <volumes>]
|
|
[--snapshots <snapshots>]
|
|
[--gigabytes <gigabytes>]
|
|
[--volume-type <volume_type_name>]
|
|
<class></computeroutput></screen>
|
|
<para>
|
|
Updates quotas for a quota class.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><class></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of quota class for which to set quotas.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--volumes <volumes></command></term>
|
|
<listitem>
|
|
<para>
|
|
The new "volumes" quota value. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--snapshots <snapshots></command></term>
|
|
<listitem>
|
|
<para>
|
|
The new "snapshots" quota value. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--gigabytes <gigabytes></command></term>
|
|
<listitem>
|
|
<para>
|
|
The new "gigabytes" quota value. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--volume-type <volume_type_name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Volume type. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_quota-defaults">
|
|
<title>cinder quota-defaults</title>
|
|
<screen><computeroutput>usage: cinder quota-defaults <tenant_id></computeroutput></screen>
|
|
<para>
|
|
Lists default quotas for a tenant.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><tenant_id></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of the tenant for which to list default quotas.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_quota-delete">
|
|
<title>cinder quota-delete</title>
|
|
<screen><computeroutput>usage: cinder quota-delete <tenant_id></computeroutput></screen>
|
|
<para>
|
|
Delete the quotas for a tenant.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><tenant_id></command></term>
|
|
<listitem>
|
|
<para>
|
|
UUID of tenant to delete the quotas for.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_quota-show">
|
|
<title>cinder quota-show</title>
|
|
<screen><computeroutput>usage: cinder quota-show <tenant_id></computeroutput></screen>
|
|
<para>
|
|
Lists quotas for a tenant.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><tenant_id></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of the tenant for which to list quotas.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_quota-update">
|
|
<title>cinder quota-update</title>
|
|
<screen><computeroutput>usage: cinder quota-update [--volumes <volumes>] [--snapshots <snapshots>]
|
|
[--gigabytes <gigabytes>] [--backups <backups>]
|
|
[--backup-gigabytes <backup_gigabytes>]
|
|
[--volume-type <volume_type_name>]
|
|
<tenant_id></computeroutput></screen>
|
|
<para>
|
|
Updates quotas for a tenant.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><tenant_id></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of the tenant for which to set quotas.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--volumes <volumes></command></term>
|
|
<listitem>
|
|
<para>
|
|
The new "volumes" quota value. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--snapshots <snapshots></command></term>
|
|
<listitem>
|
|
<para>
|
|
The new "snapshots" quota value. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--gigabytes <gigabytes></command></term>
|
|
<listitem>
|
|
<para>
|
|
The new "gigabytes" quota value. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--backups <backups></command></term>
|
|
<listitem>
|
|
<para>
|
|
The new "backups" quota value. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--backup-gigabytes <backup_gigabytes></command></term>
|
|
<listitem>
|
|
<para>
|
|
The new "backup_gigabytes" quota value. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--volume-type <volume_type_name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Volume type. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_quota-usage">
|
|
<title>cinder quota-usage</title>
|
|
<screen><computeroutput>usage: cinder quota-usage <tenant_id></computeroutput></screen>
|
|
<para>
|
|
Lists quota usage for a tenant.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><tenant_id></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of the tenant for which to list quota usage.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_rate-limits">
|
|
<title>cinder rate-limits</title>
|
|
<screen><computeroutput>usage: cinder rate-limits</computeroutput></screen>
|
|
<para>
|
|
Lists rate limits for a user.
|
|
</para>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_readonly-mode-update">
|
|
<title>cinder readonly-mode-update</title>
|
|
<screen><computeroutput>usage: cinder readonly-mode-update <volume> <True|true|False|false></computeroutput></screen>
|
|
<para>
|
|
Updates volume read-only access-mode flag.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of volume to update.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><True|true|False|false></command></term>
|
|
<listitem>
|
|
<para>
|
|
Enables or disables update of volume to read-only
|
|
access mode.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_rename">
|
|
<title>cinder rename</title>
|
|
<screen><computeroutput>usage: cinder rename [--display-description <display-description>]
|
|
<volume> [<display-name>]</computeroutput></screen>
|
|
<para>
|
|
Renames a volume.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of volume to rename.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><display-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
New display name for volume.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--display-description <display-description></command></term>
|
|
<listitem>
|
|
<para>
|
|
Volume description. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_reset-state">
|
|
<title>cinder reset-state</title>
|
|
<screen><computeroutput>usage: cinder reset-state [--state <state>] <volume> [<volume> ...]</computeroutput></screen>
|
|
<para>
|
|
Explicitly updates the volume state.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of volume to modify. Separate multiple volumes
|
|
with a space.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--state <state></command></term>
|
|
<listitem>
|
|
<para>
|
|
The state to assign to the volume. Valid values are
|
|
"available," "error," "creating," "deleting," "in-use,"
|
|
"attaching," "detaching" and "error_deleting." NOTE: This
|
|
command simply changes the state of the Volume in the
|
|
DataBase with no regard to actual status, exercise caution
|
|
when using. Default=available.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_service-disable">
|
|
<title>cinder service-disable</title>
|
|
<screen><computeroutput>usage: cinder service-disable [--reason <reason>] <hostname> <binary></computeroutput></screen>
|
|
<para>
|
|
Disables the service.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><hostname></command></term>
|
|
<listitem>
|
|
<para>
|
|
Host name.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><binary></command></term>
|
|
<listitem>
|
|
<para>
|
|
Service binary.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--reason <reason></command></term>
|
|
<listitem>
|
|
<para>
|
|
Reason for disabling service.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_service-enable">
|
|
<title>cinder service-enable</title>
|
|
<screen><computeroutput>usage: cinder service-enable <hostname> <binary></computeroutput></screen>
|
|
<para>
|
|
Enables the service.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><hostname></command></term>
|
|
<listitem>
|
|
<para>
|
|
Host name.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><binary></command></term>
|
|
<listitem>
|
|
<para>
|
|
Service binary.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_service-list">
|
|
<title>cinder service-list</title>
|
|
<screen><computeroutput>usage: cinder service-list [--host <hostname>] [--binary <binary>]</computeroutput></screen>
|
|
<para>
|
|
Lists all services. Filter by host and service binary.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--host <hostname></command></term>
|
|
<listitem>
|
|
<para>
|
|
Host name. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--binary <binary></command></term>
|
|
<listitem>
|
|
<para>
|
|
Service binary. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_set-bootable">
|
|
<title>cinder set-bootable</title>
|
|
<screen><computeroutput>usage: cinder set-bootable <volume> <True|true|False|false></computeroutput></screen>
|
|
<para>
|
|
Update bootable status of a volume.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of the volume to update.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><True|true|False|false></command></term>
|
|
<listitem>
|
|
<para>
|
|
Flag to indicate whether volume is bootable.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_show">
|
|
<title>cinder show</title>
|
|
<screen><computeroutput>usage: cinder show <volume></computeroutput></screen>
|
|
<para>
|
|
Shows volume details.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume></command></term>
|
|
<listitem>
|
|
<para>
|
|
Volume name or ID.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_snapshot-create">
|
|
<title>cinder snapshot-create</title>
|
|
<screen><computeroutput>usage: cinder snapshot-create [--force <True|False>]
|
|
[--display-name <display-name>]
|
|
[--display-description <display-description>]
|
|
<volume></computeroutput></screen>
|
|
<para>
|
|
Creates a snapshot.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of volume to snapshot.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--force <True|False></command></term>
|
|
<listitem>
|
|
<para>
|
|
Allows or disallows snapshot of a volume when the
|
|
volume is attached to an instance. If set to True,
|
|
ignores the current status of the volume when
|
|
attempting to snapshot it rather than forcing it to be
|
|
available. Default=False.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--display-name <display-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
The snapshot name. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--display-description <display-description></command></term>
|
|
<listitem>
|
|
<para>
|
|
The snapshot description. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_snapshot-delete">
|
|
<title>cinder snapshot-delete</title>
|
|
<screen><computeroutput>usage: cinder snapshot-delete <snapshot> [<snapshot> ...]</computeroutput></screen>
|
|
<para>
|
|
Remove one or more snapshots.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><snapshot></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of the snapshot(s) to delete.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_snapshot-list">
|
|
<title>cinder snapshot-list</title>
|
|
<screen><computeroutput>usage: cinder snapshot-list [--all-tenants [<0|1>]]
|
|
[--display-name <display-name>]
|
|
[--status <status>] [--volume-id <volume-id>]</computeroutput></screen>
|
|
<para>
|
|
Lists all snapshots.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--all-tenants [<0|1>]</command></term>
|
|
<listitem>
|
|
<para>
|
|
Shows details for all tenants. Admin only.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--display-name <display-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Filters list by a display name. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--status <status></command></term>
|
|
<listitem>
|
|
<para>
|
|
Filters list by a status. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--volume-id <volume-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
Filters list by a volume ID. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_snapshot-metadata">
|
|
<title>cinder snapshot-metadata</title>
|
|
<screen><computeroutput>usage: cinder snapshot-metadata <snapshot> <action> <key=value>
|
|
[<key=value> ...]</computeroutput></screen>
|
|
<para>
|
|
Sets or deletes snapshot metadata.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><snapshot></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of snapshot for which to update metadata.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><action></command></term>
|
|
<listitem>
|
|
<para>
|
|
The action. Valid values are "set" or "unset."
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><key=value></command></term>
|
|
<listitem>
|
|
<para>
|
|
The metadata key and value pair to set or unset. For unset,
|
|
specify only the key.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_snapshot-metadata-show">
|
|
<title>cinder snapshot-metadata-show</title>
|
|
<screen><computeroutput>usage: cinder snapshot-metadata-show <snapshot></computeroutput></screen>
|
|
<para>
|
|
Shows snapshot metadata.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><snapshot></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</title>
|
|
<screen><computeroutput>usage: cinder snapshot-metadata-update-all <snapshot> <key=value>
|
|
[<key=value> ...]</computeroutput></screen>
|
|
<para>
|
|
Updates snapshot metadata.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><snapshot></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of snapshot for which to update metadata.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><key=value></command></term>
|
|
<listitem>
|
|
<para>
|
|
Metadata key and value pair or pairs to update. Default=[].
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_snapshot-rename">
|
|
<title>cinder snapshot-rename</title>
|
|
<screen><computeroutput>usage: cinder snapshot-rename [--display-description <display-description>]
|
|
<snapshot> [<display-name>]</computeroutput></screen>
|
|
<para>
|
|
Renames a snapshot.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><snapshot></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of snapshot.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><display-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
New display name for snapshot.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--display-description <display-description></command></term>
|
|
<listitem>
|
|
<para>
|
|
Snapshot description. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_snapshot-reset-state">
|
|
<title>cinder snapshot-reset-state</title>
|
|
<screen><computeroutput>usage: cinder snapshot-reset-state [--state <state>]
|
|
<snapshot> [<snapshot> ...]</computeroutput></screen>
|
|
<para>
|
|
Explicitly updates the snapshot state.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><snapshot></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of snapshot to modify.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--state <state></command></term>
|
|
<listitem>
|
|
<para>
|
|
The state to assign to the snapshot. Valid values are
|
|
"available," "error," "creating," "deleting," and
|
|
"error_deleting." NOTE: This command simply changes the
|
|
state of the Snapshot in the DataBase with no regard to
|
|
actual status, exercise caution when using.
|
|
Default=available.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_snapshot-show">
|
|
<title>cinder snapshot-show</title>
|
|
<screen><computeroutput>usage: cinder snapshot-show <snapshot></computeroutput></screen>
|
|
<para>
|
|
Shows snapshot details.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><snapshot></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of snapshot.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_transfer-accept">
|
|
<title>cinder transfer-accept</title>
|
|
<screen><computeroutput>usage: cinder transfer-accept <transfer> <auth_key></computeroutput></screen>
|
|
<para>
|
|
Accepts a volume transfer.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><transfer></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of transfer to accept.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><auth_key></command></term>
|
|
<listitem>
|
|
<para>
|
|
Authentication key of transfer to accept.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_transfer-create">
|
|
<title>cinder transfer-create</title>
|
|
<screen><computeroutput>usage: cinder transfer-create [--display-name <display-name>] <volume></computeroutput></screen>
|
|
<para>
|
|
Creates a volume transfer.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of volume to transfer.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--display-name <display-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Transfer name. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_transfer-delete">
|
|
<title>cinder transfer-delete</title>
|
|
<screen><computeroutput>usage: cinder transfer-delete <transfer></computeroutput></screen>
|
|
<para>
|
|
Undoes a transfer.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><transfer></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of transfer to delete.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_transfer-list">
|
|
<title>cinder transfer-list</title>
|
|
<screen><computeroutput>usage: cinder transfer-list [--all-tenants [<0|1>]]</computeroutput></screen>
|
|
<para>
|
|
Lists all transfers.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--all-tenants [<0|1>]</command></term>
|
|
<listitem>
|
|
<para>
|
|
Shows details for all tenants. Admin only.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_transfer-show">
|
|
<title>cinder transfer-show</title>
|
|
<screen><computeroutput>usage: cinder transfer-show <transfer></computeroutput></screen>
|
|
<para>
|
|
Show transfer details.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><transfer></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of transfer to accept.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_type-create">
|
|
<title>cinder type-create</title>
|
|
<screen><computeroutput>usage: cinder type-create <name></computeroutput></screen>
|
|
<para>
|
|
Creates a volume type.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name for the volume type.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_type-delete">
|
|
<title>cinder type-delete</title>
|
|
<screen><computeroutput>usage: cinder type-delete <id></computeroutput></screen>
|
|
<para>
|
|
Deletes a specified volume type.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><id></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of volume type to delete.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_type-key">
|
|
<title>cinder type-key</title>
|
|
<screen><computeroutput>usage: cinder type-key <vtype> <action> [<key=value> [<key=value> ...]]</computeroutput></screen>
|
|
<para>
|
|
Sets or unsets extra_spec for a volume type.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><vtype></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of volume type.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><action></command></term>
|
|
<listitem>
|
|
<para>
|
|
The action. Valid values are "set" or "unset."
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><key=value></command></term>
|
|
<listitem>
|
|
<para>
|
|
The extra specs key and value pair to set or unset. For unset,
|
|
specify only the key. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_type-list">
|
|
<title>cinder type-list</title>
|
|
<screen><computeroutput>usage: cinder type-list</computeroutput></screen>
|
|
<para>
|
|
Lists available 'volume types'.
|
|
</para>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_upload-to-image">
|
|
<title>cinder upload-to-image</title>
|
|
<screen><computeroutput>usage: cinder upload-to-image [--force <True|False>]
|
|
[--container-format <container-format>]
|
|
[--disk-format <disk-format>]
|
|
<volume> <image-name></computeroutput></screen>
|
|
<para>
|
|
Uploads volume to Image Service as an image.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of volume to upload to an image.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><image-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
The new image name.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--force <True|False></command></term>
|
|
<listitem>
|
|
<para>
|
|
Enables or disables upload of a volume that is
|
|
attached to an instance. Default=False.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--container-format <container-format></command></term>
|
|
<listitem>
|
|
<para>
|
|
Container format type. Default is bare.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--disk-format <disk-format></command></term>
|
|
<listitem>
|
|
<para>
|
|
Disk format type. Default is raw.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
</section>
|
|
|
|
<section xml:id="cinder_cli_v2">
|
|
<title>Block Storage API v2 commands</title>
|
|
<para>
|
|
You can select an API version to use by adding the
|
|
<parameter>--os-volume-api-version</parameter> parameter or by setting
|
|
the corresponding environment variable:
|
|
<screen><prompt>$</prompt> <userinput>export OS_VOLUME_API_VERSION=2</userinput></screen>
|
|
</para>
|
|
<section xml:id="cinderclient_subcommand_absolute-limits_v2">
|
|
<title>cinder absolute-limits (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 absolute-limits</computeroutput></screen>
|
|
<para>
|
|
Lists absolute limits for a user.
|
|
</para>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_availability-zone-list_v2">
|
|
<title>cinder availability-zone-list (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 availability-zone-list</computeroutput></screen>
|
|
<para>
|
|
Lists all availability zones.
|
|
</para>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_backup-create_v2">
|
|
<title>cinder backup-create (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 backup-create [--container <container>] [--name <name>]
|
|
[--description <description>] [--incremental]
|
|
<volume></computeroutput></screen>
|
|
<para>
|
|
Creates a volume backup.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of volume to backup.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--container <container></command></term>
|
|
<listitem>
|
|
<para>
|
|
Backup container name. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--name <name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Backup name. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--description <description></command></term>
|
|
<listitem>
|
|
<para>
|
|
Backup description. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--incremental</command></term>
|
|
<listitem>
|
|
<para>
|
|
Incremental backup. Default=False.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_backup-delete_v2">
|
|
<title>cinder backup-delete (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 backup-delete <backup></computeroutput></screen>
|
|
<para>
|
|
Removes a backup.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><backup></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of backup to delete.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_backup-export_v2">
|
|
<title>cinder backup-export (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 backup-export <backup></computeroutput></screen>
|
|
<para>
|
|
Export backup metadata record.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><backup></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of the backup to export.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_backup-import_v2">
|
|
<title>cinder backup-import (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 backup-import <backup_service> <backup_url></computeroutput></screen>
|
|
<para>
|
|
Import backup metadata record.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><backup_service></command></term>
|
|
<listitem>
|
|
<para>
|
|
Backup service to use for importing the backup.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><backup_url></command></term>
|
|
<listitem>
|
|
<para>
|
|
Backup URL for importing the backup metadata.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_backup-list_v2">
|
|
<title>cinder backup-list (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 backup-list</computeroutput></screen>
|
|
<para>
|
|
Lists all backups.
|
|
</para>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_backup-restore_v2">
|
|
<title>cinder backup-restore (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 backup-restore [--volume <volume>] <backup></computeroutput></screen>
|
|
<para>
|
|
Restores a backup.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><backup></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of backup to restore.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--volume <volume></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of volume to which to restore. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_backup-show_v2">
|
|
<title>cinder backup-show (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 backup-show <backup></computeroutput></screen>
|
|
<para>
|
|
Shows backup details.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><backup></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of backup.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_cgsnapshot-create_v2">
|
|
<title>cinder cgsnapshot-create (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 cgsnapshot-create [--name <name>] [--description <description>]
|
|
<consistencygroup></computeroutput></screen>
|
|
<para>
|
|
Creates a cgsnapshot.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><consistencygroup></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of a consistency group.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--name <name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Cgsnapshot name. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--description <description></command></term>
|
|
<listitem>
|
|
<para>
|
|
Cgsnapshot description. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_cgsnapshot-delete_v2">
|
|
<title>cinder cgsnapshot-delete (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 cgsnapshot-delete <cgsnapshot> [<cgsnapshot> ...]</computeroutput></screen>
|
|
<para>
|
|
Removes one or more cgsnapshots.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><cgsnapshot></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of one or more cgsnapshots to be deleted.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_cgsnapshot-list_v2">
|
|
<title>cinder cgsnapshot-list (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 cgsnapshot-list [--all-tenants [<0|1>]] [--status <status>]
|
|
[--consistencygroup-id <consistencygroup_id>]</computeroutput></screen>
|
|
<para>
|
|
Lists all cgsnapshots.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--all-tenants [<0|1>]</command></term>
|
|
<listitem>
|
|
<para>
|
|
Shows details for all tenants. Admin only.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--status <status></command></term>
|
|
<listitem>
|
|
<para>
|
|
Filters results by a status. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--consistencygroup-id <consistencygroup_id></command></term>
|
|
<listitem>
|
|
<para>
|
|
Filters results by a consistency group ID.
|
|
Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_cgsnapshot-show_v2">
|
|
<title>cinder cgsnapshot-show (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 cgsnapshot-show <cgsnapshot></computeroutput></screen>
|
|
<para>
|
|
Shows cgsnapshot details.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><cgsnapshot></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of cgsnapshot.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_consisgroup-create_v2">
|
|
<title>cinder consisgroup-create (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 consisgroup-create [--name <name>] [--description <description>]
|
|
[--availability-zone <availability-zone>]
|
|
<volume-types></computeroutput></screen>
|
|
<para>
|
|
Creates a consistency group.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume-types></command></term>
|
|
<listitem>
|
|
<para>
|
|
Volume types.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--name <name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of a consistency group.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--description <description></command></term>
|
|
<listitem>
|
|
<para>
|
|
Description of a consistency group. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--availability-zone <availability-zone></command></term>
|
|
<listitem>
|
|
<para>
|
|
Availability zone for volume. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_consisgroup-create-from-src_v2">
|
|
<title>cinder consisgroup-create-from-src (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 consisgroup-create-from-src [--cgsnapshot <cgsnapshot>]
|
|
[--name <name>]
|
|
[--description <description>]</computeroutput></screen>
|
|
<para>
|
|
Creates a consistency group from a cgsnapshot.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--cgsnapshot <cgsnapshot></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of a cgsnapshot. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--name <name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of a consistency group. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--description <description></command></term>
|
|
<listitem>
|
|
<para>
|
|
Description of a consistency group. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_consisgroup-delete_v2">
|
|
<title>cinder consisgroup-delete (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 consisgroup-delete [--force]
|
|
<consistencygroup> [<consistencygroup> ...]</computeroutput></screen>
|
|
<para>
|
|
Removes one or more consistency groups.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><consistencygroup></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of one or more consistency groups to be
|
|
deleted.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--force</command></term>
|
|
<listitem>
|
|
<para>
|
|
Allows or disallows consistency groups to be deleted. If
|
|
the consistency group is empty, it can be deleted
|
|
without the force flag. If the consistency group is not
|
|
empty, the force flag is required for it to be deleted.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_consisgroup-list_v2">
|
|
<title>cinder consisgroup-list (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 consisgroup-list [--all-tenants [<0|1>]]</computeroutput></screen>
|
|
<para>
|
|
Lists all consistencygroups.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--all-tenants [<0|1>]</command></term>
|
|
<listitem>
|
|
<para>
|
|
Shows details for all tenants. Admin only.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_consisgroup-show_v2">
|
|
<title>cinder consisgroup-show (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 consisgroup-show <consistencygroup></computeroutput></screen>
|
|
<para>
|
|
Shows details of a consistency group.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><consistencygroup></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of a consistency group.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_consisgroup-update_v2">
|
|
<title>cinder consisgroup-update (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 consisgroup-update [--name <name>] [--description <description>]
|
|
[--add-volumes <uuid1,uuid2,......>]
|
|
[--remove-volumes <uuid3,uuid4,......>]
|
|
<consistencygroup></computeroutput></screen>
|
|
<para>
|
|
Updates a consistencygroup.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><consistencygroup></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of a consistency group.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--name <name></command></term>
|
|
<listitem>
|
|
<para>
|
|
New name for consistency group. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--description <description></command></term>
|
|
<listitem>
|
|
<para>
|
|
New description for consistency group. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--add-volumes <uuid1,uuid2,......></command></term>
|
|
<listitem>
|
|
<para>
|
|
UUID of one or more volumes to be added to the
|
|
consistency group, separated by commas. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--remove-volumes <uuid3,uuid4,......></command></term>
|
|
<listitem>
|
|
<para>
|
|
UUID of one or more volumes to be removed from the
|
|
consistency group, separated by commas. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_create_v2">
|
|
<title>cinder create (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 create [--consisgroup-id <consistencygroup-id>]
|
|
[--snapshot-id <snapshot-id>]
|
|
[--source-volid <source-volid>]
|
|
[--source-replica <source-replica>]
|
|
[--image-id <image-id>] [--image <image>] [--name <name>]
|
|
[--description <description>]
|
|
[--volume-type <volume-type>]
|
|
[--availability-zone <availability-zone>]
|
|
[--metadata [<key=value> [<key=value> ...]]]
|
|
[--hint <key=value>]
|
|
[<size>]</computeroutput></screen>
|
|
<para>
|
|
Creates a volume.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><size></command></term>
|
|
<listitem>
|
|
<para>
|
|
Size of volume, in GBs. (Required unless snapshot-id
|
|
/source-volid is specified).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--consisgroup-id <consistencygroup-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of a consistency group where the new volume belongs
|
|
to. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--snapshot-id <snapshot-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
Creates volume from snapshot ID. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--source-volid <source-volid></command></term>
|
|
<listitem>
|
|
<para>
|
|
Creates volume from volume ID. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--source-replica <source-replica></command></term>
|
|
<listitem>
|
|
<para>
|
|
Creates volume from replicated volume ID.
|
|
Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--image-id <image-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
Creates volume from image ID. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--image <image></command></term>
|
|
<listitem>
|
|
<para>
|
|
Creates a volume from image (ID or name).
|
|
Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--name <name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Volume name. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--description <description></command></term>
|
|
<listitem>
|
|
<para>
|
|
Volume description. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--volume-type <volume-type></command></term>
|
|
<listitem>
|
|
<para>
|
|
Volume type. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--availability-zone <availability-zone></command></term>
|
|
<listitem>
|
|
<para>
|
|
Availability zone for volume. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--metadata [<key=value> [<key=value> ...]]</command></term>
|
|
<listitem>
|
|
<para>
|
|
Metadata key and value pairs. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--hint <key=value></command></term>
|
|
<listitem>
|
|
<para>
|
|
Scheduler hint, like in nova.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_credentials_v2">
|
|
<title>cinder credentials (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 credentials</computeroutput></screen>
|
|
<para>
|
|
Shows user credentials returned from auth.
|
|
</para>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_delete_v2">
|
|
<title>cinder delete (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 delete <volume> [<volume> ...]</computeroutput></screen>
|
|
<para>
|
|
Removes one or more volumes.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of volume or volumes to delete.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_encryption-type-create_v2">
|
|
<title>cinder encryption-type-create (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 encryption-type-create [--cipher <cipher>]
|
|
[--key_size <key_size>]
|
|
[--control_location <control_location>]
|
|
<volume_type> <provider></computeroutput></screen>
|
|
<para>
|
|
Creates encryption type for a volume type. Admin only.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume_type></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of volume type.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><provider></command></term>
|
|
<listitem>
|
|
<para>
|
|
The class that provides encryption support. For
|
|
example, LuksEncryptor.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--cipher <cipher></command></term>
|
|
<listitem>
|
|
<para>
|
|
The encryption algorithm or mode. For example, aes-
|
|
xts-plain64. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--key_size <key_size></command></term>
|
|
<listitem>
|
|
<para>
|
|
Size of encryption key, in bits. For example, 128 or
|
|
256. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--control_location <control_location></command></term>
|
|
<listitem>
|
|
<para>
|
|
Notional service where encryption is performed. Valid
|
|
values are "front-end" or "back-end." For example,
|
|
front-end=Nova. Default is "front-end."
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_encryption-type-delete_v2">
|
|
<title>cinder encryption-type-delete (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 encryption-type-delete <volume_type></computeroutput></screen>
|
|
<para>
|
|
Deletes encryption type for a volume type. Admin only.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume_type></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of volume type.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_encryption-type-list_v2">
|
|
<title>cinder encryption-type-list (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 encryption-type-list</computeroutput></screen>
|
|
<para>
|
|
Shows encryption type details for volume types. Admin only.
|
|
</para>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_encryption-type-show_v2">
|
|
<title>cinder encryption-type-show (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 encryption-type-show <volume_type></computeroutput></screen>
|
|
<para>
|
|
Shows encryption type details for a volume type. Admin only.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume_type></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of volume type.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_endpoints_v2">
|
|
<title>cinder endpoints (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 endpoints</computeroutput></screen>
|
|
<para>
|
|
Discovers endpoints registered by authentication service.
|
|
</para>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_extend_v2">
|
|
<title>cinder extend (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 extend <volume> <new_size></computeroutput></screen>
|
|
<para>
|
|
Attempts to extend size of an existing volume.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of volume to extend.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><new_size></command></term>
|
|
<listitem>
|
|
<para>
|
|
New size of volume, in GBs.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_extra-specs-list_v2">
|
|
<title>cinder extra-specs-list (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 extra-specs-list</computeroutput></screen>
|
|
<para>
|
|
Lists current volume types and extra specs.
|
|
</para>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_force-delete_v2">
|
|
<title>cinder force-delete (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 force-delete <volume> [<volume> ...]</computeroutput></screen>
|
|
<para>
|
|
Attempts force-delete of volume, regardless of state.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of volume or volumes to delete.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_get-pools_v2">
|
|
<title>cinder get-pools (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 get-pools [--detail]</computeroutput></screen>
|
|
<para>
|
|
Show pool information for backends. Admin only.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--detail</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information about pools.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_list_v2">
|
|
<title>cinder list (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 list [--all-tenants [<0|1>]] [--name <name>] [--status <status>]
|
|
[--metadata [<key=value> [<key=value> ...]]]
|
|
[--marker <marker>] [--limit <limit>]
|
|
[--sort <key>[:<direction>]] [--tenant [<tenant>]]</computeroutput></screen>
|
|
<para>
|
|
Lists all volumes.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--all-tenants [<0|1>]</command></term>
|
|
<listitem>
|
|
<para>
|
|
Shows details for all tenants. Admin only.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--name <name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Filters results by a name. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--status <status></command></term>
|
|
<listitem>
|
|
<para>
|
|
Filters results by a status. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--metadata [<key=value> [<key=value> ...]]</command></term>
|
|
<listitem>
|
|
<para>
|
|
Filters results by a metadata key and value pair.
|
|
Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--marker <marker></command></term>
|
|
<listitem>
|
|
<para>
|
|
Begin returning volumes that appear later in the
|
|
volume list than that represented by this volume id.
|
|
Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--limit <limit></command></term>
|
|
<listitem>
|
|
<para>
|
|
Maximum number of volumes to return. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--sort <key>[:<direction>]</command></term>
|
|
<listitem>
|
|
<para>
|
|
Comma-separated list of sort keys and directions in
|
|
the form of <key>[:<asc|desc>]. Valid keys: id,
|
|
status, size, availability_zone, name, bootable,
|
|
created_at. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--tenant [<tenant>]</command></term>
|
|
<listitem>
|
|
<para>
|
|
Display information from single tenant (Admin only).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_list-extensions_v2">
|
|
<title>cinder list-extensions (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 list-extensions</computeroutput></screen>
|
|
<para>
|
|
Lists all available os-api extensions.
|
|
</para>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_manage_v2">
|
|
<title>cinder manage (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 manage [--id-type <id-type>] [--name <name>]
|
|
[--description <description>]
|
|
[--volume-type <volume-type>]
|
|
[--availability-zone <availability-zone>]
|
|
[--metadata [<key=value> [<key=value> ...]]] [--bootable]
|
|
<host> <identifier></computeroutput></screen>
|
|
<para>
|
|
Manage an existing volume.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><host></command></term>
|
|
<listitem>
|
|
<para>
|
|
Cinder host on which the existing volume resides;
|
|
takes the form: host@backend-name#pool
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><identifier></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or other Identifier for existing volume
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--id-type <id-type></command></term>
|
|
<listitem>
|
|
<para>
|
|
Type of backend device identifier provided, typically
|
|
source-name or source-id (Default=source-name)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--name <name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Volume name (Default=None)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--description <description></command></term>
|
|
<listitem>
|
|
<para>
|
|
Volume description (Default=None)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--volume-type <volume-type></command></term>
|
|
<listitem>
|
|
<para>
|
|
Volume type (Default=None)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--availability-zone <availability-zone></command></term>
|
|
<listitem>
|
|
<para>
|
|
Availability zone for volume (Default=None)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--metadata [<key=value> [<key=value> ...]]</command></term>
|
|
<listitem>
|
|
<para>
|
|
Metadata key=value pairs (Default=None)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--bootable</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specifies that the newly created volume should be
|
|
marked as bootable
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_metadata_v2">
|
|
<title>cinder metadata (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 metadata <volume> <action> <key=value> [<key=value> ...]</computeroutput></screen>
|
|
<para>
|
|
Sets or deletes volume metadata.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of volume for which to update metadata.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><action></command></term>
|
|
<listitem>
|
|
<para>
|
|
The action. Valid values are "set" or "unset."
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><key=value></command></term>
|
|
<listitem>
|
|
<para>
|
|
Metadata key and value pair to set or unset. For unset, specify
|
|
only the key.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_metadata-show_v2">
|
|
<title>cinder metadata-show (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 metadata-show <volume></computeroutput></screen>
|
|
<para>
|
|
Shows volume metadata.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of volume.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_metadata-update-all_v2">
|
|
<title>cinder metadata-update-all (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 metadata-update-all <volume> <key=value> [<key=value> ...]</computeroutput></screen>
|
|
<para>
|
|
Updates volume metadata.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of volume for which to update metadata.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><key=value></command></term>
|
|
<listitem>
|
|
<para>
|
|
Metadata key and value pair or pairs to update.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_migrate_v2">
|
|
<title>cinder migrate (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 migrate [--force-host-copy [<True|False>]] <volume> <host></computeroutput></screen>
|
|
<para>
|
|
Migrates volume to a new host.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of volume to migrate.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><host></command></term>
|
|
<listitem>
|
|
<para>
|
|
Destination host.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--force-host-copy [<True|False>]</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="cinderclient_subcommand_qos-associate_v2">
|
|
<title>cinder qos-associate (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 qos-associate <qos_specs> <volume_type_id></computeroutput></screen>
|
|
<para>
|
|
Associates qos specs with specified volume type.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><qos_specs></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of QoS specifications.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><volume_type_id></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of volume type with which to associate QoS
|
|
specifications.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_qos-create_v2">
|
|
<title>cinder qos-create (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 qos-create <name> <key=value> [<key=value> ...]</computeroutput></screen>
|
|
<para>
|
|
Creates a qos specs.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of new QoS specifications.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><key=value></command></term>
|
|
<listitem>
|
|
<para>
|
|
QoS specifications.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_qos-delete_v2">
|
|
<title>cinder qos-delete (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 qos-delete [--force [<True|False>]] <qos_specs></computeroutput></screen>
|
|
<para>
|
|
Deletes a specified qos specs.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><qos_specs></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of QoS specifications to delete.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--force [<True|False>]</command></term>
|
|
<listitem>
|
|
<para>
|
|
Enables or disables deletion of in-use QoS
|
|
specifications. Default=False.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_qos-disassociate_v2">
|
|
<title>cinder qos-disassociate (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 qos-disassociate <qos_specs> <volume_type_id></computeroutput></screen>
|
|
<para>
|
|
Disassociates qos specs from specified volume type.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><qos_specs></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of QoS specifications.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><volume_type_id></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of volume type with which to associate QoS
|
|
specifications.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_qos-disassociate-all_v2">
|
|
<title>cinder qos-disassociate-all (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 qos-disassociate-all <qos_specs></computeroutput></screen>
|
|
<para>
|
|
Disassociates qos specs from all its associations.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><qos_specs></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of QoS specifications on which to operate.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_qos-get-association_v2">
|
|
<title>cinder qos-get-association (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 qos-get-association <qos_specs></computeroutput></screen>
|
|
<para>
|
|
Lists all associations for specified qos specs.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><qos_specs></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of QoS specifications.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_qos-key_v2">
|
|
<title>cinder qos-key (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 qos-key <qos_specs> <action> key=value [key=value ...]</computeroutput></screen>
|
|
<para>
|
|
Sets or unsets specifications for a qos spec.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><qos_specs></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of QoS specifications.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><action></command></term>
|
|
<listitem>
|
|
<para>
|
|
The action. Valid values are "set" or "unset."
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>key=value</command></term>
|
|
<listitem>
|
|
<para>
|
|
Metadata key and value pair to set or unset. For unset, specify
|
|
only the key.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_qos-list_v2">
|
|
<title>cinder qos-list (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 qos-list</computeroutput></screen>
|
|
<para>
|
|
Lists qos specs.
|
|
</para>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_qos-show_v2">
|
|
<title>cinder qos-show (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 qos-show <qos_specs></computeroutput></screen>
|
|
<para>
|
|
Shows qos specs details.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><qos_specs></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of QoS specifications to show.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_quota-class-show_v2">
|
|
<title>cinder quota-class-show (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 quota-class-show <class></computeroutput></screen>
|
|
<para>
|
|
Lists quotas for a quota class.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><class></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of quota class for which to list quotas.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_quota-class-update_v2">
|
|
<title>cinder quota-class-update (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 quota-class-update [--volumes <volumes>]
|
|
[--snapshots <snapshots>]
|
|
[--gigabytes <gigabytes>]
|
|
[--volume-type <volume_type_name>]
|
|
<class-name></computeroutput></screen>
|
|
<para>
|
|
Updates quotas for a quota class.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><class-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of quota class for which to set quotas.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--volumes <volumes></command></term>
|
|
<listitem>
|
|
<para>
|
|
The new "volumes" quota value. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--snapshots <snapshots></command></term>
|
|
<listitem>
|
|
<para>
|
|
The new "snapshots" quota value. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--gigabytes <gigabytes></command></term>
|
|
<listitem>
|
|
<para>
|
|
The new "gigabytes" quota value. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--volume-type <volume_type_name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Volume type. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_quota-defaults_v2">
|
|
<title>cinder quota-defaults (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 quota-defaults <tenant_id></computeroutput></screen>
|
|
<para>
|
|
Lists default quotas for a tenant.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><tenant_id></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of tenant for which to list quota defaults.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_quota-delete_v2">
|
|
<title>cinder quota-delete (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 quota-delete <tenant_id></computeroutput></screen>
|
|
<para>
|
|
Delete the quotas for a tenant.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><tenant_id></command></term>
|
|
<listitem>
|
|
<para>
|
|
UUID of tenant to delete the quotas for.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_quota-show_v2">
|
|
<title>cinder quota-show (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 quota-show <tenant_id></computeroutput></screen>
|
|
<para>
|
|
Lists quotas for a tenant.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><tenant_id></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of tenant for which to list quotas.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_quota-update_v2">
|
|
<title>cinder quota-update (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 quota-update [--volumes <volumes>] [--snapshots <snapshots>]
|
|
[--gigabytes <gigabytes>] [--backups <backups>]
|
|
[--backup-gigabytes <backup_gigabytes>]
|
|
[--consistencygroups <consistencygroups>]
|
|
[--volume-type <volume_type_name>]
|
|
<tenant_id></computeroutput></screen>
|
|
<para>
|
|
Updates quotas for a tenant.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><tenant_id></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of tenant for which to set quotas.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--volumes <volumes></command></term>
|
|
<listitem>
|
|
<para>
|
|
The new "volumes" quota value. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--snapshots <snapshots></command></term>
|
|
<listitem>
|
|
<para>
|
|
The new "snapshots" quota value. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--gigabytes <gigabytes></command></term>
|
|
<listitem>
|
|
<para>
|
|
The new "gigabytes" quota value. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--backups <backups></command></term>
|
|
<listitem>
|
|
<para>
|
|
The new "backups" quota value. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--backup-gigabytes <backup_gigabytes></command></term>
|
|
<listitem>
|
|
<para>
|
|
The new "backup_gigabytes" quota value. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--consistencygroups <consistencygroups></command></term>
|
|
<listitem>
|
|
<para>
|
|
The new "consistencygroups" quota value. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--volume-type <volume_type_name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Volume type. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_quota-usage_v2">
|
|
<title>cinder quota-usage (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 quota-usage <tenant_id></computeroutput></screen>
|
|
<para>
|
|
Lists quota usage for a tenant.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><tenant_id></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of tenant for which to list quota usage.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_rate-limits_v2">
|
|
<title>cinder rate-limits (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 rate-limits</computeroutput></screen>
|
|
<para>
|
|
Lists rate limits for a user.
|
|
</para>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_readonly-mode-update_v2">
|
|
<title>cinder readonly-mode-update (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 readonly-mode-update <volume> <True|true|False|false></computeroutput></screen>
|
|
<para>
|
|
Updates volume read-only access-mode flag.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of volume to update.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><True|true|False|false></command></term>
|
|
<listitem>
|
|
<para>
|
|
Enables or disables update of volume to read-only
|
|
access mode.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_rename_v2">
|
|
<title>cinder rename (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 rename [--description <description>] <volume> [<name>]</computeroutput></screen>
|
|
<para>
|
|
Renames a volume.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of volume to rename.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><name></command></term>
|
|
<listitem>
|
|
<para>
|
|
New name for volume.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--description <description></command></term>
|
|
<listitem>
|
|
<para>
|
|
Volume description. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_replication-promote_v2">
|
|
<title>cinder replication-promote (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 replication-promote <volume></computeroutput></screen>
|
|
<para>
|
|
Promote a secondary volume to primary for a relationship.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of the volume to promote.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_replication-reenable_v2">
|
|
<title>cinder replication-reenable (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 replication-reenable <volume></computeroutput></screen>
|
|
<para>
|
|
Sync the secondary volume with primary for a relationship.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of the volume to reenable replication.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_reset-state_v2">
|
|
<title>cinder reset-state (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 reset-state [--state <state>] <volume> [<volume> ...]</computeroutput></screen>
|
|
<para>
|
|
Explicitly updates the volume state in the Cinder database. Note that this
|
|
does not affect whether the volume is actually attached to the Nova compute
|
|
host or instance and can result in an unusable volume. Being a database change
|
|
only, this has no impact on the true state of the volume and may not match the
|
|
actual state. This can render a volume unusable in the case of change to the
|
|
'available' state.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of volume to modify.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--state <state></command></term>
|
|
<listitem>
|
|
<para>
|
|
The state to assign to the volume. Valid values are
|
|
"available," "error," "creating," "deleting," "in-use,"
|
|
"attaching," "detaching" and "error_deleting." NOTE: This
|
|
command simply changes the state of the Volume in the
|
|
DataBase with no regard to actual status, exercise caution
|
|
when using. Default=available.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_retype_v2">
|
|
<title>cinder retype (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 retype [--migration-policy <never|on-demand>]
|
|
<volume> <volume-type></computeroutput></screen>
|
|
<para>
|
|
Changes the volume type for a volume.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of volume for which to modify type.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><volume-type></command></term>
|
|
<listitem>
|
|
<para>
|
|
New volume type.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--migration-policy <never|on-demand></command></term>
|
|
<listitem>
|
|
<para>
|
|
Migration policy during retype of volume.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_service-disable_v2">
|
|
<title>cinder service-disable (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 service-disable [--reason <reason>] <hostname> <binary></computeroutput></screen>
|
|
<para>
|
|
Disables the service.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><hostname></command></term>
|
|
<listitem>
|
|
<para>
|
|
Host name.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><binary></command></term>
|
|
<listitem>
|
|
<para>
|
|
Service binary.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--reason <reason></command></term>
|
|
<listitem>
|
|
<para>
|
|
Reason for disabling service.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_service-enable_v2">
|
|
<title>cinder service-enable (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 service-enable <hostname> <binary></computeroutput></screen>
|
|
<para>
|
|
Enables the service.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><hostname></command></term>
|
|
<listitem>
|
|
<para>
|
|
Host name.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><binary></command></term>
|
|
<listitem>
|
|
<para>
|
|
Service binary.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_service-list_v2">
|
|
<title>cinder service-list (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 service-list [--host <hostname>] [--binary <binary>]</computeroutput></screen>
|
|
<para>
|
|
Lists all services. Filter by host and service binary.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--host <hostname></command></term>
|
|
<listitem>
|
|
<para>
|
|
Host name. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--binary <binary></command></term>
|
|
<listitem>
|
|
<para>
|
|
Service binary. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_set-bootable_v2">
|
|
<title>cinder set-bootable (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 set-bootable <volume> <True|true|False|false></computeroutput></screen>
|
|
<para>
|
|
Update bootable status of a volume.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of the volume to update.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><True|true|False|false></command></term>
|
|
<listitem>
|
|
<para>
|
|
Flag to indicate whether volume is bootable.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_show_v2">
|
|
<title>cinder show (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 show <volume></computeroutput></screen>
|
|
<para>
|
|
Shows volume details.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of volume.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_snapshot-create_v2">
|
|
<title>cinder snapshot-create (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 snapshot-create [--force [<True|False>]] [--name <name>]
|
|
[--description <description>]
|
|
[--metadata [<key=value> [<key=value> ...]]]
|
|
<volume></computeroutput></screen>
|
|
<para>
|
|
Creates a snapshot.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of volume to snapshot.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--force [<True|False>]</command></term>
|
|
<listitem>
|
|
<para>
|
|
Allows or disallows snapshot of a volume when the
|
|
volume is attached to an instance. If set to True,
|
|
ignores the current status of the volume when
|
|
attempting to snapshot it rather than forcing it to be
|
|
available. Default=False.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--name <name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Snapshot name. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--description <description></command></term>
|
|
<listitem>
|
|
<para>
|
|
Snapshot description. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--metadata [<key=value> [<key=value> ...]]</command></term>
|
|
<listitem>
|
|
<para>
|
|
Snapshot metadata key and value pairs. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_snapshot-delete_v2">
|
|
<title>cinder snapshot-delete (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 snapshot-delete <snapshot> [<snapshot> ...]</computeroutput></screen>
|
|
<para>
|
|
Removes one or more snapshots.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><snapshot></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of the snapshot(s) to delete.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_snapshot-list_v2">
|
|
<title>cinder snapshot-list (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 snapshot-list [--all-tenants [<0|1>]] [--name <name>]
|
|
[--status <status>] [--volume-id <volume-id>]</computeroutput></screen>
|
|
<para>
|
|
Lists all snapshots.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--all-tenants [<0|1>]</command></term>
|
|
<listitem>
|
|
<para>
|
|
Shows details for all tenants. Admin only.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--name <name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Filters results by a name. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--status <status></command></term>
|
|
<listitem>
|
|
<para>
|
|
Filters results by a status. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--volume-id <volume-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
Filters results by a volume ID. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_snapshot-metadata_v2">
|
|
<title>cinder snapshot-metadata (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 snapshot-metadata <snapshot> <action> <key=value>
|
|
[<key=value> ...]</computeroutput></screen>
|
|
<para>
|
|
Sets or deletes snapshot metadata.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><snapshot></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of snapshot for which to update metadata.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><action></command></term>
|
|
<listitem>
|
|
<para>
|
|
The action. Valid values are "set" or "unset."
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><key=value></command></term>
|
|
<listitem>
|
|
<para>
|
|
Metadata key and value pair to set or unset. For unset, specify
|
|
only the key.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_snapshot-metadata-show_v2">
|
|
<title>cinder snapshot-metadata-show (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 snapshot-metadata-show <snapshot></computeroutput></screen>
|
|
<para>
|
|
Shows snapshot metadata.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><snapshot></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of snapshot.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_snapshot-metadata-update-all_v2">
|
|
<title>cinder snapshot-metadata-update-all (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 snapshot-metadata-update-all <snapshot> <key=value>
|
|
[<key=value> ...]</computeroutput></screen>
|
|
<para>
|
|
Updates snapshot metadata.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><snapshot></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of snapshot for which to update metadata.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><key=value></command></term>
|
|
<listitem>
|
|
<para>
|
|
Metadata key and value pair to update.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_snapshot-rename_v2">
|
|
<title>cinder snapshot-rename (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 snapshot-rename [--description <description>]
|
|
<snapshot> [<name>]</computeroutput></screen>
|
|
<para>
|
|
Renames a snapshot.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><snapshot></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of snapshot.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><name></command></term>
|
|
<listitem>
|
|
<para>
|
|
New name for snapshot.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--description <description></command></term>
|
|
<listitem>
|
|
<para>
|
|
Snapshot description. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_snapshot-reset-state_v2">
|
|
<title>cinder snapshot-reset-state (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 snapshot-reset-state [--state <state>]
|
|
<snapshot> [<snapshot> ...]</computeroutput></screen>
|
|
<para>
|
|
Explicitly updates the snapshot state.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><snapshot></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of snapshot to modify.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--state <state></command></term>
|
|
<listitem>
|
|
<para>
|
|
The state to assign to the snapshot. Valid values are
|
|
"available," "error," "creating," "deleting," and
|
|
"error_deleting." NOTE: This command simply changes the
|
|
state of the Snapshot in the DataBase with no regard to
|
|
actual status, exercise caution when using.
|
|
Default=available.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_snapshot-show_v2">
|
|
<title>cinder snapshot-show (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 snapshot-show <snapshot></computeroutput></screen>
|
|
<para>
|
|
Shows snapshot details.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><snapshot></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of snapshot.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_transfer-accept_v2">
|
|
<title>cinder transfer-accept (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 transfer-accept <transfer> <auth_key></computeroutput></screen>
|
|
<para>
|
|
Accepts a volume transfer.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><transfer></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of transfer to accept.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><auth_key></command></term>
|
|
<listitem>
|
|
<para>
|
|
Authentication key of transfer to accept.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_transfer-create_v2">
|
|
<title>cinder transfer-create (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 transfer-create [--name <name>] <volume></computeroutput></screen>
|
|
<para>
|
|
Creates a volume transfer.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of volume to transfer.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--name <name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Transfer name. Default=None.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_transfer-delete_v2">
|
|
<title>cinder transfer-delete (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 transfer-delete <transfer></computeroutput></screen>
|
|
<para>
|
|
Undoes a transfer.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><transfer></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of transfer to delete.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_transfer-list_v2">
|
|
<title>cinder transfer-list (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 transfer-list [--all-tenants [<0|1>]]</computeroutput></screen>
|
|
<para>
|
|
Lists all transfers.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--all-tenants [<0|1>]</command></term>
|
|
<listitem>
|
|
<para>
|
|
Shows details for all tenants. Admin only.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_transfer-show_v2">
|
|
<title>cinder transfer-show (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 transfer-show <transfer></computeroutput></screen>
|
|
<para>
|
|
Shows transfer details.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><transfer></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of transfer to accept.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_type-access-add_v2">
|
|
<title>cinder type-access-add (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 type-access-add --volume-type <volume_type> --project-id
|
|
<project_id></computeroutput></screen>
|
|
<para>
|
|
Adds volume type access for the given project.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--volume-type <volume_type></command></term>
|
|
<listitem>
|
|
<para>
|
|
Volume type name or ID to add access for the given
|
|
project.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--project-id <project_id></command></term>
|
|
<listitem>
|
|
<para>
|
|
Project ID to add volume type access for.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_type-access-list_v2">
|
|
<title>cinder type-access-list (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 type-access-list --volume-type <volume_type></computeroutput></screen>
|
|
<para>
|
|
Print access information about the given volume type.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--volume-type <volume_type></command></term>
|
|
<listitem>
|
|
<para>
|
|
Filter results by volume type name or ID.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_type-access-remove_v2">
|
|
<title>cinder type-access-remove (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 type-access-remove --volume-type <volume_type> --project-id
|
|
<project_id></computeroutput></screen>
|
|
<para>
|
|
Removes volume type access for the given project.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--volume-type <volume_type></command></term>
|
|
<listitem>
|
|
<para>
|
|
Volume type name or ID to remove access for the given
|
|
project.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--project-id <project_id></command></term>
|
|
<listitem>
|
|
<para>
|
|
Project ID to remove volume type access for.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_type-create_v2">
|
|
<title>cinder type-create (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 type-create [--description <description>]
|
|
[--is-public <is-public>]
|
|
<name></computeroutput></screen>
|
|
<para>
|
|
Creates a volume type.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of new volume type.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--description <description></command></term>
|
|
<listitem>
|
|
<para>
|
|
Description of new volume type.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--is-public <is-public></command></term>
|
|
<listitem>
|
|
<para>
|
|
Make type accessible to the public (default true).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_type-default_v2">
|
|
<title>cinder type-default (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 type-default</computeroutput></screen>
|
|
<para>
|
|
List the default volume type.
|
|
</para>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_type-delete_v2">
|
|
<title>cinder type-delete (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 type-delete <id></computeroutput></screen>
|
|
<para>
|
|
Deletes a volume type.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><id></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of volume type to delete.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_type-key_v2">
|
|
<title>cinder type-key (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 type-key <vtype> <action> <key=value> [<key=value> ...]</computeroutput></screen>
|
|
<para>
|
|
Sets or unsets extra_spec for a volume type.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><vtype></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of volume type.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><action></command></term>
|
|
<listitem>
|
|
<para>
|
|
The action. Valid values are "set" or "unset."
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><key=value></command></term>
|
|
<listitem>
|
|
<para>
|
|
The extra specs key and value pair to set or unset. For unset,
|
|
specify only the key.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_type-list_v2">
|
|
<title>cinder type-list (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 type-list [--all]</computeroutput></screen>
|
|
<para>
|
|
Lists available 'volume types'.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--all</command></term>
|
|
<listitem>
|
|
<para>
|
|
Display all volume types (Admin only).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_type-update_v2">
|
|
<title>cinder type-update (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 type-update [--name <name>] [--description <description>] <id></computeroutput></screen>
|
|
<para>
|
|
Updates volume type name and/or description.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><id></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of the volume type.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--name <name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of the volume type.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--description <description></command></term>
|
|
<listitem>
|
|
<para>
|
|
Description of the volume type.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_unmanage_v2">
|
|
<title>cinder unmanage (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 unmanage <volume></computeroutput></screen>
|
|
<para>
|
|
Stop managing a volume.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of the volume to unmanage.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="cinderclient_subcommand_upload-to-image_v2">
|
|
<title>cinder upload-to-image (v2)</title>
|
|
<screen><computeroutput>usage: cinder --os-volume-api-version 2 upload-to-image [--force [<True|False>]]
|
|
[--container-format <container-format>]
|
|
[--disk-format <disk-format>]
|
|
<volume> <image-name></computeroutput></screen>
|
|
<para>
|
|
Uploads volume to Image Service as an image.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of volume to snapshot.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><image-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
The new image name.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--force [<True|False>]</command></term>
|
|
<listitem>
|
|
<para>
|
|
Enables or disables upload of a volume that is
|
|
attached to an instance. Default=False.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--container-format <container-format></command></term>
|
|
<listitem>
|
|
<para>
|
|
Container format type. Default is bare.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--disk-format <disk-format></command></term>
|
|
<listitem>
|
|
<para>
|
|
Disk format type. Default is raw.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
</section>
|
|
</chapter>
|