openstack
/
python-ironicclient
Code Issues Proposed changes
A python client implementing the Ironic API.
272 Commits 6 Branches 36 Tags 20 MiB
Python 100%
Go to file
Jeremy Stanley 77129b82d7 Workflow documentation is now in infra-manual 
Replace URLs for workflow documentation to appropriate parts of the
OpenStack Project Infrastructure Manual.

Dropped sections that duplicate each other after the change.

Co-Authored-By: David Shrewsbury <shrewsbury.dave@gmail.com>

Change-Id: I0642c49567a58797fd811864e95b2d9b4ed21efc
 		2014-12-17 09:24:45 -05:00
doc/source Workflow documentation is now in infra-manual 2014-12-17 09:24:45 -05:00
ironicclient Add option to specify node uuid in node-create subcommand 2014-12-02 18:29:27 -08:00
tools Merge "Add bash completion support for ironic cli" 2014-07-15 18:58:11 +00:00
.gitignore Add initial files 2013-09-05 16:35:21 -07:00
.gitreview Added .gitreview 2013-05-14 22:28:31 +00:00
.testr.conf Add initial files 2013-09-05 16:35:21 -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
README.rst Workflow documentation is now in infra-manual 2014-12-17 09:24:45 -05:00
openstack-common.conf Sync apiclient from Oslo 2014-10-30 14:33:50 +00:00
requirements.txt Updated from global requirements 2014-10-11 22:37:48 +00:00
setup.cfg Support building wheels (PEP-427) 2013-11-19 10:16:42 +01:00
setup.py Updated from global requirements 2014-06-18 00:47:25 +00:00
test-requirements.txt Updated from global requirements 2014-11-21 18:33:12 +00:00
tox.ini Remove unused command in tox.ini 2014-09-26 15:25:59 +09: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

For more information, see:

http://docs.openstack.org/developer/python-ironicclient/.

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

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