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 59ffddd2e5 Merge "Add tests for 'baremetal port create' command" 6 days ago
doc Update create node from file example 4 months ago
ironicclient Merge "Add tests for 'baremetal port create' command" 6 days ago
playbooks/functional Fix missing tox in functional devstack-minimal based job 8 months ago
releasenotes Support YAML files wherever JSON files are accepted 2 weeks ago
tools Remove future dependency 10 months ago
zuul.d Remove lower-constraints job 2 months ago
.coveragerc Fix coverage target 4 years ago
.gitignore Drop python 2.7 support and testing 1 year ago
.gitreview OpenDev Migration Patch 1 year ago
.stestr.conf Replace testr with stestr 3 years ago
CONTRIBUTING.rst Update the documentation link for doc migration 3 years ago
LICENSE Add initial files 7 years ago
README.rst Add PyPi link to readme.rst 2 months ago
requirements.txt Fix l-c job 5 months ago
setup.cfg Add py38 package metadata 10 months ago
setup.py Cleanup py27 support 11 months ago
test-requirements.txt Move pep8 dependencies from test-requirements to tox.ini 2 months ago
tox.ini Update minversion of tox 1 month 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