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
License: Apache License, Version 2.0
Documentation: http://docs.openstack.org/developer/python-ironicclient
Source: http://git.openstack.org/cgit/openstack/python-ironicclient
Change logs with information about specific versions (or tags) are available at:
http://git.openstack.org/cgit/openstack/python-ironicclient/.
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
Built Distribution
Hashes for python-ironicclient-1.2.0.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | de18d22d111a457567dc1c59638a6a73f4e7e91aaf3cde3f1b8f1a03e927c8a8 |
|
| MD5 | 10671d115f12c0f217d1421844073b94 |
|
| BLAKE2b-256 | 274f1c7fbb8e2f28811b1aa7e8a6db1d68947cfb6b14d7309049a6e588062d9f |
Hashes for python_ironicclient-1.2.0-py2.py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 65051564ca466840063ca2082dfe18ea101d276b8166ddfe6b903aa86d6b7350 |
|
| MD5 | 57a9b6f6d490046503f8a55946d913f2 |
|
| BLAKE2b-256 | 574250ce54f4820577a984a5f6169aa4051f3d99fb0eb9e1cd6ac64aaedd8da6 |
