Skip to main content

Team and repository tags

http://governance.openstack.org/badges/python-openstackclient.svg

OpenStackClient

Latest Version Downloads

OpenStackClient (aka OSC) is a command-line client for OpenStack that brings the command set for Compute, Identity, Image, 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

  • Launchpad project - release management

  • Blueprints - feature specifications

  • Bugs - issue tracking

  • 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-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.

Authentication may also be performed using an already-acquired token and a URL pointing directly to the service API that presumably was acquired from the Service Catalog:

export OS_TOKEN=<token>
export OS_URL=<url-to-openstack-service>

The corresponding command-line options look very similar:

--os-token <token>
--os-url <url-to-openstack-service>

Metadata

Release files for python-openstackclient 3.14.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for python-openstackclient 3.14.2
File Size Uploaded Provenance
python-openstackclient-3.14.2.tar.gz 668.3 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for python-openstackclient 3.14.2
File Interpreter ABI Platform
python_openstackclient-3.14.2-py2.py3-none-any.whl Python 2, Python 3 none any Details

Total release size: 1.5 MB

Release files / python-openstackclient-3.14.2.tar.gz

Download URL python-openstackclient-3.14.2.tar.gz
Size 668.3 kB
Tags Source
SHA-256 checksum
How to use checksums
7a3b286aff05eb69606e6492bfb27e6e7da779cfa4dfafba545b03dfdc2513a6
BLAKE2b-256 checksum
How to use checksums
70fd1735d64f2606a8d8ac821163e2e463f22d2bb7c13a2190a4e16fb590b0d3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / python_openstackclient-3.14.2-py2.py3-none-any.whl

Download URL python_openstackclient-3.14.2-py2.py3-none-any.whl
Size 806.0 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
ec085580eafa7afa38dfd3300908588a9d7783b43f111ed09aa14bde0ccb61b0
BLAKE2b-256 checksum
How to use checksums
b8ba791154e9e328764540b7070243aa4e9823a734498c680f5218956d79b5a6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for python-openstackclient 3.14.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Release history Release notifications | RSS feed

This release

3.14.2 This release

2 release files No provenance

0.1.51

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page