Client for OpenStack services
您最多选择25个主题 主题必须以字母或数字开头,可以包含连字符 (-),并且长度不得超过35个字符
Zuul c6a171f010 Merge "Refactor AggregateTests" 1周前
doc Deflate .htaccess 1周前
examples osc-lib: api.auth 3 年前
openstackclient Merge "Refactor AggregateTests" 1周前
releasenotes Merge "Add parent project filter for listing projects" 3 周前
tools Avoid for constraints support 1年前
.coveragerc Updated coverage configuration file 3 年前
.gitignore Updates for stestr 2 年前
.gitreview OpenDev Migration Patch 6 个月前
.mailmap Clean up test environment and remove unused imports. 6 年前
.stestr.conf Updates for stestr 2 年前
.zuul.yaml Add Python 3 Train unit tests 4 个月前
CONTRIBUTING.rst Doc: launchpad => storyboard 3 周前
HACKING.rst Update the documentation link for doc migration 2 年前
README.rst Doc: launchpad => storyboard 3 周前
babel.cfg Add translation markers for user v2 actions 5 年前
lower-constraints.txt Use autoprogram-cliff for remaining plugin docs 2 周前
requirements.txt Microversion 2.77: Support Specifying AZ to unshelve 2 个月前
setup.cfg compute: autogenerate docs 1周前 Updated from global requirements 2 年前
test-requirements.txt Remove plugin projects from test-requirements.txt 3 周前
tox.ini Add redirect testing 1周前


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.