PYTHON-IRONICCLIENT(1)

📦

version 6.3.0 · 4 versions

💖 NAME 💖

okay bestie, welcome to PYTHON-IRONICCLIENT(1) — the manual page for python-ironicclient, version python-ironicclient 6.3.0. This is the client for the OpenStack Ironic API (https://wiki.openstack.org/wiki/Ironic). It gives you:

a Python API: the ironicclient module, and
command-line interface: openstack baremetal

🌈 CONTENTS 🌈

🐍 ironicclient Python API 🐍

The ironicclient python API lets you access ironic, the OpenStack Bare Metal Provisioning Service.

For example, to manipulate nodes, you interact with an ironicclient.v1.node.Node <#ironicclient.v1.node.Node> object. You obtain access to nodes via attributes of the ironicclient.v1.client.Client <#ironicclient.v1.client.Client> object.

🧚 Usage 🧚

💅 Get a Client object 💅

First, create an ironicclient.v1.client.Client <#ironicclient.v1.client.Client> instance by passing your credentials to ironicclient.client.get_client() <#ironicclient.client.get_client>. By default, the Bare Metal Provisioning system is configured so that only administrators (users with 'admin' role) have access.

💀 Note: Explicit instantiation of ironicclient.v1.client.Client <#ironicclient.v1.client.Client> may cause errors since it doesn't verify provided arguments, using ironicclient.client.get_client() <#ironicclient.client.get_client> is preferred way to get client object.

There are two different sets of credentials that can be used:

ironic endpoint and auth token
Identity Service (keystone) credentials

🔑 Using ironic endpoint and auth token 🔑

An auth token and the ironic endpoint can be used to authenticate:

os_auth_token: authentication token (from Identity Service)
ironic_url: ironic API endpoint, eg http://ironic.example.org:6385/v1

To create the client, you can use the API like so:

>>> from ironicclient import client
>>>
>>> kwargs = {'os_auth_token': '3bcc3d3a03f44e3d8377f9247b0ad155',
>>>           'ironic_url': 'http://ironic.example.org:6385/'}
>>> ironic = client.get_client(1, **kwargs)

🪪 Using Identity Service (keystone) credentials 🪪

These Identity Service credentials can be used to authenticate:

os_username: name of user
os_password: user's password
os_auth_url: Identity Service endpoint for authorization
insecure: Boolean. If True, does not perform X.509 certificate validation when establishing SSL connection with identity service. default: False (optional)
os_tenant_{name|id}: name or ID of tenant

Also the following parameters are required when using the Identity API v3:

os_user_domain_name: name of a domain the user belongs to, usually 'default'
os_project_domain_name: name of a domain the project belongs to, usually 'default'

To create a client, you can use the API like so:

>>> from ironicclient import client
>>>
>>> kwargs = {'os_username': 'name',
>>>           'os_password': 'password',
>>>           'os_auth_url': 'http://keystone.example.org:5000/',
>>>           'os_project_name': 'project'}
>>> ironic = client.get_client(1, **kwargs)

⚡ Perform ironic operations ⚡

Once you have an ironicclient.v1.client.Client <#ironicclient.v1.client.Client>, you can perform various tasks:

>>> ironic.driver.list()  # list of drivers
>>> ironic.node.list()  # list of nodes
>>> ironic.node.get(node_uuid)  # information about a particular node

When the Client needs to propagate an exception, it will usually raise an instance subclassed from ironicclient.common.apiclient.exceptions.ClientException <#ironicclient.common.apiclient.exceptions.ClientException>.

Refer to the modules themselves, for more details.

📦 ironicclient Modules 📦

Module Index <>

📚 python-ironicclient User Documentation 📚

🛠️ baremetal Standalone Command-Line Interface (CLI) 🛠️

📜 Synopsis 📜

baremetal [options] <command> [command-options]

baremetal help <command>

📝 Description 📝

The standalone baremetal tool allows interacting with the Bare Metal service without installing the OpenStack Client tool as in openstack baremetal Command-Line Interface (CLI) <>.

The standalone tool is mostly identical to its OSC counterpart, with two exceptions:

No need to prefix commands with openstack.
No authentication is assumed by default.

Check the OSC CLI reference <> for a list of available commands.

🔍 Inspector support 🔍

The standalone baremetal tool optionally supports the low-level bare metal introspection API provided by ironic-inspector (https://docs.openstack.org/ironic-inspector/). If ironic-inspector-client (https://docs.openstack.org/python-ironic-inspector-client/) is installed, its commands (https://docs.openstack.org/python-ironic-inspector-client/latest/cli/index.html) are automatically available (also without the openstack prefix).

🚀 Standalone usage 🚀

To use the CLI with a standalone bare metal service, you need to provide an endpoint to connect to. It can be done in three ways:

Provide an explicit --os-endpoint argument, e.g.:

$ baremetal --os-endpoint https://ironic.host:6385 node list

Set the corresponding environment variable, e.g.:

$ export OS_ENDPOINT=https://ironic.host:6385
$ baremetal node list

Populate a clouds.yaml (https://docs.openstack.org/openstacksdk/latest/user/guides/connect_from_config.html) file, setting baremetal_endpoint_override, e.g.:

$ cat ~/.config/openstack/clouds.yaml
clouds:
  ironic:
    auth_type: none
    baremetal_endpoint_override: http://127.0.0.1:6385
$ export OS_CLOUD=ironic
$ baremetal node list

☁️ Usage with OpenStack ☁️

The standalone CLI can also be used with the Bare Metal service installed as part of OpenStack. See Authentication <#osc-auth> for information on the required input.

🌟 openstack baremetal Command-Line Interface (CLI) 🌟

📜 Synopsis 📜

openstack [options] baremetal <command> [command-options]

openstack help baremetal <command>

📝 Description 📝

The OpenStack Client plugin interacts with the Bare Metal service through the openstack baremetal command line interface (CLI).

To use the openstack CLI, the OpenStackClient (python-openstackclient) package must be installed. There are two ways to do this:

along with this python-ironicclient package:

$ pip install python-ironicclient[cli]

directly:

$ pip install python-openstackclient

This CLI is provided by python-openstackclient and osc-lib projects:

🔐 Authentication 🔐

To use the CLI, you must provide your OpenStack username, password, project, and auth endpoint. You can use configuration options --os-username, --os-password, --os-project-id (or --os-project-name), and --os-auth-url, or set the corresponding environment variables:

$ export OS_USERNAME=user
$ export OS_PASSWORD=password
$ export OS_PROJECT_NAME=project                         # or OS_PROJECT_ID
$ export OS_PROJECT_DOMAIN_ID=default
$ export OS_USER_DOMAIN_ID=default
$ export OS_IDENTITY_API_VERSION=3
$ export OS_AUTH_URL=http://auth.example.com:5000/identity

🆘 Getting help 🆘

To get a list of available (sub)commands and options, run:

$ openstack help baremetal

To get usage and options of a command, run:

$ openstack help baremetal <sub-command>

✨ Examples ✨

Get information about the openstack baremetal node create command:

$ openstack help baremetal node create

Get a list of available drivers:

$ openstack baremetal driver list

Enroll a node with the ipmi driver:

$ openstack baremetal node create --driver ipmi --driver-info ipmi_address=1.2.3.4

Get a list of nodes:

$ openstack baremetal node list

The baremetal API version can be specified via:

environment variable OS_BAREMETAL_API_VERSION:

$ export OS_BAREMETAL_API_VERSION=1.25

or optional command line argument --os-baremetal-api-version:

$ openstack baremetal port group list --os-baremetal-api-version 1.25

📚 Command Reference 📚

List of released CLI commands available in openstack client. These commands can be referenced by doing openstack help baremetal.

🧾 baremetal allocation 🧾

🧾 baremetal allocation create 🧾

Create a new baremetal allocation.

openstack baremetal allocation create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--resource-class RESOURCE_CLASS]
    [--trait TRAITS]
    [--candidate-node CANDIDATE_NODES]
    [--name NAME]
    [--uuid UUID]
    [--owner OWNER]
    [--extra <key=value>]
    [--wait [<time-out>]]
    [--node NODE]

-f <FORMATTER>, --format <FORMATTER> — the output format, defaults to table
-c COLUMN, --column COLUMN — specify the column(s) to include, can be repeated to show multiple columns
--noindent — whether to disable indenting the JSON
--prefix <PREFIX> — add a prefix to all variable names
--max-width <integer> — Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
--fit-width — Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
--print-empty — Print empty table if there is no data to show.
--resource-class <RESOURCE_CLASS> — Resource class to request.
--trait <TRAITS> — A trait to request. Can be specified multiple times.
--candidate-node <CANDIDATE_NODES> — A candidate node for this allocation. Can be specified multiple times. If at least one is specified, only the provided candidate nodes are considered for the allocation.
--name <NAME> — Unique name of the allocation.
--uuid <UUID> — UUID of the allocation.
--owner <OWNER> — Owner of the allocation.
--extra <key=value> — Record arbitrary key/value metadata. Can be specified multiple times.
--wait <time-out> — Wait for the new allocation to become active. An error is returned if allocation fails and --wait is used. Optionally takes a timeout value (in seconds). The default value is 0, meaning it will wait indefinitely.
--node <NODE> — Backfill this allocation from the provided node that has already been deployed. Bypasses the normal allocation process.

This command is provided by the python-ironicclient plugin. 💅 (that's the plugin doing the heavy lifting, bestie — slay)

baremetal allocation delete

Unregister your baremetal allocation(s). Like, yeet them from existence. Gone. 💀

openstack baremetal allocation delete <allocation> [<allocation> ...]

allocation — the Allocation(s) you wanna delete (name or UUID). You can pass a whole lil squad of them.

This command is provided by the python-ironicclient plugin. 🫶

baremetal allocation list

List out all the baremetal allocations. Window shopping, but for allocations 👑

openstack baremetal allocation list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--limit <limit>]
    [--marker <allocation>]
    [--sort <key>[:<direction>]]
    [--node <node>]
    [--resource-class <resource_class>]
    [--state <state>]
    [--owner <owner>]
    [--long | --fields <field> [<field> ...]]

-f <FORMATTER>, --format <FORMATTER> — the output format you want, defaults to table
-c COLUMN, --column COLUMN — pick the column(s) to include; repeat it to show multiple columns
--quote <QUOTE_MODE> — controls when quotes get included, defaults to nonnumeric
--noindent — disables indenting the JSON (flat JSON energy)
--max-width <integer> — maximum display width, <1 to disable. You can also set the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence (it wins, periodt)
--fit-width — fits the table to the display width. Implied if --max-width is greater than 0. Set the env var CLIFF_FIT_WIDTH=1 to always enable it
--print-empty — prints an empty table if there's honestly no data to show
--sort-column SORT_COLUMN — specify the column(s) to sort the data by (columns listed first get priority, non-existing columns are just ignored, no drama), column names are case-insensitive and accept underscores for spaces, and you can repeat it
--sort-ascending — sorts the column(s) in ascending order
--sort-descending — sorts the column(s) in descending order
--limit <limit> — maximum number of allocations to return per request, 0 for no limit. Default is the maximum number used by the Baremetal API Service
--marker <allocation> — an Allocation UUID (for example, of the last allocation in the list from a previous request). Returns the list of allocations after this UUID, like "continue from here" ✨
--sort <key>[:<direction>] — sort output by the specified allocation fields and directions (asc or desc) (default: asc). Multiple fields and directions can be specified, separated by comma
--node <node> — only list allocations of this node (name or UUID)
--resource-class <resource_class> — only list allocations with this resource class
--state <state> — only list allocations in this state
--owner <owner> — only list allocations with this owner
--long — show detailed information about the allocations (the full tea ☕)
--fields <field> — one or more allocation fields. Only these fields will be fetched from the server. Can not be used when --long is specified (pick one, bestie)

This command is provided by the python-ironicclient plugin. 💖

baremetal allocation set

Set baremetal allocation properties. Glow-up time ✨

openstack baremetal allocation set
    [--name <name>]
    [--extra <key=value>]
    <allocation>

--name <name> — sets the name of the allocation
--extra <key=value> — extra property to set on this allocation (repeat the option to set multiple extra properties)
allocation — name or UUID of the allocation

This command is provided by the python-ironicclient plugin. 🌸

baremetal allocation show

Show baremetal allocation details. The full dossier 🕵️‍♀️

openstack baremetal allocation show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--fields <field> [<field> ...]]
    <id>

-f <FORMATTER>, --format <FORMATTER> — the output format, defaults to table
-c COLUMN, --column COLUMN — specify the column(s) to include, can be repeated to show multiple columns
--noindent — whether to disable indenting the JSON
--prefix <PREFIX> — adds a prefix to all variable names
--max-width <integer> — maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence
--fit-width — fit the table to the display width. Implied if --max-width is greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
--print-empty — print an empty table if there is no data to show
--fields <field> — one or more allocation fields. Only these fields will be fetched from the server
id — UUID or name of the allocation

This command is provided by the python-ironicclient plugin. 🦋

baremetal allocation unset

Unset baremetal allocation properties. Undo button, but make it CLI 🫠

openstack baremetal allocation unset
    [--name]
    [--extra <key>]
    <allocation>

--name — unset the name of the allocation
--extra <key> — extra property to unset on this baremetal allocation (repeat the option to unset multiple extra property).
allocation — name or UUID of the allocation

This command is provided by the python-ironicclient plugin. 💜

baremetal chassis

baremetal chassis create

Create a brand new chassis. Fresh out of the box 🎁

openstack baremetal chassis create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--description <description>]
    [--extra <key=value>]
    [--uuid <uuid>]

-f <FORMATTER>, --format <FORMATTER> — the output format, defaults to table
-c COLUMN, --column COLUMN — specify the column(s) to include, can be repeated to show multiple columns
--noindent — whether to disable indenting the JSON
--prefix <PREFIX> — add a prefix to all variable names
--max-width <integer> — maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence
--fit-width — fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
--print-empty — print empty table if there is no data to show.
--description <description> — description for the chassis
--extra <key=value> — record arbitrary key/value metadata. Can be specified multiple times.
--uuid <uuid> — unique UUID of the chassis

This command is provided by the python-ironicclient plugin. ⭐

baremetal chassis delete

Delete a chassis. Byeee 👋

openstack baremetal chassis delete <chassis> [<chassis> ...]

chassis — UUIDs of chassis to delete

This command is provided by the python-ironicclient plugin. 🔥

baremetal chassis list

List the chassis. The whole lineup ✨

openstack baremetal chassis list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--fields <field> [<field> ...]]
    [--limit <limit>]
    [--long]
    [--marker <chassis>]
    [--sort <key>[:<direction>]]

-f <FORMATTER>, --format <FORMATTER> — the output format, defaults to table
-c COLUMN, --column COLUMN — specify the column(s) to include, can be repeated to show multiple columns
--quote <QUOTE_MODE> — when to include quotes, defaults to nonnumeric
--noindent — whether to disable indenting the JSON
--max-width <integer> — maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence
--fit-width — fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
--print-empty — print empty table if there is no data to show.
--sort-column SORT_COLUMN — specify the column(s) to sort the data by (columns specified first have priority, non-existing columns are ignored), column names are case-insensitive and accept underscores for spaces, can be repeated
--sort-ascending — sort the column(s) in ascending order
--sort-descending — sort the column(s) in descending order
--fields <field> — one or more chassis fields. Only these fields will be fetched from the server. Cannot be used when --long is specified.
--limit <limit> — maximum number of chassis to return per request, 0 for no limit. Default is the maximum number used by the Baremetal API Service.
--long — show detailed information about the chassis
--marker <chassis> — Chassis UUID (for example, of the last chassis in the list from a previous request). Returns the list of chassis after this UUID.
--sort <key>[:<direction>] — sort output by specified chassis fields and directions (asc or desc) (default: asc). Multiple fields and directions can be specified, separated by comma.

This command is provided by the python-ironicclient plugin. 🧚

baremetal chassis set

Set chassis properties. Tweaking era 💅

openstack baremetal chassis set
    [--description <description>]
    [--extra <key=value>]
    <chassis>

--description <description> — set the description of the chassis
--extra <key=value> — extra to set on this chassis (repeat the option to set multiple extras)
chassis — UUID of the chassis

This command is provided by the python-ironicclient plugin. 🌈

baremetal chassis show

Show chassis details.

okay so continuing the chassis saga 💅 next up we have showing off one specific chassis, and honestly it's giving "let me see the receipts."

openstack baremetal chassis show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--fields <field> [<field> ...]]
    <chassis>

-f <FORMATTER>, --format <FORMATTER> — the output format, defaults to table. pick your aesthetic ✨
-c COLUMN, --column COLUMN — specify the column(s) to include, can be repeated to show multiple columns. stack 'em up, bestie.
--noindent — whether to disable indenting the JSON. no squish, just flat.
--prefix <PREFIX> — add a prefix to all variable names.
--max-width <integer> — Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. parameter's the main character here 👑
--fit-width — Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable.
--print-empty — Print empty table if there is no data to show. (yes, an empty table is still a serve.)
--fields <field> — One or more chassis fields. Only these fields will be fetched from the server.
chassis — UUID of the chassis.

This command is provided by the python-ironicclient plugin.

🦋 baremetal chassis unset 🦋

Unset chassis properties. we're clearing the vibes, no cap.

openstack baremetal chassis unset
    [--description]
    [--extra <key>]
    <chassis>

--description — Clear the chassis description. bye bye, backstory 💀
--extra <key> — Extra to unset on this chassis (repeat option to unset multiple extras). lowkey handy.
chassis — UUID of the chassis.

This command is provided by the python-ironicclient plugin.

🌈 baremetal conductor 🌈

the conductor era. so iconic. let's get into it 🫶

🎀 baremetal conductor list 🎀

List baremetal conductors. it's literally giving roster.

openstack baremetal conductor list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--limit <limit>]
    [--marker <conductor>]
    [--sort <key>[:<direction>]]
    [--long | --fields <field> [<field> ...]]

-f <FORMATTER>, --format <FORMATTER> — the output format, defaults to table.
-c COLUMN, --column COLUMN — specify the column(s) to include, can be repeated to show multiple columns.
--quote <QUOTE_MODE> — when to include quotes, defaults to nonnumeric.
--noindent — whether to disable indenting the JSON.
--max-width <integer> — Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
--fit-width — Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable.
--print-empty — Print empty table if there is no data to show.
--sort-column SORT_COLUMN — specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), column names are case-insensitive and accept underscores for spaces, can be repeated. so thorough, we love her 💖
--sort-ascending — sort the column(s) in ascending order.
--sort-descending — sort the column(s) in descending order.
--limit <limit> — Maximum number of conductors to return per request, 0 for no limit. Default is the maximum number used by the Baremetal API Service.
--marker <conductor> — Hostname of the conductor (for example, of the last conductor in the list from a previous request). Returns the list of conductors after this conductor.
--sort <key>[:<direction>] — Sort output by specified conductor fields and directions (asc or desc) (default: asc). Multiple fields and directions can be specified, separated by comma.
--long — Show detailed information about the conductors.
--fields <field> — One or more conductor fields. Only these fields will be fetched from the server. Can not be used when --long is specified. (so it's --long OR --fields, pick your fighter ⚔️)

This command is provided by the python-ironicclient plugin.

🌸 baremetal conductor show 🌸

Show baremetal conductor details. the deep dive, bestie 🫧

openstack baremetal conductor show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--fields <field> [<field> ...]]
    <conductor>

-f <FORMATTER>, --format <FORMATTER> — the output format, defaults to table.
-c COLUMN, --column COLUMN — specify the column(s) to include, can be repeated to show multiple columns.
--noindent — whether to disable indenting the JSON.
--prefix <PREFIX> — add a prefix to all variable names.
--max-width <integer> — Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
--fit-width — Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable.
--print-empty — Print empty table if there is no data to show.
--fields <field> — One or more conductor fields. Only these fields will be fetched from the server.
conductor — Hostname of the conductor.

This command is provided by the python-ironicclient plugin.

⭐ baremetal create ⭐

(yes it's listed twice, and yes we're doing it twice, consistency queen 💅)

Create resources from files. like a glow-up for your baremetal, from a file.

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

file — File (.yaml or .json) containing descriptions of the resources to create. Can be specified multiple times. stack those files, babe ✨

This command is provided by the python-ironicclient plugin.

🧚 baremetal deploy template 🧚

deploy templates! reusable step recipes, lowkey iconic.

👑 baremetal deploy template create 👑

Create a new deploy template. fresh out the oven 🍓

openstack baremetal deploy template create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--uuid <uuid>]
    [--extra <key=value>]
    --steps <steps>
    <name>

-f <FORMATTER>, --format <FORMATTER> — the output format, defaults to table.
-c COLUMN, --column COLUMN — specify the column(s) to include, can be repeated to show multiple columns.
--noindent — whether to disable indenting the JSON.
--prefix <PREFIX> — add a prefix to all variable names.
--max-width <integer> — Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
--fit-width — Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable.
--print-empty — Print empty table if there is no data to show.
--uuid <uuid> — UUID of the deploy template.
--extra <key=value> — Record arbitrary key/value metadata. Can be specified multiple times. (extra, extra, read all about it 📣)
--steps <steps> — The deploy steps. May be the path to a YAML file containing the deploy steps; OR '-', with the deploy steps being read from standard input; OR a JSON string. The value should be a list of deploy-step dictionaries; each dictionary should have keys 'interface', 'step', 'args' and 'priority'. three input modes, main character energy fr fr.
name — Unique name for this deploy template. Must be a valid trait name.

This command is provided by the python-ironicclient plugin.

💀 baremetal deploy template delete 💀

Delete deploy template(s). we're unaliving them, respectfully 🙈

openstack baremetal deploy template delete <template> [<template> ...]

template — Name(s) or UUID(s) of the deploy template(s) to delete.

This command is provided by the python-ironicclient plugin.

🔥 baremetal deploy template list 🔥

List baremetal deploy templates. the whole collection, curated ✨

openstack baremetal deploy template list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--limit <limit>]
    [--marker <template>]
    [--sort <key>[:<direction>]]
    [--long | --fields <field> [<field> ...]]

-f <FORMATTER>, --format <FORMATTER> — the output format, defaults to table.
-c COLUMN, --column COLUMN — specify the column(s) to include, can be repeated to show multiple columns.
--quote <QUOTE_MODE> — when to include quotes, defaults to nonnumeric.
--noindent — whether to disable indenting the JSON.
--max-width <integer> — Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
--fit-width — Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable.
--print-empty — Print empty table if there is no data to show.
--sort-column SORT_COLUMN — specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), column names are case-insensitive and accept underscores for spaces, can be repeated.
--sort-ascending — sort the column(s) in ascending order.
--sort-descending — sort the column(s) in descending order.
--limit <limit> — Maximum number of deploy templates to return per request, 0 for no limit. Default is the maximum number used by the Baremetal API Service.
--marker <template> — DeployTemplate UUID (for example, of the last deploy template in the list from a previous request). Returns the list of deploy templates after this UUID.
--sort <key>[:<direction>] — Sort output by specified deploy template fields and directions (asc or desc) (default: asc). Multiple fields and directions can be specified, separated by comma.
--long — Show detailed information about deploy templates.
--fields <field> — one or more deploy template fields, bestie 💅 only these fields get fetched from the server. And no, you literally can't use this when --long is also on the command — they do not coexist, periodt.

This command is provided by the python-ironicclient plugin.

🎀 baremetal deploy template set 🎀

Set baremetal deploy template properties. Glow-up szn for your template ✨

openstack baremetal deploy template set
    [--name <name>]
    [--steps <steps>]
    [--extra <key=value>]
    <template>

--name <name> — sets the unique name of the deploy template. It has to be a valid trait name (<red>don't try to be cute with it, the server will not be charmed).
--steps <steps> — the deploy steps themselves. You can hand it over three ways, pick your fighter: the path to a YAML file that holds the deploy steps; OR -, which means the deploy steps get read from standard input; OR a JSON string, right there in the command. The value should be a list of deploy-step dictionaries, and each dictionary should have the keys 'interface', 'step', 'args' and 'priority'. iykyk 🫶
--extra <key=value> — extra to set on this baremetal deploy template. Repeat the option to set multiple extras — go off 💖

template — name or UUID of the deploy template.

This command is provided by the python-ironicclient plugin.

🌸 baremetal deploy template show 🌸

Show baremetal deploy template details. The vibe check for your template 👑

openstack baremetal deploy template show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--fields <field> [<field> ...]]
    <template>

-f <FORMATTER>, --format <FORMATTER> — the output format. Defaults to table. 🎀
-c COLUMN, --column COLUMN — specify the column(s) to include. Repeat it to show multiple columns, iconic behaviour fr.
--noindent — whether to disable indenting the JSON.
--prefix <PREFIX> — adds a prefix to all variable names.
--max-width <integer> — maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence — it's giving main character energy over the env var 💅
--fit-width — fit the table to the display width. Implied if --max-width is greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable it ⭐
--print-empty — print an empty table if there's no data to show. Empty but make it fashion.
--fields <field> — one or more deploy template fields. Only these fields get fetched from the server.

template — name or UUID of the deploy template.

This command is provided by the python-ironicclient plugin.

🦋 baremetal deploy template unset 🦋

Unset baremetal deploy template properties. Undo button, but make it CLI 😭

openstack baremetal deploy template unset [--extra <key>] <template>

--extra <key> — extra to unset on this baremetal deploy template. Repeat the option to unset multiple extras 💜

template — name or UUID of the deploy template.

This command is provided by the python-ironicclient plugin.

👑 baremetal driver 👑

The driver fam lives here — everything driver-related is right below, bestie 💖

✨ baremetal driver list ✨

List the enabled drivers. The roster, if you will 🫶

openstack baremetal driver list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--type <type>]
    [--long | --fields <field> [<field> ...]]

-f <FORMATTER>, --format <FORMATTER> — the output format, defaults to table.
-c COLUMN, --column COLUMN — specify the column(s) to include, can be repeated to show multiple columns.
--quote <QUOTE_MODE> — when to include quotes, defaults to nonnumeric.
--noindent — whether to disable indenting the JSON.
--max-width <integer> — maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
--fit-width — fit the table to the display width. Implied if --max-width is greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable.
--print-empty — print empty table if there is no data to show.
--sort-column SORT_COLUMN — specify the column(s) to sort the data. Columns specified first have priority, and non-existing columns are just ignored (we don't see them 👀). Column names are case-insensitive and accept underscores for spaces. Can be repeated.
--sort-ascending — sort the column(s) in ascending order ⬆️
--sort-descending — sort the column(s) in descending order ⬇️
--type <type> — type of driver ("classic" or "dynamic"). The default is to list all of them, no favourites 💅
--long — show detailed information about the drivers.
--fields <field> — one or more node fields. Only these fields get fetched from the server. Can not be used when --long is specified (they're mutually exclusive, sorry bestie).

This command is provided by the python-ironicclient plugin.

🔥 baremetal driver passthru call 🔥

Call a vendor passthru method for a driver. Poking the driver directly, we love to see it 💀

openstack baremetal driver passthru call
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--arg <key=value>]
    [--http-method <http-method>]
    <driver>
    <method>

-f <FORMATTER>, --format <FORMATTER> — the output format, defaults to table.
-c COLUMN, --column COLUMN — specify the column(s) to include, can be repeated to show multiple columns.
--noindent — whether to disable indenting the JSON.
--prefix <PREFIX> — add a prefix to all variable names.
--max-width <integer> — maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
--fit-width — fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable.
--print-empty — print empty table if there is no data to show.
--arg <key=value> — argument to pass to the passthru method. Repeat the option to specify multiple arguments 🎀
--http-method <http-method> — the HTTP method to use in the passthru request. One of DELETE, GET, PATCH, POST, PUT. Defaults to 'POST'.

driver — name of the driver.

method — vendor passthru method to be called.

This command is provided by the python-ironicclient plugin.

💜 baremetal driver passthru list 💜

List available vendor passthru methods for a driver. Showing you the whole menu 🍓

openstack baremetal driver passthru list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    <driver>

-f <FORMATTER>, --format <FORMATTER> — the output format, defaults to table.
-c COLUMN, --column COLUMN — specify the column(s) to include, can be repeated to show multiple columns.
--quote <QUOTE_MODE> — when to include quotes, defaults to nonnumeric.
--noindent — whether to disable indenting the JSON.
--max-width <integer> — maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
--fit-width — fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable.
--print-empty — print empty table if there is no data to show.
--sort-column SORT_COLUMN — specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored). Column names are case-insensitive and accept underscores for spaces. Can be repeated.
--sort-ascending — sort the column(s) in ascending order.
--sort-descending — sort the column(s) in descending order.

driver — name of the driver.

This command is provided by the python-ironicclient plugin.

🧚 baremetal driver property list 🧚

List the driver properties. All the little settings that make your driver, your driver 💅

openstack baremetal driver property list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    <driver>

-f <FORMATTER>, --format <FORMATTER> — the output format, defaults to table.
-c COLUMN, --column COLUMN — specify the column(s) to include, can be repeated to show multiple columns.
--quote <QUOTE_MODE> — when to include quotes, defaults to nonnumeric.
--noindent — whether to disable indenting the JSON.
--max-width <integer> — maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
--fit-width — fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable.
--print-empty — print empty table if there is no data to show.
--sort-column SORT_COLUMN — specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored). Column names are case-insensitive and accept underscores for spaces. Can be repeated.
--sort-ascending — sort the column(s) in ascending order.
--sort-descending — sort the column(s) in descending order.

driver — name of the driver.

This command is provided by the python-ironicclient plugin.

🌈 baremetal driver raid property list 🌈

List a driver's RAID logical disk properties. Yes, RAID — we're being fancy now 💖

openstack baremetal driver raid property list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    <driver>

-f <FORMATTER>, --format <FORMATTER> — the output format, defaults to table.
-c COLUMN, --column COLUMN — pick which column(s) you wanna include, and yeah you can repeat it to show multiple columns 💅
--quote <QUOTE_MODE> — controls when quotes get included, defaults to nonnumeric
--noindent — whether to disable indenting the JSON
--max-width <integer> — Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence ✨
--fit-width — Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
--print-empty — Print empty table if there is no data to show.
--sort-column SORT_COLUMN — specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), column names are case-insensitive and accept underscores for spaces, can be repeated
--sort-ascending — sort the column(s) in ascending order
--sort-descending — sort the column(s) in descending order

driver — Name of the driver.

This command is provided by the python-ironicclient plugin. 🫶

baremetal driver show

Show information about a driver. Like, the whole lil profile bestie 💖

openstack baremetal driver show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--fields <field> [<field> ...]]
    <driver>

-f <FORMATTER>, --format <FORMATTER> — the output format, defaults to table
-c COLUMN, --column COLUMN — specify the column(s) to include, can be repeated to show multiple columns
--noindent — whether to disable indenting the JSON
--prefix <PREFIX> — add a prefix to all variable names
--max-width <integer> — Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
--fit-width — Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
--print-empty — Print empty table if there is no data to show.
--fields <field> — One or more node fields. Only these fields will be fetched from the server.

driver — Name of the driver.

This command is provided by the python-ironicclient plugin. 🦋

baremetal node

baremetal node abort

Set provision state of baremetal node to 'abort'. It's giving emergency brake energy 😭

openstack baremetal node abort <node> [<node> ...]

node — Names or UUID's of the nodes.

This command is provided by the python-ironicclient plugin. 💀

baremetal node add trait

Add traits to a node. Glow-up time, no cap ✨

openstack baremetal node add trait <node> <trait> [<trait> ...]

node — Name or UUID of the node

trait — Trait(s) to add

This command is provided by the python-ironicclient plugin. 🎀

baremetal node adopt

Set provision state of baremetal node to 'adopt'. Basically claiming it as your own, main character move 👑

openstack baremetal node adopt
    [--wait [<time-out>]]
    <node>
    [<node> ...]

--wait <time-out> — Wait for a node to reach the desired state, active. Optionally takes a timeout value (in seconds). The default value is 0, meaning it will wait indefinitely.

node — Names or UUID's of the nodes.

This command is provided by the python-ironicclient plugin. 💜

baremetal node bios setting list

List a node's BIOS settings. The receipts, basically 📋

openstack baremetal node bios setting list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--long | --fields <field> [<field> ...]]
    <node>

-f <FORMATTER>, --format <FORMATTER> — the output format, defaults to table
-c COLUMN, --column COLUMN — specify the column(s) to include, can be repeated to show multiple columns
--quote <QUOTE_MODE> — when to include quotes, defaults to nonnumeric
--noindent — whether to disable indenting the JSON
--max-width <integer> — Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
--fit-width — Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
--print-empty — Print empty table if there is no data to show.
--sort-column SORT_COLUMN — specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), column names are case-insensitive and accept underscores for spaces, can be repeated
--sort-ascending — sort the column(s) in ascending order
--sort-descending — sort the column(s) in descending order
--long — Show detailed information about the BIOS settings. The full lore 🍓
--fields <field> — One or more node fields. Only these fields will be fetched from the server. Can not be used when '--long' is specified.

node — Name or UUID of the node

This command is provided by the python-ironicclient plugin. ⭐

baremetal node bios setting show

Show a specific BIOS setting for a node. Zooming in on one (1) detail 🔍

openstack baremetal node bios setting show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    <node>
    <setting name>

-f <FORMATTER>, --format <FORMATTER> — the output format, defaults to table
-c COLUMN, --column COLUMN — specify the column(s) to include, can be repeated to show multiple columns
--noindent — whether to disable indenting the JSON
--prefix <PREFIX> — add a prefix to all variable names
--max-width <integer> — Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
--fit-width — Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
--print-empty — Print empty table if there is no data to show.

node — Name or UUID of the node

setting name — Setting name to show

This command is provided by the python-ironicclient plugin. 🌸

baremetal node boot device set

Set the boot device for a node. Choosing where it wakes up, literally 🥾

openstack baremetal node boot device set
    [--persistent]
    <node>
    [<node> ...]
    <device>

--persistent — Make changes persistent for all future boots

node — Names or UUID's of the nodes

device — One of bios, cdrom, disk, pxe, safe, wanboot

This command is provided by the python-ironicclient plugin. 🔥

baremetal node boot device show

Show the boot device information for a node. Receipts on where it boots from 📸

openstack baremetal node boot device show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--supported]
    <node>

-f <FORMATTER>, --format <FORMATTER> — the output format, defaults to table
-c COLUMN, --column COLUMN — specify the column(s) to include, can be repeated to show multiple columns
--noindent — whether to disable indenting the JSON
--prefix <PREFIX> — add a prefix to all variable names
--max-width <integer> — Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
--fit-width — Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
--print-empty — Print empty table if there is no data to show.
--supported — Show the supported boot devices

node — Name or UUID of the node

This command is provided by the python-ironicclient plugin. 🌈

baremetal node boot mode set

Set the boot mode for the next baremetal node deployment 🚀

openstack baremetal node boot mode set <node> [<node> ...] <boot_mode>

node — Names or UUID's of the nodes.

boot_mode — The boot mode to set for node (uefi/bios)

This command is provided by the python-ironicclient plugin. 🧚

baremetal node children list

Get a list of nodes associated as children. Found family fr fr 🫶

openstack baremetal node children list
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    <node>

-f <FORMATTER>, --format <FORMATTER> — the output format, defaults to table
-c COLUMN, --column COLUMN — specify the column(s) to include, can be repeated to show multiple columns
--noindent — whether to disable indenting the JSON
--prefix <PREFIX> — add a prefix to all variable names
--max-width <integer> — Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
--fit-width — Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
--print-empty — Print empty table if there is no data to show.

node — Name or UUID of the node.

This command is provided by the python-ironicclient plugin. 💜

baremetal node clean

Set provision state of baremetal node to 'clean'. Self-care era 🧼✨

openstack baremetal node clean
    [--wait [<time-out>]]
    (--clean-steps <clean-steps> | --runbook <runbook>)
    [--disable-ramdisk]
    <node>
    [<node> ...]

