Client for OpenStack services

Go to file

OpenStack Proposal Bot 226766ae74 Updated from global requirements Change-Id: I4be6137a0d6717702e495d391cd9cb404fcf26ce		2016-07-09 19:27:08 +00:00
doc	fix one spelling mistake and two help messages	2016-07-07 14:19:04 +08:00
examples	osc-lib: api.auth	2016-06-30 08:57:59 -05:00
functional	Deduplicate get_opts methods	2016-07-05 15:39:03 +00:00
openstackclient	Merge "Correct reraising of exception"	2016-07-07 20:56:18 +00:00
releasenotes	Merge "Add "--property" option to "snapshot create" command in volumev2"	2016-07-06 15:31:39 +00:00
tools	Pep8 environment to run on delta code only	2016-05-12 00:55:10 +05:30
.coveragerc	Change ignore-errors to ignore_errors	2015-09-21 14:54:21 +00:00
.gitignore	gitignore .idea	2016-02-20 16:25:56 +08: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
CONTRIBUTING.rst	Added CONTRIBUTING.rst file	2016-05-16 17:42:48 +05:30
HACKING.rst	Remove non-existing hacking deviations from doc	2015-08-09 13:22:48 -07:00
LICENSE	Remove LICENSE APPENDIX	2015-11-18 13:25:56 +09:00
post_test_hook.sh	unwedge the gate	2015-10-08 03:09:43 -04:00
README.rst	Add Testing Ref in README.rst	2016-04-11 11:12:37 -05:00
requirements.txt	Updated from global requirements	2016-07-09 19:27:08 +00:00
setup.cfg	Merge "Transfer "ip fixed add/remove" to "server add/remove fixed ip""	2016-07-06 13:59:32 +00:00
setup.py	Updated from global requirements	2015-09-18 16:42:31 +00:00
test-requirements.txt	Updated from global requirements	2016-07-01 04:24:41 +00:00
tox.ini	Pep8 environment to run on delta code only	2016-05-12 00:55:10 +05:30

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 Block Storage 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.

PyPi - package installation
Online Documentation
Launchpad project - release management
Blueprints - feature specifications
Bugs - issue tracking
Source
Developer - getting started as a developer
Contributing - contributing code
Testing - testing code
IRC: #openstack-sdks on Freenode (irc.freenode.net)
License: Apache 2.0

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>