A python client implementing the Ironic API.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Zuul fc31b5e1bd Merge "Standalone CLI: fix a minor issue in the docs" 1 hour ago
doc Standalone CLI: fix a minor issue in the docs 2 hours ago
ironicclient Merge "Standalone CLI: optional support for ironic-inspector" 1 hour ago
playbooks/functional Drop python 2.7 support and testing 4 months ago
releasenotes Merge "Add node lessee" 1 hour ago
tools Remove the ironic command 7 months ago
zuul.d Explicitly set ramdisk type 2 weeks ago
.coveragerc Fix coverage target 3 years ago
.gitignore Drop python 2.7 support and testing 4 months ago
.gitreview OpenDev Migration Patch 11 months ago
.stestr.conf Replace testr with stestr 2 years ago
CONTRIBUTING.rst Update the documentation link for doc migration 2 years ago
LICENSE Add initial files 6 years ago
README.rst Remove the ironic command 7 months ago
lower-constraints.txt A standalone CLI for ironic 2 days ago
requirements.txt Get rid of the oslo.config requirement 21 hours ago
setup.cfg Merge "A standalone CLI for ironic" 1 day ago
setup.py Cleanup py27 support 3 days ago
test-requirements.txt A standalone CLI for ironic 2 days ago
tox.ini Bump hacking to 3.0.0 1 week ago


Python bindings for the Ironic API

Team and repository tags



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