python-keystoneclient/docs/shell.rst

The keystone shell utility

keystone

Warning

COMING SOON

The command line interface is not yet completed. This document serves as a reference for the implementation.

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

First, you'll need an OpenStack Keystone account and an API key. You get this by using the keystone-manage command in OpenStack Keystone.

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

KEYSTONE_USERNAME

Your Keystone username.

KEYSTONE_API_KEY

Your API key.

KEYSTONE_PROJECT_ID

Project for work.

KEYSTONE_URL

The OpenStack API server URL.

KEYSTONE_VERSION

The OpenStack API version.

For example, in Bash you'd use:

export KEYSTONE_USERNAME=yourname
export KEYSTONE_API_KEY=yadayadayada
export KEYSTONE_PROJECT_ID=myproject
export KEYSTONE_URL=http://...
export KEYSTONE_VERSION=2.0

From there, all shell commands take the form:

keystone <command> [arguments...]

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