### Start Server

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/command-objects/compute/v2/index.md

Start one or more servers. Use --all-projects to start servers in another project (admin only).

```shell
openstack server start [--all-projects] <server> [<server> ...]
```

--------------------------------

### List example command

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/contributor/command-beta.md

Example of a command execution.

```bash
openstack example list
```

--------------------------------

### OpenStack Client Cloud Configuration Example

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/man/openstack.md

Example of a clouds.yaml file for configuring multiple OpenStack clouds.

```yaml
clouds:
  devstack:
    auth:
      auth_url: http://192.168.122.10:5000/
      project_name: demo
      username: demo
      password: 0penstack
    region_name: RegionOne
  ds-admin:
    auth:
      auth_url: http://192.168.122.10:5000/
      project_name: admin
      username: admin
      password: 0penstack
    region_name: RegionOne
  infra:
    cloud: rackspace
    auth:
      project_id: 275610
      username: openstack
      password: xyzpdq!lazydog
    region_name: DFW,ORD,IAD
```

--------------------------------

### Install OpenStackClient

Source: https://github.com/openstack/python-openstackclient/blob/master/README.rst

Install the client package using pip.

```shell
python3 -m pip install python-openstackclient
```

--------------------------------

### Install project for development

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/contributor/developing.md

Install the project in editable mode to test new code changes.

```bash
$ python setup.py develop
```

```bash
$ pip install -e .
```

--------------------------------

### Install and run Tox

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/contributor/developing.md

Commands to install Tox and execute test environments.

```bash
$ pip install tox
```

```bash
$ tox
```

```bash
$ tox -e py38,pep8
```

--------------------------------

### Rackspace Cloud Configuration Example

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/man/openstack.md

Example of a public-clouds.yaml file specifying Rackspace cloud configuration.

```yaml
public-clouds:
  rackspace:
    auth:
      auth_url: 'https://identity.api.rackspacecloud.com/v2.0/'
```

--------------------------------

### Install Tox prerequisites

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/contributor/developing.md

Install necessary system dependencies for Tox based on the operating system.

```bash
$ apt-get install gcc gettext python3-dev libxml2-dev libxslt1-dev \
    zlib1g-dev
```

```bash
$ yum install gcc python3-devel libxml2-devel libxslt-devel
```

```bash
$ zypper install gcc python3-devel libxml2-devel libxslt-devel
```

--------------------------------

### Get Help for a Specific OpenStackClient Command

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/contributor/humaninterfaceguide.md

Use the `help` command followed by the specific command name to get detailed help for that command, such as for creating a server.

```bash
$ openstack help server create
```

--------------------------------

### Start Action Plan

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/plugin-commands/watcher.md

Initiates the execution of a specified action plan.

```APIDOC
## POST /v1/actionplans/{action-plan}/start

### Description
Start action plan command.

### Method
POST

### Endpoint
/v1/actionplans/{action-plan}/start

### Path Parameters
- **action-plan** (string) - Required - UUID of the action_plan.

### Response
#### Success Response (200)
- **uuid** (string) - The UUID of the action plan.
- **name** (string) - The name of the action plan.
- **state** (string) - The updated state of the action plan (e.g., RUNNING).
- **created_at** (string) - Timestamp of when the action plan was created.
- **updated_at** (string) - Timestamp of when the action plan was last updated.

#### Response Example
{
  "uuid": "f0e9d8c7-b6a5-4321-fedc-ba9876543210",
  "name": "resize-plan-123",
  "state": "RUNNING",
  "created_at": "2023-10-27T09:00:00Z",
  "updated_at": "2023-10-27T09:35:00Z"
}
```

--------------------------------

### GET /database/instance/show

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/plugin-commands/trove.md

Show details of a specific database instance.

```APIDOC
## GET /database/instance/show

### Description
Show instance details.

### Method
GET

### Endpoint
openstack database instance show <instance>

### Parameters
#### Path Parameters
- **instance** (string) - Required - Instance (name or ID).
```

--------------------------------

### GET /os-floating-ips

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/contributor/api/openstackclient.api.md

Get all floating IPs.

```APIDOC
## GET /os-floating-ips

### Description
Get all floating IPs.

### Method
GET

### Endpoint
/os-floating-ips

### Response
#### Success Response (200)
- **floating_ips** (list) - A list of floating IP objects
```

--------------------------------

### Example: Adding 'list user' Command

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/commands.md

Illustrates how to register the 'list user' command for the Identity API v3 within the setup.cfg file.

```ini
openstack.identity.v3 =
    # ...
    list_user = openstackclient.identity.v3.user:ListUser
    # ...
```

--------------------------------

### GET /os-floating-ip-pools

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/contributor/api/openstackclient.api.md

Get all floating IP pools.

```APIDOC
## GET /os-floating-ip-pools

### Description
Get all floating IP pools.

### Method
GET

### Endpoint
/os-floating-ip-pools

### Response
#### Success Response (200)
- **floating_ip_pools** (list) - A list of floating IP pool objects
```

--------------------------------

### GET /os-floating-ips/{floating_ip_id}

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/contributor/api/openstackclient.api.md

Get a floating IP.

```APIDOC
## GET /os-floating-ips/{floating_ip_id}

### Description
Get a floating IP.

### Method
GET

### Endpoint
/os-floating-ips/{floating_ip_id}

### Parameters
#### Path Parameters
- **floating_ip_id** (string) - Required - The floating IP address

### Response
#### Success Response (200)
- **floating_ip** (object) - A floating IP object
```

--------------------------------

### Create Server CLI

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/command-objects/compute/v2/index.md

Creates a new server instance. Requires specifying a flavor and either an image or a volume/snapshot for booting. Numerous options control networking, security, storage, and configuration.

```shell
openstack server create
    --flavor <flavor>
    [--image <image> | --image-property <key=value> | --volume <volume> | --snapshot <snapshot>]
    [--boot-from-volume <volume-size>]
    [--block-device-mapping <dev-name=mapping>]
    [--block-device <block-device>]
    [--swap <swap>]
    [--ephemeral <size=size[,format=format]
    >]
    [--network <network>]
    [--port <port>]
    [--no-network]
    [--auto-network]
    [--nic <net-id=net-uuid,port-id=port-uuid,v4-fixed-ip=ip-addr,v6-fixed-ip=ip-addr,tag=tag,auto,none>]
    [--password <password>]
    [--no-security-group | --security-group <security-group>]
    [--key-name <key-name>]
    [--property <key=value>]
    [--file <dest-filename=source-filename>]
    [--user-data <user-data>]
    [--description <description>]
    [--availability-zone <zone-name>]
    [--host <host>]
    [--hypervisor-hostname <hypervisor-hostname>]
    [--server-group <server-group>]
    [--hint <key=value>]
    [--use-config-drive | --no-config-drive | --config-drive <config-drive-volume>|True]
    [--min <count>]
    [--max <count>]
    [--tag <tag>]
    [--hostname <hostname>]
    [--wait]
    [--trusted-image-cert <trusted-cert-id>]
    <server-name>
```

--------------------------------

### Create a software deployment

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/plugin-commands/heat.md

Initiates a software deployment on a specified server with optional configuration and signal transport settings.

```shell
openstack software deployment create
    [--input-value <key=value>]
    [--action <action>]
    [--config <config>]
    [--signal-transport <signal-transport>]
    [--container <container>]
    [--timeout <timeout>]
    --server <server>
    <deployment-name>
```

--------------------------------

### Create a new project

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/command-objects/identity/v3/index.md

Use this command to create a new project. You can specify the domain, parent project, description, enable/disable status, properties, and immutability. The --or-show option returns the existing project if it already exists.

```shell
openstack project create
    [--domain <domain>]
    [--parent <project>]
    [--description <description>]
    [--enable | --disable]
    [--property <key=value>]
    [--or-show]
    [--immutable | --no-immutable]
    [--tag <tag>]
    <project-name>
```

--------------------------------

### GET metric measures show

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/plugin-commands/gnocchi.md

Get measurements of a specific metric.

```APIDOC
## GET metric measures show

### Description
Get measurements of a metric.

### Method
GET

### Endpoint
openstack metric measures show

### Parameters
#### Path Parameters
- **metric** (string) - Required - ID or name of the metric.

#### Query Parameters
- **--resource-id** (string) - Optional - ID of the resource.
- **--aggregation** (string) - Optional - Aggregation to retrieve.
- **--start** (string) - Optional - Beginning of the period.
- **--stop** (string) - Optional - End of the period.
```

--------------------------------

### List deployables

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/plugin-commands/cyborg.md

Lists all available deployables.

```shell
openstack accelerator deployable list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--long]
```

--------------------------------

### Get Command Description

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/man/openstack.md

Use this command to get a description of a specific command.

```bash
openstack help <command>
```

--------------------------------

### Command Entry Point Format

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/commands.md

Defines the standard format for command entry points in setup.cfg, specifying the action and object mapping to a Python class.

```text
action_object = fully.qualified.module.vXX.object:ActionObject
```

--------------------------------

### Command-line equivalent for Rackspace configuration

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/configuration/index.md

This example shows the command-line options that correspond to the 'infra' entry in the clouds.yaml for a Rackspace account. It's useful for understanding the direct mapping between configuration file keywords and CLI arguments.

```bash
--os-auth-url https://identity.api.rackspacecloud.com/v2.0/
--os-project-id 275610
--os-username openstack
--os-password xyzpdq!lazydog
--os-region-name DFW
--os-interface internal
```

--------------------------------

### Show default configuration

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/plugin-commands/trove.md

Displays the default configuration settings for an instance.

```shell
openstack database configuration default <instance>
```

--------------------------------

### Define create action syntax

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/contributor/humaninterfaceguide.md

Standard pattern for creating new object instances.

```default
<object> create <name>
```

--------------------------------

### GET /stack/list

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/plugin-commands/heat.md

List all stacks.

```APIDOC
## GET /stack/list

### Description
List stacks.

### Method
GET

### Endpoint
openstack stack list

### Parameters
#### Query Parameters
- **--deleted** (flag) - Optional - Include soft-deleted stacks
- **--nested** (flag) - Optional - Include nested stacks
- **--limit** (integer) - Optional - Limit the number of stacks returned
```

--------------------------------

