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.2.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5577dc7bdf924cad1406fa52570b44b0819b554118cb37b9f3e3222c91934834 |
|
MD5 | 7171871fc0a265223e0b856ffe2fc762 |
|
BLAKE2b-256 | 8830eaeae99c9e8b6e6d83b5b7fb8cc8e66e5804562977f412d9a12372a335c2 |
Hashes for python_openstackclient-5.2.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f5d72e0163286c4e0c3aeabaecd069bd8bcd2075f28f459bdcdafc5d23ab4b9f |
|
MD5 | 79b3f0777ac7d7b8cd8e08afbd2e7a08 |
|
BLAKE2b-256 | f1152ca78e2a6478937b19f43aaa706697ee4a09f7d24a1888f6e8c056e0a084 |