openstack-manuals/doc/common/section_cli_cinder_commands.xml

<?xml version="1.0" encoding="UTF-8"?>
<section 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>cinder commands</title>
    <para>The cinder client is the command-line interface (CLI) for the
         OpenStack Block Storage API and its extensions.</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>              [--os-password &lt;auth-password>]
              [--os-tenant-name &lt;auth-tenant-name>]
              [--os-tenant-id &lt;auth-tenant-id>] [--os-auth-url &lt;auth-url>]
              [--os-region-name &lt;region-name>] [--service-type &lt;service-type>]
              [--service-name &lt;service-name>]
              [--volume-service-name &lt;volume-service-name>]
              [--endpoint-type &lt;endpoint-type>]
              [--os-volume-api-version &lt;volume-api-ver>]
              [--os-cacert &lt;ca-certificate>] [--retries &lt;retries>]
              &lt;subcommand> ...</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_command_pos">
        <title>cinder positional arguments</title>
        <screen><computeroutput>  &lt;subcommand>
    absolute-limits     Print a list of absolute limits for a user
    availability-zone-list
                        List all the availability zones.
    backup-create       Creates a backup.
    backup-delete       Remove a backup.
    backup-list         List all the backups.
    backup-restore      Restore a backup.
    backup-show         Show details about a backup.
    create              Add a new volume.
    credentials         Show user credentials returned from auth.
    delete              Remove volume(s).
    encryption-type-create
                        Create a new encryption type for a volume type (Admin
                        Only).
    encryption-type-list
                        List encryption type information for all volume types
                        (Admin Only).
    encryption-type-show
                        Show the encryption type information for a volume type
                        (Admin Only).
    endpoints           Discover endpoints that get returned from the
                        authenticate services.
    extend              Attempt to extend the size of an existing volume.
    extra-specs-list    Print a list of current 'volume types and extra specs'
                        (Admin Only).
    force-delete        Attempt forced removal of volume(s), regardless of the
                        state(s).
    list                List all the volumes.
    metadata            Set or Delete metadata on a volume.
    metadata-show       Show metadata of given volume.
    metadata-update-all
                        Update all metadata of a volume.
    migrate             Migrate the volume to the new host.
    qos-associate       Associate qos specs with specific volume type.
    qos-create          Create a new qos specs.
    qos-delete          Delete a specific qos specs.
    qos-disassociate    Disassociate qos specs from specific volume type.
    qos-disassociate-all
                        Disassociate qos specs from all of its associations.
    qos-get-association
                        Get all associations of specific qos specs.
    qos-key             Set or unset specifications for a qos spec.
    qos-list            Get full list of qos specs.
    qos-show            Get a specific qos specs.
    quota-class-show    List the quotas for a quota class.
    quota-class-update  Update the quotas for a quota class.
    quota-defaults      List the default quotas for a tenant.
    quota-show          List the quotas for a tenant.
    quota-update        Update the quotas for a tenant.
    quota-usage         List the quota usage for a tenant.
    rate-limits         Print a list of rate limits for a user
    readonly-mode-update
                        Update volume read-only access mode read_only.
    rename              Rename a volume.
    reset-state         Explicitly update the state of a volume.
    service-disable     Disable the service.
    service-enable      Enable the service.
    service-list        List all the services. Filter by host &amp; service
                        binary.
    show                Show details about a volume.
    snapshot-create     Add a new snapshot.
    snapshot-delete     Remove a snapshot.
    snapshot-list       List all the snapshots.
    snapshot-metadata   Set or Delete metadata of a snapshot.
    snapshot-metadata-show
                        Show metadata of given snapshot.
    snapshot-metadata-update-all
                        Update all metadata of a snapshot.
    snapshot-rename     Rename a snapshot.
    snapshot-reset-state
                        Explicitly update the state of a snapshot.
    snapshot-show       Show details about a snapshot.
    transfer-accept     Accepts a volume transfer.
    transfer-create     Creates a volume transfer.
    transfer-delete     Undo a transfer.
    transfer-list       List all the transfers.
    transfer-show       Show details about a transfer.
    type-create         Create a new volume type.
    type-delete         Delete a specific volume type.
    type-key            Set or unset extra_spec for a volume type.
    type-list           Print a list of available 'volume types'.
    upload-to-image     Upload volume to image service as image.
    bash-completion     Print arguments for bash_completion.
    help                Display help about this program or one of its
                        subcommands.
    list-extensions     List all the os-api extensions that are available.
