3c280727e7
This has no impact on the end result, but it should make fixing issues
introduced by API microversion 2.69 a little easier.
Conflicts:
openstackclient/compute/v2/server.py
NOTE(melwitt): The conflicts are because the following changes are not
in Victoria:
* I463993170c03a1d98c47ab6a3c19131b7fca1099 (Remove oslo.utils)
* I18991adf899c7b72c98bb89871bf0715d35943f0 (Add a few selectable
fields to the "openstack server list" output)
* I2f2033a8d49ee42eb21696a9cd28e63ad9712fad (trivial: Cleanup docs
for 'server list')
Change-Id: I7d70eac8aa1a6197ed05a49f071e6899ec219c03
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
(cherry picked from commit 4c3de28e83)
(cherry picked from commit f4adbcef7b)
(cherry picked from commit cb621f22d4)
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
- Online Documentation
- Storyboard project - bugs and feature requests
- Blueprints - feature specifications (historical only)
- Source
- 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-openstackclientThere are a few variants on getting help. A list of global options
and supported commands is shown with --help:
openstack --helpThere is also a help command that can be used to get
help text for a specific command:
openstack help
openstack help server createIf you want to make changes to the OpenStackClient for testing and contribution, make any changes and then run:
python setup.py developor:
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.