### Create OpenStack Server

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/interactive.md

Creates a new server instance with specified image, flavor, and keypair. The output shows the details of the created server, including its ID and status.

```bash
(openstack) server create --image CirrOS --flavor m1.small --key-name beaker sample-server
```

--------------------------------

### GET /ca/list

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/plugin-commands/barbican.md

List CAs.

```APIDOC
## GET /ca/list

### Description
List CAs.

### Method
GET

### Endpoint
openstack ca list [options]

### Parameters
#### Query Parameters
- **--limit** (integer) - Optional - Specify the limit to the number of items to list per page.
- **--offset** (integer) - Optional - Specify the page offset.
- **--name** (string) - Optional - Specify the ca name.
```

--------------------------------

### Create OpenStack Project (Identity v2)

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/command-objects/identity/v2/index.md

Use this command to create a new project. You must provide a project name. Optional arguments include a description, enabling or disabling the project, and setting properties. The --or-show option returns the existing project if it already exists.

```shell
openstack project create
    [--description <description>]
    [--enable | --disable]
    [--property <key=value>]
    [--or-show]
    <project-name>
```

--------------------------------

### GET /event/trigger

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/plugin-commands/mistral.md

List all event triggers.

```APIDOC
## GET /event/trigger

### Description
List all event triggers.

### Method
GET

### Endpoint
openstack event trigger list [--sort-column SORT_COLUMN] [--sort-ascending | --sort-descending] [--marker [MARKER]] [--limit [LIMIT]] [--sort_keys [SORT_KEYS]] [--sort_dirs [SORT_DIRS]] [--filter FILTERS]

### Parameters
#### Query Parameters
- **--sort-column** (string) - Optional - Specify the column(s) to sort the data.
- **--sort-ascending** (flag) - Optional - Sort in ascending order.
- **--sort-descending** (flag) - Optional - Sort in descending order.
- **--marker** (string) - Optional - The last execution uuid of the previous page.
- **--limit** (integer) - Optional - Maximum number of entries to return.
- **--sort_keys** (string) - Optional - Comma-separated list of sort keys.
- **--sort_dirs** (string) - Optional - Comma-separated list of sort directions.
- **--filter** (string) - Optional - Filters.
```

--------------------------------

### Create Database Instance

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/plugin-commands/trove.md

Creates a new database instance with specified configurations.

```APIDOC
## POST /database/instance/create

### Description
Creates a new database instance.

### Method
POST

### Endpoint
/database/instance/create

### Parameters
#### Query Parameters
- **flavor** (string) - Optional - Flavor to create the instance (name or ID). Flavor is not required when creating replica instances.
- **size** (integer) - Optional - Size of the instance disk volume in GB. Required when volume support is enabled.
- **volume_type** (string) - Optional - Volume type. Optional when volume support is enabled.
- **databases** (array) - Optional - List of databases to create.
  - **name** (string) - Name of the database.
- **users** (array) - Optional - List of users to create.
  - **name** (string) - Username.
  - **password** (string) - User password.
- **backup** (string) - Optional - A backup name or ID.
- **availability_zone** (string) - Optional - The Zone hint to give to Nova.
- **datastore** (string) - Optional - A datastore name or ID.
- **datastore_version** (string) - Optional - A datastore version name or ID.
- **datastore_version_number** (string) - Optional - The version number for the database. The version number is needed for the datastore versions with the same name.
- **nic** (object) - Optional - Network configuration for the instance.
  - **net_id** (string) - Network ID.
  - **subnet_id** (string) - Subnet ID.
  - **ip_address** (string) - Optional IP address.
- **configuration** (string) - Optional - ID of the configuration group to attach to the instance.
- **replica_of** (string) - Optional - ID or name of an existing instance to replicate from.
- **replica_count** (integer) - Optional - Number of replicas to create (defaults to 1 if replica_of specified).
- **module** (string) - Optional - ID or name of the module to apply. Specify multiple times to apply multiple modules.
- **locality** (string) - Optional - Locality policy to use when creating replicas. Choose one of %(choices)s.
- **is_public** (boolean) - Optional - Whether or not to make the instance public.
- **allowed_cidrs** (array) - Optional - The IP CIDRs that are allowed to access the database instance. Repeat for multiple values.
- **name** (string) - Required - Name of the instance.

### Request Body Example
```json
{
  "name": "my-db-instance",
  "flavor": "small",
  "size": 20,
  "databases": [
    {"name": "app_db"}
  ],
  "users": [
    {"name": "app_user", "password": "secretpassword"}
  ],
  "datastore": "mysql",
  "datastore_version": "5.7"
}
```

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the instance.
- **name** (string) - The name of the instance.
- **status** (string) - The current status of the instance.
- **created** (string) - Timestamp of creation.

#### Response Example
```json
{
  "id": "instance-id-123",
  "name": "my-db-instance",
  "status": "BUILD",
  "created": "2023-10-27T10:00:00Z"
}
```
```

--------------------------------

### GET /action/definition

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/plugin-commands/mistral.md

List all action definitions.