</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_command_optional">
        <title>cinder optional arguments</title>
        <screen><computeroutput>  --version             show program's version number and exit
  --debug               Print debugging output
  --os-username &lt;auth-user-name>
                        Defaults to env[OS_USERNAME].
  --os-password &lt;auth-password>
                        Defaults to env[OS_PASSWORD].
  --os-tenant-name &lt;auth-tenant-name>
                        Defaults to env[OS_TENANT_NAME].
  --os-tenant-id &lt;auth-tenant-id>
                        Defaults to env[OS_TENANT_ID].
  --os-auth-url &lt;auth-url>
                        Defaults to env[OS_AUTH_URL].
  --os-region-name &lt;region-name>
                        Defaults to env[OS_REGION_NAME].
  --service-type &lt;service-type>
                        Defaults to volume for most actions
  --service-name &lt;service-name>
                        Defaults to env[CINDER_SERVICE_NAME]
  --volume-service-name &lt;volume-service-name>
                        Defaults to env[CINDER_VOLUME_SERVICE_NAME]
  --endpoint-type &lt;endpoint-type>
                        Defaults to env[CINDER_ENDPOINT_TYPE] or publicURL.
  --os-volume-api-version &lt;volume-api-ver>
                        Accepts 1 or 2,defaults to env[OS_VOLUME_API_VERSION].
  --os-cacert &lt;ca-certificate>
                        Specify a CA bundle file to use in verifying a TLS
                        (https) server certificate. Defaults to env[OS_CACERT]
  --retries &lt;retries>   Number of retries.
</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_absolute-limits">
        <title>cinder absolute-limits command</title>
        <screen><computeroutput>usage: cinder absolute-limits

Print a list of absolute limits for a user

</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_availability-zone-list">
        <title>cinder availability-zone-list command</title>
        <screen><computeroutput>usage: cinder availability-zone-list

List all the availability zones.

</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_backup-create">
        <title>cinder backup-create command</title>
        <screen><computeroutput>usage: cinder backup-create [--container &lt;container>]
                            [--display-name &lt;display-name>]
                            [--display-description &lt;display-description>]
                            &lt;volume>

Creates a backup.

Positional arguments:
  &lt;volume>              Name or ID of the volume to backup.

Optional arguments:
  --container &lt;container>
                        Optional Backup container name. (Default=None)
  --display-name &lt;display-name>
                        Optional backup name. (Default=None)
  --display-description &lt;display-description>
                        Optional backup description. (Default=None)

</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_backup-delete">
        <title>cinder backup-delete command</title>
        <screen><computeroutput>usage: cinder backup-delete &lt;backup>

Remove a backup.

Positional arguments:
  &lt;backup>  Name or ID of the backup to delete.

</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_backup-list">
        <title>cinder backup-list command</title>
        <screen><computeroutput>usage: cinder backup-list

List all the backups.

</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_backup-restore">
        <title>cinder backup-restore command</title>
        <screen><computeroutput>usage: cinder backup-restore [--volume-id &lt;volume>] &lt;backup>

Restore a backup.

Positional arguments:
  &lt;backup>              ID of the backup to restore.

Optional arguments:
  --volume-id &lt;volume>  Optional ID(or name) of the volume to restore to.

</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_backup-show">
        <title>cinder backup-show command</title>
        <screen><computeroutput>usage: cinder backup-show &lt;backup>

Show details about a backup.

Positional arguments:
  &lt;backup>  Name or ID of the backup.

</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_create">
        <title>cinder create command</title>
        <screen><computeroutput>usage: cinder create [--snapshot-id &lt;snapshot-id>]
                     [--source-volid &lt;source-volid>] [--image-id &lt;image-id>]
                     [--display-name &lt;display-name>]
                     [--display-description &lt;display-description>]
                     [--volume-type &lt;volume-type>]
                     [--availability-zone &lt;availability-zone>]
                     [--metadata [&lt;key=value> [&lt;key=value> ...]]]
                     &lt;size>

Add a new volume.

Positional arguments:
  &lt;size>                Size of volume in GB

