OpenStack Command-line Client
Project description
Team and repository tags
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
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 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.
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-4.0.1.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 793b30012dbc9daf732b2bd1df87ea0da2df2486cb960666413f48710c66b4c1 |
|
| MD5 | 9649b9973e8a75d72e730e9f6eb927ce |
|
| BLAKE2b-256 | a0ff6bb8581e3d19404b4ce3aa0ded72f5949cc30f83b4d254f2875b3a9affbd |
Hashes for python_openstackclient-4.0.1-py2.py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a9c9dcde73626328e14a22d79adb89e1f5637db7ad1c1e0bed5fb2cc12bdc425 |
|
| MD5 | 5a62280c876485b03e7a1f06c8304df9 |
|
| BLAKE2b-256 | cb6db7facf292acde40f651eb9317c404a20994dc63e12a4dc57cd8e28b45f7b |
