openstack/python-ironicclient
Code Issues Proposed changes
A python client implementing the Ironic API.
777 Commits 5 Branches 44 Tags 21 MiB
Python 100%
109b438527
Go to file
Ruby Loo 109b438527 If no resource, don't call Resource.to_dict() 
This adds a new method base.Manager._get_as_dict() which
checks whether there is a resource first, before calling
Resource.to_dict(). Code was modified to call this new
method, instead of calling Resource.to_dict() directly.

This fixes the AttributeError that occurs if, for example, one
tries to get the list of driver passthru methods of the 'fake'
driver (via 'ironic driver-get-vendor-passthru-methods fake').
There are no methods, and without this change, an AttributeError
exception is raised. With this fix, an empty list is returned.

Change-Id: Ib6b691cd39ede9c5902b4df29023fd974b367a7d
Closes-Bug: #1626806
2016-10-04 12:10:08 -04:00
doc/source Add docs target to tox.ini 2016-08-19 19:39:11 +03:00
ironicclient If no resource, don't call Resource.to_dict() 2016-10-04 12:10:08 -04:00
releasenotes If no resource, don't call Resource.to_dict() 2016-10-04 12:10:08 -04: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 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 Updated from global requirements 2016-08-30 14:53:14 +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 Include jsonschema only once in requirements 2016-09-02 11:59:37 +03: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/.