openstack-manuals/doc/cli-reference/generated/ch_cli_cinder_commands.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 service command-line client</title>

    <para>The <command>cinder</command> client is the command-line
        interface (CLI) for the Block Storage service API and its extensions.

       This chapter documents <command>cinder</command> version
        <literal>1.5.0</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 &lt;auth-system&gt;]
              [--service-type &lt;service-type&gt;] [--service-name &lt;service-name&gt;]
              [--volume-service-name &lt;volume-service-name&gt;]
              [--os-endpoint-type &lt;os-endpoint-type&gt;]
              [--endpoint-type &lt;endpoint-type&gt;]
              [--os-volume-api-version &lt;volume-api-ver&gt;]
              [--bypass-url &lt;bypass-url&gt;] [--retries &lt;retries&gt;]
              [--os-auth-strategy &lt;auth-strategy&gt;]
              [--os-username &lt;auth-user-name&gt;] [--os-password &lt;auth-password&gt;]
              [--os-tenant-name &lt;auth-tenant-name&gt;]
              [--os-tenant-id &lt;auth-tenant-id&gt;] [--os-auth-url &lt;auth-url&gt;]
              [--os-user-id &lt;auth-user-id&gt;]
              [--os-user-domain-id &lt;auth-user-domain-id&gt;]
              [--os-user-domain-name &lt;auth-user-domain-name&gt;]
              [--os-project-id &lt;auth-project-id&gt;]
              [--os-project-name &lt;auth-project-name&gt;]
              [--os-project-domain-id &lt;auth-project-domain-id&gt;]
              [--os-project-domain-name &lt;auth-project-domain-name&gt;]
              [--os-region-name &lt;region-name&gt;] [--os-token &lt;token&gt;]
              [--os-url &lt;url&gt;] [--insecure] [--os-cacert &lt;ca-certificate&gt;]
              [--os-cert &lt;certificate&gt;] [--os-key &lt;key&gt;] [--timeout &lt;seconds&gt;]
              &lt;subcommand&gt; ...</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-export</command></term>
    <listitem>
      <para>
        Export backup metadata record.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>backup-import</command></term>
    <listitem>
      <para>
        Import backup metadata record.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>backup-list</command></term>
    <listitem>
      <para>
        Lists all backups.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>backup-reset-state</command></term>
    <listitem>
      <para>
        Explicitly updates the backup state.
      </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>
        Shows backup details.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>cgsnapshot-create</command></term>
    <listitem>
      <para>
        Creates a cgsnapshot.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>cgsnapshot-delete</command></term>
    <listitem>
      <para>
        Removes one or more cgsnapshots.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>cgsnapshot-list</command></term>
    <listitem>
      <para>
        Lists all cgsnapshots.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>cgsnapshot-show</command></term>
    <listitem>
      <para>
        Shows cgsnapshot details.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>consisgroup-create</command></term>
    <listitem>
      <para>
        Creates a consistency group.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>consisgroup-create-from-src</command></term>
    <listitem>
      <para>
      Creates a consistency group from a cgsnapshot or a
      source CG.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>consisgroup-delete</command></term>
    <listitem>
      <para>
        Removes one or more consistency groups.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>consisgroup-list</command></term>
    <listitem>
      <para>
        Lists all consistencygroups.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>consisgroup-show</command></term>
    <listitem>
      <para>
        Shows details of a consistency group.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>consisgroup-update</command></term>
    <listitem>
      <para>
        Updates a consistencygroup.
      </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 a volume type. Admin
      only.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>encryption-type-update</command></term>
    <listitem>
      <para>
      Update encryption type information for a 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>get-capabilities</command></term>
    <listitem>
      <para>
        Show backend volume stats and properties. Admin only.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>get-pools</command></term>
    <listitem>
      <para>
        Show pool information for backends. Admin only.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>image-metadata</command></term>
    <listitem>
      <para>
        Sets or deletes volume image metadata.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>image-metadata-show</command></term>
    <listitem>
      <para>
      Shows volume image metadata.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>list</command></term>
    <listitem>
      <para>
        Lists all volumes.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>manage</command></term>
    <listitem>
      <para>
        Manage an existing volume.
      </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 its associations.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>qos-get-association</command></term>
    <listitem>
      <para>
      Lists 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 qos specs details.
      </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>replication-disable</command></term>
    <listitem>
      <para>
      Disables volume replication on a given volume.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>replication-enable</command></term>
    <listitem>
      <para>
        Enables volume replication on a given volume.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>replication-failover</command></term>
    <listitem>
      <para>
      Failover a volume to a secondary target
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>replication-list-targets</command></term>
    <listitem>
      <para>
      List replication targets available for a volume.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>replication-promote</command></term>
    <listitem>
      <para>
      Promote a secondary volume to primary for a
      relationship.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>replication-reenable</command></term>
    <listitem>
      <para>
      Sync the secondary volume with primary for a
      relationship.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>reset-state</command></term>
    <listitem>
      <para>
        Explicitly updates the volume state in the Cinder
      database.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>retype</command></term>
    <listitem>
      <para>
        Changes the volume type for a volume.
      </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>
        Removes 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>
        Shows transfer details.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>type-access-add</command></term>
    <listitem>
      <para>
        Adds volume type access for the given project.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>type-access-list</command></term>
    <listitem>
      <para>
        Print access information about the given volume type.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>type-access-remove</command></term>
    <listitem>
      <para>
        Removes volume type access for the given project.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>type-create</command></term>
    <listitem>
      <para>
        Creates a volume type.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>type-default</command></term>
    <listitem>
      <para>
        List the default volume type.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>type-delete</command></term>
    <listitem>
      <para>
        Deletes a 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'. (Admin only will see
      private types)
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>type-show</command></term>
    <listitem>
      <para>
        Show volume type details.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>type-update</command></term>
    <listitem>
      <para>
        Updates volume type name ,description and/or
      is_public.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>unmanage</command></term>
    <listitem>
      <para>
        Stop managing a volume.
      </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 &lt;auth-system&gt;</command></term>
    <listitem>
      <para>
      Defaults to <code>env[OS_AUTH_SYSTEM]</code>.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--service-type &lt;service-type&gt;</command></term>
    <listitem>
      <para>
      Service type. For most actions, default is volume.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--service-name &lt;service-name&gt;</command></term>
    <listitem>
      <para>
      Service name. Default=<code>env[CINDER_SERVICE_NAME]</code>.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--volume-service-name &lt;volume-service-name&gt;</command></term>
    <listitem>
      <para>
      Volume service name.
      Default=<code>env[CINDER_VOLUME_SERVICE_NAME]</code>.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--os-endpoint-type &lt;os-endpoint-type&gt;</command></term>
    <listitem>
      <para>
      Endpoint type, which is publicURL or internalURL.
      Default=<code>env[OS_ENDPOINT_TYPE]</code> or nova
      <code>env[CINDER_ENDPOINT_TYPE]</code> or publicURL.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--endpoint-type &lt;endpoint-type&gt;</command></term>
    <listitem>
      <para>
      <emphasis>DEPRECATED!</emphasis> Use --os-endpoint-type.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--os-volume-api-version &lt;volume-api-ver&gt;</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 &lt;bypass-url&gt;</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 &lt;retries&gt;</command></term>
    <listitem>
      <para>
        Number of retries.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--os-auth-strategy &lt;auth-strategy&gt;</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 &lt;auth-user-name&gt;</command></term>
    <listitem>
      <para>
      OpenStack user name. Default=<code>env[OS_USERNAME]</code>.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--os-password &lt;auth-password&gt;</command></term>
    <listitem>
      <para>
      Password for OpenStack user. Default=<code>env[OS_PASSWORD]</code>.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--os-tenant-name &lt;auth-tenant-name&gt;</command></term>
    <listitem>
      <para>
      Tenant name. Default=<code>env[OS_TENANT_NAME]</code>.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--os-tenant-id &lt;auth-tenant-id&gt;</command></term>
    <listitem>
      <para>
      ID for the tenant. Default=<code>env[OS_TENANT_ID]</code>.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--os-auth-url &lt;auth-url&gt;</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 &lt;auth-user-id&gt;</command></term>
    <listitem>
      <para>
      Authentication user ID (Env: OS_USER_ID).
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--os-user-domain-id &lt;auth-user-domain-id&gt;</command></term>
    <listitem>
      <para>
      OpenStack user domain ID. Defaults to
      <code>env[OS_USER_DOMAIN_ID]</code>.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--os-user-domain-name &lt;auth-user-domain-name&gt;</command></term>
    <listitem>
      <para>
      OpenStack user domain name. Defaults to
      <code>env[OS_USER_DOMAIN_NAME]</code>.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--os-project-id &lt;auth-project-id&gt;</command></term>
    <listitem>
      <para>
      Another way to specify tenant ID. This option is
      mutually exclusive with --os-tenant-id. Defaults to
      <code>env[OS_PROJECT_ID]</code>.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--os-project-name &lt;auth-project-name&gt;</command></term>
    <listitem>
      <para>
      Another way to specify tenant name. This option is
      mutually exclusive with --os-tenant-name. Defaults to
      <code>env[OS_PROJECT_NAME]</code>.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--os-project-domain-id &lt;auth-project-domain-id&gt;</command></term>
    <listitem>
      <para>
      Defaults to <code>env[OS_PROJECT_DOMAIN_ID]</code>.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--os-project-domain-name &lt;auth-project-domain-name&gt;</command></term>
    <listitem>
      <para>
      Defaults to <code>env[OS_PROJECT_DOMAIN_NAME]</code>.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--os-region-name &lt;region-name&gt;</command></term>
    <listitem>
      <para>
      Region name. Default=<code>env[OS_REGION_NAME]</code>.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--os-token &lt;token&gt;</command></term>
    <listitem>
      <para>
        Defaults to <code>env[OS_TOKEN]</code>.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--os-url &lt;url&gt;</command></term>
    <listitem>
      <para>
        Defaults to <code>env[OS_URL]</code>.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--insecure</command></term>
    <listitem>
      <para>
        Explicitly allow client to perform "insecure" TLS
      (https) requests. The server's certificate will not be
      verified against any certificate authorities. This
      option should be used with caution.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--os-cacert &lt;ca-certificate&gt;</command></term>
    <listitem>
      <para>
      Specify a CA bundle file to use in verifying a TLS
      (https) server certificate. Defaults to
      <code>env[OS_CACERT]</code>.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--os-cert &lt;certificate&gt;</command></term>
    <listitem>
      <para>
      Defaults to <code>env[OS_CERT]</code>.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--os-key &lt;key&gt;</command></term>
    <listitem>
      <para>
        Defaults to <code>env[OS_KEY]</code>.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--timeout &lt;seconds&gt;</command></term>
    <listitem>
      <para>
        Set request timeout (in seconds).
      </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 &lt;container&gt;] [--name &lt;name&gt;]
                            [--description &lt;description&gt;] [--incremental]
                            [--force]
                            &lt;volume&gt;</computeroutput></screen>
        <para>
Creates a volume backup.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;volume&gt;</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 &lt;container&gt;</command></term>
    <listitem>
      <para>
      Backup container name. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--name &lt;name&gt;</command></term>
    <listitem>
      <para>
        Backup name. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--description &lt;description&gt;</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>
  <varlistentry>
    <term><command>--force</command></term>
    <listitem>
      <para>
        Allows or disallows backup of a volume when the volume
      is attached to an instance. If set to True, backs up
      the volume whether its status is "available" or "in-
      use". The backup of an "in-use" volume means your data
      is crash consistent. Default=False.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="cinderclient_subcommand_backup-delete">
        <title>cinder backup-delete</title>
        <screen><computeroutput>usage: cinder backup-delete &lt;backup&gt;</computeroutput></screen>
        <para>
Removes a backup.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;backup&gt;</command></term>
    <listitem>
      <para>
        Name or ID of backup to delete.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="cinderclient_subcommand_backup-export">
        <title>cinder backup-export</title>
        <screen><computeroutput>usage: cinder backup-export &lt;backup&gt;</computeroutput></screen>
        <para>
Export backup metadata record.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;backup&gt;</command></term>
    <listitem>
      <para>
        ID of the backup to export.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="cinderclient_subcommand_backup-import">
        <title>cinder backup-import</title>
        <screen><computeroutput>usage: cinder backup-import &lt;backup_service&gt; &lt;backup_url&gt;</computeroutput></screen>
        <para>
