openstack-manuals/doc/common/section_cinder_cli_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="cinder_commands">
  <title>cinder commands</title>
  <para>The cinder client is the command-line interface for the
    OpenStack Block Storage API.</para>
  <para>For help on a specific cinder command, enter:</para>
  <screen><prompt>$</prompt> <userinput><command>cinder</command> <option>help</option> <replaceable>COMMAND</replaceable></userinput></screen>
  <example>
    <title>Usage</title>
    <screen><computeroutput>cinder [--version] [--debug] [--os-username &lt;auth-user-name>]
       [--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;compute-api-ver>]
       [--os-cacert &lt;ca-certificate>] [--retries &lt;retries>]
       &lt;subcommand> ...</computeroutput></screen>
  </example>
  <example>
    <title>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 a volume.
    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 a volume, regardless of its
                        state.
    list                List all the volumes.
    metadata            Set or Delete metadata on a volume.
    migrate             Migrate the volume to the new host.
    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.
    rate-limits         Print a list of rate limits for a user
    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-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>
  </example>
  <example>
    <title>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 compute 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;compute-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>
  </example>
</section>