OpenStackClient Placement plugin

4.8.0 verified Fri May 01 auth: no python

OpenStackClient plugin for the Placement service, used to manage resource providers, inventories, allocations, and traits in OpenStack. Current version 4.8.0 requires Python >=3.9. Released on a rolling cycle aligned with OpenStack releases.

pip install osc-placement

Common errors

error openstack: 'placement' is not an openstack command. See 'openstack --help'. ↓

cause osc-placement is not installed or not registered properly.

fix

Run 'pip install osc-placement' and ensure it's in the same Python environment as python-openstackclient.

error placement command not found ↓

cause Missing or outdated openstackclient installation.

fix

Install or upgrade python-openstackclient: 'pip install --upgrade python-openstackclient'.

error Not found: Resource provider with name or uuid ... ↓

cause The resource provider does not exist or the user lacks permissions.

fix

Verify the resource provider exists with 'openstack resource provider list' and check your role assignments.

Warnings

gotcha osc-placement is a plugin and does not provide a Python API; it only extends the openstack CLI. Do not attempt to import its internals. ↓

fix Use openstack CLI commands or the openstacksdk Python library for programmatic access.

breaking The placement API microversion may need to be specified for certain commands; default behavior might change between OpenStack releases. ↓

fix Check the OpenStack Placement documentation for the required microversion for your installation and use the --os-placement-api-version flag if needed.

deprecated Some older placement CLI subcommands were removed in favor of unified resource provider commands. ↓

fix Migrate from commands like 'openstack allocation candidate list' to 'openstack resource provider inventory list' or similar.

Imports

osc_placement
wrong
```
from osc_placement import plugin
```
correct
```
import osc_placement
```
There is no direct API; the module is auto-discovered by openstackclient as a plugin.

Quickstart

After installing osc-placement and configuring OpenStack credentials (OS_AUTH_URL, OS_USERNAME, OS_PASSWORD, OS_PROJECT_NAME), run the openstack client with placement commands.

openstack resource provider list