blob: 33605e8a40ef5271b364428c5c6132f480738e5e (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
|
Python bindings for the Ironic API
==================================
This is a client for the OpenStack `Ironic
<https://wiki.openstack.org/wiki/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
`OpenStack wiki <http://wiki.openstack.org/HowToContribute>`_. The master
repository is on `git.openstack.org
<https://git.openstack.org/cgit/openstack/python-ironicclient>`_.
``python-ironicclient`` is licensed under the Apache License like the rest
of OpenStack.
.. contents:: Contents:
:local:
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/>`_.
|