--wait <time-out> — Wait for a node to reach the desired state, manageable. Optionally takes a timeout value (in seconds). The default value is 0, meaning it will wait indefinitely.
--clean-steps <clean-steps> — the actual clean steps, bestie. It can be a path to a YAML file holding them; OR - and they get read in from standard input; OR just a JSON string right there in the command. Whatever you give it should be a list of clean-step dictionaries — each one needs keys 'interface' and 'step', plus an optional 'args' key. 🧼
--runbook <runbook> — the identifier of a predefined runbook to use for cleaning. Like, the easy mode option instead of hand-writing steps, iykyk.
--disable-ramdisk — ironic-python-agent will not be booted for cleaning. Heads up: with this set, only steps explicitly marked as not requiring ironic-python-agent can be executed. No ramdisk, no ramdisk steps, periodt. 💀
node — names or UUID's of the nodes.

Lowkey every one of these commands is served to you by the python-ironicclient plugin. 🫶

🖥️ `baremetal node console disable`

Disable console access for a node. Sorry bestie, no console for you. 🙈

openstack baremetal node console disable <node> [<node> ...]

node — names or UUID's of the nodes

This command is provided by the python-ironicclient plugin.

✨ `baremetal node console enable`

Enable console access for a node. We're so back. 👑

openstack baremetal node console enable <node> [<node> ...]

node — names or UUID's of the nodes

This command is provided by the python-ironicclient plugin.

🎀 `baremetal node console show`

Show console information for a node. The main character of console commands, honestly.

openstack baremetal node console show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    <node>

-f <FORMATTER>, --format <FORMATTER> — the output format, defaults to table
-c COLUMN, --column COLUMN — specify the column(s) to include, can be repeated to show multiple columns
--noindent — whether to disable indenting the JSON
--prefix <PREFIX> — add a prefix to all variable names
--max-width <integer> — maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
--fit-width — fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
--print-empty — print empty table if there is no data to show.
node — name or UUID of the node

This command is provided by the python-ironicclient plugin.

🦋 `baremetal node create`

openstack baremetal node create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--chassis-uuid <chassis>]
    --driver <driver>
    [--driver-info <key=value>]
    [--property <key=value>]
    [--extra <key=value>]
    [--uuid <uuid>]
    [--name <name>]
    [--instance-name <instance_name>]
    [--bios-interface <bios_interface>]
    [--boot-interface <boot_interface>]
    [--console-interface <console_interface>]
    [--deploy-interface <deploy_interface>]
    [--inspect-interface <inspect_interface>]
    [--management-interface <management_interface>]
    [--network-data <network data>]
    [--network-interface <network_interface>]
    [--power-interface <power_interface>]
    [--raid-interface <raid_interface>]
    [--rescue-interface <rescue_interface>]
    [--storage-interface <storage_interface>]
    [--vendor-interface <vendor_interface>]
    [--resource-class <resource_class>]
    [--conductor-group <conductor_group>]
    [--automated-clean | --no-automated-clean]
    [--owner <owner>]
    [--lessee <lessee>]
    [--description <description>]
    [--shard <shard>]
    [--parent-node <parent_node>]
    [--firmware-interface <firmware_interface>]
    [--disable-power-off]

output-ish flags first 💅

-f <FORMATTER>, --format <FORMATTER> — the output format, defaults to table
-c COLUMN, --column COLUMN — specify the column(s) to include, can be repeated to show multiple columns
--noindent — whether to disable indenting the JSON
--prefix <PREFIX> — add a prefix to all variable names
--max-width <integer> — maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
--fit-width — fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
--print-empty — print empty table if there is no data to show.

now the actual node stuff 🌸

--chassis-uuid <chassis> — UUID of the chassis that this node belongs to.
--driver <driver> — driver used to control the node [REQUIRED]. Like, you literally cannot skip this one, bestie. Non-negotiable.
--driver-info <key=value> — key/value pair used by the driver, such as out-of-band management credentials. Can be specified multiple times.
--property <key=value> — key/value pair describing the physical characteristics of the node. This is exported to Nova and used by the scheduler. Can be specified multiple times.
--extra <key=value> — record arbitrary key/value metadata. Can be specified multiple times.
--uuid <uuid> — unique UUID for the node.
--name <name> — unique name for the node.
--instance-name <instance_name> — name of the instance deployed on this node.
--bios-interface <bios_interface> — BIOS interface used by the node's driver. This is only applicable when the specified --driver is a hardware type.
--boot-interface <boot_interface> — boot interface used by the node's driver. This is only applicable when the specified --driver is a hardware type.
--console-interface <console_interface> — console interface used by the node's driver. This is only applicable when the specified --driver is a hardware type.
--deploy-interface <deploy_interface> — deploy interface used by the node's driver. This is only applicable when the specified --driver is a hardware type.
--inspect-interface <inspect_interface> — inspect interface used by the node's driver. This is only applicable when the specified --driver is a hardware type.
--management-interface <management_interface> — management interface used by the node's driver. This is only applicable when the specified --driver is a hardware type.
--network-data <network data> — JSON string, or a YAML file, or - for stdin, to read static network configuration for the baremetal node associated with this ironic node. The format of this file should comply with Nova network data metadata (network_data.json). Depending on ironic boot interface capabilities being used, network configuration may or may not been served to the node for offline network configuration. 👀 (yes, that's the original wording energy — read it twice and you'll get the vibe)
--network-interface <network_interface> — network interface used for switching node to cleaning/provisioning networks.
--power-interface <power_interface> — power interface used by the node's driver. This is only applicable when the specified --driver is a hardware type.
--raid-interface <raid_interface> — RAID interface used by the node's driver. This is only applicable when the specified --driver is a hardware type.
--rescue-interface <rescue_interface> — rescue interface used by the node's driver. This is only applicable when the specified --driver is a hardware type.
--storage-interface <storage_interface> — storage interface used by the node's driver.
--vendor-interface <vendor_interface> — vendor interface used by the node's driver. This is only applicable when the specified --driver is a hardware type.
--resource-class <resource_class> — resource class for mapping nodes to Nova flavors
--conductor-group <conductor_group> — conductor group the node will belong to
--automated-clean — enable automated cleaning for the node
--no-automated-clean — explicitly disable automated cleaning for the node
--owner <owner> — owner of the node.
--lessee <lessee> — lessee of the node.
--description <description> — description for the node.
--shard <shard> — shard for the node.
--parent-node <parent_node> — parent node for the node being created.
--firmware-interface <firmware_interface> — firmware interface used by the node's driver. This is only applicable when the specified --driver is a hardware type.
--disable-power-off — explicitly disable power off actions on the node

This command is provided by the python-ironicclient plugin.

Fr fr though, notice how literally every *interface flag has the same "only applicable when the specified --driver is a hardware type" caveat? That's not a typo on my end, that's just how it is. Hardware type driver = interfaces apply. 💅

💀 `baremetal node delete`

Unregister baremetal node(s). It's giving "block and delete", but for servers.

openstack baremetal node delete <node> [<node> ...]

node — node(s) to delete (name or UUID)

This command is provided by the python-ironicclient plugin.

Careful bestie — there's no undo button on this one. Deletion is deletion. 😭

🔥 `baremetal node deploy`

Set provision state of baremetal node to 'deploy'. Time to make it real. 🚀

openstack baremetal node deploy
    [--wait [<time-out>]]
    [--config-drive <config-drive>]
    [--deploy-steps <deploy-steps>]
    <node>
    [<node> ...]

--wait <time-out> — wait for a node to reach the desired state, active. Optionally takes a timeout value (in seconds). The default value is 0, meaning it will wait indefinitely. So like, forever. Bestie will be here a while if you don't set a number. ⏳
--config-drive <config-drive> — a gzipped, base64-encoded configuration drive string OR the path to the configuration drive file OR the path to a directory containing the config drive files OR a JSON object to build config drive from OR the path to the JSON file. In case it's a directory, a config drive will be generated from it. In case it's a JSON object with optional keys meta_data, user_data and network_data or a JSON file, a config drive will be generated on the server side (see the bare metal API reference for more details). Okay so that's five different things it can be — pick your fighter. 🥊
--deploy-steps <deploy-steps> — the deploy steps. May be the path to a YAML file containing the deploy steps; OR -, with the deploy steps being read from standard input; OR a JSON string. The value should be a list of deploy-step dictionaries; each dictionary should have keys 'interface' and 'step', and optional key 'args'.
node — names or UUID's of the nodes.

This command is provided by the python-ironicclient plugin.

🌸 `baremetal node firmware list`

Bestie, this one lists, like, all the Firmware Components of a node. Every single one. No crumbs left. ✨

openstack baremetal node firmware list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    <node>

-f <FORMATTER>, --format <FORMATTER> — the output format, defaults to table 💅
-c COLUMN, --column COLUMN — specify the column(s) to include, and fr fr you can repeat it to show multiple columns 🎀
--quote <QUOTE_MODE> — when to include quotes, defaults to nonnumeric
--noindent — whether to disable indenting the JSON
--max-width <integer> — Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence 👑
--fit-width — Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
--print-empty — Print empty table if there is no data to show.
--sort-column SORT_COLUMN — specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), column names are case-insensitive and accept underscores for spaces, can be repeated
--sort-ascending — sort the column(s) in ascending order
--sort-descending — sort the column(s) in descending order

node — Name or UUID of the node 🦋

This command is provided by the python-ironicclient plugin.

🫶 `baremetal node history get`

Get history event for a baremetal node. One (1) event. Singular. We're being specific today. 💖

openstack baremetal node history get
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    <node>
    <event>

-f <FORMATTER>, --format <FORMATTER> — the output format, defaults to table
-c COLUMN, --column COLUMN — specify the column(s) to include, can be repeated to show multiple columns ✨
--noindent — whether to disable indenting the JSON
--prefix <PREFIX> — add a prefix to all variable names
--max-width <integer> — Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence
--fit-width — Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
--print-empty — Print empty table if there is no data to show.

node — Name or UUID of the node. 🌸

event — UUID of the event. 🌸

This command is provided by the python-ironicclient plugin.

🧚 `baremetal node history list`

Get history events for a baremetal node — plural this time, we're getting the whole lore. 😭

openstack baremetal node history list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--long]
    <node>

-f <FORMATTER>, --format <FORMATTER> — the output format, defaults to table
-c COLUMN, --column COLUMN — specify the column(s) to include, can be repeated to show multiple columns
--quote <QUOTE_MODE> — when to include quotes, defaults to nonnumeric
--noindent — whether to disable indenting the JSON
--max-width <integer> — Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence 💜
--fit-width — Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
--print-empty — Print empty table if there is no data to show.
--sort-column SORT_COLUMN — specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), column names are case-insensitive and accept underscores for spaces, can be repeated
--sort-ascending — sort the column(s) in ascending order
--sort-descending — sort the column(s) in descending order
--long — Show detailed information about the node history events. 🔥

node — Name or UUID of the node.

This command is provided by the python-ironicclient plugin.

💀 `baremetal node inject nmi`

Inject NMI to baremetal node. That's it. That's the whole vibe. No flags, no extra credit, just inject. 🫶

openstack baremetal node inject nmi <node> [<node> ...]

node — Names or UUID's of the nodes.

This command is provided by the python-ironicclient plugin.

🎀 `baremetal node inspect`

Set provision state of baremetal node to 'inspect'. Lowkey iconic behaviour tbh.

openstack baremetal node inspect
    [--wait [<time-out>]]
    <node>
    [<node> ...]

--wait <time-out> — Wait for a node to reach the desired state, manageable. Optionally takes a timeout value (in seconds). The default value is 0, meaning it will wait indefinitely. ⏳ (yes bestie, indefinitely — it will simply sit there. forever. patiently.)

node — Names or UUID's of the nodes.

This command is provided by the python-ironicclient plugin.

🌈 `baremetal node inventory save`

Get hardware inventory of a node (in JSON format) or save it to file. Your call, main character. ✨

openstack baremetal node inventory save [--file <filename>] <node>

--file <filename> — Save inspection data to file with name (default: stdout).

node — Name or UUID of the node

This command is provided by the python-ironicclient plugin.

👑 `baremetal node list`

List baremetal nodes. The big one. The whole friend group in one table. 💅

openstack baremetal node list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--limit <limit>]
    [--marker <node>]
    [--sort <key>[:<direction>]]
    [--maintenance | --no-maintenance]
    [--retired | --no-retired]
    [--fault <fault>]
    [--associated | --unassociated]
    [--provision-state <provision state>]
    [--driver <driver>]
    [--resource-class <resource class>]
    [--conductor-group <conductor_group>]
    [--conductor <conductor>]
    [--chassis <chassis UUID>]
    [--owner <owner>]
    [--lessee <lessee>]
    [--description-contains <description_contains>]
    [--instance-name <instance_name>]
    [--sharded | --unsharded]
    [--shards <shards> [<shards> ...]]
    [--long | --fields <field> [<field> ...]]
    [--include-children | --parent-node <parent_node>]

-f <FORMATTER>, --format <FORMATTER> — the output format, defaults to table
-c COLUMN, --column COLUMN — specify the column(s) to include, can be repeated to show multiple columns
--quote <QUOTE_MODE> — when to include quotes, defaults to nonnumeric
--noindent — whether to disable indenting the JSON
--max-width <integer> — Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence
--fit-width — Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
--print-empty — Print empty table if there is no data to show.
--sort-column SORT_COLUMN — specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), column names are case-insensitive and accept underscores for spaces, can be repeated
--sort-ascending — sort the column(s) in ascending order
--sort-descending — sort the column(s) in descending order
--limit <limit> — Maximum number of nodes to return per request, 0 for no limit. Default is the maximum number used by the Baremetal API Service.
--marker <node> — Node UUID (for example, of the last node in the list from a previous request). Returns the list of nodes after this UUID. 📍
--sort <key>[:<direction>] — Sort output by specified node fields and directions (asc or desc) (default: asc). Multiple fields and directions can be specified, separated by comma.
--maintenance — Limit list to nodes in maintenance mode 🔧
--no-maintenance — Limit list to nodes not in maintenance mode
--retired — Limit list to retired nodes.
--no-retired — Limit list to not retired nodes.
--fault <fault> — List nodes in specified fault.
--associated — List only nodes associated with an instance.
--unassociated — List only nodes not associated with an instance.
--provision-state <provision state> — List nodes in specified provision state.
--driver <driver> — Limit list to nodes with driver <driver>
--resource-class <resource class> — Limit list to nodes with resource class <resource class>
--conductor-group <conductor_group> — Limit list to nodes with conductor group <conductor group>
--conductor <conductor> — Limit list to nodes with conductor <conductor>
--chassis <chassis UUID> — Limit list to nodes of this chassis
--owner <owner> — Limit list to nodes with owner <owner>
--lessee <lessee> — Limit list to nodes with lessee <lessee>
--description-contains <description_contains> — Limit list to nodes with description contains <description_contains> 🍓
--instance-name <instance_name> — Filter the list of returned nodes by an instance name.
--sharded — List only nodes that are sharded.
--unsharded — List only nodes that are not sharded.
--shards <shards> — List only nodes that are in shards <shards>.
--long — Show detailed information about the nodes. 🔥
--fields <field> — One or more node fields. Only these fields will be fetched from the server. Can not be used when '--long' is specified. ⚠️ (like, genuinely can't — pick a lane bestie)
--include-children — Include children in the node list.
--parent-node <parent_node> — only list the nodes that are tied to a parent node 🫶

This command is provided by the python-ironicclient plugin.

baremetal node maintenance set

Okay so this one puts your baremetal node into maintenance mode — like, it's benched, do not touch 🔧

openstack baremetal node maintenance set
    [--reason <reason>]
    <node>
    [<node> ...]

--reason <reason> — the reason you're slapping it into maintenance mode, bestie. Say why!
node — names or UUID's of the nodes. Yes, plural, you can do a whole squad.

This command is provided by the python-ironicclient plugin.

baremetal node maintenance unset

And this is the glow-up: yanking that node back out of maintenance mode ✨

openstack baremetal node maintenance unset <node> [<node> ...]

node — names or UUID's of the nodes.

This command is provided by the python-ironicclient plugin.

baremetal node manage

Flips the provision state of your baremetal node to 'manage' — very demure, very "I'm in control now" 💅

openstack baremetal node manage
    [--wait [<time-out>]]
    <node>
    [<node> ...]

--wait <time-out> — literally waits for a node to reach the desired state, manageable. You can optionally hand it a timeout value (in seconds). Default is 0, which means it waits indefinitely — no cap, it's committed 😭
node — names or UUID's of the nodes.

This command is provided by the python-ironicclient plugin.

baremetal node passthru call

Calls a vendor passthru method for a node. Very "let me speak to the vendor directly" energy 📞

openstack baremetal node passthru call
    [--arg <key=value>]
    [--http-method <http-method>]
    <node>
    <method>

--arg <key=value> — an argument to pass to the passthru method. Repeat the option to specify multiple arguments, bestie, stack 'em 🎀
--http-method <http-method> — the HTTP method to use in the passthru request. One of DELETE, GET, PATCH, POST, PUT. Defaults to POST.
node — name or UUID of the node.
method — vendor passthru method to be executed.

This command is provided by the python-ironicclient plugin.

baremetal node passthru list

Lists all the vendor passthru methods a node has. Window shopping, basically 🛍️

openstack baremetal node passthru list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    <node>

-f <FORMATTER>, --format <FORMATTER> — the output format, defaults to table.
-c COLUMN, --column COLUMN — specify the column(s) to include. Can be repeated to show multiple columns.
--quote <QUOTE_MODE> — when to include quotes, defaults to nonnumeric.
--noindent — whether to disable indenting the JSON.
--max-width <integer> — maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. Heads up, the flag wins 👑
--fit-width — fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable.
--print-empty — print empty table if there is no data to show.
--sort-column SORT_COLUMN — specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored). Column names are case-insensitive and accept underscores for spaces. Can be repeated.
--sort-ascending — sort the column(s) in ascending order.
--sort-descending — sort the column(s) in descending order.
node — name or UUID of the node.

This command is provided by the python-ironicclient plugin.

baremetal node power off

Powers a node off. Bye bestie 👋💀

openstack baremetal node power off
    [--power-timeout <power-timeout>]
    [--soft]
    <node>
    [<node> ...]

--power-timeout <power-timeout> — timeout (in seconds, positive integer) to wait for the target power state before erroring out.
--soft — request graceful power-off. Polite! 🎀
node — names or UUID's of the nodes.

This command is provided by the python-ironicclient plugin.

baremetal node power on

Powers a node on. Wake up, main character energy ⚡

openstack baremetal node power on
    [--power-timeout <power-timeout>]
    <node>
    [<node> ...]

--power-timeout <power-timeout> — timeout (in seconds, positive integer) to wait for the target power state before erroring out.
node — names or UUID's of the nodes.

This command is provided by the python-ironicclient plugin.

baremetal node provide

Sets the provision state of your baremetal node to 'provide' — handing it back out into the world 🌈

openstack baremetal node provide
    [--wait [<time-out>]]
    <node>
    [<node> ...]

--wait <time-out> — wait for a node to reach the desired state, available. Optionally takes a timeout value (in seconds). The default value is 0, meaning it will wait indefinitely. Down bad, no limits 😭
node — names or UUID's of the nodes.

This command is provided by the python-ironicclient plugin.

baremetal node reboot

Reboots a baremetal node. The classic "have you tried turning it off and on again" 🔄

openstack baremetal node reboot
    [--soft]
    [--power-timeout <power-timeout>]
    <node>
    [<node> ...]

--soft — request Graceful reboot.
--power-timeout <power-timeout> — timeout (in seconds, positive integer) to wait for the target power state before erroring out.
node — names or UUID's of the nodes.

This command is provided by the python-ironicclient plugin.

baremetal node rebuild

Sets the provision state of a baremetal node to 'rebuild'. Fresh start, new me 🦋

openstack baremetal node rebuild
    [--wait [<time-out>]]
    [--config-drive <config-drive>]
    [--deploy-steps <deploy-steps>]
    <node>
    [<node> ...]

--wait <time-out> — wait for a node to reach the desired state, active. Optionally takes a timeout value (in seconds). The default value is 0, meaning it will wait indefinitely.
--config-drive <config-drive> — okay so this is a lot, stay with me 🫶 it's a gzipped, base64-encoded configuration drive string OR the path to the configuration drive file OR the path to a directory containing the config drive files OR a JSON object to build config drive from OR the path to the JSON file. In case it's a directory, a config drive will be generated from it. In case it's a JSON object with optional keys meta_data, user_data and network_data or a JSON file, a config drive will be generated on the server side (see the bare metal API reference for more details).
--deploy-steps <deploy-steps> — the deploy steps in JSON format. May be the path to a file containing the deploy steps; OR '-', with the deploy steps being read from standard input; OR a string. The value should be a list of deploy-step dictionaries; each dictionary should have keys 'interface', 'step', 'priority' and optional key 'args'.
node — names or UUID's of the nodes.

This command is provided by the python-ironicclient plugin.

baremetal node remove trait

Removes trait(s) from a node. Marie Kondo-ing that node's vibes 🧹✨

openstack baremetal node remove trait [--all] <node> [<trait> ...]

--all — remove all traits. All of them. No survivors 💀
node — name or UUID of the node.
trait — trait(s) to remove.

This command is provided by the python-ironicclient plugin.

baremetal node rescue

Sets the provision state of a baremetal node to 'rescue' — it's giving lifeguard on duty 🛟

openstack baremetal node rescue
    [--wait [<time-out>]]
    --rescue-password <rescue-password>
    <node>
    [<node> ...]

--wait <time-out> — wait for a node to reach the desired state, rescue. Optionally takes a timeout value (in seconds). The default value is 0, meaning it will wait indefinitely.
--rescue-password <rescue-password> — the password that will be used to login to the rescue ramdisk. The value should be a non-empty string. Don't leave it blank, bestie 🙈
node — names or UUID's of the nodes.

This command is provided by the python-ironicclient plugin.

baremetal node secure boot off

Turns secure boot off 🔓

openstack baremetal node secure boot off <node> [<node> ...]

node — name or UUID of the node.

This command is provided by the python-ironicclient plugin.

baremetal node secure boot on

Turns secure boot on 🔐

openstack baremetal node secure boot on <node> [<node> ...]

node — name or UUID of the node.

This command is provided by the python-ironicclient plugin.

baremetal node service

Sets the provision state of a baremetal node to 'service' — the node is literally at your service 💅

openstack baremetal node service
    [--wait [<time-out>]]
    (--service-steps <service-steps> | --runbook <runbook>)
    [--disable-ramdisk]
    <node>
    [<node> ...]

--wait <time-out> — wait for a node to reach the desired state, active. Optionally takes a timeout value (in seconds). The default value is 0, meaning it will wait indefinitely.
--service-steps <service-steps> — the service steps. May be the path to a YAML file containing the service steps; OR '-', with the service steps being read from standard input; OR a JSON string. The value should be a list of service-step dictionaries; each dictionary should have keys 'interface' and 'step', and optional key 'args'.
--runbook <runbook> — the identifier of a predefined runbook to use for servicing.
--disable-ramdisk — ironic-python-agent will not be booted for cleaning. Only steps explicitly marked as not requiring ironic-python-agent can be executed with this set. Read that twice, fr fr 🙏
node — names or UUID's of the nodes.

This command is provided by the python-ironicclient plugin.

baremetal node set

Set baremetal properties

openstack baremetal node set
    [--instance-uuid <uuid>]
    [--instance-name <instance_name>]
    [--name <name>]
    [--chassis-uuid <chassis UUID>]
    [--driver <driver>]
    [--bios-interface <bios_interface> | --reset-bios-interface]
    [--boot-interface <boot_interface> | --reset-boot-interface]
    [--console-interface <console_interface> | --reset-console-interface]
    [--deploy-interface <deploy_interface> | --reset-deploy-interface]
    [--firmware-interface <firmware_interface> | --reset-firmware-interface]
    [--inspect-interface <inspect_interface> | --reset-inspect-interface]
    [--management-interface <management_interface> | --reset-management-interface]
    [--network-interface <network_interface> | --reset-network-interface]
    [--network-data <network data>]
    [--power-interface <power_interface> | --reset-power-interface]
    [--raid-interface <raid_interface> | --reset-raid-interface]
    [--rescue-interface <rescue_interface> | --reset-rescue-interface]
    [--storage-interface <storage_interface> | --reset-storage-interface]
    [--vendor-interface <vendor_interface> | --reset-vendor-interface]
    [--reset-interfaces]
    [--resource-class <resource_class>]
    [--conductor-group <conductor_group>]
    [--automated-clean | --no-automated-clean]
    [--protected]
    [--protected-reason <protected_reason>]
    [--retired]
    [--retired-reason <retired_reason>]
    [--target-raid-config <target_raid_config>]
    [--property <key=value>]
    [--extra <key=value>]
    [--driver-info <key=value>]
    [--instance-info <key=value>]
    [--owner <owner>]
    [--lessee <lessee>]
    [--description <description>]
    [--shard <shard>]
    [--parent-node <parent_node>]
    [--enable-power-off | --disable-power-off]
    <node>
    [<node> ...]

--instance-uuid <uuid> — sets the node's instance UUID to <uuid>, bestie. Slap a UUID on it.
--instance-name <instance_name> — sets the name of the instance that's deployed on this node.
--name <name> — renames the node to <name>. Glow-up, but for hostnames ✨
--chassis-uuid <chassis UUID> — puts the node in a different chassis. Real "moving in with a new roommate" energy.
--driver <driver> — sets the driver for the node.
--bios-interface <bios_interface> — sets the BIOS interface. Very demure, very firmware.
--reset-bios-interface — nukes the BIOS interface back to its hardware type default. Iconic reset behavior 💅
--boot-interface <boot_interface> — sets the boot interface.
--reset-boot-interface — puts the boot interface back to its hardware type default.
--console-interface <console_interface> — sets the console interface.
--reset-console-interface — console interface → hardware type default. Poof.
--deploy-interface <deploy_interface> — sets the deploy interface.
--reset-deploy-interface — deploy interface back to its hardware type default, no cap.
--firmware-interface <firmware_interface> — sets the firmware interface.
--reset-firmware-interface — resets the firmware interface for its hardware type default. (Yes, the original says "for", we're not fixing it, we're respecting it 🫶)
--inspect-interface <inspect_interface> — sets the inspect interface.
--reset-inspect-interface — inspect interface back to hardware type default.
--management-interface <management_interface> — sets the management interface.
--reset-management-interface — management interface back to hardware type default.
--network-interface <network_interface> — sets the network interface.
--reset-network-interface — network interface back to hardware type default.
--network-data <network data> — okay so this one's a whole thing 😭 you give it a JSON string, OR a YAML file, OR - to read from stdin, and it reads static network configuration for the baremetal node associated with this ironic node. The format of this file should comply with Nova network data metadata (network_data.json). And here's the tea: depending on which ironic boot interface capabilities are being used, the network configuration may or may not have been served to the node for offline network configuration. It's giving "it depends" and we respect that.
--power-interface <power_interface> — sets the power interface.
--reset-power-interface — power interface back to hardware type default ⚡
--raid-interface <raid_interface> — sets the RAID interface.
--reset-raid-interface — RAID interface back to hardware type default.
--rescue-interface <rescue_interface> — sets the rescue interface.
--reset-rescue-interface — rescue interface back to hardware type default. Rescuing the rescuers.
--storage-interface <storage_interface> — sets the storage interface.
--reset-storage-interface — storage interface back to hardware type default.
--vendor-interface <vendor_interface> — sets the vendor interface.
--reset-vendor-interface — vendor interface back to hardware type default.
--reset-interfaces — resets all interfaces that you didn't explicitly specify back to their default implementations. Heads up bestie: this one is only valid with --driver. No driver, no dice.
--resource-class <resource_class> — sets the resource class. Main character label energy 👑
--conductor-group <conductor_group> — sets the conductor group for the node.
--automated-clean — enables automated cleaning for the node 🧼
--no-automated-clean — explicitly disables automated cleaning for the node. Like, you really mean it.
--protected — marks the node as protected. Hands off, she's guarded 🙈
--protected-reason <protected_reason> — sets the reason for marking the node as protected. Gotta cite your sources.
--retired — marks the node as retired. She's living her retired life now.
--retired-reason <retired_reason> — sets the reason for marking the node as retired.
--target-raid-config <target_raid_config> — sets the target RAID configuration (JSON) for the node. And it can be one of: 1. a file containing YAML data of the RAID configuration; 2. - to read the contents from standard input; or 3. a valid JSON string. Three flavors, pick your fighter.
--property <key=value> — a property to set on this baremetal node (repeat the option to set multiple properties).
--extra <key=value> — an extra to set on this baremetal node (repeat the option to set multiple extras).
--driver-info <key=value> — driver information to set on this baremetal node (repeat the option to set multiple driver infos).
--instance-info <key=value> — instance information to set on this baremetal node (repeat the option to set multiple instance infos).
--owner <owner> — sets the owner for the node.
--lessee <lessee> — sets the lessee for the node.
--description <description> — sets the description for the node. Give her a little bio ✍️
--shard <shard> — sets the shard for the node.
--parent-node <parent_node> — sets the parent node for the node. Family tree but make it infrastructure 🌳
--enable-power-off — explicitly enables power off actions on nodes.
--disable-power-off — explicitly disables power off actions on nodes.
node — names or UUID's of the nodes. Yep, plural allowed, you can pass a whole squad.

This command is provided by the python-ironicclient plugin.

🎀 `baremetal node show` 🎀

Shows baremetal node details. The reveal. The moment. ⭐

openstack baremetal node show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--instance]
    [--fields <field> [<field> ...]]
    <node>

-f <FORMATTER>, --format <FORMATTER> — the output format, defaults to table.
-c COLUMN, --column COLUMN — specify the column(s) to include, can be repeated to show multiple columns.
--noindent — whether to disable indenting the JSON.
--prefix <PREFIX> — add a prefix to all variable names.
--max-width <integer> — maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. (Parameter wins, always 💅)
--fit-width — fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable.
--print-empty — print an empty table if there is no data to show. At least the table ate, even if it's empty.
--instance — treats <node> as an instance UUID. Plot twist.
--fields <field> — one or more node fields. Only these fields will be fetched from the server. Selective, and honestly valid.
node — name or UUID of the node (or instance UUID if --instance is specified).

This command is provided by the python-ironicclient plugin.

🌸 `baremetal node trait add` 🌸

Adds traits to a node. Little personality tags 🏷️✨

openstack baremetal node trait add <node> <trait> [<trait> ...]

node — name or UUID of the node.
trait — trait(s) to add. Bring a whole list, she can hold them.

This command is provided by the python-ironicclient plugin.

🦋 `baremetal node trait list` 🦋

Lists a node's traits. A full personality read 💜

openstack baremetal node trait list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    <node>

-f <FORMATTER>, --format <FORMATTER> — the output format, defaults to table.
-c COLUMN, --column COLUMN — specify the column(s) to include, can be repeated to show multiple columns.
--quote <QUOTE_MODE> — when to include quotes, defaults to nonnumeric.
--noindent — whether to disable indenting the JSON.
--max-width <integer> — maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
--fit-width — fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable.
--print-empty — print an empty table if there is no data to show.
--sort-column SORT_COLUMN — specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), column names are case-insensitive and accept underscores for spaces, can be repeated. So forgiving, we love her.
--sort-ascending — sort the column(s) in ascending order.
--sort-descending — sort the column(s) in descending order.
node — name or UUID of the node.

This command is provided by the python-ironicclient plugin.

🎀 baremetal node trait remove

Bye-bye traits! Pull one (or a whole bunch) off a node.

openstack baremetal node trait remove [--all] <node> [<trait> ...]

--all — remove all the traits, like, every single one 💅
node — name or UUID of the node
trait — the trait(s) you wanna remove

This command is provided by the python-ironicclient plugin.

🫶 baremetal node undeploy

Sets the provision state of a baremetal node to 'deleted'. Iconic teardown moment.

openstack baremetal node undeploy
    [--wait [<time-out>]]
    <node>
    [<node> ...]

--wait <time-out> — wait for a node to reach the desired state, available. Optionally takes a timeout value (in seconds). The default value is 0, meaning it will wait indefinitely 😭 (yes, forever-forever)
node — names or UUID's of the nodes

This command is provided by the python-ironicclient plugin.

✨ baremetal node unhold

Sets the provision state of a baremetal node to 'unhold'.

openstack baremetal node unhold <node> [<node> ...]

node — names or UUID's of the nodes

This command is provided by the python-ironicclient plugin.

🦋 baremetal node unrescue

Sets the provision state of a baremetal node to 'unrescue' — time to come back from the rescue era.

openstack baremetal node unrescue
    [--wait [<time-out>]]
    <node>
    [<node> ...]

--wait <time-out> — wait for a node to reach the desired state, active. Optionally takes a timeout value (in seconds). The default value is 0, meaning it will wait indefinitely 🫠
node — names or UUID's of the nodes

This command is provided by the python-ironicclient plugin.

🧹 baremetal node unset

Unset baremetal properties. Basically the "never mind 🙈" of commands — you're taking stuff back off the node.

openstack baremetal node unset
    [--instance-uuid]
    [--instance-name]
    [--name]
    [--resource-class]
    [--target-raid-config]
    [--property <key>]
    [--extra <key>]
    [--driver-info <key>]
    [--instance-info <key>]
    [--chassis-uuid]
    [--bios-interface]
    [--boot-interface]
    [--console-interface]
    [--deploy-interface]
    [--firmware-interface]
    [--inspect-interface]
    [--network-data]
    [--management-interface]
    [--network-interface]
    [--power-interface]
    [--raid-interface]
    [--rescue-interface]
    [--storage-interface]
    [--vendor-interface]
    [--conductor-group]
    [--automated-clean]
    [--protected]
    [--protected-reason]
    [--retired]
    [--retired-reason]
    [--owner]
    [--lessee]
    [--description]
    [--shard]
    [--parent-node]
    <node>
    [<node> ...]

--instance-uuid — unset instance UUID on this baremetal node
--instance-name — unset instance name on this baremetal node
--name — unset the name of the node
--resource-class — unset the resource class of the node
--target-raid-config — unset the target RAID configuration of the node
--property <key> — property to unset on this baremetal node (repeat the option to unset multiple properties)
--extra <key> — extra to unset on this baremetal node (repeat the option to unset multiple extras)
--driver-info <key> — driver information to unset on this baremetal node (repeat the option to unset multiple items in driver information)
--instance-info <key> — instance information to unset on this baremetal node (repeat the option to unset multiple instance information)
--chassis-uuid — unset chassis UUID on this baremetal node
--bios-interface — unset BIOS interface on this baremetal node
--boot-interface — unset boot interface on this baremetal node
--console-interface — unset console interface on this baremetal node
--deploy-interface — unset deploy interface on this baremetal node
--firmware-interface — unset firmware interface on this baremetal node
--inspect-interface — unset inspect interface on this baremetal node
--network-data — unset network data on this baremetal port. (yep, the page says port here, not node — copying it exactly, don't @ me 🙈)
--management-interface — unset management interface on this baremetal node
--network-interface — unset network interface on this baremetal node
--power-interface — unset power interface on this baremetal node
--raid-interface — unset RAID interface on this baremetal node
--rescue-interface — unset rescue interface on this baremetal node
--storage-interface — unset storage interface on this baremetal node
--vendor-interface — unset vendor interface on this baremetal node
--conductor-group — unset conductor group for this baremetal node (the default group will be used)
--automated-clean — unset automated clean option on this baremetal node (the value from configuration will be used)
--protected — unset the protected flag on the node
--protected-reason — unset the protected reason (gets unset automatically when protected is unset)
--retired — unset the retired flag on the node
--retired-reason — unset the retired reason (gets unset automatically when retired is unset)
--owner — unset the owner field of the node
--lessee — unset the lessee field of the node
--description — unset the description field of the node
--shard — unset the shard field of the node
--parent-node — unset the parent node field of the node
node — names or UUID's of the nodes

This command is provided by the python-ironicclient plugin.

🔍 baremetal node validate

Vibe-checks a node's driver interfaces. Does this node actually work? Let's find out bestie.

openstack baremetal node validate
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    <node>

-f <FORMATTER>, --format <FORMATTER> — the output format, defaults to table
-c COLUMN, --column COLUMN — specify the column(s) to include, can be repeated to show multiple columns
--quote <QUOTE_MODE> — when to include quotes, defaults to nonnumeric
--noindent — whether to disable indenting the JSON
--max-width <integer> — maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
--fit-width — fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
--print-empty — print empty table if there is no data to show.
--sort-column SORT_COLUMN — specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), column names are case-insensitive and accept underscores for spaces, can be repeated
--sort-ascending — sort the column(s) in ascending order
--sort-descending — sort the column(s) in descending order
node — name or UUID of the node

