openstack/python-ironicclient
Code Issues Proposed changes
A python client implementing the Ironic API.
801 Commits 5 Branches 44 Tags 21 MiB
Python 100%
ea7c719f28
Go to file
Rodion Promyshlennikov ea7c719f28 Add basic tests for OSC plugin baremetal node commands 
Add testcases for commands:
openstack baremetal node create,
openstack baremetal node delete,
openstack baremetal node list,
openstack baremetal node show,
openstack baremetal node set,
openstack baremetal node unset.

Change-Id: I32d9e33a868f2224d179f3d16de19f62b85d535e
Partial-Bug: #1566329
2016-11-07 12:39:35 +00:00
doc/source Merge "Add docs for create command" 2016-10-13 00:12:11 +00:00
ironicclient Add basic tests for OSC plugin baremetal node commands 2016-11-07 12:39:35 +00:00
releasenotes Merge "OSC plugin support microversions 1.21 & 1.22" 2016-10-14 10:00:27 +00:00
tools Sync tools/tox_install.sh 2016-08-30 19:47:38 +02:00
.coveragerc Fix coverage target 2016-07-27 14:12:42 -07:00
.gitignore Update .gitignore to ignore .idea of PyCharm 2016-10-10 14:00:38 +08: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 Add prefix "$" for command examples 2016-09-29 20:02:58 +09:00
requirements.txt Updated from global requirements 2016-10-15 00:12:00 +00:00
setup.cfg Merge "Add openstack baremetal driver commands" 2016-08-31 18:33:19 +00:00
setup.py Updated from global requirements 2015-09-17 12:16:41 +00:00
test-requirements.txt Add basic tests for OSC plugin baremetal node commands 2016-11-07 12:39:35 +00:00
tox.ini Don't write python bytecode while testing 2016-08-31 09:58:29 -07: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/.