https://github.com/openstack/python-ironicclient
A python client implementing the Ironic API. Mirror of code maintained at opendev.org.
https://github.com/openstack/python-ironicclient
Last synced: over 1 year ago
JSON representation
A python client implementing the Ironic API. Mirror of code maintained at opendev.org.
- Host: GitHub
- URL: https://github.com/openstack/python-ironicclient
- Owner: openstack
- License: apache-2.0
- Created: 2013-05-14T22:28:29.000Z (about 13 years ago)
- Default Branch: master
- Last Pushed: 2025-03-19T19:31:03.000Z (over 1 year ago)
- Last Synced: 2025-03-29T04:05:13.626Z (over 1 year ago)
- Language: Python
- Homepage: https://opendev.org/openstack/python-ironicclient
- Size: 2.7 MB
- Stars: 59
- Watchers: 9
- Forks: 46
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- Contributing: CONTRIBUTING.rst
- License: LICENSE
Awesome Lists containing this project
README
==================================
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
`_. 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 `_.
The master repository is on `opendev.org
`_.
``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
`_.
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 AA:BB:CC:DD:EE:FF
An example of updating driver properties for a node::
$ openstack baremetal node set --driver-info ipmi_address=
For more information about the ``openstack baremetal`` command and
the subcommands available, run::
$ openstack help baremetal