Client for OpenStack services
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Huanxuan Ao b0c317ebdd Add Support for showing flavor access list 5 years ago
doc Merge "Add "--project" option to "volume type create" command" 5 years ago
examples osc-lib: api.auth 5 years ago
functional Merge "Unskip the tests affected by warlock 1.3.0" 5 years ago
openstackclient Add Support for showing flavor access list 5 years ago
releasenotes Add Support for showing flavor access list 5 years ago
tools Follow upper constraints for all tox targets 5 years ago
.coveragerc Change ignore-errors to ignore_errors 6 years ago
.gitignore gitignore .idea 6 years ago
.gitreview Add openstack-common and test infrastructure. 9 years ago
.mailmap Clean up test environment and remove unused imports. 9 years ago
.testr.conf Use format options for functional tests 6 years ago
CONTRIBUTING.rst Added CONTRIBUTING.rst file 5 years ago
HACKING.rst Remove non-existing hacking deviations from doc 6 years ago
LICENSE Remove LICENSE APPENDIX 6 years ago
README.rst Added a note on how to test changes 5 years ago
babel.cfg Add translation markers for user v2 actions 7 years ago
post_test_hook.sh unwedge the gate 6 years ago
requirements.txt Updated from global requirements 5 years ago
setup.cfg Add Python3.5 to setup.cfg tox.ini 5 years ago
setup.py Updated from global requirements 6 years ago
test-requirements.txt Add python-neutronclient to OSC plugins 5 years ago
tox.ini Follow upper constraints for all tox targets 5 years ago

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>