Command Line Interface Examples¶
The Keystone command line interface packaged in python-keystoneclient only supports the Identity v2.0 API. The OpenStack common command line interface packaged in python-openstackclient supports both v2.0 and v3 APIs.
Note
As of the Juno release, it is recommended to use python-openstackclient
,
as it supports both v2.0 and v3 APIs. For the purpose of backwards compatibility,
the CLI packaged in python-keystoneclient
is not being removed.
Using python-openstackclient (v3 or v2.0)¶
A complete list of OpenStackClient commands with full examples are located at OpenStackClient’s Command List page. Additionally, for details related to authentication, refer to OpenStackClient’s Authentication page.
Using python-keystoneclient (v2.0-only)¶
Tenants¶
tenant-create
¶
keyword arguments
- name
- description (optional, defaults to None)
- enabled (optional, defaults to True)
example:
$ keystone tenant-create --name=demo
creates a tenant named “demo”.
tenant-delete
¶
arguments
- tenant_id
example:
$ keystone tenant-delete f2b7b39c860840dfa47d9ee4adffa0b3
Users¶
user-create
¶
keyword arguments
- name
- pass
- tenant_id (optional, defaults to None)
- enabled (optional, defaults to True)
example:
$ keystone user-create
--name=admin \
--pass=secrete \
--tenant_id=2395953419144b67955ac4bab96b8fd2 \
--email=admin@example.com
user-delete
¶
keyword arguments
- user_id
example:
$ keystone user-delete f2b7b39c860840dfa47d9ee4adffa0b3
user-list
¶
list users in the system, optionally by a specific tenant (identified by tenant_id)
arguments
- tenant_id (optional, defaults to None)
example:
$ keystone user-list
user-update
¶
arguments
- user_id
keyword arguments
- name Desired new user name (Optional)
- email Desired new email address (Optional)
- enabled <true|false> Enable or disable user (Optional)
example:
$ keystone user-update 03c84b51574841ba9a0d8db7882ac645 --email=newemail@example.com
user-password-update
¶
arguments
- user_id
- password
example:
$ keystone user-password-update --pass foo 03c84b51574841ba9a0d8db7882ac645
Roles¶
user-role-add
¶
keyword arguments
- user <user-id>
- role <role-id>
- tenant_id <tenant-id>
example:
$ keystone user-role-add \
--user=96a6ebba0d4c441887aceaeced892585 \
--role=f8dd5a2e4dc64a41b96add562d9a764e \
--tenant_id=2395953419144b67955ac4bab96b8fd2
user-role-remove
¶
keyword arguments
- user <user-id>
- role <role-id>
- tenant_id <tenant-id>
example:
$ keystone user-role-remove \
--user=96a6ebba0d4c441887aceaeced892585 \
--role=f8dd5a2e4dc64a41b96add562d9a764e \
--tenant_id=2395953419144b67955ac4bab96b8fd2