Import backup metadata record.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;backup_service&gt;</command></term>
    <listitem>
      <para>
        Backup service to use for importing the backup.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;backup_url&gt;</command></term>
    <listitem>
      <para>
        Backup URL for importing the backup metadata.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="cinderclient_subcommand_backup-list">
        <title>cinder backup-list</title>
        <screen><computeroutput>usage: cinder backup-list [--all-tenants [&lt;all_tenants&gt;]] [--name &lt;name&gt;]
                          [--status &lt;status&gt;] [--volume-id &lt;volume-id&gt;]
                          [--marker &lt;marker&gt;] [--limit &lt;limit&gt;]
                          [--sort &lt;key&gt;[:&lt;direction&gt;]]</computeroutput></screen>
        <para>
Lists all backups.
        </para>  <variablelist wordsize="10">
    <title>Optional arguments</title>
  <varlistentry>
    <term><command>--all-tenants [&lt;all_tenants&gt;]</command></term>
    <listitem>
      <para>
      Shows details for all tenants. Admin only.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--name &lt;name&gt;</command></term>
    <listitem>
      <para>
        Filters results by a name. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--status &lt;status&gt;</command></term>
    <listitem>
      <para>
        Filters results by a status. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--volume-id &lt;volume-id&gt;</command></term>
    <listitem>
      <para>
      Filters results by a volume ID. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--marker &lt;marker&gt;</command></term>
    <listitem>
      <para>
        Begin returning backups that appear later in the
      backup list than that represented by this id.
      Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--limit &lt;limit&gt;</command></term>
    <listitem>
      <para>
        Maximum number of backups to return. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--sort &lt;key&gt;[:&lt;direction&gt;]</command></term>
    <listitem>
      <para>
      Comma-separated list of sort keys and directions in
      the form of &lt;key&gt;[:&lt;asc|desc&gt;]. Valid keys: id,
      status, size, availability_zone, name, bootable,
      created_at. Default=None.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="cinderclient_subcommand_backup-reset-state">
        <title>cinder backup-reset-state</title>
        <screen><computeroutput>usage: cinder backup-reset-state [--state &lt;state&gt;] &lt;backup&gt; [&lt;backup&gt; ...]</computeroutput></screen>
        <para>
Explicitly updates the backup state.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;backup&gt;</command></term>
    <listitem>
      <para>
        Name or ID of the backup to modify.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
  <variablelist wordsize="10">
    <title>Optional arguments</title>
  <varlistentry>
    <term><command>--state &lt;state&gt;</command></term>
    <listitem>
      <para>
        The state to assign to the backup. Valid values are
      "available", "error", "creating", "deleting", and
      "error_deleting". Default=available.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="cinderclient_subcommand_backup-restore">
        <title>cinder backup-restore</title>
        <screen><computeroutput>usage: cinder backup-restore [--volume &lt;volume&gt;] &lt;backup&gt;</computeroutput></screen>
        <para>
Restores a backup.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;backup&gt;</command></term>
    <listitem>
      <para>
        ID of backup to restore.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
  <variablelist wordsize="10">
    <title>Optional arguments</title>
  <varlistentry>
    <term><command>--volume &lt;volume&gt;</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">
        <title>cinder backup-show</title>
        <screen><computeroutput>usage: cinder backup-show &lt;backup&gt;</computeroutput></screen>
        <para>
Shows backup details.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;backup&gt;</command></term>
    <listitem>
      <para>
        Name or ID of backup.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="cinderclient_subcommand_cgsnapshot-create">
        <title>cinder cgsnapshot-create</title>
        <screen><computeroutput>usage: cinder cgsnapshot-create [--name &lt;name&gt;] [--description &lt;description&gt;]
                                &lt;consistencygroup&gt;</computeroutput></screen>
        <para>
Creates a cgsnapshot.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;consistencygroup&gt;</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 &lt;name&gt;</command></term>
    <listitem>
      <para>
        Cgsnapshot name. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--description &lt;description&gt;</command></term>
    <listitem>
      <para>
      Cgsnapshot description. Default=None.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="cinderclient_subcommand_cgsnapshot-delete">
        <title>cinder cgsnapshot-delete</title>
        <screen><computeroutput>usage: cinder cgsnapshot-delete &lt;cgsnapshot&gt; [&lt;cgsnapshot&gt; ...]</computeroutput></screen>
        <para>
Removes one or more cgsnapshots.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;cgsnapshot&gt;</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">
        <title>cinder cgsnapshot-list</title>
        <screen><computeroutput>usage: cinder cgsnapshot-list [--all-tenants [&lt;0|1&gt;]] [--status &lt;status&gt;]
                              [--consistencygroup-id &lt;consistencygroup_id&gt;]</computeroutput></screen>
        <para>
Lists all cgsnapshots.
        </para>  <variablelist wordsize="10">
    <title>Optional arguments</title>
  <varlistentry>
    <term><command>--all-tenants [&lt;0|1&gt;]</command></term>
    <listitem>
      <para>
      Shows details for all tenants. Admin only.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--status &lt;status&gt;</command></term>
    <listitem>
      <para>
        Filters results by a status. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--consistencygroup-id &lt;consistencygroup_id&gt;</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">
        <title>cinder cgsnapshot-show</title>
        <screen><computeroutput>usage: cinder cgsnapshot-show &lt;cgsnapshot&gt;</computeroutput></screen>
        <para>
Shows cgsnapshot details.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;cgsnapshot&gt;</command></term>
    <listitem>
      <para>
        Name or ID of cgsnapshot.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="cinderclient_subcommand_consisgroup-create">
        <title>cinder consisgroup-create</title>
        <screen><computeroutput>usage: cinder consisgroup-create [--name &lt;name&gt;] [--description &lt;description&gt;]
                                 [--availability-zone &lt;availability-zone&gt;]
                                 &lt;volume-types&gt;</computeroutput></screen>
        <para>
Creates a consistency group.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;volume-types&gt;</command></term>
    <listitem>
      <para>
        Volume types.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
  <variablelist wordsize="10">
    <title>Optional arguments</title>
  <varlistentry>
    <term><command>--name &lt;name&gt;</command></term>
    <listitem>
      <para>
        Name of a consistency group.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--description &lt;description&gt;</command></term>
    <listitem>
      <para>
      Description of a consistency group. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--availability-zone &lt;availability-zone&gt;</command></term>
    <listitem>
      <para>
      Availability zone for volume. Default=None.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="cinderclient_subcommand_consisgroup-create-from-src">
        <title>cinder consisgroup-create-from-src</title>
        <screen><computeroutput>usage: cinder consisgroup-create-from-src [--cgsnapshot &lt;cgsnapshot&gt;]
                                          [--source-cg &lt;source-cg&gt;]
                                          [--name &lt;name&gt;]
                                          [--description &lt;description&gt;]</computeroutput></screen>
        <para>
Creates a consistency group from a cgsnapshot or a source CG.
        </para>  <variablelist wordsize="10">
    <title>Optional arguments</title>
  <varlistentry>
    <term><command>--cgsnapshot &lt;cgsnapshot&gt;</command></term>
    <listitem>
      <para>
      Name or ID of a cgsnapshot. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--source-cg &lt;source-cg&gt;</command></term>
    <listitem>
      <para>
      Name or ID of a source CG. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--name &lt;name&gt;</command></term>
    <listitem>
      <para>
        Name of a consistency group. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--description &lt;description&gt;</command></term>
    <listitem>
      <para>
      Description of a consistency group. Default=None.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="cinderclient_subcommand_consisgroup-delete">
        <title>cinder consisgroup-delete</title>
        <screen><computeroutput>usage: cinder consisgroup-delete [--force]
                                 &lt;consistencygroup&gt; [&lt;consistencygroup&gt; ...]</computeroutput></screen>
        <para>
Removes one or more consistency groups.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;consistencygroup&gt;</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">
        <title>cinder consisgroup-list</title>
        <screen><computeroutput>usage: cinder consisgroup-list [--all-tenants [&lt;0|1&gt;]]</computeroutput></screen>
        <para>
Lists all consistencygroups.
        </para>  <variablelist wordsize="10">
    <title>Optional arguments</title>
  <varlistentry>
    <term><command>--all-tenants [&lt;0|1&gt;]</command></term>
    <listitem>
      <para>
      Shows details for all tenants. Admin only.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="cinderclient_subcommand_consisgroup-show">
        <title>cinder consisgroup-show</title>
        <screen><computeroutput>usage: cinder consisgroup-show &lt;consistencygroup&gt;</computeroutput></screen>
        <para>
Shows details of a consistency group.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;consistencygroup&gt;</command></term>
    <listitem>
      <para>
        Name or ID of a consistency group.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="cinderclient_subcommand_consisgroup-update">
        <title>cinder consisgroup-update</title>
        <screen><computeroutput>usage: cinder consisgroup-update [--name &lt;name&gt;] [--description &lt;description&gt;]
                                 [--add-volumes &lt;uuid1,uuid2,......&gt;]
                                 [--remove-volumes &lt;uuid3,uuid4,......&gt;]
                                 &lt;consistencygroup&gt;</computeroutput></screen>
        <para>
Updates a consistencygroup.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;consistencygroup&gt;</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 &lt;name&gt;</command></term>
    <listitem>
      <para>
        New name for consistency group. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--description &lt;description&gt;</command></term>
    <listitem>
      <para>
      New description for consistency group. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--add-volumes &lt;uuid1,uuid2,......&gt;</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 &lt;uuid3,uuid4,......&gt;</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">
        <title>cinder create</title>
        <screen><computeroutput>usage: cinder create [--consisgroup-id &lt;consistencygroup-id&gt;]
                     [--snapshot-id &lt;snapshot-id&gt;]
                     [--source-volid &lt;source-volid&gt;]
                     [--source-replica &lt;source-replica&gt;]
                     [--image-id &lt;image-id&gt;] [--image &lt;image&gt;] [--name &lt;name&gt;]
                     [--description &lt;description&gt;]
                     [--volume-type &lt;volume-type&gt;]
                     [--availability-zone &lt;availability-zone&gt;]
                     [--metadata [&lt;key=value&gt; [&lt;key=value&gt; ...]]]
                     [--hint &lt;key=value&gt;] [--allow-multiattach]
                     [&lt;size&gt;]</computeroutput></screen>
        <para>
Creates a volume.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;size&gt;</command></term>
    <listitem>
      <para>
        Size of volume, in GiBs. (Required unless snapshot-id
      /source-volid is specified).
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
  <variablelist wordsize="10">
    <title>Optional arguments</title>
  <varlistentry>
    <term><command>--consisgroup-id &lt;consistencygroup-id&gt;</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 &lt;snapshot-id&gt;</command></term>
    <listitem>
      <para>
      Creates volume from snapshot ID. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--source-volid &lt;source-volid&gt;</command></term>
    <listitem>
      <para>
      Creates volume from volume ID. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--source-replica &lt;source-replica&gt;</command></term>
    <listitem>
      <para>
      Creates volume from replicated volume ID.
      Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--image-id &lt;image-id&gt;</command></term>
    <listitem>
      <para>
      Creates volume from image ID. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--image &lt;image&gt;</command></term>
    <listitem>
      <para>
        Creates a volume from image (ID or name).
      Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--name &lt;name&gt;</command></term>
    <listitem>
      <para>
        Volume name. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--description &lt;description&gt;</command></term>
    <listitem>
      <para>
      Volume description. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--volume-type &lt;volume-type&gt;</command></term>
    <listitem>
      <para>
      Volume type. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--availability-zone &lt;availability-zone&gt;</command></term>
    <listitem>
      <para>
      Availability zone for volume. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--metadata [&lt;key=value&gt; [&lt;key=value&gt; ...]]</command></term>
    <listitem>
      <para>
      Metadata key and value pairs. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--hint &lt;key=value&gt;</command></term>
    <listitem>
      <para>
        Scheduler hint, like in nova.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--allow-multiattach</command></term>
    <listitem>
      <para>
        Allow volume to be attached more than once.
      Default=False
      </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 &lt;volume&gt; [&lt;volume&gt; ...]</computeroutput></screen>
        <para>
Removes one or more volumes.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;volume&gt;</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">
        <title>cinder encryption-type-create</title>
        <screen><computeroutput>usage: cinder encryption-type-create [--cipher &lt;cipher&gt;]
                                     [--key_size &lt;key_size&gt;]
                                     [--control_location &lt;control_location&gt;]
                                     &lt;volume_type&gt; &lt;provider&gt;</computeroutput></screen>
        <para>
Creates encryption type for a volume type. Admin only.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;volume_type&gt;</command></term>
    <listitem>
      <para>
        Name or ID of volume type.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;provider&gt;</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 &lt;cipher&gt;</command></term>
    <listitem>
      <para>
        The encryption algorithm or mode. For example, aes-
      xts-plain64. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--key_size &lt;key_size&gt;</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 &lt;control_location&gt;</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 &lt;volume_type&gt;</computeroutput></screen>
        <para>
