openstack/python-openstackclient
Code Issues Proposed changes
Client for OpenStack services
950 Commits 6 Branches 61 Tags 72 MiB
Python 100%
d5f2c50c0f
Go to file
Jenkins d5f2c50c0f Merge "Updated from global requirements"
2015-04-01 02:00:50 +00:00
doc Add support to remote_id 2015-03-30 11:53:17 -04:00
examples Move OSC auth plugins so they can be found 2015-03-10 03:16:12 +00:00
functional Merge "Look harder to find DevStack" 2015-03-12 03:10:54 +00:00
openstackclient Add support to remote_id 2015-03-30 11:53:17 -04:00
python-openstackclient/locale Imported Translations from Transifex 2015-03-31 06:05:13 +00:00
tools sync oslo bits 2014-06-20 16:18:33 -04:00
.coveragerc Update .coveragerc 2013-02-06 16:47:06 +02:00
.gitignore Enhance the theming for modules page 2014-11-18 22:07:57 -05: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 Add Identity v2 project tests 2013-08-16 14:35:46 -05:00
babel.cfg Add translation markers for user v2 actions 2014-10-09 14:47:19 -04:00
HACKING.rst Fix PEP8 E302 errors 2014-07-22 17:51:15 -06: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
openstack-common.conf Use oslo.utils 2014-09-22 13:07:31 +03:00
post_test_hook.sh Add functional tests to osc 2014-10-01 19:46:07 -04:00
README.rst Update README 2015-03-09 15:49:44 -05:00
requirements.txt Updated from global requirements 2015-03-31 18:38:53 +00:00
run_tests.sh Modify run_tests.sh to just run tox 2013-08-02 01:41:14 -05:00
setup.cfg Add the ability to set and unset flavor properties 2015-03-19 13:54:19 -04:00
setup.py Updated from global requirements 2014-05-01 13:50:49 +00:00
test-requirements.txt Updated from global requirements 2015-03-31 18:38:53 +00:00
tox.ini Change test order to avoid incompatibliity 2015-01-28 05:44:37 -07: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>