OpenStack Command-line Client

Warnings

• breaking Python 2.x is no longer supported. `python-openstackclient` 9.0.0 requires Python >=3.10. Older versions of the client (especially pre-3.x) might have exhibited syntax errors if run with Python 2.
  Fix: Ensure your environment uses Python 3.10 or higher. Use `python3 -m pip install ...`.
• gotcha There are two PyPI packages: `python-openstackclient` (the core client) and `openstackclient` (a metapackage that installs `python-openstackclient` and common plugins). The latter is often recommended for a more complete experience.
  Fix: For a full suite of commands, `pip install openstackclient` is generally preferred.
• deprecated Legacy project-specific command-line clients (e.g., `nova`, `glance`, `cinder` CLIs) are being actively superseded by `python-openstackclient` for a unified experience. Some advanced or less common features might still exist only in the legacy clients but are being migrated.
  Fix: Prefer using `openstack <service> <command>` (e.g., `openstack server list`) over legacy commands (e.g., `nova list`). Refer to documentation for equivalent commands.
• gotcha Installing Python packages directly into the system's Python environment using `pip install` without a virtual environment can lead to conflicts and break system tools.
  Fix: Always use Python virtual environments (`python3 -m venv .venv` and `source .venv/bin/activate`) when installing packages with `pip` to isolate dependencies.
• gotcha Authentication can be configured via environment variables (e.g., sourcing an `openrc` file), a `clouds.yaml` file, or command-line options. Inconsistent or missing authentication details are a common source of errors.
  Fix: Ensure one of the authentication methods is correctly configured. For `clouds.yaml`, it's typically located at `~/.config/openstack/clouds.yaml` or specified via `OS_CLIENT_CONFIG_FILE`. Verify settings like `OS_AUTH_URL`, `OS_USERNAME`, `OS_PASSWORD`, `OS_PROJECT_NAME`, etc.

Install

• python3 -m pip install python-openstackclient Install `python-openstackclient`
• python3 -m pip install openstackclient Recommended: Install `openstackclient` metapackage (includes plugins)

Imports

• openstack

  import subprocess
  # ... or use openstacksdk for direct Python API interaction

  `python-openstackclient` is primarily a command-line interface. Direct programmatic import of the `openstackclient` module for application logic is not the typical pattern. For Python API interactions, the `openstacksdk` library is recommended. If you need to execute CLI commands from Python, use `subprocess`.

Quickstart

This quickstart demonstrates how to interact with the OpenStack CLI programmatically from Python using `subprocess`. It shows two common authentication methods: environment variables (often sourced from an `openrc` file) and `clouds.yaml`. Ensure your OpenStack credentials are set as environment variables or configured in a `clouds.yaml` file for the client to authenticate successfully.

import os
import subprocess

# --- Configuration (choose one method) ---
# Method 1: Environment Variables (recommended for scripts)
os.environ['OS_AUTH_URL'] = os.environ.get('OS_AUTH_URL', 'http://<your-keystone-url>/v3')
os.environ['OS_USERNAME'] = os.environ.get('OS_USERNAME', 'admin')
os.environ['OS_PASSWORD'] = os.environ.get('OS_PASSWORD', 'your_password')
os.environ['OS_PROJECT_NAME'] = os.environ.get('OS_PROJECT_NAME', 'admin')
os.environ['OS_USER_DOMAIN_NAME'] = os.environ.get('OS_USER_DOMAIN_NAME', 'Default')
os.environ['OS_PROJECT_DOMAIN_NAME'] = os.environ.get('OS_PROJECT_DOMAIN_NAME', 'Default')
os.environ['OS_IDENTITY_API_VERSION'] = os.environ.get('OS_IDENTITY_API_VERSION', '3')

# Method 2: clouds.yaml (often found in ~/.config/openstack/clouds.yaml)
# Ensure your clouds.yaml is configured and replace 'my-cloud' with your cloud name
# If using clouds.yaml, you might not need to set environment variables.
# Example clouds.yaml content (place in ~/.config/openstack/clouds.yaml or specify via OS_CLIENT_CONFIG_FILE):
# clouds:
#   my-cloud:
#     auth:
#       auth_url: 'http://<your-keystone-url>/v3'
#       username: 'admin'
#       password: 'your_password'
#       project_name: 'admin'
#       user_domain_name: 'Default'
#       project_domain_name: 'Default'
#     region_name: 'RegionOne'

# Example: List OpenStack projects using the CLI
try:
    print("\n--- Listing OpenStack Projects ---")
    # Use 'openstack --os-cloud my-cloud project list' if using clouds.yaml
    result = subprocess.run(['openstack', 'project', 'list'], capture_output=True, text=True, check=True)
    print(result.stdout)
    if result.stderr:
        print("Stderr:\n", result.stderr)

    print("\n--- Listing OpenStack Services ---")
    result = subprocess.run(['openstack', 'service', 'list'], capture_output=True, text=True, check=True)
    print(result.stdout)
    if result.stderr:
        print("Stderr:\n", result.stderr)

except subprocess.CalledProcessError as e:
    print(f"Error executing OpenStack CLI command: {e.cmd}")
    print(f"Return Code: {e.returncode}")
    print(f"Stdout:\n{e.stdout}")
    print(f"Stderr:\n{e.stderr}")
except FileNotFoundError:
    print("Error: 'openstack' command not found. Is OpenStackClient installed and in your PATH?")