```APIDOC
## GET /action/definition

### Description
List all actions.

### Parameters
#### Query Parameters
- **--sort-column** (string) - Optional - Specify the column(s) to sort the data.
- **--sort-ascending** (flag) - Optional - Sort the column(s) in ascending order.
- **--sort-descending** (flag) - Optional - Sort the column(s) in descending order.
- **--marker** (string) - Optional - The last execution uuid of the previous page.
- **--limit** (integer) - Optional - Maximum number of entries to return.
- **--sort_keys** (string) - Optional - Comma-separated list of sort keys.
- **--sort_dirs** (string) - Optional - Comma-separated list of sort directions.
- **--filter** (string) - Optional - Filters to apply.
- **--namespace** (string) - Optional - Namespace of the actions.
```

--------------------------------

### GET /baremetal/introspection/rule/show

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/plugin-commands/ironic-inspector.md

Show an introspection rule.

```APIDOC
## GET /baremetal/introspection/rule/show

### Description
Show an introspection rule.

### Method
GET

### Endpoint
openstack baremetal introspection rule show uuid

### Parameters
#### Path Parameters
- **uuid** (string) - Required - rule UUID
```

--------------------------------

### List Database Backup Strategies

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/plugin-commands/trove.md

Lists existing backup strategies with optional filtering by instance or project ID and sorting options.

```shell
openstack database backup strategy list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--instance-id INSTANCE_ID]
    [--project-id PROJECT_ID]
```

--------------------------------

### GET /baremetal/introspection/rule/list

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/plugin-commands/ironic-inspector.md

List all introspection rules.

```APIDOC
## GET /baremetal/introspection/rule/list

### Description
List all introspection rules.

### Method
GET

### Endpoint
openstack baremetal introspection rule list

### Parameters
#### Query Parameters
- **--sort-column** (string) - Optional - specify the column(s) to sort the data
- **--sort-ascending** (flag) - Optional - sort the column(s) in ascending order
- **--sort-descending** (flag) - Optional - sort the column(s) in descending order
```

--------------------------------

### GET /baremetal/introspection/list

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/plugin-commands/ironic-inspector.md

List introspection statuses.

```APIDOC
## GET /baremetal/introspection/list

### Description
List introspection statuses.

### Method
GET

### Endpoint
openstack baremetal introspection list

### Parameters
#### Query Parameters
- **--sort-column** (string) - Optional - specify the column(s) to sort the data
- **--sort-ascending** (flag) - Optional - sort the column(s) in ascending order
- **--sort-descending** (flag) - Optional - sort the column(s) in descending order
- **--marker** (string) - Optional - UUID of the last item on the previous page
- **--limit** (integer) - Optional - the amount of items to return
```

--------------------------------

### Show database instance details

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/plugin-commands/trove.md

Display comprehensive information about a specific database instance.

```shell
openstack database instance show <instance>
```

--------------------------------

### GET /recordset/list

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/plugin-commands/designate.md

List recordsets for a zone.

```APIDOC
## GET recordset list

### Description
List recordsets.

### Parameters
#### Path Parameters
- **zone_id** (string) - Required - Zone ID. To list all recordsets specify 'all'

#### Query Parameters
- **--name** (string) - Optional - RecordSet Name
- **--type** (string) - Optional - RecordSet Type
- **--status** (string) - Optional - RecordSet Status
- **--long** (boolean) - Optional - List additional fields in output
```

--------------------------------

### Create Baremetal Resources from File

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/plugin-commands/ironic.md

Creates baremetal resources by reading descriptions from one or more YAML or JSON files. Each file can contain descriptions for multiple resources.

```shell
openstack baremetal create <file> [<file> ...]
```

--------------------------------

### Get Order

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/plugin-commands/barbican.md

Retrieves an order by its URI.

```APIDOC
## secret order get

### Description
Retrieve an order by providing its URI.

### Method
GET

### Endpoint
/orders/{URI}

### Parameters
#### Path Parameters
- **URI** (string) - Required - The URI reference order.
```

--------------------------------

### Create software configuration

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/plugin-commands/heat.md

Creates a new software configuration object.

```shell
openstack software config create
    [--config-file <config-file>]
    [--definition-file <destination-file>]
    [--group <group>]
    <config-name>
```

--------------------------------

### openstackclient.common.configuration.ShowConfiguration.get_parser

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/contributor/api/openstackclient.md

Gets the argument parser for the ShowConfiguration command.

```APIDOC
## openstackclient.common.configuration.ShowConfiguration.get_parser

### Description
Retrieves the argument parser for the `ShowConfiguration` command, used for parsing command-line arguments related to configuration.

### Method
Not specified (likely a class method)

### Endpoint
Not specified

### Parameters
Not specified

### Request Example
Not specified

### Response
Not specified
```

--------------------------------

### Install Service Plugins

Source: https://github.com/openstack/python-openstackclient/blob/master/README.rst

Add support for additional OpenStack services like DNS.

```shell
python3 -m pip install python3-designateclient
```

--------------------------------

### openstackclient.common.availability_zone.ListAvailabilityZone.get_parser

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/contributor/api/openstackclient.md

Gets the argument parser for the ListAvailabilityZone command.

```APIDOC
## openstackclient.common.availability_zone.ListAvailabilityZone.get_parser

### Description
Retrieves the argument parser for the `ListAvailabilityZone` command, used for parsing command-line arguments.

### Method
Not specified (likely a class method)

### Endpoint
Not specified

### Parameters
Not specified

### Request Example
Not specified

### Response
Not specified
```

