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 8aed5feab8 Merge "Fix uploading an signed image does not work if private signing key is encrypted" 2 days ago
doc Merge "image: autogenerate docs" 1 month ago
examples Build utility image for using osc 3 months ago
openstackclient Merge "Fix uploading an signed image does not work if private signing key is encrypted" 2 days ago
releasenotes Merge "Fix uploading an signed image does not work if private signing key is encrypted" 2 days ago
tools Avoid tox_install.sh for constraints support 2 years ago
.coveragerc Updated coverage configuration file 3 years ago
.gitignore Updates for stestr 2 years ago
.gitreview OpenDev Migration Patch 1 year ago
.mailmap Clean up test environment and remove unused imports. 7 years ago
.stestr.conf Updates for stestr 2 years ago
.zuul.yaml Remove enabling of glance v1 API 1 week ago
CONTRIBUTING.rst Update http links in docs 4 months ago
Dockerfile Add a command to trigger entrypoint cache creation 4 days ago
HACKING.rst Replace six.iteritems() with .items() 6 months ago
LICENSE Remove LICENSE APPENDIX 4 years ago
README.rst Doc: launchpad => storyboard 8 months ago
bindep.txt Add libc6-dev to bindep 3 months ago
lower-constraints.txt Merge "Expose flag for forcing use of import for images" 2 days ago
requirements.txt Merge "Expose flag for forcing use of import for images" 2 days ago
setup.cfg Merge "Make volume backup record commands available in v3" 3 days ago
setup.py Cleanup Python 2.7 support 3 months ago
test-requirements.txt switch to stevedore for entry points 4 days ago
tox.ini Remove os-client-config references 1 month ago

README.rst

Team and repository tags

image

OpenStackClient

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 setup.py develop

or:

pip install -e .

Configuration

The CLI is configured via environment variables and command-line options as listed in https://docs.openstack.org/python-openstackclient/latest/cli/authentication.html.

Authentication using username/password is most commonly used:

export OS_AUTH_URL=<url-to-openstack-identity>
export OS_IDENTITY_API_VERSION=3
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.