This command is provided by the python-ironicclient plugin.

🌸 baremetal node vif attach

Attach a VIF to a given node. Networking era 💅

openstack baremetal node vif attach
    [--port-uuid <port-uuid>]
    [--portgroup-uuid <portgroup-uuid>]
    [--vif-info <key=value>]
    <node>
    <vif-id>

--port-uuid <port-uuid> — UUID of the baremetal port to attach the VIF to.
--portgroup-uuid <portgroup-uuid> — UUID of the baremetal portgroup to attach the VIF to.
--vif-info <key=value> — record arbitrary key/value metadata. Can be specified multiple times. The mandatory 'id' parameter cannot be specified as a key. (rude but true)
node — name or UUID of the node
vif-id — name or UUID of the VIF to attach to a node.

This command is provided by the python-ironicclient plugin.

🍓 baremetal node vif detach

Detach VIF from a given node. Un-attach, un-attach 🎶

openstack baremetal node vif detach <node> <vif-id>

node — name or UUID of the node
vif-id — name or UUID of the VIF to detach from a node.

This command is provided by the python-ironicclient plugin.

👑 baremetal node vif list

Show attached VIFs for a node — the whole guest list, bestie.

openstack baremetal node vif list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    <node>

-f <FORMATTER>, --format <FORMATTER> — the output format, defaults to table
-c COLUMN, --column COLUMN — specify the column(s) to include, can be repeated to show multiple columns
--quote <QUOTE_MODE> — when to include quotes, defaults to nonnumeric
--noindent — whether to disable indenting the JSON
--max-width <integer> — maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
--fit-width — fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
--print-empty — print empty table if there is no data to show.
--sort-column SORT_COLUMN — specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), column names are case-insensitive and accept underscores for spaces, can be repeated
--sort-ascending — sort the column(s) in ascending order
--sort-descending — sort the column(s) in descending order
node — name or UUID of the node

This command is provided by the python-ironicclient plugin.

🌈 baremetal port

🎀 baremetal port create

Create a new port 🔌✨

ok bestie, next up is the full breakdown of baremetal port create and its flags — coming in the next part, don't go anywhere 💖

openstack baremetal port create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    --node <uuid>
    [--uuid <uuid>]
    [--extra <key=value>]
    [--local-link-connection <key=value>]
    [--pxe-enabled <boolean>]
    [--port-group <uuid>]
    [--physical-network <physical network>]
    [--is-smartnic]
    [--name <port name>]
    [--description <port description>]
    [--vendor <port vendor>]
    [--category <port category>]
    <address>

like, that's the whole shape of it bestie — <address> is mandatory, --node is mandatory, everything else is a vibe you can add or skip ✨

-f <FORMATTER>, --format <FORMATTER> — the output format, defaults to table 💅
-c COLUMN, --column COLUMN — specify the column(s) to include, can be repeated to show multiple columns
--noindent — whether to disable indenting the JSON
--prefix <PREFIX> — add a prefix to all variable names
--max-width <integer> — Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
--fit-width — Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
--print-empty — Print empty table if there is no data to show.
--node <uuid> — UUID of the node that this port belongs to.
--uuid <uuid> — UUID of the port.
--extra <key=value> — Record arbitrary key/value metadata. Argument can be specified multiple times.
--local-link-connection <key=value> — Key/value metadata describing Local link connection information. Valid keys are 'switch_info', 'switch_id', 'port_id' and 'hostname'. The keys 'switch_id' and 'port_id' are required. In case of a Smart NIC port, the required keys are 'port_id' and 'hostname'. Argument can be specified multiple times.
--pxe-enabled <boolean> — Indicates whether this Port should be used when PXE booting this Node.
--port-group <uuid> — UUID of the port group that this port belongs to.
--physical-network <physical network> — Name of the physical network to which this port is connected.
--is-smartnic — Indicates whether this Port is a Smart NIC port
--name <port name> — Name of the port.
--description <port description> — An optional description for the port.
--vendor <port vendor> — An optional vendor for the port.
--category <port category> — An optional category for the port.
address — MAC address for this port.

This command is provided by the python-ironicclient plugin.

🗑️ baremetal port delete

Delete port(s). plural. multiple. go off, clean up that cluster 🧹✨

openstack baremetal port delete <port> [<port> ...]

port — UUID(s) of the port(s) to delete.

This command is provided by the python-ironicclient plugin.

🎀 baremetal port group create

Create a new baremetal port group. it's giving found family but for ports 👑

openstack baremetal port group create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    --node <uuid>
    [--address <mac-address>]
    [--name NAME]
    [--uuid UUID]
    [--extra <key=value>]
    [--mode MODE]
    [--property <key=value>]
    [--support-standalone-ports | --unsupport-standalone-ports]
    [--physical-network <physical network>]
    [--category <port category>]

-f <FORMATTER>, --format <FORMATTER> — the output format, defaults to table 💅
-c COLUMN, --column COLUMN — specify the column(s) to include, can be repeated to show multiple columns
--noindent — whether to disable indenting the JSON
--prefix <PREFIX> — add a prefix to all variable names
--max-width <integer> — Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
--fit-width — Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
--print-empty — Print empty table if there is no data to show.
--node <uuid> — UUID of the node that this port group belongs to.
--address <mac-address> — MAC address for this port group.
--name <NAME> — Name of the port group.
--uuid <UUID> — UUID of the port group.
--extra <key=value> — Record arbitrary key/value metadata. Can be specified multiple times.
--mode <MODE> — Mode of the port group. For possible values, refer to https://www.kernel.org/doc/Documentation/networking/bonding.txt.
--property <key=value> — Key/value property related to this port group's configuration. Can be specified multiple times.
--support-standalone-ports — Ports that are members of this port group can be used as stand-alone ports. (default)
--unsupport-standalone-ports — Ports that are members of this port group cannot be used as stand-alone ports.
--physical-network <physical network> — Name of the physical network to which the ports in this port group are connected.
--category <port category> — An optional category for the port group.

This command is provided by the python-ironicclient plugin.

💀 baremetal port group delete

Unregister baremetal port group(s). bye bestie, you will NOT be missed (jk, the ports will lowkey miss you) 🫶

openstack baremetal port group delete <port group> [<port group> ...]

port group — Port group(s) to delete (name or UUID).

This command is provided by the python-ironicclient plugin.

🌈 baremetal port group list

List baremetal port groups. window shopping for your fave groupies 🛍️

openstack baremetal port group list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--limit <limit>]
    [--marker <port group>]
    [--sort <key>[:<direction>]]
    [--address <mac-address>]
    [--node <node>]
    [--shards <shard> [<shard> ...]]
    [--long | --fields <field> [<field> ...]]

-f <FORMATTER>, --format <FORMATTER> — the output format, defaults to table 💅
-c COLUMN, --column COLUMN — specify the column(s) to include, can be repeated to show multiple columns
--quote <QUOTE_MODE> — when to include quotes, defaults to nonnumeric
--noindent — whether to disable indenting the JSON
--max-width <integer> — Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
--fit-width — Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
--print-empty — Print empty table if there is no data to show.
--sort-column SORT_COLUMN — specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), column names are case-insensitive and accept underscores for spaces, can be repeated
--sort-ascending — sort the column(s) in ascending order
--sort-descending — sort the column(s) in descending order
--limit <limit> — Maximum number of port groups to return per request, 0 for no limit. Default is the maximum number used by the Baremetal API Service.
--marker <port group> — Port group UUID (for example, of the last port group in the list from a previous request). Returns the list of port groups after this UUID.
--sort <key>[:<direction>] — Sort output by specified port group fields and directions (asc or desc) (default: asc). Multiple fields and directions can be specified, separated by comma.
--address <mac-address> — Only show information for the port group with this MAC address.
--node <node> — Only list port groups of this node (name or UUID).
--shards <shard> — Only list port groups of nodes in these shards.
--long — Show detailed information about the port groups.
--fields <field> — One or more port group fields. Only these fields will be fetched from the server. Can not be used when '--long' is specified.

This command is provided by the python-ironicclient plugin.

🦋 baremetal port group set

Set baremetal port group properties. glow-up time for your group ✨💅

openstack baremetal port group set
    [--node <uuid>]
    [--address <mac-address>]
    [--name <name>]
    [--extra <key=value>]
    [--mode MODE]
    [--property <key=value>]
    [--support-standalone-ports | --unsupport-standalone-ports]
    [--physical-network <physical network>]
    [--category <category>]
    <port
    group>

--node <uuid> — Update UUID of the node that this port group belongs to.
--address <mac-address> — MAC address for this port group.
--name <name> — Name of the port group.
--extra <key=value> — Extra to set on this baremetal port group (repeat option to set multiple extras).
--mode <MODE> — Mode of the port group. For possible values, refer to https://www.kernel.org/doc/Documentation/networking/bonding.txt.
--property <key=value> — Key/value property related to this port group's configuration (repeat option to set multiple properties).
--support-standalone-ports — Ports that are members of this port group can be used as stand-alone ports.
--unsupport-standalone-ports — Ports that are members of this port group cannot be used as stand-alone ports.
--physical-network <physical network> — Set a physical network for the ports in this port group
--category <category> — Set a category for this port group
port group — Name or UUID of the port group.

This command is provided by the python-ironicclient plugin.

👑 baremetal port group show

Show baremetal port group details.

🎀 `openstack baremetal port group show`

okay bestie, this is the port-group spotlight command ✨ it pulls up one port group and lets you pick exactly how the output looks.

openstack baremetal port group show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--address]
    [--fields <field> [<field> ...]]
    <id>

-f <FORMATTER>, --format <FORMATTER> — this is the output format, and it defaults to table 💅
-c COLUMN, --column COLUMN — pick the column(s) you want included; repeat it to show multiple columns ✨
--noindent — turns off indenting the JSON, no cap 🫶
--prefix <PREFIX> — adds a prefix to all variable names 🎀
--max-width <integer> — maximum display width, with <1 to disable it. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence ⭐
--fit-width — fits the table to the display width. This is implied if --max-width is greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable it 🌸
--print-empty — prints an empty table if there’s no data to show 💀
--address — says that <id> is the MAC address (instead of UUID or name) of the port group 👑
--fields <field> — one or more port group fields. Only these fields will be fetched from the server 🔥
id — UUID or name of the port group (or MAC address if --address is specified) 💖

This command is provided by the python-ironicclient plugin.

🦋 `baremetal port group unset`

this one is the “take it back” button for baremetal port group properties 🙈

openstack baremetal port group unset
    [--name]
    [--address]
    [--extra <key>]
    [--property <key>]
    [--physical-network]
    [--category]
    <port group>

--name — unsets the name of the port group 🎀
--address — unsets the address of the port group ✨
--extra <key> — extra to unset on this baremetal port group; repeat the option to unset multiple extras 💅
--property <key> — property to unset on this baremetal port group; repeat the option to unset multiple properties 🔥
--physical-network — unsets the physical network on this baremetal port group 🌈
--category — unsets the category for this port group 🦋
port group — name or UUID of the port group 💖

This command is provided by the python-ironicclient plugin.

💅 `baremetal port list`

listing baremetal ports, bestie — with so many little knobs for sorting, filtering, and formatting 👑

openstack baremetal port list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--address <mac-address>]
    [--node <node>]
    [--port-group <port group>]
    [--limit <limit>]
    [--marker <port>]
    [--sort <key>[:<direction>]]
    [--long | --fields <field> [<field> ...]]

-f <FORMATTER>, --format <FORMATTER> — the output format, defaults to table ✨
-c COLUMN, --column COLUMN — specify the column(s) to include; repeat it to show multiple columns 🎀
--quote <QUOTE_MODE> — when to include quotes, defaults to nonnumeric 💅
--noindent — whether to disable indenting the JSON 🫶
--max-width <integer> — maximum display width, with <1 to disable it. You can also use CLIFF_MAX_TERM_WIDTH, but the parameter takes precedence ⭐
--fit-width — fits the table to the display width. Implied if --max-width is greater than 0. Set CLIFF_FIT_WIDTH=1 to always enable 🌸
--print-empty — prints an empty table if there’s no data to show 💀
--sort-column SORT_COLUMN — specify the column(s) to sort the data; columns specified first have priority, non-existing columns are ignored, column names are case-insensitive and accept underscores for spaces, and it can be repeated 🔥
--sort-ascending — sorts the column(s) in ascending order 🌈
--sort-descending — sorts the column(s) in descending order 🦋
--address <mac-address> — only show information for the port with this MAC address 🎀
--node <node> — only list ports of this node (name or UUID) 💜
--port-group <port group> — only list ports of this port group (name or UUID) 👑
--limit <limit> — maximum number of ports to return per request, 0 for no limit. Default is the maximum number used by the Baremetal API Service 💖
--marker <port> — port UUID (for example, of the last port in the list from a previous request). Returns the list of ports after this UUID ✨
--sort <key>[:<direction>] — sort output by specified port fields and directions (asc or desc) (default: asc). Multiple fields and directions can be specified, separated by comma 🔥
--long — show detailed information about ports 👑
--fields <field> — one or more port fields. Only these fields will be fetched from the server. Can not be used when --long is specified 💅

This command is provided by the python-ironicclient plugin.

🌸 `baremetal port set`

setting baremetal port properties — yes, this is the glow-up command 💖

openstack baremetal port set
    [--node <uuid>]
    [--address <address>]
    [--extra <key=value>]
    [--port-group <uuid>]
    [--local-link-connection <key=value>]
    [--pxe-enabled | --pxe-disabled]
    [--physical-network <physical network>]
    [--is-smartnic]
    [--name <name>]
    [--description <description>]
    [--vendor <vendor>]
    [--category <category>]
    <port>

--node <uuid> — set UUID of the node that this port belongs to 🎀
--address <address> — set MAC address for this port ✨
--extra <key=value> — extra to set on this baremetal port; repeat the option to set multiple extras 💅
--port-group <uuid> — set UUID of the port group that this port belongs to 🦋
--local-link-connection <key=value> — key/value metadata describing local link connection information. Valid keys are 'switch_info', 'switch_id', 'port_id' and 'hostname'. The keys 'switch_id' and 'port_id' are required. In case of a Smart NIC port, the required keys are 'port_id' and 'hostname'. Argument can be specified multiple times 🔥
--pxe-enabled — indicates that this port should be used when PXE booting this node (default) 👑
--pxe-disabled — indicates that this port should not be used when PXE booting this node 💀
--physical-network <physical network> — set the name of the physical network to which this port is connected 🌈
--is-smartnic — set port to be a Smart NIC port ⭐
--name <name> — set name for this port 🎀
--description <description> — set a description for this port 💜
--vendor <vendor> — set a vendor for this port 💖
--category <category> — set a category for this port 🦋
port — UUID of the port ✨

This command is provided by the python-ironicclient plugin.

🫶 `baremetal port show`

port details, front and center — this is the main-character view 👑

openstack baremetal port show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--address]
    [--fields <field> [<field> ...]]
    <id>

-f <FORMATTER>, --format <FORMATTER> — the output format, defaults to table ✨
-c COLUMN, --column COLUMN — specify the column(s) to include; repeat it to show multiple columns 🎀
--noindent — whether to disable indenting the JSON 💅
--prefix <PREFIX> — adds a prefix to all variable names 🫶
--max-width <integer> — maximum display width, with <1 to disable it. You can also use CLIFF_MAX_TERM_WIDTH, but the parameter takes precedence ⭐
--fit-width — fits the table to the display width. Implied if --max-width is greater than 0. Set CLIFF_FIT_WIDTH=1 to always enable 🌸
--print-empty — prints an empty table if there’s no data to show 💀
--address — says that <id> is the MAC address (instead of the UUID) of the port 🔥
--fields <field> — one or more port fields. Only these fields will be fetched from the server 🌈
id — UUID of the port (or MAC address if --address is specified) 💖

This command is provided by the python-ironicclient plugin.

🧚 `baremetal port unset`

the un-glow-up command for baremetal port properties — take those fields back, bestie 🙈

openstack baremetal port unset
    [--extra <key>]
    [--local-link-connection <key>]
    [--port-group]
    [--physical-network]
    [--is-smartnic]
    [--name]
    [--description]
    [--vendor]
    [--category]
    <port>

--extra <key> — extra to unset on this baremetal port; repeat the option to unset multiple extras 🎀
--local-link-connection <key> — remove local link connection on this port; repeat the option to unset multiple keys ✨
--port-group — remove port from the port group 💅
--physical-network — unset the physical network on this baremetal port 🌈
--is-smartnic — set Port as not Smart NIC port 💀
--name — unset the name for this port 🦋
--description — unset the description for this port 💜
--vendor — unset the vendor for this port 💖
--category — unset the category for this port 🎀
port — UUID of the port ⭐

This command is provided by the python-ironicclient plugin.

🌈 `baremetal volume`

okay, volume connector territory — buckle up, bestie 💾✨

👑 `baremetal volume connector create`

creating a new baremetal volume connector, and it’s giving required-options energy 🔥

openstack baremetal volume connector create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    --node <uuid>
    --type <type>
    --connector-id <connector id>
    [--uuid <uuid>]
    [--extra <key=value>]

-f <FORMATTER>, --format <FORMATTER> — the output format, defaults to table ✨
-c COLUMN, --column COLUMN — specify the column(s) to include; repeat it to show multiple columns 🎀
--noindent — whether to disable indenting the JSON 💅
--prefix <PREFIX> — bestie this one just sticks a little prefix on all the variable names so nothing gets confusing later 💅 super simple, super useful.
--max-width <integer> — caps the max display width. Anything <1 disables it entirely. You can also set the CLIFF_MAX_TERM_WIDTH environment variable if env vars are more your vibe, but heads up — the parameter takes precedence. 👑
--fit-width — makes the table actually fit your display width. It's implied if --max-width is greater than 0, so like, it kinda turns itself on. Wanna always have it? Set the environment variable CLIFF_FIT_WIDTH=1 and it's on fr fr. ✨
--print-empty — prints an empty table when there's genuinely no data to show. No data, still got a table, we love a consistent aesthetic 🎀
--node <uuid> — the UUID of the node that this volume connector belongs to.
--type <type> — the type of the volume connector. Valid values are 'iqn', 'ip', 'mac', 'wwnn', 'wwpn', 'port', 'portgroup' — pick your fighter 💖
--connector-id <connector id> — the ID of the volume connector within the specified type. Like, for example, the iSCSI initiator IQN for the node if the type is 'iqn'. iykyk 🧚
--uuid <uuid> — the UUID of the volume connector itself.
--extra <key=value> — records arbitrary key/value metadata, and yes you can specify it multiple times. Stack 'em up 🍓

This command is provided by the python-ironicclient plugin. Credit where credit is due, periodt. 💜

🗑️ `baremetal volume connector delete`

Unregister baremetal volume connector(s) — basically the "it's not me, it's you" of volume connectors 😭

openstack baremetal volume connector delete
    <volume connector>
    [<volume connector> ...]

volume connector — the UUID(s) of the volume connector(s) you're deleting. As many as you want, they can all go together 🦋

This command is provided by the python-ironicclient plugin.

📋 `baremetal volume connector list`

List baremetal volume connectors — the full roster, the lineup, the group chat member list 🌈

openstack baremetal volume connector list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--node <node>]
    [--limit <limit>]
    [--marker <volume connector>]
    [--sort <key>[:<direction>]]
    [--long | --fields <field> [<field> ...]]

-f <FORMATTER>, --format <FORMATTER> — the output format. Defaults to table 💅
-c COLUMN, --column COLUMN — specify the column(s) to include. Repeat it to show multiple columns, very mix-and-match of you ✨
--quote <QUOTE_MODE> — when to include quotes. Defaults to nonnumeric.
--noindent — whether to disable indenting the JSON. Un-indent it, let it be free 🦋
--max-width <integer> — Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
--fit-width — Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable.
--print-empty — Print empty table if there is no data to show.
--sort-column SORT_COLUMN — specify the column(s) to sort the data — columns specified first have a priority, and non-existing columns are ignored (rude but ok). Column names are case-insensitive and accept underscores for spaces. Can be repeated 🔥
--sort-ascending — sort the column(s) in ascending order ⬆️
--sort-descending — sort the column(s) in descending order ⬇️
--node <node> — only list volume connectors of this node (name or UUID).
--limit <limit> — maximum number of volume connectors to return per request, 0 for no limit. The default is the maximum number used by the Baremetal API Service. No cap fr fr 🧢
--marker <volume connector> — volume connector UUID (for example, of the last volume connector in the list from a previous request). Returns the list of volume connectors after this UUID — like a "continue where we left off" bookmark 🎀
--sort <key>[:<direction>] — sort output by specified volume connector fields and directions (asc or desc) (default: asc). Multiple fields and directions can be specified, separated by comma. Multitask slay 💅
--long — show detailed information about volume connectors. The full lore 👑
--fields <field> — one or more volume connector fields. Only these fields will be fetched from the server. Can not be used when '--long' is specified — pick a lane bestie 🫶

This command is provided by the python-ironicclient plugin.

🛠️ `baremetal volume connector set`

Set baremetal volume connector properties — glow-up time ✨

openstack baremetal volume connector set
    [--node <uuid>]
    [--type <type>]
    [--connector-id <connector id>]
    [--extra <key=value>]
    <volume connector>

--node <uuid> — UUID of the node that this volume connector belongs to.
--type <type> — Type of the volume connector. Can be 'iqn', 'ip', 'mac', 'wwnn', 'wwpn', 'port', 'portgroup'.
--connector-id <connector id> — ID of the volume connector in the specified type.
--extra <key=value> — Record arbitrary key/value metadata. Can be specified multiple times.
volume connector — UUID of the volume connector.

This command is provided by the python-ironicclient plugin.

🔍 `baremetal volume connector show`

Show baremetal volume connector details — the deep dive, the full story 🔎

openstack baremetal volume connector show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--fields <field> [<field> ...]]
    <id>

-f <FORMATTER>, --format <FORMATTER> — the output format, defaults to table.
-c COLUMN, --column COLUMN — specify the column(s) to include, can be repeated to show multiple columns.
--noindent — whether to disable indenting the JSON.
--prefix <PREFIX> — add a prefix to all variable names.
--max-width <integer> — Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
--fit-width — Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable.
--print-empty — Print empty table if there is no data to show.
--fields <field> — One or more volume connector fields. Only these fields will be fetched from the server.
id — UUID of the volume connector.

This command is provided by the python-ironicclient plugin.

🧹 `baremetal volume connector unset`

Unset baremetal volume connector properties — the declutter era 🧼

openstack baremetal volume connector unset
    [--extra <key>]
    <volume connector>

--extra <key> — Extra to unset (repeat option to unset multiple extras). Bye bye extras, love you, mean it 💜
volume connector — UUID of the volume connector.

This command is provided by the python-ironicclient plugin.

🌱 `baremetal volume target create`

Create a new baremetal volume target — new target just dropped 👑

openstack baremetal volume target create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    --node <uuid>
    --type <volume type>
    [--property <key=value>]
    --boot-index <boot index>
    --volume-id <volume id>
    [--uuid <uuid>]
    [--extra <key=value>]

-f <FORMATTER>, --format <FORMATTER> — the output format, defaults to table.
-c COLUMN, --column COLUMN — specify the column(s) to include, can be repeated to show multiple columns.
--noindent — whether to disable indenting the JSON.
--prefix <PREFIX> — add a prefix to all variable names.
--max-width <integer> — Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
--fit-width — Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable.
--print-empty — Print empty table if there is no data to show.
--node <uuid> — UUID of the node that this volume target belongs to.
--type <volume type> — Type of the volume target, e.g. 'iscsi', 'fibre_channel'.
--property <key=value> — Key/value property related to the type of this volume target. Can be specified multiple times.
--boot-index <boot index> — Boot index of the volume target.
--volume-id <volume id> — ID of the volume associated with this target.
--uuid <uuid> — UUID of the volume target.
--extra <key=value> — Record arbitrary key/value metadata. Can be specified multiple times.

This command is provided by the python-ironicclient plugin.

🗑️ `baremetal volume target delete`

Unregister baremetal volume target(s) — clearing the roster 😭

openstack baremetal volume target delete
    <volume target>
    [<volume target> ...]

volume target — UUID(s) of the volume target(s) to delete.

This command is provided by the python-ironicclient plugin.

📋 `baremetal volume target list`

List baremetal volume targets — the whole squad, on display 🌸

openstack baremetal volume target list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--node <node>]
    [--limit <limit>]
    [--marker <volume target>]
    [--sort <key>[:<direction>]]
    [--long | --fields <field> [<field> ...]]

-f <FORMATTER>, --format <FORMATTER> — the output format, defaults to table.
-c COLUMN, --column COLUMN — specify the column(s) to include, can be repeated to show multiple columns.
--quote <QUOTE_MODE> — when to include quotes, defaults to nonnumeric.
--noindent — whether to disable indenting the JSON.
--max-width <integer> — Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
--fit-width — Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable.
--print-empty — Print empty table if there is no data to show.
--sort-column SORT_COLUMN — tells it which column(s) to sort the data by 🫶 the columns you name first get priority, and non-existent columns are just... ignored, no drama. Column names are case-insensitive and accept underscores instead of spaces, and yeah you can repeat this one.
--sort-ascending — sort those column(s) in ascending order ✨
--sort-descending — sort those column(s) in descending order, no cap 📉
--node <node> — only list volume targets of this node (give it a name or a UUID, either eats).
--limit <limit> — max number of volume targets to return per request, 0 means no limit. Default is the maximum number used by the Baremetal API Service.
--marker <volume target> — a volume target UUID (like, say, the last volume target in the list from a previous request). Returns the list of volume targets after this UUID 👑
--sort <key>[:<direction>] — sort output by specified volume target fields and directions (asc or desc) (default: asc). You can stack multiple fields and directions, separated by comma.
--long — show detailed information about volume targets 💅
--fields <field> — one or more volume target fields. Only these fields will be fetched from the server. Can not be used when --long is specified 🚫

This command is provided by the python-ironicclient plugin.

🌸 baremetal volume target set 🌸

Set baremetal volume target properties.

openstack baremetal volume target set
    [--node <uuid>]
    [--type <volume type>]
    [--property <key=value>]
    [--boot-index <boot index>]
    [--volume-id <volume id>]
    [--extra <key=value>]
    <volume
    target>

--node <uuid> — UUID of the node that this volume target belongs to.
--type <volume type> — type of the volume target, e.g. 'iscsi', 'fibre_channel'.
--property <key=value> — key/value property related to the type of this volume target. Can be specified multiple times.
--boot-index <boot index> — boot index of the volume target.
--volume-id <volume id> — ID of the volume associated with this target.
--extra <key=value> — record arbitrary key/value metadata. Can be specified multiple times.
volume target — UUID of the volume target.

This command is provided by the python-ironicclient plugin.

🎀 baremetal volume target show 🎀

Show baremetal volume target details.

openstack baremetal volume target show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--fields <field> [<field> ...]]
    <id>

-f <FORMATTER>, --format <FORMATTER> — the output format, defaults to table
-c COLUMN, --column COLUMN — specify the column(s) to include, can be repeated to show multiple columns
--noindent — whether to disable indenting the JSON
--prefix <PREFIX> — add a prefix to all variable names
--max-width <integer> — maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
--fit-width — fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
--print-empty — print empty table if there is no data to show.
--fields <field> — one or more volume target fields. Only these fields will be fetched from the server.
id — UUID of the volume target.

This command is provided by the python-ironicclient plugin.

🦋 baremetal volume target unset 🦋

Unset baremetal volume target properties.

openstack baremetal volume target unset
    [--extra <key>]
    [--property <key>]
    <volume
    target>

--extra <key> — extra to unset (repeat option to unset multiple extras)
--property <key> — property to unset on this baremetal volume target (repeat option to unset multiple properties).
volume target — UUID of the volume target.

This command is provided by the python-ironicclient plugin.

💜 Creating the Bare Metal service resources from file 💜

Okay so — it is possible to create a set of resources using their descriptions in JSON or YAML format. It can be done in one of two ways:

Using OpenStackClient bare metal plugin CLI's command openstack baremetal create:

$ openstack -h baremetal create
usage: openstack baremetal create [-h] <file> [<file> ...]

Create resources from files

positional arguments:
  <file>      File (.yaml or .json) containing descriptions of the
              resources to create. Can be specified multiple times.

Programmatically using the Python API:

ironicclient.v1.create_resources.create_resources(client: Client <#
ironicclient.v1.client.Client>, filenames: list[str]) -> None
       Create resources using their JSON or YAML descriptions.

       Parameters

              • client -- an instance of ironic client;

              • filenames -- a list of filenames containing JSON or
                YAML resources definitions.

       Raises ClientException if any operation during files
              processing/resource creation fails.

⭐ File containing Resource Descriptions ⭐

The resources to be created can be described either in JSON or YAML. A file ending with .json is assumed to contain valid JSON, and a file ending with .yaml is assumed to contain valid YAML. Specifying a file with any other extension leads to an error 🙈

The resources that can be created are chassis, nodes, port groups and ports. A chassis can contain nodes (and resources of nodes) definitions nested under "nodes" key. A node can contain port groups definitions nested under "portgroups", and ports definitions under "ports" keys. Ports can be also nested under port groups in "ports" key.

The schema used to validate the supplied data is the following:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "description": "Schema for ironic resources file",
    "type": "object",
    "properties": {
        "chassis": {
            "type": "array",
            "items": {
                "type": "object"
            }
        },
        "nodes": {
            "type": "array",
            "items": {
                "type": "object"
            }
        }
    },
    "additionalProperties": false
}

More detailed description of the creation process can be seen in the following sections.

🌈 Examples 🌈

Here is an example of the JSON file that can be passed to the create command:

{
    "chassis": [
        {
            "description": "chassis 3 in row 23",
            "nodes": [
                {
                    "name": "node-3",
                    "driver": "ipmi",
                    "portgroups": [
                        {
                            "name": "switch.cz7882.ports.1-2",
                            "ports": [
                                {
                                    "address": "ff:00:00:00:00:00"
                                },
                                {
                                    "address": "ff:00:00:00:00:01"
                                }
                            ]
                        }
                    ],
                    "ports": [
                        {
                            "address": "00:00:00:00:00:02"
                        },
                        {
                            "address": "00:00:00:00:00:03"
                        }
                    ],
                    "driver_info": {
                        "ipmi_address": "192.168.1.23",
                        "ipmi_username": "BmcUsername",
                        "ipmi_password": "BmcPassword",
                    }
                },
                {
                    "name": "node-4",
                    "driver": "ipmi",
                    "ports": [
                        {
                            "address": "00:00:00:00:00:04"
                        },
                        {
                            "address": "00:00:00:00:00:01"
                        }
                    ]
                }
            ]
        }
    ],
    "nodes": [
        {
            "name": "node-5",
            "driver": "ipmi",
            "chassis_uuid": "74d93e6e-7384-4994-a614-fd7b399b0785",
            "ports": [
                {
                    "address": "00:00:00:00:00:00"
                }
            ]
        },
        {
            "name": "node-6",
            "driver": "ipmi"
        }
    ]
}

🔥 Creation Process 🔥

