OpenStack Command Line Client
Python
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
doc Merge "Add assignment list to v2 identity and deprecate alternate lis… Jul 23, 2016
examples osc-lib: api.auth Jun 30, 2016
functional Transfer "ip floating CRUD" to "floating ip CRUD" Jul 20, 2016
openstackclient Merge "Add assignment list to v2 identity and deprecate alternate lis… Jul 23, 2016
releasenotes Add assignment list to v2 identity and deprecate alternate listing Jul 22, 2016
tools Follow upper constraints for all tox targets Jul 17, 2016
.coveragerc Change ignore-errors to ignore_errors Sep 21, 2015
.gitignore gitignore .idea Feb 20, 2016
.gitreview Add openstack-common and test infrastructure. Apr 28, 2012
.mailmap Clean up test environment and remove unused imports. Jan 22, 2013
.testr.conf Use format options for functional tests May 17, 2015
CONTRIBUTING.rst Added CONTRIBUTING.rst file May 16, 2016
HACKING.rst Remove non-existing hacking deviations from doc Aug 9, 2015
LICENSE Remove LICENSE APPENDIX Nov 18, 2015
README.rst Added a note on how to test changes Jul 7, 2016
babel.cfg Add translation markers for user v2 actions Oct 9, 2014
post_test_hook.sh unwedge the gate Oct 8, 2015
requirements.txt Updated from global requirements Jul 21, 2016
setup.cfg Add assignment list to v2 identity and deprecate alternate listing Jul 22, 2016
setup.py Updated from global requirements Sep 18, 2015
test-requirements.txt Remove discover from test-requirements Jul 22, 2016
tox.ini Follow upper constraints for all tox targets Jul 17, 2016

README.rst

OpenStackClient

Latest Version Downloads

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

If you want to make changes to the OpenStackClient for testing and contribution, make any changes and then run:

python setup.py develop

or:

pip install -e .

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>