API Overview

This section describes some of the most commonly used Cinder API calls and their corresponding CLI commands. It is not meant to be a comprehensive list that is representative of all functionality present in Cinder; for more information, please refer to the OpenStack Configuration Reference.

 Volume API

Table 4.2, “Cinder API Overview - Volume” specifies the valid operations that can be performed on Cinder volumes. Please note that Cinder volumes are identified as CLI command arguments by either their names or UUID.

Table 4.2. Cinder API Overview - Volume
Operation CLI Command Description
Create cinder create Create a Cinder volume of specified size; optional name, availability zone, volume type
Delete cinder delete Delete an existing Cinder volume; the cinder force-delete command may be required if the Cinder volume is in an error state
Edit cinder metadata Set or unset metadata on a Cinder volume
Extend cinder extend Increase the capacity of a Cinder volume to the specified size
List cinder list List all Cinder volumes
Migrate cinder migrate Move a Cinder volume to a new Cinder backend (specified by name)
Show cinder show Show details about a Cinder volume
Upload as image cinder upload-to-image Upload a Cinder volume to the OpenStack Image Service
Manage cinder manage Bring an existing storage object under Cinder management
Unmanage cinder unmanage Cease management of an existing Cinder volume without deleting the backing storage object

 Snapshot API

Table 4.3, “Cinder API Overview - Snapshot” specifies the valid operations that can be performed on Cinder snapshots. Please note that Cinder snapshots are identified as CLI command arguments by either their display name or UUID.

Table 4.3. Cinder API Overview - Snapshot
Operation CLI Command Description
Create cinder snapshot-create Create a Cinder snapshot of a specific Cinder volume
Delete cinder snapshot-delete Delete a Cinder snapshot
Edit cinder snapshot-metadata Set or unset metadata on a Cinder snapshot
List cinder snapshot-list List all Cinder snapshots
Rename cinder snapshot-rename Change the display-name of a Cinder snapshot
Reset State cinder snapshot-reset-state Reset the state of a Cinder snapshot
Show cinder snapshot-show Show details about a Cinder snapshot

 Consistency Group API

Table 4.4, “Cinder API Overview - Snapshot” specifies the valid operations that can be performed on Cinder consistency groups. Please note that Cinder consistency groups and cgsnapshots are identified as CLI command arguments by either their display name or UUID.

Table 4.4. Cinder API Overview - Snapshot
Operation CLI Command Description
Create cinder consisgroup-create Create a consistency group with support for at least one volume type
Show cinder consisgroup-show Display details for a specified consistency group
List cinder consisgroup-list Show a list of all created consistency groups
Create a volume and add it to a consistency group cinder create Expand a consistency group to have another volume by creating a volume with the --consisgroup-id parameter
Create a cgsnapshot cinder cgsnapshot-create Generate a snapshot of a consistency group
Show a snapshot of a consistency group cinder cgsnapshot-show Display details for the cgsnapshot of consistency group
List consistency group snapshots cinder cgsnapshot-list Display all cgsnapshots for a consistency group
Delete a snapshot of a consistency group cinder cgsnapshot-delete Remove a cgsnapshot
Delete a consistency group cinder consisgroup-delete The --force flag is required when volumes are inside the consistency group
Modify a consistency group cinder consisgroup-update Add or remove volumes from a consistency group with --add-volumes [UUID-list] or --remove-volumes [UUID-list] parameters
Create a consistency group from the snapshot of another consistency group cinder consisgroup-create-from-src Use a cgsnapshot to generate a new consistency group
Create a consistency group from a source consistency group cinder consisgroup-create-from-src Copy a consistency group

 Backup API

Table 4.5, “Cinder API Overview - Backup” specifies the valid operations that can be performed on Cinder backups. Please note that Cinder backups are identified as CLI command arguments by either their display name or UUID.

Table 4.5. Cinder API Overview - Backup
Operation CLI Command Description
Create cinder backup-create Create a Cinder backup
Delete cinder backup-delete Delete a Cinder backup
List cinder backup-list List all Cinder backups
Restore cinder backup-restore Restore a Cinder backup into a Cinder volume
Show cinder backup-show Show details about a Cinder backup

 Volume Type API

Table 4.6, “Cinder API Overview - Volume Type” specifies the valid operations that can be performed on Cinder volume types. Please note that Cinder volume types are identified as CLI command arguments by either their display name or UUID.

Table 4.6. Cinder API Overview - Volume Type
Operation CLI Command Description
Create cinder type-create Create a Cinder volume type
Delete cinder type-delete Delete a Cinder volume type
List cinder type-list List existing Cinder volume type

 Volume Type Extra Specs API

Table 4.7, “Cinder API Overview - Volume Type Extra Specs” specifies the valid operations that can be performed on Cinder volume type extra specs. Please note that Cinder volume type extra specs are properties of Cinder volume types and are identified by their parent object.

Table 4.7. Cinder API Overview - Volume Type Extra Specs
Operation CLI Command Description
Set extra specs cinder type-key vtype set Assign extra specs to Cinder volume type
Unset extra specs cinder type-key vtype unset Remove extra specs from Cinder volume type

 Volume Type QoS Specs API

Table 4.8, “Cinder API Overview - Volume Type QoS Specs” specifies the valid operations that can be performed on Cinder volume type QoS specs. Please note that Cinder volume type QoS specs are created independently of Cinder volume types and are subsequently associated with a Cinder volume type.

Table 4.8. Cinder API Overview - Volume Type QoS Specs
Operation CLI Command Description
Create QoS specs cinder qos-create Create a Cinder QoS Spec
Delete QoS specs cinder qos-delete Delete a Cinder QoS Spec
List QoS specs cinder qos-list List existing Cinder QoS Specs
Show cinder qos-show Show details about a Cinder QoS Spec
Associate QoS specs cinder qos-associate Associate a Cinder QoS Spec with a Cinder volume type
Disassociate QoS specs cinder qos-disassociate Disassociate a Cinder QoS Spec from a Cinder volume type
Edit QoS spec cinder qos-key Set or unset specifications for a Cinder QoS Spec


loading table of contents...