Client for OpenStack services
Go to file
Huan Xiong 61025bf102 Useless line of code in shell.py
Shell.py contains lines to import osprofiler. This is useless
because osprofiler options support code was moved to osc-lib.

Removed it.

Change-Id: Ibec17700c87df908640848c3787d190ca66a7bcf
Closes-Bug: #1707103
2017-09-08 06:28:15 +00:00
doc Update image cli doc and fix some typos 2017-08-25 08:08:31 +08:00
examples osc-lib: api.auth 2016-06-30 08:57:59 -05:00
openstackclient Useless line of code in shell.py 2017-09-08 06:28:15 +00:00
releasenotes Implied Roles 2017-08-22 17:08:30 +00:00
tools Cleanup after install 2016-08-28 08:48:23 +02:00
.coveragerc Updated coverage configuration file 2016-10-24 17:53:33 +05:30
.gitignore move auto-generated api docs into contributor tree 2017-06-23 11:57:31 +02: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 move unit tests to new "unit" test module 2016-09-08 15:19:50 -07:00
babel.cfg Add translation markers for user v2 actions 2014-10-09 14:47:19 -04:00
CONTRIBUTING.rst Added CONTRIBUTING.rst file 2016-05-16 17:42:48 +05:30
HACKING.rst Update the documentation link for doc migration 2017-07-24 11:33:07 +08:00
LICENSE Remove LICENSE APPENDIX 2015-11-18 13:25:56 +09:00
README.rst Merge "Update the documentation link for doc migration" 2017-07-27 13:48:04 +00:00
requirements.txt Updated from global requirements 2017-09-06 03:15:36 +00:00
setup.cfg Implied Roles 2017-08-22 17:08:30 +00:00
setup.py Updated from global requirements 2017-03-03 22:59:10 +00:00
test-requirements.txt Updated from global requirements 2017-08-18 11:42:09 +00:00
tox.ini flake8-import-order: Ensure to place project imports last 2017-08-22 21:38:07 +00:00

Team and repository tags

image

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 https://docs.openstack.org/python-openstackclient/latest/cli/authentication.html.

Authentication using username/password is most commonly used:

export OS_AUTH_URL=<url-to-openstack-identity>
export OS_IDENTITY_API_VERSION=3
export OS_PROJECT_NAME=<project-name>
export OS_PROJECT_DOMAIN_NAME=<project-domain-name>
export OS_USERNAME=<username>
export OS_USER_DOMAIN_NAME=<user-domain-name>
export OS_PASSWORD=<password>  # (optional)

The corresponding command-line options look very similar:

--os-auth-url <url>
--os-identity-api-version 3
--os-project-name <project-name>
--os-project-domain-name <project-domain-name>
--os-username <username>
--os-user-domain-name <user-domain-name>
[--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>