Optional arguments:
  --snapshot-id &lt;snapshot-id>
                        Create volume from snapshot id (Optional,
                        Default=None)
  --source-volid &lt;source-volid>
                        Create volume from volume id (Optional, Default=None)
  --image-id &lt;image-id>
                        Create volume from image id (Optional, Default=None)
  --display-name &lt;display-name>
                        Volume name (Optional, Default=None)
  --display-description &lt;display-description>
                        Volume description (Optional, Default=None)
  --volume-type &lt;volume-type>
                        Volume type (Optional, Default=None)
  --availability-zone &lt;availability-zone>
                        Availability zone for volume (Optional, Default=None)
  --metadata [&lt;key=value> [&lt;key=value> ...]]
                        Metadata key=value pairs (Optional, Default=None)

</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_credentials">
        <title>cinder credentials command</title>
        <screen><computeroutput>usage: cinder credentials

Show user credentials returned from auth.

</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_delete">
        <title>cinder delete command</title>
        <screen><computeroutput>usage: cinder delete &lt;volume> [&lt;volume> ...]

Remove volume(s).

Positional arguments:
  &lt;volume>  Name or ID of the volume(s) to delete.

</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_encryption-type-create">
        <title>cinder encryption-type-create command</title>
        <screen><computeroutput>usage: cinder encryption-type-create [--cipher &lt;cipher>]
                                     [--key_size &lt;key_size>]
                                     [--control_location &lt;control_location>]
                                     &lt;volume_type> &lt;provider>

Create a new encryption type for a volume type (Admin Only).

Positional arguments:
  &lt;volume_type>         Name or ID of the volume type
  &lt;provider>            Class providing encryption support (e.g.
                        LuksEncryptor)

Optional arguments:
  --cipher &lt;cipher>     Encryption algorithm/mode to use (e.g., aes-xts-
                        plain64) (Optional, Default=None)
  --key_size &lt;key_size>
                        Size of the encryption key, in bits (e.g., 128, 256)
                        (Optional, Default=None)
  --control_location &lt;control_location>
                        Notional service where encryption is performed (e.g.,
                        front-end=Nova). Values: 'front-end', 'back-end'
                        (Optional, Default=None)

</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_encryption-type-list">
        <title>cinder encryption-type-list command</title>
        <screen><computeroutput>usage: cinder encryption-type-list

List encryption type information for all volume types (Admin Only).

</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_encryption-type-show">
        <title>cinder encryption-type-show command</title>
        <screen><computeroutput>usage: cinder encryption-type-show &lt;volume_type>

Show the encryption type information for a volume type (Admin Only).

Positional arguments:
  &lt;volume_type>  Name or ID of the volume type

</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_endpoints">
        <title>cinder endpoints command</title>
        <screen><computeroutput>usage: cinder endpoints

Discover endpoints that get returned from the authenticate services.

</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_extend">
        <title>cinder extend command</title>
        <screen><computeroutput>usage: cinder extend &lt;volume> &lt;new-size>

Attempt to extend the size of an existing volume.

Positional arguments:
  &lt;volume>    Name or ID of the volume to extend.
  &lt;new-size>  New size of volume in GB

</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_extra-specs-list">
        <title>cinder extra-specs-list command</title>
        <screen><computeroutput>usage: cinder extra-specs-list

Print a list of current 'volume types and extra specs' (Admin Only).

</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_force-delete">
        <title>cinder force-delete command</title>
        <screen><computeroutput>usage: cinder force-delete &lt;volume> [&lt;volume> ...]

Attempt forced removal of volume(s), regardless of the state(s).

Positional arguments:
  &lt;volume>  Name or ID of the volume(s) to delete.

</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_list">
        <title>cinder list command</title>
        <screen><computeroutput>usage: cinder list [--all-tenants [&lt;0|1>]] [--display-name &lt;display-name>]
                   [--status &lt;status>]
                   [--metadata [&lt;key=value> [&lt;key=value> ...]]]

List all the volumes.

Optional arguments:
  --all-tenants [&lt;0|1>]
                        Display information from all tenants (Admin only).
  --display-name &lt;display-name>
                        Filter results by display-name
  --status &lt;status>     Filter results by status
  --metadata [&lt;key=value> [&lt;key=value> ...]]
                        Filter results by metadata

</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_list-extensions">
        <title>cinder list-extensions command</title>
        <screen><computeroutput>usage: cinder list-extensions

