Welcome to Ironic Inspector Client¶
Ironic Inspector Client¶
This is a client library and tool for Ironic Inspector.
- Free software: Apache license
- Source: https://git.openstack.org/cgit/openstack/python-ironic-inspector-client
- Documentation: http://docs.openstack.org/developer/python-ironic-inspector-client
- Bugs: https://bugs.launchpad.net/python-ironic-inspector-client
- Downloads: https://pypi.python.org/pypi/python-ironic-inspector-client
Please follow usual OpenStack Gerrit Workflow to submit a patch, see Inspector contributing guide for more detail.
Refer to the HTTP API reference for information on the Ironic Inspector HTTP API.
Command Line Tool¶
CLI tool is based on OpenStackClient with prefix
openstack baremetal introspection.
Python API¶
To use Python API first create a ClientV1 object:
import ironic_inspector_client
client = ironic_inspector_client.ClientV1(session=keystone_session)
This code creates a client with API version 1.0 and a given Keystone
session. The service URL is fetched from the service catalog in this case.
See ironic_inspector_client.v1.ClientV1 documentation for details.
API Versioning¶
Starting with version 2.1.0 Ironic Inspector supports optional API versioning. Version is a tuple (X, Y), where X is always 1 for now.
The server has maximum and minimum supported versions. If no version is requested, the server assumes the maximum it’s supported.
Two constants are exposed for convenience: