Skip to content

STP

ANTA catalog for STP tests

Test functions related to various Spanning Tree Protocol (STP) settings

VerifySTPBlockedPorts

Bases: AntaTest

Verifies there is no STP blocked ports.

Expected Results
  • success: The test will pass if there are NO ports blocked by STP.
  • failure: The test will fail if there are ports blocked by STP.
Source code in anta/tests/stp.py 
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
class VerifySTPBlockedPorts(AntaTest):
    """
    Verifies there is no STP blocked ports.

    Expected Results:
        * success: The test will pass if there are NO ports blocked by STP.
        * failure: The test will fail if there are ports blocked by STP.
    """

    name = "VerifySTPBlockedPorts"
    description = "Verifies there is no STP blocked ports."
    categories = ["stp"]
    commands = [AntaCommand(command="show spanning-tree blockedports")]

    @AntaTest.anta_test
    def test(self) -> None:
        """
        Run VerifySTPBlockedPorts validation
        """

        command_output = self.instance_commands[0].json_output

        if not (stp_instances := command_output["spanningTreeInstances"]):
            self.result.is_success()
        else:
            for key, value in stp_instances.items():
                stp_instances[key] = value.pop("spanningTreeBlockedPorts")
            self.result.is_failure(f"The following ports are blocked by STP: {stp_instances}")

test 

test() -> None

Run VerifySTPBlockedPorts validation

Source code in anta/tests/stp.py 
81
82
83
84
85
86
87
88
89
90
91
92
93
94
@AntaTest.anta_test
def test(self) -> None:
    """
    Run VerifySTPBlockedPorts validation
    """

    command_output = self.instance_commands[0].json_output

    if not (stp_instances := command_output["spanningTreeInstances"]):
        self.result.is_success()
    else:
        for key, value in stp_instances.items():
            stp_instances[key] = value.pop("spanningTreeBlockedPorts")
        self.result.is_failure(f"The following ports are blocked by STP: {stp_instances}")

VerifySTPCounters

Bases: AntaTest

Verifies there is no errors in STP BPDU packets.

Expected Results
  • success: The test will pass if there are NO STP BPDU packet errors under all interfaces participating in STP.
  • failure: The test will fail if there are STP BPDU packet errors on one or many interface(s).
Source code in anta/tests/stp.py 
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
class VerifySTPCounters(AntaTest):
    """
    Verifies there is no errors in STP BPDU packets.

    Expected Results:
        * success: The test will pass if there are NO STP BPDU packet errors under all interfaces participating in STP.
        * failure: The test will fail if there are STP BPDU packet errors on one or many interface(s).
    """

    name = "VerifySTPCounters"
    description = "Verifies there is no errors in STP BPDU packets."
    categories = ["stp"]
    commands = [AntaCommand(command="show spanning-tree counters")]

    @AntaTest.anta_test
    def test(self) -> None:
        """
        Run VerifySTPBlockedPorts validation
        """

        command_output = self.instance_commands[0].json_output

        interfaces_with_errors = [
            interface for interface, counters in command_output["interfaces"].items() if counters["bpduTaggedError"] or counters["bpduOtherError"] != 0
        ]

        if interfaces_with_errors:
            self.result.is_failure(f"The following interfaces have STP BPDU packet errors: {interfaces_with_errors}")
        else:
            self.result.is_success()

test 

test() -> None

Run VerifySTPBlockedPorts validation

Source code in anta/tests/stp.py 
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
@AntaTest.anta_test
def test(self) -> None:
    """
    Run VerifySTPBlockedPorts validation
    """

    command_output = self.instance_commands[0].json_output

    interfaces_with_errors = [
        interface for interface, counters in command_output["interfaces"].items() if counters["bpduTaggedError"] or counters["bpduOtherError"] != 0
    ]

    if interfaces_with_errors:
        self.result.is_failure(f"The following interfaces have STP BPDU packet errors: {interfaces_with_errors}")
    else:
        self.result.is_success()

VerifySTPForwardingPorts

Bases: AntaTest

Verifies that all interfaces are in a forwarding state for a provided list of VLAN(s).

Expected Results
  • success: The test will pass if all interfaces are in a forwarding state for the specified VLAN(s).
  • failure: The test will fail if one or many interfaces are NOT in a forwarding state in the specified VLAN(s).
  • error: The test will give an error if a list of VLAN(s) is not provided as template_params.