List all the os-api extensions that are available.

</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_metadata">
        <title>cinder metadata command</title>
        <screen><computeroutput>usage: cinder metadata &lt;volume> &lt;action> &lt;key=value> [&lt;key=value> ...]

Set or Delete metadata on a volume.

Positional arguments:
  &lt;volume>     Name or ID of the volume to update metadata on.
  &lt;action>     Actions: 'set' or 'unset'
  &lt;key=value>  Metadata to set/unset (only key is necessary on unset)

</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_metadata-show">
        <title>cinder metadata-show command</title>
        <screen><computeroutput>usage: cinder metadata-show &lt;volume>

Show metadata of given volume.

Positional arguments:
  &lt;volume>  ID of volume

</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_metadata-update-all">
        <title>cinder metadata-update-all command</title>
        <screen><computeroutput>usage: cinder metadata-update-all &lt;volume> &lt;key=value> [&lt;key=value> ...]

Update all metadata of a volume.

Positional arguments:
  &lt;volume>     ID of the volume to update metadata on.
  &lt;key=value>  Metadata entry/entries to update.

</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_migrate">
        <title>cinder migrate command</title>
        <screen><computeroutput>usage: cinder migrate [--force-host-copy &lt;True|False>] &lt;volume> &lt;host>

Migrate the volume to the new host.

Positional arguments:
  &lt;volume>              ID of the volume to migrate
  &lt;host>                Destination host

Optional arguments:
  --force-host-copy &lt;True|False>
                        Optional flag to force the use of the generic host-
                        based migration mechanism, bypassing driver
                        optimizations (Default=False).

</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_qos-associate">
        <title>cinder qos-associate command</title>
        <screen><computeroutput>usage: cinder qos-associate &lt;qos_specs> &lt;volume_type_id>

Associate qos specs with specific volume type.

Positional arguments:
  &lt;qos_specs>       ID of qos_specs.
  &lt;volume_type_id>  ID of volume type to be associated with.

</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_qos-create">
        <title>cinder qos-create command</title>
        <screen><computeroutput>usage: cinder qos-create &lt;name> &lt;key=value> [&lt;key=value> ...]

Create a new qos specs.

Positional arguments:
  &lt;name>       Name of the new QoS specs
  &lt;key=value>  Specifications for QoS

</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_qos-delete">
        <title>cinder qos-delete command</title>
        <screen><computeroutput>usage: cinder qos-delete [--force &lt;True|False>] &lt;qos_specs>

Delete a specific qos specs.

Positional arguments:
  &lt;qos_specs>           ID of the qos_specs to delete.

Optional arguments:
  --force &lt;True|False>  Optional flag that indicates whether to delete
                        specified qos specs even if it is in-use.

</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_qos-disassociate">
        <title>cinder qos-disassociate command</title>
        <screen><computeroutput>usage: cinder qos-disassociate &lt;qos_specs> &lt;volume_type_id>

Disassociate qos specs from specific volume type.

Positional arguments:
  &lt;qos_specs>       ID of qos_specs.
  &lt;volume_type_id>  ID of volume type to be associated with.

</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_qos-disassociate-all">
        <title>cinder qos-disassociate-all command</title>
        <screen><computeroutput>usage: cinder qos-disassociate-all &lt;qos_specs>

Disassociate qos specs from all of its associations.

Positional arguments:
  &lt;qos_specs>  ID of qos_specs to be operate on.

</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_qos-get-association">
        <title>cinder qos-get-association command</title>
        <screen><computeroutput>usage: cinder qos-get-association &lt;qos_specs>

Get all associations of specific qos specs.

Positional arguments:
  &lt;qos_specs>  ID of the qos_specs.

</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_qos-key">
        <title>cinder qos-key command</title>
        <screen><computeroutput>usage: cinder qos-key &lt;qos_specs> &lt;action> key=value [key=value ...]

Set or unset specifications for a qos spec.

Positional arguments:
  &lt;qos_specs>  ID of qos specs
  &lt;action>     Actions: 'set' or 'unset'
  key=value    QoS specs to set/unset (only key is necessary on unset)

</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_qos-list">
        <title>cinder qos-list command</title>
        <screen><computeroutput>usage: cinder qos-list

Get full list of qos specs.

