Skip to main content

OpenStack Bare Metal Provisioning API Client Library

Project description

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_TENANT_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 how to create 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

For more information, see:

http://docs.openstack.org/developer/python-ironicclient/.

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

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

Project details


Release history Release notifications | RSS feed

This version

0.5.0

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

Uploaded Source

Built Distribution

python_ironicclient-0.5.0-py2.py3-none-any.whl (109.2 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for python-ironicclient-0.5.0.tar.gz
Algorithm Hash digest
SHA256 8f0a92ab0bef5279586432e4ce9dd61381454398340768497883f7a39161f11e
MD5 0786e8723205f07463c7c883219ccb0e
BLAKE2b-256 07ce859e4625cf31648dee5d96157c0b2e19c52cc5286d0d36ed2ec249bc3c28

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for python_ironicclient-0.5.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 5db16a355c71179588077a73f24740f4b893117caf57d8ade58755d907790d7f
MD5 90c2c9a7a4afa8395d2c3c3fedb96ffc
BLAKE2b-256 adcc8982584e6a8eb0e24379a8ee27ff552e75a0549f40a09643d089a8025ed5

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