openstack/python-openstackclient
Code Issues Proposed changes
Client for OpenStack services
990 Commits 6 Branches 60 Tags 72 MiB
Python 100%
aa7e58cefb
Go to file
TerryHowe aa7e58cefb Functional tests run in many environments 
Have the functional tests running with less customization and
less shell.  This change will allow the functional tests to be
run against any cloud set up in the environment.

Change-Id: I24f621fbace62273e5a0be24e7af9078c0fc8550
2015-04-25 08:42:06 -06:00
doc Merge "Begin documenting --os-cloud" 2015-04-19 15:16:42 +00:00
examples Add --os-cloud support 2015-04-18 23:04:51 -05:00
functional Functional tests run in many environments 2015-04-25 08:42:06 -06:00
openstackclient Merge "Handle the pagination for image list" 2015-04-20 20:35:02 +00:00
python-openstackclient/locale Imported Translations from Transifex 2015-04-20 06:04:10 +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 Functional tests run in many environments 2015-04-25 08:42:06 -06: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 Functional tests run in many environments 2015-04-25 08:42:06 -06:00
README.rst Update README 2015-03-09 15:49:44 -05:00
requirements.txt Add --os-cloud support 2015-04-18 23:04:51 -05: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 Uncap library requirements for liberty 2015-04-16 18:13:36 +00:00
tox.ini Functional tests run in many environments 2015-04-25 08:42:06 -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>