OpenStack Command-line Client
Project description
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
Launchpad project - release management
Blueprints - feature specifications
Bugs - issue tracking
Developer - getting started as a developer
Contributing - contributing code
Testing - testing code
IRC: #openstack-sdks on Freenode (irc.freenode.net)
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
Configuration
The CLI is configured via environment variables and command-line options as listed in http://docs.openstack.org/developer/python-openstackclient/authentication.html.
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>
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for python-openstackclient-2.4.0.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c160b9085d374a6efbae6a0d2e89308ae9d47283f447d49c2172a24f4d76f410 |
|
| MD5 | 81ad5dd3e85c8fe4c979485a158b0847 |
|
| BLAKE2b-256 | 732dcdf7cdcc5ec9925da87b3766f8222d59cd3cd11f03c64efbdef5e3e6b001 |
Hashes for python_openstackclient-2.4.0-py2.py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 6e7fadc8683abe76e2bd17f6132bbea33a9c3e8f72f09a420e3ce41f1fd13504 |
|
| MD5 | f750718bfcf01729eab4bc2ea11210d5 |
|
| BLAKE2b-256 | 3b0880c5c7dbfcceb942fb82b94b3edc143d7202eb2c012e90c44ab2a98250f4 |