--------------------------------

### GET /appcontainer/logs

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/plugin-commands/zun.md

Retrieve logs for a specific container.

```APIDOC
## GET /appcontainer/logs

### Description
Get logs of a container.

### Method
GET

### Endpoint
openstack appcontainer logs <container>

### Parameters
#### Path Parameters
- **container** (string) - Required - ID or name of the container to get logs for.
#### Query Parameters
- **--stdout** (flag) - Optional - Only stdout logs of container.
- **--stderr** (flag) - Optional - Only stderr logs of container.
- **--since** (string) - Optional - Show logs since a given datetime or integer epoch.
- **--timestamps** (flag) - Optional - Show timestamps.
- **--tail** (integer) - Optional - Number of lines to show from the end of the logs.
```

--------------------------------

### Create Backup Strategy

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/plugin-commands/trove.md

Configures a backup strategy for a project or a specific instance.

```shell
openstack database backup strategy create
    [--project-id PROJECT_ID]
    [--instance-id INSTANCE_ID]
    [--swift-container SWIFT_CONTAINER]
```

--------------------------------

### GET /appcontainer/image/show

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/plugin-commands/zun.md

Describe a specific container image.

```APIDOC
## GET /appcontainer/image/show

### Description
Describe a specific image.

### Method
GET

### Endpoint
openstack appcontainer image show <uuid>

### Parameters
#### Path Parameters
- **uuid** (string) - Required - UUID of image to describe.
```

--------------------------------

### Access Help Commands

Source: https://github.com/openstack/python-openstackclient/blob/master/README.rst

Retrieve global options or specific command documentation.

```shell
openstack --help
openstack help
```

```shell
openstack server create --help
openstack help server create
```

--------------------------------

### GET /appcontainer/image/search

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/plugin-commands/zun.md

Search for a specific container image.

```APIDOC
## GET /appcontainer/image/search

### Description
Search for a specified image.

### Method
GET

### Endpoint
openstack appcontainer image search <image_name>

### Parameters
#### Path Parameters
- **image_name** (string) - Required - Name of the image.
#### Query Parameters
- **--sort-column** (string) - Optional - Specify the column(s) to sort the data.
- **--sort-ascending** (flag) - Optional - Sort the column(s) in ascending order.
- **--sort-descending** (flag) - Optional - Sort the column(s) in descending order.
- **--image-driver** (string) - Optional - Name of the image driver.
- **--exact-match** (flag) - Optional - Exact match image name.
```

--------------------------------

### Display All OpenStackClient Commands

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/contributor/humaninterfaceguide.md

Use the `--help` option to display a list of all available commands in the OpenStackClient.

```bash
$ openstack --help
```

--------------------------------

### GET /loadbalancer/quota/list

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/plugin-commands/octavia.md

Lists quota settings for projects.

```APIDOC
## GET loadbalancer quota list

### Description
List quotas.

### Endpoint
openstack loadbalancer quota list

### Parameters
#### Query Parameters
- **--sort-column** (string) - Optional - Specify the column(s) to sort the data.
- **--sort-ascending** (flag) - Optional - Sort the column(s) in ascending order.
- **--sort-descending** (flag) - Optional - Sort the column(s) in descending order.
- **--project** (string) - Optional - Name or UUID of the project.
```

--------------------------------

### Initiate Image Import Process

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/command-objects/image/v2/index.md

Starts the image import process using various methods like glance-direct, web-download, or glance-download. Supports specifying import methods, URIs, remote image details, backend stores, and failure handling options. Requires the image name or ID.

```shell
openstack image import
    [--method <method>]
    [--uri <uri>]
    [--remote-image <REMOTE_IMAGE>]
    [--remote-region <REMOTE_GLANCE_REGION>]
    [--remote-service-interface <REMOTE_SERVICE_INTERFACE>]
    [--store [<STORE> ...]
    |
    --all-stores
    ]
    [--allow-failure | --disallow-failure]
    [--wait]
    <image>
```

--------------------------------

### GET /resource class

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/plugin-commands/placement.md

Lists all resource classes.

```APIDOC
## GET /resource class

### Description
Return a list of all resource classes. Requires --os-placement-api-version 1.2.

### Method
GET

### Parameters
#### Query Parameters
- **--sort-column** (string) - Optional - Specify the column(s) to sort the data
- **--sort-ascending** (flag) - Optional - Sort in ascending order
- **--sort-descending** (flag) - Optional - Sort in descending order
```

--------------------------------

### GET /workbook/definition/show

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/plugin-commands/mistral.md

Show the definition of a specific workbook.

```APIDOC
## GET /workbook/definition/show

### Description
Show workbook definition.

### Method
GET

### Endpoint
openstack workbook definition show name

### Parameters
#### Path Parameters
- **name** (string) - Required - Workbook name
```

--------------------------------

### Create Database Backup

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/plugin-commands/trove.md

Creates a new backup for a specified database instance.

