Python client for Ironic Inspector
Project description
This is a client library and tool for Ironic Inspector.
Free software: Apache license
Source: http://git.openstack.org/cgit/openstack/python-ironic-inspector-client
Bugs: http://bugs.launchpad.net/python-ironic-inspector-client
Downloads: https://pypi-hypernode.com/pypi/python-ironic-inspector-client
Please follow usual OpenStack Gerrit Workflow to submit a patch, see Inspector contributing guide for more detail.
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. Optional arguments service_type, interface and region_name can be provided to modify how the URL is looked up.
If the catalog lookup fails, the local host with port 5050 is tried. However, this behaviour is deprecated and should not be relied on. Also an explicit inspector_url can be passed to bypass service catalog.
Optional api_version argument is a minimum API version that a server must support. It can be a tuple (MAJ, MIN), string “MAJ.MIN” or integer (only major, minimum supported minor version is assumed).
See Usage for the list of available calls.
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 (1, 0).
Two constants are exposed for convenience:
DEFAULT_API_VERSION server API version used by default, always (1, 0) for now.
MAX_API_VERSION maximum API version this client was designed to work with. This does not mean that other versions won’t work at all - the server might still support them.
Usage
CLI tool is based on OpenStackClient with prefix openstack baremetal introspection. Accepts optional argument --inspector-url with the Ironic Inspector API endpoint.
Refer to the HTTP API reference for information on the Ironic Inspector HTTP API.
Detect server API versions
client.server_api_versions()
Returns a tuple (minimum version, maximum version). See API Versioning for details.
Start introspection on a node
client.introspect(uuid, new_ipmi_username=None, new_ipmi_password=None)
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.
CLI:
$ openstack baremetal introspection start [--wait] [--new-ipmi-password=PWD [--new-ipmi-username=USER]] UUID [UUID ...]
Note that the CLI call accepts several UUID’s and will stop on the first error.
With --wait flag it waits until introspection ends for all given nodes, then displays the results as a table.
Query introspection status
client.get_status(uuid)
uuid - Ironic node UUID.
Returns a dict with keys:
finished - whether introspection has finished for this node;
error - last error, None if introspection ended without an error.
CLI:
$ openstack baremetal introspection status UUID
Retrieving introspection data
client.get_data(uuid[, raw])
uuid - Ironic node UUID;
raw - whether to return raw data or parsed JSON data (the default).
CLI:
$ openstack baremetal introspection data save [--file=file_name] UUID
If file name is not provided, the data is dumped to stdout.
Aborting introspection
client.abort(uuid)
uuid - Ironic node UUID.
CLI:
$ openstack baremetal introspection abort UUID
Introspection Rules API
All functions related to introspection rules are grouped under rules attribute of the ClientV1 object.
Creating a rule
client.rules.create(conditions, actions[, uuid][, description])
conditions and actions are lists of dictionaries with rule conditions and actions accordingly. Please refer to the introspection rules documentation for details on.
uuid rule UUID, will be generated, if missing.
description optional rule description.
This call is not directly represented in CLI, use import below.
client.rules.from_json(rule_json)
rule_json dictionary with a rule representation.
CLI:
$ openstack baremetal introspection rule import <JSON FILE>
Listing all rules
client.rules.list()
Returns list of short rule representations, containing only description, UUID and links.
CLI:
$ openstack baremetal introspection rule list
Getting rule details
client.rules.get(uuid)
uuid rule UUID.
Returns a full rule representation as a dictionary.
This call is currently not represented in CLI.
Deleting all rules
client.rules.delete_all()
CLI:
$ openstack baremetal introspection rule purge
Deleting a rule
client.rules.delete(uuid)
uuid rule UUID.
CLI:
$ openstack baremetal introspection rule delete <UUID>
Shortcut Functions
The following functions are available for simplified access to the most common functionality:
Starting introspection:
ironic_inspector_client.introspect(uuid[, new_ipmi_password[, new_ipmi_username]][, base_url][, api_version] **)
Getting introspection status:
ironic_inspector_client.get_status(uuid[, base_url][, api_version] **)
Getting API versions supported by a server:
ironic_inspector_client.server_api_versions([base_url] **)
Here base_url argument is the same as inspector_url argument to the ClientV1 constructor. Keyword arguments are passed to the client constructor intact. The first 2 functions also accept deprecated auth_token argument, which should not be used.
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
File details
Details for the file python-ironic-inspector-client-1.6.0.tar.gz.
File metadata
- Download URL: python-ironic-inspector-client-1.6.0.tar.gz
- Upload date:
- Size: 30.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c7b87ceb1aad239c728446edc9635b4f1281f455a1c2765913c586abc9fbec0f |
|
| MD5 | 9d72a7387cec10f0f54948bc2baa6a0e |
|
| BLAKE2b-256 | 337b817b7d76f5f590e9ed7111f6ce7ce95e84eb8119b92e38e8c0a253e86165 |
Provenance
File details
Details for the file python_ironic_inspector_client-1.6.0-py2-none-any.whl.
File metadata
- Download URL: python_ironic_inspector_client-1.6.0-py2-none-any.whl
- Upload date:
- Size: 30.3 kB
- Tags: Python 2
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 04a29c1d7bd84784b00899e57d71d06b929e4e064e87a620768c89a3a1b1200c |
|
| MD5 | ec895446603811b1fd2ccf6c2ede0443 |
|
| BLAKE2b-256 | 6c4e7210c7b954a1609e1ce9ad5505322fec3edd0abd20217718f74226e76d5d |
