Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
OpenStack Command Line Client
Python

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
doc Add support to remote_id
examples Move OSC auth plugins so they can be found
functional Merge "Look harder to find DevStack"
openstackclient Add support to remote_id
python-openstackclient/locale
tools sync oslo bits
.coveragerc
.gitignore Enhance the theming for modules page
.gitreview Add openstack-common and test infrastructure.
.mailmap Clean up test environment and remove unused imports.
.testr.conf Add Identity v2 project tests
HACKING.rst
LICENSE First commit
MANIFEST.in Add translation markers for user v2 actions
README.rst Update README
babel.cfg Add translation markers for user v2 actions
openstack-common.conf Use oslo.utils
post_test_hook.sh Add functional tests to osc
requirements.txt Updated from global requirements
run_tests.sh Modify run_tests.sh to just run tox
setup.cfg Add the ability to set and unset flavor properties
setup.py Updated from global requirements
test-requirements.txt Updated from global requirements
tox.ini Change test order to avoid incompatibliity

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>
Something went wrong with that request. Please try again.