Client for OpenStack services
Go to file
huangshan 519296d762 Update http links in docs
This patch is proposed according to the Direction 10 of doc

Change-Id: I0061bf788a8da89da0077db63f6cecf2ead0d0be
2020-03-09 21:13:29 -05:00
doc Update http links in docs 2020-03-09 21:13:29 -05:00
examples osc-lib: api.auth 2016-06-30 08:57:59 -05:00
openstackclient Merge "Fix copypaste errors in access rule command" 2020-03-03 23:40:35 +00:00
releasenotes Complete "Drop python2 support" goal 2020-02-05 05:58:51 +00:00
tools Avoid for constraints support 2017-12-01 10:26:50 -06:00
.coveragerc Updated coverage configuration file 2016-10-24 17:53:33 +05:30
.gitignore Updates for stestr 2017-09-15 06:32:58 +00:00
.gitreview OpenDev Migration Patch 2019-04-19 19:45:05 +00:00
.mailmap Clean up test environment and remove unused imports. 2013-01-22 11:44:18 -06:00
.stestr.conf Updates for stestr 2017-09-15 06:32:58 +00:00
.zuul.yaml Stop testing python 2 in tox and zuul. 2019-12-06 16:06:36 +00:00
CONTRIBUTING.rst Update http links in docs 2020-03-09 21:13:29 -05:00
HACKING.rst Replace six.iteritems() with .items() 2020-01-09 18:41:29 +09:00
LICENSE Remove LICENSE APPENDIX 2015-11-18 13:25:56 +09:00
README.rst Doc: launchpad => storyboard 2019-10-22 15:13:40 -05:00
babel.cfg Add translation markers for user v2 actions 2014-10-09 14:47:19 -04:00
bindep.txt Add bindep file 2020-03-04 15:36:18 -06:00
lower-constraints.txt Add support for app cred access rules 2020-01-17 11:14:51 -08:00
requirements.txt Add support for app cred access rules 2020-01-17 11:14:51 -08:00
setup.cfg Complete "Drop python2 support" goal 2020-02-05 05:58:51 +00:00 Updated from global requirements 2017-03-03 22:59:10 +00:00
test-requirements.txt Merge "Raise flake8-import-order version to latest" 2020-01-13 18:24:20 +00:00
tox.ini Bump tox minversion 2020-01-07 09:22:30 -05:00


Team and repository tags



Latest Version

OpenStackClient (aka OSC) is a command-line client for OpenStack that brings the command set for Compute, Identity, Image, Network, 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.

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 develop


pip install -e .


The CLI is configured via environment variables and command-line options as listed in

Authentication using username/password is most commonly used:

export OS_AUTH_URL=<url-to-openstack-identity>
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.