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, 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.
PyPi - package installation
Storyboard project - bugs and feature requests
Blueprints - feature specifications (historical only)
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 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.
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-5.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 078e7bde08acfa0d2110987c187f8e3abdd03057fc552bec8b83deba6a1a8f2b |
|
MD5 | 9aa1490b9100aa1b1bea35d91ad68356 |
|
BLAKE2b-256 | 63e01571bc400c8b5ff1b68dbc506ec22225d28c88151a6d62f586b69bc6a9c1 |
Hashes for python_openstackclient-5.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d8a832d76766abc9eff9edfda89131e29e84a94d256a97c9daa67de9017453a1 |
|
MD5 | 454cbaecd72796dd74e2e6c766ef2177 |
|
BLAKE2b-256 | a8fc24d66a2137300e56c5b1bb2e72dc1790cfdb86dc74be946652d45b9c2a51 |