The client deserializes the files' contents and validates that the top-level dictionary in each of them contains only "chassis" and/or "nodes" keys, and their values are lists. The creation process is aborted if any failure is encountered in this stage. The rest of the validation is done by the ironic-api service.
Each resource is created via issuing a POST request (with the resource's dictionary representation in the body) to the ironic-api service. In the case of nested resources ("nodes" key inside chassis, "portgroups" key inside nodes, "ports" key inside nodes or portgroups), the top-level resource is created first, followed by the sub-resources. For example, if a chassis contains a list of nodes, the chassis will be created first followed by the creation of each node. The same is true for ports and port groups described within nodes.
If a resource could not be created, it does not stop the entire process. Any sub-resources of the failed resource will not be created, but otherwise, the rest of the resources will be created if possible. Any failed resources will be mentioned in the response. 💀

💖 python-ironicclient Contributor Documentation 💖

🫶 Contributing to python-ironicclient 🫶

okay so if you're lowkey thinking "hmm I wanna contribute to the python-ironicclient project" — first of all, slay, love that for you 💅 — the following will help get you started. no cap.

🦋 #openstack-ironic on OFTC IRC Network 🦋

there is a very active chat channel at <irc://irc.oftc.net/#openstack-ironic> and honestly it's the main character of getting help. this is usually the best place to ask questions and find your way around. IRC stands for Internet Relay Chat (iykyk) and it is a way to chat online in real time. you can ask a question and come back later to read the answer in the log files. logs for the #openstack-ironic IRC channel are stored at <http://eavesdrop.openstack.org/irclogs/%23openstack-ironic/> ✨

🎀 Developer Certificate of Origin 🎀

in order to contribute to the python-ironicclient project, you need to adhere to the Developer Certificate of Origin <https://developercertificate.org/>. OpenStack utilizes the Developer Certificate of Origin (DCO) as a lightweight means to confirm that you are entitled to contribute the code you submit. this ensures that you are providing your contributions under the project's license and that you have the right to do so. periodt.

🌸 Project Hosting Details 🌸

Bug tracker — <https://bugs.launchpad.net/python-ironicclient>
Mailing list (prefix subjects with [ironic] for faster responses) — <http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss>
Code Hosting — <https://opendev.org/openstack/python-ironicclient>
Code Review — <https://review.opendev.org/#/q/status:open+project:openstack/python-ironicclient,n,z>

🌈 Testing 🌈

⭐ Python Guideline Enforcement ⭐

all code has to pass the pep8 style guideline to merge into OpenStack, fr fr — no vibes-based merges here, bestie. to validate the code against these guidelines you can run:

$ tox -e pep8

🧚 Unit Testing 🧚

it is strongly encouraged to run the unit tests locally under one or more test environments prior to submitting a patch. like, genuinely, do it — it's giving responsible. to run all the recommended environments sequentially and pep8 style guideline run:

$ tox

you can also selectively pick specific test environments by listing your chosen environments after a -e flag 👑

$ tox -e py3,pep8

Note: Tox sets up virtual environment and installs all necessary dependencies. Sharing the environment with devstack testing is not recommended due to conflicting configuration with system dependencies. 💀 don't do it.

🍓 Functional Testing 🍓

functional tests have been removed as of November 2024. gone, but not forgotten 🙈

👑 Full Ironic Client Python API Reference 👑

ironicclient

ironicclient package

Subpackages

ironicclient.common package

Subpackages

ironicclient.common.apiclient package

Submodules

ironicclient.common.apiclient.base module

Base utilities to build API operation managers and objects on top of. ✨

class ironicclient.common.apiclient.base.ManagerProtocol(*args, **kwargs) — Bases: Protocol

Minimal protocol for Resource's manager dependency.

client: Any

class ironicclient.common.apiclient.base.Resource(manager: ManagerProtocol, info: dict[str, Any], loaded: bool = False) — Bases: object

Base class for OpenStack resources (tenant, user, etc.).

This is pretty much just a bag for attributes. 👜 lowkey iconic honestly.

HUMAN_ID: bool = False
NAME_ATTR: str = 'name'
get() -> None — Support for lazy loading details.

Some clients, such as novaclient have the option to lazy load the details, details which can be loaded with this function.

property human_id: str | None — Human-readable ID which can be used for bash completion.
is_loaded() -> bool
set_loaded(val: bool) -> None
to_dict() -> dict[str, Any]

😭 ironicclient.common.apiclient.exceptions module 😭

Exception definitions. buckle up bestie, there's a lot of them and every single one is here 💅

exception ironicclient.common.apiclient.exceptions.AmbiguousEndpoints(endpoints: object | None = None) — Bases: EndpointException

Found more than one matching endpoint in Service Catalog.

exception ironicclient.common.apiclient.exceptions.AuthPluginOptionsMissing(opt_names: list[str]) — Bases: AuthorizationFailure

Auth plugin misses some options.

exception ironicclient.common.apiclient.exceptions.AuthSystemNotFound(auth_system: str) — Bases: AuthorizationFailure

User has specified an AuthSystem that is not installed.

exception ironicclient.common.apiclient.exceptions.AuthorizationFailure — Bases: ClientException

Cannot authorize API client.

exception ironicclient.common.apiclient.exceptions.BadGateway(message: str | None = None, details: str | None = None, response: Response | None = None, request_id: str | None = None, url: str | None = None, method: str | None = None, http_status: int | None = None) — Bases: HttpServerError

HTTP 502 - Bad Gateway.

The server was acting as a gateway or proxy and received an invalid response from the upstream server.

http_status: int = 502

message: str = 'Bad Gateway'

exception ironicclient.common.apiclient.exceptions.BadRequest(message: str | None = None, details: str | None = None, response: Response | None = None, request_id: str | None = None, url: str | None = None, method: str | None = None, http_status: int | None = None) — Bases: HTTPClientError

HTTP 400 - Bad Request.

The request cannot be fulfilled due to bad syntax.

http_status: int = 400

message: str = 'Bad Request'

exception ironicclient.common.apiclient.exceptions.ClientException — Bases: Exception

The base exception class for all exceptions this library raises. 💀 the mother of them all.

exception ironicclient.common.apiclient.exceptions.CommandError — Bases: ClientException

Error in CLI tool.

exception ironicclient.common.apiclient.exceptions.Conflict(message: str | None = None, details: str | None = None, response: Response | None = None, request_id: str | None = None, url: str | None = None, method: str | None = None, http_status: int | None = None) — Bases: HTTPClientError

HTTP 409 - Conflict.

Indicates that the request could not be processed because of conflict in the request, such as an edit conflict.

http_status: int = 409

message: str = 'Conflict'

exception ironicclient.common.apiclient.exceptions.ConnectionError — Bases: ClientException

Cannot connect to API service.

exception ironicclient.common.apiclient.exceptions.ConnectionRefused — Bases: ConnectionError

Connection refused while trying to connect to API service.

exception ironicclient.common.apiclient.exceptions.EndpointException — Bases: ClientException

Something is rotten in Service Catalog. 🌸 dramatic but true.

exception ironicclient.common.apiclient.exceptions.EndpointNotFound — Bases: EndpointException

Could not find requested endpoint in Service Catalog.

exception ironicclient.common.apiclient.exceptions.ExpectationFailed(message: str | None = None, details: str | None = None, response: Response | None = None, request_id: str | None = None, url: str | None = None, method: str | None = None, http_status: int | None = None) — Bases: HTTPClientError

HTTP 417 - Expectation Failed.

The server cannot meet the requirements of the Expect request-header field.

http_status: int = 417

message: str = 'Expectation Failed'

exception ironicclient.common.apiclient.exceptions.Forbidden(message: str | None = None, details: str | None = None, response: Response | None = None, request_id: str | None = None, url: str | None = None, method: str | None = None, http_status: int | None = None) — Bases: HTTPClientError

HTTP 403 - Forbidden.

The request was a valid request, but the server is refusing to respond to it.

http_status: int = 403

message: str = 'Forbidden'

exception ironicclient.common.apiclient.exceptions.GatewayTimeout(message: str | None = None, details: str | None = None, response: Response | None = None, request_id: str | None = None, url: str | None = None, method: str | None = None, http_status: int | None = None) — Bases: HttpServerError

HTTP 504 - Gateway Timeout.

The server was acting as a gateway or proxy and did not receive a timely response from the upstream server.

http_status: int = 504

message: str = 'Gateway Timeout'

exception ironicclient.common.apiclient.exceptions.Gone(message: str | None = None, details: str | None = None, response: Response | None = None, request_id: str | None = None, url: str | None = None, method: str | None = None, http_status: int | None = None) — Bases: HTTPClientError

HTTP 410 - Gone.

Indicates that the resource requested is no longer available and will not be available again.

http_status: int = 410

message: str = 'Gone'

exception ironicclient.common.apiclient.exceptions.HTTPClientError(message: str | None = None, details: str | None = None, response: Response | None = None, request_id: str | None = None, url: str | None = None, method: str | None = None, http_status: int | None = None) — Bases: HttpError

Client-side HTTP error.

Exception for cases in which the client seems to have erred.

message: str = 'HTTP Client Error'

exception ironicclient.common.apiclient.exceptions.HTTPRedirection(message: str | None = None, details: str | None = None, response: Response | None = None, request_id: str | None = None, url: str | None = None, method: str | None = None, http_status: int | None = None) — Bases: HttpError

HTTP Redirection.

message: str = 'HTTP Redirection'

exception ironicclient.common.apiclient.exceptions.HttpError(message: str | None = None, details: str | None = None, response: Response | None = None, request_id: str | None = None, url: str | None = None, method: str | None = None, http_status: int | None = None) — Bases: ClientException

The base exception class for all HTTP exceptions.

http_status: int = 0

message: str = 'HTTP Error'

exception ironicclient.common.apiclient.exceptions.HttpNotImplemented(message: str | None = None, details: str | None = None, response: Response | None = None, request_id: str | None = None, url: str | None = None, method: str | None = None, http_status: int | None = None) — Bases: HttpServerError

Like, the server literally either doesn't recognize the request method or it just doesn't have the range to fulfill it — no thoughts, head empty 🫠

http_status: int = 501

message: str = 'Not Implemented'

`exception ironicclient.common.apiclient.exceptions.HttpServerError(...)`

exception
ironicclient.common.apiclient.exceptions.HttpServerError(message: str | None = None, details: str | None = None, response: Response | None = None, request_id: str | None = None, url: str | None = None, method: str | None = None, http_status: int | None = None)

Bases: HttpError

Server-side HTTP error, bestie — the ✨parent✨ of all the 5xx meltdowns. It's for cases where the server is fully aware it has erred or is incapable of performing the request. Self-aware king behavior, honestly 👑

message: str = 'HTTP Server Error'

`exception ironicclient.common.apiclient.exceptions.HttpVersionNotSupported(...)`

exception
ironicclient.common.apiclient.exceptions.HttpVersionNotSupported(message: str | None = None, details: str | None = None, response: Response | None = None, request_id: str | None = None, url: str | None = None, method: str | None = None, http_status: int | None = None)

Bases: HttpServerError

HTTP 505 - HttpVersion Not Supported. The server doesn't support the HTTP protocol version used in the request — like bringing a vibe the server has simply never heard of 💀

http_status: int = 505

message: str = 'HTTP Version Not Supported'

`exception ironicclient.common.apiclient.exceptions.InternalServerError(...)`

exception
ironicclient.common.apiclient.exceptions.InternalServerError(message: str | None = None, details: str | None = None, response: Response | None = None, request_id: str | None = None, url: str | None = None, method: str | None = None, http_status: int | None = None)

Bases: HttpServerError

HTTP 500 - Internal Server Error. The generic one, given when no more specific message is suitable — aka the "it's giving nothing, and it's giving it loudly" error 😭

http_status: int = 500

message: str = 'Internal Server Error'

`exception ironicclient.common.apiclient.exceptions.LengthRequired(...)`

exception
ironicclient.common.apiclient.exceptions.LengthRequired(message: str | None = None, details: str | None = None, response: Response | None = None, request_id: str | None = None, url: str | None = None, method: str | None = None, http_status: int | None = None)

Bases: HTTPClientError

HTTP 411 - Length Required. The request didn't specify the length of its content, which the requested resource requires. Like showing up without your ID, girl 🪪

http_status: int = 411

message: str = 'Length Required'

`exception ironicclient.common.apiclient.exceptions.MethodNotAllowed(...)`

exception
ironicclient.common.apiclient.exceptions.MethodNotAllowed(message: str | None = None, details: str | None = None, response: Response | None = None, request_id: str | None = None, url: str | None = None, method: str | None = None, http_status: int | None = None)

Bases: HTTPClientError

HTTP 405 - Method Not Allowed. A request was made of a resource using a request method that resource does not support. Wrong door, wrong key, wrong era 🔑

http_status: int = 405

message: str = 'Method Not Allowed'

`exception ironicclient.common.apiclient.exceptions.MultipleChoices(...)`

exception
ironicclient.common.apiclient.exceptions.MultipleChoices(message: str | None = None, details: str | None = None, response: Response | None = None, request_id: str | None = None, url: str | None = None, method: str | None = None, http_status: int | None = None)

Bases: HTTPRedirection

HTTP 300 - Multiple Choices. Indicates multiple options for the resource that the client may follow — so many paths, so little commitment 🦋

http_status: int = 300

message: str = 'Multiple Choices'

`exception ironicclient.common.apiclient.exceptions.NoUniqueMatch`

Bases: ClientException

Multiple entities found instead of one. Not a match, a situation — the search said "one (1)" and the database said "bestie, we have options" 🙈

`exception ironicclient.common.apiclient.exceptions.NotAcceptable(...)`

exception
ironicclient.common.apiclient.exceptions.NotAcceptable(message: str | None = None, details: str | None = None, response: Response | None = None, request_id: str | None = None, url: str | None = None, method: str | None = None, http_status: int | None = None)

Bases: HTTPClientError

HTTP 406 - Not Acceptable. The requested resource is only capable of generating content that isn't acceptable according to the Accept headers sent in the request. It can serve you, it just refuses to serve you like that 💅

http_status: int = 406

message: str = 'Not Acceptable'

`exception ironicclient.common.apiclient.exceptions.NotFound(...)`

exception
ironicclient.common.apiclient.exceptions.NotFound(message: str | None = None, details: str | None = None, response: Response | None = None, request_id: str | None = None, url: str | None = None, method: str | None = None, http_status: int | None = None)

Bases: HTTPClientError

HTTP 404 - Not Found. The classic ✨iconic✨ one: the requested resource could not be found, but it may be available again in the future. So like, don't block them, they might come back 😭

http_status: int = 404

message: str = 'Not Found'

`exception ironicclient.common.apiclient.exceptions.PaymentRequired(...)`

exception
ironicclient.common.apiclient.exceptions.PaymentRequired(message: str | None = None, details: str | None = None, response: Response | None = None, request_id: str | None = None, url: str | None = None, method: str | None = None, http_status: int | None = None)

Bases: HTTPClientError

HTTP 402 - Payment Required. Reserved for future use. That's literally it, that's the whole personality — a ghost, a placeholder, a mysterious queen who never shows up 👻

http_status: int = 402

message: str = 'Payment Required'

`exception ironicclient.common.apiclient.exceptions.PreconditionFailed(...)`

exception
ironicclient.common.apiclient.exceptions.PreconditionFailed(message: str | None = None, details: str | None = None, response: Response | None = None, request_id: str | None = None, url: str | None = None, method: str | None = None, http_status: int | None = None)

Bases: HTTPClientError

HTTP 412 - Precondition Failed. The server does not meet one of the preconditions that the requester put on the request. You set boundaries, the server did not respect them 🚩

http_status: int = 412

message: str = 'Precondition Failed'

`exception ironicclient.common.apiclient.exceptions.ProxyAuthenticationRequired(...)`

exception
ironicclient.common.apiclient.exceptions.ProxyAuthenticationRequired(message: str | None = None, details: str | None = None, response: Response | None = None, request_id: str | None = None, url: str | None = None, method: str | None = None, http_status: int | None = None)

Bases: HTTPClientError

HTTP 407 - Proxy Authentication Required. The client has to authenticate itself with the proxy first. The middleman wants your ID before you get through the door ngl 🚪

http_status: int = 407

message: str = 'Proxy Authentication Required'

`exception ironicclient.common.apiclient.exceptions.RequestEntityTooLarge(*args: Any, **kwargs: Any)`

Bases: HTTPClientError

HTTP 413 - Request Entity Too Large. The request is larger than the server is willing or able to process. Your girl packed the entire luggage set for a weekend trip 🧳

http_status: int = 413

message: str = 'Request Entity Too Large'

`exception ironicclient.common.apiclient.exceptions.RequestTimeout(...)`

exception
ironicclient.common.apiclient.exceptions.RequestTimeout(message: str | None = None, details: str | None = None, response: Response | None = None, request_id: str | None = None, url: str | None = None, method: str | None = None, http_status: int | None = None)

Bases: HTTPClientError

HTTP 408 - Request Timeout. The server timed out waiting for the request. Left on read, technically 💀

http_status: int = 408

message: str = 'Request Timeout'

`exception ironicclient.common.apiclient.exceptions.RequestUriTooLong(...)`

exception
ironicclient.common.apiclient.exceptions.RequestUriTooLong(message: str | None = None, details: str | None = None, response: Response | None = None, request_id: str | None = None, url: str | None = None, method: str | None = None, http_status: int | None = None)

Bases: HTTPClientError

HTTP 414 - Request-URI Too Long. The URI provided was too long for the server to process — a URL with main character energy that nobody asked to be that long 📏

http_status: int = 414

message: str = 'Request-URI Too Long'

`exception ironicclient.common.apiclient.exceptions.RequestedRangeNotSatisfiable(...)`

exception
ironicclient.common.apiclient.exceptions.RequestedRangeNotSatisfiable(message: str | None = None, details: str | None = None, response: Response | None = None, request_id: str | None = None, url: str | None = None, method: str | None = None, http_status: int | None = None)

Bases: HTTPClientError

HTTP 416 - Requested Range Not Satisfiable. The client asked for a portion of the file, but the server cannot supply that portion. Bestie the slice you want does not exist 🍰

http_status: int = 416

message: str = 'Requested Range Not Satisfiable'

`exception ironicclient.common.apiclient.exceptions.ServiceUnavailable(...)`

exception
ironicclient.common.apiclient.exceptions.ServiceUnavailable(message: str | None = None, details: str | None = None, response: Response | None = None, request_id: str | None = None, url: str | None = None, method: str | None = None, http_status: int | None = None)

Bases: HttpServerError

HTTP 503 - Service Unavailable. The server is currently unavailable. Not ghosting you on purpose (probably), it's just ✨going through something✨

http_status: int = 503

message: str = 'Service Unavailable'

`exception ironicclient.common.apiclient.exceptions.Unauthorized(...)`

exception
ironicclient.common.apiclient.exceptions.Unauthorized(message: str | None = None, details: str | None = None, response: Response | None = None, request_id: str | None = None, url: str | None = None, method: str | None = None, http_status: int | None = None)

Bases: HTTPClientError

HTTP 401 - Unauthorized. Similar to 403 Forbidden, but specifically for when authentication is required and has failed or has not yet been provided. Like, do you even go here? 🪪

http_status: int = 401

message: str = 'Unauthorized'

`exception ironicclient.common.apiclient.exceptions.UnprocessableEntity(...)`

exception
ironicclient.common.apiclient.exceptions.UnprocessableEntity(message: str | None = None, details: str | None = None, response: Response | None = None, request_id: str | None = None, url: str | None = None, method: str | None = None, http_status: int | None = None)

Bases: HTTPClientError

HTTP 422 - Unprocessable Entity. The request was well-formed but was unable to be followed due to semantic errors. Grammatically perfect, spiritually incorrect 😭

http_status: int = 422

message: str = 'Unprocessable Entity'

`exception ironicclient.common.apiclient.exceptions.UnsupportedMediaType(...)`

exception
ironicclient.common.apiclient.exceptions.UnsupportedMediaType(message: str | None = None, details: str | None = None, response: Response | None = None, request_id: str | None = None, url: str | None = None, method: str | None = None, http_status: int | None = None)

Bases: HTTPClientError

HTTP 415 - Unsupported Media Type. The request entity has a media type which the server or resource does not support. Wrong format, no vibes passed the check 🎞️

http_status: int = 415

message: str = 'Unsupported Media Type'

`exception ironicclient.common.apiclient.exceptions.UnsupportedVersion`

Bases: ClientException

User is trying to use an unsupported version of the API. Time traveler behavior, and the timeline said no 🕰️

`exception ironicclient.common.apiclient.exceptions.ValidationError`

Bases: ClientException

Error in validation on the API client side — caught it in-house before it ever left the group chat, love that for us ✅

`ironicclient.common.apiclient.exceptions.from_response(response: Response, method: str, url: str) -> HttpError`

ironicclient.common.apiclient.exceptions.from_response(response: Response, method: str, url: str) -> HttpError <#ironicclient.common.apiclient.exceptions.HttpError>

Returns an instance of HttpError or a subclass, based on the response. The little matcher that looks at your response and goes "oh girl, I know exactly which one of these you are" 💅

Parameters

response — the requests.Response instance, slay 💅
- method — the HTTP method used for the request
- url — the URL used for the request

✨ Module contents ✨

Submodules — okay bestie, this is where it gets spicy, buckle up 🌈

`ironicclient.common.base` module 🧱

Base utilities to build API operation managers and objects on top of. Literally the foundation, the main character of the whole operation 💅

class ironicclient.common.base.CreateManager(api: SessionClient)

Bases: Manager[ResourceT] — provides creation operations with a particular API. Iconic behavior only ✨

create(os_ironic_api_version: str | None = None, global_request_id: str | None = None, **kwargs: Any) -> ResourceT | None

Create a resource based on a kwargs dictionary of attributes. So you hand it a bag of attributes and it makes a thing 🫶

Parameters (the receipts):

kwargs — a dictionary containing the attributes of the resource that will be created.
os_ironic_api_version — string version (e.g. "1.35") to use for the request. If not specified, the client's default is used.
global_request_id — string containing the global request ID header value (in form "req-<UUID>") to use for the request.

Raises exc.InvalidAttribute — for invalid attributes that are not needed to create the resource. So like, don't pass junk, bestie 😭

class ironicclient.common.base.Manager(api: SessionClient)

Bases: Generic[ResourceT] — provides CRUD operations with a particular API. The full alphabet of doing stuff, no cap 🔥

resource_class — abstract property, type type[ResourceT]. It's the resource class. That's literally the whole vibe.

class ironicclient.common.base.Resource(manager: ManagerProtocol, info: dict[str, Any], loaded: bool = False)

Bases: Resource — represents a particular instance of an object (tenant, user, etc). This is pretty much just a bag for attributes, lowkey 🎀

to_dict() -> dict[str, Any] — turns it into a dict, obviously.

getid(obj: str | Resource) -> str

A lil wrapper to get an object's ID. Abstracts the common pattern of allowing both an object or an object's ID (UUID) as a parameter when dealing with relationships. Flexible queen behavior 👑

`ironicclient.common.filecache` module 🗂️

retrieve_data(host: str, port: str | int, expiry: int | None = None) -> str | None

Retrieve the version stored for an ironic 'host', if it's not stale. It checks to see if there is valid cached data for the host/port combination and returns that if it isn't stale — literally a vibe check on your cache 🦋

param host: The host that we need to retrieve data for
param port: The port on the host that we need to retrieve data for
param expiry: The age in seconds before cached data is deemed invalid

save_data(host: str, port: str | int, data: str) -> None

Save 'data' for a particular 'host' in the appropriate cache dir. Put it in the vault bestie 🔐

param host: The host that we need to save data for
param port: The port on the host that we need to save data for
param data: The data we want saved

`ironicclient.common.http` module 🌐

class ironicclient.common.http.SessionClient(os_ironic_api_version: str | list[str], api_version_select_state: str, max_retries: int | None, retry_interval: int | None, **kwargs: Any)

Bases: VersionNegotiationMixin, LegacyJsonAdapter — HTTP client based on Keystone client session. The whole connection moment 💫

json_request(method: str, url: str, **kwargs: Any) -> tuple[Response, dict[str, Any] | list[Any] | bytes | None]
raw_request(method: str, url: str, **kwargs: dict[str, str]) -> Response

class ironicclient.common.http.VersionNegotiationMixin

Bases: object

api_version_select_state: str
negotiate_version(conn: Session, resp: Response | None) -> str — Negotiate the server version. Assumption: called after receiving a 406 error when doing a request. Parameters:
- conn — A connection object
- resp — The response object from http request
os_ironic_api_version: str | list[str]

get_server(url: str | None) -> tuple[str | None, str | None]

Extract and return the server & port. Finders keepers 🧚

with_retries(func: Callable[[...], _RT]) -> Callable[[...], _RT]

Wrapper for _http_request adding support for retries. Because sometimes you gotta try again, fr fr 💀

`ironicclient.common.i18n` module 🌍

That's it. That's the module. Empty page, no notes 🙈

`ironicclient.common.utils` module 🛠️

class ironicclient.common.utils.HashColumn(value: _T)

Bases: FormattableColumn[Any]

human_readable() -> str | None — Return a basic human readable version of the data. Making it make sense for the girlies 💅

class ironicclient.common.utils.ListCommandArgs(*args, **kwargs)

Bases: Protocol — Protocol for parsed args passed to list commands (marker, limit, etc). The whole "here's what you typed" situation ✨

detail: bool
fields: list[list[str]] | None
limit: int | None
marker: str | None
sort_dir: str | None
sort_key: str | None

args_array_to_dict(kwargs: dict[str, Any], key_to_convert: str) -> dict[str, Any]

Convert the value in a dictionary entry to a dictionary. From the kwargs dictionary, it converts the value of the key_to_convert entry from a list of key-value pairs to a dictionary. Glow-up for data structures 🦋

Parameters:

kwargs — a dictionary
key_to_convert — the key (in kwargs), whose value is expected to be a list of key=value strings. This value will be converted to a dictionary.

Returns: kwargs, the (modified) dictionary.

args_array_to_patch(op: str, attributes: list[str]) -> list[dict[str, Any]]

No description in the source, bestie — it's giving mystery, but that's the signature, keep it exact 🎀

bool_argument_value(arg_name: str, bool_str: str, strict: bool = True, default: bool = False) -> bool

Returns the Boolean represented by bool_str. Returns the Boolean value for the argument named arg_name. The value is represented by the string bool_str. If the string is an invalid Boolean string: if strict is True, a CommandError exception is raised; otherwise the default value is returned. Yes/no but make it dramatic 😭

Parameters:

arg_name — The name of the argument
bool_str — The string representing a Boolean value
strict — Used if the string is invalid. If True, raises an exception. If False, returns the default value.
default — The default value to return if the string is invalid and not strict

Returns: the Boolean value represented by bool_str or the default value if bool_str is invalid and strict is False.

Raises CommandError — if bool_str is an invalid Boolean string. So like, keep your booleans legal or catch hands 💀

check_api_version_support(current_version: str | list[str], required_version: str) -> bool

Check if the current API version supports a required version.

Parameters:

current_version — Current API version being used (e.g. "1.112")
required_version — Minimum API version required (e.g. "1.112")

Returns: True if the current version meets the requirement, False otherwise. Also returns True if the version format is invalid (let the server decide). We love a delegation moment 👑

check_empty_arg(arg: str, arg_descriptor: str) -> None

No description in the source — but there it is, untouched, exactly as written ✨

check_for_invalid_fields(fields: list[str] | None, valid_fields: list[str]) -> None

Check for invalid fields. The bouncer at the club of arguments 🚪

Parameters:

fields — A list of fields specified by the user.
valid_fields — A list of valid fields.

Raises CommandError — if invalid fields were specified by the user. You're not on the list, babes 💅

Generate common filters for any list request. One function to serve all the list girlies 🌸

Parameters:

marker — entity ID from which to start returning entities.
limit — maximum number of entities to return.
sort_key — field to use for sorting.
sort_dir — direction of sorting: 'asc' or 'desc'.
fields — a list with a specified set of fields of the resource to be returned.
detail — Boolean, True to return detailed information. This parameter can be used for resources which accept 'detail' as a URL parameter.

Returns: list of string filters.

common_params_for_list(args: ListCommandArgs, fields: list[str], field_labels: list[str]) -> dict[str, Any]

Generate the 'params' dict that is common for every 'list' command. Teamwork makes the dream work 🫶

Parameters:

args — arguments from command line.
fields — possible fields for sorting.
field_labels — possible field labels for sorting.

Returns: a dict with params to pass to the client method.

convert_list_props_to_comma_separated(data: dict[str, Any], props: list[str] | None = None) -> dict[str, Any]

Convert the list-type properties to comma-separated strings. Lists into vibes 🦋

Parameters:

data — the input dict object.
props — the properties whose values will be converted. Defaults to None to convert all list-type properties of the input.

Returns: the result dict instance.

format_hash(data: dict[str, Any] | None, prefix: str = '') -> str | None

No description in the source, so I'm not inventing one — signature only, bestie ✨

`get_from_stdin` 🫶

ironicclient.common.utils.get_from_stdin(info_desc: str) -> str

Okay so this one is literally just "read stuff from stdin" — it's giving very demure, very mindful. ✨

Parameters

info_desc — a string description of the info you want (so it can tell you what it's asking for, slay)

Raises

InvalidAttribute if there was a problem reading from stdin 😭

Returns

the string that was read from stdin 💖

`get_json_data` 🎀

ironicclient.common.utils.get_json_data(data: bytes) -> dict[str, Any] | list[Any] | None

Checks whether the binary data is JSON, and parses it if it is. vibe check on your bytes fr fr.

Parameters

data — raw bytes to parse (e.g. the response body)

Returns

the parsed dict or list if it's valid JSON, otherwise None

`handle_json_arg` 🦋

ironicclient.common.utils.handle_json_arg(json_arg: str | None, info_desc: str) -> list[Any] | dict[str, Any] | None

Reads a JSON argument from stdin, a file, or a plain string. three ways to serve looks 👑

Parameters

json_arg — may be a file name containing the JSON, a JSON string, or '-' which means "bestie read it from standard input"
info_desc — a string description of the desired information

Returns

a list or dictionary parsed from JSON, or None if json_arg is empty (like, e.g. after reading from stdin with no input — tragic but valid)

Raises

InvalidAttribute if the argument can't be parsed 💀

`handle_json_or_file_arg` 🌸

ironicclient.common.utils.handle_json_or_file_arg(json_arg: str) -> list[Any] | dict[str, Any]

Tries to read the JSON argument from a file or from a string. lowkey the same energy as above but it always gives you something back.

Parameters

json_arg — may be a file name containing the YAML or JSON, or a JSON string

Returns

a list or dictionary parsed from JSON

Raises

InvalidAttribute if the argument can't be parsed 😤

`key_value_pairs_to_dict` 🍓

ironicclient.common.utils.key_value_pairs_to_dict(key_value_pairs: list[str] | None) -> dict[str, Any]

Turns a list of key-value pairs into a dictionary. glow-up of the century honestly.

Parameters

key_value_pairs — a list of strings, and each string is in the form <key>=<value>

Returns

a dictionary, possibly empty (yes, empty dicts are still valid and we love them)

`make_configdrive` 🧚

ironicclient.common.utils.make_configdrive(path: str) -> bytes

Makes the config drive file. arts and crafts but make it infrastructure ✨

Parameters

path — the directory containing the config drive files

Returns

a gzipped and base64 encoded configdrive string

`poll` 💅

ironicclient.common.utils.poll(timeout: int | float, poll_interval: int | float, poll_delay_function: Callable[[int | float], Any] | None, timeout_message: str | Callable[[], str]) -> Iterator[int]

No description in the docs — just the signature, sitting there, mysterious, main character energy. iykyk. 🔥

`split_and_deserialize` 🌈

ironicclient.common.utils.split_and_deserialize(string: str) -> tuple[str, Any]

Splits a string and tries to JSON-deserialize it.

So it takes a string in the KEY=VALUE format, splits it (using '=' as the separator), and tries to JSON-deserialize the VALUE. not me doing string surgery 🫶

Returns

a tuple of (key, value)

`tempdir` ⭐

ironicclient.common.utils.tempdir(suffix: str | None = None, prefix: str | None = None, dir: str | None = None) -> Generator[str, None, None]

Another one with no description — just vibes and a generator. iconic honestly.

Module contents 💜

`ironicclient.osc` package 🎀

Subpackages

`ironicclient.osc.v1` package ✨

Submodules

`ironicclient.osc.v1.baremetal_allocation` module 🦋

class `ironicclient.osc.v1.baremetal_allocation.CreateBaremetalAllocation(app: App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: ShowOne

Creates a new baremetal allocation. 🎀 making a whole allocation, no big deal.

get_parser(prog_name: str) -> ArgumentParser — returns an argparse.ArgumentParser
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_allocation.CreateBaremetalAllocation (WARNING)>
take_action(parsed_args: Namespace) -> tuple[tuple[str, ...], tuple[Any, ...]] — runs the command. Returns a tuple containing the column names and an iterable containing the data to be listed.

class `ironicclient.osc.v1.baremetal_allocation.DeleteBaremetalAllocation(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: Command

Unregisters baremetal allocation(s). bye bestie 💅

get_parser(prog_name: str) -> ArgumentParser — returns an argparse.ArgumentParser
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_allocation.DeleteBaremetalAllocation (WARNING)>
take_action(parsed_args: Namespace) -> None — "override to do something useful." the returned value will be returned by the program.

class `ironicclient.osc.v1.baremetal_allocation.ListBaremetalAllocation(app: App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: Lister

Lists the baremetal allocations. 👑

get_parser(prog_name: str) -> ArgumentParser — returns an argparse.ArgumentParser
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_allocation.ListBaremetalAllocation (WARNING)>
take_action(parsed_args: Namespace) -> tuple[Sequence[str], Iterable[Any]] — runs the command. Returns a tuple containing the column names and an iterable containing the data to be listed.

class `ironicclient.osc.v1.baremetal_allocation.SetBaremetalAllocation(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: Command

Sets baremetal allocation properties. glow-up time ⭐

get_parser(prog_name: str) -> ArgumentParser — returns an argparse.ArgumentParser
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_allocation.SetBaremetalAllocation (WARNING)>
take_action(parsed_args: Namespace) -> None — "override to do something useful." the returned value will be returned by the program.

class `ironicclient.osc.v1.baremetal_allocation.ShowBaremetalAllocation(app: App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: ShowOne

Shows baremetal allocation details. the receipts, basically 🧾✨

get_parser(prog_name: str) -> ArgumentParser — returns an argparse.ArgumentParser
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_allocation.ShowBaremetalAllocation (WARNING)>
take_action(parsed_args: Namespace) -> tuple[tuple[str, ...], tuple[Any, ...]] — runs the command. Returns a tuple containing the column names and an iterable containing the data to be listed.

class `ironicclient.osc.v1.baremetal_allocation.UnsetBaremetalAllocation(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: Command

Unsets baremetal allocation properties. undoing, but make it chic 🙈

get_parser(prog_name: str) -> ArgumentParser — returns an argparse.ArgumentParser
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_allocation.UnsetBaremetalAllocation (WARNING)>
take_action(parsed_args: Namespace) -> None — "override to do something useful." the returned value will be returned by the program.

`ironicclient.osc.v1.baremetal_chassis` module 🎀

class `ironicclient.osc.v1.baremetal_chassis.CreateBaremetalChassis(app: App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: ShowOne

Creates a new chassis. 🦋

get_parser(prog_name: str) -> ArgumentParser — returns an argparse.ArgumentParser
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_chassis.CreateBaremetalChassis (WARNING)>
take_action(parsed_args: Namespace) -> tuple[tuple[str, ...], tuple[Any, ...]] — runs the command. Returns a tuple containing the column names and an iterable containing the data to be listed.

class `ironicclient.osc.v1.baremetal_chassis.DeleteBaremetalChassis(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: Command

Deletes a chassis. it's not personal, it's just cleanup 💅

get_parser(prog_name: str) -> ArgumentParser — returns an argparse.ArgumentParser
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_chassis.DeleteBaremetalChassis (WARNING)>
take_action(parsed_args: Namespace) -> None — "override to do something useful." the returned value will be returned by the program.

class `ironicclient.osc.v1.baremetal_chassis.ListBaremetalChassis(app: App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: Lister

Lists the chassis. all of them. every single one. 👑

get_parser(prog_name: str) -> ArgumentParser — returns an argparse.ArgumentParser
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_chassis.ListBaremetalChassis (WARNING)>
take_action(parsed_args: Namespace) -> tuple[Sequence[str], Iterable[Any]] — runs the command. Returns a tuple containing the column names and an iterable containing the data to be listed.

class `ironicclient.osc.v1.baremetal_chassis.SetBaremetalChassis(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: Command

Sets chassis properties. ✨

get_parser(prog_name: str) -> ArgumentParser — returns an argparse.ArgumentParser
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_chassis.SetBaremetalChassis (WARNING)>
take_action(parsed_args: Namespace) -> None — "override to do something useful." the returned value will be returned by the program.

class `ironicclient.osc.v1.baremetal_chassis.ShowBaremetalChassis(app: App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: ShowOne

Shows chassis details. 🎀

get_parser(prog_name: str) -> ArgumentParser — returns an argparse.ArgumentParser
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_chassis.ShowBaremetalChassis (WARNING)>
take_action(parsed_args: Namespace) -> tuple[tuple[str, ...], tuple[Any, ...]] — runs the command.

Return a tuple containing the column names and an iterable containing the data to be listed. (yes, this is the same line you've seen like eight times now — the OSC command classes are very much copy my homework but change it slightly energy, and honestly? we respect the consistency 💅)

`class ironicclient.osc.v1.baremetal_chassis.UnsetBaremetalChassis(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: Command <#ironicclient.osc.command.Command>

Unset chassis properties. i.e. yeet the properties off a chassis, bestie 🫶

get_parser(prog_name: str) -> ArgumentParser — Return an argparse.ArgumentParser. that's it, that's the whole job ✨
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_chassis.UnsetBaremetalChassis (WARNING)> — the class logger, sitting at WARNING level, minding its own business 💀
take_action(parsed_args: Namespace) -> None — Override to do something useful. The returned value will be returned by the program.

🦋 `ironicclient.osc.v1.baremetal_conductor` module

`class ironicclient.osc.v1.baremetal_conductor.ListBaremetalConductor(app: App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: Lister <#ironicclient.osc.command.Lister>

List baremetal conductors 👑 (the whole roster, bestie)

get_parser(prog_name: str) -> ArgumentParser — Return an argparse.ArgumentParser.
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_conductor.ListBaremetalConductor (WARNING)>
take_action(parsed_args: Namespace) -> tuple[Sequence[str], Iterable[Any]] — Run command. Return a tuple containing the column names and an iterable containing the data to be listed. same drill, every single time fr fr

`class ironicclient.osc.v1.baremetal_conductor.ShowBaremetalConductor(app: App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: ShowOne <#ironicclient.osc.command.ShowOne>

Show baremetal conductor details 🔍 the full dossier on one (1) conductor

get_parser(prog_name: str) -> ArgumentParser — Return an argparse.ArgumentParser.
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_conductor.ShowBaremetalConductor (WARNING)>
take_action(parsed_args: Namespace) -> tuple[Sequence[str], Iterable[Any]] — Run command. Return a tuple containing the column names and an iterable containing the data to be listed.

🌸 `ironicclient.osc.v1.baremetal_create` module

`class ironicclient.osc.v1.baremetal_create.CreateBaremetal(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: Command <#ironicclient.osc.command.Command>

Create resources from files. point it at a file, get resources — extremely giving "load the preset" energy 🎀

get_parser(prog_name: str) -> ArgumentParser — Return an argparse.ArgumentParser.
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_create.CreateBaremetal (WARNING)>
take_action(parsed_args: Namespace) -> None — Override to do something useful. The returned value will be returned by the program.

🧚 `ironicclient.osc.v1.baremetal_deploy_template` module

`class ironicclient.osc.v1.baremetal_deploy_template.CreateBaremetalDeployTemplate(app: App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: ShowOne <#ironicclient.osc.command.ShowOne>

Create a new deploy template ✨ brand new template, just dropped

get_parser(prog_name: str) -> ArgumentParser — Return an argparse.ArgumentParser.
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_deploy_template.CreateBaremetalDeployTemplate (WARNING)>
take_action(parsed_args: Namespace) -> tuple[tuple[str, ...], tuple[Any, ...]] — Run command. Return a tuple containing the column names and an iterable containing the data to be listed. (note the extra-tuple-y return type here — yes it's different from all the others, no we're not going to question it 💀)

`class ironicclient.osc.v1.baremetal_deploy_template.DeleteBaremetalDeployTemplate(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: Command <#ironicclient.osc.command.Command>

Delete deploy template(s). 🗑️ plural, bestie — it'll take out more than one if you ask nicely

get_parser(prog_name: str) -> ArgumentParser — Return an argparse.ArgumentParser.
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_deploy_template.DeleteBaremetalDeployTemplate (WARNING)>
take_action(parsed_args: Namespace) -> None — Override to do something useful. The returned value will be returned by the program.

`class ironicclient.osc.v1.baremetal_deploy_template.ListBaremetalDeployTemplate(app: App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: Lister <#ironicclient.osc.command.Lister>

List baremetal deploy templates. 📋

get_parser(prog_name: str) -> ArgumentParser — Return an argparse.ArgumentParser.
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_deploy_template.ListBaremetalDeployTemplate (WARNING)>
take_action(parsed_args: Namespace) -> tuple[Sequence[str], Iterable[Any]] — Run command. Return a tuple containing the column names and an iterable containing the data to be listed.

`class ironicclient.osc.v1.baremetal_deploy_template.SetBaremetalDeployTemplate(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: Command <#ironicclient.osc.command.Command>

Set baremetal deploy template properties. 🎯 poke the properties, make them yours

get_parser(prog_name: str) -> ArgumentParser — Return an argparse.ArgumentParser.
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_deploy_template.SetBaremetalDeployTemplate (WARNING)>
take_action(parsed_args: Namespace) -> None — Override to do something useful. The returned value will be returned by the program.

`class ironicclient.osc.v1.baremetal_deploy_template.ShowBaremetalDeployTemplate(app: App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: ShowOne <#ironicclient.osc.command.ShowOne>

Show baremetal deploy template details. 🔎 the full tea on exactly one template

get_parser(prog_name: str) -> ArgumentParser — Return an argparse.ArgumentParser.
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_deploy_template.ShowBaremetalDeployTemplate (WARNING)>
take_action(parsed_args: Namespace) -> tuple[tuple[str, ...], tuple[Any, ...]] — Run command. Return a tuple containing the column names and an iterable containing the data to be listed.

`class ironicclient.osc.v1.baremetal_deploy_template.UnsetBaremetalDeployTemplate(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: Command <#ironicclient.osc.command.Command>

Unset baremetal deploy template properties. 🙈 the opposite of Set, obviously — properties are leaving the chat

get_parser(prog_name: str) -> ArgumentParser — Return an argparse.ArgumentParser.
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_deploy_template.UnsetBaremetalDeployTemplate (WARNING)>
take_action(parsed_args: Namespace) -> None — Override to do something useful. The returned value will be returned by the program.

🔥 `ironicclient.osc.v1.baremetal_driver` module

`class ironicclient.osc.v1.baremetal_driver.ListBaremetalDriver(app: App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: Lister <#ironicclient.osc.command.Lister>

List the enabled drivers. 👑 the ones actually turned on, not the whole catalogue

get_parser(prog_name: str) -> ArgumentParser — Return an argparse.ArgumentParser.
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_driver.ListBaremetalDriver (WARNING)>
take_action(parsed_args: Namespace) -> tuple[Sequence[str], Iterable[Any]] — Run command. Return a tuple containing the column names and an iterable containing the data to be listed.

`class ironicclient.osc.v1.baremetal_driver.ListBaremetalDriverProperty(app: App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: Lister <#ironicclient.osc.command.Lister>

List the driver properties. 🧾

get_parser(prog_name: str) -> ArgumentParser — Return an argparse.ArgumentParser.
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_driver.ListBaremetalDriverProperty (WARNING)>
take_action(parsed_args: Namespace) -> tuple[Sequence[str], Iterable[Any]] — Run command. Return a tuple containing the column names and an iterable containing the data to be listed.

`class ironicclient.osc.v1.baremetal_driver.ListBaremetalDriverRaidProperty(app: App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: Lister <#ironicclient.osc.command.Lister>

List a driver's RAID logical disk properties. 💽 very specific, very niche, very slay

get_parser(prog_name: str) -> ArgumentParser — Return an argparse.ArgumentParser.
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_driver.ListBaremetalDriverRaidProperty (WARNING)>
take_action(parsed_args: Namespace) -> tuple[Sequence[str], Iterable[Any]] — Run command. Return a tuple containing the column names and an iterable containing the data to be listed.

`class ironicclient.osc.v1.baremetal_driver.PassthruCallBaremetalDriver(app: App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: ShowOne <#ironicclient.osc.command.ShowOne>

Call a vendor passthru method for a driver. 📞 "passthru" is literally right there in the name — you're calling straight through to the vendor's own method, iykyk

get_parser(prog_name: str) -> ArgumentParser — Return an argparse.ArgumentParser.
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_driver.PassthruCallBaremetalDriver (WARNING)>
take_action(parsed_args: Namespace) -> tuple[Sequence[str], Iterable[Any]] — Run command. Return a tuple containing the column names and an iterable containing the data to be listed.

`class ironicclient.osc.v1.baremetal_driver.PassthruListBaremetalDriver(app: App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: Lister <#ironicclient.osc.command.Lister>

List available vendor passthru methods for a driver. 🗂️ the menu of what you're allowed to call

get_parser(prog_name: str) -> ArgumentParser — Return an argparse.ArgumentParser.
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_driver.PassthruListBaremetalDriver (WARNING)>
take_action(parsed_args: Namespace) -> tuple[Sequence[str], Iterable[Any]] — runs the command, bestie 💅 returns a tuple with the column names plus an iterable holding all the data to be listed.

🌸 `ironicclient.osc.v1.baremetal_inspection_rule` module

Okay so this module is literally the inspection-rules era — create 'em, delete 'em, list 'em, set 'em, show 'em, unset 'em. Full cycle, no notes ✨

class ironicclient.osc.v1.baremetal_inspection_rule.CreateBaremetalInspectionRule(app: App, app_args: Namespace | None, cmd_name: str | None = None) — bases: ShowOne <#ironicclient.osc.command.ShowOne>. Does exactly what it says on the tin: Create a new rule 🎀
- get_parser(prog_name: str) -> ArgumentParser — hands you back an argparse.ArgumentParser.
- log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_inspection_rule.CreateBaremetalInspectionRule (WARNING)> — the class's very own logger, living at WARNING level.
- take_action(parsed_args: Namespace) -> tuple[tuple[str, ...], tuple[Any, ...]] — runs the command. Returns a tuple with the column names and an iterable containing the data to be listed.
class ironicclient.osc.v1.baremetal_inspection_rule.DeleteBaremetalInspectionRule(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None) — bases: Command <#ironicclient.osc.command.Command>. Delete rule(s). plural, so go off 👑
- get_parser(prog_name: str) -> ArgumentParser — returns an argparse.ArgumentParser.
- log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_inspection_rule.DeleteBaremetalInspectionRule (WARNING)>
- take_action(parsed_args: Namespace) -> None — described as "Override to do something useful", and the returned value will be returned by the program.
class ironicclient.osc.v1.baremetal_inspection_rule.ListBaremetalInspectionRule(app: App, app_args: Namespace | None, cmd_name: str | None = None) — bases: Lister <#ironicclient.osc.command.Lister>. List baremetal rules. the main character of scrollable output 🦋
- get_parser(prog_name: str) -> ArgumentParser — returns an argparse.ArgumentParser.
- log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_inspection_rule.ListBaremetalInspectionRule (WARNING)>
- take_action(parsed_args: Namespace) -> tuple[Sequence[str], Iterable[Any]] — runs the command. Returns a tuple of column names and an iterable containing the data to be listed.
class ironicclient.osc.v1.baremetal_inspection_rule.SetBaremetalInspectionRule(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None) — bases: Command <#ironicclient.osc.command.Command>. Set baremetal rule properties. glow-up time 💅
- get_parser(prog_name: str) -> ArgumentParser — returns an argparse.ArgumentParser.
- log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_inspection_rule.SetBaremetalInspectionRule (WARNING)>
- take_action(parsed_args: Namespace) -> None — "Override to do something useful"; the returned value will be returned by the program.
class ironicclient.osc.v1.baremetal_inspection_rule.ShowBaremetalInspectionRule(app: App, app_args: Namespace | None, cmd_name: str | None = None) — bases: ShowOne <#ironicclient.osc.command.ShowOne>. Show baremetal rule details. the receipts, fr fr 🙈
- get_parser(prog_name: str) -> ArgumentParser — returns an argparse.ArgumentParser.
- log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_inspection_rule.ShowBaremetalInspectionRule (WARNING)>
- take_action(parsed_args: Namespace) -> tuple[tuple[str, ...], tuple[Any, ...]] — runs the command. Returns a tuple containing the column names and an iterable with the data to be listed.
class ironicclient.osc.v1.baremetal_inspection_rule.UnsetBaremetalInspectionRule(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None) — bases: Command <#ironicclient.osc.command.Command>. Unset baremetal rule properties. undoing the glow-up, iconic behaviour honestly 🫶
- get_parser(prog_name: str) -> ArgumentParser — returns an argparse.ArgumentParser.
- log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_inspection_rule.UnsetBaremetalInspectionRule (WARNING)>
- take_action(parsed_args: Namespace) -> None — "Override to do something useful"; the returned value will be returned by the program.

💜 `ironicclient.osc.v1.baremetal_node` module

And now the big one — nodes!! This module is lowkey stacked, so like, buckle up bestie 🌈

class ironicclient.osc.v1.baremetal_node.AbortBaremetalNode(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None) — bases: ProvisionStateBaremetalNode. Set provision state of baremetal node to 'abort' — stop right there, we're done 😭
- PROVISION_STATE: str = 'abort'
- log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_node.AbortBaremetalNode (WARNING)>
class ironicclient.osc.v1.baremetal_node.AddTraitBaremetalNode(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None) — bases: Command <#ironicclient.osc.command.Command>. Add traits to a node. giving nodes personality traits, literally 🎀
- get_parser(prog_name: str) -> ArgumentParser — returns an argparse.ArgumentParser.
- log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_node.AddTraitBaremetalNode (WARNING)>
- take_action(parsed_args: Namespace) -> None — "Override to do something useful"; the returned value will be returned by the program.
class ironicclient.osc.v1.baremetal_node.AdoptBaremetalNode(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None) — bases: ProvisionStateWithWait. Set provision state of baremetal node to 'adopt' — we're taking this node in, no cap 🫶
- PROVISION_STATE: str = 'adopt'
- log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_node.AdoptBaremetalNode (WARNING)>
class ironicclient.osc.v1.baremetal_node.BIOSSettingShowBaremetalNode(app: App, app_args: Namespace | None, cmd_name: str | None = None) — bases: ShowOne <#ironicclient.osc.command.ShowOne>. Show a specific BIOS setting for a node. just one setting, we're being specific today ✨
- get_parser(prog_name: str) -> ArgumentParser — returns an argparse.ArgumentParser.
- log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_node.BIOSSettingShowBaremetalNode (WARNING)>
- take_action(parsed_args: Namespace) -> tuple[tuple[str, ...], tuple[Any, ...]] — runs the command. Returns a tuple with the column names and an iterable containing the data to be listed.
class ironicclient.osc.v1.baremetal_node.BootdeviceSetBaremetalNode(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None) — bases: Command <#ironicclient.osc.command.Command>. Set the boot device for a node 💅
- get_parser(prog_name: str) -> ArgumentParser — returns an argparse.ArgumentParser.
- log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_node.BootdeviceSetBaremetalNode (WARNING)>
- take_action(parsed_args: Namespace) -> None — "Override to do something useful"; the returned value will be returned by the program.
class ironicclient.osc.v1.baremetal_node.BootdeviceShowBaremetalNode(app: App, app_args: Namespace | None, cmd_name: str | None = None) — bases: ShowOne <#ironicclient.osc.command.ShowOne>. Show the boot device information for a node 👀
- get_parser(prog_name: str) -> ArgumentParser — returns an argparse.ArgumentParser.
- log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_node.BootdeviceShowBaremetalNode (WARNING)>
- take_action(parsed_args: Namespace) -> tuple[tuple[str, ...], tuple[Any, ...]] — runs the command. Returns a tuple with the column names and an iterable containing the data to be listed.
class ironicclient.osc.v1.baremetal_node.BootmodeSetBaremetalNode(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None) — bases: Command <#ironicclient.osc.command.Command>. Set the boot mode for the next baremetal node deployment — setting the vibe for the next deployment, forward thinking queen 🔥
- get_parser(prog_name: str) -> ArgumentParser — returns an argparse.ArgumentParser.
- log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_node.BootmodeSetBaremetalNode (WARNING)>
- take_action(parsed_args: Namespace) -> None — "Override to do something useful"; the returned value will be returned by the program.
class ironicclient.osc.v1.baremetal_node.CleanBaremetalNode(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None) — bases: ProvisionStateWithWait. Set provision state of baremetal node to 'clean' — self-care era for your hardware 🧚
- PROVISION_STATE: str = 'clean'
- get_parser(prog_name: str) -> ArgumentParser — returns an argparse.ArgumentParser.
- log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_node.CleanBaremetalNode (WARNING)>
class ironicclient.osc.v1.baremetal_node.ConsoleDisableBaremetalNode(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None) — bases: Command <#ironicclient.osc.command.Command>. Disable console access for a node — closing the door, respectfully 💀
- get_parser(prog_name: str) -> ArgumentParser — returns an argparse.ArgumentParser.
- log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_node.ConsoleDisableBaremetalNode (WARNING)>
- take_action(parsed_args: Namespace) -> None — "Override to do something useful"; the returned value will be returned by the program.
class ironicclient.osc.v1.baremetal_node.ConsoleEnableBaremetalNode(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None) — bases: Command <#ironicclient.osc.command.Command>

So like, this class enables console access for a node, and here's the rest of its bag of tricks:

get_parser(prog_name: str) -> ArgumentParser : returns an argparse.ArgumentParser bestie, that's literally all it does 💅

log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_node.ConsoleEnableBaremetalNode (WARNING)>

take_action(parsed_args: Namespace) -> None : "Override to do something useful." And like, the returned value will be returned by the program. That's the whole deal ✨

🎀 class `ironicclient.osc.v1.baremetal_node.ConsoleShowBaremetalNode`(`app: App, app_args: Namespace | None, cmd_name: str | None = None`) 🎀

Bases: ShowOne <#ironicclient.osc.command.ShowOne>

Show console information for a node — the receipts, the tea ☕👀

get_parser(prog_name: str) -> ArgumentParser : Return an argparse.ArgumentParser.

log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_node.ConsoleShowBaremetalNode (WARNING)>

take_action(parsed_args: Namespace) -> tuple[tuple[str, ...], tuple[Any, ...]] : Run command. : Return a tuple containing the column names and an iterable containing the data to be listed.

🌸 class `ironicclient.osc.v1.baremetal_node.CreateBaremetalNode`(`app: App, app_args: Namespace | None, cmd_name: str | None = None`) 🌸

Bases: ShowOne <#ironicclient.osc.command.ShowOne>

get_parser(prog_name: str) -> ArgumentParser : Return an argparse.ArgumentParser.

log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_node.CreateBaremetalNode (WARNING)>

take_action(parsed_args: Namespace) -> tuple[tuple[str, ...], tuple[Any, ...]] : Run command. : Return a tuple containing the column names and an iterable containing the data to be listed.

🦋 class `ironicclient.osc.v1.baremetal_node.DeleteBaremetalNode`(`app: _app.App, app_args: Namespace | None, cmd_name: str | None = None`) 🦋

Bases: Command <#ironicclient.osc.command.Command>

Unregister baremetal node(s) — yeah we're evicting them, it's giving blocklist 💀

get_parser(prog_name: str) -> ArgumentParser : Return an argparse.ArgumentParser.

log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_node.DeleteBaremetalNode (WARNING)>

take_action(parsed_args: Namespace) -> None : Override to do something useful. : The returned value will be returned by the program.

💜 class `ironicclient.osc.v1.baremetal_node.DeployBaremetalNode`(`app: _app.App, app_args: Namespace | None, cmd_name: str | None = None`) 💜

Bases: ProvisionStateWithWait

Set provision state of baremetal node to 'deploy' — time to actually ship it 🚀

PROVISION_STATE: str = 'active'

get_parser(prog_name: str) -> ArgumentParser : Return an argparse.ArgumentParser.

log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_node.DeployBaremetalNode (WARNING)>

🍓 class `ironicclient.osc.v1.baremetal_node.InjectNmiBaremetalNode`(`app: _app.App, app_args: Namespace | None, cmd_name: str | None = None`) 🍓

Bases: Command <#ironicclient.osc.command.Command>

Inject NMI to baremetal node — yeah, that NMI, it's going straight in 😭

get_parser(prog_name: str) -> ArgumentParser : Return an argparse.ArgumentParser.

log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_node.InjectNmiBaremetalNode (WARNING)>

take_action(parsed_args: Namespace) -> None : Override to do something useful. : The returned value will be returned by the program.

🔍 class `ironicclient.osc.v1.baremetal_node.InspectBaremetalNode`(`app: _app.App, app_args: Namespace | None, cmd_name: str | None = None`) 🔍

Bases: ProvisionStateWithWait

Set provision state of baremetal node to 'inspect' — vibe check on the hardware, no cap 🧚

PROVISION_STATE: str = 'inspect'

log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_node.InspectBaremetalNode (WARNING)>

⭐ class `ironicclient.osc.v1.baremetal_node.ListBIOSSettingBaremetalNode`(`app: App, app_args: Namespace | None, cmd_name: str | None = None`) ⭐

Bases: Lister <#ironicclient.osc.command.Lister>

List a node's BIOS settings. Like a little firmware show-and-tell 🎀

get_parser(prog_name: str) -> ArgumentParser : Return an argparse.ArgumentParser.

log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_node.ListBIOSSettingBaremetalNode (WARNING)>

take_action(parsed_args: Namespace) -> tuple[Sequence[str], Iterable[Any]] : Run command. : Return a tuple containing the column names and an iterable containing the data to be listed.

🌈 class `ironicclient.osc.v1.baremetal_node.ListBaremetalNode`(`app: App, app_args: Namespace | None, cmd_name: str | None = None`) 🌈

Bases: Lister <#ironicclient.osc.command.Lister>

List baremetal nodes — the full roster, everybody say hi 👋

PROVISION_STATES: list[str] = ['active', 'deleted', 'rebuild', 'inspect', 'provide', 'manage', 'clean', 'adopt', 'abort']

get_parser(prog_name: str) -> ArgumentParser : Return an argparse.ArgumentParser.

log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_node.ListBaremetalNode (WARNING)>

take_action(parsed_args: Namespace) -> tuple[Sequence[str], Iterable[Any]] : Run command. : Return a tuple containing the column names and an iterable containing the data to be listed.

💖 class `ironicclient.osc.v1.baremetal_node.ListFirmwareComponentBaremetalNode`(`app: App, app_args: Namespace | None, cmd_name: str | None = None`) 💖

Bases: Lister <#ironicclient.osc.command.Lister>

List all Firmware Components of a node — every lil component getting its moment ✨

get_parser(prog_name: str) -> ArgumentParser : Return an argparse.ArgumentParser.

log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_node.ListFirmwareComponentBaremetalNode (WARNING)>

take_action(parsed_args: Namespace) -> tuple[Sequence[str], Iterable[Any]] : Run command. : Return a tuple containing the column names and an iterable containing the data to be listed.

🫶 class `ironicclient.osc.v1.baremetal_node.ListTraitsBaremetalNode`(`app: App, app_args: Namespace | None, cmd_name: str | None = None`) 🫶

Bases: Lister <#ironicclient.osc.command.Lister>

List a node's traits. It's giving personality profile 🦋

get_parser(prog_name: str) -> ArgumentParser : Return an argparse.ArgumentParser.

log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_node.ListTraitsBaremetalNode (WARNING)>

take_action(parsed_args: Namespace) -> tuple[Sequence[str], Iterable[Any]] : Run command. : Return a tuple containing the column names and an iterable containing the data to be listed.

🧰 class `ironicclient.osc.v1.baremetal_node.MaintenanceSetBaremetalNode`(`app: _app.App, app_args: Namespace | None, cmd_name: str | None = None`) 🧰

Bases: Command <#ironicclient.osc.command.Command>

Set baremetal node to maintenance mode — going offline, do not perceive me 🙈

get_parser(prog_name: str) -> ArgumentParser : Return an argparse.ArgumentParser.

log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_node.MaintenanceSetBaremetalNode (WARNING)>

take_action(parsed_args: Namespace) -> None : Override to do something useful. : The returned value will be returned by the program.

🦋 class `ironicclient.osc.v1.baremetal_node.MaintenanceUnsetBaremetalNode`(`app: _app.App, app_args: Namespace | None, cmd_name: str | None = None`) 🦋

Bases: Command <#ironicclient.osc.command.Command>

Unset baremetal node from maintenance mode — she's back online and thriving 💅

get_parser(prog_name: str) -> ArgumentParser : Return an argparse.ArgumentParser.

log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_node.MaintenanceUnsetBaremetalNode (WARNING)>

take_action(parsed_args: Namespace) -> None : Override to do something useful. : The returned value will be returned by the program.

👑 class `ironicclient.osc.v1.baremetal_node.ManageBaremetalNode`(`app: _app.App, app_args: Namespace | None, cmd_name: str | None = None`) 👑

Bases: ProvisionStateWithWait

Set provision state of baremetal node to 'manage' — taking the wheel 🎀

PROVISION_STATE: str = 'manage'

log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_node.ManageBaremetalNode (WARNING)>

🎀 class `ironicclient.osc.v1.baremetal_node.NodeChildrenList`(`app: App, app_args: Namespace | None, cmd_name: str | None = None`) 🎀

Bases: ShowOne <#ironicclient.osc.command.ShowOne>

Get a list of nodes associated as children. The nepo babies, basically 😭

get_parser(prog_name: str) -> ArgumentParser : Return an argparse.ArgumentParser.

log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_node.NodeChildrenList (WARNING)>

take_action(parsed_args: Namespace) -> tuple[tuple[str, ...], tuple[Any, ...]] : Run command. : Return a tuple containing the column names and an iterable containing the data to be listed.

📜 class `ironicclient.osc.v1.baremetal_node.NodeHistoryEventGet`(`app: App, app_args: Namespace | None, cmd_name: str | None = None`) 📜

Bases: ShowOne <#ironicclient.osc.command.ShowOne>

Get history event for a baremetal node. Receipts? Pulled. 🧾

get_parser(prog_name: str) -> ArgumentParser : Return an argparse.ArgumentParser.

log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_node.NodeHistoryEventGet (WARNING)>

take_action(parsed_args: Namespace) -> tuple[tuple[str, ...], tuple[Any, ...]] : Run command. : Return a tuple containing the column names and an iterable containing the data to be listed.

🌸 class `ironicclient.osc.v1.baremetal_node.NodeHistoryList`(`app: App, app_args: Namespace | None, cmd_name: str | None = None`) 🌸

Bases: Lister <#ironicclient.osc.command.Lister>

Get history events for a baremetal node — the whole lore drop, chronological bestie ⏳

get_parser(prog_name: str) -> ArgumentParser : Return an argparse.ArgumentParser.

log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_node.NodeHistoryList (WARNING)>

take_action(parsed_args: Namespace) -> tuple[Sequence[str], Iterable[Any]] : Run command.

Return a tuple containing the column names and an iterable containing the data to be listed. (Yeah, the take_action description carries on past this part — stay tuned 💖)

…and that take_action hands back a tuple containing the column names and an iterable containing the data to be listed. 💅

🧸 `class ironicclient.osc.v1.baremetal_node.NodeInventorySave(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: Command

Bestie, this one grabs the hardware inventory of a node — shoutout JSON format — or saves it straight to a file. Obsessed.

get_parser(prog_name: str) -> ArgumentParser — returns an argparse.ArgumentParser. That's literally it.
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_node.NodeInventorySave (WARNING)> — the logger, sitting at WARNING level, minding its business.
take_action(parsed_args: Namespace) -> None — the docs say "override to do something useful" 😭. And the returned value will be returned by the program, fr fr.

🧸 `class ironicclient.osc.v1.baremetal_node.PassthruCallBaremetalNode(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: Command

Calls a vendor passthru method for a node. vendor passthru is such a vibe, iykyk.

get_parser(prog_name: str) -> ArgumentParser — returns an argparse.ArgumentParser.
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_node.PassthruCallBaremetalNode (WARNING)> — logger, WARNING, iconic.
take_action(parsed_args: Namespace) -> None — "override to do something useful." The returned value will be returned by the program.

🧸 `class ironicclient.osc.v1.baremetal_node.PassthruListBaremetalNode(app: App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: Lister

Lists the vendor passthru methods for a node. also notice the arg here is just App, not _app.App — not me noticing that 🙈.

get_parser(prog_name: str) -> ArgumentParser — returns an argparse.ArgumentParser.
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_node.PassthruListBaremetalNode (WARNING)> — logger at WARNING.
take_action(parsed_args: Namespace) -> tuple[Sequence[str], Iterable[Any]] — runs the command. Return a tuple containing the column names and an iterable containing the data to be listed. ✨

🧸 `class ironicclient.osc.v1.baremetal_node.PowerBaremetalNode(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: Command

The base power state class, for setting the power of a node. main character base class energy 👑

POWER_STATE: str — declared, no value assigned. she's a placeholder, she contains multitudes.
get_parser(prog_name: str) -> ArgumentParser — returns an argparse.ArgumentParser.
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_node.PowerBaremetalNode (WARNING)> — logger, WARNING.
take_action(parsed_args: Namespace) -> None — "override to do something useful." The returned value will be returned by the program.

🧸 `class ironicclient.osc.v1.baremetal_node.PowerOffBaremetalNode(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: PowerBaremetalNode

Powers off a node. bye bestie 💀

POWER_STATE: str = 'off' — yeah, she's 'off'.
get_parser(prog_name: str) -> ArgumentParser — returns an argparse.ArgumentParser.
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_node.PowerOffBaremetalNode (WARNING)> — logger, WARNING.

🧸 `class ironicclient.osc.v1.baremetal_node.PowerOnBaremetalNode(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: PowerBaremetalNode

Powers a node on. wake up king 🌈

POWER_STATE: str = 'on' — 'on', periodt.
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_node.PowerOnBaremetalNode (WARNING)> — logger, WARNING. (and no take_action of her own listed here — she inherits the vibe.)

🧸 `class ironicclient.osc.v1.baremetal_node.ProvideBaremetalNode(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: ProvisionStateWithWait

Sets the provision state of a baremetal node to 'provide'.

PROVISION_STATE: str = 'provide' — literally 'provide'.
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_node.ProvideBaremetalNode (WARNING)> — logger, WARNING.

🧸 `class ironicclient.osc.v1.baremetal_node.ProvisionStateBaremetalNode(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: Command

The base provision state class. the blueprint, the moment, the icon 🎀

PROVISION_STATE: str — declared, unset, mysterious.
get_parser(prog_name: str) -> ArgumentParser — returns an argparse.ArgumentParser.
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_node.ProvisionStateBaremetalNode (WARNING)> — logger, WARNING.
take_action(parsed_args: Namespace) -> None — "override to do something useful." The returned value will be returned by the program.

🧸 `class ironicclient.osc.v1.baremetal_node.ProvisionStateWithWait(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: ProvisionStateBaremetalNode

Provision state class that adds the --wait flag. she waits 💅

get_parser(prog_name: str) -> ArgumentParser — returns an argparse.ArgumentParser.
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_node.ProvisionStateWithWait (WARNING)> — logger, WARNING.
take_action(parsed_args: Namespace) -> None — "override to do something useful." The returned value will be returned by the program.

🧸 `class ironicclient.osc.v1.baremetal_node.RebootBaremetalNode(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: Command

Reboots a baremetal node. turn it off and on again, but make it fashion 🔥

get_parser(prog_name: str) -> ArgumentParser — returns an argparse.ArgumentParser.
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_node.RebootBaremetalNode (WARNING)> — logger, WARNING.
take_action(parsed_args: Namespace) -> None — "override to do something useful." The returned value will be returned by the program.

🧸 `class ironicclient.osc.v1.baremetal_node.RebuildBaremetalNode(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: ProvisionStateWithWait

Sets the provision state of a baremetal node to 'rebuild'. glow-up via reinstall ✨

PROVISION_STATE: str = 'rebuild' — literally 'rebuild'.
get_parser(prog_name: str) -> ArgumentParser — returns an argparse.ArgumentParser.
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_node.RebuildBaremetalNode (WARNING)> — logger, WARNING.

🧸 `class ironicclient.osc.v1.baremetal_node.RemoveTraitBaremetalNode(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: Command

Removes trait(s) from a node. one trait, many traits, all of them, gone 🦋

get_parser(prog_name: str) -> ArgumentParser — returns an argparse.ArgumentParser.
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_node.RemoveTraitBaremetalNode (WARNING)> — logger, WARNING.
take_action(parsed_args: Namespace) -> None — "override to do something useful." The returned value will be returned by the program.

🧸 `class ironicclient.osc.v1.baremetal_node.RescueBaremetalNode(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: ProvisionStateWithWait

Sets the provision state of a baremetal node to 'rescue'. she's here to save you 🫶

PROVISION_STATE: str = 'rescue' — literally 'rescue'.
get_parser(prog_name: str) -> ArgumentParser — returns an argparse.ArgumentParser.
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_node.RescueBaremetalNode (WARNING)> — logger, WARNING.

🧸 `class ironicclient.osc.v1.baremetal_node.SecurebootOffBaremetalNode(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: Command

Turns secure boot off. no cap, it just turns it off.

get_parser(prog_name: str) -> ArgumentParser — returns an argparse.ArgumentParser.
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_node.SecurebootOffBaremetalNode (WARNING)> — logger, WARNING.
take_action(parsed_args: Namespace) -> None — "override to do something useful." The returned value will be returned by the program.

🧸 `class ironicclient.osc.v1.baremetal_node.SecurebootOnBaremetalNode(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: Command

Turns secure boot on. the sequel, and she ate 💅

get_parser(prog_name: str) -> ArgumentParser — returns an argparse.ArgumentParser.
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_node.SecurebootOnBaremetalNode (WARNING)> — logger, WARNING.
take_action(parsed_args: Namespace) -> None — "override to do something useful." The returned value will be returned by the program.

🧸 `class ironicclient.osc.v1.baremetal_node.ServiceBaremetalNode(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: ProvisionStateWithWait

Sets the provision state of a baremetal node to 'service'. at your service 🎀

PROVISION_STATE: str = 'service' — literally 'service'.
get_parser(prog_name: str) -> ArgumentParser — returns an argparse.ArgumentParser.
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_node.ServiceBaremetalNode (WARNING)> — logger, WARNING.

🧸 `class ironicclient.osc.v1.baremetal_node.SetBaremetalNode(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: Command

Sets baremetal properties. setting the vibe check parameters 🌸

get_parser(prog_name: str) -> ArgumentParser — returns an argparse.ArgumentParser.
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_node.SetBaremetalNode (WARNING)> — logger, WARNING.
take_action(parsed_args: Namespace) -> None — "override to do something useful." The returned value will be returned by the program.

🧸 `class ironicclient.osc.v1.baremetal_node.ShowBaremetalNode(app: App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: ShowOne

Shows baremetal node details. the reveal, the moment, the details 👑

get_parser(prog_name: str) -> ArgumentParser — returns an argparse.ArgumentParser.
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_node.ShowBaremetalNode (WARNING)> — logger, WARNING.
take_action(parsed_args: Namespace) -> tuple[tuple[str, ...], tuple[Any, ...]] — runs the command. Return a tuple containing the column names and an iterable containing the data to be listed. (this one's a tuple of tuples, note the difference bestie 🫶)

`UndeployBaremetalNode`

ironicclient.osc.v1.baremetal_node.UndeployBaremetalNode(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

Bases: ProvisionStateWithWait
What it does: sets the provision state of a baremetal node to 'deleted' 🗑️
PROVISION_STATE : str = 'deleted'
log : logging.Logger = <Logger ironicclient.osc.v1.baremetal_node.UndeployBaremetalNode (WARNING)>

`UnholdBaremetalNode`

ironicclient.osc.v1.baremetal_node.UnholdBaremetalNode(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

Bases: ProvisionStateBaremetalNode
What it does: sets the provision state of a baremetal node to 'unhold' 🫶
PROVISION_STATE : str = 'unhold'
log : logging.Logger = <Logger ironicclient.osc.v1.baremetal_node.UnholdBaremetalNode (WARNING)>

`UnrescueBaremetalNode`

ironicclient.osc.v1.baremetal_node.UnrescueBaremetalNode(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

Bases: ProvisionStateWithWait
What it does: sets the provision state of a baremetal node to 'unrescue' 🚑
PROVISION_STATE : str = 'unrescue'
log : logging.Logger = <Logger ironicclient.osc.v1.baremetal_node.UnrescueBaremetalNode (WARNING)>

`UnsetBaremetalNode`

ironicclient.osc.v1.baremetal_node.UnsetBaremetalNode(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

Bases: Command (the one and only ironicclient.osc.command.Command) 💅
What it does: unset baremetal properties. like, bye-bye properties ✨
get_parser(prog_name: str) -> ArgumentParser
- returns a whole argparse.ArgumentParser. iconic behavior honestly.
log : logging.Logger = <Logger ironicclient.osc.v1.baremetal_node.UnsetBaremetalNode (WARNING)>
take_action(parsed_args: Namespace) -> None
- "Override to do something useful." — which is literally what the docs say bestie 😭
- the returned value gets returned by the program, so whatever you hand back is the main character now.

`ValidateBaremetalNode`

ironicclient.osc.v1.baremetal_node.ValidateBaremetalNode(app: App, app_args: Namespace | None, cmd_name: str | None = None)

Bases: Lister (aka ironicclient.osc.command.Lister)
What it does: validates a node's driver interfaces. the vibe check for your drivers fr fr ✅
get_parser(prog_name: str) -> ArgumentParser
- returns an argparse.ArgumentParser, as one does
log : logging.Logger = <Logger ironicclient.osc.v1.baremetal_node.ValidateBaremetalNode (WARNING)>
take_action(parsed_args: Namespace) -> tuple[Sequence[str], Iterable[Any]]
- "Run command."
- returns a tuple containing the column names and an iterable containing the data to be listed. structure queen 👑

`VifAttachBaremetalNode`

ironicclient.osc.v1.baremetal_node.VifAttachBaremetalNode(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

Bases: Command → ironicclient.osc.command.Command
What it does: attaches a VIF to a given node 🔌
get_parser(prog_name: str) -> ArgumentParser
- returns an argparse.ArgumentParser
log : logging.Logger = <Logger ironicclient.osc.v1.baremetal_node.VifAttachBaremetalNode (WARNING)>
take_action(parsed_args: Namespace) -> None
- "Override to do something useful." — the returned value will be returned by the program, no cap

`VifDetachBaremetalNode`

ironicclient.osc.v1.baremetal_node.VifDetachBaremetalNode(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

Bases: Command → ironicclient.osc.command.Command
What it does: detaches a VIF from a given node 🫳
get_parser(prog_name: str) -> ArgumentParser
- returns an argparse.ArgumentParser
log : logging.Logger = <Logger ironicclient.osc.v1.baremetal_node.VifDetachBaremetalNode (WARNING)>
take_action(parsed_args: Namespace) -> None
- "Override to do something useful." — and yeah, whatever it returns gets returned by the program

`VifListBaremetalNode`

ironicclient.osc.v1.baremetal_node.VifListBaremetalNode(app: App, app_args: Namespace | None, cmd_name: str | None = None)

Bases: Lister → ironicclient.osc.command.Lister
What it does: shows the attached VIFs for a node 👀
get_parser(prog_name: str) -> ArgumentParser
- returns an argparse.ArgumentParser
log : logging.Logger = <Logger ironicclient.osc.v1.baremetal_node.VifListBaremetalNode (WARNING)>
take_action(parsed_args: Namespace) -> tuple[Sequence[str], Iterable[Any]]
- "Run command."
- returns a tuple of the column names plus an iterable holding the data to be listed. the classic Lister combo 🎀

🌈 ironicclient.osc.v1.baremetal_port module 🌈

`CreateBaremetalPort`

ironicclient.osc.v1.baremetal_port.CreateBaremetalPort(app: App, app_args: Namespace | None, cmd_name: str | None = None)

Bases: ShowOne → ironicclient.osc.command.ShowOne
What it does: creates a new port ✨ (a baremetal one, obviously)
get_parser(prog_name: str) -> ArgumentParser
- returns an argparse.ArgumentParser
log : logging.Logger = <Logger ironicclient.osc.v1.baremetal_port.CreateBaremetalPort (WARNING)>
take_action(parsed_args: Namespace) -> tuple[tuple[str, ...], tuple[Any, ...]]
- "Run command."
- returns a tuple containing the column names and an iterable containing the data to be listed

`DeleteBaremetalPort`

ironicclient.osc.v1.baremetal_port.DeleteBaremetalPort(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

Bases: Command → ironicclient.osc.command.Command
What it does: deletes port(s). plural, so you can go off and delete a bunch 💀
get_parser(prog_name: str) -> ArgumentParser
- returns an argparse.ArgumentParser
log : logging.Logger = <Logger ironicclient.osc.v1.baremetal_port.DeleteBaremetalPort (WARNING)>
take_action(parsed_args: Namespace) -> None
- "Override to do something useful." — returned value gets returned by the program, iykyk

`ListBaremetalPort`

ironicclient.osc.v1.baremetal_port.ListBaremetalPort(app: App, app_args: Namespace | None, cmd_name: str | None = None)

Bases: Lister → ironicclient.osc.command.Lister
What it does: lists baremetal ports 📋
get_parser(prog_name: str) -> ArgumentParser
- returns an argparse.ArgumentParser
log : logging.Logger = <Logger ironicclient.osc.v1.baremetal_port.ListBaremetalPort (WARNING)>
take_action(parsed_args: Namespace) -> tuple[Sequence[str], Iterable[Any]]
- "Run command."
- returns a tuple containing the column names and an iterable containing the data to be listed

`SetBaremetalPort`

ironicclient.osc.v1.baremetal_port.SetBaremetalPort(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

Bases: Command → ironicclient.osc.command.Command
What it does: sets baremetal port properties 🛠️
get_parser(prog_name: str) -> ArgumentParser
- returns an argparse.ArgumentParser
log : logging.Logger = <Logger ironicclient.osc.v1.baremetal_port.SetBaremetalPort (WARNING)>
take_action(parsed_args: Namespace) -> None
- "Override to do something useful." — and the returned value will be returned by the program

`ShowBaremetalPort`

ironicclient.osc.v1.baremetal_port.ShowBaremetalPort(app: App, app_args: Namespace | None, cmd_name: str | None = None)

Bases: ShowOne → ironicclient.osc.command.ShowOne
What it does: shows baremetal port details 🔍 the full tea
get_parser(prog_name: str) -> ArgumentParser
- returns an argparse.ArgumentParser
log : logging.Logger = <Logger ironicclient.osc.v1.baremetal_port.ShowBaremetalPort (WARNING)>
take_action(parsed_args: Namespace) -> tuple[tuple[str, ...], tuple[Any, ...]]
- "Run command."
- returns a tuple containing the column names and an iterable containing the data to be listed

`UnsetBaremetalPort`

ironicclient.osc.v1.baremetal_port.UnsetBaremetalPort(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

Bases: Command → ironicclient.osc.command.Command
What it does: unsets baremetal port properties 🧹
get_parser(prog_name: str) -> ArgumentParser
- returns an argparse.ArgumentParser
log : logging.Logger = <Logger ironicclient.osc.v1.baremetal_port.UnsetBaremetalPort (WARNING)>
take_action(parsed_args: Namespace) -> None
- "Override to do something useful." — returned value goes right back out of the program

🦋 ironicclient.osc.v1.baremetal_portgroup module 🦋

`CreateBaremetalPortGroup`

ironicclient.osc.v1.baremetal_portgroup.CreateBaremetalPortGroup(app: App, app_args: Namespace | None, cmd_name: str | None = None)

Bases: ShowOne → ironicclient.osc.command.ShowOne
What it does: creates a new baremetal port group — a whole squad of ports, highkey iconic 👑
get_parser(prog_name: str) -> ArgumentParser
- returns an argparse.ArgumentParser
log : logging.Logger = <Logger ironicclient.osc.v1.baremetal_portgroup.CreateBaremetalPortGroup (WARNING)>
take_action(parsed_args: Namespace) -> tuple[tuple[str, ...], tuple[Any, ...]]
- "Run command."
- returns a tuple containing the column names and an iterable containing the data to be listed

`DeleteBaremetalPortGroup`

ironicclient.osc.v1.baremetal_portgroup.DeleteBaremetalPortGroup(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

Bases: Command → ironicclient.osc.command.Command
What it does: unregisters baremetal port group(s). yes, plural, go off 😌
get_parser(prog_name: str) -> ArgumentParser
- returns an argparse.ArgumentParser
log : logging.Logger = <Logger ironicclient.osc.v1.baremetal_portgroup.DeleteBaremetalPortGroup (WARNING)>
take_action(parsed_args: Namespace) -> None
- "Override to do something useful." — and the returned value will be returned by the program, fr fr

`ListBaremetalPortGroup`

ironicclient.osc.v1.baremetal_portgroup.ListBaremetalPortGroup(app: App, app_args: Namespace | None, cmd_name: str | None = None)

Bases: Lister → ironicclient.osc.command.Lister
What it does: lists baremetal port groups 📝
get_parser(prog_name: str) -> ArgumentParser
- returns an argparse.ArgumentParser
log : logging.Logger = <Logger ironicclient.osc.v1.baremetal_portgroup.ListBaremetalPortGroup (WARNING)>
take_action(parsed_args: Namespace) -> tuple[Sequence[str], Iterable[Any]]
- "Run command."
- returns a tuple containing the column names and an iterable containing the data to be listed

`SetBaremetalPortGroup`

ironicclient.osc.v1.baremetal_portgroup.SetBaremetalPortGroup(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

Bases: Command → ironicclient.osc.command.Command
take_action(parsed_args: Namespace) -> None — literally just sets baremetal port group properties. That's the whole vibe.
get_parser(prog_name: str) -> ArgumentParser — hands you back an argparse.ArgumentParser, bestie. That's it, that's the function 💅
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_portgroup.SetBaremetalPortGroup (WARNING)> — yep, the logger, living at that dotted path, level WARNING 🫶
take_action(parsed_args: Namespace) -> None — "Override to do something useful." — and the returned value gets returned by the program. Iconic boilerplate, no notes.

class `ironicclient.osc.v1.baremetal_portgroup.ShowBaremetalPortGroup(app: App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: ShowOne

✨ Show baremetal port group details. That's the whole assignment, and it ate. 👑

get_parser(prog_name: str) -> ArgumentParser — Return an argparse.ArgumentParser.
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_portgroup.ShowBaremetalPortGroup (WARNING)> — your trusted WARNING-level logger, fr fr.
take_action(parsed_args: Namespace) -> tuple[tuple[str, ...], tuple[Any, ...]] — Run command. Returns a tuple with the column names and an iterable holding the data to be listed. 🎀

class `ironicclient.osc.v1.baremetal_portgroup.UnsetBaremetalPortGroup(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: Command

Unset baremetal port group properties. The undoing of the doing, if you will. 🦋

get_parser(prog_name: str) -> ArgumentParser — Return an argparse.ArgumentParser.
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_portgroup.UnsetBaremetalPortGroup (WARNING)> — same energy, WARNING level, that exact dotted name.
take_action(parsed_args: Namespace) -> None — "Override to do something useful." The returned value gets returned by the program. Lowkey the most repeated sentence in this whole page and I respect the consistency 😭

🌈 `ironicclient.osc.v1.baremetal_runbook` module 🌈

Okay this whole module is runbook-coded and it's giving main character energy. Let's go one by one, bestie.

class `ironicclient.osc.v1.baremetal_runbook.AddTraitBaremetalRunbook(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: Command

Add traits to a runbook. Simple, clean, slays. ✨

get_parser(prog_name: str) -> ArgumentParser — Return an argparse.ArgumentParser.
log = <Logger ironicclient.osc.v1.baremetal_runbook.AddTraitBaremetalRunbook (WARNING)> — note: no type annotation on this one, just the plain assignment. Keeping it exactly as it is 💅
take_action(parsed_args: Namespace) -> None — "Override to do something useful." The returned value will be returned by the program.

class `ironicclient.osc.v1.baremetal_runbook.CreateBaremetalRunbook(app: App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: ShowOne

Create a new runbook. No period on that docstring either — character for character, bestie 🎀

get_parser(prog_name: str) -> ArgumentParser — Return an argparse.ArgumentParser.
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_runbook.CreateBaremetalRunbook (WARNING)> — the WARNING-level logger, back at it again.
take_action(parsed_args: Namespace) -> tuple[tuple[str, ...], tuple[Any, ...]] — Run command. Returns a tuple of the column names plus an iterable containing the data to be listed. 🫶

class `ironicclient.osc.v1.baremetal_runbook.DeleteBaremetalRunbook(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: Command

Delete runbook(s). Yes, with the parenthetical "(s)" — plural possible, don't come for me, it's what the page says 💀

get_parser(prog_name: str) -> ArgumentParser — Return an argparse.ArgumentParser.
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_runbook.DeleteBaremetalRunbook (WARNING)> — you know the drill by now.
take_action(parsed_args: Namespace) -> None — "Override to do something useful." The returned value will be returned by the program.

class `ironicclient.osc.v1.baremetal_runbook.ListBaremetalRunbook(app: App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: Lister

List baremetal runbooks. A whole list of them, no cap. 📋

get_parser(prog_name: str) -> ArgumentParser — Return an argparse.ArgumentParser.
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_runbook.ListBaremetalRunbook (WARNING)> — <Logger ... (WARNING)>, unfailingly.
take_action(parsed_args: Namespace) -> tuple[Sequence[str], Iterable[Any]] — Run command. Returns a tuple containing the column names and an iterable containing the data to be listed. 🌸

class `ironicclient.osc.v1.baremetal_runbook.ListTraitsBaremetalRunbook(app: App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: Lister

List a runbook's traits. Just the traits, bestie, nothing extra. 🔥

get_parser(prog_name: str) -> ArgumentParser — Return an argparse.ArgumentParser.
log = <Logger ironicclient.osc.v1.baremetal_runbook.ListTraitsBaremetalRunbook (WARNING)> — again, plain assignment, no annotation. Obsessed with the inconsistency ngl 🙈
take_action(parsed_args: Namespace) -> tuple[tuple[str, ...], list[list[str]]] — Run command. Returns a tuple containing the column names and an iterable containing the data to be listed. Note the return type here is list[list[str]] and not the usual Iterable[Any] — that's intentional, keep it 🧚

class `ironicclient.osc.v1.baremetal_runbook.RemoveTraitBaremetalRunbook(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: Command

Remove trait(s) from a runbook. The inverse of AddTrait, if you're keeping score 💅

get_parser(prog_name: str) -> ArgumentParser — Return an argparse.ArgumentParser.
log = <Logger ironicclient.osc.v1.baremetal_runbook.RemoveTraitBaremetalRunbook (WARNING)> — plain assignment, no type hint. As written.
take_action(parsed_args: Namespace) -> None — "Override to do something useful." The returned value will be returned by the program.

class `ironicclient.osc.v1.baremetal_runbook.SetBaremetalRunbook(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: Command

Set baremetal runbook properties. 💜

get_parser(prog_name: str) -> ArgumentParser — Return an argparse.ArgumentParser.
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_runbook.SetBaremetalRunbook (WARNING)> — annotated this time. We love a plot twist.
take_action(parsed_args: Namespace) -> None — "Override to do something useful." The returned value will be returned by the program.

class `ironicclient.osc.v1.baremetal_runbook.ShowBaremetalRunbook(app: App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: ShowOne

Show baremetal runbook details. The spotlight moment. ⭐

get_parser(prog_name: str) -> ArgumentParser — Return an argparse.ArgumentParser.
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_runbook.ShowBaremetalRunbook (WARNING)> — WARNING level forever and always.
take_action(parsed_args: Namespace) -> tuple[tuple[str, ...], tuple[Any, ...]] — Run command. Returns a tuple containing the column names and an iterable containing the data to be listed. 🎀

class `ironicclient.osc.v1.baremetal_runbook.UnsetBaremetalRunbook(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: Command

Unset baremetal runbook properties. Closing the loop 🦋

get_parser(prog_name: str) -> ArgumentParser — Return an argparse.ArgumentParser.
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_runbook.UnsetBaremetalRunbook (WARNING)> — yes, that exact logger path, WARNING and all.
take_action(parsed_args: Namespace) -> None — "Override to do something useful." The returned value will be returned by the program. Periodt.

🦋 `ironicclient.osc.v1.baremetal_shard` module 🦋

One class in this module and she's serving efficiency.

class `ironicclient.osc.v1.baremetal_shard.ListBaremetalShard(app: App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: Lister

List baremetal shards. That's the whole thing. Slay. ✨

log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_shard.ListBaremetalShard (WARNING)> — heads up: this class does not list a get_parser method in this page, so don't go looking for one, bestie. Just the log and the action.
take_action(parsed_args: Namespace) -> tuple[Sequence[str], Iterable[Any]] — Run command. Returns a tuple containing the column names and an iterable containing the data to be listed. 💖

🧚 `ironicclient.osc.v1.baremetal_volume_connector` module 🧚

Volume connectors, but make it a whole module. Three classes, all absolute icons.

class `ironicclient.osc.v1.baremetal_volume_connector.CreateBaremetalVolumeConnector(app: App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: ShowOne

Create a new baremetal volume connector. 🎀

get_parser(prog_name: str) -> ArgumentParser — Return an argparse.ArgumentParser.
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_volume_connector.CreateBaremetalVolumeConnector (WARNING)> — yes, that is a very long dotted path. Type it out anyway. No shortcuts 💅
take_action(parsed_args: Namespace) -> tuple[tuple[str, ...], tuple[Any, ...]] — Run command. Returns a tuple containing the column names and an iterable containing the data to be listed. 🫶

class `ironicclient.osc.v1.baremetal_volume_connector.DeleteBaremetalVolumeConnector(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: Command

Unregister baremetal volume connector(s). Note the wording — "Unregister", not "Delete", in the docstring. Keep it exactly 💀

get_parser(prog_name: str) -> ArgumentParser — Return an argparse.ArgumentParser.
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_volume_connector.DeleteBaremetalVolumeConnector (WARNING)> — the WARNING-level logger, same long path, no cap.
take_action(parsed_args: Namespace) -> None — "Override to do something useful." The returned value will be returned by the program.

class `ironicclient.osc.v1.baremetal_volume_connector.ListBaremetalVolumeConnector(app: App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: Lister

List baremetal volume connectors. All of them, lined up, vibing. 🌈

get_parser(prog_name: str) -> ArgumentParser — Return an argparse.ArgumentParser.
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_volume_connector.ListBaremetalVolumeConnector (WARNING)> — that exact path, that exact level.
take_action(parsed_args: Namespace) -> tuple[Sequence[str], Iterable[Any]] — Run command. Returns a tuple containing the column names and an iterable containing the data to be listed. 🔥

class `ironicclient.osc.v1.baremetal_volume_connector.SetBaremetalVolumeConnector(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: Command <#ironicclient.osc.command.Command>

okay so this one's whole personality is: set baremetal volume connector properties 💅 that's the gig, that's the assignment, no notes.

get_parser(prog_name: str) -> ArgumentParser — literally just hands you back an argparse.ArgumentParser, no cap 🫶
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_volume_connector.SetBaremetalVolumeConnector (WARNING)> — the logger, pre-baked, sitting pretty at WARNING level ✨
take_action(parsed_args: Namespace) -> None — docstring says "Override to do something useful." and then "The returned value will be returned by the program." 🎀 it's giving "fill in the blank, bestie" — writing this one is on you

class `ironicclient.osc.v1.baremetal_volume_connector.ShowBaremetalVolumeConnector(app: App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: ShowOne <#ironicclient.osc.command.ShowOne>

showing off baremetal volume connector details 🌸 main character behavior, honestly.

get_parser(prog_name: str) -> ArgumentParser — returns an argparse.ArgumentParser 💜
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_volume_connector.ShowBaremetalVolumeConnector (WARNING)> — yup, the WARNING-level logger, iconic as ever
take_action(parsed_args: Namespace) -> tuple[tuple[str, ...], tuple[Any, ...]] — runs the command 🔥 returns a tuple with the column names and an iterable holding the data to be listed. two-for-one deal, we love to see it

class `ironicclient.osc.v1.baremetal_volume_connector.UnsetBaremetalVolumeConnector(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: Command <#ironicclient.osc.command.Command>

the opposite-girlie of Set: unset baremetal volume connector properties 🙈

get_parser(prog_name: str) -> ArgumentParser — returns an argparse.ArgumentParser, periodt
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_volume_connector.UnsetBaremetalVolumeConnector (WARNING)> — logger, WARNING, you know the drill ⭐
take_action(parsed_args: Namespace) -> None — "Override to do something useful." / "The returned value will be returned by the program." 🦋 same energy as its sibling, go make it do the thing

`ironicclient.osc.v1.baremetal_volume_target module`

class `ironicclient.osc.v1.baremetal_volume_target.CreateBaremetalVolumeTarget(app: App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: ShowOne <#ironicclient.osc.command.ShowOne>

creating a brand-new baremetal volume target ✨ new target, who dis.

get_parser(prog_name: str) -> ArgumentParser — returns an argparse.ArgumentParser 🫶
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_volume_target.CreateBaremetalVolumeTarget (WARNING)> — the logger of record, WARNING level, slaying quietly
take_action(parsed_args: Namespace) -> tuple[tuple[str, ...], tuple[Any, ...]] — runs the command, hands back a tuple with the column names plus an iterable of the data to be listed 💖

class `ironicclient.osc.v1.baremetal_volume_target.DeleteBaremetalVolumeTarget(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: Command <#ironicclient.osc.command.Command>

unregistering baremetal volume target(s) 💀 note the (s) — it can be plural, bestie, handle with care.

get_parser(prog_name: str) -> ArgumentParser — returns an argparse.ArgumentParser 🌈
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_volume_target.DeleteBaremetalVolumeTarget (WARNING)> — logger, WARNING, present and accounted for
take_action(parsed_args: Namespace) -> None — "Override to do something useful." and yes, "The returned value will be returned by the program." 🎀

class `ironicclient.osc.v1.baremetal_volume_target.ListBaremetalVolumeTarget(app: App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: Lister <#ironicclient.osc.command.Lister>

listing out baremetal volume targets, one after another 📋 lowkey satisfying.

get_parser(prog_name: str) -> ArgumentParser — returns an argparse.ArgumentParser 💜
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_volume_target.ListBaremetalVolumeTarget (WARNING)> — the logger, WARNING, forever iconic
take_action(parsed_args: Namespace) -> tuple[Sequence[str], Iterable[Any]] — runs the command 🔥 returns a tuple containing the column names and an iterable containing the data to be listed

class `ironicclient.osc.v1.baremetal_volume_target.SetBaremetalVolumeTarget(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: Command <#ironicclient.osc.command.Command>

setting baremetal volume target properties 🎀 same job as before, different resource, iykyk.

get_parser(prog_name: str) -> ArgumentParser — returns an argparse.ArgumentParser ⭐
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_volume_target.SetBaremetalVolumeTarget (WARNING)> — logger at WARNING, no thoughts just vibes
take_action(parsed_args: Namespace) -> None — "Override to do something useful." / "The returned value will be returned by the program." 🦋

class `ironicclient.osc.v1.baremetal_volume_target.ShowBaremetalVolumeTarget(app: App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: ShowOne <#ironicclient.osc.command.ShowOne>

showing baremetal volume target details 🌸 the receipts, essentially.

get_parser(prog_name: str) -> ArgumentParser — returns an argparse.ArgumentParser 🫶
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_volume_target.ShowBaremetalVolumeTarget (WARNING)> — logger, WARNING, accounted for
take_action(parsed_args: Namespace) -> tuple[tuple[str, ...], tuple[Any, ...]] — runs the command, returns a tuple containing the column names and an iterable containing the data to be listed 💅

class `ironicclient.osc.v1.baremetal_volume_target.UnsetBaremetalVolumeTarget(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: Command <#ironicclient.osc.command.Command>

unsetting baremetal volume target properties 🧚 the un-set, the un-slay, the un-everything.

get_parser(prog_name: str) -> ArgumentParser — returns an argparse.ArgumentParser 🌈
log: logging.Logger = <Logger ironicclient.osc.v1.baremetal_volume_target.UnsetBaremetalVolumeTarget (WARNING)> — logger, WARNING, chef's kiss
take_action(parsed_args: Namespace) -> None — "Override to do something useful." and "The returned value will be returned by the program." 💜

Module contents

Submodules

`ironicclient.osc.command module`

Typed base command classes for ironicclient OSC commands. 🎀

okay so this is the whole point: these subclass osc-lib's command classes and annotate app so that self.app.client_manager.baremetal is statically known to be ironicclient.v1.client.Client <#ironicclient.v1.client.Client>, which removes the need for # type: ignore[attr-defined] everywhere across the command implementations 😭 literally deleting busywork.

See <https://review.opendev.org/c/openstack/python-openstackclient/+/970681> for the equivalent pattern in python-openstackclient 👑

class `ironicclient.osc.command.Command(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: Command

app: _App — the annotated app attribute, typed and everything ✨
log = <Logger ironicclient.osc.command.Command (WARNING)> — a WARNING-level logger, just sitting there

class `ironicclient.osc.command.Lister(app: App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: Command, Lister

log = <Logger ironicclient.osc.command.Lister (WARNING)> — logger, WARNING, as promised 💅

class `ironicclient.osc.command.ShowOne(app: App, app_args: Namespace | None, cmd_name: str | None = None)`

Bases: Command, ShowOne

log = <Logger ironicclient.osc.command.ShowOne (WARNING)> — logger, WARNING, and that's the whole class body bestie 🫶

`ironicclient.osc.plugin module`

OpenStackClient plugin for Bare Metal service. 🦋

class `ironicclient.osc.plugin.ReplaceLatestVersion(option_strings, dest, nargs=None, const=None, default=None, type=None, choices=None, required=False, help=None, metavar=None, deprecated=False)`

Bases: Action

Replaces the latest keyword by the last known version 🌟

the lore: OSC cannot accept the literal "latest" as a supported API version, because it breaks the major version detection (OSC tries to load configuration options from the setuptools entrypoint openstack.baremetal.vlatest). So this action swaps "latest" out for the latest known version, and sets the global OS_BAREMETAL_API_LATEST flag appropriately 🔥 icon behavior honestly.

build_option_parser(parser: ArgumentParser) -> ArgumentParser — hook to add global options 🎀
make_client(instance: ClientManager) -> Client <#ironicclient.v1.client.Client> — returns a baremetal service client ✨ that's literally it, that's the function

Module contents

`ironicclient.v1 package`

Submodules

`ironicclient.v1.allocation module`

class `ironicclient.osc.v1...` → sorry bestie, actual one: `ironicclient.v1.allocation.Allocation(manager: ManagerProtocol <#ironicclient.common.apiclient.base.ManagerProtocol>, info: dict[str, Any], loaded: bool = False)`

Bases: Resource <#ironicclient.common.base.Resource>

(pink flag: no body text in the original here, so no lore to spill — it's just the class declaration, take it as-is 💅)

class `ironicclient.v1.allocation.AllocationManager(api: SessionClient <#ironicclient.common.http.SessionClient>)`

Bases: CreateManager <#ironicclient.common.base.CreateManager>[Allocation]

delete(allocation_id: str, os_ironic_api_version: str | None = None, global_request_id: str | None = None) -> None — deletes the Allocation 💀

Parameters:

allocation_id — the UUID or name of an allocation
os_ironic_api_version — string version (e.g. "1.35") to use for the request. if you don't specify it, the client's default is used
global_request_id — string containing the global request ID header value (in the form "req-<UUID>") to use for the request

get(allocation_id: str, fields: list[str] | None = None, os_ironic_api_version: str | None = None, global_request_id: str | None = None) -> Resource <#ironicclient.common.base.Resource> | None — gets an allocation with the specified identifier 🌸

Parameters:

allocation_id — the UUID or name of an allocation
fields — optional, a list with a specified set of fields of the resource to be returned. can not be used when 'detail' is set 🫶
os_ironic_api_version — string version (e.g. "1.35") to use for the request. if you don't specify it, the client's default is used

global_request_id — String containing global request ID header value (in form "req-<UUID>") to use for the request. 🔑

Returns — an Allocation object. 💖

✨ `list(...)` ✨

list(resource_class: str | None = None, state: str | None = None, node: str | None = None, limit: int | None = None, marker: str | None = None, sort_key: str | None = None, sort_dir: str | None = None, fields: list[str] | None = None, owner: str | None = None, os_ironic_api_version: str | None = None, global_request_id: str | None = None) -> list[Allocation]

Retrieve a list of allocations. Bestie, this is your shopping list of allocations. 🛍️

Parameters

resource_class — Optional, get allocations with this resource class.
state — Optional, get allocations in this state. One of allocating, active or error. Pick your vibe. 💅
node — UUID or name of the node of the allocation. Which node? That node. 👀
marker — Optional, the UUID of an allocation, eg the last allocation from a previous result set. Return the next result set. It's the "continue where we left off" button. ⏭️
limit — The maximum number of results to return per request, if:
1. limit > 0, the maximum number of allocations to return.
2. limit == 0, return the entire list of allocations.
3. limit == None, the number of items returned respect the maximum imposed by the Ironic API (see Ironic's api.max_limit option).
sort_key — Optional, field used for sorting.
sort_dir — Optional, direction of sorting, either 'asc' (the default) or 'desc'.
fields — Optional, a list with a specified set of fields of the resource to be returned.
owner — Optional, project that owns the allocation. Find your allocation's parent. 🫶
os_ironic_api_version — String version (e.g. "1.35") to use for the request. If not specified, the client's default is used. Choose your API era. ✨
global_request_id — String containing global request ID header value (in form "req-<UUID>") to use for the request.

Returns — A list of allocations. ✨

Raises InvalidAttribute if a subset of fields is requested with detail option set. 💀

resource_class — alias of Allocation. 🫶

🌸 `update(...)` 🌸

update(allocation_id: str, patch: list[dict[str, Any]], os_ironic_api_version: str | None = None, global_request_id: str | None = None) -> Resource

Updates the Allocation. Only 'name' and 'extra' field are allowed. 🚨 Like, the API will literally not let you edit anything else, so don't even try.

Parameters

allocation_id — The UUID or name of an allocation.
patch — a json PATCH document to apply to this allocation.
os_ironic_api_version — String version (e.g. "1.35") to use for the request. If not specified, the client's default is used.
global_request_id — String containing global request ID header value (in form "req-<UUID>") to use for the request.

🧚 `wait(...)` 🧚

wait(allocation_id: str, timeout: int | float = 0, poll_interval: int | float = 1, poll_delay_function: Callable[[int | float], object] | None = None, os_ironic_api_version: str | None = None, global_request_id: str | None = None) -> Resource | None

Wait for the Allocation to become active. It's giving "girl, just wait" energy. ⏳

Parameters

timeout — timeout in seconds, no timeout if 0. Zero means forever, which is a choice. 🕰️
poll_interval — interval in seconds between polls.
poll_delay_function — function to use to wait between polls (defaults to time.sleep). Should take one argument - delay time in seconds. Any exceptions raised inside it will abort the wait. So if your custom function throws, the whole wait is cancelled. No cap. 💀
os_ironic_api_version — String version (e.g. "1.35") to use for the request. If not specified, the client's default is used.
global_request_id — String containing global request ID header value (in form "req-<UUID>") to use for the request.

Returns — updated Allocation object. 💖

Raises StateTransitionFailed if allocation reaches the error state. 😭

Raises StateTransitionTimeout on timeout. 💀

🦋 ironicclient.v1.chassis module 🦋

`class ironicclient.v1.chassis.Chassis(manager: ManagerProtocol, info: dict[str, Any], loaded: bool = False)`

Bases: Resource

`class ironicclient.v1.chassis.ChassisManager(api: SessionClient)`

Bases: CreateManager[Chassis]

`delete(chassis_id: str, os_ironic_api_version: str | None = None, global_request_id: str | None = None) -> None`

`get(chassis_id: str, fields: list[str] | None = None, os_ironic_api_version: str | None = None, global_request_id: str | None = None) -> Resource | None`

🎀 `list(...)` 🎀

list(marker: str | None = None, limit: int | None = None, sort_key: str | None = None, sort_dir: str | None = None, detail: bool = False, fields: list[str] | None = None, os_ironic_api_version: str | None = None, global_request_id: str | None = None) -> list[Chassis]

Retrieve a list of chassis. Chassis is already plural, bestie — don't @ me. 💅

Parameters

marker — Optional, the UUID of a chassis, eg the last chassis from a previous result set. Return the next result set.
limit — The maximum number of results to return per request, if:
1. limit > 0, the maximum number of chassis to return.
2. limit == 0, return the entire list of chassis.
3. limit param is NOT specified (None), the number of items returned respect the maximum imposed by the Ironic API (see Ironic's api.max_limit option).
sort_key — Optional, field used for sorting.
sort_dir — Optional, direction of sorting, either 'asc' (the default) or 'desc'.
detail — Optional, boolean whether to return detailed information about chassis. The tea. ☕
fields — Optional, a list with a specified set of fields of the resource to be returned. Can not be used when 'detail' is set. So pick one, okay? 🙅
os_ironic_api_version — String version (e.g. "1.35") to use for the request. If not specified, the client's default is used.
global_request_id — String containing global request ID header value (in form "req-<UUID>") to use for the request.

Returns — A list of chassis. ✨

📱 `list_nodes(...)` 📱

list_nodes(chassis_id: str, marker: str | None = None, limit: int | None = None, sort_key: str | None = None, sort_dir: str | None = None, detail: bool = False, fields: list[str] | None = None, associated: bool | str | None = None, maintenance: bool | str | None = None, provision_state: str | None = None, os_ironic_api_version: str | None = None, global_request_id: str | None = None) -> list[Chassis]

List all the nodes for a given chassis. It's giving "who's in this chassis's group chat?" 📱

Parameters

chassis_id — The UUID of the chassis.
marker — Optional, the UUID of a node, eg the last node from a previous result set. Return the next result set.
limit — The maximum number of results to return per request, if:
1. limit > 0, the maximum number of nodes to return.
2. limit == 0, return the entire list of nodes.
3. limit param is NOT specified (None), the number of items returned respect the maximum imposed by the Ironic API (see Ironic's api.max_limit option).
sort_key — Optional, field used for sorting.
sort_dir — Optional, direction of sorting, either 'asc' (the default) or 'desc'.
detail — Optional, boolean whether to return detailed information about nodes.
fields — Optional, a list with a specified set of fields of the resource to be returned. Can not be used when 'detail' is set.
associated — Optional. Either a Boolean or a string representation of a Boolean that indicates whether to return a list of associated (True or "True") or unassociated (False or "False") nodes. Yes, both the bool and the string work. Versatile. 💁
maintenance — Optional. Either a Boolean or a string representation of a Boolean that indicates whether to return nodes in maintenance mode (True or "True"), or not in maintenance mode (False or "False"). Same deal. 🔧
provision_state — Optional. String value to get only nodes in that provision state. Filter by state, queen. 👑
os_ironic_api_version — String version (e.g. "1.35") to use for the request. If not specified, the client's default is used.
global_request_id — String containing the global request ID header value (in the form "req-<UUID>") to use for the request.

Returns — a list of nodes. (yes, "nodes", that's literally what the docs say on the chassis manager — we did not write that, we just report it 💀)

resource_class — alias of Chassis

update(chassis_id: str, patch: list[dict[str, Any]], os_ironic_api_version: str | None = None, global_request_id: str | None = None) -> Resource

🧚 `ironicclient.v1.client module`

`class ironicclient.v1.client.Client(endpoint_override: str | None = None, *args: Any, **kwargs: Any)`

Bases: object

The main-character client for the Ironic v1 API 👑 this is the thing you actually instantiate, bestie.

Parameters

endpoint_override (string) — A user-supplied endpoint URL for the ironic service.
session — A keystoneauth Session object — and it must be provided as a keyword argument, no cap, don't try to sneak it in positionally.

property current_api_version: str | list[str]

Returns the current API version in use. ✨

This is the version of the REST API that the API client is presently set to request. Heads up: this value can change as a result of API version negotiation — it's not frozen the second you set it.

property is_api_version_negotiated: bool

Returns True if microversion negotiation has already happened. Simple as that 🫶

negotiate_api_version() -> str

Triggers negotiation with the remote API endpoint.

Returns — the negotiated API version.

🎀 `ironicclient.v1.conductor module`

`class ironicclient.v1.conductor.Conductor(manager: ManagerProtocol, info: dict[str, Any], loaded: bool = False)`

Bases: Resource

`class ironicclient.v1.conductor.ConductorManager(api: SessionClient)`

Bases: Manager[Conductor]

get(hostname: str, fields: list[str] | None = None, os_ironic_api_version: str | None = None, global_request_id: str | None = None) -> Resource | None

Retrieve a list of conductors 🎛️ literally just the conductors, in a list.

Parameters

marker — Optional, the hostname of a conductor, e.g. the last conductor from a previous result set. Returns the next result set. (pagination's finest 💅)
limit — Optional. The maximum number of results to return per request, if:
1. limit > 0, the maximum number of ports to return.
2. limit == 0, return the entire list of ports.
3. limit param is NOT specified (None), the number of items returned respect the maximum imposed by the Ironic API (see Ironic's api.max_limit option).
sort_key — Optional, field used for sorting.
sort_dir — Optional, direction of sorting, either 'asc' (the default) or 'desc'.
fields — Optional, a list with a specified set of fields of the resource to be returned. Can not be used when 'detail' is set.
detail — Optional, boolean whether to return detailed information about conductors.
os_ironic_api_version — String version (e.g. "1.35") to use for the request. If not specified, the client's default is used.
global_request_id — String containing the global request ID header value (in the form "req-<UUID>") to use for the request.

Returns — A list of conductors.

resource_class — alias of Conductor

🌈 `ironicclient.v1.create_resources module`

Okay this module is the whole "make a bunch of stuff from a dict / from a file" situation and honestly it's giving bulk-import energy 🔥

create_chassis(client: Client, chassis_list: list[dict[str, object]]) -> list[Exception]

Create chassis from dictionaries.

Parameters

client — ironic client instance.
chassis_list — list of dictionaries to be POSTed to /chassis endpoint; if some of them contain a "nodes" key, its content is POSTed separately to the /nodes endpoint.

Returns — array of exceptions encountered during creation. (not the created things — the exceptions. feel that 🫠)

create_nodes(client: Client, node_list: list[dict[str, object]], chassis_uuid: str | None = None) -> list[Exception]

Create nodes from dictionaries.

Parameters

client — ironic client instance.
node_list — list of dictionaries to be POSTed to /nodes endpoint; if some of them contain a "ports" key, its content is POSTed separately to /ports endpoint.
chassis_uuid — UUID of a chassis the nodes should be associated with.

Returns — array of exceptions encountered during creation.

create_portgroups(client: Client, portgroup_list: list[dict[str, object]], node_uuid: str) -> list[Exception]

Create port groups from dictionaries.

Parameters

client — ironic client instance.
portgroup_list — list of dictionaries to be POSTed to /portgroups endpoint; if some of them contain a "ports" key, its content is POSTed separately to /ports endpoint.
node_uuid — UUID of a node the port groups should be associated with.

Returns — array of exceptions encountered during creation.

create_ports(client: Client, port_list: list[dict[str, object]], node_uuid: str, portgroup_uuid: str | None = None) -> list[Exception]

Create ports from dictionaries.

Parameters

client — ironic client instance.
port_list — list of dictionaries to be POSTed to /ports endpoint.
node_uuid — UUID of a node the ports should be associated with.
portgroup_uuid — UUID of a port group the ports should be associated with, if they are its members.

Returns — array of exceptions encountered during creation.

create_resources(client: Client, filenames: list[str]) -> None

Create resources using their JSON or YAML descriptions 🌸 the "here's a file, go wild" entry point.

Parameters

client — an instance of ironic client;
filenames — a list of filenames containing JSON or YAML resources definitions.

Raises — ClientException if any operation during files processing/resource creation fails. So like, keep an eye on that one.

create_single_chassis(client: Client, **params: Any) -> str

Call the client to create a chassis.

Parameters

client — ironic client instance.
params — dictionary to be POSTed to /chassis endpoint, excluding the "nodes" key.

Returns — UUID of the created chassis or None in case of exception, and an exception, if it appears.

Raises — InvalidAttribute, if some parameters passed to client's create_method are invalid.

Raises — ClientException, if the creation of the chassis fails.

create_single_handler(resource_type: str) -> Callable[[Callable[[...], str]], Callable[[...], tuple[str | None, Exception | None]]]

Catch errors of the creation of a single resource 🧚 the decorator of all time, honestly.

This decorator appends an error (which is an instance of some client exception class) to the return value of the create_method, changing the return value from just UUID to (UUID, error), and does some exception handling.

Parameters

resource_type — string value, the type of the resource being created, e.g. 'node', used purely for exception messages.

create_single_node(client: Client, **params: Any) -> str

Call the client to create a node.

Parameters

client — ironic client instance.
params — dictionary to be POSTed to /nodes endpoint, excluding "ports" and "portgroups" keys.

Returns — UUID of the created node or None in case of exception, and an exception, if it appears.

Raises — InvalidAttribute, if some parameters passed to client's create_method are invalid.

Raises — ClientException, if the creation of the node fails.

create_single_port(client: Client, **params: Any) -> str

Call the client to create a port.

Parameters

client — ironic client instance.
params — dictionary to be POSTed to /ports endpoint.

Returns — UUID of the created port or None in case of exception, and an exception, if it appears.

Raises — InvalidAttribute, if some parameters passed to client's create_method are invalid.

Raises — ClientException, if the creation of the port fails.

create_single_portgroup(client: Client, **params: Any) -> str

Call the client to create a port group.

Parameters

client — ironic client instance.
params — dictionary to be POSTed to /portgroups endpoint, excluding the "ports" key.

Returns — UUID of the created port group or None in case of exception, and an exception, if it appears.

Raises InvalidAttribute, if some parameters passed to client's create_method are invalid.

Raises ClientException, if the creation of the portgroup fails.

ironicclient.v1.create_resources.load_from_file(filename: str) -> dict[str, object]

Okay so this one literally just deserializes JSON or YAML from a file 🍓

Parameters

filename — name of the file containing JSON or YAML.

Returns

a dictionary deserialized from JSON or YAML.

Raises ClientException if the file can not be loaded or if its contents is not a valid JSON or YAML, or if the file extension is not supported.

🚀 `ironicclient.v1.deploy_template` module

class ironicclient.v1.deploy_template.DeployTemplate(manager: ManagerProtocol, info: dict[str, Any], loaded: bool = False)

Bases: Resource

class ironicclient.v1.deploy_template.DeployTemplateManager(api: SessionClient)

Bases: CreateManager[DeployTemplate]

delete(template_id: str, os_ironic_api_version: str | None = None, global_request_id: str | None = None) -> None

get(template_id: str, fields: list[str] | None = None, os_ironic_api_version: str | None = None, global_request_id: str | None = None) -> Resource | None

Retrieve a list of deploy templates 🎀

Parameters

marker — Optional, the UUID of a deploy template, eg the last template from a previous result set. Return the next result set.
limit — the maximum number of results to return per request, if:
1. limit > 0, the maximum number of deploy templates to return.
2. limit == 0, return the entire list of deploy templates.
3. limit param is NOT specified (None), the number of items returned respect the maximum imposed by the Ironic API (see Ironic's api.max_limit option).
sort_key — Optional, field used for sorting.
sort_dir — Optional, direction of sorting, either 'asc' (the default) or 'desc'.
detail — Optional, boolean whether to return detailed information about deploy templates.
fields — Optional, a list with a specified set of fields of the resource to be returned. Can not be used when 'detail' is set.
os_ironic_api_version — String version (e.g. "1.35") to use for the request. If not specified, the client's default is used.
global_request_id — String containing global request ID header value (in form "req-<UUID>") to use for the request.

Returns

A list of deploy templates.

resource_class

alias of DeployTemplate

update(template_id: str, patch: list[dict[str, Any]], os_ironic_api_version: str | None = None, global_request_id: str | None = None) -> Resource

🔧 `ironicclient.v1.driver` module

class ironicclient.v1.driver.Driver(manager: ManagerProtocol, info: dict[str, Any], loaded: bool = False)

Bases: Resource

class ironicclient.v1.driver.DriverManager(api: SessionClient)

Bases: Manager[Driver]

delete(driver_name: str, os_ironic_api_version: str | None = None, global_request_id: str | None = None) -> None

get(driver_name: str, os_ironic_api_version: str | None = None, global_request_id: str | None = None, fields: list[str] | None = None) -> Resource | None

get_vendor_passthru_methods(driver_name: str, os_ironic_api_version: str | None = None, global_request_id: str | None = None) -> dict[str, Any]

Retrieve a list of drivers 💅

Parameters

driver_type — Optional, string to filter the drivers by type. Value should be 'classic' or 'dynamic'.
detail — Optional, flag whether to return detailed information about drivers. Default is None means not to send the arg to the server due to older versions of the server cannot handle filtering on detail. (yes, that sentence is a whole mood 😭)
os_ironic_api_version — String version (e.g. "1.35") to use for the request. If not specified, the client's default is used.
global_request_id — String containing global request ID header value (in form "req-<UUID>") to use for the request.
fields — Optional, a list with a specified set of fields of the resource to be returned. Can not be used when 'detail' is set.

Returns

A list of drivers.

properties(driver_name: str, os_ironic_api_version: str | None = None, global_request_id: str | None = None) -> dict[str, str]

raid_logical_disk_properties(driver_name: str, os_ironic_api_version: str | None = None, global_request_id: str | None = None) -> dict[str, str]

Returns the RAID logical disk properties for the driver. ✨

Parameters

driver_name — Name of the driver.
os_ironic_api_version — String version (e.g. "1.35") to use for the request. If not specified, the client's default is used.
global_request_id — String containing global request ID header value (in form "req-<UUID>") to use for the request.

Returns

A dictionary containing the properties that can be mentioned for RAID logical disks and a textual description for them. It returns an empty dictionary on error.

resource_class

alias of Driver

update(driver_name: str, patch: list[dict[str, Any]], http_method: str = 'PATCH', os_ironic_api_version: str | None = None, global_request_id: str | None = None) -> Resource

Issue requests for vendor-specific actions on a given driver. This is the "call the driver and ask it to do a thing" button 🫶

Parameters

driver_name — The name of the driver.
method — Name of the vendor method.
args — Optional. The arguments to be passed to the method.
http_method — The HTTP method to use on the request. Defaults to POST.
os_ironic_api_version — String version (e.g. "1.35") to use for the request. If not specified, the client's default is used.
global_request_id — String containing global request ID header value (in form "req-<UUID>") to use for the request.

📣 `ironicclient.v1.events` module

class ironicclient.v1.events.Event(manager: ManagerProtocol, info: dict[str, Any], loaded: bool = False)

Bases: Resource

class ironicclient.v1.events.EventManager(api: SessionClient)

Bases: CreateManager[Event]

resource_class

alias of Event

🔍 `ironicclient.v1.inspection_rule` module

class ironicclient.v1.inspection_rule.InspectionRule(manager: ManagerProtocol, info: dict[str, Any], loaded: bool = False)

Bases: Resource

class ironicclient.v1.inspection_rule.InspectionRuleManager(api: SessionClient)

Bases: CreateManager[InspectionRule]

delete(rule_id: str, os_ironic_api_version: str | None = None, global_request_id: str | None = None) -> None

get(rule_id: str, fields: list[str] | None = None, os_ironic_api_version: str | None = None, global_request_id: str | None = None) -> Resource | None

Retrieve a list of rules.

Parameters

marker — Optional, the UUID of a deploy template, eg the last template from a previous result set. Return the next result set. 👉 literally just "next page bestie"
limit — the max number of results to return per request, and here's the vibe check on how it behaves:
1. limit > 0, the maximum number of rules to return.
2. limit == 0, return the entire list of rules. (all of them. every single one. godspeed 🫡)
3. limit param is NOT specified (None), the number of items returned respect the maximum imposed by the Ironic API (see Ironic's api.max_limit option).
sort_key — Optional, field used for sorting.
sort_dir — Optional, direction of sorting, either 'asc' (the default) or 'desc'.
detail — Optional, boolean whether to return detailed information about rules.
fields — Optional, a list with a specified set of fields of the resource to be returned. Can not be used when 'detail' is set. ⚠️ like, pick one, bestie.
os_ironic_api_version — String version (e.g. "1.35") to use for the request. If not specified, the client's default is used.
global_request_id — String containing global request ID header value (in form "req-<UUID>") to use for the request.

📦 Returns

A list of rules. that's it, that's the return 💅

🎀 `resource_class`

alias of InspectionRule — no cap, it's just the same thing wearing a different outfit ✨

🛠️ `update`

update(rule_id: str, patch: list[dict[str, Any]], os_ironic_api_version: str | None = None, global_request_id: str | None = None) -> Resource

🌸 `ironicclient.v1.node` module

okay this is the node era of the client and it's honestly kind of the main character 👑

`class ironicclient.v1.node.Node(manager: ManagerProtocol, info: dict[str, Any], loaded: bool = False)`

Bases: Resource 🫶

`class ironicclient.v1.node.NodeManager(api: SessionClient)`

Bases: CreateManager[Node]

This is the manager, aka the one who actually does stuff. Her methods, in order, no crumbs:

🦋 `add_trait`

add_trait(node_ident: str, trait: str, os_ironic_api_version: str | None = None, global_request_id: str | None = None) -> Node | None

Add a trait to a node. giving the node a little personality sticker 🌈

Parameters

node_ident — node UUID or name.
trait — trait to add to the node.
os_ironic_api_version — String version (e.g. "1.35") to use for the request. If not specified, the client's default is used.
global_request_id — String containing global request ID header value (in form "req-<UUID>") to use for the request.

`delete`

delete(node_id: str, os_ironic_api_version: str | None = None, global_request_id: str | None = None) -> None

`get`

get(node_id: str, fields: list[str] | None = None, os_ironic_api_version: str | None = None, global_request_id: str | None = None) -> Node | None

🔧 `get_bios_setting`

get_bios_setting(node_ident: str, name: str, os_ironic_api_version: str | None = None, global_request_id: str | None = None) -> dict[str, str] | None

Get a BIOS setting from a node. one (1) setting, very demure 💅

Parameters

node_ident — node UUID or name.
name — BIOS setting name to get from the node.
os_ironic_api_version — String version (e.g. "1.35") to use for the request. If not specified, the client's default is used.
global_request_id — String containing global request ID header value (in form "req-<UUID>") to use for the request.

`get_boot_device`

get_boot_device(node_uuid: str, os_ironic_api_version: str | None = None, global_request_id: str | None = None) -> dict[str, str | bool]

`get_by_instance_uuid`

get_by_instance_uuid(instance_uuid: str, fields: list[str] | None = None, os_ironic_api_version: str | None = None, global_request_id: str | None = None) -> Node

`get_console`

get_console(node_uuid: str, os_ironic_api_version: str | None = None, global_request_id: str | None = None) -> dict[str, bool | dict[str, str] | None]

📜 `get_history_event`

get_history_event(node_ident: str, event: str, os_ironic_api_version: str | None = None, global_request_id: str | None = None) -> dict[str, str]

Get a single event record for a node.

Provides the ability to request, and return a node's single event history entry. it's giving scrapbook page energy 🎀

Parameters

node_ident — The name or UUID of the node.
event — The UUID of the event entry as listed in the node event history list.
os_ironic_api_version — String version (e.g. "1.35") to use for the request. If not specified, the client's default is used.
global_request_id — String containing global request ID header value (in form "req-<UUID>") to use for the request.

📜 `get_history_list`

get_history_list(node_ident: str, detail: bool = False, os_ironic_api_version: str | None = None, global_request_id: str | None = None) -> list[dict[str, str]]

Get node history event list.

Provides the ability to query a node event history list from the API and return the API response to the caller. the whole timeline, bestie ✨

Requires API version 1.78. do not forget, she will not work otherwise 💀

Parameters

node_ident — The name or UUID of the node.
detail — If detailed data should be returned in the event list entry. Default False.
os_ironic_api_version — String version (e.g. "1.35") to use for the request. If not specified, the client's default is used.
global_request_id — String containing global request ID header value (in form "req-<UUID>") to use for the request.

🔍 `get_inventory`

get_inventory(node_ident: str, os_ironic_api_version: str | None = None, global_request_id: str | None = None) -> dict[str, Any]

Get the hardware inventory of the node. everything she's made of, lowkey iconic 🔥

Requires API version 1.81. yes, actually. no, you can't skip it 🙈

Parameters

node_ident — The name or UUID of the node.
os_ironic_api_version — String version (e.g. "1.81") to use for the request. If not specified, the client's default is used.
global_request_id — String containing global request ID header value (in form "req-<UUID>") to use for the request.

`get_supported_boot_devices`

get_supported_boot_devices(node_uuid: str, os_ironic_api_version: str | None = None, global_request_id: str | None = None) -> dict[str, list[str]]

🏷️ `get_traits`

get_traits(node_ident: str, os_ironic_api_version: str | None = None, global_request_id: str | None = None) -> list[str]

Get traits for a node. all her little badges 🎀

Parameters

node_ident — node UUID or name.
os_ironic_api_version — String version (e.g. "1.35") to use for the request. If not specified, the client's default is used.
global_request_id — String containing global request ID header value (in form "req-<UUID>") to use for the request.

`get_vendor_passthru_methods`

get_vendor_passthru_methods(node_ident: str, os_ironic_api_version: str | None = None, global_request_id: str | None = None) -> dict[str, dict[str, bool | str | list[str]]]

`inject_nmi`

inject_nmi(node_uuid: str, os_ironic_api_version: str | None = None, global_request_id: str | None = None) -> Node | None

📋 `list`

list(associated: bool | str | None = None, maintenance: bool | str | None = None, marker: str | None = None, limit: int | None = None, detail: bool = False, sort_key: str | None = None, sort_dir: str | None = None, fields: list[str] | None = None, provision_state: str | None = None, driver: str | None = None, resource_class: str | None = None, chassis: str | None = None, fault: str | None = None, os_ironic_api_version: str | None = None, conductor_group: str | None = None, conductor: str | None = None, owner: str | None = None, retired: bool | str | None = None, lessee: str | None = None, shards: list[str] | None = None, sharded: bool | str | None = None, parent_node: str | None = None, include_children: bool | None = None, description_contains: str | None = None, global_request_id: str | None = None, instance_name: str | None = None) -> list[Node]

Retrieve a list of nodes. The big one. The whole roster. 👑

Parameters

associated — Optional. Either a Boolean or a string representation of a Boolean that indicates whether to return a list of associated (True or "True") or unassociated (False or "False") nodes.
maintenance — Optional. Either a Boolean or a string representation of a Boolean that indicates whether to return nodes in maintenance mode (True or "True"), or not in maintenance mode (False or "False").
retired — Optional. Either a Boolean or a string representation of a Boolean that indicates whether to return retired nodes (True or "True").
provision_state — Optional. String value to get only nodes in that provision state.
marker — Optional, the UUID of a node, eg the last node from a previous result set. Return the next result set.

limit — .INDENT 2.0 The maximum number of results to return per request, if:
1. limit > 0, the maximum number of nodes to return.
2. limit == 0, return the entire list of nodes.
3. limit param is NOT specified (None), the number of items returned respect the maximum imposed by the Ironic API (see Ironic's api.max_limit option).
detail — Optional, boolean whether to return detailed information about nodes.
sort_key — Optional, field used for sorting.
sort_dir — Optional, direction of sorting, either 'asc' (the default) or 'desc'.
fields — Optional, a list with a specified set of fields of the resource to be returned. Can not be used when 'detail' is set.
driver — Optional. String value to get only nodes using that driver.
resource_class — Optional. String value to get only nodes with the given resource class set.
chassis — Optional, the UUID of a chassis. Used to get only nodes of this chassis.
fault — Optional. String value to get only nodes with specified fault.
os_ironic_api_version — String version (e.g. "1.35") to use for the request. If not specified, the client's default is used.
global_request_id — String containing global request ID header value (in form "req-<UUID>") to use for the request.
conductor_group — Optional. String value to get only nodes with the given conductor group set.
conductor — Optional. String value to get only nodes mapped to the given conductor.
owner — Optional. String value to get only nodes mapped to a specific owner.
lessee — Optional. String value to get only nodes mapped to a specific lessee.
shards — Optional. A list with a specified set of shards to limit node returns to.
sharded — Optional. Boolean value, when true get only nodes with a non-null node.shard value, when false get only nodes with a null node.shard value. None is a noop. with a non-null node.shard value.
parent_node — Optional. String value used to retrieve child nodes with the supplied parent node.
include_children — Optional. Boolean Value, only True is valid. Tells the ironic API to enumerate all child nodes which are normally hidden from the node list.
description_contains — Optional. String value to get nodes with description contains specified value.
instance_name — Optional. String value to get only nodes with the given instance_name set.

Returns A list of nodes.

🌸 `list_bios_settings` 🌸

list_bios_settings(node_ident: str, detail: bool = False, fields: list[str] | None = None, os_ironic_api_version: str | None = None, global_request_id: str | None = None) -> list[dict[str, str | int | bool | list[str] | None]]

List all BIOS settings from a node.

Parameters

node_ident — node UUID or name.
os_ironic_api_version — String version (e.g. "1.35") to use for the request. If not specified, the client's default is used.
global_request_id — String containing global request ID header value (in form "req-<UUID>") to use for the request.
detail — Optional, boolean whether to return detailed information about bios settings.
fields — Optional, a list with a specified set of fields of the resource to be returned. Can not be used when 'detail' is set.

🦋 `list_children_of_node` 🦋

list_children_of_node(node_id: str, os_ironic_api_version: str | None = None, global_request_id: str | None = None) -> list[str]

Get a list of child nodes for the supplied node_id.

Parameters

node_id — The name or UUID of a node.
os_ironic_api_version — String version (e.g. "1.35") to use for the request. If not specified, the client's default is used.
global_request_id — String containing global request ID header value (in form "req-<UUID>") to use for the request.

Returns A list of UUIDs representing child nodes for the supplied node_id..

⭐ `list_firmware_components` ⭐

list_firmware_components(node_ident: str, os_ironic_api_version: str | None = None, global_request_id: str | None = None) -> list[dict[str, str]]

List all firmware components from a node.

Parameters

node_ident — node UUID or name.
os_ironic_api_version — String version (e.g. "1.35") to use for the request. If not specified, the client's default is used.
global_request_id — String containing global request ID header value (in form "req-<UUID>") to use for the request.

🎀 `list_ports` 🎀

list_ports(node_id: str, marker: str | None = None, limit: int | None = None, sort_key: str | None = None, sort_dir: str | None = None, detail: bool = False, fields: list[str] | None = None, os_ironic_api_version: str | None = None, global_request_id: str | None = None) -> list[Port <#ironicclient.v1.port.Port>]

List all the ports for a given node.

Parameters

node_id — Name or UUID of the node.
marker — Optional, the UUID of a port, eg the last port from a previous result set. Return the next result set.
limit — .INDENT 2.0 The maximum number of results to return per request, if:
1. limit > 0, the maximum number of ports to return.
2. limit == 0, return the entire list of ports.
3. limit param is NOT specified (None), the number of items returned respect the maximum imposed by the Ironic API (see Ironic's api.max_limit option).
sort_key — Optional, field used for sorting.
sort_dir — Optional, direction of sorting, either 'asc' (the default) or 'desc'.
detail — Optional, boolean whether to return detailed information about ports.
fields — Optional, a list with a specified set of fields of the resource to be returned. Can not be used when 'detail' is set.
os_ironic_api_version — String version (e.g. "1.35") to use for the request. If not specified, the client's default is used.
global_request_id — String containing global request ID header value (in form "req-<UUID>") to use for the request.

Returns A list of ports.

💜 `list_volume_connectors` 💜

list_volume_connectors(node_id: str, marker: str | None = None, limit: int | None = None, sort_key: str | None = None, sort_dir: str | None = None, detail: bool = False, fields: list[str] | None = None, os_ironic_api_version: str | None = None, global_request_id: str | None = None) -> list[VolumeConnector <#ironicclient.v1.volume_connector.VolumeConnector>]

List all the volume connectors for a given node.

Parameters

node_id — Name or UUID of the node.
marker — Optional, the UUID of a volume connector, eg the last volume connector from a previous result set. Return the next result set.
limit — .INDENT 2.0 The maximum number of results to return per request, if:
1. limit > 0, the maximum number of volume connectors to return.
2. limit == 0, return the entire list of volume connectors.
3. limit param is NOT specified (None), the number of items returned respect the maximum imposed by the Ironic API (see Ironic's api.max_limit option).
sort_key — Optional, field used for sorting.
sort_dir — Optional, direction of sorting, either 'asc' (the default) or 'desc'.
detail — Optional, boolean whether to return detailed information about volume connectors.
fields — Optional, a list with a specified set of fields of the resource to be returned. Can not be used when 'detail' is set.
os_ironic_api_version — String version (e.g. "1.35") to use for the request. If not specified, the client's default is used.
global_request_id — String containing global request ID header value (in form "req-<UUID>") to use for the request.

Returns A list of volume connectors.

🌈 `list_volume_targets` 🌈

list_volume_targets(node_id: str, marker: str | None = None, limit: int | None = None, sort_key: str | None = None, sort_dir: str | None = None, detail: bool = False, fields: list[str] | None = None, os_ironic_api_version: str | None = None, global_request_id: str | None = None) -> list[VolumeTarget <#ironicclient.v1.volume_target.VolumeTarget>]

List all the volume targets for a given node.

Parameters

node_id — Name or UUID of the node.
marker — optional, and it's the UUID of a volume target, like the last volume target from a previous result set. It returns the next result set. Pagination slay 💅
limit — the maximum number of results to return per request, if:
1. limit > 0 → that's the maximum number of volume targets to return.
2. limit == 0 → return the entire list of volume targets. all of them. the whole buffet 🍓
3. limit param is NOT specified (None) → the number of items returned respect the maximum imposed by the Ironic API (see Ironic's api.max_limit option).
sort_key — optional, the field used for sorting.
sort_dir — optional, direction of sorting, either 'asc' (the default) or 'desc'.
detail — optional, boolean for whether to return detailed information about volume targets.
fields — optional, a list with a specified set of fields of the resource to be returned. Can not be used when 'detail' is set. pick one, bestie, you can't have both 🙈
os_ironic_api_version — string version (e.g. "1.35") to use for the request. If not specified, the client's default is used.
global_request_id — string containing global request ID header value (in form "req-<UUID>") to use for the request.

Returns 💫

A list of volume targets. that's it, that's the tea 🎀

`remove_all_traits`

remove_all_traits(node_ident: str, os_ironic_api_version: str | None = None, global_request_id: str | None = None) -> None

Remove all traits from a node. like, every single one. scorched earth, but make it polite ✨

Parameters

node_ident — node UUID or name.
os_ironic_api_version — string version (e.g. "1.35") to use for the request. If not specified, the client's default is used.
global_request_id — string containing global request ID header value (in form "req-<UUID>") to use for the request.

`remove_trait`

remove_trait(node_ident: str, trait: str, os_ironic_api_version: str | None = None, global_request_id: str | None = None) -> None

Remove one trait from a node. surgical. precise. iconic 💅

Parameters

node_ident — node UUID or name.
trait — trait to remove from the node.
os_ironic_api_version — string version (e.g. "1.35") to use for the request. If not specified, the client's default is used.
global_request_id — string containing global request ID header value (in form "req-<UUID>") to use for the request.

`resource_class`

alias of Node. that's literally the whole vibe check, it's just a nickname for Node 🦋

`set_boot_device`

set_boot_device(node_uuid: str, boot_device: str, persistent: bool = False, os_ironic_api_version: str | None = None, global_request_id: str | None = None) -> Node <#ironicclient.v1.node.Node> | None

(no extra description on this one in the source — the signature is the whole meal, bestie 🫶)

`set_boot_mode`

set_boot_mode(node_id: str, state: str, os_ironic_api_version: str | None = None, global_request_id: str | None = None) -> Node <#ironicclient.v1.node.Node> | None

Sets boot mode for a node. very main character energy for a firmware setting 🔥

Parameters

node_id — Node identifier
state — one of target boot modes, 'uefi' or 'bios'
os_ironic_api_version — string version (e.g. "1.76") to use for the request. If not specified, the client's default is used. (yes, "1.76" — that's the example this one uses, not a typo, don't come for me 😭)
global_request_id — string containing global request ID header value (in form "req-<UUID>") to use for the request.

Raises ValueError if boot mode is not one of 'uefi' / 'bios' — so don't be creative with it 🙈

Returns

The status of the request.

`set_console_mode`

set_console_mode(node_uuid: str, enabled: bool | str, os_ironic_api_version: str | None = None, global_request_id: str | None = None) -> Node <#ironicclient.v1.node.Node> | None

Set the console mode for the node. on or off, that's the whole plot 🌸

Parameters

node_uuid — The UUID of the node.
enabled — Either a Boolean or a string representation of a Boolean. True to enable the console; False to disable.
os_ironic_api_version — string version (e.g. "1.35") to use for the request. If not specified, the client's default is used.
global_request_id — string containing global request ID header value (in form "req-<UUID>") to use for the request.

`set_maintenance`

set_maintenance(node_id: str, state: bool | str, maint_reason: str | None = None, os_ironic_api_version: str | None = None, global_request_id: str | None = None) -> Node <#ironicclient.v1.node.Node> | None

Set the maintenance mode for the node. sometimes a node just needs a little spa day 💆‍♀️

Parameters

node_id — The UUID of the node.
state — the maintenance mode; either a Boolean or a string representation of a Boolean (eg, 'true', 'on', 'false', 'off'). True to put the node in maintenance mode; False to take the node out of maintenance mode.
maint_reason — Optional string. Reason for putting node into maintenance mode. receipts, basically 📝
os_ironic_api_version — string version (e.g. "1.35") to use for the request. If not specified, the client's default is used.
global_request_id — string containing global request ID header value (in form "req-<UUID>") to use for the request.

Raises InvalidAttribute if state is an invalid string (that doesn't represent a Boolean). so like… don't pass 'maybe' 💀

`set_power_state`

set_power_state(node_id: str, state: str, soft: bool = False, timeout: int | None = None, os_ironic_api_version: str | None = None, global_request_id: str | None = None) -> Node <#ironicclient.v1.node.Node> | None

Sets power state for a node. the classic on/off/reboot situation, but make it graceful ✨

Parameters

node_id — Node identifier
state — one of target power state, 'on', 'off', or 'reboot'
soft — the flag for graceful power 'off' or 'reboot'
timeout — the timeout (in seconds) positive integer value (> 0)
os_ironic_api_version — string version (e.g. "1.35") to use for the request. If not specified, the client's default is used.
global_request_id — string containing global request ID header value (in form "req-<UUID>") to use for the request.

Raises ValueError if 'soft' or 'timeout' option is invalid — so no negative seconds, no nonsense, we're not doing that today 🚫

Returns

The status of the request.

`set_provision_state`

set_provision_state(node_uuid: str, state: str, configdrive: str | dict[str, Any] | list[Any] | bytes | None = None, cleansteps: list[dict[str, Any]] | None = None, rescue_password: str | None = None, os_ironic_api_version: str | None = None, global_request_id: str | None = None, deploysteps: list[dict[str, Any]] | None = None, servicesteps: list[dict[str, Any]] | None = None, runbook: str | None = None, disable_ramdisk: bool | str | None = None) -> Node <#ironicclient.v1.node.Node> | None

Set the provision state for the node. this is the big one, the main event, the finale of the whole node lifecycle 👑

Parameters

node_uuid — The UUID or name of the node. (yes, or name, she's flexible 💜)
state — the desired provision state. One of 'active', 'deleted', 'rebuild', 'inspect', 'provide', 'manage', 'clean', 'abort', 'rescue', 'unrescue'.
configdrive — one of:
- a gzipped, base64-encoded configuration drive string
- a dictionary to build config drive from
- a path to the configuration drive file (ISO 9660 or VFAT)
- a path to a directory containing the config drive files
- a path to a JSON file to build config from

In case it's a directory, a config drive will be generated from it. In case it's a dictionary or a JSON file, a config drive will be generated on the server side (requires API version 1.56). This is only valid when setting state to 'active'. so basically don't get cute with it at other states 🎀

cleansteps — the clean steps as a list of clean-step dictionaries; each dictionary should have keys 'interface' and 'step', and optional key 'args'. This must be specified (and is only valid) when setting provision-state to 'clean'. required AND exclusive, she's high maintenance and she's worth it 💅
rescue_password — a string to be used as the login password inside the rescue ramdisk once a node is rescued. This must be specified (and is only valid) when setting 'state' to 'rescue'.
os_ironic_api_version — string version (e.g. "1.35") to use for the request. If not specified, the client's default is used.
global_request_id — string containing global request ID header value (in form "req-<UUID>") to use for the request.

heads up bestie: deploysteps, servicesteps, runbook and disable_ramdisk are all up there in the signature, but the source doesn't spell out descriptions for them here — so I'm not out here inventing lore 🙈

deploysteps — the deploy steps, as a list of deploy-step dictionaries 💅 each dict needs the keys 'interface', 'step', 'priority', plus an optional 'args' key. This one's optional, and it's only valid when you're setting provision-state to 'active' or 'rebuild'.
servicesteps — the service steps, as a list of service-step dictionaries 🎀 each dict needs 'interface', 'step', and an optional 'args' key, for when you're setting an 'active' node to 'service'.
runbook — the identifier of a predefined runbook to use for provisioning. iykyk.
disable_ramdisk — a Boolean; if you set it to true it will not boot the ironic-python-agent for cleaning. Only valid when setting 'state' to 'clean' or 'service', and only for steps explicitly marked as not requiring the ironic-python-agent can you use this one 🙈

Raises InvalidAttribute if there was an error with the clean steps or deploy steps — so like, if you fumbled something, it tells you.

Returns the status of the request ✨

`set_secure_boot`

set_secure_boot(node_id: str, state: bool | str,
os_ironic_api_version: str | None = None, global_request_id: str
| None = None) -> Node <#ironicclient.v1.node.Node> | None

Set the secure boot state for the node. Locking it down, bestie 🔒

Parameters

node_id — the UUID of the node.
state — the secure boot state; either a Boolean or a string representation of a Boolean (eg, 'true', 'on', 'false', 'off'). True to turn secure boot on; False to turn secure boot off. Simple as that.
os_ironic_api_version — string version (e.g. "1.76") to use for the request. If not specified, the client's default is used.
global_request_id — string containing global request ID header value (in form "req-<UUID>") to use for the request.

Raises InvalidAttribute if state is an invalid string (like, one that doesn't represent a Boolean). No vibes-based guessing allowed 💀

`set_target_raid_config`

set_target_raid_config(node_ident: str, target_raid_config:
dict[str, Any], os_ironic_api_version: str | None = None,
global_request_id: str | None = None) -> Node <#ironicclient.v1
.node.Node> | None

Sets target_raid_config for a node. RAID glow-up incoming 🌸

Parameters

node_ident — Node identifier
target_raid_config — a dictionary with the target RAID configuration; may be empty.
os_ironic_api_version — string version (e.g. "1.35") to use for the request. If not specified, the client's default is used.
global_request_id — string containing global request ID header value (in form "req-<UUID>") to use for the request.

Returns — status of the request 🫶

`set_traits`

set_traits(node_ident: str, traits: list[str],
os_ironic_api_version: str | None = None, global_request_id: str
| None = None) -> Node <#ironicclient.v1.node.Node> | None

Set traits for a node. Giving that node a whole personality ✨

Heads up though: this removes any existing traits and adds the traits passed in to this method. It's giving clean slate, not merge 😭

Parameters

node_ident — node UUID or name.
traits — list of traits to add to the node.
os_ironic_api_version — string version (e.g. "1.35") to use for the request. If not specified, the client's default is used.
global_request_id — string containing global request ID header value (in form "req-<UUID>") to use for the request.

`states`

states(node_uuid: str, os_ironic_api_version: str | None = None,
global_request_id: str | None = None) -> Node <#ironicclient.v1
.node.Node> | None

That's it, that's the whole entry. Iconic minimalism 💅

`update`

update(node_id: str, patch: list[dict[str, Any]] | dict[str, Any]
| None, http_method: str = 'PATCH', os_ironic_api_version: str |
None = None, reset_interfaces: bool | None = None,
global_request_id: str | None = None) -> Node <#ironicclient.v1
.node.Node> | None

No prose here either — just the signature, and http_method defaults to 'PATCH' in case you were wondering 🎀

`validate`

validate(node_uuid: str, os_ironic_api_version: str | None =
None, global_request_id: str | None = None) -> Node <#
ironicclient.v1.node.Node> | None

Yep, same energy. Short and sweet 🦋

`vendor_passthru`

vendor_passthru(node_id: str, method: str, args: dict[str, Any] |
None = None, http_method: str | None = None,
os_ironic_api_version: str | None = None, global_request_id: str
| None = None) -> Node <#ironicclient.v1.node.Node> | None

Issue requests for vendor-specific actions on a given node. The back door for vendor stuff 👑

Parameters

node_id — the UUID of the node.
method — name of the vendor method.
args — optional. The arguments to be passed to the method.
http_method — the HTTP method to use on the request. Defaults to POST.
os_ironic_api_version — string version (e.g. "1.35") to use for the request. If not specified, the client's default is used.
global_request_id — string containing global request ID header value (in form "req-<UUID>") to use for the request.

`vif_attach`

vif_attach(node_ident: str, vif_id: str, os_ironic_api_version:
str | None = None, global_request_id: str | None = None,
**kwargs: str) -> None

Attach VIF to a given node. Matchmaker, matchmaker 💖

Parameters

node_ident — the UUID or Name of the node.
vif_id — the UUID or Name of the VIF to attach.
os_ironic_api_version — string version (e.g. "1.35") to use for the request. If not specified, the client's default is used.
global_request_id — string containing global request ID header value (in form "req-<UUID>") to use for the request.
kwargs — a dictionary containing the attributes of the resource that will be created.

`vif_detach`

vif_detach(node_ident: str, vif_id: str, os_ironic_api_version:
str | None = None, global_request_id: str | None = None) -> None

Detach VIF from a given node. Breaking up, but make it network config 💔

Parameters

node_ident — the UUID or Name of the node.
vif_id — the UUID or Name of the VIF to detach.
os_ironic_api_version — string version (e.g. "1.35") to use for the request. If not specified, the client's default is used.
global_request_id — string containing global request ID header value (in form "req-<UUID>") to use for the request.

`vif_list`

vif_list(node_ident: str, os_ironic_api_version: str | None =
None, global_request_id: str | None = None) -> list[Node <#
ironicclient.v1.node.Node>]

List VIFs attached to a given node. Roll call 📋

Parameters

node_ident — the UUID or Name of the node.
os_ironic_api_version — string version (e.g. "1.35") to use for the request. If not specified, the client's default is used.
global_request_id — string containing global request ID header value (in form "req-<UUID>") to use for the request.

`wait_for_provision_state`

wait_for_provision_state(node_ident: str | list[str],
expected_state: str, timeout: int | float = 0, poll_interval: int
| float = 2, poll_delay_function: Callable[[int | float], object]
| None = None, fail_on_unexpected_state: bool = True,
os_ironic_api_version: str | None = None, global_request_id: str
| None = None) -> None

Helper function to wait for nodes to reach a given state. The "are we there yet" of the Ironic world 🚗

It polls the Ironic API in a loop until the node gets to the requested state.

Fails in the following cases:

Timeout (if provided) is reached ⏰
Node's last_error gets set to a non-empty value
Unexpected stable state is reached and fail_on_unexpected_state is on
Error state is reached (if it's not equal to expected_state)

Parameters

node_ident — node UUID or name (one or a list)
expected_state — expected final provision state
timeout — timeout in seconds, no timeout if 0
poll_interval — interval in seconds between 2 poll
poll_delay_function — function to use to wait between polls (defaults to time.sleep). Should take one argument — delay time in seconds. Any exceptions raised inside it will abort the wait.
fail_on_unexpected_state — whether to fail if the nodes reaches a different stable state.
os_ironic_api_version — string version (e.g. "1.35") to use for the request. If not specified, the client's default is used.
global_request_id — string containing global request ID header value (in form "req-<UUID>") to use for the request.

Raises StateTransitionFailed if node reached an error state 😭

Raises StateTransitionTimeout on timeout 💀

`ironicclient.v1.port` module 🦋

`class ironicclient.v1.port.Port(manager: ManagerProtocol, info: dict[str, Any], loaded: bool = False)`

Bases: Resource

class ironicclient.v1.port.Port(
    manager: ManagerProtocol,
    info: dict[str, Any],
    loaded: bool = False,
)

okay so it's a Resource subclass, that's the whole personality 💅

`class ironicclient.v1.port.PortManager(api: SessionClient)`

Bases: CreateManager[Port]

class ironicclient.v1.port.PortManager(api: SessionClient)

`delete(port_id: str, os_ironic_api_version: str | None = None, global_request_id: str | None = None) -> None`

delete(
    port_id: str,
    os_ironic_api_version: str | None = None,
    global_request_id: str | None = None,
) -> None

`get(port_id: str, fields: list[str] | None = None, os_ironic_api_version: str | None = None, global_request_id: str | None = None) -> Port | None`

get(
    port_id: str,
    fields: list[str] | None = None,
    os_ironic_api_version: str | None = None,
    global_request_id: str | None = None,
) -> Port | None

`get_by_address(address: str, fields: list[str] | None = None, os_ironic_api_version: str | None = None, global_request_id: str | None = None) -> Port`

get_by_address(
    address: str,
    fields: list[str] | None = None,
    os_ironic_api_version: str | None = None,
    global_request_id: str | None = None,
) -> Port

`list(address: str | None = None, limit: int | None = None, marker: str | None = None, sort_key: str | None = None, sort_dir: str | None = None, detail: bool = False, fields: list[str] | None = None, node: str | None = None, portgroup: str | None = None, os_ironic_api_version: str | None = None, global_request_id: str | None = None) -> list[Port]`

list(
    address: str | None = None,
    limit: int | None = None,
    marker: str | None = None,
    sort_key: str | None = None,
    sort_dir: str | None = None,
    detail: bool = False,
    fields: list[str] | None = None,
    node: str | None = None,
    portgroup: str | None = None,
    os_ironic_api_version: str | None = None,
    global_request_id: str | None = None,
) -> list[Port]

Retrieve a list of ports. ✨

Parameters

address — Optional, MAC address of a port, to get the port which has this MAC address 🫶
marker — Optional, the UUID of a port, eg the last port from a previous result set. Return the next result set.
limit — the max number of results to return per request, if:
1. limit > 0, the maximum number of ports to return.
2. limit == 0, return the entire list of ports.
3. limit param is NOT specified (None), the number of items returned respect the maximum imposed by the Ironic API (see Ironic's api.max_limit option).
sort_key — Optional, field used for sorting.
sort_dir — Optional, direction of sorting, either 'asc' (the default) or 'desc'.
detail — Optional, boolean whether to return detailed information about ports.
fields — Optional, a list with a specified set of fields of the resource to be returned. Can not be used when 'detail' is set.
node — Optional, name or UUID of a node. Used to get ports of this node.
portgroup — Optional, name or UUID of a portgroup. Used to get ports of this portgroup.
os_ironic_api_version — String version (e.g. "1.35") to use for the request. If not specified, the client's default is used.
global_request_id — String containing global request ID header value (in form "req-<UUID>") to use for the request.

Returns

A list of ports 🎀

`resource_class`

alias of Port

`update(port_id: str, patch: list[dict[str, Any]], os_ironic_api_version: str | None = None, global_request_id: str | None = None) -> Port`

update(
    port_id: str,
    patch: list[dict[str, Any]],
    os_ironic_api_version: str | None = None,
    global_request_id: str | None = None,
) -> Port

`ironicclient.v1.portgroup` module 🌸

`class ironicclient.v1.portgroup.Portgroup(manager: ManagerProtocol, info: dict[str, Any], loaded: bool = False)`

Bases: Resource

class ironicclient.v1.portgroup.Portgroup(
    manager: ManagerProtocol,
    info: dict[str, Any],
    loaded: bool = False,
)

`class ironicclient.v1.portgroup.PortgroupManager(api: SessionClient)`

Bases: CreateManager[Portgroup]

class ironicclient.v1.portgroup.PortgroupManager(api: SessionClient)

`delete(portgroup_id: str, os_ironic_api_version: str | None = None, global_request_id: str | None = None) -> None`

delete(
    portgroup_id: str,
    os_ironic_api_version: str | None = None,
    global_request_id: str | None = None,
) -> None

Delete the Portgroup from the DB. it's gone, bestie, poof 💀

Parameters

portgroup_id — The UUID or name of a portgroup.
os_ironic_api_version — String version (e.g. "1.35") to use for the request. If not specified, the client's default is used.
global_request_id — String containing global request ID header value (in form "req-<UUID>") to use for the request.

`get(portgroup_id: str, fields: list[str] | None = None, os_ironic_api_version: str | None = None, global_request_id: str | None = None) -> Portgroup | None`

get(
    portgroup_id: str,
    fields: list[str] | None = None,
    os_ironic_api_version: str | None = None,
    global_request_id: str | None = None,
) -> Portgroup | None

Get a port group with the specified identifier 🔍

Parameters

portgroup_id — The UUID or name of a portgroup.
fields — Optional, a list with a specified set of fields of the resource to be returned. Can not be used when 'detail' is set.
os_ironic_api_version — String version (e.g. "1.35") to use for the request. If not specified, the client's default is used.
global_request_id — String containing global request ID header value (in form "req-<UUID>") to use for the request.

Returns

a Portgroup object 🫶

`get_by_address(address: str, fields: list[str] | None = None, os_ironic_api_version: str | None = None, global_request_id: str | None = None) -> Portgroup`

get_by_address(
    address: str,
    fields: list[str] | None = None,
    os_ironic_api_version: str | None = None,
    global_request_id: str | None = None,
) -> Portgroup

Get a port group with the specified MAC address 🎀

Parameters

address — The MAC address of a portgroup.
fields — Optional, a list with a specified set of fields of the resource to be returned. Can not be used when 'detail' is set.
os_ironic_api_version — String version (e.g. "1.35") to use for the request. If not specified, the client's default is used.
global_request_id — String containing global request ID header value (in form "req-<UUID>") to use for the request.

Returns

a Portgroup object 💖

`list(node: str | None = None, address: str | None = None, limit: int | None = None, marker: str | None = None, sort_key: str | None = None, sort_dir: str | None = None, detail: bool = False, fields: list[str] | None = None, shards: list[str] | None = None, os_ironic_api_version: str | None = None, global_request_id: str | None = None) -> list[Portgroup]`

list(
    node: str | None = None,
    address: str | None = None,
    limit: int | None = None,
    marker: str | None = None,
    sort_key: str | None = None,
    sort_dir: str | None = None,
    detail: bool = False,
    fields: list[str] | None = None,
    shards: list[str] | None = None,
    os_ironic_api_version: str | None = None,
    global_request_id: str | None = None,
) -> list[Portgroup]

Retrieve a list of portgroups. ✨

Parameters

node — Optional, UUID or name of a node, to get the portgroups for that node.
address — Optional, MAC address of a portgroup, to get the portgroup which has this MAC address.
marker — Optional, the UUID of a portgroup, eg the last portgroup from a previous result set. Return the next result set.
limit — the max number of results to return per request, if:
1. limit > 0, the maximum number of portgroups to return.
2. limit == 0, return the entire list of portgroups.
3. limit == None, the number of items returned respect the maximum imposed by the Ironic API (see Ironic's api.max_limit option).
sort_key — Optional, field used for sorting.
sort_dir — Optional, direction of sorting, either 'asc' (the default) or 'desc'.
detail — Optional, boolean whether to return detailed information about portgroups.
fields — Optional, a list with a specified set of fields of the resource to be returned. Can not be used when 'detail' is set.
shards — Optional, a list of shards to filter portgroups by. Only portgroups associated with nodes in these shards will be returned.
os_ironic_api_version — String version (e.g. "1.35") to use for the request. If not specified, the client's default is used.
global_request_id — String containing global request ID header value (in form "req-<UUID>") to use for the request.

Returns

A list of portgroups 🌈

Raises InvalidAttribute if a subset of fields is requested with detail option set.

fr fr do NOT set detail and pass a fields subset at the same time, it will throw at you and it will not be cute 😭

`list_ports(portgroup_id: str, marker: str | None = None, limit: int | None = None, sort_key: str | None = None, sort_dir: str | None = None, detail: bool = False, fields: list[str] | None = None, os_ironic_api_version: str | None = None, global_request_id: str | None = None) -> list[Portgroup]`

list_ports(
    portgroup_id: str,
    marker: str | None = None,
    limit: int | None = None,
    sort_key: str | None = None,
    sort_dir: str | None = None,
    detail: bool = False,
    fields: list[str] | None = None,
    os_ironic_api_version: str | None = None,
    global_request_id: str | None = None,
) -> list[Portgroup]

List all the ports for a given portgroup 🦋

Parameters

portgroup_id — Name or UUID of the portgroup.
marker — Optional, the UUID of a port, eg the last port from a previous result set. Return the next result set.
limit — the max number of results to return per request, if:
1. limit > 0, the maximum number of ports to return.
2. limit == 0, return the entire list of ports.
3. limit param is NOT specified (None), the number of items returned respect the maximum imposed by the Ironic API (see Ironic's api.max_limit option).
sort_key — optional, the field you wanna sort by.
- sort_dir — optional, which direction to sort: either 'asc' (the default, bestie 💅) or 'desc'.
- detail — optional boolean, do you want the detailed tea about the ports or not.
- fields — optional, a list with a specified set of fields of the resource to be returned. Can not be used when 'detail' is set — pick one, not both, no cap 🙅
- os_ironic_api_version — string version (e.g. "1.35") to use for the request. Don't specify it and the client's default is used.
- global_request_id — string containing the global request ID header value (in the form "req-<UUID>") to use for the request.

Returns

A list of ports. that's it, that's the payoff 🎀

resource_class

alias of Portgroup — literally the same thing wearing a different name, iykyk ✨

`update(portgroup_id: str, patch: list[dict[str, Any]], os_ironic_api_version: str | None = None, global_request_id: str | None = None) -> Portgroup`

Update the Portgroup. glow-up time 💅

Parameters

portgroup_id — the UUID or name of a portgroup.
patch — the patch request with the updates in it.
os_ironic_api_version — string version (e.g. "1.35") to use for the request. If not specified, the client's default is used.
global_request_id — string containing the global request ID header value (in the form "req-<UUID>") to use for the request.

🦋 ironicclient.v1.resource_fields module

`class ironicclient.v1.resource_fields.Resource(field_ids: list[str], sort_excluded: list[str] | None = None, override_labels: dict[str, str] | None = None)`

Bases: object — yes literally just object, humble of it honestly 🫶

Resource class

So this class is the whole manager of the various fields that a resource (think Chassis, Node, Port) contains. Each individual field is made of a 'field_id' (that's the key) and a 'label' (that's the value). The caller only provides the 'field_ids' when instantiating the object — the labels come along for the ride.

The ordering of the 'field_ids' is preserved exactly as the caller specified it. no shuffling, no sorting, we respect the order periodt 👑

It also gives you the ability to exclude some of these fields when they're being used for sorting. handy.

FIELDS: dict[str, str] — the full lookup table, in all its glory:

FIELDS: dict[str, str] = {'actions': 'Actions', 'address': 'Address', 'alive': 'Alive', 'allocation_uuid': 'Allocation UUID', 'allowable_values': 'Allowable Values', 'async': 'Async', 'attach': 'Response is attachment', 'attribute_type': 'Attribute Type', 'automated_clean': 'Automated Clean', 'bios_interface': 'BIOS Interface', 'boot_index': 'Boot Index', 'boot_interface': 'Boot Interface', 'boot_mode': 'Boot Mode', 'candidate_nodes': 'Candidate Nodes', 'category': 'Category', 'chassis_uuid': 'Chassis UUID', 'children': 'Child Nodes', 'clean_step': 'Clean Step', 'conditions': 'Conditions', 'conductor': 'Conductor', 'conductor_group': 'Conductor Group', 'connector_id': 'Connector ID', 'console_enabled': 'Console Enabled', 'console_interface': 'Console Interface', 'count': 'Count', 'created_at': 'Created At', 'default_bios_interface': 'Default BIOS Interface', 'default_boot_interface': 'Default Boot Interface', 'default_console_interface': 'Default Console Interface', 'default_deploy_interface': 'Default Deploy Interface', 'default_firmware_interface': 'Default Firmware Interface', 'default_inspect_interface': 'Default Inspect Interface', 'default_management_interface': 'Default Management Interface', 'default_network_interface': 'Default Network Interface', 'default_power_interface': 'Default Power Interface', 'default_raid_interface': 'Default RAID Interface', 'default_rescue_interface': 'Default Rescue Interface', 'default_storage_interface': 'Default Storage Interface', 'default_vendor_interface': 'Default Vendor Interface', 'deploy_interface': 'Deploy Interface', 'deploy_step': 'Deploy Step', 'description': 'Description', 'disable_power_off': 'Disable Power Off', 'disable_ramdisk': 'Disable Ramdisk', 'driver': 'Driver', 'driver_info': 'Driver Info', 'driver_internal_info': 'Driver Internal Info', 'drivers': 'Drivers', 'duration_seconds': 'Duration (seconds)', 'enabled_bios_interfaces': 'Enabled BIOS Interfaces', 'enabled_boot_interfaces': 'Enabled Boot Interfaces', 'enabled_console_interfaces': 'Enabled Console Interfaces', 'enabled_deploy_interfaces': 'Enabled Deploy Interfaces', 'enabled_firmware_interfaces': 'Enabled Firmware Interfaces', 'enabled_inspect_interfaces': 'Enabled Inspect Interfaces', 'enabled_management_interfaces': 'Enabled Management Interfaces', 'enabled_network_interfaces': 'Enabled Network Interfaces', 'enabled_power_interfaces': 'Enabled Power Interfaces', 'enabled_raid_interfaces': 'Enabled RAID Interfaces', 'enabled_rescue_interfaces': 'Enabled Rescue Interfaces', 'enabled_storage_interfaces': 'Enabled Storage Interfaces', 'enabled_vendor_interfaces': 'Enabled Vendor Interfaces', 'event': 'Description of the event', 'event_type': 'Event Origin Type', 'extra': 'Extra', 'fault': 'Fault', 'firmware_interface': 'Firmware Interface', 'health': 'Health', 'hostname': 'Hostname', 'hosts': 'Active host(s)', 'http_methods': 'Supported HTTP methods', 'id': 'ID', 'inspect_interface': 'Inspect Interface', 'inspection_finished_at': 'Inspection Finished At', 'inspection_started_at': 'Inspection Started At', 'instance_info': 'Instance Info', 'instance_name': 'Instance Name', 'instance_uuid': 'Instance UUID', 'internal_info': 'Internal Info', 'is_smartnic': 'Is Smart NIC port', 'last_error': 'Last Error', 'lessee': 'Lessee', 'local_link_connection': 'Local Link Connection', 'lower_bound': 'Lower Bound', 'maintenance': 'Maintenance', 'maintenance_reason': 'Maintenance Reason', 'management_interface': 'Management Interface', 'max_length': 'Maximum Length', 'min_length': 'Minimum Length', 'mode': 'Mode', 'name': 'Name', 'network_data': 'Network Configuration', 'network_interface': 'Network Interface', 'node_uuid': 'Node UUID', 'owner': 'Owner', 'parent_node': 'Parent Node', 'phase': 'Phase', 'physical_network': 'Physical Network', 'portgroup_uuid': 'Portgroup UUID', 'power_interface': 'Power Interface', 'power_state': 'Power State', 'priority': 'Priority', 'project': 'Project', 'properties': 'Properties', 'protected': 'Protected', 'protected_reason': 'Protected Reason', 'provision_state': 'Provisioning State', 'provision_updated_at': 'Provision Updated At', 'public': 'Public', 'pxe_enabled': 'PXE boot enabled', 'raid_config': 'Current RAID configuration', 'raid_interface': 'RAID Interface', 'read_only': 'Read Only', 'rescue_interface': 'Rescue Interface', 'reservation': 'Reservation', 'reset_required': 'Reset Required', 'resource_class': 'Resource Class', 'retired': 'Retired', 'retired_reason': 'Retired Reason', 'secure_boot': 'Secure Boot', 'sensitive': 'Sensitive', 'severity': 'Severity', 'standalone_ports_supported': 'Standalone Ports Supported', 'state': 'State', 'steps': 'Steps', 'storage_interface': 'Storage Interface', 'target_power_state': 'Target Power State', 'target_provision_state': 'Target Provision State', 'target_raid_config': 'Target RAID configuration', 'traits': 'Traits', 'type': 'Type', 'unique': 'Unique', 'updated_at': 'Updated At', 'upper_bound': 'Upper Bound', 'user': 'User', 'uuid': 'UUID', 'value': 'Value', 'vendor': 'Vendor', 'vendor_interface': 'Vendor Interface', 'volume_id': 'Volume ID', 'volume_type': 'Driver Volume Type'}

Properties — little computed cuties, all tuples of str:

fields: tuple[str, ...]
labels: tuple[str, ...]
sort_fields: tuple[str, ...]
sort_labels: tuple[str, ...]

🌈 ironicclient.v1.runbook module

`class ironicclient.v1.runbook.Runbook(manager: ManagerProtocol, info: dict[str, Any], loaded: bool = False)`

Bases: Resource (ironicclient.common.base.Resource) 🧚

`class ironicclient.v1.runbook.RunbookManager(api: SessionClient)`

Bases: CreateManager[Runbook] (ironicclient.common.base.CreateManager) 👑

`add_trait(runbook_ident: str, trait: str, os_ironic_api_version: str | None = None, global_request_id: str | None = None) -> Runbook | None`

Add a trait to a runbook. give it a little accessory 💅

Requires API version 1.112 or later. no version, no trait, that's the rule bestie.

Parameters

runbook_ident — runbook UUID or name.
trait — the trait to add to the runbook.
os_ironic_api_version — string version (e.g. "1.112") to use for the request. If not specified, the client's default is used.
global_request_id — string containing the global request ID header value (in the form "req-<UUID>") to use for the request.

`delete(runbook_id: str, os_ironic_api_version: str | None = None, global_request_id: str | None = None) -> None`

`get(runbook_id: str, fields: list[str] | None = None, os_ironic_api_version: str | None = None, global_request_id: str | None = None) -> Resource | None`

`get_traits(runbook_ident: str, os_ironic_api_version: str | None = None, global_request_id: str | None = None) -> list[str]`

Get traits for a runbook. the full accessory collection 🔥

Requires API version 1.112 or later. same deal, don't forget it.

Parameters

runbook_ident — runbook UUID or name.
os_ironic_api_version — string version (e.g. "1.112") to use for the request. If not specified, the client's default is used.
global_request_id — string containing the global request ID header value (in the form "req-<UUID>") to use for the request.

list(limit: int | None = None, marker: str | None = None,
sort_key: str | None = None, sort_dir: str | None = None, detail:
bool = False, fields: list[str] | None = None,
os_ironic_api_version: str | None = None, global_request_id: str
| None = None, project: str | None = None, public: bool | None =
None) -> list[Runbook]

Okay so this is the runbook list — retrieve a list of runbooks ✨ (and yeah, project and public are sitting right there in the signature, the param list below just doesn't spell them out — clock the signature, bestie 👀).

Parameters:

marker — Optional, the UUID of a deploy template, eg the last template from a previous result set. Return the next result set.
limit — The maximum number of results to return per request, if:
1. limit > 0, the maximum number of runbooks to return.
2. limit == 0, return the entire list of runbooks.
3. limit param is NOT specified (None), the number of items returned respect the maximum imposed by the Ironic API (see Ironic's api.max_limit option).
sort_key — Optional, field used for sorting.
sort_dir — Optional, direction of sorting, either 'asc' (the default) or 'desc'.
detail — Optional, boolean whether to return detailed information about runbooks.
fields — Optional, a list with a specified set of fields of the resource to be returned. Can not be used when 'detail' is set.
os_ironic_api_version — String version (e.g. "1.35") to use for the request. If not specified, the client's default is used.
global_request_id — String containing global request ID header value (in form "req-<UUID>") to use for the request.

Returns — a list of runbooks. slay 💅

remove_all_traits(runbook_ident: str, os_ironic_api_version: str
| None = None, global_request_id: str | None = None) -> None

Remove all the traits from a runbook. Like, every single one, gone 💀

Requires API version 1.112 or later. Don't skip the vibe check on that one, fr fr.

Parameters:

runbook_ident — runbook UUID or name.
os_ironic_api_version — String version (e.g. "1.112") to use for the request. If not specified, the client's default is used.
global_request_id — String containing global request ID header value (in form "req-<UUID>") to use for the request.

remove_trait(runbook_ident: str, trait: str,
os_ironic_api_version: str | None = None, global_request_id: str
| None = None) -> None

Remove one trait from a runbook — targeted, surgical, main character energy 🎯

Also requires API version 1.112 or later, same deal as above.

Parameters:

runbook_ident — runbook UUID or name.
trait — trait to remove from the runbook.
os_ironic_api_version — String version (e.g. "1.112") to use for the request. If not specified, the client's default is used.
global_request_id — String containing global request ID header value (in form "req-<UUID>") to use for the request.

resource_class — alias of Runbook. That's it, that's the whole thing 🫶

update(runbook_id: str, patch: list[dict[str, Any]],
os_ironic_api_version: str | None = None, global_request_id: str
| None = None) -> Resource

🌈 `ironicclient.v1.shard module` 🌈

`class ironicclient.v1.shard.Shard(manager: ManagerProtocol, info: dict[str, Any], loaded: bool = False)`

Bases: Resource 💜

`class ironicclient.v1.shard.ShardManager(api: SessionClient)`

Bases: Manager[Shard]

list(os_ironic_api_version: str | None = None, global_request_id:
str | None = None) -> list[Shard]

Retrieve a list of shards ✨

Parameters:

os_ironic_api_version — String version (e.g. "1.35") to use for the request. If not specified, the client's default is used.
global_request_id — String containing global request ID header value (in form "req-<UUID>") to use for the request.

Returns — A list of conductors.

Not even joking, that's what it says. Shards in, conductors out 😭 iconic documentation moment, we keep it exactly as it is 💀

resource_class — alias of Shard.

🦋 `ironicclient.v1.utils module` 🦋

(that's the whole section babe, it's just vibes and a heading 💅)

🎀 `ironicclient.v1.volume_connector module` 🎀

`class ironicclient.v1.volume_connector.VolumeConnector(manager: ManagerProtocol, info: dict[str, Any], loaded: bool = False)`

Bases: Resource 🌸

`class ironicclient.v1.volume_connector.VolumeConnectorManager(api: SessionClient)`

Bases: CreateManager[VolumeConnector]

delete(volume_connector_id: str, os_ironic_api_version: str |
None = None, global_request_id: str | None = None) -> None

get(volume_connector_id: str, fields: list[str] | None = None,
os_ironic_api_version: str | None = None, global_request_id: str
| None = None) -> Resource | None

list(node: str | None = None, limit: int | None = None, marker:
str | None = None, sort_key: str | None = None, sort_dir: str |
None = None, detail: bool = False, fields: list[str] | None =
None, os_ironic_api_version: str | None = None,
global_request_id: str | None = None) -> list[VolumeConnector]

Retrieve a list of volume connector. Yes, connector, singular-ish, we don't judge grammar here 🫶

Parameters:

node — Optional, UUID or name of a node, to get volume connectors for this node only.
marker — Optional, the UUID of a volume connector, eg the last volume connector from a previous result set. Return the next result set.
limit — The maximum number of results to return per request, if:
1. limit > 0, the maximum number of volume connectors to return.
2. limit == 0, return the entire list of volume connectors.
3. limit param is NOT specified (None), the number of items returned respect the maximum imposed by the Ironic API (see Ironic's api.max_limit option).
sort_key — Optional, field used for sorting.
sort_dir — Optional, direction of sorting, either 'asc' (the default) or 'desc'.
detail — Optional, boolean whether to return detailed information about volume connectors.
fields — Optional, a list with a specified set of fields of the resource to be returned. Can not be used when 'detail' is set.
os_ironic_api_version — String version (e.g. "1.35") to use for the request. If not specified, the client's default is used.
global_request_id — String containing global request ID header value (in form "req-<UUID>") to use for the request.

Returns — A list of volume connectors. periodt 💅

resource_class — alias of VolumeConnector.

update(volume_connector_id: str, patch: list[dict[str, Any]],
os_ironic_api_version: str | None = None, global_request_id: str
| None = None) -> Resource

🔥 `ironicclient.v1.volume_target module` 🔥

`class ironicclient.v1.volume_target.VolumeTarget(manager: ManagerProtocol, info: dict[str, Any], loaded: bool = False)`

Bases: Resource ⭐

`class ironicclient.v1.volume_target.VolumeTargetManager(api: SessionClient)`

Bases: CreateManager[VolumeTarget]

delete(volume_target_id: str, os_ironic_api_version: str | None =
None, global_request_id: str | None = None) -> None

get(volume_target_id: str, fields: list[str] | None = None,
os_ironic_api_version: str | None = None, global_request_id: str
| None = None) -> Resource | None

list(node: str | None = None, limit: int | None = None, marker:
str | None = None, sort_key: str | None = None, sort_dir: str |
None = None, detail: bool = False, fields: list[str] | None =
None, os_ironic_api_version: str | None = None,
global_request_id: str | None = None) -> list[VolumeTarget]

Retrieve a list of volume target 🌈

Parameters:

node — Optional, UUID or name of a node, to get volume targets for this node only.
marker — Optional, the UUID of a volume target, eg the last volume target from a previous result set. Return the next result set.
limit — The maximum number of results to return per request, if:
1. limit > 0, the maximum number of volume targets to return.
2. limit == 0, return the entire list of volume targets.
3. limit param is NOT specified (None), the number of items returned respect the maximum imposed by the Ironic API (see Ironic's api.max_limit option).
sort_key — Optional, field used for sorting.
sort_dir — optional, and it's literally just the direction of sorting: either 'asc' (which is the default, bestie) or 'desc'. that's it. 💅
detail — optional boolean, and it controls whether you get detailed info about volume targets. fancy mode: on or off 🎀
fields — optional, a list with a specified set of fields of the resource to be returned. ⚠️ heads up: can not be used when 'detail' is set. pick a lane, queen.
os_ironic_api_version — a String version (e.g. "1.35") to use for the request. if you don't specify it, the client's default is what you get. no cap ✨
global_request_id — a String containing the global request ID header value (in form "req-<UUID>") to use for the request. tracking queen 👑

Returns

a list of volume targets. that's the whole payoff. 🦋

`resource_class`

alias of VolumeTarget. it's giving "same energy, different name" 💫

update(volume_target_id: str, patch: list[dict[str, Any]],
os_ironic_api_version: str | None = None, global_request_id: str
| None = None) -> Resource

📚 Module contents

okay so this section is lowkey the index of everything — it says Module contents, then Submodules, and then it dishes out each submodule one by one. let's go 🌈

🧩 ironicclient.client module

`ironicclient.client.Client`

Client(version: str, endpoint_override: str | None = None,
session: Session | None = None, *args: Any, **kwargs: Any) -> Client

create a client of an appropriate version.

🫶 real talk: this call requires a session. if you want it to be created for you, use get_client instead.

Parameters

endpoint_override — a bare metal endpoint to use.
session — a keystoneauth session to use. this argument is actually required and is marked optional only for backward compatibility. the audacity, honestly 😭
args — other arguments to pass to the HTTP client. not recommended, use kwargs instead. please, i'm begging 🥺
kwargs — other keyword arguments to pass to the HTTP client (e.g. insecure).

`ironicclient.client.get_client`

get_client(api_version: str, auth_type: str | None = None,
os_ironic_api_version: str | None = None, max_retries: int | None = None,
retry_interval: int | None = None, session: Session | None = None,
valid_interfaces: str | list[str] | None = None, interface: str |
list[str] | None = None, service_type: str | None = None, region_name:
str | None = None, additional_headers: dict[str, str] | None = None,
global_request_id: str | None = None, **kwargs: Any) -> Client

get an authenticated client, based on the credentials. this is the one that does the whole glow-up for you ✨

Parameters

api_version — the API version to use. Valid value: '1'. yes, just the one. iconic minimalism 💅
auth_type — type of keystoneauth auth plugin loader to use.
os_ironic_api_version — ironic API version to use.
max_retries — maximum number of retries in case of conflict error. perseverance queen 🔥
retry_interval — amount of time (in seconds) between retries in case of conflict error.
session — an existing keystoneauth session. will be created from kwargs if not provided. she's flexible like that 🧚
valid_interfaces — list of valid endpoint interfaces to use if the bare metal endpoint is not provided.
interface — an alias for valid_interfaces. twins fr fr 👯
service_type — bare metal endpoint service type.
region_name — name of the region to use when searching the bare metal endpoint. geographically slaying 🌸
additional_headers — additional headers that should be attached to every request passing through the client. headers of the same name specified per request will take priority. main character headers only 👑
global_request_id — a header (in the form of req-$uuid) that will be passed on all requests. enables cross project request id tracking. that's cross-project, bestie, she's connected 🌐
kwargs — all the other params that are passed to keystoneauth for session construction.

💀 ironicclient.exc module

`ironicclient.exc.AmbigiousAuthSystem`

alias of AmbiguousAuthSystem. yes the typo is canon, we do not touch it. 🙈

exception `ironicclient.exc.AmbiguousAuthSystem`

Bases: ClientException

could not obtain token and endpoint using provided credentials. the credentials said "no ❤️" 😭

exception `ironicclient.exc.InvalidAttribute`

Bases: ClientException

(it's giving mysterious. no description given, just vibes 💀)

exception `ironicclient.exc.StateTransitionFailed`

Bases: ClientException

failed to reach a requested provision state. so close, yet so far 🥲

exception `ironicclient.exc.StateTransitionTimeout`

Bases: ClientException

timed out while waiting for a requested provision state. she waited, she ghosted 💔

`ironicclient.exc.from_response`

from_response(response: Response, message: str | None = None,
traceback: str | None = None, method: str | None = None,
url: str | None = None) -> HttpError

return an HttpError instance based on response from httplib/requests. turning that L into a legible error message 🫶

🐚 ironicclient.shell module

class `ironicclient.shell.App`

Bases: App

`build_option_parser`

build_option_parser(description: str | None, version: str | None,
argparse_kwargs: dict[str, object] | None = None) -> ArgumentParser

return an argparse option parser for this application.

subclasses may override this method to extend the parser with more global options. go off, subclass 💅

Parameters

description (str) — full description of the application
version (str) — version number for the application
argparse_kwargs — extra keyword argument passed to the ArgumentParser constructor

`initialize_app`

initialize_app(argv: list[str]) -> None

hook for subclasses to take global initialization action after the arguments are parsed but before a command is run. invoked only once, even in interactive mode. one and done, no reruns ✨

Parameters

argv — List of arguments, including the subcommand to run. Empty for interactive mode.

class `ironicclient.shell.ClientManager`

ClientManager(cloud_region: CloudRegion, options: Namespace)

Bases: object

property baremetal: Client

class `ironicclient.shell.CommandManager`

CommandManager(namespace: str | None = None, convert_underscores: bool = True,
*, ignored_modules: Iterable[str] | None = None)

Bases: CommandManager

`load_commands`

load_commands(namespace: str) -> None

load all the commands from an entrypoint 📥

Parameters

namespace — The namespace to load commands from.

Returns

None

`ironicclient.shell.main`

main(argv: list[str] = ['-M', 'man', 'doc/source', '.sphinx/man', '-v']) -> int

(that default argv is not a drill, it's literally right there 🎀)

🔎 INDICES AND TABLES

the navigation trio, absolutely serving:

Index
Module Index
Search Page

🖋️ Author

Author name not set — anonymous icon behavior, honestly kind of mysterious 💜

© Copyright

OpenStack Foundation

okay bestie that's the whole page, we ate and left zero crumbs 🍓✨ this was the 6.3.0 version of PYTHON-IRONICCLIENT(1), dated Jan 02, 1980 (yes, really, the date is camp 💀), and it's filed under the name PYTHON-IRONICCLIENT(1). mwah, go build something iconic 🫶👑

📦 where this page comes from

nixpkgs unstable: python3.13-python-ironicclient 6.3.0
💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash-1017 on 2026-11-06: a language model's rewrite of the original, under its terms

PYTHON-IRONICCLIENT(1)

💖 NAME 💖

🌈 CONTENTS 🌈

🐍 ironicclient Python API 🐍

🧚 Usage 🧚

💅 Get a Client object 💅

🔑 Using ironic endpoint and auth token 🔑

🪪 Using Identity Service (keystone) credentials 🪪

⚡ Perform ironic operations ⚡

📦 ironicclient Modules 📦

📚 python-ironicclient User Documentation 📚

🛠️ baremetal Standalone Command-Line Interface (CLI) 🛠️

📜 Synopsis 📜

📝 Description 📝

🔍 Inspector support 🔍

🚀 Standalone usage 🚀

☁️ Usage with OpenStack ☁️

🌟 openstack baremetal Command-Line Interface (CLI) 🌟

📜 Synopsis 📜

📝 Description 📝

🔐 Authentication 🔐

🆘 Getting help 🆘

✨ Examples ✨

📚 Command Reference 📚

📚 Command Reference 📚

🧾 baremetal allocation 🧾

🧾 baremetal allocation create 🧾

baremetal allocation delete

baremetal allocation list

baremetal allocation set

baremetal allocation show

baremetal allocation unset

baremetal chassis

baremetal chassis create

baremetal chassis delete

baremetal chassis list

baremetal chassis set

baremetal chassis show

🦋 baremetal chassis unset 🦋

🌈 baremetal conductor 🌈

🎀 baremetal conductor list 🎀

🌸 baremetal conductor show 🌸

⭐ baremetal create ⭐

⭐ baremetal create ⭐

🧚 baremetal deploy template 🧚

👑 baremetal deploy template create 👑

💀 baremetal deploy template delete 💀

🔥 baremetal deploy template list 🔥

🎀 baremetal deploy template set 🎀

🌸 baremetal deploy template show 🌸

🦋 baremetal deploy template unset 🦋

👑 baremetal driver 👑

✨ baremetal driver list ✨

🔥 baremetal driver passthru call 🔥

💜 baremetal driver passthru list 💜

🧚 baremetal driver property list 🧚

🌈 baremetal driver raid property list 🌈

baremetal driver show

baremetal node

baremetal node abort

baremetal node add trait

baremetal node adopt

baremetal node bios setting list

baremetal node bios setting show

baremetal node boot device set

baremetal node boot device show

baremetal node boot mode set

baremetal node children list

baremetal node clean

🖥️ baremetal node console disable

✨ baremetal node console enable

🎀 baremetal node console show

🦋 baremetal node create

output-ish flags first 💅

now the actual node stuff 🌸

💀 baremetal node delete

🔥 baremetal node deploy

🌸 baremetal node firmware list

🫶 baremetal node history get

🧚 baremetal node history list

🖥️ `baremetal node console disable`

✨ `baremetal node console enable`

🎀 `baremetal node console show`

🦋 `baremetal node create`

💀 `baremetal node delete`

🔥 `baremetal node deploy`

🌸 `baremetal node firmware list`

🫶 `baremetal node history get`

🧚 `baremetal node history list`

💀 `baremetal node inject nmi`

🎀 `baremetal node inspect`

🌈 `baremetal node inventory save`

👑 `baremetal node list`

🎀 `baremetal node show` 🎀

🌸 `baremetal node trait add` 🌸

🦋 `baremetal node trait list` 🦋

🎀 `openstack baremetal port group show`

🦋 `baremetal port group unset`

💅 `baremetal port list`

🌸 `baremetal port set`

🫶 `baremetal port show`

🧚 `baremetal port unset`

🌈 `baremetal volume`

👑 `baremetal volume connector create`

🗑️ `baremetal volume connector delete`

📋 `baremetal volume connector list`

🛠️ `baremetal volume connector set`

🔍 `baremetal volume connector show`

🧹 `baremetal volume connector unset`

🌱 `baremetal volume target create`

🗑️ `baremetal volume target delete`

📋 `baremetal volume target list`