Skip to content


Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
A python client implementing the Ironic API.

Updated from global requirements

Change-Id: I090e80b072e6480ed95c21382ae88a14d9461ff9
latest commit 720effdd4c
OpenStack Proposal Bot authored


Python bindings for the Ironic API

This is a client for the OpenStack Ironic API. It provides a Python API (the ironicclient module) and a command-line interface (ironic).

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

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

Python API

Quick-start Example::
>>> from ironicclient import client
>>> kwargs = {'os_auth_token': '3bcc3d3a03f44e3d8377f9247b0ad155'
>>>           'ironic_url': ''}
>>> ironic = client.get_client(1, **kwargs)

Command-line API

This package will install the ironic command line interface that you can use to interact with the ironic API.

In order to use the ironic CLI you'll need to provide your OpenStack tenant, username, password and authentication endpoint. You can do this with the --os-tenant-name, --os-username, --os-password and --os-auth-url parameters, though it may be easier to set them as environment variables:

export OS_TENANT_NAME=project
export OS_USERNAME=user
export OS_PASSWORD=pass
export OS_AUTH_URL=

To use a specific Ironic API endpoint:

export IRONIC_URL=

An example of how to create a basic node with the pxe_ipmitool driver:

ironic node-create -d pxe_ipmitool

An example of creating a port on a node:

ironic port-create -a AA:BB:CC:DD:EE:FF -n nodeUUID

An example of updating driver properties for a node:

ironic node-update nodeUUID add driver_info/ipmi_address=<IPaddress>
ironic node-update nodeUUID add driver_info/ipmi_username=<username>
ironic node-update nodeUUID add driver_info/ipmi_password=<password>

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

ironic help

Change logs with information about specific versions (or tags) are available at:
Something went wrong with that request. Please try again.