1
The :program:`keystone` shell utility
2
=========================================
8
The :program:`keystone` shell utility interacts with OpenStack Keystone API
9
from the command line. It supports the entirety of the OpenStack Keystone API.
11
First, you'll need an OpenStack Keystone account. You get this by using the
12
`keystone-manage` command in OpenStack Keystone.
14
You'll need to provide :program:`keystone` with your OpenStack username and
15
password. You can do this with the :option:`--os_username`, :option:`--os_password`.
16
You can optionally specify a :option:`--os_tenant_id` or :option:`--os_tenant_name`,
17
to scope your token to a specific tenant. If you don't specify a tenant, you
18
will be scoped to your default tenant if you have one. Instead of using
19
options, it is easier to just set them as environment variables:
21
.. envvar:: OS_USERNAME
23
Your Keystone username.
25
.. envvar:: OS_PASSWORD
27
Your Keystone password.
29
.. envvar:: OS_TENANT_NAME
31
Name of Keystone Tenant.
33
.. envvar:: OS_TENANT_ID
35
ID of Keystone Tenant.
37
.. envvar:: OS_AUTH_URL
39
The OpenStack API server URL.
41
.. envvar:: OS_IDENTITY_API_VERSION
43
The OpenStack Identity API version.
45
For example, in Bash you'd use::
47
export OS_USERNAME=yourname
48
export OS_PASSWORD=yadayadayada
49
export OS_TENANT_NAME=myproject
50
export OS_AUTH_URL=http://example.com:5000/v2.0/
51
export OS_IDENTITY_API_VERSION=2.0
53
From there, all shell commands take the form::
55
keystone <command> [arguments...]
57
Run :program:`keystone help` to get a full list of all possible commands,
58
and run :program:`keystone help <command>` to get detailed help for that
added
removed
doc/source/shell.rst
