diff options
author | Zuul <zuul@review.opendev.org> | 2023-04-27 12:05:11 +0000 |
---|---|---|
committer | Gerrit Code Review <review@openstack.org> | 2023-04-27 12:05:11 +0000 |
commit | 3cd8c294fbad24b9cfd1d0b7ae5aeaf5629f5168 (patch) | |
tree | 985652fcc2dcad2401b54a155ac841744607aeb3 /doc/source/admin/how_it_works.rst | |
parent | 33e3bae28bc2ff0412ca66e6b7145365ed4ffaf2 (diff) | |
parent | 3e05a03f7c04d59cc5b6aa6bb5633431a1beb2a0 (diff) | |
download | ironic-python-agent-3cd8c294fbad24b9cfd1d0b7ae5aeaf5629f5168.tar.gz |
Merge "Deprecate LLDP in inventory in favour of a new collector"
Diffstat (limited to 'doc/source/admin/how_it_works.rst')
-rw-r--r-- | doc/source/admin/how_it_works.rst | 18 |
1 files changed, 14 insertions, 4 deletions
diff --git a/doc/source/admin/how_it_works.rst b/doc/source/admin/how_it_works.rst index 803ac7a8..5f4a6773 100644 --- a/doc/source/admin/how_it_works.rst +++ b/doc/source/admin/how_it_works.rst @@ -145,8 +145,16 @@ collectors are: * ``nics`` - list of objects with keys ``name`` (NIC name) and ``numa_node`` (node ID). +``lldp`` + Collects information about the network connectivity using LLDP_. Provides + one key: + + * ``lldp_raw`` - mapping of interface names to lists of raw + type-length-value (TLV) records. + .. _hardware: https://pypi.org/project/hardware/ .. _NUMA: https://en.wikipedia.org/wiki/Non-uniform_memory_access +.. _LLDP: https://en.wikipedia.org/wiki/Link_Layer_Discovery_Protocol .. _hardware-inventory: @@ -191,10 +199,12 @@ fields: ``interfaces`` list of network interfaces with fields: ``name``, ``mac_address``, ``ipv4_address``, ``lldp``, ``vendor``, ``product``, and optionally - ``biosdevname`` (BIOS given NIC name). If configuration option - ``collect_lldp`` is set to True the ``lldp`` field will be populated - by a list of type-length-value(TLV) fields retrieved using the - Link Layer Discovery Protocol (LLDP). + ``biosdevname`` (BIOS given NIC name). + + .. note:: + For backward compatibility, interfaces may contain ``lldp`` fields. + They are deprecated, consumers should rely on the ``lldp`` inspection + collector instead. ``system_vendor`` system vendor information from SMBIOS as reported by ``dmidecode``: |