1
diff --git a/src/metadataserver/builtin_scripts/commissioning_scripts/install_lldpd.py b/src/metadataserver/builtin_scripts/commissioning_scripts/install_lldpd.py
2
index e319775..f875011 100644
3
--- a/src/metadataserver/builtin_scripts/commissioning_scripts/install_lldpd.py
4
+++ b/src/metadataserver/builtin_scripts/commissioning_scripts/install_lldpd.py
5
@@ -25,43 +25,45 @@
6
25
# packages: {apt: lldpd}
25
# packages: {apt: lldpd}
7
26
# timeout: 30
26
# timeout: 30
8
27
# --- End MAAS 1.0 script metadata ---
27
# --- End MAAS 1.0 script metadata ---
9
28
"""Installs and configures `lldpd` for passive capture.
10
29
28
13
30
`config_file` refers to a shell script that is sourced by
29
from codecs import open
14
31
`lldpd`'s init script, i.e. it's Upstart config on Ubuntu.
30
import os
15
31
from subprocess import check_call
16
32
32
17
33
It selects the following options for the `lldpd` daemon:
18
34
33
22
35
-c  Enable the support of CDP protocol to deal with Cisco routers
34
def lldpd_install(config_file):
23
36
    that do not speak LLDP. If repeated, CDPv1 packets will be
35
    """Installs and configures `lldpd` for passive capture.
21
37
    sent even when there is no CDP peer detected.
24
38
36
28
39
-f  Enable the support of FDP protocol to deal with Foundry routers
37
    `config_file` refers to a shell script that is sourced by
29
40
    that do not speak LLDP. If repeated, FDP packets will be sent
38
    `lldpd`'s init script, i.e. it's Upstart config on Ubuntu.
27
41
    even when there is no FDP peer detected.
30
42
39
35
43
-s  Enable the support of SONMP protocol to deal with Nortel
40
    It selects the following options for the `lldpd` daemon:
32
44
    routers and switches that do not speak LLDP. If repeated,
33
45
    SONMP packets will be sent even when there is no SONMP peer
34
46
    detected.
36
47
41
40
48
-e  Enable the support of EDP protocol to deal with Extreme
42
    -c  Enable the support of CDP protocol to deal with Cisco routers
41
49
    routers and switches that do not speak LLDP. If repeated, EDP
43
        that do not speak LLDP. If repeated, CDPv1 packets will be
42
50
    packets will be sent even when there is no EDP peer detected.
44
        sent even when there is no CDP peer detected.
43
51
45
46
52
-r  Receive-only mode. With this switch, lldpd will not send any
46
    -f  Enable the support of FDP protocol to deal with Foundry routers
47
53
    frame. It will only listen to neighbors.
47
        that do not speak LLDP. If repeated, FDP packets will be sent
48
48
        even when there is no FDP peer detected.
49
54
49
53
55
These flags are chosen so that we're able to capture information
50
    -s  Enable the support of SONMP protocol to deal with Nortel
54
56
from a broad spectrum of equipment, but without advertising the
51
        routers and switches that do not speak LLDP. If repeated,
55
57
node's temporary presence.
52
        SONMP packets will be sent even when there is no SONMP peer
56
53
        detected.
57
58
54
61
59
"""
55
    -e  Enable the support of EDP protocol to deal with Extreme
62
60
from codecs import open
56
        routers and switches that do not speak LLDP. If repeated, EDP
63
61
from subprocess import check_call
57
        packets will be sent even when there is no EDP peer detected.
64
62
58
65
59
    -r  Receive-only mode. With this switch, lldpd will not send any
66
60
        frame. It will only listen to neighbors.
67
63
61
69
64
def lldpd_install(config_file):
62
    These flags are chosen so that we're able to capture information
70
63
    from a broad spectrum of equipment, but without advertising the
71
64
    node's temporary presence.
72
65
73
66
    """
74
65
    print("INFO: Configuring lldpd...")
67
    print("INFO: Configuring lldpd...")
75
66
68
76
67
    with open(config_file, "a", "ascii") as fd:
69
    with open(config_file, "a", "ascii") as fd:
77
@@ -73,5 +75,32 @@ def lldpd_install(config_file):
78
73
    check_call(("systemctl", "restart", "lldpd"))
75
    check_call(("systemctl", "restart", "lldpd"))
79
74
76
80
75
77
81
78
def disable_embedded_lldp_agent_in_intel_cna_cards():
82
79
    """Intel cards that use i40e driver have an internal lldp processor
83
80
    on the NIC that filter out lldp packets before they can reach the
84
81
    host.  For the linux lldp daemon to receive such packets, we have to
85
82
    disable that feature.
86
83
87
84
    """
88
85
    addr_path = "/sys/kernel/debug/i40e"
89
86
    if not os.path.exists(addr_path):
90
87
        return
91
88
    for inner_dir in os.listdir(addr_path):
92
89
        command_path = "{}/{}/command".format(addr_path, inner_dir)
93
90
        try:
94
91
            with open(command_path, "w", encoding="ascii") as command_file:
95
92
                command_file.write("lldp stop\n")
96
93
            print(
97
94
                "INFO: Disabled embedded lldp agent for {}".format(inner_dir)
98
95
            )
99
96
        except (OSError, IOError):
100
97
            print(
101
98
                "WARNING: Failed to disable the embedded lldp agent for {}".format(
102
99
                    inner_dir
103
100
                )
104
101
            )
105
102
106
103
107
76
if __name__ == "__main__":
104
if __name__ == "__main__":
108
105
    disable_embedded_lldp_agent_in_intel_cna_cards()
109
77
    lldpd_install("/etc/default/lldpd")
106
    lldpd_install("/etc/default/lldpd")
110
diff --git a/src/metadataserver/builtin_scripts/commissioning_scripts/tests/test_lldp.py b/src/metadataserver/builtin_scripts/commissioning_scripts/tests/test_lldp.py
111
index 0afdd92..dda2740 100644
112
--- a/src/metadataserver/builtin_scripts/commissioning_scripts/tests/test_lldp.py
113
+++ b/src/metadataserver/builtin_scripts/commissioning_scripts/tests/test_lldp.py
114
@@ -44,6 +44,26 @@ class TestLLDPScripts(MAASTestCase):
115
44
            config_observed = fd.read()
44
            config_observed = fd.read()
116
45
        self.assertEqual(config_expected, config_observed)
45
        self.assertEqual(config_expected, config_observed)
117
46
46
118
47
    def test_install_script_disables_intel_lldp(self):
119
48
        self.patch(os.path, "exists").return_value = True
120
49
        self.patch(os, "listdir").return_value = ["0000:1a:00.0"]
121
50
        temp_file = self.make_file("temp", "")
122
51
        mock_open = self.patch(install_lldpd, "open")
123
52
        mock_open.return_value = open(temp_file, "w", encoding="ascii")
124
53
        install_lldpd.disable_embedded_lldp_agent_in_intel_cna_cards()
125
54
        output_expected = "lldp stop\n".encode("ascii")
126
55
        with open(temp_file, "rb") as fd:
127
56
            output_observed = fd.read()
128
57
        self.assertEqual(output_expected, output_observed)
129
58
        self.assertThat(
130
59
            mock_open,
131
60
            MockCalledOnceWith(
132
61
                "/sys/kernel/debug/i40e/0000:1a:00.0/command",
133
62
                "w",
134
63
                encoding="ascii",
135
64
            ),
136
65
        )
137
66
138
47
    def test_capture_lldpd_script_waits_for_lldpd(self):
67
    def test_capture_lldpd_script_waits_for_lldpd(self):
139
48
        reference_file = self.make_file("reference")
68
        reference_file = self.make_file("reference")
140
49
        time_delay = 8.98  # seconds
69
        time_delay = 8.98  # seconds
Reviewer	Date Requested	Status
Adam Collard (community)	2020-08-25	Approve on 2020-08-27
MAAS Lander		Approve on 2020-08-26
Review via email: mp+389824@code.launchpad.net