Skip to content

ANTA catalog for BFD tests

VerifyBFDPeersHealth

Verifies the health of IPv4 BFD peers across all VRFs.

It checks that no BFD peer is in the down state and that the discriminator value of the remote system is not zero.

Optionally, it can also verify that BFD peers have not been down before a specified threshold of hours.

Expected Results
  • Success: The test will pass if all IPv4 BFD peers are up, the discriminator value of each remote system is non-zero, and the last downtime of each peer is above the defined threshold.
  • Failure: The test will fail if any IPv4 BFD peer is down, the discriminator value of any remote system is zero, or the last downtime of any peer is below the defined threshold.
Examples 
anta.tests.bfd:
  - VerifyBFDPeersHealth:
      down_threshold: 2

Inputs

Name Type Description Default
down_threshold int | None
Optional down threshold in hours to check if a BFD peer was down before those hours or not.
Field(default=None, gt=0)
Source code in anta/tests/bfd.py 
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
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
class VerifyBFDPeersHealth(AntaTest):
    """Verifies the health of IPv4 BFD peers across all VRFs.

    It checks that no BFD peer is in the down state and that the discriminator value of the remote system is not zero.

    Optionally, it can also verify that BFD peers have not been down before a specified threshold of hours.

    Expected Results
    ----------------
    * Success: The test will pass if all IPv4 BFD peers are up, the discriminator value of each remote system is non-zero,
               and the last downtime of each peer is above the defined threshold.
    * Failure: The test will fail if any IPv4 BFD peer is down, the discriminator value of any remote system is zero,
               or the last downtime of any peer is below the defined threshold.

    Examples
    --------
    ```yaml
    anta.tests.bfd:
      - VerifyBFDPeersHealth:
          down_threshold: 2
    ```
    """

    name = "VerifyBFDPeersHealth"
    description = "Verifies the health of all IPv4 BFD peers."
    categories: ClassVar[list[str]] = ["bfd"]
    # revision 1 as later revision introduces additional nesting for type
    commands: ClassVar[list[AntaCommand | AntaTemplate]] = [
        AntaCommand(command="show bfd peers", revision=1),
        AntaCommand(command="show clock", revision=1),
    ]

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

        down_threshold: int | None = Field(default=None, gt=0)
        """Optional down threshold in hours to check if a BFD peer was down before those hours or not."""

    @AntaTest.anta_test
    def test(self) -> None:
        """Main test function for VerifyBFDPeersHealth."""
        # Initialize failure strings
        down_failures = []
        up_failures = []

        # Extract the current timestamp and command output
        clock_output = self.instance_commands[1].json_output
        current_timestamp = clock_output["utcTime"]
        bfd_output = self.instance_commands[0].json_output

        # set the initial result
        self.result.is_success()

        # Check if any IPv4 BFD peer is configured
        ipv4_neighbors_exist = any(vrf_data["ipv4Neighbors"] for vrf_data in bfd_output["vrfs"].values())
        if not ipv4_neighbors_exist:
            self.result.is_failure("No IPv4 BFD peers are configured for any VRF.")
            return

        # Iterate over IPv4 BFD peers
        for vrf, vrf_data in bfd_output["vrfs"].items():
            for peer, neighbor_data in vrf_data["ipv4Neighbors"].items():
                for peer_data in neighbor_data["peerStats"].values():
                    peer_status = peer_data["status"]
                    remote_disc = peer_data["remoteDisc"]
                    remote_disc_info = f" with remote disc {remote_disc}" if remote_disc == 0 else ""
                    last_down = peer_data["lastDown"]
                    hours_difference = (
                        datetime.fromtimestamp(current_timestamp, tz=timezone.utc) - datetime.fromtimestamp(last_down, tz=timezone.utc)
                    ).total_seconds() / 3600

                    # Check if peer status is not up
                    if peer_status != "up":
                        down_failures.append(f"{peer} is {peer_status} in {vrf} VRF{remote_disc_info}.")

                    # Check if the last down is within the threshold
                    elif self.inputs.down_threshold and hours_difference < self.inputs.down_threshold:
                        up_failures.append(f"{peer} in {vrf} VRF was down {round(hours_difference)} hours ago{remote_disc_info}.")

                    # Check if remote disc is 0
                    elif remote_disc == 0:
                        up_failures.append(f"{peer} in {vrf} VRF has remote disc {remote_disc}.")

        # Check if there are any failures
        if down_failures:
            down_failures_str = "\n".join(down_failures)
            self.result.is_failure(f"Following BFD peers are not up:\n{down_failures_str}")
        if up_failures:
            up_failures_str = "\n".join(up_failures)
            self.result.is_failure(f"\nFollowing BFD peers were down:\n{up_failures_str}")

VerifyBFDPeersIntervals

Verifies the timers of the IPv4 BFD peers in the specified VRF.

Expected Results
  • Success: The test will pass if the timers of the IPv4 BFD peers are correct in the specified VRF.
  • Failure: The test will fail if the IPv4 BFD peers are not found or their timers are incorrect in the specified VRF.
Examples 
anta.tests.bfd:
  - VerifyBFDPeersIntervals:
      bfd_peers:
        - peer_address: 192.0.255.8
          vrf: default
          tx_interval: 1200
          rx_interval: 1200
          multiplier: 3
        - peer_address: 192.0.255.7
          vrf: default
          tx_interval: 1200
          rx_interval: 1200
          multiplier: 3

Inputs

Name Type Description Default
bfd_peers list[BFDPeer]
List of BFD peers.
-

BFDPeer

Name Type Description Default
peer_address IPv4Address
IPv4 address of a BFD peer.
-
vrf str
Optional VRF for BFD peer. If not provided, it defaults to `default`.
'default'
tx_interval BfdInterval
Tx interval of BFD peer in milliseconds.
-
rx_interval BfdInterval
Rx interval of BFD peer in milliseconds.
-
multiplier BfdMultiplier
Multiplier of BFD peer.
-
Source code in anta/tests/bfd.py 
 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
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
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
class VerifyBFDPeersIntervals(AntaTest):
    """Verifies the timers of the IPv4 BFD peers in the specified VRF.

    Expected Results
    ----------------
    * Success: The test will pass if the timers of the IPv4 BFD peers are correct in the specified VRF.
    * Failure: The test will fail if the IPv4 BFD peers are not found or their timers are incorrect in the specified VRF.

    Examples
    --------
    ```yaml
    anta.tests.bfd:
      - VerifyBFDPeersIntervals:
          bfd_peers:
            - peer_address: 192.0.255.8
              vrf: default
              tx_interval: 1200
              rx_interval: 1200
              multiplier: 3
            - peer_address: 192.0.255.7
              vrf: default
              tx_interval: 1200
              rx_interval: 1200
              multiplier: 3
    ```
    """

    name = "VerifyBFDPeersIntervals"
    description = "Verifies the timers of the IPv4 BFD peers in the specified VRF."
    categories: ClassVar[list[str]] = ["bfd"]
    commands: ClassVar[list[AntaCommand | AntaTemplate]] = [AntaCommand(command="show bfd peers detail", revision=1)]

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

        bfd_peers: list[BFDPeer]
        """List of BFD peers."""

        class BFDPeer(BaseModel):
            """Model for an IPv4 BFD peer."""

            peer_address: IPv4Address
            """IPv4 address of a BFD peer."""
            vrf: str = "default"
            """Optional VRF for BFD peer. If not provided, it defaults to `default`."""
            tx_interval: BfdInterval
            """Tx interval of BFD peer in milliseconds."""
            rx_interval: BfdInterval
            """Rx interval of BFD peer in milliseconds."""
            multiplier: BfdMultiplier
            """Multiplier of BFD peer."""

    @AntaTest.anta_test
    def test(self) -> None:
        """Main test function for VerifyBFDPeersIntervals."""
        failures: dict[Any, Any] = {}

        # Iterating over BFD peers
        for bfd_peers in self.inputs.bfd_peers:
            peer = str(bfd_peers.peer_address)
            vrf = bfd_peers.vrf
            tx_interval = bfd_peers.tx_interval
            rx_interval = bfd_peers.rx_interval
            multiplier = bfd_peers.multiplier

            # Check if BFD peer configured
            bfd_output = get_value(
                self.instance_commands[0].json_output,
                f"vrfs..{vrf}..ipv4Neighbors..{peer}..peerStats..",
                separator="..",
            )
            if not bfd_output:
                failures[peer] = {vrf: "Not Configured"}
                continue

            # Convert interval timer(s) into milliseconds to be consistent with the inputs.
            bfd_details = bfd_output.get("peerStatsDetail", {})
            op_tx_interval = bfd_details.get("operTxInterval") // 1000
            op_rx_interval = bfd_details.get("operRxInterval") // 1000
            detect_multiplier = bfd_details.get("detectMult")
            intervals_ok = op_tx_interval == tx_interval and op_rx_interval == rx_interval and detect_multiplier == multiplier

            # Check timers of BFD peer
            if not intervals_ok:
                failures[peer] = {
                    vrf: {
                        "tx_interval": op_tx_interval,
                        "rx_interval": op_rx_interval,
                        "multiplier": detect_multiplier,
                    }
                }

        # Check if any failures
        if not failures:
            self.result.is_success()
        else:
            self.result.is_failure(f"Following BFD peers are not configured or timers are not correct:\n{failures}")

