Metadata-Version: 2.4
Name: python-ironicclient
Version: 6.3.0
Summary: OpenStack Bare Metal Provisioning API Client Library
Author-email: OpenStack <openstack-discuss@lists.openstack.org>
License-Expression: Apache-2.0
Project-URL: Homepage, https://docs.openstack.org/python-ironicclient/
Project-URL: Repository, https://opendev.org/openstack/python-ironicclient/
Project-URL: Bug Tracker, https://bugs.launchpad.net/python-ironicclient
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: OpenStack
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Typing :: Typed
Requires-Python: >=3.11
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: pbr>=6.0.0
Requires-Dist: platformdirs>=3
Requires-Dist: cliff>=2.8.0
Requires-Dist: dogpile.cache>=0.8.0
Requires-Dist: jsonschema>=3.2.0
Requires-Dist: keystoneauth1>=3.11.0
Requires-Dist: openstacksdk>=4.10.0
Requires-Dist: osc-lib>=2.0.0
Requires-Dist: oslo.utils>=3.33.0
Requires-Dist: PyYAML>=3.13
Requires-Dist: requests>=2.14.2
Requires-Dist: stevedore>=1.20.0
Provides-Extra: cli
Requires-Dist: python-openstackclient>=3.12.0; extra == "cli"
Dynamic: license-file
Dynamic: requires-dist

==================================
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://bugs.launchpad.net/python-ironicclient
* 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
