python-ironicclient


Namepython-ironicclient JSON
Version 5.9.0 PyPI version JSON
download
home_pagehttps://docs.openstack.org/python-ironicclient/latest/
SummaryOpenStack Bare Metal Provisioning API Client Library
upload_time2024-11-12 15:51:07
maintainerNone
docs_urlNone
authorOpenStack
requires_python>=3.9
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ==================================
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/9f/d3/2880a9c16f31c020c90be1790dd25fe475052c275eb583cb16db9bd4b25a/python-ironicclient-5.9.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.9.0",
    "project_urls": {
        "Homepage": "https://docs.openstack.org/python-ironicclient/latest/"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e214a2cc40fe2f8135fdc944a6f784338df3494964d6e22952fca48111040a0f",
                "md5": "a6cf3f401d356846b8dd1b0a09159d20",
                "sha256": "b226c7495b76785d8b709466f1f780d66bf9d910c4cacc4e9d2406ae064058dd"
            },
            "downloads": -1,
            "filename": "python_ironicclient-5.9.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "a6cf3f401d356846b8dd1b0a09159d20",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 236459,
            "upload_time": "2024-11-12T15:51:05",
            "upload_time_iso_8601": "2024-11-12T15:51:05.587343Z",
            "url": "https://files.pythonhosted.org/packages/e2/14/a2cc40fe2f8135fdc944a6f784338df3494964d6e22952fca48111040a0f/python_ironicclient-5.9.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9fd32880a9c16f31c020c90be1790dd25fe475052c275eb583cb16db9bd4b25a",
                "md5": "5a6987a426b6f46d915e1b9f88c209f6",
                "sha256": "c255de1ed402adacc24a90dd62310d6d5735d166f3995eabe9ea90db7c67bdb6"
            },
            "downloads": -1,
            "filename": "python-ironicclient-5.9.0.tar.gz",
            "has_sig": false,
            "md5_digest": "5a6987a426b6f46d915e1b9f88c209f6",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 220842,
            "upload_time": "2024-11-12T15:51:07",
            "upload_time_iso_8601": "2024-11-12T15:51:07.684345Z",
            "url": "https://files.pythonhosted.org/packages/9f/d3/2880a9c16f31c020c90be1790dd25fe475052c275eb583cb16db9bd4b25a/python-ironicclient-5.9.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-12 15:51:07",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "python-ironicclient"
}
        
Elapsed time: 0.59871s