Source code in anta/tests/stp.py 
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
class VerifySTPForwardingPorts(AntaTest):
    """
    Verifies that all interfaces are in a forwarding state for a provided list of VLAN(s).

    Expected Results:
        * success: The test will pass if all interfaces are in a forwarding state for the specified VLAN(s).
        * failure: The test will fail if one or many interfaces are NOT in a forwarding state in the specified VLAN(s).
        * error: The test will give an error if a list of VLAN(s) is not provided as template_params.
    """

    name = "VerifySTPForwardingPorts"
    description = "Verifies that all interfaces are forwarding for a provided list of VLAN(s)."
    categories = ["stp"]
    template = AntaTemplate(template="show spanning-tree topology vlan {vlan} status")

    @AntaTest.anta_test
    def test(self) -> None:
        """
        Run VerifySTPForwardingPorts validation.
        """

        self.result.is_success()

        for command in self.instance_commands:
            if command.params and "vlan" in command.params:
                vlan_id = command.params["vlan"]

            if not (topologies := get_value(command.json_output, "topologies")):
                self.result.is_failure(f"STP instance for VLAN {vlan_id} is not configured")

            else:
                for value in topologies.values():
                    if int(vlan_id) in value["vlans"]:
                        interfaces_not_forwarding = [interface for interface, state in value["interfaces"].items() if state["state"] != "forwarding"]

                if interfaces_not_forwarding:
                    self.result.is_failure(f"The following interface(s) are not in a forwarding state for VLAN {vlan_id}: {interfaces_not_forwarding}")

test 

test() -> None

Run VerifySTPForwardingPorts validation.

Source code in anta/tests/stp.py 
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
@AntaTest.anta_test
def test(self) -> None:
    """
    Run VerifySTPForwardingPorts validation.
    """

    self.result.is_success()

    for command in self.instance_commands:
        if command.params and "vlan" in command.params:
            vlan_id = command.params["vlan"]

        if not (topologies := get_value(command.json_output, "topologies")):
            self.result.is_failure(f"STP instance for VLAN {vlan_id} is not configured")

        else:
            for value in topologies.values():
                if int(vlan_id) in value["vlans"]:
                    interfaces_not_forwarding = [interface for interface, state in value["interfaces"].items() if state["state"] != "forwarding"]

            if interfaces_not_forwarding:
                self.result.is_failure(f"The following interface(s) are not in a forwarding state for VLAN {vlan_id}: {interfaces_not_forwarding}")

VerifySTPMode

Bases: AntaTest

Verifies the configured STP mode for a provided list of VLAN(s).

Expected Results
  • success: The test will pass if the STP mode is configured properly in the specified VLAN(s).
  • failure: The test will fail if the STP mode is NOT configured properly for one or more specified VLAN(s).
  • skipped: The test will be skipped if the STP mode is not provided.
  • error: The test will give an error if a list of VLAN(s) is not provided as template_params.
Source code in anta/tests/stp.py 
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
56
57
58
59
60
61
62
63
64
class VerifySTPMode(AntaTest):
    """
    Verifies the configured STP mode for a provided list of VLAN(s).

    Expected Results:
        * success: The test will pass if the STP mode is configured properly in the specified VLAN(s).
        * failure: The test will fail if the STP mode is NOT configured properly for one or more specified VLAN(s).
        * skipped: The test will be skipped if the STP mode is not provided.
        * error: The test will give an error if a list of VLAN(s) is not provided as template_params.
    """

    name = "VerifySTPMode"
    description = "Verifies the configured STP mode for a provided list of VLAN(s)."
    categories = ["stp"]
    template = AntaTemplate(template="show spanning-tree vlan {vlan}")

    @staticmethod
    def _check_stp_mode(mode: str) -> None:
        """
        Verifies if the provided STP mode is compatible with Arista EOS devices.

        Args:
            mode: The STP mode to verify.
        """
        stp_modes = ["mstp", "rstp", "rapidPvst"]

        if mode not in stp_modes:
            raise ValueError(f"Wrong STP mode provided. Valid modes are: {stp_modes}")

    @AntaTest.anta_test
    def test(self, mode: str = "mstp") -> None:
        """
        Run VerifySTPVersion validation.

        Args:
            mode: STP mode to verify. Defaults to 'mstp'.
        """
        if not mode:
            self.result.is_skipped(f"{self.__class__.name} did not run because mode was not supplied")
            return

        self._check_stp_mode(mode)

        self.result.is_success()

        for command in self.instance_commands:
            if command.params and "vlan" in command.params:
                vlan_id = command.params["vlan"]
            if not (stp_mode := get_value(command.json_output, f"spanningTreeVlanInstances.{vlan_id}.spanningTreeVlanInstance.protocol")):
                self.result.is_failure(f"STP mode '{mode}' not configured for VLAN {vlan_id}")

            elif stp_mode != mode:
                self.result.is_failure(f"Wrong STP mode configured for VLAN {vlan_id}")

test 

test(mode: str = 'mstp') -> None

Run VerifySTPVersion validation.

Parameters:

Name Type Description Default
mode str

STP mode to verify. Defaults to ‘mstp’.

 'mstp'
