A python client implementing the Ironic API.

Go to file

Ruby Loo fd54fd076f Adds 'openstack baremetal node console' commands Adds the following console-related commands to the OpenStackClient plugin: openstack baremetal node console disable openstack baremetal node console enable openstack baremetal node console show Change-Id: I060531baf84907cdf3763369a43469ec1c860e4d Partial-Bug: #1526479		2016-08-25 09:05:30 -04:00
doc/source	Add docs target to tox.ini	2016-08-19 19:39:11 +03:00
ironicclient	Adds 'openstack baremetal node console' commands	2016-08-25 09:05:30 -04:00
releasenotes	Adds 'openstack baremetal node console' commands	2016-08-25 09:05:30 -04:00
tools	Use constraints for all the things	2016-08-19 08:40:00 -04:00
.coveragerc	Fix coverage target	2016-07-27 14:12:42 -07:00
.gitignore	Add reno for release notes management	2015-12-18 13:05:28 +02:00
.gitreview	Added .gitreview	2013-05-14 22:28:31 +00:00
.testr.conf	Switch tox unit test command to use ostestr	2015-12-15 07:45:07 -08:00
CONTRIBUTING.rst	Workflow documentation is now in infra-manual	2014-12-17 09:24:45 -05:00
LICENSE	Add initial files	2013-09-05 16:35:21 -07:00
README.rst	Fix Quick-start example syntax.	2016-07-13 09:01:38 +03:00
requirements.txt	Use osc_lib instead of cliff	2016-08-25 09:37:33 +08:00
setup.cfg	Adds 'openstack baremetal node console' commands	2016-08-25 09:05:30 -04:00
setup.py	Updated from global requirements	2015-09-17 12:16:41 +00:00
test-requirements.txt	Merge "Updated from global requirements"	2016-08-05 16:25:12 +00:00
tox.ini	Merge "Add docs target to tox.ini"	2016-08-22 15:48:51 +00:00

README.rst

Python bindings for the Ironic API

This is a client for the OpenStack Ironic API. It provides a Python API (the ironicclient module) and a command-line interface (ironic).

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 like the rest of OpenStack.

Contents:

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)

Command-line API

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_TENANT_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 how to create a basic node with the pxe_ipmitool driver:

ironic node-create -d pxe_ipmitool

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

License: Apache License, Version 2.0
Documentation: http://docs.openstack.org/developer/python-ironicclient
Source: http://git.openstack.org/cgit/openstack/python-ironicclient
Bugs: http://bugs.launchpad.net/python-ironicclient

Change logs with information about specific versions (or tags) are available at:

http://git.openstack.org/cgit/openstack/python-ironicclient/.