Skip to main content

OpenStack Bare Metal Provisioning API Client Library

Project description

Team and repository tags

https://governance.openstack.org/tc/badges/python-ironicclient.svg

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.

Project resources

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 <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

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

python-ironicclient-5.9.0.tar.gz (220.8 kB view details)

Uploaded Source

Built Distribution

python_ironicclient-5.9.0-py3-none-any.whl (236.5 kB view details)

Uploaded Python 3

File details

Details for the file python-ironicclient-5.9.0.tar.gz.

File metadata

  • Download URL: python-ironicclient-5.9.0.tar.gz
  • Upload date:
  • Size: 220.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.9

File hashes

Hashes for python-ironicclient-5.9.0.tar.gz
Algorithm Hash digest
SHA256 c255de1ed402adacc24a90dd62310d6d5735d166f3995eabe9ea90db7c67bdb6
MD5 5a6987a426b6f46d915e1b9f88c209f6
BLAKE2b-256 9fd32880a9c16f31c020c90be1790dd25fe475052c275eb583cb16db9bd4b25a

See more details on using hashes here.

File details

Details for the file python_ironicclient-5.9.0-py3-none-any.whl.

File metadata

File hashes

Hashes for python_ironicclient-5.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b226c7495b76785d8b709466f1f780d66bf9d910c4cacc4e9d2406ae064058dd
MD5 a6cf3f401d356846b8dd1b0a09159d20
BLAKE2b-256 e214a2cc40fe2f8135fdc944a6f784338df3494964d6e22952fca48111040a0f

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page