blob: 0d03b01566ec1bc2b2af3c6d39ad689f50826809 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
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 `--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:
.. 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/v3
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.
|
