Red Hat Training

A Red Hat training course is available for Red Hat OpenStack Platform

Chapter 4. Block Storage Service Command-line Client

The cinder client is the command-line interface (CLI) for the OpenStack Block Storage API and its extensions. This chapter documents cinder version 1.9.0.
For help on a specific cinder command, enter: 
$ cinder help COMMAND

4.1. cinder Usage

usage: cinder [--version] [-d] [--os-auth-system <auth-system>]
              [--service-type <service-type>] [--service-name <service-name>]
              [--volume-service-name <volume-service-name>]
              [--os-endpoint-type <os-endpoint-type>]
              [--endpoint-type <endpoint-type>]
              [--os-volume-api-version <volume-api-ver>]
              [--bypass-url <bypass-url>] [--retries <retries>]
              [--profile HMAC_KEY] [--os-auth-strategy <auth-strategy>]
              [--os-username <auth-user-name>] [--os-password <auth-password>]
              [--os-tenant-name <auth-tenant-name>]
              [--os-tenant-id <auth-tenant-id>] [--os-auth-url <auth-url>]
              [--os-user-id <auth-user-id>]
              [--os-user-domain-id <auth-user-domain-id>]
              [--os-user-domain-name <auth-user-domain-name>]
              [--os-project-id <auth-project-id>]
              [--os-project-name <auth-project-name>]
              [--os-project-domain-id <auth-project-domain-id>]
              [--os-project-domain-name <auth-project-domain-name>]
              [--os-region-name <region-name>] [--os-token <token>]
              [--os-url <url>] [--insecure] [--os-cacert <ca-certificate>]
              [--os-cert <certificate>] [--os-key <key>] [--timeout <seconds>]
              <subcommand> ...

Subcommands

absolute-limits


        Lists absolute limits for a user.

availability-zone-list


      Lists all availability zones.

backup-create


        Creates a volume backup.

backup-delete


        Removes one or more backups.

backup-export


        Export backup metadata record.

backup-import


        Import backup metadata record.

backup-list


        Lists all backups.

backup-reset-state


        Explicitly updates the backup state.

backup-restore


        Restores a backup.

backup-show


        Shows backup details.

cgsnapshot-create


        Creates a cgsnapshot.

cgsnapshot-delete


        Removes one or more cgsnapshots.

cgsnapshot-list


        Lists all cgsnapshots.

cgsnapshot-show


        Shows cgsnapshot details.

consisgroup-create


        Creates a consistency group.

consisgroup-create-from-src


      Creates a consistency group from a cgsnapshot or a
      source CG.

consisgroup-delete


        Removes one or more consistency groups.

consisgroup-list


        Lists all consistencygroups.

consisgroup-show


        Shows details of a consistency group.

consisgroup-update


        Updates a consistencygroup.

create


        Creates a volume.

credentials


        Shows user credentials returned from auth.

delete


        Removes one or more volumes.

encryption-type-create


      Creates encryption type for a volume type. Admin only.

encryption-type-delete


      Deletes encryption type for a volume type. Admin only.

encryption-type-list


      Shows encryption type details for volume types. Admin
      only.

encryption-type-show


      Shows encryption type details for a volume type. Admin
      only.

encryption-type-update


      Update encryption type information for a volume type
      (Admin Only).

endpoints


        Discovers endpoints registered by authentication
      service.

extend


        Attempts to extend size of an existing volume.

extra-specs-list


        Lists current volume types and extra specs.

failover-host


        Failover a replicating cinder-volume host.

force-delete


        Attempts force-delete of volume, regardless of state.

freeze-host


        Freeze and disable the specified cinder-volume host.

get-capabilities


        Show backend volume stats and properties. Admin only.

get-pools


        Show pool information for backends. Admin only.

group-show


        Shows details of a group.

image-metadata


        Sets or deletes volume image metadata.

image-metadata-show


      Shows volume image metadata.

list


        Lists all volumes.

manage


        Manage an existing volume.

manageable-list


        Lists all manageable volumes.

metadata


        Sets or deletes volume metadata.

metadata-show


        Shows volume metadata.

metadata-update-all


      Updates volume metadata.

migrate


        Migrates volume to a new host.

qos-associate


        Associates qos specs with specified volume type.

qos-create


        Creates a qos specs.

qos-delete


        Deletes a specified qos specs.

qos-disassociate


        Disassociates qos specs from specified volume type.

qos-disassociate-all


      Disassociates qos specs from all its associations.

qos-get-association


      Lists all associations for specified qos specs.

qos-key


        Sets or unsets specifications for a qos spec.

qos-list


        Lists qos specs.

qos-show


        Shows qos specs details.

quota-class-show


        Lists quotas for a quota class.

quota-class-update


        Updates quotas for a quota class.

quota-defaults


        Lists default quotas for a tenant.

quota-delete


        Delete the quotas for a tenant.

quota-show


        Lists quotas for a tenant.

quota-update


        Updates quotas for a tenant.

quota-usage


        Lists quota usage for a tenant.

rate-limits


        Lists rate limits for a user.

readonly-mode-update


      Updates volume read-only access-mode flag.

rename


        Renames a volume.

replication-promote


      Promote a secondary volume to primary for a
      relationship.

replication-reenable


      Sync the secondary volume with primary for a
      relationship.

reset-state


        Explicitly updates the volume state in the Cinder
      database.

retype


        Changes the volume type for a volume.

service-disable


        Disables the service.

service-enable


        Enables the service.

service-list


        Lists all services. Filter by host and service binary.

set-bootable


        Update bootable status of a volume.

show


        Shows volume details.

snapshot-create


        Creates a snapshot.

snapshot-delete


        Removes one or more snapshots.

snapshot-list


        Lists all snapshots.

snapshot-manage


        Manage an existing snapshot.

snapshot-manageable-list


      Lists all manageable snapshots.

snapshot-metadata


        Sets or deletes snapshot metadata.

snapshot-metadata-show


      Shows snapshot metadata.

snapshot-metadata-update-all


      Updates snapshot metadata.

snapshot-rename


        Renames a snapshot.

snapshot-reset-state


      Explicitly updates the snapshot state.

snapshot-show


        Shows snapshot details.

snapshot-unmanage


        Stop managing a snapshot.

thaw-host


        Thaw and enable the specified cinder-volume host.

transfer-accept


        Accepts a volume transfer.

transfer-create


        Creates a volume transfer.

transfer-delete


        Undoes a transfer.

transfer-list


        Lists all transfers.

transfer-show


        Shows transfer details.

type-access-add


        Adds volume type access for the given project.

type-access-list


        Print access information about the given volume type.

type-access-remove


        Removes volume type access for the given project.

type-create


        Creates a volume type.

type-default


        List the default volume type.

type-delete


        Deletes volume type or types.

type-key


        Sets or unsets extra_spec for a volume type.

type-list


        Lists available 'volume types'. (Admin only will see
      private types)

type-show


        Show volume type details.

type-update


        Updates volume type name, description, and/or
      is_public.

unmanage


        Stop managing a volume.

upload-to-image


        Uploads volume to Image Service as an image.

bash-completion


        Prints arguments for bash_completion.

help


        Shows help about this program or one of its
      subcommands.

list-extensions


        Lists all available os-api extensions.