openstack/python-ironicclient
Code Issues Proposed changes
A python client implementing the Ironic API.
583 Commits 5 Branches 45 Tags 21 MiB
Python 100%
059ebb72b0
Go to file
John L. Villalovos 059ebb72b0 Fix pep8 stderr warning regarding __all__ defined as list 
During the pep8 run get the following warning generated:

./ironicclient/__init__.py WARNING: __all__ is defined as a list, this
means pep257 cannot reliably detect contents of the __all__ variable,
because it can be mutated. Change __all__ to be an (immutable) tuple, to
remove this warning. Note, pep257 uses __all__ to detect which
definitions are public, to warn if public definitions are missing
docstrings. If __all__ is a (mutable) list, pep257 cannot reliably
assume its contents. pep257 will proceed assuming __all__ is not
mutated.

Change-Id: I25a5d24e9c429bdd119abf9efb24e3cc822eef4a
2016-03-28 11:02:27 -07:00
doc/source Add documentation on how to run tests 2015-11-18 11:10:01 +02:00
ironicclient Fix pep8 stderr warning regarding __all__ defined as list 2016-03-28 11:02:27 -07:00
releasenotes Merge "Improve output of --json option" 2016-03-22 12:25:02 +00:00
tools Allow functional tests to work with Keystone v3 2016-02-01 15:56:43 +02: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 Update README to work with release tools 2015-04-21 15:29:57 +00:00
requirements.txt Remove httplib2 2016-03-14 18:37:25 +02:00
setup.cfg Drop py33 support 2015-12-15 17:30:47 +09:00
setup.py Updated from global requirements 2015-09-17 12:16:41 +00:00
test-requirements.txt Updated from global requirements 2016-02-08 02:43:39 +00:00
tox.ini Stop ignoring _ as builtin in pep8 2016-02-25 17:51:29 +02: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/.