Deletes encryption type for a volume type. Admin only.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;volume_type&gt;</command></term>
    <listitem>
      <para>
        Name or ID of 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 &lt;volume_type&gt;</computeroutput></screen>
        <para>
Shows encryption type details for a volume type. Admin only.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;volume_type&gt;</command></term>
    <listitem>
      <para>
        Name or ID of volume type.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="cinderclient_subcommand_encryption-type-update">
        <title>cinder encryption-type-update</title>
        <screen><computeroutput>usage: cinder encryption-type-update [--provider &lt;provider&gt;]
                                     [--cipher [&lt;cipher&gt;]]
                                     [--key-size [&lt;key-size&gt;]]
                                     [--control-location &lt;control-location&gt;]
                                     &lt;volume-type&gt;</computeroutput></screen>
        <para>
Update encryption type information for a volume type (Admin Only).
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;volume-type&gt;</command></term>
    <listitem>
      <para>
        Name or ID of the volume type
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
  <variablelist wordsize="10">
    <title>Optional arguments</title>
  <varlistentry>
    <term><command>--provider &lt;provider&gt;</command></term>
    <listitem>
      <para>
      Class providing encryption support (e.g.
      LuksEncryptor) (Optional)
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--cipher [&lt;cipher&gt;]</command></term>
    <listitem>
      <para>
        Encryption algorithm/mode to use (e.g., aes-xts-
      plain64). Provide parameter without value to set to
      provider default. (Optional)
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--key-size [&lt;key-size&gt;]</command></term>
    <listitem>
      <para>
      Size of the encryption key, in bits (e.g., 128, 256).
      Provide parameter without value to set to provider
      default. (Optional)
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--control-location &lt;control-location&gt;</command></term>
    <listitem>
      <para>
      Notional service where encryption is performed (e.g.,
      front-end=Nova). Values: 'front-end', 'back-end'
      (Optional)
      </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 &lt;volume&gt; &lt;new_size&gt;</computeroutput></screen>
        <para>
Attempts to extend size of an existing volume.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;volume&gt;</command></term>
    <listitem>
      <para>
        Name or ID of volume to extend.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;new_size&gt;</command></term>
    <listitem>
      <para>
        New size of volume, in GiBs.
      </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 &lt;volume&gt; [&lt;volume&gt; ...]</computeroutput></screen>
        <para>
Attempts force-delete of volume, regardless of state.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;volume&gt;</command></term>
    <listitem>
      <para>
        Name or ID of volume or volumes to delete.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="cinderclient_subcommand_get-capabilities">
        <title>cinder get-capabilities</title>
        <screen><computeroutput>usage: cinder get-capabilities &lt;host&gt;</computeroutput></screen>
        <para>
Show backend volume stats and properties. Admin only.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;host&gt;</command></term>
    <listitem>
      <para>
        Cinder host to show backend volume stats and properties; takes the
      form: host@backend-name
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="cinderclient_subcommand_get-pools">
        <title>cinder get-pools</title>
        <screen><computeroutput>usage: cinder 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_image-metadata">
        <title>cinder image-metadata</title>
        <screen><computeroutput>usage: cinder image-metadata &lt;volume&gt; &lt;action&gt; &lt;key=value&gt; [&lt;key=value&gt; ...]</computeroutput></screen>
        <para>
Sets or deletes volume image metadata.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;volume&gt;</command></term>
    <listitem>
      <para>
        Name or ID of volume for which to update metadata.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;action&gt;</command></term>
    <listitem>
      <para>
        The action. Valid values are 'set' or 'unset.'
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;key=value&gt;</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_image-metadata-show">
        <title>cinder image-metadata-show</title>
        <screen><computeroutput>usage: cinder image-metadata-show &lt;volume&gt;</computeroutput></screen>
        <para>
Shows volume image metadata.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;volume&gt;</command></term>
    <listitem>
      <para>
        ID of volume.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="cinderclient_subcommand_list">
        <title>cinder list</title>
        <screen><computeroutput>usage: cinder list [--all-tenants [&lt;0|1&gt;]] [--name &lt;name&gt;] [--status &lt;status&gt;]
                   [--migration_status &lt;migration_status&gt;]
                   [--metadata [&lt;key=value&gt; [&lt;key=value&gt; ...]]]
                   [--marker &lt;marker&gt;] [--limit &lt;limit&gt;]
                   [--sort &lt;key&gt;[:&lt;direction&gt;]] [--tenant [&lt;tenant&gt;]]</computeroutput></screen>
        <para>
Lists all volumes.
        </para>  <variablelist wordsize="10">
    <title>Optional arguments</title>
  <varlistentry>
    <term><command>--all-tenants [&lt;0|1&gt;]</command></term>
    <listitem>
      <para>
      Shows details for all tenants. Admin only.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--name &lt;name&gt;</command></term>
    <listitem>
      <para>
        Filters results by a name. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--status &lt;status&gt;</command></term>
    <listitem>
      <para>
        Filters results by a status. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--migration_status &lt;migration_status&gt;</command></term>
    <listitem>
      <para>
      Filters results by a migration status. Default=None.
      Admin only.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--metadata [&lt;key=value&gt; [&lt;key=value&gt; ...]]</command></term>
    <listitem>
      <para>
      Filters results by a metadata key and value pair.
      Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--marker &lt;marker&gt;</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 &lt;limit&gt;</command></term>
    <listitem>
      <para>
        Maximum number of volumes to return. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--sort &lt;key&gt;[:&lt;direction&gt;]</command></term>
    <listitem>
      <para>
      Comma-separated list of sort keys and directions in
      the form of &lt;key&gt;[:&lt;asc|desc&gt;]. Valid keys: id,
      status, size, availability_zone, name, bootable,
      created_at. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--tenant [&lt;tenant&gt;]</command></term>
    <listitem>
      <para>
        Display information from single tenant (Admin only).
      </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_manage">
        <title>cinder manage</title>
        <screen><computeroutput>usage: cinder manage [--id-type &lt;id-type&gt;] [--name &lt;name&gt;]
                     [--description &lt;description&gt;]
                     [--volume-type &lt;volume-type&gt;]
                     [--availability-zone &lt;availability-zone&gt;]
                     [--metadata [&lt;key=value&gt; [&lt;key=value&gt; ...]]] [--bootable]
                     &lt;host&gt; &lt;identifier&gt;</computeroutput></screen>
        <para>
Manage an existing volume.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;host&gt;</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>&lt;identifier&gt;</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 &lt;id-type&gt;</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 &lt;name&gt;</command></term>
    <listitem>
      <para>
        Volume name (Default=None)
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--description &lt;description&gt;</command></term>
    <listitem>
      <para>
      Volume description (Default=None)
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--volume-type &lt;volume-type&gt;</command></term>
    <listitem>
      <para>
      Volume type (Default=None)
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--availability-zone &lt;availability-zone&gt;</command></term>
    <listitem>
      <para>
      Availability zone for volume (Default=None)
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--metadata [&lt;key=value&gt; [&lt;key=value&gt; ...]]</command></term>
    <listitem>
      <para>
      Metadata key=value pairs (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">
        <title>cinder metadata</title>
        <screen><computeroutput>usage: cinder metadata &lt;volume&gt; &lt;action&gt; &lt;key=value&gt; [&lt;key=value&gt; ...]</computeroutput></screen>
        <para>
Sets or deletes volume metadata.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;volume&gt;</command></term>
    <listitem>
      <para>
        Name or ID of volume for which to update metadata.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;action&gt;</command></term>
    <listitem>
      <para>
        The action. Valid values are "set" or "unset."
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;key=value&gt;</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">
        <title>cinder metadata-show</title>
        <screen><computeroutput>usage: cinder metadata-show &lt;volume&gt;</computeroutput></screen>
        <para>
Shows volume metadata.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;volume&gt;</command></term>
    <listitem>
      <para>
        ID of volume.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="cinderclient_subcommand_metadata-update-all">
        <title>cinder metadata-update-all</title>
        <screen><computeroutput>usage: cinder metadata-update-all &lt;volume&gt; &lt;key=value&gt; [&lt;key=value&gt; ...]</computeroutput></screen>
        <para>
Updates volume metadata.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;volume&gt;</command></term>
    <listitem>
      <para>
        ID of volume for which to update metadata.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;key=value&gt;</command></term>
    <listitem>
      <para>
        Metadata key and value pair or pairs to update.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="cinderclient_subcommand_migrate">
        <title>cinder migrate</title>
        <screen><computeroutput>usage: cinder migrate [--force-host-copy [&lt;True|False&gt;]]
                      [--lock-volume [&lt;True|False&gt;]]
                      &lt;volume&gt; &lt;host&gt;</computeroutput></screen>
        <para>
Migrates volume to a new host.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;volume&gt;</command></term>
    <listitem>
      <para>
        ID of volume to migrate.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;host&gt;</command></term>
    <listitem>
      <para>
        Destination host. Takes the form: host@backend-
      name#pool
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
  <variablelist wordsize="10">
    <title>Optional arguments</title>
  <varlistentry>
    <term><command>--force-host-copy [&lt;True|False&gt;]</command></term>
    <listitem>
      <para>
      Enables or disables generic host-based force-
      migration, which bypasses driver optimizations.
      Default=False.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--lock-volume [&lt;True|False&gt;]</command></term>
    <listitem>
      <para>
      Enables or disables the termination of volume
      migration caused by other commands. This option
      applies to the available volume. True means it locks
      the volume state and does not allow the migration to
      be aborted. The volume status will be in maintenance
      during the migration. False means it allows the volume
      migration to be aborted. The volume status is still in
      the original status. 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 &lt;qos_specs&gt; &lt;volume_type_id&gt;</computeroutput></screen>
        <para>
Associates qos specs with specified volume type.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;qos_specs&gt;</command></term>
    <listitem>
      <para>
        ID of QoS specifications.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;volume_type_id&gt;</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">
        <title>cinder qos-create</title>
        <screen><computeroutput>usage: cinder qos-create &lt;name&gt; &lt;key=value&gt; [&lt;key=value&gt; ...]</computeroutput></screen>
        <para>
Creates a qos specs.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;name&gt;</command></term>
    <listitem>
      <para>
        Name of new QoS specifications.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;key=value&gt;</command></term>
    <listitem>
      <para>
        QoS specifications.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="cinderclient_subcommand_qos-delete">
        <title>cinder qos-delete</title>
        <screen><computeroutput>usage: cinder qos-delete [--force [&lt;True|False&gt;]] &lt;qos_specs&gt;</computeroutput></screen>
        <para>
Deletes a specified qos specs.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;qos_specs&gt;</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 [&lt;True|False&gt;]</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 &lt;qos_specs&gt; &lt;volume_type_id&gt;</computeroutput></screen>
        <para>
Disassociates qos specs from specified volume type.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;qos_specs&gt;</command></term>
    <listitem>
      <para>
        ID of QoS specifications.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;volume_type_id&gt;</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">
        <title>cinder qos-disassociate-all</title>
        <screen><computeroutput>usage: cinder qos-disassociate-all &lt;qos_specs&gt;</computeroutput></screen>
        <para>
Disassociates qos specs from all its associations.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;qos_specs&gt;</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">
        <title>cinder qos-get-association</title>
        <screen><computeroutput>usage: cinder qos-get-association &lt;qos_specs&gt;</computeroutput></screen>
        <para>
Lists all associations for specified qos specs.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;qos_specs&gt;</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 &lt;qos_specs&gt; &lt;action&gt; 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>&lt;qos_specs&gt;</command></term>
    <listitem>
      <para>
        ID of QoS specifications.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;action&gt;</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 &lt;qos_specs&gt;</computeroutput></screen>
        <para>
Shows qos specs details.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;qos_specs&gt;</command></term>
    <listitem>
      <para>
        ID of QoS specifications to show.
      </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 &lt;class&gt;</computeroutput></screen>
        <para>
Lists quotas for a quota class.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;class&gt;</command></term>
    <listitem>
      <para>
        Name of quota class 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 &lt;volumes&gt;]
                                 [--snapshots &lt;snapshots&gt;]
                                 [--gigabytes &lt;gigabytes&gt;]
                                 [--volume-type &lt;volume_type_name&gt;]
                                 &lt;class_name&gt;</computeroutput></screen>
        <para>
