A python client implementing the Ironic API.
Go to file
Dmitry Tantsur 1c941eefe5 Support for protected and protected_reason fields
Story: #2003869
Task: #27624
Depends-On: https://review.openstack.org/611662
Change-Id: Ib575ace38d1bedce54d0d21517d745ed3204d6f2
2018-11-27 10:12:10 +01:00
doc Include python API reference in docs 2018-05-31 12:34:35 +03:00
ironicclient Support for protected and protected_reason fields 2018-11-27 10:12:10 +01:00
playbooks/legacy Do not run functional (API) tests in the CI 2018-04-30 15:40:59 +02:00
releasenotes Support for protected and protected_reason fields 2018-11-27 10:12:10 +01:00
tools Allow to use none auth in functional tests 2018-05-18 08:57:22 +00:00
zuul.d Use templates for cover and lower-constraints 2018-09-22 17:59:38 +02: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 Added .gitreview 2013-05-14 22:28:31 +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 Modify useful links to project resources in README 2018-09-28 14:26:05 +01:00
requirements.txt Switch to none auth for standalone mode 2018-05-07 13:52:45 +00:00
setup.cfg BIOS Settings support 2018-06-12 08:51:19 +08: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 Update min tox version to 2.0 2018-10-21 02:18:59 +00:00

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
  • two command-line interfaces: openstack baremetal and ironic (deprecated, please use openstack baremetal).

Development takes place via the usual OpenStack processes as outlined in the developer guide. The master repository is on git.openstack.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

ironic CLI (deprecated)

This is deprecated and will be removed in the S* release. Please use the openstack baremetal CLI instead.

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_PROJECT_NAME=project
$ export OS_USERNAME=user
$ export OS_PASSWORD=pass
$ export OS_AUTH_URL=http://auth.example.com:5000/v2.0

To use a specific Ironic API endpoint:

$ export IRONIC_URL=http://ironic.example.com:6385

An example of creating a basic node with the ipmi driver:

$ ironic node-create -d ipmi

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