A python client implementing the Ironic API.
Go to file
Iury Gregory Melo Ferreira f51566545e Drop python 2.7 support and testing
OpenStack is dropping the py2.7 support in ussuri cycle.

python-ironicclient is ready with python 3 and ok to drop the
python 2.7 support.

Complete discussion & schedule can be found in
- http://lists.openstack.org/pipermail/openstack-discuss/2019-October/010142.html
- https://etherpad.openstack.org/p/drop-python2-support

Ussuri Communtiy-wide goal - https://review.opendev.org/#/c/691178/

Change-Id: Iacc50fde00f0d24e9c6ee2b1ac61b8fa060094fb
2019-11-22 11:08:56 +01:00
doc Drop python 2.7 support and testing 2019-11-22 11:08:56 +01:00
ironicclient Merge "Fix usage of --owner filter during node list" 2019-09-24 15:23:58 +00:00
playbooks/functional Drop python 2.7 support and testing 2019-11-22 11:08:56 +01:00
releasenotes Drop python 2.7 support and testing 2019-11-22 11:08:56 +01:00
tools Remove the ironic command 2019-08-20 21:51:12 +00:00
zuul.d Drop python 2.7 support and testing 2019-11-22 11:08:56 +01: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 Remove the ironic command 2019-08-20 21:51:12 +00:00
lower-constraints.txt Build pdf doc 2019-09-05 18:43:33 +08:00
requirements.txt Make the dependency on oslo.config explicit 2019-09-23 15:20:29 +02:00
setup.cfg Drop python 2.7 support and testing 2019-11-22 11:08:56 +01: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 Drop python 2.7 support and testing 2019-11-22 11:08:56 +01:00

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