Updates quotas for a quota class.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;class_name&gt;</command></term>
    <listitem>
      <para>
        Name of quota class for which to set quotas.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
  <variablelist wordsize="10">
    <title>Optional arguments</title>
  <varlistentry>
    <term><command>--volumes &lt;volumes&gt;</command></term>
    <listitem>
      <para>
        The new "volumes" quota value. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--snapshots &lt;snapshots&gt;</command></term>
    <listitem>
      <para>
      The new "snapshots" quota value. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--gigabytes &lt;gigabytes&gt;</command></term>
    <listitem>
      <para>
      The new "gigabytes" quota value. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--volume-type &lt;volume_type_name&gt;</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 &lt;tenant_id&gt;</computeroutput></screen>
        <para>
Lists default quotas for a tenant.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;tenant_id&gt;</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">
        <title>cinder quota-delete</title>
        <screen><computeroutput>usage: cinder quota-delete &lt;tenant_id&gt;</computeroutput></screen>
        <para>
Delete the quotas for a tenant.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;tenant_id&gt;</command></term>
    <listitem>
      <para>
        UUID of tenant to 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 &lt;tenant_id&gt;</computeroutput></screen>
        <para>
Lists quotas for a tenant.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;tenant_id&gt;</command></term>
    <listitem>
      <para>
        ID of 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 &lt;volumes&gt;] [--snapshots &lt;snapshots&gt;]
                           [--gigabytes &lt;gigabytes&gt;] [--backups &lt;backups&gt;]
                           [--backup-gigabytes &lt;backup_gigabytes&gt;]
                           [--consistencygroups &lt;consistencygroups&gt;]
                           [--volume-type &lt;volume_type_name&gt;]
                           [--per-volume-gigabytes &lt;per_volume_gigabytes&gt;]
                           &lt;tenant_id&gt;</computeroutput></screen>
        <para>
Updates quotas for a tenant.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;tenant_id&gt;</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 &lt;volumes&gt;</command></term>
    <listitem>
      <para>
        The new "volumes" quota value. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--snapshots &lt;snapshots&gt;</command></term>
    <listitem>
      <para>
      The new "snapshots" quota value. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--gigabytes &lt;gigabytes&gt;</command></term>
    <listitem>
      <para>
      The new "gigabytes" quota value. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--backups &lt;backups&gt;</command></term>
    <listitem>
      <para>
        The new "backups" quota value. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--backup-gigabytes &lt;backup_gigabytes&gt;</command></term>
    <listitem>
      <para>
      The new "backup_gigabytes" quota value. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--consistencygroups &lt;consistencygroups&gt;</command></term>
    <listitem>
      <para>
      The new "consistencygroups" quota value. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--volume-type &lt;volume_type_name&gt;</command></term>
    <listitem>
      <para>
      Volume type. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--per-volume-gigabytes &lt;per_volume_gigabytes&gt;</command></term>
    <listitem>
      <para>
      Set max volume size limit. 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 &lt;tenant_id&gt;</computeroutput></screen>
        <para>
Lists quota usage for a tenant.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;tenant_id&gt;</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">
        <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 &lt;volume&gt; &lt;True|true|False|false&gt;</computeroutput></screen>
        <para>
Updates volume read-only access-mode flag.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;volume&gt;</command></term>
    <listitem>
      <para>
        ID of volume to update.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;True|true|False|false&gt;</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 [--description &lt;description&gt;] &lt;volume&gt; [&lt;name&gt;]</computeroutput></screen>
        <para>
Renames a volume.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;volume&gt;</command></term>
    <listitem>
      <para>
        Name or ID of volume to rename.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;name&gt;</command></term>
    <listitem>
      <para>
        New name for volume.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
  <variablelist wordsize="10">
    <title>Optional arguments</title>
  <varlistentry>
    <term><command>--description &lt;description&gt;</command></term>
    <listitem>
      <para>
      Volume description. Default=None.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="cinderclient_subcommand_replication-disable">
        <title>cinder replication-disable</title>
        <screen><computeroutput>usage: cinder replication-disable &lt;volume&gt;</computeroutput></screen>
        <para>
Disables volume replication on a given volume.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;volume&gt;</command></term>
    <listitem>
      <para>
        ID of volume to disable replication.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="cinderclient_subcommand_replication-enable">
        <title>cinder replication-enable</title>
        <screen><computeroutput>usage: cinder replication-enable &lt;volume&gt;</computeroutput></screen>
        <para>
Enables volume replication on a given volume.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;volume&gt;</command></term>
    <listitem>
      <para>
        ID of volume to enable replication.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="cinderclient_subcommand_replication-failover">
        <title>cinder replication-failover</title>
        <screen><computeroutput>usage: cinder replication-failover &lt;volume&gt; &lt;secondary&gt;</computeroutput></screen>
        <para>
Failover a volume to a secondary target
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;volume&gt;</command></term>
    <listitem>
      <para>
        ID of volume to failover.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;secondary&gt;</command></term>
    <listitem>
      <para>
        A unqiue identifier that represents a failover target.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="cinderclient_subcommand_replication-list-targets">
        <title>cinder replication-list-targets</title>
        <screen><computeroutput>usage: cinder replication-list-targets &lt;volume&gt;</computeroutput></screen>
        <para>
List replication targets available for a volume.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;volume&gt;</command></term>
    <listitem>
      <para>
        ID of volume to list available replication targets.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="cinderclient_subcommand_replication-promote">
        <title>cinder replication-promote</title>
        <screen><computeroutput>usage: cinder replication-promote &lt;volume&gt;</computeroutput></screen>
        <para>
Promote a secondary volume to primary for a relationship.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;volume&gt;</command></term>
    <listitem>
      <para>
        Name or ID of the volume to promote. The volume should have the
      replica volume created with source-replica argument.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="cinderclient_subcommand_replication-reenable">
        <title>cinder replication-reenable</title>
        <screen><computeroutput>usage: cinder replication-reenable &lt;volume&gt;</computeroutput></screen>
        <para>
Sync the secondary volume with primary for a relationship.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;volume&gt;</command></term>
    <listitem>
      <para>
        Name or ID of the volume to reenable replication. The replication-
      status of the volume should be inactive.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="cinderclient_subcommand_reset-state">
        <title>cinder reset-state</title>
        <screen><computeroutput>usage: cinder reset-state [--state &lt;state&gt;] [--attach-status &lt;attach-status&gt;]
                          [--reset-migration-status]
                          &lt;volume&gt; [&lt;volume&gt; ...]</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>&lt;volume&gt;</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 &lt;state&gt;</command></term>
    <listitem>
      <para>
        The state to assign to the volume. Valid values are
      "available", "error", "creating", "deleting", "in-
      use", "attaching", "detaching", "error_deleting" and
      "maintenance". 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>
  <varlistentry>
    <term><command>--attach-status &lt;attach-status&gt;</command></term>
    <listitem>
      <para>
      The attach status to assign to the volume in the
      DataBase, with no regard to the actual status. Valid
      values are "attached" and "detached". Default=None,
      that means the status is unchanged.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--reset-migration-status</command></term>
    <listitem>
      <para>
      Clears the migration status of the volume in the
      DataBase that indicates the volume is source or
      destination of volume migration, with no regard to the
      actual status.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="cinderclient_subcommand_retype">
        <title>cinder retype</title>
        <screen><computeroutput>usage: cinder retype [--migration-policy &lt;never|on-demand&gt;]
                     &lt;volume&gt; &lt;volume-type&gt;</computeroutput></screen>
        <para>
Changes the volume type for a volume.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;volume&gt;</command></term>
    <listitem>
      <para>
        Name or ID of volume for which to modify type.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;volume-type&gt;</command></term>
    <listitem>
      <para>
        New volume type.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
  <variablelist wordsize="10">
    <title>Optional arguments</title>
  <varlistentry>
    <term><command>--migration-policy &lt;never|on-demand&gt;</command></term>
    <listitem>
      <para>
      Migration policy during retype of volume.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="cinderclient_subcommand_service-disable">
        <title>cinder service-disable</title>
        <screen><computeroutput>usage: cinder service-disable [--reason &lt;reason&gt;] &lt;hostname&gt; &lt;binary&gt;</computeroutput></screen>
        <para>
Disables the service.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;hostname&gt;</command></term>
    <listitem>
      <para>
        Host name.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;binary&gt;</command></term>
    <listitem>
      <para>
        Service binary.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
  <variablelist wordsize="10">
    <title>Optional arguments</title>
  <varlistentry>
    <term><command>--reason &lt;reason&gt;</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 &lt;hostname&gt; &lt;binary&gt;</computeroutput></screen>
        <para>
Enables the service.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;hostname&gt;</command></term>
    <listitem>
      <para>
        Host name.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;binary&gt;</command></term>
    <listitem>
      <para>
        Service binary.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="cinderclient_subcommand_service-list">
        <title>cinder service-list</title>
        <screen><computeroutput>usage: cinder service-list [--host &lt;hostname&gt;] [--binary &lt;binary&gt;]</computeroutput></screen>
        <para>
Lists all services. Filter by host and service binary.
        </para>  <variablelist wordsize="10">
    <title>Optional arguments</title>
  <varlistentry>
    <term><command>--host &lt;hostname&gt;</command></term>
    <listitem>
      <para>
        Host name. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--binary &lt;binary&gt;</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 &lt;volume&gt; &lt;True|true|False|false&gt;</computeroutput></screen>
        <para>
Update bootable status of a volume.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;volume&gt;</command></term>
    <listitem>
      <para>
        ID of the volume to update.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;True|true|False|false&gt;</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 &lt;volume&gt;</computeroutput></screen>
        <para>
Shows volume details.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;volume&gt;</command></term>
    <listitem>
      <para>
        Name or ID of volume.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="cinderclient_subcommand_snapshot-create">
        <title>cinder snapshot-create</title>
        <screen><computeroutput>usage: cinder snapshot-create [--force [&lt;True|False&gt;]] [--name &lt;name&gt;]
                              [--description &lt;description&gt;]
                              [--metadata [&lt;key=value&gt; [&lt;key=value&gt; ...]]]
                              &lt;volume&gt;</computeroutput></screen>
        <para>
Creates a snapshot.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;volume&gt;</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 [&lt;True|False&gt;]</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 &lt;name&gt;</command></term>
    <listitem>
      <para>
        Snapshot name. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--description &lt;description&gt;</command></term>
    <listitem>
      <para>
      Snapshot description. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--metadata [&lt;key=value&gt; [&lt;key=value&gt; ...]]</command></term>
    <listitem>
      <para>
      Snapshot metadata key and value pairs. 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 &lt;snapshot&gt; [&lt;snapshot&gt; ...]</computeroutput></screen>
        <para>
Removes one or more snapshots.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;snapshot&gt;</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 [&lt;0|1&gt;]] [--name &lt;name&gt;]
                            [--status &lt;status&gt;] [--volume-id &lt;volume-id&gt;]
                            [--marker &lt;marker&gt;] [--limit &lt;limit&gt;]
                            [--sort &lt;key&gt;[:&lt;direction&gt;]]</computeroutput></screen>
        <para>
Lists all snapshots.
        </para>  <variablelist wordsize="10">
    <title>Optional arguments</title>
  <varlistentry>
    <term><command>--all-tenants [&lt;0|1&gt;]</command></term>
    <listitem>
      <para>
      Shows details for all tenants. Admin only.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--name &lt;name&gt;</command></term>
    <listitem>
      <para>
        Filters results by a name. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--status &lt;status&gt;</command></term>
    <listitem>
      <para>
        Filters results by a status. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--volume-id &lt;volume-id&gt;</command></term>
    <listitem>
      <para>
      Filters results by a volume ID. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--marker &lt;marker&gt;</command></term>
    <listitem>
      <para>
        Begin returning snapshots that appear later in the
      snapshot list than that represented by this id.
      Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--limit &lt;limit&gt;</command></term>
    <listitem>
      <para>
        Maximum number of snapshots to return. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--sort &lt;key&gt;[:&lt;direction&gt;]</command></term>
    <listitem>
      <para>
      Comma-separated list of sort keys and directions in
      the form of &lt;key&gt;[:&lt;asc|desc&gt;]. Valid keys: id,
      status, size, availability_zone, name, bootable,
      created_at. 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 &lt;snapshot&gt; &lt;action&gt; &lt;key=value&gt;
                                [&lt;key=value&gt; ...]</computeroutput></screen>
        <para>
Sets or deletes snapshot metadata.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;snapshot&gt;</command></term>
    <listitem>
      <para>
        ID of snapshot for which to update metadata.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;action&gt;</command></term>
    <listitem>
      <para>
        The action. Valid values are "set" or "unset."
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;key=value&gt;</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">
        <title>cinder snapshot-metadata-show</title>
        <screen><computeroutput>usage: cinder snapshot-metadata-show &lt;snapshot&gt;</computeroutput></screen>
        <para>
