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

Uploaded Source

Built Distribution

python_ironicclient-4.4.1-py3-none-any.whl (240.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: python-ironicclient-4.4.1.tar.gz
  • Upload date:
  • Size: 213.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.11

File hashes

Hashes for python-ironicclient-4.4.1.tar.gz
Algorithm Hash digest
SHA256 64aadfdf6ae53c43e87c21c269a10c15f872aa9ed60f9194792943e17b48f505
MD5 32f9c3534c81d8c0ec52d75134956326
BLAKE2b-256 e8c736049eb39bbf01f4e33fce0fa3c704bc2ef5e1cf26f602d7fb21c564cfce

See more details on using hashes here.

File details

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

File metadata

  • Download URL: python_ironicclient-4.4.1-py3-none-any.whl
  • Upload date:
  • Size: 240.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.11

File hashes

Hashes for python_ironicclient-4.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 667f708bdef66e7e1a4ad947733acf85a94a4506f53ca0ebe89a038553b6e2a0
MD5 3810054ef06b58c286a557a637fad273
BLAKE2b-256 d79180c6f87f17bf818df44e515ddf925997b9dc57aa3e41b794188174c7d48f

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