VerifyBFDPeersRegProtocols

Verifies that IPv4 BFD peer(s) have the specified protocol(s) registered.

Expected Results
  • Success: The test will pass if IPv4 BFD peers are registered with the specified protocol(s).
  • Failure: The test will fail if IPv4 BFD peers are not found or the specified protocol(s) are not registered for the BFD peer(s).
Examples 
anta.tests.bfd:
  - VerifyBFDPeersRegProtocols:
      bfd_peers:
        - peer_address: 192.0.255.7
          vrf: default
          protocols:
            - bgp

Inputs

Name Type Description Default
bfd_peers list[BFDPeer]
List of IPv4 BFD peers.
-

BFDPeer

Name Type Description Default
peer_address IPv4Address
IPv4 address of a BFD peer.
-
vrf str
Optional VRF for BFD peer. If not provided, it defaults to `default`.
'default'
protocols list[BfdProtocol]
List of protocols to be verified.
-
Source code in anta/tests/bfd.py 
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
class VerifyBFDPeersRegProtocols(AntaTest):
    """Verifies that IPv4 BFD peer(s) have the specified protocol(s) registered.

    Expected Results
    ----------------
    * Success: The test will pass if IPv4 BFD peers are registered with the specified protocol(s).
    * Failure: The test will fail if IPv4 BFD peers are not found or the specified protocol(s) are not registered for the BFD peer(s).

    Examples
    --------
    ```yaml
    anta.tests.bfd:
      - VerifyBFDPeersRegProtocols:
          bfd_peers:
            - peer_address: 192.0.255.7
              vrf: default
              protocols:
                - bgp
    ```
    """

    name = "VerifyBFDPeersRegProtocols"
    description = "Verifies that IPv4 BFD peer(s) have the specified protocol(s) registered."
    categories: ClassVar[list[str]] = ["bfd"]
    commands: ClassVar[list[AntaCommand | AntaTemplate]] = [AntaCommand(command="show bfd peers detail", revision=1)]

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

        bfd_peers: list[BFDPeer]
        """List of IPv4 BFD peers."""

        class BFDPeer(BaseModel):
            """Model for an IPv4 BFD peer."""

            peer_address: IPv4Address
            """IPv4 address of a BFD peer."""
            vrf: str = "default"
            """Optional VRF for BFD peer. If not provided, it defaults to `default`."""
            protocols: list[BfdProtocol]
            """List of protocols to be verified."""

    @AntaTest.anta_test
    def test(self) -> None:
        """Main test function for VerifyBFDPeersRegProtocols."""
        # Initialize failure messages
        failures: dict[Any, Any] = {}

        # Iterating over BFD peers, extract the parameters and command output
        for bfd_peer in self.inputs.bfd_peers:
            peer = str(bfd_peer.peer_address)
            vrf = bfd_peer.vrf
            protocols = bfd_peer.protocols
            bfd_output = get_value(
                self.instance_commands[0].json_output,
                f"vrfs..{vrf}..ipv4Neighbors..{peer}..peerStats..",
                separator="..",
            )

            # Check if BFD peer configured
            if not bfd_output:
                failures[peer] = {vrf: "Not Configured"}
                continue

            # Check registered protocols
            difference = set(protocols) - set(get_value(bfd_output, "peerStatsDetail.apps"))

            if difference:
                failures[peer] = {vrf: sorted(difference)}

        if not failures:
            self.result.is_success()
        else:
            self.result.is_failure(f"The following BFD peers are not configured or have non-registered protocol(s):\n{failures}")

