Skip to main content

Python bindings for the Ironic API

Team and repository tags

https://governance.openstack.org/tc/badges/python-ironicclient.svg

Overview

This is a client for the OpenStack Bare Metal API. It provides:

  • a Python API: the ironicclient module, and

  • a command-line interfaces: openstack baremetal

Development takes place via the usual OpenStack processes as outlined in the developer guide. The master repository is on opendev.org.

python-ironicclient is licensed under the Apache License, Version 2.0, like the rest of OpenStack.

Project resources

Python API

Quick-start Example:

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

openstack baremetal CLI

The openstack baremetal command line interface is available when the bare metal plugin (included in this package) is used with the OpenStackClient.

There are two ways to install the OpenStackClient (python-openstackclient) package:

  • along with this python-ironicclient package:

    # pip install python-ironicclient[cli]
  • directly:

    # pip install python-openstackclient

An example of creating a basic node with the ipmi driver:

$ openstack baremetal node create --driver ipmi

An example of creating a port on a node:

$ openstack baremetal port create --node <UUID> AA:BB:CC:DD:EE:FF

An example of updating driver properties for a node:

$ openstack baremetal node set --driver-info ipmi_address=<IPaddress> <UUID or name>

For more information about the openstack baremetal command and the subcommands available, run:

$ openstack help baremetal

Metadata

Release files for python-ironicclient 5.13.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for python-ironicclient 5.13.2
File Size Uploaded Provenance Actions
python_ironicclient-5.13.2.tar.gz 227.7 kB Without provenance Details for python_ironicclient-5.13.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for python-ironicclient 5.13.2
File Interpreter ABI Platform Actions
python_ironicclient-5.13.2-py3-none-any.whl Python 3 none any Details for python_ironicclient-5.13.2-py3-none-any.whl

Total release size: 475.1 kB

Release files / python_ironicclient-5.13.2.tar.gz

Download URL python_ironicclient-5.13.2.tar.gz
Size 227.7 kB
Tags Source
SHA-256 checksum
How to use checksums
10989f0b326e551ad93bb51dad811ddd603e5cfeb09067331cde77f89de747b2
BLAKE2b-256 checksum
How to use checksums
0232ce104d0e3e2cb9c2cf9b9b798b8453a43cd2e710c0c2bf625ac6d07bdec1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.10

Release files / python_ironicclient-5.13.2-py3-none-any.whl

Download URL python_ironicclient-5.13.2-py3-none-any.whl
Size 247.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4de769e3083703117312410ac70a9b25c1b8c2c7708b67ddca5bf8c0c19d7d18
BLAKE2b-256 checksum
How to use checksums
a12ca071f9dd4591bc18cda5f15414cedc7351afa3b8f7a7a816a65b84c7aebb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.10

Security for python-ironicclient 5.13.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

5.13.2 This release

2 release files No provenance

0.0

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page