A python client implementing the Ironic API.
Go to file
Takashi Kajinami ef4fc3e558 Remove unused check_python_version
This method is not used actually. In addition now the required python
version is enforced by setup.cfg .

Change-Id: If0cbb97c4adfb51f775bf438ad50c8ddf832e794
2022-07-17 00:44:56 +09:00
doc Fix references to ironicclient classes and methods 2021-10-18 15:38:42 +02:00
ironicclient Avoid using 'foo' as invalid JSON test data 2022-03-01 13:42:54 +13:00
playbooks/functional Fix missing tox in functional devstack-minimal based job 2020-06-24 16:52:22 +02:00
releasenotes Update master for stable/yoga 2022-03-07 14:08:55 +00:00
tools Remove unused check_python_version 2022-07-17 00:44:56 +09:00
zuul.d Drop lower-constraints.txt and its testing 2022-05-25 21:23:01 +09:00
.coveragerc Fix coverage target 2016-07-27 14:12:42 -07:00
.gitignore Drop python 2.7 support and testing 2019-11-22 11:08:56 +01:00
.gitreview OpenDev Migration Patch 2019-04-19 19:29:51 +00:00
.stestr.conf Replace testr with stestr 2017-10-06 07:20:47 +00:00
CONTRIBUTING.rst Update the documentation link for doc migration 2017-08-02 08:35:17 +00:00
LICENSE Add initial files 2013-09-05 16:35:21 -07:00
README.rst Add PyPi link to readme.rst 2021-01-03 11:20:52 +08:00
bindep.txt Fix for missing fonts in PDF jobs 2021-07-26 17:12:02 +02:00
requirements.txt Drop lower-constraints.txt and its testing 2022-05-25 21:23:01 +09:00
setup.cfg The Python 3.6 and Python 3.7 Support has been dropped since zed 2022-06-01 16:17:04 +08:00
setup.py Cleanup py27 support 2020-04-04 16:50:23 +02:00
test-requirements.txt Move pep8 dependencies from test-requirements to tox.ini 2020-12-23 12:13:40 +00:00
tox.ini Drop lower-constraints.txt and its testing 2022-05-25 21:23:01 +09:00


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