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

Uploaded Source

Built Distribution

python_ironicclient-4.7.0-py3-none-any.whl (243.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: python-ironicclient-4.7.0.tar.gz
  • Upload date:
  • Size: 214.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.2.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.8.10

File hashes

Hashes for python-ironicclient-4.7.0.tar.gz
Algorithm Hash digest
SHA256 8df53ac396bf657547e1532151f064729905c689cabe8641d932c804bbaf2afe
MD5 540be2fb6765c7330e6f7546c7cd5c3b
BLAKE2b-256 2957905398df3a894342b198860f42beb528950b040e7721c7abe230aa0aa931

See more details on using hashes here.

File details

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

File metadata

  • Download URL: python_ironicclient-4.7.0-py3-none-any.whl
  • Upload date:
  • Size: 243.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.2.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.8.10

File hashes

Hashes for python_ironicclient-4.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cb6ac7fb98ebd2f92493c69032cad57a7675f31956e5ef6f4090cedb66a1f137
MD5 8dc06b930d3614ec82d0d47dde5d3463
BLAKE2b-256 8feaa887f0b97094c51a559e09cd943521fc551246c6306d8062b4473e03893f

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