```shell
openstack database backup create
    [-i <instance>]
    [--description <description>]
    [--parent <parent>]
    [--incremental]
    [--swift-container SWIFT_CONTAINER]
    [--restore-from RESTORE_FROM]
    [--restore-datastore-version RESTORE_DATASTORE_VERSION]
    [--restore-size RESTORE_SIZE]
    [--storage-driver STORAGE_DRIVER]
    <name>
```

--------------------------------

### GET /resource/member

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/plugin-commands/mistral.md

List all members associated with a resource.

```APIDOC
## GET /resource/member

### Description
List all members for a specific resource.

### Method
GET

### Endpoint
openstack resource member list [options] resource_id resource_type

### Parameters
#### Path Parameters
- **resource_id** (string) - Required - Resource ID to be shared.
- **resource_type** (string) - Required - Resource type.

#### Query Parameters
- **--sort-column** (string) - Optional - Specify the column(s) to sort the data.
- **--sort-ascending** (flag) - Optional - Sort in ascending order.
- **--sort-descending** (flag) - Optional - Sort in descending order.
- **--marker** (string) - Optional - The last execution uuid of the previous page.
- **--limit** (integer) - Optional - Maximum number of entries to return.
- **--sort_keys** (string) - Optional - Comma-separated list of sort keys.
- **--sort_dirs** (string) - Optional - Comma-separated list of sort directions.
- **--filter** (string) - Optional - Filters.
```

--------------------------------

### List configuration parameters

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/plugin-commands/trove.md

Lists available parameters for a specific configuration group and datastore version.

```shell
openstack database configuration parameter list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--datastore <datastore>]
    <datastore_version>
```

--------------------------------

### List software configurations

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/plugin-commands/heat.md

Lists available software configurations with optional sorting and filtering by limit or marker.

```shell
openstack software config list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--limit <limit>]
    [--marker <id>]
```

--------------------------------

### GET /coe/cluster/template/list

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/plugin-commands/magnum.md

Lists all available cluster templates.

```APIDOC
## GET coe cluster template list

### Description
List Cluster Templates.

### Method
GET

### Endpoint
openstack coe cluster template list [options]

### Parameters
#### Query Parameters
- **--sort-column** (string) - Optional - Column to sort by.
- **--sort-ascending** (boolean) - Optional - Sort ascending.
- **--sort-descending** (boolean) - Optional - Sort descending.
- **--limit** (integer) - Optional - Limit the number of results.
- **--sort-key** (string) - Optional - Key to sort by.
- **--sort-dir** (string) - Optional - Sort direction.
- **--fields** (string) - Optional - Fields to display.
```

--------------------------------

### GET /coe/cluster/show

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/plugin-commands/magnum.md

Retrieves details for a specific cluster.

```APIDOC
## GET coe cluster show

### Description
Show details of a specific cluster.

### Method
GET

### Endpoint
openstack coe cluster show <cluster>

### Parameters
#### Path Parameters
- **cluster** (string) - Required - ID or name of the cluster to show.
```

--------------------------------

### Create a database

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/plugin-commands/trove.md

Creates a new database on a specified instance with optional character set and collation settings.

```shell
openstack database db create
    [--character_set <character_set>]
    [--collate <collate>]
    <instance>
    <name>
```

--------------------------------

### Selecting a cloud configuration on the command line

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/configuration/index.md

Demonstrates how to specify a cloud configuration to use when running an OpenStackClient command. This is useful when you have multiple cloud definitions in your configuration files.

```bash
openstack --os-cloud infra server list
```

--------------------------------

### GET /stack check

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/plugin-commands/heat.md

Check the status of a stack.

```APIDOC
## GET /stack check

### Description
Perform a check operation on a stack.

### Method
GET

### Endpoint
/stack check

### Parameters
#### Query Parameters
- **--sort-column** (string) - Optional - Column(s) to sort data.
- **--sort-ascending** (boolean) - Optional - Sort in ascending order.
- **--sort-descending** (boolean) - Optional - Sort in descending order.
- **--wait** (boolean) - Optional - Wait for check to complete.
- **stack** (string) - Required - Name or ID of the stack.
```

--------------------------------

### OpenStackClient Object-Action Syntax

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/commands.md

Illustrates the syntax for commands involving one or two objects and an action. Examples show single-word and multi-word object names.

```default
<object-1> <action> <object-2>
```

```bash
$ group add user <group> <user>
```

```bash
$ volume type list   # 'volume type' is a two-word single object
```

--------------------------------

### GET /metric/show

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/plugin-commands/gnocchi.md

Show details of a specific metric.

```APIDOC
## GET metric show

### Description
Show a metric.

### Method
GET

### Endpoint
openstack metric show [--resource-id RESOURCE_ID] metric

### Parameters
#### Path Parameters
- **metric** (string) - Required - ID or name of the metric

#### Query Parameters
- **--resource-id** (string) - Optional - ID of the resource
```

--------------------------------

### GET /metric/resource/show

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/plugin-commands/gnocchi.md

Show details of a specific resource.

```APIDOC
## GET metric resource show

### Description
Show a resource.

### Method
GET

### Endpoint
openstack metric resource show [--type RESOURCE_TYPE] resource_id

### Parameters
#### Path Parameters
- **resource_id** (string) - Required - ID of a resource

#### Query Parameters
- **--type** (string) - Optional - Type of resource
```

