==================================
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
Raw data
{
"_id": null,
"home_page": "https://docs.openstack.org/python-ironicclient/latest/",
"name": "python-ironicclient",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": "OpenStack",
"author_email": "openstack-discuss@lists.openstack.org",
"download_url": "https://files.pythonhosted.org/packages/c9/be/c8fa91c8c3554eceff66ba998af9f8b90b94c467353e251c9c05618f4eb7/python-ironicclient-5.10.0.tar.gz",
"platform": null,
"description": "==================================\nPython bindings for the Ironic API\n==================================\n\nTeam and repository tags\n------------------------\n\n.. image:: https://governance.openstack.org/tc/badges/python-ironicclient.svg\n :target: https://governance.openstack.org/tc/reference/tags/index.html\n\nOverview\n--------\n\nThis is a client for the OpenStack `Bare Metal API\n<https://docs.openstack.org/api-ref/baremetal/>`_. It provides:\n\n* a Python API: the ``ironicclient`` module, and\n* a command-line interfaces: ``openstack baremetal``\n\nDevelopment takes place via the usual OpenStack processes as outlined in the\n`developer guide <https://docs.openstack.org/infra/manual/developers.html>`_.\nThe master repository is on `opendev.org\n<https://opendev.org/openstack/python-ironicclient/>`_.\n\n``python-ironicclient`` is licensed under the Apache License, Version 2.0,\nlike the rest of OpenStack.\n\n.. contents:: Contents:\n :local:\n\nProject resources\n-----------------\n\n* Documentation: https://docs.openstack.org/python-ironicclient/latest/\n* Source: https://opendev.org/openstack/python-ironicclient\n* PyPi: https://pypi.org/project/python-ironicclient\n* Bugs: https://storyboard.openstack.org/#!/project/959\n* Release notes: https://docs.openstack.org/releasenotes/python-ironicclient/\n\nPython API\n----------\n\nQuick-start Example::\n\n >>> from ironicclient import client\n >>>\n >>> kwargs = {'os_auth_token': '3bcc3d3a03f44e3d8377f9247b0ad155',\n >>> 'ironic_url': 'http://ironic.example.org:6385/'}\n >>> ironic = client.get_client(1, **kwargs)\n\n\n``openstack baremetal`` CLI\n---------------------------\n\nThe ``openstack baremetal`` command line interface is available when the bare\nmetal plugin (included in this package) is used with the `OpenStackClient\n<https://docs.openstack.org/python-openstackclient/latest/>`_.\n\nThere are two ways to install the OpenStackClient (python-openstackclient)\npackage:\n\n* along with this python-ironicclient package::\n\n # pip install python-ironicclient[cli]\n\n* directly::\n\n # pip install python-openstackclient\n\nAn example of creating a basic node with the ``ipmi`` driver::\n\n $ openstack baremetal node create --driver ipmi\n\nAn example of creating a port on a node::\n\n $ openstack baremetal port create --node <UUID> AA:BB:CC:DD:EE:FF\n\nAn example of updating driver properties for a node::\n\n $ openstack baremetal node set --driver-info ipmi_address=<IPaddress> <UUID or name>\n\nFor more information about the ``openstack baremetal`` command and\nthe subcommands available, run::\n\n $ openstack help baremetal\n\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "OpenStack Bare Metal Provisioning API Client Library",
"version": "5.10.0",
"project_urls": {
"Homepage": "https://docs.openstack.org/python-ironicclient/latest/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7b72fac8eb2490312925fe26b49ac3b93372d1d140fe5bd8dc09b79a5576958f",
"md5": "c9778f0f16c9a4f89a5d308161b9a704",
"sha256": "4fe07f4c9a4c5f22c423f38a0d2284fb023a41f673470810e71f3ac279b9b9de"
},
"downloads": -1,
"filename": "python_ironicclient-5.10.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c9778f0f16c9a4f89a5d308161b9a704",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 240973,
"upload_time": "2025-01-10T14:03:16",
"upload_time_iso_8601": "2025-01-10T14:03:16.434155Z",
"url": "https://files.pythonhosted.org/packages/7b/72/fac8eb2490312925fe26b49ac3b93372d1d140fe5bd8dc09b79a5576958f/python_ironicclient-5.10.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c9bec8fa91c8c3554eceff66ba998af9f8b90b94c467353e251c9c05618f4eb7",
"md5": "b9a4961cb81c0cc9c894bd47af93fb2b",
"sha256": "120d9e6a4ae2e7ed613ee2b2abdf9fe1d2f7de297a1b82d82d9be85987d4e0b6"
},
"downloads": -1,
"filename": "python-ironicclient-5.10.0.tar.gz",
"has_sig": false,
"md5_digest": "b9a4961cb81c0cc9c894bd47af93fb2b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 222766,
"upload_time": "2025-01-10T14:03:17",
"upload_time_iso_8601": "2025-01-10T14:03:17.931054Z",
"url": "https://files.pythonhosted.org/packages/c9/be/c8fa91c8c3554eceff66ba998af9f8b90b94c467353e251c9c05618f4eb7/python-ironicclient-5.10.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-10 14:03:17",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "python-ironicclient"
}
JSON