Python client for Ironic Inspector
Project description
This is a client library and tool for ironic-inspector.
Install from PyPI:
pip install python-ironic-inspector-client
Please follow usual OpenStack Gerrit Workflow to submit a patch, see Inspector contributing guide for more detail.
Usage
CLI tool is based on OpenStackClient with prefix openstack baremetal introspection. Accepts optional argument --inspector-url with the ironic-inspector API endpoint.
Start introspection on a node:
ironic_inspector_client.introspect(uuid, new_ipmi_username=None, new_ipmi_password=None)
$ openstack baremetal introspection start UUID [--new-ipmi-password=PWD [--new-ipmi-username=USER]]
uuid - Ironic node UUID;
new_ipmi_username and new_ipmi_password - if these are set, ironic-inspector will switch to manual power on and assigning IPMI credentials on introspection. See Setting IPMI Credentials for details.
Query introspection status:
ironic_inspector_client.get_status(uuid)
$ openstack baremetal introspection status UUID
uuid - Ironic node UUID.
Every call accepts additional optional arguments:
base_url ironic-inspector API endpoint, defaults to 127.0.0.1:5050,
auth_token Keystone authentication token.
api_version requested API version; can be a tuple (MAJ, MIN), string “MAJ.MIN” or integer (only major). Right now only (1, 0) is supported, other versions will raise an exception. Defaults to DEFAULT_API_VERSION.
Two constants are exposed by the client:
DEFAULT_API_VERSION server API version used by default.
MAX_API_VERSION maximum API version this client was designed to work with. Right now providing bigger value for api_version argument raises on exception, this limitation may be lifted later.
Refer to HTTP-API.rst for information on the ironic-inspector HTTP API.
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
Built Distribution
Hashes for python-ironic-inspector-client-1.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6d80745f09726e16307729a003c68a7c04737968ee15607e2099a64a7d832016 |
|
MD5 | 407d1f2ca2126921223690eb5bb0dd37 |
|
BLAKE2b-256 | 371539ae98dafe4fa27e41404b097512714bed3d6b75dae21e7e22daa644d59f |
Hashes for python_ironic_inspector_client-1.0.1-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 80e128d16957911ddbf9e4f7547a79b4a57f32eac281f53bf0b6fae59bc2ba66 |
|
MD5 | df00c12503907c3c7891de9272a744ef |
|
BLAKE2b-256 | 8e14b58bd3c52f50bad88e4d8abadf3a8caf3c49a1c7443fd715997392e349bd |