understack/python/understack-workflows/understack_workflows/pxe_port_heuristic.py at 9add0cf79a630671be23b97226cea4e164bc4561 · rackerlabs/understack · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
from understack_workflows.bmc_chassis_info import ChassisInfo
from understack_workflows.bmc_chassis_info import InterfaceInfo

# We try not choose interface whose name contains any of these:
DISQUALIFIED = ["DRAC", "ILO", "NIC.EMBEDDED"]

# A higher number is more likely to be PXE interface:
NIC_PREFERENCE = {
    "NIC.Integrated.1-1-1": 100,
    "NIC.Integrated.1-1": 99,
    "NIC.Slot.1-1-1": 98,
    "NIC.Slot.1-1": 97,
    "NIC.Integrated.1-2-1": 96,
    "NIC.Integrated.1-2": 95,
    "NIC.Slot.1-2-1": 94,
    "NIC.Slot.1-2": 93,
    "NIC.Slot.1-3-1": 92,
    "NIC.Slot.1-3": 91,
    "NIC.Slot.2-1-1": 90,
    "NIC.Slot.2-1": 89,
    "NIC.Integrated.2-1-1": 88,
    "NIC.Integrated.2-1": 87,
    "NIC.Slot.2-2-1": 86,
    "NIC.Slot.2-2": 85,
    "NIC.Integrated.2-2-1": 84,
    "NIC.Integrated.2-2": 83,
    "NIC.Slot.3-1-1": 82,
    "NIC.Slot.3-1": 81,
    "NIC.Slot.3-2-1": 80,
    "NIC.Slot.3-2": 79,
}


def guess_pxe_interface(device_info: ChassisInfo) -> str:
    """Determine most probable PXE interface for BMC."""
    interface = max(device_info.interfaces, key=_pxe_preference)
    return interface.name


def _pxe_preference(interface: InterfaceInfo) -> list:
    """Relative likelihood that interface is used for PXE.

    Prefer names that are not disqualified.

    After that, prefer interfaces that have an LLDP neighbor.

    Finally, score the interface name according to the list above.
    """
    is_eligible = not any(x in interface.name.upper() for x in DISQUALIFIED)

    link_detected = interface.remote_switch_port_name is not None

    name_preference = NIC_PREFERENCE.get(interface.name, 0)

    return [is_eligible, link_detected, name_preference]