Shows snapshot metadata.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;snapshot&gt;</command></term>
    <listitem>
      <para>
        ID of snapshot.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="cinderclient_subcommand_snapshot-metadata-update-all">
        <title>cinder snapshot-metadata-update-all</title>
        <screen><computeroutput>usage: cinder snapshot-metadata-update-all &lt;snapshot&gt; &lt;key=value&gt;
                                           [&lt;key=value&gt; ...]</computeroutput></screen>
        <para>
Updates snapshot metadata.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;snapshot&gt;</command></term>
    <listitem>
      <para>
        ID of snapshot for which to update metadata.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;key=value&gt;</command></term>
    <listitem>
      <para>
        Metadata key and value pair to update.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="cinderclient_subcommand_snapshot-rename">
        <title>cinder snapshot-rename</title>
        <screen><computeroutput>usage: cinder snapshot-rename [--description &lt;description&gt;]
                              &lt;snapshot&gt; [&lt;name&gt;]</computeroutput></screen>
        <para>
Renames a snapshot.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;snapshot&gt;</command></term>
    <listitem>
      <para>
        Name or ID of snapshot.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;name&gt;</command></term>
    <listitem>
      <para>
        New name for snapshot.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
  <variablelist wordsize="10">
    <title>Optional arguments</title>
  <varlistentry>
    <term><command>--description &lt;description&gt;</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 &lt;state&gt;]
                                   &lt;snapshot&gt; [&lt;snapshot&gt; ...]</computeroutput></screen>
        <para>
Explicitly updates the snapshot state.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;snapshot&gt;</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 &lt;state&gt;</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 &lt;snapshot&gt;</computeroutput></screen>
        <para>
Shows snapshot details.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;snapshot&gt;</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 &lt;transfer&gt; &lt;auth_key&gt;</computeroutput></screen>
        <para>
Accepts a volume transfer.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;transfer&gt;</command></term>
    <listitem>
      <para>
        ID of transfer to accept.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;auth_key&gt;</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 [--name &lt;name&gt;] &lt;volume&gt;</computeroutput></screen>
        <para>
Creates a volume transfer.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;volume&gt;</command></term>
    <listitem>
      <para>
        Name or ID of volume to transfer.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
  <variablelist wordsize="10">
    <title>Optional arguments</title>
  <varlistentry>
    <term><command>--name &lt;name&gt;</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 &lt;transfer&gt;</computeroutput></screen>
        <para>
Undoes a transfer.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;transfer&gt;</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 [&lt;0|1&gt;]]</computeroutput></screen>
        <para>
Lists all transfers.
        </para>  <variablelist wordsize="10">
    <title>Optional arguments</title>
  <varlistentry>
    <term><command>--all-tenants [&lt;0|1&gt;]</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 &lt;transfer&gt;</computeroutput></screen>
        <para>
Shows transfer details.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;transfer&gt;</command></term>
    <listitem>
      <para>
        Name or ID of transfer to accept.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="cinderclient_subcommand_type-access-add">
        <title>cinder type-access-add</title>
        <screen><computeroutput>usage: cinder type-access-add --volume-type &lt;volume_type&gt; --project-id
                              &lt;project_id&gt;</computeroutput></screen>
        <para>
Adds volume type access for the given project.
        </para>  <variablelist wordsize="10">
    <title>Optional arguments</title>
  <varlistentry>
    <term><command>--volume-type &lt;volume_type&gt;</command></term>
    <listitem>
      <para>
      Volume type name or ID to add access for the given
      project.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--project-id &lt;project_id&gt;</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">
        <title>cinder type-access-list</title>
        <screen><computeroutput>usage: cinder type-access-list --volume-type &lt;volume_type&gt;</computeroutput></screen>
        <para>
Print access information about the given volume type.
        </para>  <variablelist wordsize="10">
    <title>Optional arguments</title>
  <varlistentry>
    <term><command>--volume-type &lt;volume_type&gt;</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">
        <title>cinder type-access-remove</title>
        <screen><computeroutput>usage: cinder type-access-remove --volume-type &lt;volume_type&gt; --project-id
                                 &lt;project_id&gt;</computeroutput></screen>
        <para>
Removes volume type access for the given project.
        </para>  <variablelist wordsize="10">
    <title>Optional arguments</title>
  <varlistentry>
    <term><command>--volume-type &lt;volume_type&gt;</command></term>
    <listitem>
      <para>
      Volume type name or ID to remove access for the given
      project.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--project-id &lt;project_id&gt;</command></term>
    <listitem>
      <para>
      Project ID to remove volume type access for.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="cinderclient_subcommand_type-create">
        <title>cinder type-create</title>
        <screen><computeroutput>usage: cinder type-create [--description &lt;description&gt;]
                          [--is-public &lt;is-public&gt;]
                          &lt;name&gt;</computeroutput></screen>
        <para>
Creates a volume type.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;name&gt;</command></term>
    <listitem>
      <para>
        Name of new volume type.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
  <variablelist wordsize="10">
    <title>Optional arguments</title>
  <varlistentry>
    <term><command>--description &lt;description&gt;</command></term>
    <listitem>
      <para>
      Description of new volume type.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--is-public &lt;is-public&gt;</command></term>
    <listitem>
      <para>
      Make type accessible to the public (default true).
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="cinderclient_subcommand_type-default">
        <title>cinder type-default</title>
        <screen><computeroutput>usage: cinder type-default</computeroutput></screen>
        <para>
List the default volume type.
        </para>
    </section>
    <section xml:id="cinderclient_subcommand_type-delete">
        <title>cinder type-delete</title>
        <screen><computeroutput>usage: cinder type-delete &lt;id&gt;</computeroutput></screen>
        <para>
Deletes a volume type.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;id&gt;</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 &lt;vtype&gt; &lt;action&gt; &lt;key=value&gt; [&lt;key=value&gt; ...]</computeroutput></screen>
        <para>
Sets or unsets extra_spec for a volume type.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;vtype&gt;</command></term>
    <listitem>
      <para>
        Name or ID of volume type.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;action&gt;</command></term>
    <listitem>
      <para>
        The action. Valid values are "set" or "unset."
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;key=value&gt;</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">
        <title>cinder type-list</title>
        <screen><computeroutput>usage: cinder type-list</computeroutput></screen>
        <para>
Lists available 'volume types'. (Admin only will see private types)
        </para>
    </section>
    <section xml:id="cinderclient_subcommand_type-show">
        <title>cinder type-show</title>
        <screen><computeroutput>usage: cinder type-show &lt;volume_type&gt;</computeroutput></screen>
        <para>
Show volume type details.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;volume_type&gt;</command></term>
    <listitem>
      <para>
        Name or ID of the volume type.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="cinderclient_subcommand_type-update">
        <title>cinder type-update</title>
        <screen><computeroutput>usage: cinder type-update [--name &lt;name&gt;] [--description &lt;description&gt;]
                          [--is-public &lt;is-public&gt;]
                          &lt;id&gt;</computeroutput></screen>
        <para>
Updates volume type name ,description and/or is_public.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;id&gt;</command></term>
    <listitem>
      <para>
        ID of the volume type.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
  <variablelist wordsize="10">
    <title>Optional arguments</title>
  <varlistentry>
    <term><command>--name &lt;name&gt;</command></term>
    <listitem>
      <para>
        Name of the volume type.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--description &lt;description&gt;</command></term>
    <listitem>
      <para>
      Description of the volume type.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--is-public &lt;is-public&gt;</command></term>
    <listitem>
      <para>
      Make type accessible to the public or not.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="cinderclient_subcommand_unmanage">
        <title>cinder unmanage</title>
        <screen><computeroutput>usage: cinder unmanage &lt;volume&gt;</computeroutput></screen>
        <para>
Stop managing a volume.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;volume&gt;</command></term>
    <listitem>
      <para>
        Name or ID of the volume to unmanage.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="cinderclient_subcommand_upload-to-image">
        <title>cinder upload-to-image</title>
        <screen><computeroutput>usage: cinder upload-to-image [--force [&lt;True|False&gt;]]
                              [--container-format &lt;container-format&gt;]
                              [--disk-format &lt;disk-format&gt;]
                              &lt;volume&gt; &lt;image-name&gt;</computeroutput></screen>
        <para>
Uploads volume to Image Service as an image.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;volume&gt;</command></term>
    <listitem>
      <para>
        Name or ID of volume to snapshot.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;image-name&gt;</command></term>
    <listitem>
      <para>
        The new image name.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
  <variablelist wordsize="10">
    <title>Optional arguments</title>
  <varlistentry>
    <term><command>--force [&lt;True|False&gt;]</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 &lt;container-format&gt;</command></term>
    <listitem>
      <para>
      Container format type. Default is bare.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--disk-format &lt;disk-format&gt;</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 &lt;container&gt;] [--name &lt;name&gt;]
                            [--description &lt;description&gt;] [--incremental]
                            [--force]
                            &lt;volume&gt;</computeroutput></screen>
        <para>
Creates a volume backup.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;volume&gt;</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 &lt;container&gt;</command></term>
    <listitem>
      <para>
      Backup container name. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--name &lt;name&gt;</command></term>
    <listitem>
      <para>
        Backup name. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--description &lt;description&gt;</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>
  <varlistentry>
    <term><command>--force</command></term>
    <listitem>
      <para>
        Allows or disallows backup of a volume when the volume
      is attached to an instance. If set to True, backs up
      the volume whether its status is "available" or "in-
      use". The backup of an "in-use" volume means your data
      is crash consistent. 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 &lt;backup&gt;</computeroutput></screen>
        <para>
Removes a backup.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;backup&gt;</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 &lt;backup&gt;</computeroutput></screen>
        <para>
Export backup metadata record.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;backup&gt;</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 &lt;backup_service&gt; &lt;backup_url&gt;</computeroutput></screen>
        <para>
Import backup metadata record.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;backup_service&gt;</command></term>
    <listitem>
      <para>
        Backup service to use for importing the backup.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;backup_url&gt;</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 [--all-tenants [&lt;all_tenants&gt;]] [--name &lt;name&gt;]
                          [--status &lt;status&gt;] [--volume-id &lt;volume-id&gt;]
                          [--marker &lt;marker&gt;] [--limit &lt;limit&gt;]
                          [--sort &lt;key&gt;[:&lt;direction&gt;]]</computeroutput></screen>
        <para>
Lists all backups.
        </para>  <variablelist wordsize="10">
    <title>Optional arguments</title>
  <varlistentry>
    <term><command>--all-tenants [&lt;all_tenants&gt;]</command></term>
    <listitem>
      <para>
      Shows details for all tenants. Admin only.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--name &lt;name&gt;</command></term>
    <listitem>
      <para>
        Filters results by a name. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--status &lt;status&gt;</command></term>
    <listitem>
      <para>
        Filters results by a status. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--volume-id &lt;volume-id&gt;</command></term>
    <listitem>
      <para>
      Filters results by a volume ID. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--marker &lt;marker&gt;</command></term>
    <listitem>
      <para>
        Begin returning backups that appear later in the
      backup list than that represented by this id.
      Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--limit &lt;limit&gt;</command></term>
    <listitem>
      <para>
        Maximum number of backups to return. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--sort &lt;key&gt;[:&lt;direction&gt;]</command></term>
    <listitem>
      <para>
      Comma-separated list of sort keys and directions in
      the form of &lt;key&gt;[:&lt;asc|desc&gt;]. Valid keys: id,
      status, size, availability_zone, name, bootable,
      created_at. Default=None.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="cinderclient_subcommand_backup-reset-state_v2">
        <title>cinder backup-reset-state (v2)</title>
        <screen><computeroutput>usage: cinder --os-volume-api-version 2 backup-reset-state [--state &lt;state&gt;] &lt;backup&gt; [&lt;backup&gt; ...]</computeroutput></screen>
        <para>
Explicitly updates the backup state.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;backup&gt;</command></term>
    <listitem>
      <para>
        Name or ID of the backup to modify.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
  <variablelist wordsize="10">
    <title>Optional arguments</title>
  <varlistentry>
    <term><command>--state &lt;state&gt;</command></term>
    <listitem>
      <para>
        The state to assign to the backup. Valid values are
      "available", "error", "creating", "deleting", and
      "error_deleting". Default=available.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </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 &lt;volume&gt;] &lt;backup&gt;</computeroutput></screen>
        <para>
Restores a backup.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;backup&gt;</command></term>
    <listitem>
      <para>
        ID of backup to restore.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
  <variablelist wordsize="10">
    <title>Optional arguments</title>
  <varlistentry>
    <term><command>--volume &lt;volume&gt;</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 &lt;backup&gt;</computeroutput></screen>
        <para>
