Skip to main content

OpenStack Bare Metal Provisioning API Client Library

Project description

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

Python bindings for the Ironic API

This is a client for the OpenStack Ironic API. It provides:

  • a Python API: the ironicclient module, and

  • two command-line interfaces: openstack baremetal and ironic (deprecated, please use openstack baremetal).

Development takes place via the usual OpenStack processes as outlined in the developer guide. The master repository is on git.openstack.org.

python-ironicclient is licensed under the Apache License, Version 2.0, like the rest of OpenStack.

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

ironic CLI (deprecated)

This is deprecated and will be removed in the S* release. Please use the openstack baremetal CLI instead.

This package will install the ironic command line interface that you can use to interact with the ironic API.

In order to use the ironic CLI you’ll need to provide your OpenStack tenant, username, password and authentication endpoint. You can do this with the --os-tenant-name, --os-username, --os-password and --os-auth-url parameters, though it may be easier to set them as environment variables:

$ export OS_PROJECT_NAME=project
$ export OS_USERNAME=user
$ export OS_PASSWORD=pass
$ export OS_AUTH_URL=http://auth.example.com:5000/v2.0

To use a specific Ironic API endpoint:

$ export IRONIC_URL=http://ironic.example.com:6385

An example of creating a basic node with the ipmi driver:

$ ironic node-create -d ipmi

An example of creating a port on a node:

$ ironic port-create -a AA:BB:CC:DD:EE:FF -n nodeUUID

An example of updating driver properties for a node:

$ ironic node-update nodeUUID add driver_info/ipmi_address=<IPaddress>
$ ironic node-update nodeUUID add driver_info/ipmi_username=<username>
$ ironic node-update nodeUUID add driver_info/ipmi_password=<password>

For more information about the ironic command and the subcommands available, run:

$ ironic help

Project details


Release history Release notifications | RSS feed

This version

2.5.3

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

Uploaded Source

Built Distribution

python_ironicclient-2.5.3-py2.py3-none-any.whl (275.1 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: python-ironicclient-2.5.3.tar.gz
  • Upload date:
  • Size: 232.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.5.2

File hashes

Hashes for python-ironicclient-2.5.3.tar.gz
Algorithm Hash digest
SHA256 67ce333671aa1ffa0f11a48ce0de9c6ec70953196e59b99965036da177b80205
MD5 c21ca1c764bb87db9e046a9164de3160
BLAKE2b-256 7eb9e59a94db17d209a75080dbddc0ed34a0a3b7466e8d8c0a8a796acc8c0ef3

See more details on using hashes here.

File details

Details for the file python_ironicclient-2.5.3-py2.py3-none-any.whl.

File metadata

  • Download URL: python_ironicclient-2.5.3-py2.py3-none-any.whl
  • Upload date:
  • Size: 275.1 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.5.2

File hashes

Hashes for python_ironicclient-2.5.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 c5f7008495f0718fd87535e496f548cdef9d4abe4992bcdb3b601466f86ef784
MD5 16aca62befc90f9eb20c607c9ec10478
BLAKE2b-256 273ee32097f442dc6841250cae0c94e095beef0dd84ef9f35af6a528749a82ef

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