A python client implementing the Ironic API.

Go to file

Julia Kreger f9d05c7123 Update create node from file example The file was out of date with the removed *_ipmitool drivers and the driver_info field which should be posted on node creation to the API. Change-Id: I18ece4f2472a0aced2874992c18a8871665f9621		2020-10-21 11:44:44 -07:00
doc	Update create node from file example	2020-10-21 11:44:44 -07:00
ironicclient	Merge "Allow to pass global request id in port and volume"	2020-07-02 08:54:20 +00:00
playbooks/functional	Fix missing tox in functional devstack-minimal based job	2020-06-24 16:52:22 +02:00
releasenotes	Merge "Add port-uuid parameter to node vif attach"	2020-06-29 20:46:05 +00:00
tools	Remove future dependency	2020-05-04 15:14:53 +02:00
zuul.d	Restore default netboot boot option	2020-04-27 16:03:48 +02: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
lower-constraints.txt	drop mock from lower-constraints	2020-06-09 11:55:41 +02:00
README.rst	Remove the ironic command	2019-08-20 21:51:12 +00:00
requirements.txt	Cap jsonschema 3.2.0 as the minimal version	2020-05-26 22:11:07 +02:00
setup.cfg	Add py38 package metadata	2020-05-02 07:06:42 -05:00
setup.py	Cleanup py27 support	2020-04-04 16:50:23 +02:00
test-requirements.txt	Use unittest.mock instead of third party mock	2020-04-30 10:07:00 +02:00
tox.ini	Set min version of tox to 3.2.1	2020-07-15 15:31:46 +02:00

README.rst

Python bindings for the Ironic API

Team and repository tags

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

Documentation: https://docs.openstack.org/python-ironicclient/latest/
Source: https://opendev.org/openstack/python-ironicclient
Bugs: https://storyboard.openstack.org/#!/project/959
Release notes: https://docs.openstack.org/releasenotes/python-ironicclient/

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