92 lines
2.6 KiB
ReStructuredText
92 lines
2.6 KiB
ReStructuredText
Inspection data
|
|
===============
|
|
|
|
The in-band inspection processes collects a lot of information about the node.
|
|
This data consists of two parts:
|
|
|
|
* *Inventory* is :ironic-python-agent-doc:`hardware inventory
|
|
<admin/how_it_works.html#hardware-inventory>` reported by the agent.
|
|
* *Plugin data* is data populated by ramdisk-side and server-side plug-ins.
|
|
|
|
After a successful inspection, you can get both parts as JSON with:
|
|
|
|
.. code-block:: console
|
|
|
|
$ baremetal node inventory save <NODE>
|
|
|
|
Use `jq` to filter the parts you need, e.g. only the inventory itself:
|
|
|
|
.. code-block:: console
|
|
|
|
$ # System vendor information from the inventory
|
|
$ baremetal node inventory save <NODE> | jq .inventory.system_vendor
|
|
{
|
|
"product_name": "KVM (9.2.0)",
|
|
"serial_number": "",
|
|
"manufacturer": "Red Hat",
|
|
"firmware": {
|
|
"vendor": "EDK II",
|
|
"version": "edk2-20221207gitfff6d81270b5-7.el9",
|
|
"build_date": "12/07/2022"
|
|
}
|
|
}
|
|
|
|
$ # Interfaces used to create ports
|
|
$ baremetal node inventory save <NODE> | jq .plugin_data.valid_interfaces
|
|
{
|
|
"eth0": {
|
|
"name": "eth0",
|
|
"mac_address": "52:54:00:5e:09:ff",
|
|
"ipv4_address": "192.168.122.164",
|
|
"ipv6_address": "fe80::5054:ff:fe5e:9ff",
|
|
"has_carrier": true,
|
|
"lldp": null,
|
|
"vendor": "0x1af4",
|
|
"product": "0x0001",
|
|
"client_id": null,
|
|
"biosdevname": null,
|
|
"speed_mbps": null,
|
|
"pxe_enabled": true
|
|
}
|
|
}
|
|
|
|
.. _plugin-data:
|
|
|
|
Plugin data
|
|
-----------
|
|
|
|
Plugin data is the storage for all information that is collected or processed
|
|
by various plugins. Its format is not a part of the API stability promise
|
|
and may change depending on your configuration.
|
|
|
|
Plugin data comes from two sources:
|
|
|
|
* :ironic-python-agent-doc:`inspection collectors
|
|
<admin/how_it_works.html#inspection-data>` - ramdisk-side inspection
|
|
plug-ins.
|
|
* :doc:`hooks` - server-side inspection plug-ins.
|
|
|
|
.. TODO(dtantsur): inspection rules API once it's ready
|
|
|
|
Data storage
|
|
------------
|
|
|
|
There are several options to store the inspection data, specified via the
|
|
:oslo.config:option:`inventory.data_backend` option:
|
|
|
|
``none``
|
|
Do not store inspection data at all. The API will always return 404 NOT
|
|
FOUND.
|
|
|
|
``database``
|
|
Store inspection data in a separate table in the main database.
|
|
|
|
``swift``
|
|
Store inspection data in the Object Store service (swift) in the container
|
|
specified by the :oslo.config:option:`inventory.swift_data_container`
|
|
option.
|
|
|
|
.. warning::
|
|
There is currently no way to migrate data between backends. Changing the
|
|
backend will remove access to existing data.
|