Go to file

Mark Vanderwiel 5903ffff8a Allow wait_for_delete to work for all clients

Allow the exception and error status
strings to be passed in such that other plugins can
make use of this function.

There is a comment in find_resource:
  The exception to catch here is dependent on which
  client library the manager passed in belongs to.
  Eventually this should be pulled from a common set
  of client exceptions.

Since I think that is a long ways off, this change will
work now and also work when a common exception is defined
and used.

Change-Id: Iab56cd1166028caed4f1e657e0b1ee81af3f48d8

2016-01-28 10:52:45 -06:00

doc

Merge "Remove the Tuskar client"

2016-01-28 00:25:14 +00:00

examples

Switch to ksa Session

2015-12-02 01:55:14 +00:00

functional

Add router functional tests

2016-01-25 10:28:59 -06:00

openstackclient

Allow wait_for_delete to work for all clients

2016-01-28 10:52:45 -06:00

python-openstackclient/locale

Imported Translations from Zanata

2016-01-19 06:03:29 +00:00

releasenotes

Merge "Add releasenote for 'subnet list' command support"

2016-01-27 00:36:31 +00:00

.coveragerc

Change ignore-errors to ignore_errors

2015-09-21 14:54:21 +00:00

.gitignore

Add reno for release notes management

2015-12-02 14:32:07 -06: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

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

Use Block Storage instead of Volume

2015-11-27 17:56:10 +08:00

requirements.txt

Updated from global requirements

2016-01-26 23:29:00 +00:00

setup.cfg

Merge "Subnet List"

2016-01-27 00:36:11 +00:00

setup.py

Updated from global requirements

2015-09-18 16:42:31 +00:00

test-requirements.txt

Remove the Tuskar client

2016-01-27 16:34:28 +00:00

tox.ini

Deprecated tox -downloadcache option removed

2015-12-11 23:30:31 +01: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
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>