cinder CLI man page

cinder CLI man page


cinder [options] <command> [command-options]

cinder help

cinder help <command>


The cinder command line utility interacts with OpenStack Block Storage Service (Cinder).

In order to use the CLI, you must provide your OpenStack username, password, project (historically called tenant), and auth endpoint. You can use configuration options –os-username, –os-password, –os-tenant-name or –os-tenant-id, and –os-auth-url or set corresponding environment variables:

export OS_USERNAME=user
export OS_PASSWORD=pass
export OS_TENANT_NAME=myproject
export OS_AUTH_URL=

You can select an API version to use by –os-volume-api-version option or by setting corresponding environment variable:



To get a list of available commands and options run:

cinder help

To get usage and options of a command:

cinder help <command>


Cinder client is hosted in Launchpad so you can view current bugs at

Creative Commons Attribution 3.0 License

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.