</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_qos-show">
        <title>cinder qos-show command</title>
        <screen><computeroutput>usage: cinder qos-show &lt;qos_specs>

Get a specific qos specs.

Positional arguments:
  &lt;qos_specs>  ID of the qos_specs to show.

</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_quota-class-show">
        <title>cinder quota-class-show command</title>
        <screen><computeroutput>usage: cinder quota-class-show &lt;class>

List the quotas for a quota class.

Positional arguments:
  &lt;class>  Name of quota class to list the quotas for.

</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_quota-class-update">
        <title>cinder quota-class-update command</title>
        <screen><computeroutput>usage: cinder quota-class-update [--volumes &lt;volumes>]
                                 [--snapshots &lt;snapshots>]
                                 [--gigabytes &lt;gigabytes>]
                                 [--volume-type &lt;volume_type_name>]
                                 &lt;class>

Update the quotas for a quota class.

Positional arguments:
  &lt;class>               Name of quota class to set the quotas for.

Optional arguments:
  --volumes &lt;volumes>   New value for the "volumes" quota.
  --snapshots &lt;snapshots>
                        New value for the "snapshots" quota.
  --gigabytes &lt;gigabytes>
                        New value for the "gigabytes" quota.
  --volume-type &lt;volume_type_name>
                        Volume type (Optional, Default=None)

</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_quota-defaults">
        <title>cinder quota-defaults command</title>
        <screen><computeroutput>usage: cinder quota-defaults &lt;tenant_id>

List the default quotas for a tenant.

Positional arguments:
  &lt;tenant_id>  UUID of tenant to list the default quotas for.

</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_quota-show">
        <title>cinder quota-show command</title>
        <screen><computeroutput>usage: cinder quota-show &lt;tenant_id>

List the quotas for a tenant.

Positional arguments:
  &lt;tenant_id>  UUID of tenant to list the quotas for.

</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_quota-update">
        <title>cinder quota-update command</title>
        <screen><computeroutput>usage: cinder quota-update [--volumes &lt;volumes>] [--snapshots &lt;snapshots>]
                           [--gigabytes &lt;gigabytes>]
                           [--volume-type &lt;volume_type_name>]
                           &lt;tenant_id>

Update the quotas for a tenant.

Positional arguments:
  &lt;tenant_id>           UUID of tenant to set the quotas for.

Optional arguments:
  --volumes &lt;volumes>   New value for the "volumes" quota.
  --snapshots &lt;snapshots>
                        New value for the "snapshots" quota.
  --gigabytes &lt;gigabytes>
                        New value for the "gigabytes" quota.
  --volume-type &lt;volume_type_name>
                        Volume type (Optional, Default=None)

</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_quota-usage">
        <title>cinder quota-usage command</title>
        <screen><computeroutput>usage: cinder quota-usage &lt;tenant_id>

List the quota usage for a tenant.

Positional arguments:
  &lt;tenant_id>  UUID of tenant to list the quota usage for.

</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_rate-limits">
        <title>cinder rate-limits command</title>
        <screen><computeroutput>usage: cinder rate-limits

Print a list of rate limits for a user

</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_readonly-mode-update">
        <title>cinder readonly-mode-update command</title>
        <screen><computeroutput>usage: cinder readonly-mode-update &lt;volume> &lt;True|true|False|false>

Update volume read-only access mode read_only.

Positional arguments:
  &lt;volume>              ID of the volume to update.
  &lt;True|true|False|false>
                        Flag to indicate whether to update volume to read-only
                        access mode.

</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_rename">
        <title>cinder rename command</title>
        <screen><computeroutput>usage: cinder rename [--display-description &lt;display-description>]
                     &lt;volume> [&lt;display-name>]

Rename a volume.

Positional arguments:
  &lt;volume>              Name or ID of the volume to rename.
  &lt;display-name>        New display-name for the volume.

Optional arguments:
  --display-description &lt;display-description>
                        Optional volume description. (Default=None)

</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_reset-state">
        <title>cinder reset-state command</title>
        <screen><computeroutput>usage: cinder reset-state [--state &lt;state>] &lt;volume> [&lt;volume> ...]

Explicitly update the state of a volume.

Positional arguments:
  &lt;volume>         Name or ID of the volume to modify.

Optional arguments:
  --state &lt;state>  Indicate which state to assign the volume. Options include
                   available, error, creating, deleting, error_deleting. If no
                   state is provided, available will be used.

