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.12.0.tar.gz (225.8 kB view details)

Uploaded Source

Built Distribution

python_ironicclient-5.12.0-py3-none-any.whl (246.8 kB view details)

Uploaded Python 3

File details

Details for the file python_ironicclient-5.12.0.tar.gz.

File metadata

  • Download URL: python_ironicclient-5.12.0.tar.gz
  • Upload date:
  • Size: 225.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.11.12

File hashes

Hashes for python_ironicclient-5.12.0.tar.gz
Algorithm Hash digest
SHA256 f3fdefb096ff04d9174000e20a9443871f07d12d94eb6b1d3efb64bbdc99af5d
MD5 3951be4f546396bbd5b5762565bbd0fb
BLAKE2b-256 834bc62a64a6a1b6b10edf1996e2e497ca8ae0ea7a1c1e9af97a974e168c3d56

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for python_ironicclient-5.12.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bab9bc094ab215f1252454b208f3fec78c7f8f4c569093cefa7b1398cab3dd20
MD5 f8d1b5bca1f353481fdf09d473bde26c
BLAKE2b-256 2e82261d2f962e78e20c5644484110f97e31f463190b313a62f07e7e8f9e675f

See more details on using hashes here.

Supported by

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