diff options
Diffstat (limited to 'doc/source/user/shell.rst')
| -rw-r--r-- | doc/source/user/shell.rst | 49 |
1 files changed, 49 insertions, 0 deletions
diff --git a/doc/source/user/shell.rst b/doc/source/user/shell.rst new file mode 100644 index 0000000..813b769 --- /dev/null +++ b/doc/source/user/shell.rst @@ -0,0 +1,49 @@ +The :program:`cinder` shell utility +========================================= + +.. program:: cinder +.. highlight:: bash + +The :program:`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 :program:`cinder` with your OpenStack username and +API key. You can do this with the :option:`--os-username`, :option:`--os-password` +and :option:`--os-tenant-name` options, but it's easier to just set them as +environment variables by setting two environment variables: + +.. envvar:: OS_USERNAME or CINDER_USERNAME + + Your OpenStack Cinder username. + +.. envvar:: OS_PASSWORD or CINDER_PASSWORD + + Your password. + +.. envvar:: OS_TENANT_NAME or CINDER_PROJECT_ID + + Project for work. + +.. envvar:: OS_AUTH_URL or CINDER_URL + + The OpenStack API server URL. + +.. envvar:: 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://auth.example.com:5000/v2.0 + export OS_VOLUME_API_VERSION=3 + +From there, all shell commands take the form:: + + cinder <command> [arguments...] + +Run :program:`cinder help` to get a full list of all possible commands, +and run :program:`cinder help <command>` to get detailed help for that +command. |