</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_service-disable">
        <title>cinder service-disable command</title>
        <screen><computeroutput>usage: cinder service-disable &lt;hostname> &lt;binary>

Disable the service.

Positional arguments:
  &lt;hostname>  Name of host.
  &lt;binary>    Service binary.

</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_service-enable">
        <title>cinder service-enable command</title>
        <screen><computeroutput>usage: cinder service-enable &lt;hostname> &lt;binary>

Enable the service.

Positional arguments:
  &lt;hostname>  Name of host.
  &lt;binary>    Service binary.

</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_service-list">
        <title>cinder service-list command</title>
        <screen><computeroutput>usage: cinder service-list [--host &lt;hostname>] [--binary &lt;binary>]

List all the services. Filter by host &amp; service binary.

Optional arguments:
  --host &lt;hostname>  Name of host.
  --binary &lt;binary>  Service binary.

</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_show">
        <title>cinder show command</title>
        <screen><computeroutput>usage: cinder show &lt;volume>

Show details about a volume.

Positional arguments:
  &lt;volume>  Name or ID of the volume.

</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_snapshot-create">
        <title>cinder snapshot-create command</title>
        <screen><computeroutput>usage: cinder snapshot-create [--force &lt;True|False>]
                              [--display-name &lt;display-name>]
                              [--display-description &lt;display-description>]
                              &lt;volume>

Add a new snapshot.

Positional arguments:
  &lt;volume>              Name or ID of the volume to snapshot

Optional arguments:
  --force &lt;True|False>  Optional flag to indicate whether to snapshot a volume
                        even if it's attached to an instance. (Default=False)
  --display-name &lt;display-name>
                        Optional snapshot name. (Default=None)
  --display-description &lt;display-description>
                        Optional snapshot description. (Default=None)

</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_snapshot-delete">
        <title>cinder snapshot-delete command</title>
        <screen><computeroutput>usage: cinder snapshot-delete &lt;snapshot>

Remove a snapshot.

Positional arguments:
  &lt;snapshot>  Name or ID of the snapshot to delete.

</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_snapshot-list">
        <title>cinder snapshot-list command</title>
        <screen><computeroutput>usage: cinder snapshot-list [--all-tenants [&lt;0|1>]]
                            [--display-name &lt;display-name>]
                            [--status &lt;status>] [--volume-id &lt;volume-id>]

List all the snapshots.

Optional arguments:
  --all-tenants [&lt;0|1>]
                        Display information from all tenants (Admin only).
  --display-name &lt;display-name>
                        Filter results by display-name
  --status &lt;status>     Filter results by status
  --volume-id &lt;volume-id>
                        Filter results by volume-id

</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_snapshot-metadata">
        <title>cinder snapshot-metadata command</title>
        <screen><computeroutput>usage: cinder snapshot-metadata &lt;snapshot> &lt;action> &lt;key=value>
                                [&lt;key=value> ...]

Set or Delete metadata of a snapshot.

Positional arguments:
  &lt;snapshot>   ID of the snapshot to update metadata on.
  &lt;action>     Actions: 'set' or 'unset'
  &lt;key=value>  Metadata to set/unset (only key is necessary on unset)

</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_snapshot-metadata-show">
        <title>cinder snapshot-metadata-show command</title>
        <screen><computeroutput>usage: cinder snapshot-metadata-show &lt;snapshot>

Show metadata of given snapshot.

Positional arguments:
  &lt;snapshot>  ID of snapshot

</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_snapshot-metadata-update-all">
        <title>cinder snapshot-metadata-update-all command</title>
        <screen><computeroutput>usage: cinder snapshot-metadata-update-all &lt;snapshot> &lt;key=value>
                                           [&lt;key=value> ...]

Update all metadata of a snapshot.

Positional arguments:
  &lt;snapshot>   ID of the snapshot to update metadata on.
  &lt;key=value>  Metadata entry/entries to update.

</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_snapshot-rename">
        <title>cinder snapshot-rename command</title>
        <screen><computeroutput>usage: cinder snapshot-rename [--display-description &lt;display-description>]
                              &lt;snapshot> [&lt;display-name>]

Rename a snapshot.

Positional arguments:
  &lt;snapshot>            Name or ID of the snapshot.
  &lt;display-name>        New display-name for the snapshot.

