openstack/python-openstackclient
Code Issues Proposed changes
Client for OpenStack services
1,308 Commits 11 Branches 54 Tags 71 MiB
Python 100%
c5b31f3c6a
Go to file
Jenkins c5b31f3c6a Merge "Fix quota show when there is no project id"
2015-08-05 19:26:16 +00:00
doc Add domain scoping in 'role assignment list' 2015-07-31 18:56:34 -07:00
examples Fix examples with cacert 2015-07-01 05:11:45 -06:00
functional Add functional test for volume type create --property 2015-08-05 07:25:06 -04:00
openstackclient Fix quota show when there is no project id 2015-08-05 09:55:29 -06:00
python-openstackclient/locale Imported Translations from Transifex 2015-08-04 06:26:16 +00:00
.coveragerc Update .coveragerc 2013-02-06 16:47:06 +02:00
.gitignore Ignore cover directory from git 2015-06-01 17:46:02 +10:00
.gitreview Add openstack-common and test infrastructure. 2012-04-28 22:27:34 +00:00
.mailmap Clean up test environment and remove unused imports. 2013-01-22 11:44:18 -06:00
.testr.conf Use format options for functional tests 2015-05-17 12:33:39 +00:00
babel.cfg Add translation markers for user v2 actions 2014-10-09 14:47:19 -04:00
HACKING.rst Minor Documentation changes for code samples 2015-07-30 14:41:41 -04:00
LICENSE First commit 2012-04-18 13:16:39 -05:00
MANIFEST.in Add translation markers for user v2 actions 2014-10-09 14:47:19 -04:00
post_test_hook.sh Functional tests run in many environments 2015-04-25 08:42:06 -06:00
README.rst Include links to developer workflow documentation 2015-06-08 11:43:24 -04:00
requirements.txt Updated from global requirements 2015-07-22 04:59:50 +00:00
setup.cfg Add support for volume v2 commands 2015-07-24 13:16:38 -07:00
setup.py Updated from global requirements 2015-07-15 01:37:44 +00:00
test-requirements.txt Updated from global requirements 2015-08-04 00:49:08 +00:00
tox.ini Remove requirements.txt from tox.ini 2015-07-17 11:21:02 -06:00

README.rst

OpenStackClient

OpenStackClient (aka OSC) is a command-line client for OpenStack that brings the command set for Compute, Identity, Image, Object Store and Volume APIs together in a single shell with a uniform command structure.

The primary goal is to provide a unified shell command structure and a common language to describe operations in OpenStack.

Getting Started

OpenStack Client can be installed from PyPI using pip:

pip install python-openstackclient

There are a few variants on getting help. A list of global options and supported commands is shown with --help:

openstack --help

There is also a help command that can be used to get help text for a specific command:

openstack help
openstack help server create

Configuration

The CLI is configured via environment variables and command-line options as listed in http://docs.openstack.org/developer/python-openstackclient/authentication.html.

Authentication using username/password is most commonly used:

export OS_AUTH_URL=<url-to-openstack-identity>
export OS_PROJECT_NAME=<project-name>
export OS_USERNAME=<username>
export OS_PASSWORD=<password>  # (optional)

The corresponding command-line options look very similar:

--os-auth-url <url>
--os-project-name <project-name>
--os-username <username>
[--os-password <password>]

If a password is not provided above (in plaintext), you will be interactively prompted to provide one securely.

Authentication may also be performed using an already-acquired token and a URL pointing directly to the service API that presumably was acquired from the Service Catalog:

export OS_TOKEN=<token>
export OS_URL=<url-to-openstack-service>

The corresponding command-line options look very similar:

--os-token <token>
--os-url <url-to-openstack-service>