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
80
81
82
83
84
85
|
==================================
Python bindings for the Ironic API
==================================
Team and repository tags
------------------------
.. image:: https://governance.openstack.org/tc/badges/python-ironicclient.svg
:target: https://governance.openstack.org/tc/reference/tags/index.html
Overview
--------
This is a client for the OpenStack `Bare Metal API
<https://docs.openstack.org/api-ref/baremetal/>`_. It provides:
* a Python API: the ``ironicclient`` module, and
* a command-line interfaces: ``openstack baremetal``
Development takes place via the usual OpenStack processes as outlined in the
`developer guide <https://docs.openstack.org/infra/manual/developers.html>`_.
The master repository is on `opendev.org
<https://opendev.org/openstack/python-ironicclient/>`_.
``python-ironicclient`` is licensed under the Apache License, Version 2.0,
like the rest of OpenStack.
.. contents:: Contents:
:local:
Project resources
-----------------
* Documentation: https://docs.openstack.org/python-ironicclient/latest/
* Source: https://opendev.org/openstack/python-ironicclient
* PyPi: https://pypi.org/project/python-ironicclient
* Bugs: https://storyboard.openstack.org/#!/project/959
* Release notes: https://docs.openstack.org/releasenotes/python-ironicclient/
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)
``openstack baremetal`` CLI
---------------------------
The ``openstack baremetal`` command line interface is available when the bare
metal plugin (included in this package) is used with the `OpenStackClient
<https://docs.openstack.org/python-openstackclient/latest/>`_.
There are two ways to install the OpenStackClient (python-openstackclient)
package:
* along with this python-ironicclient package::
# pip install python-ironicclient[cli]
* directly::
# pip install python-openstackclient
An example of creating a basic node with the ``ipmi`` driver::
$ openstack baremetal node create --driver ipmi
An example of creating a port on a node::
$ openstack baremetal port create --node <UUID> AA:BB:CC:DD:EE:FF
An example of updating driver properties for a node::
$ openstack baremetal node set --driver-info ipmi_address=<IPaddress> <UUID or name>
For more information about the ``openstack baremetal`` command and
the subcommands available, run::
$ openstack help baremetal
|
