openstack/python-cinderclient
Code Issues Proposed changes
Files
f2ac10f282d2c5def47487d845d4aa18e7054917
python-cinderclient/doc/source/shell.rst
Frederic Lepied 33c897d87e Fixed documentation of the cinder shell command. 
Updated README.rst and shell.rst to match changes
in the cinder command and novaclient README.rst.

Change-Id: Ifaa53d5c06e6d7d8e3d4d858672717954303bea7
Fixes: bug #1074125
2013-01-31 20:41:47 +01:00

1.4 KiB
Raw Blame History

The cinder shell utility

cinder

The cinder shell utility interacts with the OpenStack Cinder API from the command line. It supports the entirety of the OpenStack Cinder API.

You'll need to provide cinder with your OpenStack username and API key. You can do this with the --os-username, --os-password and --os-tenant-name options, but it's easier to just set them as environment variables by setting two environment variables:

OS_USERNAME or CINDER_USERNAME

Your OpenStack Cinder username.

OS_PASSWORD or CINDER_PASSWORD

Your password.

OS_TENANT_NAME or CINDER_PROJECT_ID

Project for work.

OS_AUTH_URL or CINDER_URL

The OpenStack API server URL.

OS_VOLUME_API_VERSION

The OpenStack Block Storage API version.

For example, in Bash you'd use:

export OS_USERNAME=yourname
export OS_PASSWORD=yadayadayada
export OS_TENANT_NAME=myproject
export OS_AUTH_URL=http://...
export OS_VOLUME_API_VERSION=1

From there, all shell commands take the form:

cinder <command> [arguments...]

Run cinder help to get a full list of all possible commands, and run cinder help <command> to get detailed help for that command.