A python client implementing the Ironic API.

Go to file

Julia Kreger f62758cda5 Remove the ironic command The ironic command is dead, long live the OSC baremetal command. Also removed the json_respose tests, which seemed ot be geared to checking json returned data on the command line. For ironic these tests seemed to be very explicit for our CLI where as OSC should be covering the return data handling, the only real end effect is field level expectation enforcement in the functional test... which seems excessive and un-needed. Story: 1726605 Task: 11974 Depends-on: https://review.opendev.org/677183 Change-Id: I3e3ae416a65d8e01956434ba51bd3187ab001f80		2019-08-20 21:51:12 +00:00
doc	Remove the ironic command	2019-08-20 21:51:12 +00:00
ironicclient	Remove the ironic command	2019-08-20 21:51:12 +00:00
playbooks/functional	Run jobs under python2 and python3	2019-03-15 17:43:19 +01:00
releasenotes	Remove the ironic command	2019-08-20 21:51:12 +00:00
tools	Remove the ironic command	2019-08-20 21:51:12 +00:00
zuul.d	Update Python 3 test runtimes for Train	2019-06-13 11:30:34 +08:00
.coveragerc	Fix coverage target	2016-07-27 14:12:42 -07:00
.gitignore	Remove testrepository	2018-07-11 17:49:59 +07: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	Merge "Fix lower-constraints.txt"	2018-07-14 01:25:55 +00:00
README.rst	Remove the ironic command	2019-08-20 21:51:12 +00:00
requirements.txt	Remove the ironic command	2019-08-20 21:51:12 +00:00
setup.cfg	Remove the ironic command	2019-08-20 21:51:12 +00:00
setup.py	Updated from global requirements	2017-03-02 11:54:32 +00:00
test-requirements.txt	Switch to using stestr	2018-06-05 08:53:23 -04:00
tox.ini	Switch to the new canonical constraints URL on master	2019-06-17 21:42:27 +08: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