openstack
/
python-openstackclient
Code Issues Proposed changes
Client for OpenStack services
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
4,879 Commits
12 Branches
31 Tags
64 MiB
Python 100%
 
master
stable/2023.1
stable/wallaby
stable/xena
stable/yoga
stable/zed
stable/train
stable/ussuri
stable/victoria
stable/rocky
stable/stein
feature/osc4
xena-em
6.2.0
6.1.0
5.6.2
5.6.1
queens-eol
wallaby-em
6.0.0
pike-eol
victoria-em
5.8.0
5.7.0
ussuri-em
5.6.0
5.5.1
5.2.2
ocata-eol
train-em
5.5.0
4.0.2
stein-em
5.4.0
5.3.1
5.3.0
4.0.1
5.2.1
5.2.0
5.1.0
rocky-em
5.0.0
3.18.1
3.16.3
queens-em
4.0.0
3.19.0
pike-em
3.12.2
ocata-em
3.18.0
3.14.3
3.16.2
3.17.0
3.16.1
3.16.0
3.14.2
3.8.2
3.14.1
3.12.1
3.15.0
3.14.0
3.13.0
newton-eol
3.12.0
mitaka-eol
3.11.0
3.10.0
3.9.0
2.3.1
3.8.1
3.8.0
3.7.0
3.6.0
3.5.0
liberty-eol
3.2.1
3.4.1
3.4.0
3.3.0
3.2.0
3.1.0
3.0.1
3.0.0
kilo-eol
2.6.0
2.5.0
2.4.0
2.3.0
1.0.5
2.2.0
2.1.0
1.7.2
2.0.0
1.9.0
1.8.0
1.7.1
1.7.0
1.6.0
1.5.0
1.4.0
1.3.0
1.0.4
1.2.0
1.1.0
1.0.3
1.0.2
1.0.1
1.0.0
0.4.1
0.4.0
0.3.1
0.3.0
0.2.2
0.2.1
0.2.0
0.2.rc1
0.2.alpha1
0.1
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '671f73694a'
${ noResults }
Go to file
Stephen Finucane 671f73694a zuul: Stop testing against Tempest 
Neither Tempest itself nor any of the service projects use OSC. As such,
there's no reason to run Tempest jobs here. It's simply a waste of
resources.

Change-Id: I74b0b196fe59e5e1462e3dadc659cf6680a53f80
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
 		3 years ago
doc Remove usage of six 3 years ago
examples Build utility image for using osc 3 years ago
openstackclient Merge "Remove usage of six" 3 years ago
releasenotes Merge "Add 'openstack server create --use-config-drive'" 3 years ago
tools Avoid tox_install.sh for constraints support 6 years ago
.coveragerc Updated coverage configuration file 7 years ago
.gitignore Updates for stestr 6 years ago
.gitreview OpenDev Migration Patch 4 years ago
.mailmap Clean up test environment and remove unused imports. 10 years ago
.stestr.conf Updates for stestr 6 years ago
.zuul.yaml zuul: Stop testing against Tempest 3 years ago
CONTRIBUTING.rst Update http links in docs 3 years ago
Dockerfile Add a command to trigger entrypoint cache creation 3 years ago
HACKING.rst Replace six.iteritems() with .items() 3 years ago
LICENSE Remove LICENSE APPENDIX 8 years ago
README.rst Doc: launchpad => storyboard 4 years ago
bindep.txt Fix gate due to switch to focal 3 years ago
lower-constraints.txt Remove usage of six 3 years ago
requirements.txt Remove usage of six 3 years ago
setup.cfg Merge "Make volume backup record commands available in v3" 3 years ago
setup.py Cleanup Python 2.7 support 3 years ago
test-requirements.txt switch to stevedore for entry points 3 years ago
tox.ini Merge "bump py37 to py38 in tox.ini" 3 years ago

README.rst

Team and repository tags

image

OpenStackClient

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.

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.