openstack/python-ironicclient
Code Issues Proposed changes
A python client implementing the Ironic API.
485 Commits 5 Branches 44 Tags 21 MiB
Python 100%
3843ab81cd
Go to file
Jenkins 3843ab81cd Merge "Fix exceptions.from_response() parameter"
2015-12-08 20:51:53 +00:00
doc/source Add documentation on how to run tests 2015-11-18 11:10:01 +02:00
ironicclient Merge "Fix exceptions.from_response() parameter" 2015-12-08 20:51:53 +00:00
tools Drop explicit Python 2.6 support 2015-11-17 18:06:00 -08:00
.gitignore Adds basic ironicclient functional testing 2015-03-09 13:45:20 -07:00
.gitreview Added .gitreview 2013-05-14 22:28:31 +00:00
.testr.conf Adds basic ironicclient functional testing 2015-03-09 13:45:20 -07: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
MANIFEST.in Add initial files 2013-09-05 16:35:21 -07:00
openstack-common.conf Sync oslo.incubator 2015-05-07 08:35:20 +02:00
README.rst Update README to work with release tools 2015-04-21 15:29:57 +00:00
requirements.txt Updated from global requirements 2015-11-29 02:37:35 +00:00
setup.cfg Drop explicit Python 2.6 support 2015-11-17 18:06:00 -08:00
setup.py Updated from global requirements 2015-09-17 12:16:41 +00:00
test-requirements.txt Updated from global requirements 2015-12-07 09:14:20 +00:00
tox.ini Remove httpretty workaround 2015-11-25 08:02:47 -08: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

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

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