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 d0458b07f1 Merge "Add support for retired{_reason} fields." 5 months ago
doc Drop python 2.7 support and testing 7 months ago
ironicclient Merge "Add support for retired{_reason} fields." 5 months ago
playbooks/functional Drop python 2.7 support and testing 7 months ago
releasenotes Add support for retired{_reason} fields. 5 months ago
tools Remove the ironic command 10 months ago
zuul.d Drop python 2.7 support and testing 7 months ago
.coveragerc Fix coverage target 4 years ago
.gitignore Drop python 2.7 support and testing 7 months ago
.gitreview OpenDev Migration Patch 1 year 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 10 months ago
lower-constraints.txt Stop using six library 6 months ago
requirements.txt Stop using six library 6 months ago
setup.cfg Drop python 2.7 support and testing 7 months ago
setup.py Updated from global requirements 3 years ago
test-requirements.txt Switch to using stestr 2 years ago
tox.ini Enforce running tox with correct python version based on env 6 months ago

README.rst

Python bindings for the Ironic API

Team and repository tags

image

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.

Contents:

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