Document hardware inventory sent to lookup and inspection

Also add a missing docstring to HardwareManager.list_hardware_info.

Change-Id: Iee3584320f0591398e7761513ff588efeb62886d
This commit is contained in:
Dmitry Tantsur
2016-02-02 16:35:03 +01:00
parent 01685839ba
commit c9674da220
2 changed files with 49 additions and 0 deletions
doc/source
ironic_python_agent

@ -267,6 +267,14 @@ class HardwareManager(object):
return erase_results
def list_hardware_info(self):
"""Return full hardware inventory as a serializable dict.
This inventory is sent to Ironic on lookup and to Inspector on
inspection.
:return: a dictionary representing inventory
"""
# NOTE(dtantsur): don't forget to update docs when extending inventory
hardware_info = {}
hardware_info['interfaces'] = self.list_network_interfaces()
hardware_info['cpu'] = self.get_cpus()