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.
Zuul 7046562919 Merge "bump py37 to py38 in tox.ini" 10 months ago
doc Update developing.rst 11 months ago
examples Build utility image for using osc 1 year ago
openstackclient Merge "Fix --image-property option in 'create server'" 10 months ago
releasenotes Merge "Fix --image-property option in 'create server'" 10 months ago
tools Pep8 environment to run on delta code only 5 years ago
.coveragerc Updated coverage configuration file 5 years ago
.gitignore Updates for stestr 4 years ago
.gitreview OpenDev Migration Patch 2 years ago
.mailmap Clean up test environment and remove unused imports. 9 years ago
.stestr.conf Updates for stestr 4 years ago
.zuul.yaml Support tagging Neutron ports on creation 11 months ago
CONTRIBUTING.rst Update http links in docs 1 year ago
Dockerfile Add a command to trigger entrypoint cache creation 1 year ago
HACKING.rst Replace six.iteritems() with .items() 2 years ago
README.rst Doc: launchpad => storyboard 2 years ago
bindep.txt Fix gate due to switch to focal 11 months ago
lower-constraints.txt Fix gate due to switch to focal 11 months ago
requirements.txt Merge "Expose flag for forcing use of import for images" 1 year ago
setup.cfg Merge "Make volume backup record commands available in v3" 1 year ago Cleanup Python 2.7 support 1 year ago
test-requirements.txt switch to stevedore for entry points 1 year ago
tox.ini Merge "bump py37 to py38 in tox.ini" 10 months ago


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.