Optional arguments:
  --display-description &lt;display-description>
                        Optional snapshot description. (Default=None)

</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_snapshot-reset-state">
        <title>cinder snapshot-reset-state command</title>
        <screen><computeroutput>usage: cinder snapshot-reset-state [--state &lt;state>]
                                   &lt;snapshot> [&lt;snapshot> ...]

Explicitly update the state of a snapshot.

Positional arguments:
  &lt;snapshot>       Name or ID of the snapshot to modify.

Optional arguments:
  --state &lt;state>  Indicate which state to assign the snapshot. Options
                   include available, error, creating, deleting,
                   error_deleting. If no state is provided, available will be
                   used.

</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_snapshot-show">
        <title>cinder snapshot-show command</title>
        <screen><computeroutput>usage: cinder snapshot-show &lt;snapshot>

Show details about a snapshot.

Positional arguments:
  &lt;snapshot>  Name or ID of the snapshot.

</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_transfer-accept">
        <title>cinder transfer-accept command</title>
        <screen><computeroutput>usage: cinder transfer-accept &lt;transfer> &lt;auth_key>

Accepts a volume transfer.

Positional arguments:
  &lt;transfer>  ID of the transfer to accept.
  &lt;auth_key>  Auth key of the transfer to accept.

</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_transfer-create">
        <title>cinder transfer-create command</title>
        <screen><computeroutput>usage: cinder transfer-create [--display-name &lt;display-name>] &lt;volume>

Creates a volume transfer.

Positional arguments:
  &lt;volume>              Name or ID of the volume to transfer.

Optional arguments:
  --display-name &lt;display-name>
                        Optional transfer name. (Default=None)

</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_transfer-delete">
        <title>cinder transfer-delete command</title>
        <screen><computeroutput>usage: cinder transfer-delete &lt;transfer>

Undo a transfer.

Positional arguments:
  &lt;transfer>  Name or ID of the transfer to delete.

</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_transfer-list">
        <title>cinder transfer-list command</title>
        <screen><computeroutput>usage: cinder transfer-list

List all the transfers.

</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_transfer-show">
        <title>cinder transfer-show command</title>
        <screen><computeroutput>usage: cinder transfer-show &lt;transfer>

Show details about a transfer.

Positional arguments:
  &lt;transfer>  Name or ID of the transfer to accept.

</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_type-create">
        <title>cinder type-create command</title>
        <screen><computeroutput>usage: cinder type-create &lt;name>

Create a new volume type.

Positional arguments:
  &lt;name>  Name of the new volume type

</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_type-delete">
        <title>cinder type-delete command</title>
        <screen><computeroutput>usage: cinder type-delete &lt;id>

Delete a specific volume type.

Positional arguments:
  &lt;id>  Unique ID of the volume type to delete

</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_type-key">
        <title>cinder type-key command</title>
        <screen><computeroutput>usage: cinder type-key &lt;vtype> &lt;action> [&lt;key=value> [&lt;key=value> ...]]

Set or unset extra_spec for a volume type.

Positional arguments:
  &lt;vtype>      Name or ID of the volume type
  &lt;action>     Actions: 'set' or 'unset'
  &lt;key=value>  Extra_specs to set/unset (only key is necessary on unset)

</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_type-list">
        <title>cinder type-list command</title>
        <screen><computeroutput>usage: cinder type-list

Print a list of available 'volume types'.

</computeroutput></screen>
    </section>
    <section xml:id="cinderclient_subcommand_upload-to-image">
        <title>cinder upload-to-image command</title>
        <screen><computeroutput>usage: cinder upload-to-image [--force &lt;True|False>]
                              [--container-format &lt;container-format>]
                              [--disk-format &lt;disk-format>]
                              &lt;volume> &lt;image-name>

Upload volume to image service as image.

Positional arguments:
  &lt;volume>              Name or ID of the volume to upload to an image
  &lt;image-name>          Name for created image

Optional arguments:
  --force &lt;True|False>  Optional flag to indicate whether to upload a volume
                        even if it's attached to an instance. (Default=False)
  --container-format &lt;container-format>
                        Optional type for container format (Default=bare)
  --disk-format &lt;disk-format>
                        Optional type for disk format (Default=raw)

</computeroutput></screen>
    </section>
</section>