Shows backup details.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;backup&gt;</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 &lt;name&gt;] [--description &lt;description&gt;]
                                &lt;consistencygroup&gt;</computeroutput></screen>
        <para>
Creates a cgsnapshot.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;consistencygroup&gt;</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 &lt;name&gt;</command></term>
    <listitem>
      <para>
        Cgsnapshot name. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--description &lt;description&gt;</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 &lt;cgsnapshot&gt; [&lt;cgsnapshot&gt; ...]</computeroutput></screen>
        <para>
Removes one or more cgsnapshots.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;cgsnapshot&gt;</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 [&lt;0|1&gt;]] [--status &lt;status&gt;]
                              [--consistencygroup-id &lt;consistencygroup_id&gt;]</computeroutput></screen>
        <para>
Lists all cgsnapshots.
        </para>  <variablelist wordsize="10">
    <title>Optional arguments</title>
  <varlistentry>
    <term><command>--all-tenants [&lt;0|1&gt;]</command></term>
    <listitem>
      <para>
      Shows details for all tenants. Admin only.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--status &lt;status&gt;</command></term>
    <listitem>
      <para>
        Filters results by a status. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--consistencygroup-id &lt;consistencygroup_id&gt;</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 &lt;cgsnapshot&gt;</computeroutput></screen>
        <para>
Shows cgsnapshot details.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;cgsnapshot&gt;</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 &lt;name&gt;] [--description &lt;description&gt;]
                                 [--availability-zone &lt;availability-zone&gt;]
                                 &lt;volume-types&gt;</computeroutput></screen>
        <para>
Creates a consistency group.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;volume-types&gt;</command></term>
    <listitem>
      <para>
        Volume types.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
  <variablelist wordsize="10">
    <title>Optional arguments</title>
  <varlistentry>
    <term><command>--name &lt;name&gt;</command></term>
    <listitem>
      <para>
        Name of a consistency group.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--description &lt;description&gt;</command></term>
    <listitem>
      <para>
      Description of a consistency group. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--availability-zone &lt;availability-zone&gt;</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 &lt;cgsnapshot&gt;]
                                          [--source-cg &lt;source-cg&gt;]
                                          [--name &lt;name&gt;]
                                          [--description &lt;description&gt;]</computeroutput></screen>
        <para>
Creates a consistency group from a cgsnapshot or a source CG.
        </para>  <variablelist wordsize="10">
    <title>Optional arguments</title>
  <varlistentry>
    <term><command>--cgsnapshot &lt;cgsnapshot&gt;</command></term>
    <listitem>
      <para>
      Name or ID of a cgsnapshot. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--source-cg &lt;source-cg&gt;</command></term>
    <listitem>
      <para>
      Name or ID of a source CG. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--name &lt;name&gt;</command></term>
    <listitem>
      <para>
        Name of a consistency group. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--description &lt;description&gt;</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]
                                 &lt;consistencygroup&gt; [&lt;consistencygroup&gt; ...]</computeroutput></screen>
        <para>
Removes one or more consistency groups.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;consistencygroup&gt;</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 [&lt;0|1&gt;]]</computeroutput></screen>
        <para>
Lists all consistencygroups.
        </para>  <variablelist wordsize="10">
    <title>Optional arguments</title>
  <varlistentry>
    <term><command>--all-tenants [&lt;0|1&gt;]</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 &lt;consistencygroup&gt;</computeroutput></screen>
        <para>
Shows details of a consistency group.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;consistencygroup&gt;</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 &lt;name&gt;] [--description &lt;description&gt;]
                                 [--add-volumes &lt;uuid1,uuid2,......&gt;]
                                 [--remove-volumes &lt;uuid3,uuid4,......&gt;]
                                 &lt;consistencygroup&gt;</computeroutput></screen>
        <para>
Updates a consistencygroup.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;consistencygroup&gt;</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 &lt;name&gt;</command></term>
    <listitem>
      <para>
        New name for consistency group. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--description &lt;description&gt;</command></term>
    <listitem>
      <para>
      New description for consistency group. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--add-volumes &lt;uuid1,uuid2,......&gt;</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 &lt;uuid3,uuid4,......&gt;</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 &lt;consistencygroup-id&gt;]
                     [--snapshot-id &lt;snapshot-id&gt;]
                     [--source-volid &lt;source-volid&gt;]
                     [--source-replica &lt;source-replica&gt;]
                     [--image-id &lt;image-id&gt;] [--image &lt;image&gt;] [--name &lt;name&gt;]
                     [--description &lt;description&gt;]
                     [--volume-type &lt;volume-type&gt;]
                     [--availability-zone &lt;availability-zone&gt;]
                     [--metadata [&lt;key=value&gt; [&lt;key=value&gt; ...]]]
                     [--hint &lt;key=value&gt;] [--allow-multiattach]
                     [&lt;size&gt;]</computeroutput></screen>
        <para>
Creates a volume.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;size&gt;</command></term>
    <listitem>
      <para>
        Size of volume, in GiBs. (Required unless snapshot-id
      /source-volid is specified).
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
  <variablelist wordsize="10">
    <title>Optional arguments</title>
  <varlistentry>
    <term><command>--consisgroup-id &lt;consistencygroup-id&gt;</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 &lt;snapshot-id&gt;</command></term>
    <listitem>
      <para>
      Creates volume from snapshot ID. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--source-volid &lt;source-volid&gt;</command></term>
    <listitem>
      <para>
      Creates volume from volume ID. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--source-replica &lt;source-replica&gt;</command></term>
    <listitem>
      <para>
      Creates volume from replicated volume ID.
      Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--image-id &lt;image-id&gt;</command></term>
    <listitem>
      <para>
      Creates volume from image ID. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--image &lt;image&gt;</command></term>
    <listitem>
      <para>
        Creates a volume from image (ID or name).
      Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--name &lt;name&gt;</command></term>
    <listitem>
      <para>
        Volume name. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--description &lt;description&gt;</command></term>
    <listitem>
      <para>
      Volume description. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--volume-type &lt;volume-type&gt;</command></term>
    <listitem>
      <para>
      Volume type. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--availability-zone &lt;availability-zone&gt;</command></term>
    <listitem>
      <para>
      Availability zone for volume. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--metadata [&lt;key=value&gt; [&lt;key=value&gt; ...]]</command></term>
    <listitem>
      <para>
      Metadata key and value pairs. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--hint &lt;key=value&gt;</command></term>
    <listitem>
      <para>
        Scheduler hint, like in nova.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--allow-multiattach</command></term>
    <listitem>
      <para>
        Allow volume to be attached more than once.
      Default=False
      </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 &lt;volume&gt; [&lt;volume&gt; ...]</computeroutput></screen>
        <para>
Removes one or more volumes.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;volume&gt;</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 &lt;cipher&gt;]
                                     [--key_size &lt;key_size&gt;]
                                     [--control_location &lt;control_location&gt;]
                                     &lt;volume_type&gt; &lt;provider&gt;</computeroutput></screen>
        <para>
Creates encryption type for a volume type. Admin only.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;volume_type&gt;</command></term>
    <listitem>
      <para>
        Name or ID of volume type.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;provider&gt;</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 &lt;cipher&gt;</command></term>
    <listitem>
      <para>
        The encryption algorithm or mode. For example, aes-
      xts-plain64. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--key_size &lt;key_size&gt;</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 &lt;control_location&gt;</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 &lt;volume_type&gt;</computeroutput></screen>
        <para>
Deletes encryption type for a volume type. Admin only.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;volume_type&gt;</command></term>
    <listitem>
      <para>
        Name or ID of 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 &lt;volume_type&gt;</computeroutput></screen>
        <para>
Shows encryption type details for a volume type. Admin only.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;volume_type&gt;</command></term>
    <listitem>
      <para>
        Name or ID of volume type.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="cinderclient_subcommand_encryption-type-update_v2">
        <title>cinder encryption-type-update (v2)</title>
        <screen><computeroutput>usage: cinder --os-volume-api-version 2 encryption-type-update [--provider &lt;provider&gt;]
                                     [--cipher [&lt;cipher&gt;]]
                                     [--key-size [&lt;key-size&gt;]]
                                     [--control-location &lt;control-location&gt;]
                                     &lt;volume-type&gt;</computeroutput></screen>
        <para>
Update encryption type information for a volume type (Admin Only).
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;volume-type&gt;</command></term>
    <listitem>
      <para>
        Name or ID of the volume type
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
  <variablelist wordsize="10">
    <title>Optional arguments</title>
  <varlistentry>
    <term><command>--provider &lt;provider&gt;</command></term>
    <listitem>
      <para>
      Class providing encryption support (e.g.
      LuksEncryptor) (Optional)
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--cipher [&lt;cipher&gt;]</command></term>
    <listitem>
      <para>
        Encryption algorithm/mode to use (e.g., aes-xts-
      plain64). Provide parameter without value to set to
      provider default. (Optional)
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--key-size [&lt;key-size&gt;]</command></term>
    <listitem>
      <para>
      Size of the encryption key, in bits (e.g., 128, 256).
      Provide parameter without value to set to provider
      default. (Optional)
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--control-location &lt;control-location&gt;</command></term>
    <listitem>
      <para>
      Notional service where encryption is performed (e.g.,
      front-end=Nova). Values: 'front-end', 'back-end'
      (Optional)
      </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 &lt;volume&gt; &lt;new_size&gt;</computeroutput></screen>
        <para>
Attempts to extend size of an existing volume.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;volume&gt;</command></term>
    <listitem>
      <para>
        Name or ID of volume to extend.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;new_size&gt;</command></term>
    <listitem>
      <para>
        New size of volume, in GiBs.
      </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 &lt;volume&gt; [&lt;volume&gt; ...]</computeroutput></screen>
        <para>
Attempts force-delete of volume, regardless of state.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;volume&gt;</command></term>
    <listitem>
      <para>
        Name or ID of volume or volumes to delete.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="cinderclient_subcommand_get-capabilities_v2">
        <title>cinder get-capabilities (v2)</title>
        <screen><computeroutput>usage: cinder --os-volume-api-version 2 get-capabilities &lt;host&gt;</computeroutput></screen>
        <para>
Show backend volume stats and properties. Admin only.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;host&gt;</command></term>
    <listitem>
      <para>
        Cinder host to show backend volume stats and properties; takes the
      form: host@backend-name
      </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_image-metadata_v2">
        <title>cinder image-metadata (v2)</title>
        <screen><computeroutput>usage: cinder --os-volume-api-version 2 image-metadata &lt;volume&gt; &lt;action&gt; &lt;key=value&gt; [&lt;key=value&gt; ...]</computeroutput></screen>
        <para>
Sets or deletes volume image metadata.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;volume&gt;</command></term>
    <listitem>
      <para>
        Name or ID of volume for which to update metadata.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;action&gt;</command></term>
    <listitem>
      <para>
        The action. Valid values are 'set' or 'unset.'
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;key=value&gt;</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_image-metadata-show_v2">
        <title>cinder image-metadata-show (v2)</title>
        <screen><computeroutput>usage: cinder --os-volume-api-version 2 image-metadata-show &lt;volume&gt;</computeroutput></screen>
        <para>
Shows volume image metadata.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;volume&gt;</command></term>
    <listitem>
      <para>
        ID of volume.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="cinderclient_subcommand_list_v2">
        <title>cinder list (v2)</title>
        <screen><computeroutput>usage: cinder --os-volume-api-version 2 list [--all-tenants [&lt;0|1&gt;]] [--name &lt;name&gt;] [--status &lt;status&gt;]
                   [--migration_status &lt;migration_status&gt;]
                   [--metadata [&lt;key=value&gt; [&lt;key=value&gt; ...]]]
                   [--marker &lt;marker&gt;] [--limit &lt;limit&gt;]
                   [--sort &lt;key&gt;[:&lt;direction&gt;]] [--tenant [&lt;tenant&gt;]]</computeroutput></screen>
        <para>
