OpenStack Command-line Client
.. image:: https://governance.openstack.org/tc/badges/python-openstackclient.svg :target: https://governance.openstack.org/tc/reference/tags/index.html
.. Change things from this point on
.. image:: https://img.shields.io/pypi/v/python-openstackclient.svg :target: https://pypi.org/project/python-openstackclient/ :alt: Latest Version
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 installationOnline Documentation
_Launchpad project
_ - bugs and feature requestsBlueprints
_ - feature specifications (historical only)Source
_Developer
_ - getting started as a developerContributing
_ - contributing codeTesting
_ - testing code.. _PyPi: https://pypi.org/project/python-openstackclient
.. _Online Documentation: https://docs.openstack.org/python-openstackclient/latest/
.. _Blueprints: https://blueprints.launchpad.net/python-openstackclient
.. _Launchpad project
: https://bugs.launchpad.net/python-openstackclient
.. _Source: https://opendev.org/openstack/python-openstackclient
.. _Developer: https://docs.openstack.org/project-team-guide/project-setup/python.html
.. _Contributing: https://docs.openstack.org/infra/manual/developers.html
.. _Testing: https://docs.openstack.org/python-openstackclient/latest/contributor/developing.html#testing
.. _Release Notes: https://docs.openstack.org/releasenotes/python-openstackclient
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 .
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:
For a local user, your configuration will look like the one below::
export OS_AUTH_URL=
The corresponding command-line options look very similar::
--os-auth-url
For a federated user, your configuration will look the so::
export OS_PROJECT_NAME=
The corresponding command-line options look very similar::
--os-project-name
If a password is not provided above (in plaintext), you will be interactively prompted to provide one securely.