Skip to main content

OpenStack Bare Metal Provisioning API Client Library

Project description

https://governance.openstack.org/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 a command-line interface (ironic).

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

Command-line API

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 pxe_ipmitool driver:

$ ironic node-create -d pxe_ipmitool

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

OpenStackClient Baremetal Plugin

In order to use Baremetal Plugin the OpenStackClient should be installed:

# pip install python-openstackclient

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

$ openstack baremetal node create --driver agent_ipmitool

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

Change logs with information about specific versions (or tags) are available at:

https://git.openstack.org/cgit/openstack/python-ironicclient/.

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

Uploaded Source

Built Distribution

python_ironicclient-1.15.0-py2.py3-none-any.whl (261.4 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for python-ironicclient-1.15.0.tar.gz
Algorithm Hash digest
SHA256 bd34ecb8e591c1b30b5f8798b2fed48c7f455448c7f4d8549d4c4cffe534c890
MD5 5691e7b88109b4b40c4a8205919b1bac
BLAKE2b-256 5de3d82625b52113f430392eebd5430912f29134cf0956a826aeb3c7428e59d6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for python_ironicclient-1.15.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 e3421aa343b62ffa9e3ddbc5d326f0e361a778a80079fe5abb54b1ef0f5dca23
MD5 872f4843b738d11681701ef98612ae6a
BLAKE2b-256 fafa186d589eaba91a2493267b316bb107308b20d7cc07304ae9db7b15e01775

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