Lists all volumes.
        </para>  <variablelist wordsize="10">
    <title>Optional arguments</title>
  <varlistentry>
    <term><command>--all-tenants [&lt;0|1&gt;]</command></term>
    <listitem>
      <para>
      Shows details for all tenants. Admin only.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--name &lt;name&gt;</command></term>
    <listitem>
      <para>
        Filters results by a name. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--status &lt;status&gt;</command></term>
    <listitem>
      <para>
        Filters results by a status. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--migration_status &lt;migration_status&gt;</command></term>
    <listitem>
      <para>
      Filters results by a migration status. Default=None.
      Admin only.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--metadata [&lt;key=value&gt; [&lt;key=value&gt; ...]]</command></term>
    <listitem>
      <para>
      Filters results by a metadata key and value pair.
      Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--marker &lt;marker&gt;</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 &lt;limit&gt;</command></term>
    <listitem>
      <para>
        Maximum number of volumes to return. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--sort &lt;key&gt;[:&lt;direction&gt;]</command></term>
    <listitem>
      <para>
      Comma-separated list of sort keys and directions in
      the form of &lt;key&gt;[:&lt;asc|desc&gt;]. Valid keys: id,
      status, size, availability_zone, name, bootable,
      created_at. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--tenant [&lt;tenant&gt;]</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 &lt;id-type&gt;] [--name &lt;name&gt;]
                     [--description &lt;description&gt;]
                     [--volume-type &lt;volume-type&gt;]
                     [--availability-zone &lt;availability-zone&gt;]
                     [--metadata [&lt;key=value&gt; [&lt;key=value&gt; ...]]] [--bootable]
                     &lt;host&gt; &lt;identifier&gt;</computeroutput></screen>
        <para>
Manage an existing volume.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;host&gt;</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>&lt;identifier&gt;</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 &lt;id-type&gt;</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 &lt;name&gt;</command></term>
    <listitem>
      <para>
        Volume name (Default=None)
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--description &lt;description&gt;</command></term>
    <listitem>
      <para>
      Volume description (Default=None)
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--volume-type &lt;volume-type&gt;</command></term>
    <listitem>
      <para>
      Volume type (Default=None)
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--availability-zone &lt;availability-zone&gt;</command></term>
    <listitem>
      <para>
      Availability zone for volume (Default=None)
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--metadata [&lt;key=value&gt; [&lt;key=value&gt; ...]]</command></term>
    <listitem>
      <para>
      Metadata key=value pairs (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 &lt;volume&gt; &lt;action&gt; &lt;key=value&gt; [&lt;key=value&gt; ...]</computeroutput></screen>
        <para>
Sets or deletes volume metadata.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;volume&gt;</command></term>
    <listitem>
      <para>
        Name or ID of volume for which to update metadata.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;action&gt;</command></term>
    <listitem>
      <para>
        The action. Valid values are "set" or "unset."
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;key=value&gt;</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 &lt;volume&gt;</computeroutput></screen>
        <para>
Shows volume metadata.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;volume&gt;</command></term>
    <listitem>
      <para>
        ID of volume.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="cinderclient_subcommand_metadata-update-all_v2">
        <title>cinder metadata-update-all (v2)</title>
        <screen><computeroutput>usage: cinder --os-volume-api-version 2 metadata-update-all &lt;volume&gt; &lt;key=value&gt; [&lt;key=value&gt; ...]</computeroutput></screen>
        <para>
Updates volume metadata.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;volume&gt;</command></term>
    <listitem>
      <para>
        ID of volume for which to update metadata.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;key=value&gt;</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 [&lt;True|False&gt;]]
                      [--lock-volume [&lt;True|False&gt;]]
                      &lt;volume&gt; &lt;host&gt;</computeroutput></screen>
        <para>
Migrates volume to a new host.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;volume&gt;</command></term>
    <listitem>
      <para>
        ID of volume to migrate.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;host&gt;</command></term>
    <listitem>
      <para>
        Destination host. Takes the form: host@backend-
      name#pool
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
  <variablelist wordsize="10">
    <title>Optional arguments</title>
  <varlistentry>
    <term><command>--force-host-copy [&lt;True|False&gt;]</command></term>
    <listitem>
      <para>
      Enables or disables generic host-based force-
      migration, which bypasses driver optimizations.
      Default=False.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--lock-volume [&lt;True|False&gt;]</command></term>
    <listitem>
      <para>
      Enables or disables the termination of volume
      migration caused by other commands. This option
      applies to the available volume. True means it locks
      the volume state and does not allow the migration to
      be aborted. The volume status will be in maintenance
      during the migration. False means it allows the volume
      migration to be aborted. The volume status is still in
      the original status. 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 &lt;qos_specs&gt; &lt;volume_type_id&gt;</computeroutput></screen>
        <para>
Associates qos specs with specified volume type.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;qos_specs&gt;</command></term>
    <listitem>
      <para>
        ID of QoS specifications.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;volume_type_id&gt;</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 &lt;name&gt; &lt;key=value&gt; [&lt;key=value&gt; ...]</computeroutput></screen>
        <para>
Creates a qos specs.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;name&gt;</command></term>
    <listitem>
      <para>
        Name of new QoS specifications.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;key=value&gt;</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 [&lt;True|False&gt;]] &lt;qos_specs&gt;</computeroutput></screen>
        <para>
Deletes a specified qos specs.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;qos_specs&gt;</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 [&lt;True|False&gt;]</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 &lt;qos_specs&gt; &lt;volume_type_id&gt;</computeroutput></screen>
        <para>
Disassociates qos specs from specified volume type.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;qos_specs&gt;</command></term>
    <listitem>
      <para>
        ID of QoS specifications.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;volume_type_id&gt;</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 &lt;qos_specs&gt;</computeroutput></screen>
        <para>
Disassociates qos specs from all its associations.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;qos_specs&gt;</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 &lt;qos_specs&gt;</computeroutput></screen>
        <para>
Lists all associations for specified qos specs.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;qos_specs&gt;</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 &lt;qos_specs&gt; &lt;action&gt; 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>&lt;qos_specs&gt;</command></term>
    <listitem>
      <para>
        ID of QoS specifications.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;action&gt;</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 &lt;qos_specs&gt;</computeroutput></screen>
        <para>
Shows qos specs details.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;qos_specs&gt;</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 &lt;class&gt;</computeroutput></screen>
        <para>
Lists quotas for a quota class.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;class&gt;</command></term>
    <listitem>
      <para>
        Name of quota class 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 &lt;volumes&gt;]
                                 [--snapshots &lt;snapshots&gt;]
                                 [--gigabytes &lt;gigabytes&gt;]
                                 [--volume-type &lt;volume_type_name&gt;]
                                 &lt;class_name&gt;</computeroutput></screen>
        <para>
Updates quotas for a quota class.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;class_name&gt;</command></term>
    <listitem>
      <para>
        Name of quota class for which to set quotas.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
  <variablelist wordsize="10">
    <title>Optional arguments</title>
  <varlistentry>
    <term><command>--volumes &lt;volumes&gt;</command></term>
    <listitem>
      <para>
        The new "volumes" quota value. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--snapshots &lt;snapshots&gt;</command></term>
    <listitem>
      <para>
      The new "snapshots" quota value. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--gigabytes &lt;gigabytes&gt;</command></term>
    <listitem>
      <para>
      The new "gigabytes" quota value. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--volume-type &lt;volume_type_name&gt;</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 &lt;tenant_id&gt;</computeroutput></screen>
        <para>
Lists default quotas for a tenant.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;tenant_id&gt;</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 &lt;tenant_id&gt;</computeroutput></screen>
        <para>
Delete the quotas for a tenant.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;tenant_id&gt;</command></term>
    <listitem>
      <para>
        UUID of tenant to 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 &lt;tenant_id&gt;</computeroutput></screen>
        <para>
Lists quotas for a tenant.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;tenant_id&gt;</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 &lt;volumes&gt;] [--snapshots &lt;snapshots&gt;]
                           [--gigabytes &lt;gigabytes&gt;] [--backups &lt;backups&gt;]
                           [--backup-gigabytes &lt;backup_gigabytes&gt;]
                           [--consistencygroups &lt;consistencygroups&gt;]
                           [--volume-type &lt;volume_type_name&gt;]
                           [--per-volume-gigabytes &lt;per_volume_gigabytes&gt;]
                           &lt;tenant_id&gt;</computeroutput></screen>
        <para>
Updates quotas for a tenant.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;tenant_id&gt;</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 &lt;volumes&gt;</command></term>
    <listitem>
      <para>
        The new "volumes" quota value. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--snapshots &lt;snapshots&gt;</command></term>
    <listitem>
      <para>
      The new "snapshots" quota value. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--gigabytes &lt;gigabytes&gt;</command></term>
    <listitem>
      <para>
      The new "gigabytes" quota value. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--backups &lt;backups&gt;</command></term>
    <listitem>
      <para>
        The new "backups" quota value. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--backup-gigabytes &lt;backup_gigabytes&gt;</command></term>
    <listitem>
      <para>
      The new "backup_gigabytes" quota value. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--consistencygroups &lt;consistencygroups&gt;</command></term>
    <listitem>
      <para>
      The new "consistencygroups" quota value. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--volume-type &lt;volume_type_name&gt;</command></term>
    <listitem>
      <para>
      Volume type. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--per-volume-gigabytes &lt;per_volume_gigabytes&gt;</command></term>
    <listitem>
      <para>
      Set max volume size limit. 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 &lt;tenant_id&gt;</computeroutput></screen>
        <para>
Lists quota usage for a tenant.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;tenant_id&gt;</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 &lt;volume&gt; &lt;True|true|False|false&gt;</computeroutput></screen>
        <para>
Updates volume read-only access-mode flag.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;volume&gt;</command></term>
    <listitem>
      <para>
        ID of volume to update.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;True|true|False|false&gt;</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 &lt;description&gt;] &lt;volume&gt; [&lt;name&gt;]</computeroutput></screen>
        <para>
Renames a volume.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;volume&gt;</command></term>
    <listitem>
      <para>
        Name or ID of volume to rename.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;name&gt;</command></term>
    <listitem>
      <para>
        New name for volume.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
  <variablelist wordsize="10">
    <title>Optional arguments</title>
  <varlistentry>
    <term><command>--description &lt;description&gt;</command></term>
    <listitem>
      <para>
      Volume description. Default=None.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="cinderclient_subcommand_replication-disable_v2">
        <title>cinder replication-disable (v2)</title>
        <screen><computeroutput>usage: cinder --os-volume-api-version 2 replication-disable &lt;volume&gt;</computeroutput></screen>
        <para>
Disables volume replication on a given volume.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;volume&gt;</command></term>
    <listitem>
      <para>
        ID of volume to disable replication.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="cinderclient_subcommand_replication-enable_v2">
        <title>cinder replication-enable (v2)</title>
        <screen><computeroutput>usage: cinder --os-volume-api-version 2 replication-enable &lt;volume&gt;</computeroutput></screen>
        <para>
Enables volume replication on a given volume.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;volume&gt;</command></term>
    <listitem>
      <para>
        ID of volume to enable replication.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="cinderclient_subcommand_replication-failover_v2">
        <title>cinder replication-failover (v2)</title>
        <screen><computeroutput>usage: cinder --os-volume-api-version 2 replication-failover &lt;volume&gt; &lt;secondary&gt;</computeroutput></screen>
        <para>
Failover a volume to a secondary target
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;volume&gt;</command></term>
    <listitem>
      <para>
        ID of volume to failover.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;secondary&gt;</command></term>
    <listitem>
      <para>
        A unqiue identifier that represents a failover target.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="cinderclient_subcommand_replication-list-targets_v2">
        <title>cinder replication-list-targets (v2)</title>
        <screen><computeroutput>usage: cinder --os-volume-api-version 2 replication-list-targets &lt;volume&gt;</computeroutput></screen>
        <para>
List replication targets available for a volume.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;volume&gt;</command></term>
    <listitem>
      <para>
        ID of volume to list available replication targets.
      </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 &lt;volume&gt;</computeroutput></screen>
        <para>
Promote a secondary volume to primary for a relationship.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;volume&gt;</command></term>
    <listitem>
      <para>
        Name or ID of the volume to promote. The volume should have the
      replica volume created with source-replica argument.
      </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 &lt;volume&gt;</computeroutput></screen>
        <para>
Sync the secondary volume with primary for a relationship.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;volume&gt;</command></term>
    <listitem>
      <para>
        Name or ID of the volume to reenable replication. The replication-
      status of the volume should be inactive.
      </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 &lt;state&gt;] [--attach-status &lt;attach-status&gt;]
                          [--reset-migration-status]
                          &lt;volume&gt; [&lt;volume&gt; ...]</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>&lt;volume&gt;</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 &lt;state&gt;</command></term>
    <listitem>
      <para>
        The state to assign to the volume. Valid values are
      "available", "error", "creating", "deleting", "in-
      use", "attaching", "detaching", "error_deleting" and
      "maintenance". 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>
  <varlistentry>
    <term><command>--attach-status &lt;attach-status&gt;</command></term>
    <listitem>
      <para>
      The attach status to assign to the volume in the
      DataBase, with no regard to the actual status. Valid
      values are "attached" and "detached". Default=None,
      that means the status is unchanged.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--reset-migration-status</command></term>
    <listitem>
      <para>
      Clears the migration status of the volume in the
      DataBase that indicates the volume is source or
      destination of volume migration, with no regard to the
      actual status.
      </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 &lt;never|on-demand&gt;]
                     &lt;volume&gt; &lt;volume-type&gt;</computeroutput></screen>
        <para>