Source code in anta/tests/stp.py 
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
@AntaTest.anta_test
def test(self, mode: str = "mstp") -> None:
    """
    Run VerifySTPVersion validation.

    Args:
        mode: STP mode to verify. Defaults to 'mstp'.
    """
    if not mode:
        self.result.is_skipped(f"{self.__class__.name} did not run because mode was not supplied")
        return

    self._check_stp_mode(mode)

    self.result.is_success()

    for command in self.instance_commands:
        if command.params and "vlan" in command.params:
            vlan_id = command.params["vlan"]
        if not (stp_mode := get_value(command.json_output, f"spanningTreeVlanInstances.{vlan_id}.spanningTreeVlanInstance.protocol")):
            self.result.is_failure(f"STP mode '{mode}' not configured for VLAN {vlan_id}")

        elif stp_mode != mode:
            self.result.is_failure(f"Wrong STP mode configured for VLAN {vlan_id}")

VerifySTPRootPriority

Bases: AntaTest

Verifies the STP root priority for a provided list of VLAN or MST instance ID(s).

Expected Results
  • success: The test will pass if the STP root priority is configured properly for the specified VLAN or MST instance ID(s).
  • failure: The test will fail if the STP root priority is NOT configured properly for the specified VLAN or MST instance ID(s).
  • skipped: The test will be skipped if the STP root priority is not provided.
Source code in anta/tests/stp.py 
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
class VerifySTPRootPriority(AntaTest):
    """
    Verifies the STP root priority for a provided list of VLAN or MST instance ID(s).

    Expected Results:
        * success: The test will pass if the STP root priority is configured properly for the specified VLAN or MST instance ID(s).
        * failure: The test will fail if the STP root priority is NOT configured properly for the specified VLAN or MST instance ID(s).
        * skipped: The test will be skipped if the STP root priority is not provided.
    """

    name = "VerifySTPRootPriority"
    description = "Verifies the STP root priority for a provided list of VLAN or MST instance ID(s)."
    categories = ["stp"]
    commands = [AntaCommand(command="show spanning-tree root detail")]

    @AntaTest.anta_test
    def test(self, priority: Optional[int] = None, instances: Optional[List[int]] = None) -> None:
        """
        Run VerifySTPRootPriority validation.

        Args:
            priority: STP root priority to verify.
            instances: List of VLAN or MST instance ID(s). By default, ALL VLAN or MST instance ID(s) will be verified.
        """
        if not priority:
            self.result.is_skipped(f"{self.__class__.name} did not run because priority was not supplied")
            return

        command_output = self.instance_commands[0].json_output

        if not (stp_instances := command_output["instances"]):
            self.result.is_failure("No STP instances configured")
            return

        for instance in stp_instances:
            if instance.startswith("MST"):
                prefix = "MST"
                break
            if instance.startswith("VL"):
                prefix = "VL"
                break

        check_instances = [f"{prefix}{instance_id}" for instance_id in instances] if instances else command_output["instances"].keys()

        wrong_priority_instances = [instance for instance in check_instances if get_value(command_output, f"instances.{instance}.rootBridge.priority") != priority]

        if wrong_priority_instances:
            self.result.is_failure(f"The following instance(s) have the wrong STP root priority configured: {wrong_priority_instances}")
        else:
            self.result.is_success()

test 

test(
    priority: Optional[int] = None,
    instances: Optional[List[int]] = None,
) -> None

Run VerifySTPRootPriority validation.

Parameters:

Name Type Description Default
priority Optional[int]

STP root priority to verify.

 None
instances Optional[List[int]]

List of VLAN or MST instance ID(s). By default, ALL VLAN or MST instance ID(s) will be verified.

 None
Source code in anta/tests/stp.py 
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
@AntaTest.anta_test
def test(self, priority: Optional[int] = None, instances: Optional[List[int]] = None) -> None:
    """
    Run VerifySTPRootPriority validation.

    Args:
        priority: STP root priority to verify.
        instances: List of VLAN or MST instance ID(s). By default, ALL VLAN or MST instance ID(s) will be verified.
    """
    if not priority:
        self.result.is_skipped(f"{self.__class__.name} did not run because priority was not supplied")
        return

    command_output = self.instance_commands[0].json_output

    if not (stp_instances := command_output["instances"]):
        self.result.is_failure("No STP instances configured")
        return

    for instance in stp_instances:
        if instance.startswith("MST"):
            prefix = "MST"
            break
        if instance.startswith("VL"):
            prefix = "VL"
            break

    check_instances = [f"{prefix}{instance_id}" for instance_id in instances] if instances else command_output["instances"].keys()

    wrong_priority_instances = [instance for instance in check_instances if get_value(command_output, f"instances.{instance}.rootBridge.priority") != priority]

    if wrong_priority_instances:
        self.result.is_failure(f"The following instance(s) have the wrong STP root priority configured: {wrong_priority_instances}")
    else:
        self.result.is_success()
Last update: July 19, 2023