Skip to content

ANTA catalog for OSPF tests

VerifyOSPFMaxLSA

Verifies LSAs present in the OSPF link state database 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 
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
class VerifyOSPFMaxLSA(AntaTest):
    """Verifies LSAs present in the OSPF link state database 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:
    ```
    """

    name = "VerifyOSPFMaxLSA"
    description = "Verifies all OSPF instances did not cross the maximum LSA threshold."
    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."""
        command_output = self.instance_commands[0].json_output
        ospf_instance_info = _get_ospf_max_lsa_info(command_output)
        if not ospf_instance_info:
            self.result.is_skipped("No OSPF instance found.")
            return
        all_instances_within_threshold = all(instance["numLsa"] <= instance["maxLsa"] * (instance["maxLsaThreshold"] / 100) for instance in ospf_instance_info)
        if all_instances_within_threshold:
            self.result.is_success()
        else:
            exceeded_instances = [
                instance["instance"] for instance in ospf_instance_info if instance["numLsa"] > instance["maxLsa"] * (instance["maxLsaThreshold"] / 100)
            ]
            self.result.is_failure(f"OSPF Instances {exceeded_instances} crossed the maximum LSA threshold.")

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 
124
125
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
164
165
166
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
    ```
    """

    name = "VerifyOSPFNeighborCount"
    description = "Verifies the number of OSPF neighbors in FULL state is the one we expect."
    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."""
        command_output = self.instance_commands[0].json_output
        if (neighbor_count := _count_ospf_neighbor(command_output)) == 0:
            self.result.is_skipped("no OSPF neighbor found")
            return
        self.result.is_success()
        if neighbor_count != self.inputs.number:
            self.result.is_failure(f"device has {neighbor_count} neighbors (expected {self.inputs.number})")
        not_full_neighbors = _get_not_full_ospf_neighbors(command_output)
        if not_full_neighbors:
            self.result.is_failure(f"Some neighbors are not correctly configured: {not_full_neighbors}.")

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 
 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
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:
    ```
    """

    name = "VerifyOSPFNeighborState"
    description = "Verifies all OSPF neighbors are in FULL state."
    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."""
        command_output = self.instance_commands[0].json_output
        if _count_ospf_neighbor(command_output) == 0:
            self.result.is_skipped("no OSPF neighbor found")
            return
        self.result.is_success()
        not_full_neighbors = _get_not_full_ospf_neighbors(command_output)
        if not_full_neighbors:
            self.result.is_failure(f"Some neighbors are not correctly configured: {not_full_neighbors}.")

_count_ospf_neighbor 

_count_ospf_neighbor(ospf_neighbor_json: dict[str, Any]) -> int

Count the number of OSPF neighbors.

Args:

ospf_neighbor_json: The JSON output of the show ip ospf neighbor command.

Returns:

Type Description
int: The number of OSPF neighbors.
Source code in anta/tests/routing/ospf.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
def _count_ospf_neighbor(ospf_neighbor_json: dict[str, Any]) -> int:
    """Count the number of OSPF neighbors.

    Args:
    ----
      ospf_neighbor_json: The JSON output of the `show ip ospf neighbor` command.

    Returns
    -------
      int: The number of OSPF neighbors.

    """
    count = 0
    for vrf_data in ospf_neighbor_json["vrfs"].values():
        for instance_data in vrf_data["instList"].values():
            count += len(instance_data.get("ospfNeighborEntries", []))
    return count

_get_not_full_ospf_neighbors 

_get_not_full_ospf_neighbors(ospf_neighbor_json: dict[str, Any]) -> list[dict[str, Any]]

Return the OSPF neighbors whose adjacency state is not full.

Args:

ospf_neighbor_json: The JSON output of the show ip ospf neighbor command.

Returns:

Type Description
list[dict[str, Any]]: A list of OSPF neighbors whose adjacency state is not `full`.
Source code in anta/tests/routing/ospf.py 
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
def _get_not_full_ospf_neighbors(ospf_neighbor_json: dict[str, Any]) -> list[dict[str, Any]]:
    """Return the OSPF neighbors whose adjacency state is not `full`.

    Args:
    ----
      ospf_neighbor_json: The JSON output of the `show ip ospf neighbor` command.

    Returns
    -------
      list[dict[str, Any]]: A list of OSPF neighbors whose adjacency state is not `full`.

    """
    return [
        {
            "vrf": vrf,
            "instance": instance,
            "neighbor": neighbor_data["routerId"],
            "state": state,
        }
        for vrf, vrf_data in ospf_neighbor_json["vrfs"].items()
        for instance, instance_data in vrf_data["instList"].items()
        for neighbor_data in instance_data.get("ospfNeighborEntries", [])
        if (state := neighbor_data["adjacencyState"]) != "full"
    ]

_get_ospf_max_lsa_info 

_get_ospf_max_lsa_info(ospf_process_json: dict[str, Any]) -> list[dict[str, Any]]

Return information about OSPF instances and their LSAs.

Args:

ospf_process_json: OSPF process information in JSON format.

Returns:

Type Description
list[dict[str, Any]]: A list of dictionaries containing OSPF LSAs information.
Source code in anta/tests/routing/ospf.py 
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
def _get_ospf_max_lsa_info(ospf_process_json: dict[str, Any]) -> list[dict[str, Any]]:
    """Return information about OSPF instances and their LSAs.

    Args:
    ----
      ospf_process_json: OSPF process information in JSON format.

    Returns
    -------
      list[dict[str, Any]]: A list of dictionaries containing OSPF LSAs information.

    """
    return [
        {
            "vrf": vrf,
            "instance": instance,
            "maxLsa": instance_data.get("maxLsaInformation", {}).get("maxLsa"),
            "maxLsaThreshold": instance_data.get("maxLsaInformation", {}).get("maxLsaThreshold"),
            "numLsa": instance_data.get("lsaInformation", {}).get("numLsa"),
        }
        for vrf, vrf_data in ospf_process_json.get("vrfs", {}).items()
        for instance, instance_data in vrf_data.get("instList", {}).items()
    ]