Changes the volume type for a volume.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;volume&gt;</command></term>
    <listitem>
      <para>
        Name or ID of volume for which to modify type.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;volume-type&gt;</command></term>
    <listitem>
      <para>
        New volume type.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
  <variablelist wordsize="10">
    <title>Optional arguments</title>
  <varlistentry>
    <term><command>--migration-policy &lt;never|on-demand&gt;</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 &lt;reason&gt;] &lt;hostname&gt; &lt;binary&gt;</computeroutput></screen>
        <para>
Disables the service.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;hostname&gt;</command></term>
    <listitem>
      <para>
        Host name.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;binary&gt;</command></term>
    <listitem>
      <para>
        Service binary.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
  <variablelist wordsize="10">
    <title>Optional arguments</title>
  <varlistentry>
    <term><command>--reason &lt;reason&gt;</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 &lt;hostname&gt; &lt;binary&gt;</computeroutput></screen>
        <para>
Enables the service.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;hostname&gt;</command></term>
    <listitem>
      <para>
        Host name.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;binary&gt;</command></term>
    <listitem>
      <para>
        Service binary.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="cinderclient_subcommand_service-list_v2">
        <title>cinder service-list (v2)</title>
        <screen><computeroutput>usage: cinder --os-volume-api-version 2 service-list [--host &lt;hostname&gt;] [--binary &lt;binary&gt;]</computeroutput></screen>
        <para>
Lists all services. Filter by host and service binary.
        </para>  <variablelist wordsize="10">
    <title>Optional arguments</title>
  <varlistentry>
    <term><command>--host &lt;hostname&gt;</command></term>
    <listitem>
      <para>
        Host name. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--binary &lt;binary&gt;</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 &lt;volume&gt; &lt;True|true|False|false&gt;</computeroutput></screen>
        <para>
Update bootable status of a volume.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;volume&gt;</command></term>
    <listitem>
      <para>
        ID of the volume to update.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;True|true|False|false&gt;</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 &lt;volume&gt;</computeroutput></screen>
        <para>
Shows volume details.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;volume&gt;</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 [&lt;True|False&gt;]] [--name &lt;name&gt;]
                              [--description &lt;description&gt;]
                              [--metadata [&lt;key=value&gt; [&lt;key=value&gt; ...]]]
                              &lt;volume&gt;</computeroutput></screen>
        <para>
Creates a snapshot.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;volume&gt;</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 [&lt;True|False&gt;]</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 &lt;name&gt;</command></term>
    <listitem>
      <para>
        Snapshot name. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--description &lt;description&gt;</command></term>
    <listitem>
      <para>
      Snapshot description. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--metadata [&lt;key=value&gt; [&lt;key=value&gt; ...]]</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 &lt;snapshot&gt; [&lt;snapshot&gt; ...]</computeroutput></screen>
        <para>
Removes one or more snapshots.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;snapshot&gt;</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 [&lt;0|1&gt;]] [--name &lt;name&gt;]
                            [--status &lt;status&gt;] [--volume-id &lt;volume-id&gt;]
                            [--marker &lt;marker&gt;] [--limit &lt;limit&gt;]
                            [--sort &lt;key&gt;[:&lt;direction&gt;]]</computeroutput></screen>
        <para>
Lists all snapshots.
        </para>  <variablelist wordsize="10">
    <title>Optional arguments</title>
  <varlistentry>
    <term><command>--all-tenants [&lt;0|1&gt;]</command></term>
    <listitem>
      <para>
      Shows details for all tenants. Admin only.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--name &lt;name&gt;</command></term>
    <listitem>
      <para>
        Filters results by a name. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--status &lt;status&gt;</command></term>
    <listitem>
      <para>
        Filters results by a status. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--volume-id &lt;volume-id&gt;</command></term>
    <listitem>
      <para>
      Filters results by a volume ID. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--marker &lt;marker&gt;</command></term>
    <listitem>
      <para>
        Begin returning snapshots that appear later in the
      snapshot list than that represented by this id.
      Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--limit &lt;limit&gt;</command></term>
    <listitem>
      <para>
        Maximum number of snapshots to return. Default=None.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--sort &lt;key&gt;[:&lt;direction&gt;]</command></term>
    <listitem>
      <para>
      Comma-separated list of sort keys and directions in
      the form of &lt;key&gt;[:&lt;asc|desc&gt;]. Valid keys: id,
      status, size, availability_zone, name, bootable,
      created_at. 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 &lt;snapshot&gt; &lt;action&gt; &lt;key=value&gt;
                                [&lt;key=value&gt; ...]</computeroutput></screen>
        <para>
Sets or deletes snapshot metadata.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;snapshot&gt;</command></term>
    <listitem>
      <para>
        ID of snapshot for which to update metadata.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;action&gt;</command></term>
    <listitem>
      <para>
        The action. Valid values are "set" or "unset."
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;key=value&gt;</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 &lt;snapshot&gt;</computeroutput></screen>
        <para>
Shows snapshot metadata.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;snapshot&gt;</command></term>
    <listitem>
      <para>
        ID of snapshot.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="cinderclient_subcommand_snapshot-metadata-update-all_v2">
        <title>cinder snapshot-metadata-update-all (v2)</title>
        <screen><computeroutput>usage: cinder --os-volume-api-version 2 snapshot-metadata-update-all &lt;snapshot&gt; &lt;key=value&gt;
                                           [&lt;key=value&gt; ...]</computeroutput></screen>
        <para>
Updates snapshot metadata.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;snapshot&gt;</command></term>
    <listitem>
      <para>
        ID of snapshot for which to update metadata.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;key=value&gt;</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 &lt;description&gt;]
                              &lt;snapshot&gt; [&lt;name&gt;]</computeroutput></screen>
        <para>
Renames a snapshot.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;snapshot&gt;</command></term>
    <listitem>
      <para>
        Name or ID of snapshot.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;name&gt;</command></term>
    <listitem>
      <para>
        New name for snapshot.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
  <variablelist wordsize="10">
    <title>Optional arguments</title>
  <varlistentry>
    <term><command>--description &lt;description&gt;</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 &lt;state&gt;]
                                   &lt;snapshot&gt; [&lt;snapshot&gt; ...]</computeroutput></screen>
        <para>
Explicitly updates the snapshot state.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;snapshot&gt;</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 &lt;state&gt;</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 &lt;snapshot&gt;</computeroutput></screen>
        <para>
Shows snapshot details.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;snapshot&gt;</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 &lt;transfer&gt; &lt;auth_key&gt;</computeroutput></screen>
        <para>
Accepts a volume transfer.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;transfer&gt;</command></term>
    <listitem>
      <para>
        ID of transfer to accept.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;auth_key&gt;</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 &lt;name&gt;] &lt;volume&gt;</computeroutput></screen>
        <para>
Creates a volume transfer.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;volume&gt;</command></term>
    <listitem>
      <para>
        Name or ID of volume to transfer.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
  <variablelist wordsize="10">
    <title>Optional arguments</title>
  <varlistentry>
    <term><command>--name &lt;name&gt;</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 &lt;transfer&gt;</computeroutput></screen>
        <para>
Undoes a transfer.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;transfer&gt;</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 [&lt;0|1&gt;]]</computeroutput></screen>
        <para>
Lists all transfers.
        </para>  <variablelist wordsize="10">
    <title>Optional arguments</title>
  <varlistentry>
    <term><command>--all-tenants [&lt;0|1&gt;]</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 &lt;transfer&gt;</computeroutput></screen>
        <para>
Shows transfer details.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;transfer&gt;</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 &lt;volume_type&gt; --project-id
                              &lt;project_id&gt;</computeroutput></screen>
        <para>
Adds volume type access for the given project.
        </para>  <variablelist wordsize="10">
    <title>Optional arguments</title>
  <varlistentry>
    <term><command>--volume-type &lt;volume_type&gt;</command></term>
    <listitem>
      <para>
      Volume type name or ID to add access for the given
      project.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--project-id &lt;project_id&gt;</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 &lt;volume_type&gt;</computeroutput></screen>
        <para>
Print access information about the given volume type.
        </para>  <variablelist wordsize="10">
    <title>Optional arguments</title>
  <varlistentry>
    <term><command>--volume-type &lt;volume_type&gt;</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 &lt;volume_type&gt; --project-id
                                 &lt;project_id&gt;</computeroutput></screen>
        <para>
Removes volume type access for the given project.
        </para>  <variablelist wordsize="10">
    <title>Optional arguments</title>
  <varlistentry>
    <term><command>--volume-type &lt;volume_type&gt;</command></term>
    <listitem>
      <para>
      Volume type name or ID to remove access for the given
      project.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--project-id &lt;project_id&gt;</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 &lt;description&gt;]
                          [--is-public &lt;is-public&gt;]
                          &lt;name&gt;</computeroutput></screen>
        <para>
Creates a volume type.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;name&gt;</command></term>
    <listitem>
      <para>
        Name of new volume type.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
  <variablelist wordsize="10">
    <title>Optional arguments</title>
  <varlistentry>
    <term><command>--description &lt;description&gt;</command></term>
    <listitem>
      <para>
      Description of new volume type.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--is-public &lt;is-public&gt;</command></term>
    <listitem>
      <para>
      Make type accessible to the public (default true).
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="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 &lt;id&gt;</computeroutput></screen>
        <para>
Deletes a volume type.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;id&gt;</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 &lt;vtype&gt; &lt;action&gt; &lt;key=value&gt; [&lt;key=value&gt; ...]</computeroutput></screen>
        <para>
Sets or unsets extra_spec for a volume type.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;vtype&gt;</command></term>
    <listitem>
      <para>
        Name or ID of volume type.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;action&gt;</command></term>
    <listitem>
      <para>
        The action. Valid values are "set" or "unset."
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;key=value&gt;</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</computeroutput></screen>
        <para>
Lists available 'volume types'. (Admin only will see private types)
        </para>
    </section>
    <section xml:id="cinderclient_subcommand_type-show_v2">
        <title>cinder type-show (v2)</title>
        <screen><computeroutput>usage: cinder --os-volume-api-version 2 type-show &lt;volume_type&gt;</computeroutput></screen>
        <para>
Show volume type details.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;volume_type&gt;</command></term>
    <listitem>
      <para>
        Name or ID of the volume type.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="cinderclient_subcommand_type-update_v2">
        <title>cinder type-update (v2)</title>
        <screen><computeroutput>usage: cinder --os-volume-api-version 2 type-update [--name &lt;name&gt;] [--description &lt;description&gt;]
                          [--is-public &lt;is-public&gt;]
                          &lt;id&gt;</computeroutput></screen>
        <para>
Updates volume type name ,description and/or is_public.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;id&gt;</command></term>
    <listitem>
      <para>
        ID of the volume type.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
  <variablelist wordsize="10">
    <title>Optional arguments</title>
  <varlistentry>
    <term><command>--name &lt;name&gt;</command></term>
    <listitem>
      <para>
        Name of the volume type.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--description &lt;description&gt;</command></term>
    <listitem>
      <para>
      Description of the volume type.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--is-public &lt;is-public&gt;</command></term>
    <listitem>
      <para>
      Make type accessible to the public or not.
      </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 &lt;volume&gt;</computeroutput></screen>
        <para>
Stop managing a volume.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;volume&gt;</command></term>
    <listitem>
      <para>
        Name or ID of the volume to 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 [&lt;True|False&gt;]]
                              [--container-format &lt;container-format&gt;]
                              [--disk-format &lt;disk-format&gt;]
                              &lt;volume&gt; &lt;image-name&gt;</computeroutput></screen>
        <para>
Uploads volume to Image Service as an image.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;volume&gt;</command></term>
    <listitem>
      <para>
        Name or ID of volume to snapshot.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;image-name&gt;</command></term>
    <listitem>
      <para>
        The new image name.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
  <variablelist wordsize="10">
    <title>Optional arguments</title>
  <varlistentry>
    <term><command>--force [&lt;True|False&gt;]</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 &lt;container-format&gt;</command></term>
    <listitem>
      <para>
      Container format type. Default is bare.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--disk-format &lt;disk-format&gt;</command></term>
    <listitem>
      <para>
      Disk format type. Default is raw.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    </section>
</chapter>