Client for OpenStack services
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Go to file
Artem Goncharov f36a34b675 Switch compute aggregate functions to SDK
Continue journey towards having OSC consuming SDK for nova part.

Change-Id: Id16e6c47aa93f02f15f49e1f59f73fecaa3e3b80
3 years ago
doc Let autoprogram-cliff know who's running 3 years ago
examples Build utility image for using osc 3 years ago
openstackclient Switch compute aggregate functions to SDK 3 years ago
releasenotes Switch compute aggregate functions to SDK 3 years ago
tools Avoid for constraints support 6 years ago
.coveragerc Updated coverage configuration file 7 years ago
.gitignore Updates for stestr 6 years ago
.gitreview OpenDev Migration Patch 4 years ago
.mailmap Clean up test environment and remove unused imports. 11 years ago
.stestr.conf Updates for stestr 6 years ago
.zuul.yaml zuul: Stop testing against Tempest 3 years ago
CONTRIBUTING.rst Update http links in docs 3 years ago
Dockerfile Add a command to trigger entrypoint cache creation 3 years ago
HACKING.rst Remove references to Python 2.7 3 years ago
README.rst Doc: launchpad => storyboard 4 years ago
bindep.txt Fix gate due to switch to focal 3 years ago
lower-constraints.txt Switch compute flavors from novaclient/direct to SDK 3 years ago
requirements.txt Switch compute flavors from novaclient/direct to SDK 3 years ago
setup.cfg Switch compute aggregate functions to SDK 3 years ago Cleanup Python 2.7 support 3 years ago
test-requirements.txt switch to stevedore for entry points 3 years ago
tox.ini Replace deprecated UPPER_CONSTRAINTS_FILE variable 3 years 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.