Client for OpenStack services

Go to file

Andrey Larionov 8c6b5a087a Initialize neutron client with region name All clients except neutron are initialized with region name. This makes unable to use network related commands of openstackclient in multi-region configurations Change-Id: I200dc9a2f938c3e69357f91c79810df167e4fccb Closes-bug: 1570491		2016-04-18 19:54:58 +03:00
doc	Merge "Doc: Unify repeatable option comments"	2016-04-13 21:22:50 +00:00
examples	Switch to ksa Session	2015-12-02 01:55:14 +00:00
functional	Use CommandFailed exception from tempest_lib	2016-04-13 19:09:07 +03:00
openstackclient	Initialize neutron client with region name	2016-04-18 19:54:58 +03:00
releasenotes	Merge "Fix SSL/TLS verification for network commands"	2016-04-13 08:31:37 +00:00
.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
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
README.rst	Add Testing Ref in README.rst	2016-04-11 11:12:37 -05:00
babel.cfg	Add translation markers for user v2 actions	2014-10-09 14:47:19 -04:00
post_test_hook.sh	unwedge the gate	2015-10-08 03:09:43 -04:00
requirements.txt	Updated from global requirements	2016-04-13 12:48:31 +00:00
setup.cfg	Merge "Refactor security group rule list to use SDK"	2016-04-11 03:01:13 +00:00
setup.py	Updated from global requirements	2015-09-18 16:42:31 +00:00
test-requirements.txt	Updated from global requirements	2016-04-08 00:33:16 +00:00
tox.ini	Merge "Defaults are ignored with flake8"	2016-02-26 01:59:47 +00: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 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>