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.
Corey Bryant b41d7518c3 Add Python 3 Train unit tests 1 week ago
doc Merge "Change default security group protocol to 'any'" 3 weeks ago
examples osc-lib: api.auth 3 years ago
openstackclient Merge "Use cliff formattable columns in identity commands" 3 weeks ago
releasenotes Merge "Change default security group protocol to 'any'" 3 weeks ago
tools Avoid tox_install.sh for constraints support 1 year ago
.coveragerc Updated coverage configuration file 2 years ago
.gitignore Updates for stestr 1 year ago
.gitreview OpenDev Migration Patch 2 months ago
.mailmap Clean up test environment and remove unused imports. 6 years ago
.stestr.conf Updates for stestr 1 year ago
.zuul.yaml Add Python 3 Train unit tests 2 weeks ago
CONTRIBUTING.rst Added CONTRIBUTING.rst file 3 years ago
HACKING.rst Update the documentation link for doc migration 2 years ago
LICENSE Remove LICENSE APPENDIX 3 years ago
README.rst Followup opendev cleanup and test jobs 2 months ago
babel.cfg Add translation markers for user v2 actions 4 years ago
lower-constraints.txt Microversion 2.73: Support adding the reason behind a server lock 3 weeks ago
requirements.txt Microversion 2.73: Support adding the reason behind a server lock 3 weeks ago
setup.cfg Add Python 3 Train unit tests 2 weeks ago
setup.py Updated from global requirements 2 years ago
test-requirements.txt Blacklist Bandit 1.6.0 due to directory exclusion bug 2 months ago
tox.ini Add Python 3 Train unit tests 1 week ago

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

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>