--------------------------------

### Create Baremetal Deploy Template

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/plugin-commands/ironic.md

Creates a new deploy template. The deploy steps can be provided via a YAML file, standard input, or a JSON string. Arbitrary metadata can be included using --extra.

```shell
openstack baremetal deploy template create
    [--uuid <uuid>]
    [--extra <key=value>]
    --steps <steps>
    <name>
```

--------------------------------

### Show software configuration details

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/plugin-commands/heat.md

Displays details for a specific software configuration.

```shell
openstack software config show [--config-only] <config>
```

--------------------------------

### GET /ca

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/plugin-commands/barbican.md

Retrieve a CA by providing its URI.

```APIDOC
## GET /ca

### Description
Retrieve a CA by providing its URI.

### Method
GET

### Endpoint
openstack ca get URI

### Parameters
#### Path Parameters
- **URI** (string) - Required - The URI reference for the CA.
```

--------------------------------

### GET /datastore/version/list

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/plugin-commands/trove.md

Lists all available versions for a specific datastore.

```APIDOC
## GET /datastore/version/list

### Description
Lists available versions for a datastore.

### Method
GET

### Endpoint
openstack datastore version list <datastore>

### Parameters
#### Path Parameters
- **datastore** (string) - Required - ID or name of the datastore

#### Query Parameters
- **--sort-column** (string) - Optional - Specify the column(s) to sort the data.
- **--sort-ascending** (flag) - Optional - Sort the column(s) in ascending order.
- **--sort-descending** (flag) - Optional - Sort the column(s) in descending order.
```

--------------------------------

### Promote a database instance

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/plugin-commands/trove.md

Promote a replica instance to become the new source of its replication set.

```shell
openstack database instance promote <instance>
```

--------------------------------

### Create Baremetal Runbook

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/plugin-commands/ironic.md

Creates a new baremetal runbook with specified details. You must provide a name and the runbook steps, which can be supplied via a YAML file, standard input, or a JSON string. Optional parameters include description, traits, UUID, public/private status, owner, and extra metadata.

```shell
openstack baremetal runbook create
    --name <name>
    [--description <description>]
    [--traits <trait>]
    [--uuid <uuid>]
    [--public [<public>]]
    [--owner <owner>]
    [--extra <key=value>]
    --steps <steps>
```

--------------------------------

### Get Queue Metadata

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/plugin-commands/zaqar.md

Retrieves metadata for a specified queue.

```APIDOC
## GET /v2/queues/{queue_name}/metadata

### Description
Gets queue metadata.

### Method
GET

### Endpoint
/v2/queues/{queue_name}/metadata

### Parameters
#### Path Parameters
- **queue_name** (string) - Required - Name of the queue.

### Response
#### Success Response (200 OK)
- **metadata** (object) - An object containing queue metadata.

#### Response Example
```json
{
  "metadata": {
    "messages": 10,
    "subscribers": 5,
    "created": "timestamp",
    "updated": "timestamp"
  }
}
```
```

--------------------------------

### List software deployments

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/plugin-commands/heat.md

Lists software deployments with options for sorting, filtering by server, and displaying additional fields.

```shell
openstack software deployment list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--server <server>]
    [--long]
```

--------------------------------

### GET /loadbalancer/show

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/plugin-commands/octavia.md

Retrieves details for a single load balancer.

```APIDOC
## GET loadbalancer show

### Description
Show the details for a single load balancer.

### Endpoint
openstack loadbalancer show <load_balancer>

### Parameters
#### Path Parameters
- **load_balancer** (string) - Required - Name or UUID of the load balancer.
```

--------------------------------

### GET /loadbalancer/quota/show

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/plugin-commands/octavia.md

Shows quota details for a specific project.

```APIDOC
## GET loadbalancer quota show

### Description
Show the quota details for a project.

### Endpoint
openstack loadbalancer quota show <project>

### Parameters
#### Path Parameters
- **project** (string) - Required - Name or UUID of the project.
```

--------------------------------

### Define show action syntax

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/contributor/humaninterfaceguide.md

Standard pattern for fetching details of a single object instance.

```default
<object> show <name-or-id>
```

--------------------------------

### GET /appcontainer/action/list

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/plugin-commands/zun.md

List actions performed on a specific container.

```APIDOC
## GET /appcontainer/action/list

### Description
List actions on a container.

### Method
GET

### Endpoint
openstack appcontainer action list <container>

### Parameters
#### Path Parameters
- **container** (string) - Required - ID or name of the container to list actions.

#### Query Parameters
- **--sort-column** (string) - Optional - Specify the column(s) to sort the data.
- **--sort-ascending** (flag) - Optional - Sort in ascending order.
- **--sort-descending** (flag) - Optional - Sort in descending order.
```

--------------------------------

### Show configuration parameter details

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/plugin-commands/trove.md

Displays details for a specific database configuration parameter.

```shell
openstack database configuration parameter show
    [--datastore <datastore>]
    <datastore_version>
    <parameter>
```

--------------------------------

### Manage release notes

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/contributor/developing.md

Commands to create and build release notes using reno.

```bash
$ tox -e venv -- reno new <bug-,bp-,whatever>
```