VerifyBFDSpecificPeers

Verifies if the IPv4 BFD peer’s sessions are UP and remote disc is non-zero in the specified VRF.

Expected Results
  • Success: The test will pass if IPv4 BFD peers are up and remote disc is non-zero in the specified VRF.
  • Failure: The test will fail if IPv4 BFD peers are not found, the status is not UP or remote disc is zero in the specified VRF.
Examples 
anta.tests.bfd:
  - VerifyBFDSpecificPeers:
      bfd_peers:
        - peer_address: 192.0.255.8
          vrf: default
        - peer_address: 192.0.255.7
          vrf: default

Inputs

Name Type Description Default
bfd_peers list[BFDPeer]
List of IPv4 BFD peers.
-

BFDPeer

Name Type Description Default
peer_address IPv4Address
IPv4 address of a BFD peer.
-
vrf str
Optional VRF for BFD peer. If not provided, it defaults to `default`.
'default'
Source code in anta/tests/bfd.py 
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
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
95
96
class VerifyBFDSpecificPeers(AntaTest):
    """Verifies if the IPv4 BFD peer's sessions are UP and remote disc is non-zero in the specified VRF.

    Expected Results
    ----------------
    * Success: The test will pass if IPv4 BFD peers are up and remote disc is non-zero in the specified VRF.
    * Failure: The test will fail if IPv4 BFD peers are not found, the status is not UP or remote disc is zero in the specified VRF.

    Examples
    --------
    ```yaml
    anta.tests.bfd:
      - VerifyBFDSpecificPeers:
          bfd_peers:
            - peer_address: 192.0.255.8
              vrf: default
            - peer_address: 192.0.255.7
              vrf: default
    ```
    """

    name = "VerifyBFDSpecificPeers"
    description = "Verifies the IPv4 BFD peer's sessions and remote disc in the specified VRF."
    categories: ClassVar[list[str]] = ["bfd"]
    commands: ClassVar[list[AntaCommand | AntaTemplate]] = [AntaCommand(command="show bfd peers", revision=1)]

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

        bfd_peers: list[BFDPeer]
        """List of IPv4 BFD peers."""

        class BFDPeer(BaseModel):
            """Model for an IPv4 BFD peer."""

            peer_address: IPv4Address
            """IPv4 address of a BFD peer."""
            vrf: str = "default"
            """Optional VRF for BFD peer. If not provided, it defaults to `default`."""

    @AntaTest.anta_test
    def test(self) -> None:
        """Main test function for VerifyBFDSpecificPeers."""
        failures: dict[Any, Any] = {}

        # Iterating over BFD peers
        for bfd_peer in self.inputs.bfd_peers:
            peer = str(bfd_peer.peer_address)
            vrf = bfd_peer.vrf
            bfd_output = get_value(
                self.instance_commands[0].json_output,
                f"vrfs..{vrf}..ipv4Neighbors..{peer}..peerStats..",
                separator="..",
            )

            # Check if BFD peer configured
            if not bfd_output:
                failures[peer] = {vrf: "Not Configured"}
                continue

            # Check BFD peer status and remote disc
            if not (bfd_output.get("status") == "up" and bfd_output.get("remoteDisc") != 0):
                failures[peer] = {
                    vrf: {
                        "status": bfd_output.get("status"),
                        "remote_disc": bfd_output.get("remoteDisc"),
                    }
                }

        if not failures:
            self.result.is_success()
        else:
            self.result.is_failure(f"Following BFD peers are not configured, status is not up or remote disc is zero:\n{failures}")