openstack
/
python-openstackclient
Code Issues Proposed changes
Client for OpenStack services
4,824 Commits 10 Branches 46 Tags 69 MiB
Python 100%
Go to file
Zuul 03b6f53675 Merge "Remove translation sections from setup.cfg" 2020-07-04 16:46:55 +00:00
doc Merge "image: autogenerate docs" 2020-06-09 02:10:31 +00:00
examples Build utility image for using osc 2020-03-14 17:15:46 -05:00
openstackclient Merge "Allow os quota list query to filter by project" 2020-06-29 22:22:25 +00:00
releasenotes Merge "Switch to newer openstackdocstheme and reno versions" 2020-06-05 18:32:11 +00:00
tools Avoid tox_install.sh 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 Remove os-client-config references 2020-06-08 16:20:28 -05:00
CONTRIBUTING.rst Update http links in docs 2020-03-09 21:13:29 -05:00
Dockerfile Be explicit about python version in image 2020-03-26 08:48:20 -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
bindep.txt Add libc6-dev to bindep 2020-03-26 08:46:13 -05:00
lower-constraints.txt Remove translation sections from setup.cfg 2020-06-23 12:22:58 +08:00
requirements.txt Remove Babel from requirements 2020-04-17 18:15:11 +02:00
setup.cfg Remove translation sections from setup.cfg 2020-06-23 12:22:58 +08:00
setup.py Cleanup Python 2.7 support 2020-03-30 20:00:41 +02:00
test-requirements.txt Remove os-client-config references 2020-06-08 16:20:28 -05:00
tox.ini Remove os-client-config references 2020-06-08 16:20:28 -05:00

README.rst

Team and repository tags

image

OpenStackClient

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 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.