Skip to content

ANTA Tests for OSPF

Module related to OSPF tests.

VerifyOSPFMaxLSA

Verifies all OSPF instances did not cross the maximum LSA threshold.

Expected Results
  • Success: The test will pass if all OSPF instances did not cross the maximum LSA Threshold.
  • Failure: The test will fail if some OSPF instances crossed the maximum LSA Threshold.
  • Skipped: The test will be skipped if no OSPF instance is found.
Examples 
anta.tests.routing:
  ospf:
    - VerifyOSPFMaxLSA:
Source code in anta/tests/routing/ospf.py 
126
127
128
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
class VerifyOSPFMaxLSA(AntaTest):
    """Verifies all OSPF instances did not cross the maximum LSA threshold.

    Expected Results
    ----------------
    * Success: The test will pass if all OSPF instances did not cross the maximum LSA Threshold.
    * Failure: The test will fail if some OSPF instances crossed the maximum LSA Threshold.
    * Skipped: The test will be skipped if no OSPF instance is found.

    Examples
    --------
    ```yaml
    anta.tests.routing:
      ospf:
        - VerifyOSPFMaxLSA:
    ```
    """

    categories: ClassVar[list[str]] = ["ospf"]
    commands: ClassVar[list[AntaCommand | AntaTemplate]] = [AntaCommand(command="show ip ospf", revision=1)]

    @AntaTest.anta_test
    def test(self) -> None:
        """Main test function for VerifyOSPFMaxLSA."""
        self.result.is_success()

        # If OSPF is not configured on device, test skipped.
        if not (command_output := get_value(self.instance_commands[0].json_output, "vrfs")):
            self.result.is_skipped("OSPF not configured")
            return

        for vrf_data in command_output.values():
            for instance, instance_data in vrf_data.get("instList", {}).items():
                max_lsa = instance_data["maxLsaInformation"]["maxLsa"]
                max_lsa_threshold = instance_data["maxLsaInformation"]["maxLsaThreshold"]
                num_lsa = get_value(instance_data, "lsaInformation.numLsa")
                if num_lsa > (max_lsa_threshold := round(max_lsa * (max_lsa_threshold / 100))):
                    self.result.is_failure(f"Instance: {instance} - Crossed the maximum LSA threshold - Expected: < {max_lsa_threshold} Actual: {num_lsa}")

VerifyOSPFNeighborCount

Verifies the number of OSPF neighbors in FULL state is the one we expect.

Expected Results
  • Success: The test will pass if the number of OSPF neighbors in FULL state is the one we expect.
  • Failure: The test will fail if the number of OSPF neighbors in FULL state is not the one we expect.
  • Skipped: The test will be skipped if no OSPF neighbor is found.
Examples 
anta.tests.routing:
  ospf:
    - VerifyOSPFNeighborCount:
        number: 3

Inputs

Name Type Description Default
number int
The expected number of OSPF neighbors in FULL state.
-
Source code in anta/tests/routing/ospf.py 
 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
 95
 96
 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
class VerifyOSPFNeighborCount(AntaTest):
    """Verifies the number of OSPF neighbors in FULL state is the one we expect.

    Expected Results
    ----------------
    * Success: The test will pass if the number of OSPF neighbors in FULL state is the one we expect.
    * Failure: The test will fail if the number of OSPF neighbors in FULL state is not the one we expect.
    * Skipped: The test will be skipped if no OSPF neighbor is found.

    Examples
    --------
    ```yaml
    anta.tests.routing:
      ospf:
        - VerifyOSPFNeighborCount:
            number: 3
    ```
    """

    categories: ClassVar[list[str]] = ["ospf"]
    commands: ClassVar[list[AntaCommand | AntaTemplate]] = [AntaCommand(command="show ip ospf neighbor", revision=1)]

    class Input(AntaTest.Input):
        """Input model for the VerifyOSPFNeighborCount test."""

        number: int
        """The expected number of OSPF neighbors in FULL state."""

    @AntaTest.anta_test
    def test(self) -> None:
        """Main test function for VerifyOSPFNeighborCount."""
        self.result.is_success()
        # If OSPF is not configured on device, test skipped.
        if not (command_output := get_value(self.instance_commands[0].json_output, "vrfs")):
            self.result.is_skipped("OSPF not configured")
            return

        no_neighbor = True
        interfaces = []
        for vrf_data in command_output.values():
            for instance_data in vrf_data["instList"].values():
                neighbors = instance_data["ospfNeighborEntries"]
                if not neighbors:
                    continue
                no_neighbor = False
                interfaces.extend([neighbor["routerId"] for neighbor in neighbors if neighbor["adjacencyState"] == "full"])

        # If OSPF neighbors are not configured on device, test skipped.
        if no_neighbor:
            self.result.is_skipped("No OSPF neighbor detected")
            return

        # If the number of OSPF neighbors expected to be in the FULL state does not match with actual one, test fails.
        if len(interfaces) != self.inputs.number:
            self.result.is_failure(f"Neighbor count mismatch - Expected: {self.inputs.number} Actual: {len(interfaces)}")

VerifyOSPFNeighborState

Verifies all OSPF neighbors are in FULL state.

Expected Results
  • Success: The test will pass if all OSPF neighbors are in FULL state.
  • Failure: The test will fail if some OSPF neighbors are not in FULL state.
  • Skipped: The test will be skipped if no OSPF neighbor is found.
Examples 
anta.tests.routing:
  ospf:
    - VerifyOSPFNeighborState:
Source code in anta/tests/routing/ospf.py 
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
65
66
class VerifyOSPFNeighborState(AntaTest):
    """Verifies all OSPF neighbors are in FULL state.

    Expected Results
    ----------------
    * Success: The test will pass if all OSPF neighbors are in FULL state.
    * Failure: The test will fail if some OSPF neighbors are not in FULL state.
    * Skipped: The test will be skipped if no OSPF neighbor is found.

    Examples
    --------
    ```yaml
    anta.tests.routing:
      ospf:
        - VerifyOSPFNeighborState:
    ```
    """

    categories: ClassVar[list[str]] = ["ospf"]
    commands: ClassVar[list[AntaCommand | AntaTemplate]] = [AntaCommand(command="show ip ospf neighbor", revision=1)]

    @AntaTest.anta_test
    def test(self) -> None:
        """Main test function for VerifyOSPFNeighborState."""
        self.result.is_success()

        # If OSPF is not configured on device, test skipped.
        if not (command_output := get_value(self.instance_commands[0].json_output, "vrfs")):
            self.result.is_skipped("OSPF not configured")
            return

        no_neighbor = True
        for vrf, vrf_data in command_output.items():
            for instance, instance_data in vrf_data["instList"].items():
                neighbors = instance_data["ospfNeighborEntries"]
                if not neighbors:
                    continue
                no_neighbor = False
                interfaces = [(neighbor["routerId"], state) for neighbor in neighbors if (state := neighbor["adjacencyState"]) != "full"]
                for interface in interfaces:
                    self.result.is_failure(
                        f"Instance: {instance} VRF: {vrf} Neighbor ID: {interface[0]} - Incorrect adjacency state - Expected: Full Actual: {interface[1]}"
                    )

        # If OSPF neighbors are not configured on device, test skipped.
        if no_neighbor:
            self.result.is_skipped("No OSPF neighbor detected")

VerifyOSPFSpecificNeighbors

Verifies OSPF specific neighbors.

Expected Results
  • Success: The test will pass if all specified OSPF neighbors meet expected state and area.
  • Failure: The test will fail if OSPF is not configured, or any specified neighbor is not found or has incorrect state/area.
Examples 
anta.tests.routing:
  ospf:
    - VerifyOSPFSpecificNeighbors:
        neighbors:
          - instance: 100
            vrf: default
            ip_address: 10.1.255.46
            local_interface: Ethernet2
            area_id: 0  # Support for decimal format
            state: full
          - instance: 200
            vrf: DEV
            ip_address: 10.9.1.1
            local_interface: Vlan911
            area_id: 0.0.0.1  # Support for IP address format
            state: 2Ways

Inputs

Name Type Description Default
neighbors list[OSPFNeighbor]
List of OSPF neighbors to verify.
-
Source code in anta/tests/routing/ospf.py 
166
167
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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
class VerifyOSPFSpecificNeighbors(AntaTest):
    """Verifies OSPF specific neighbors.

    Expected Results
    ----------------
    * Success: The test will pass if all specified OSPF neighbors meet expected state and area.
    * Failure: The test will fail if OSPF is not configured, or any specified neighbor is not found or has incorrect state/area.

    Examples
    --------
    ```yaml
    anta.tests.routing:
      ospf:
        - VerifyOSPFSpecificNeighbors:
            neighbors:
              - instance: 100
                vrf: default
                ip_address: 10.1.255.46
                local_interface: Ethernet2
                area_id: 0  # Support for decimal format
                state: full
              - instance: 200
                vrf: DEV
                ip_address: 10.9.1.1
                local_interface: Vlan911
                area_id: 0.0.0.1  # Support for IP address format
                state: 2Ways
    ```
    """

    categories: ClassVar[list[str]] = ["ospf"]
    commands: ClassVar[list[AntaCommand | AntaTemplate]] = [AntaCommand(command="show ip ospf neighbor", revision=1)]

    class Input(AntaTest.Input):
        """Input model for the VerifyOSPFSpecificNeighbors test."""

        neighbors: list[OSPFNeighbor]
        """List of OSPF neighbors to verify."""

    @AntaTest.anta_test
    def test(self) -> None:
        """Main test function for VerifyOSPFSpecificNeighbors."""
        self.result.is_success()

        # If OSPF is not configured on the device, test fails
        if not (vrf_data := get_value(self.instance_commands[0].json_output, "vrfs")):
            self.result.is_failure("OSPF not configured")
            return

        for neighbor in self.inputs.neighbors:
            # Try to get the neighbor data from the ospfNeighborEntries output list
            neighbor_data = {}
            for entry in get_value(vrf_data, f"{neighbor.vrf}..instList..{neighbor.instance}..ospfNeighborEntries", default=[], separator=".."):
                if str(neighbor.ip_address) == entry["interfaceAddress"] and neighbor.local_interface == entry["interfaceName"]:
                    # Neighbor found
                    neighbor_data = entry
                    break

            if not neighbor_data:
                self.result.is_failure(f"{neighbor} - Neighbor not found")
                continue

            # Check the area_id
            if (exp_area_id := str(neighbor.area_id)) != (act_area_id := neighbor_data["details"]["areaId"]):
                self.result.is_failure(f"{neighbor} - Area-ID mismatch - Expected: {exp_area_id} Actual: {act_area_id}")
                continue

            # Check the adjacency state
            if (exp_adj_state := neighbor.state) != (act_adj_state := neighbor_data["adjacencyState"]):
                self.result.is_failure(f"{neighbor} - Adjacency state mismatch - Expected: {exp_adj_state} Actual: {act_adj_state}")