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
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.2.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 29b221fb34d347a167037e64619f9d6c2d7f13fe60ba17a43272d686e16d69f5 |
|
MD5 | cd80abbe7684936b382b7f04ce4e18c9 |
|
BLAKE2b-256 | 4ca1e9dd04f8c2b381bf78b93e007c3abcb069047ca3c8915991d2453a9d53af |
Hashes for python_openstackclient-3.2.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b1e88c16d52418565bb7f486c07bc4ff03a2f654a7098188cd79e865fc7e3203 |
|
MD5 | 9ef9723339aeb1f87c95ddc2011d3463 |
|
BLAKE2b-256 | ea307c37a6220277f9f23a600d36de7f99dc6e90c810cb918a5e9a7f4df5d50e |