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
Huanxuan Ao 23ee2fd8f0 Refactor "snapshot" commands
1.change the command name ``snapshot create/delete/list/
show/set/unset`` to ``volume snapshot create/delete/list/

2.change the optional parameter "--name <name>" to a
positional parameter "<snapshot-name>"; Change the
positional parameter "<volume>" to a optional
parameter "--volume <volume>"

Change-Id: If03276ecdf6f0d96893d5ecf91c2aaa64929cff3
Implements: bp backup-snapshot-renamed-for-volume-resource
Co-Authored-By: Sheel Rana <>
7 years ago
doc Refactor "snapshot" commands 7 years ago
examples osc-lib: api.auth 7 years ago
openstackclient Refactor "snapshot" commands 7 years ago
releasenotes Refactor "snapshot" commands 7 years ago
tools Cleanup after install 7 years ago
.coveragerc Updated coverage configuration file 7 years ago
.gitignore gitignore .idea 7 years ago
.gitreview Add openstack-common and test infrastructure. 11 years ago
.mailmap Clean up test environment and remove unused imports. 11 years ago
.testr.conf move unit tests to new "unit" test module 7 years ago
CONTRIBUTING.rst Added CONTRIBUTING.rst file 7 years ago
HACKING.rst Remove non-existing hacking deviations from doc 8 years ago
README.rst Added a note on how to test changes 7 years ago
babel.cfg Add translation markers for user v2 actions 9 years ago
requirements.txt Updated from global requirements 7 years ago
setup.cfg Refactor "snapshot" commands 7 years ago Updated from global requirements 8 years ago
test-requirements.txt Updated from global requirements 7 years ago
tox.ini move all functional tests to tests module 7 years ago



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.

  • PyPi - package installation
  • Online Documentation
  • Launchpad project - release management
  • Blueprints - feature specifications
  • Bugs - issue tracking
  • Source
  • Developer - getting started as a developer
  • Contributing - contributing code
  • Testing - testing code
  • IRC: #openstack-sdks on Freenode (
  • License: Apache 2.0

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_USERNAME=<username>
export OS_PASSWORD=<password>  # (optional)

The corresponding command-line options look very similar:

--os-auth-url <url>
--os-project-name <project-name>
--os-username <username>
[--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>