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.9.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 74262dd62d410c5d1c4fc0ca98ffe50a0f7b55254f53d03a1dc8f5fd87fa519d |
|
MD5 | bf955a73330c8792efa471c8895523d8 |
|
BLAKE2b-256 | 09e558ff3c1529d49bb436f4d7123df33f09222a9a2dac591ec66b9e4ecc74ee |
Hashes for python_openstackclient-3.9.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3c48e9bbdff8a7679f04fe6a03d609c75e597975f9f43de7ec001719ec554ad9 |
|
MD5 | 8eef24e4afa4c47be991d88a62b9d8be |
|
BLAKE2b-256 | f702cc20ac2b50af74781186fcf8b0599acbfb21238122c830a0cfce936526ef |