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
Monty Taylor 8c47b67e83 Build utility image for using osc
python-openstackclient currently has a non-zero number of dependencies,
so for admins who would like to run it on laptops or similar it can
get tricky. In opendev, for instance, admins have it installed into
a venv on a jump host, but it's really wonky to keep up with.

Use the opendev/python-builder opendev/python-base pair to make a
minimal image that contains an install of python-openstackclient
and publish it to the osclient org on dockerhub. There is an overall
policy against having binary artifacts such as this appear to be
official deliverables of the OpenStack project, which this is not.
It's also only publishing images based on master, so no warranties
should be implied. But if this makes life easier for a user somewhere,

Change-Id: I9a8bfc27c127e92b6856cb6a3e45b32c818db16c
3 years ago
doc Merge "Complete "Drop python2 support" goal" 3 years ago
examples Build utility image for using osc 3 years ago
openstackclient Use 'KeyValueAppendAction' from osc-lib 3 years ago
releasenotes Complete "Drop python2 support" goal 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 Build utility image for using osc 3 years ago
CONTRIBUTING.rst Doc: launchpad => storyboard 4 years ago
Dockerfile Build utility image for using osc 3 years ago
HACKING.rst Replace six.iteritems() with .items() 3 years ago
README.rst Doc: launchpad => storyboard 4 years ago
babel.cfg Add translation markers for user v2 actions 9 years ago
bindep.txt Add bindep file 3 years ago
lower-constraints.txt Add support for app cred access rules 3 years ago
requirements.txt Add support for app cred access rules 3 years ago
setup.cfg Complete "Drop python2 support" goal 3 years ago Updated from global requirements 6 years ago
test-requirements.txt Merge "Raise flake8-import-order version to latest" 3 years ago
tox.ini Bump tox minversion 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.