---
id: python-octaviaclient
version: "3.14.0"
license: unclear
license_treatment: permissive
maintenance: active
---

# python-octaviaclient — Octavia client for OpenStack Load Balancing

License: permissive · Maintenance: active · Downloads: 145.3K/mo

## What it is and what it does

python-octaviaclient is a plugin for the OpenStack Client that adds command-line commands for managing Octavia load balancers. It integrates with the broader OpenStack ecosystem, allowing operators and administrators to create, configure, and monitor load balancing resources from the CLI rather than through the OpenStack dashboard or direct API calls.

The package is designed specifically for CLI use; the documentation explicitly recommends using openstacksdk for programmatic Python access instead. It depends on keystoneauth1 for authentication, osc-lib for CLI framework integration, and several oslo libraries for serialization and utilities. It requires Python 3.10 or later and is actively maintained by the OpenStack community.

Use it for:

- Manage OpenStack load balancers from the command line as part of infrastructure automation scripts.
- Create and configure load balancing rules and pools for OpenStack-hosted applications.
- Monitor and troubleshoot load balancer status and health in an OpenStack environment.
- Integrate load balancer management into OpenStack deployment and orchestration workflows.
- Query and list load balancer resources across an OpenStack cloud infrastructure.

## Worth the install?

AI-flagged interpretation of the facts above — verify before relying.

python-octaviaclient is an OpenStack Client plugin that provides command-line access to Octavia, OpenStack's load balancing service.

Yes, if you manage OpenStack infrastructure and need CLI access to Octavia load balancing. The package has low install friction, active maintenance, permissive licensing, and no known vulnerabilities. It is a standard tool for OpenStack operators. Install only if you have python-openstackclient already set up and valid OpenStack credentials configured.

## Install

pip install python-octaviaclient
uv add python-octaviaclient
poetry add python-octaviaclient

## Installing python-octaviaclient

Before you install: Low install friction; depends on established OpenStack ecosystem packages (keystoneauth1, python-openstackclient, osc-lib, oslo.serialization, oslo.utils, cliff, pbr, requests). Actively maintained with a release 93 days ago.

License in practice: Licensed under Apache (permissive), so you can use, modify, and distribute the package freely in most contexts without restriction.

Quickstart:

pip install python-octaviaclient

After installation, the Octavia commands become available through the OpenStack Client:
openstack loadbalancer list

Requires python-openstackclient to be installed and configured with valid OpenStack credentials and endpoint access.

Verify before relying:

- Whether the package works with all OpenStack cloud providers or only specific distributions.
- Performance characteristics when managing large numbers of load balancers.
- Specific Octavia API version compatibility constraints beyond Python version support.

## Package facts

- License: not declared (permissive)
- Python support: supports_current
- Install friction: low
- Maintenance: active
- Downloads: 145.3K/month (top 15,000 on PyPI)
- Known vulnerabilities: none known

## Tags

openstack load balancing cli, octavia client command line, openstack client plugin, load balancer management tool, openstack lbaas client, octavia cli tool, openstack networking load balance, openstack, load-balancing, cli-tool

[View on SkillFed](https://skillfed.io/packages/python-octaviaclient) · [View on PyPI](https://pypi.org/project/python-octaviaclient/)