OpenStack Command-line Client
Project description
OpenStackClient
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
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 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>
Project details
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-3.10.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d2facb3c67ba5facec45adb80a46cb2eaf4f449a54dfc64fb11d0f07e3445ebe |
|
MD5 | 582300d5a78f3c51a400b1457536a129 |
|
BLAKE2b-256 | dea83ddbf1fa0896d0525138746474b944c6e0ed555d298c7a247a5f7c6eab4d |
Hashes for python_openstackclient-3.10.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 73226e68d90608d1e9126b6ee0b87b611f63c0df66d9d1cf06972022eebcb9a5 |
|
MD5 | bb95a663545451a6328faebf931818c4 |
|
BLAKE2b-256 | 83ad98556cd80cf656b93fb5de38b21d0f29f3c39381b71eba5cecd204368d2e |