openstack/python-openstackclient
Code Issues Proposed changes
Client for OpenStack services
4,896 Commits 6 Branches 60 Tags 72 MiB
Python 100%
2eeab20eca
Go to file
Zuul 2eeab20eca Merge "Always display direction for security group rules"
2020-10-13 23:26:24 +00:00
doc Merge "Add server migration list CLI" 2020-10-12 16:01:52 +00:00
examples Build utility image for using osc 2020-03-14 17:15:46 -05:00
openstackclient Merge "Always display direction for security group rules" 2020-10-13 23:26:24 +00:00
releasenotes Merge "Always display direction for security group rules" 2020-10-13 23:26:24 +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 zuul: Stop testing against Tempest 2020-10-12 17:25:03 +01:00
bindep.txt Fix gate due to switch to focal 2020-09-11 10:25:56 +02:00
CONTRIBUTING.rst Update http links in docs 2020-03-09 21:13:29 -05:00
Dockerfile Add a command to trigger entrypoint cache creation 2020-07-06 14:53:50 -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
lower-constraints.txt Remove usage of six 2020-10-07 02:15:25 +00:00
README.rst Doc: launchpad => storyboard 2019-10-22 15:13:40 -05:00
requirements.txt Remove oslo.utils 2020-10-12 17:29:57 +01:00
setup.cfg Add server migration list CLI 2020-09-24 18:45:13 +08:00
setup.py Cleanup Python 2.7 support 2020-03-30 20:00:41 +02:00
test-requirements.txt switch to stevedore for entry points 2020-07-06 08:44:31 -04:00
tox.ini Merge "bump py37 to py38 in tox.ini" 2020-10-01 13:14:02 +00: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.