```bash
$ git commit  # Commit the change because reno scans git log.

$ tox -e releasenotes
```

--------------------------------

### GET /optimize/strategy/state

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/plugin-commands/watcher.md

Retrieves information about strategy requirements and state.

```APIDOC
## GET optimize strategy state

### Description
Retrieve information about strategy requirements.

### Method
GET

### Endpoint
openstack optimize strategy state [--sort-column SORT_COLUMN] [--sort-ascending | --sort-descending] <strategy>

### Parameters
#### Path Parameters
- **strategy** (string) - Required - Name of the strategy

#### Query Parameters
- **--sort-column** (string) - Optional - Specify the column(s) to sort the data
- **--sort-ascending** (flag) - Optional - Sort the column(s) in ascending order
- **--sort-descending** (flag) - Optional - Sort the column(s) in descending order
```

--------------------------------

### GET /loadbalancer/provider/list

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/plugin-commands/octavia.md

Lists all available load balancer providers.

```APIDOC
## GET loadbalancer provider list

### Description
List all providers.

### Endpoint
openstack loadbalancer provider list

### Parameters
#### Query Parameters
- **--sort-column** (string) - Optional - Specify the column(s) to sort the data.
- **--sort-ascending** (flag) - Optional - Sort the column(s) in ascending order.
- **--sort-descending** (flag) - Optional - Sort the column(s) in descending order.
```

--------------------------------

### Example clouds.yaml for DevStack and Rackspace

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/configuration/index.md

This snippet shows how to define multiple cloud configurations in clouds.yaml, including settings for a DevStack environment and a Rackspace account. It demonstrates authentication details, region names, and interface selection.

```yaml
clouds:
  devstack:
    auth:
      auth_url: http://192.168.122.10:5000/
      project_name: demo
      username: demo
      password: 0penstack
    region_name: RegionOne
  ds-admin:
    auth:
      auth_url: http://192.168.122.10:5000/
      project_name: admin
      username: admin
      password: 0penstack
    region_name: RegionOne
  infra:
    cloud: rackspace
    auth:
      project_id: 275610
      username: openstack
      password: xyzpdq!lazydog
    region_name: DFW,ORD,IAD
    interface: internal
```

--------------------------------

### List Instance Backups

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/plugin-commands/trove.md

Lists all available backups associated with a specific database instance.

```shell
openstack database backup list instance
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--limit <limit>]
    [--marker <ID>]
    <instance>
```

--------------------------------

### GET /messaging/health

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/plugin-commands/zaqar.md

Retrieve the health status of the Zaqar server.

```APIDOC
## GET messaging health

### Description
Display detailed health status of Zaqar server.

### Method
GET

### Endpoint
messaging health
```

--------------------------------

### Minimal Identity API v3 Environment Setup

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/authentication.md

A minimal set of environment variables required for authenticating with Identity API v3 when using a default domain.

```bash
$ export OS_IDENTITY_API_VERSION=3
$ export OS_AUTH_URL=http://localhost:5000/v3
$ export OS_DEFAULT_DOMAIN=default
$ export OS_USERNAME=admin
$ export OS_PASSWORD=secret
$ export OS_PROJECT_NAME=admin
```

--------------------------------

### GET /messaging/flavor

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/plugin-commands/zaqar.md

List or show details of pool flavors.

```APIDOC
## GET messaging flavor list

### Description
List available pool flavors.

### Method
GET

### Endpoint
messaging flavor list

## GET messaging flavor show

### Description
Display pool flavor details.

### Method
GET

### Endpoint
messaging flavor show <flavor_name>
```

--------------------------------

### GET /messaging/claim

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/plugin-commands/zaqar.md

Query details of an existing message claim.

```APIDOC
## GET messaging claim query

### Description
Display claim details.

### Method
GET

### Endpoint
messaging claim query <queue_name> <claim_id>

### Parameters
#### Path Parameters
- **queue_name** (string) - Required - Name of the claimed queue.
- **claim_id** (string) - Required - ID of the claim.
```

--------------------------------

### List database configurations

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/plugin-commands/trove.md

Lists database configurations with optional sorting, limiting, and marker parameters.

```shell
openstack database configuration list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--limit <limit>]
    [--marker <ID>]
```

--------------------------------

### GET /optimize/datamodel

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/plugin-commands/watcher.md

Lists information on retrieved data models.

```APIDOC
## GET /optimize/datamodel

### Description
List information on retrieved data model.

### Method
GET

### Endpoint
openstack optimize datamodel list

### Parameters
#### Query Parameters
- **--sort-column** (string) - Optional - Specify the column(s) to sort the data
- **--sort-ascending** (flag) - Optional - Sort the column(s) in ascending order
- **--sort-descending** (flag) - Optional - Sort the column(s) in descending order
- **--type** (string) - Optional - Filter by type
- **--audit** (string) - Optional - Filter by audit
- **--detail** (flag) - Optional - Show detailed information
```

--------------------------------

### Show software deployment details

Source: https://github.com/openstack/python-openstackclient/blob/master/doc/source/cli/plugin-commands/heat.md

Displays detailed information about a specific software deployment.

```shell
openstack software deployment show [--long] <deployment>
```