Skip to content

BGP

ANTA catalog for BGP tests

BGP test functions

VerifyBGPPeerCount

Bases: AntaTest

This test verifies the count of BGP peers for a given address family.

It supports multiple types of address families (AFI) and subsequent service families (SAFI). Please refer to the Input class attributes below for details.

Expected Results
  • success: If the count of BGP peers matches the expected count for each address family and VRF.
  • failure: If the count of BGP peers does not match the expected count, or if BGP is not configured for an expected VRF or address family.
Source code in anta/tests/routing/bgp.py 
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
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
class VerifyBGPPeerCount(AntaTest):
    """
    This test verifies the count of BGP peers for a given address family.

    It supports multiple types of address families (AFI) and subsequent service families (SAFI).
    Please refer to the Input class attributes below for details.

    Expected Results:
        * success: If the count of BGP peers matches the expected count for each address family and VRF.
        * failure: If the count of BGP peers does not match the expected count, or if BGP is not configured for an expected VRF or address family.
    """

    name = "VerifyBGPPeerCount"
    description = "Verifies the count of BGP peers."
    categories = ["routing", "bgp"]
    commands = [
        AntaTemplate(template="show bgp {afi} {safi} summary vrf {vrf}"),
        AntaTemplate(template="show bgp {afi} summary"),
    ]

    class Input(AntaTest.Input):  # pylint: disable=missing-class-docstring
        address_families: List[BgpAfi]
        """
        List of BGP address families (BgpAfi)
        """

        class BgpAfi(BaseModel):  # pylint: disable=missing-class-docstring
            afi: Afi
            """BGP address family (AFI)"""
            safi: Optional[Safi] = None
            """Optional BGP subsequent service family (SAFI).

            If the input `afi` is `ipv4` or `ipv6`, a valid `safi` must be provided.
            """
            vrf: str = "default"
            """
            Optional VRF for IPv4 and IPv6. If not provided, it defaults to `default`.

            If the input `afi` is not `ipv4` or `ipv6`, e.g. `evpn`, `vrf` must be `default`.
            """
            num_peers: PositiveInt
            """Number of expected BGP peer(s)"""

            @model_validator(mode="after")
            def validate_inputs(self: BaseModel) -> BaseModel:
                """
                Validate the inputs provided to the BgpAfi class.

                If afi is either ipv4 or ipv6, safi must be provided.

                If afi is not ipv4 or ipv6, safi must not be provided and vrf must be default.
                """
                if self.afi in ["ipv4", "ipv6"]:
                    if self.safi is None:
                        raise ValueError("'safi' must be provided when afi is ipv4 or ipv6")
                elif self.safi is not None:
                    raise ValueError("'safi' must not be provided when afi is not ipv4 or ipv6")
                elif self.vrf != "default":
                    raise ValueError("'vrf' must be default when afi is not ipv4 or ipv6")
                return self

    def render(self, template: AntaTemplate) -> list[AntaCommand]:
        commands = []
        for afi in self.inputs.address_families:
            if template == VerifyBGPPeerCount.commands[0] and afi.afi in ["ipv4", "ipv6"]:
                commands.append(template.render(afi=afi.afi, safi=afi.safi, vrf=afi.vrf, num_peers=afi.num_peers))
            elif template == VerifyBGPPeerCount.commands[1] and afi.afi not in ["ipv4", "ipv6"]:
                commands.append(template.render(afi=afi.afi, vrf=afi.vrf, num_peers=afi.num_peers))
        return commands

    @AntaTest.anta_test
    def test(self) -> None:
        self.result.is_success()

        failures: dict[tuple[str, Any], dict[str, Any]] = {}

        for command in self.instance_commands:
            peer_count = 0
            command_output = command.json_output

            afi = cast(Afi, command.params.get("afi"))
            safi = cast(Optional[Safi], command.params.get("safi"))
            afi_vrf = cast(str, command.params.get("vrf"))
            num_peers = cast(PositiveInt, command.params.get("num_peers"))

            if not (vrfs := command_output.get("vrfs")):
                _add_bgp_failures(failures=failures, afi=afi, safi=safi, vrf=afi_vrf, issue="Not Configured")
                continue

            if afi_vrf == "all":
                for vrf_data in vrfs.values():
                    peer_count += len(vrf_data["peers"])
            else:
                peer_count += len(command_output["vrfs"][afi_vrf]["peers"])

            if peer_count != num_peers:
                _add_bgp_failures(failures=failures, afi=afi, safi=safi, vrf=afi_vrf, issue=f"Expected: {num_peers}, Actual: {peer_count}")

        if failures:
            self.result.is_failure(f"Failures: {list(failures.values())}")

Input

Bases: Input

Source code in anta/tests/routing/bgp.py 
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
class Input(AntaTest.Input):  # pylint: disable=missing-class-docstring
    address_families: List[BgpAfi]
    """
    List of BGP address families (BgpAfi)
    """

    class BgpAfi(BaseModel):  # pylint: disable=missing-class-docstring
        afi: Afi
        """BGP address family (AFI)"""
        safi: Optional[Safi] = None
        """Optional BGP subsequent service family (SAFI).

        If the input `afi` is `ipv4` or `ipv6`, a valid `safi` must be provided.
        """
        vrf: str = "default"
        """
        Optional VRF for IPv4 and IPv6. If not provided, it defaults to `default`.

        If the input `afi` is not `ipv4` or `ipv6`, e.g. `evpn`, `vrf` must be `default`.
        """
        num_peers: PositiveInt
        """Number of expected BGP peer(s)"""

        @model_validator(mode="after")
        def validate_inputs(self: BaseModel) -> BaseModel:
            """
            Validate the inputs provided to the BgpAfi class.

            If afi is either ipv4 or ipv6, safi must be provided.

            If afi is not ipv4 or ipv6, safi must not be provided and vrf must be default.
            """
            if self.afi in ["ipv4", "ipv6"]:
                if self.safi is None:
                    raise ValueError("'safi' must be provided when afi is ipv4 or ipv6")
            elif self.safi is not None:
                raise ValueError("'safi' must not be provided when afi is not ipv4 or ipv6")
            elif self.vrf != "default":
                raise ValueError("'vrf' must be default when afi is not ipv4 or ipv6")
            return self

address_families instance-attribute 

address_families: List[BgpAfi]

List of BGP address families (BgpAfi)

BgpAfi

Bases: BaseModel

Source code in anta/tests/routing/bgp.py 
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
class BgpAfi(BaseModel):  # pylint: disable=missing-class-docstring
    afi: Afi
    """BGP address family (AFI)"""
    safi: Optional[Safi] = None
    """Optional BGP subsequent service family (SAFI).

    If the input `afi` is `ipv4` or `ipv6`, a valid `safi` must be provided.
    """
    vrf: str = "default"
    """
    Optional VRF for IPv4 and IPv6. If not provided, it defaults to `default`.

    If the input `afi` is not `ipv4` or `ipv6`, e.g. `evpn`, `vrf` must be `default`.
    """
    num_peers: PositiveInt
    """Number of expected BGP peer(s)"""

    @model_validator(mode="after")
    def validate_inputs(self: BaseModel) -> BaseModel:
        """
        Validate the inputs provided to the BgpAfi class.

        If afi is either ipv4 or ipv6, safi must be provided.

        If afi is not ipv4 or ipv6, safi must not be provided and vrf must be default.
        """
        if self.afi in ["ipv4", "ipv6"]:
            if self.safi is None:
                raise ValueError("'safi' must be provided when afi is ipv4 or ipv6")
        elif self.safi is not None:
            raise ValueError("'safi' must not be provided when afi is not ipv4 or ipv6")
        elif self.vrf != "default":
            raise ValueError("'vrf' must be default when afi is not ipv4 or ipv6")
        return self
afi instance-attribute 
afi: Afi

BGP address family (AFI)

num_peers instance-attribute 
num_peers: PositiveInt

Number of expected BGP peer(s)

safi class-attribute instance-attribute 
safi: Optional[Safi] = None

Optional BGP subsequent service family (SAFI).

If the input afi is ipv4 or ipv6, a valid safi must be provided.

vrf class-attribute instance-attribute 
vrf: str = 'default'

Optional VRF for IPv4 and IPv6. If not provided, it defaults to default.

If the input afi is not ipv4 or ipv6, e.g. evpn, vrf must be default.

validate_inputs 
validate_inputs() -> BaseModel

Validate the inputs provided to the BgpAfi class.

If afi is either ipv4 or ipv6, safi must be provided.

If afi is not ipv4 or ipv6, safi must not be provided and vrf must be default.

Source code in anta/tests/routing/bgp.py 
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
@model_validator(mode="after")
def validate_inputs(self: BaseModel) -> BaseModel:
    """
    Validate the inputs provided to the BgpAfi class.

    If afi is either ipv4 or ipv6, safi must be provided.

    If afi is not ipv4 or ipv6, safi must not be provided and vrf must be default.
    """
    if self.afi in ["ipv4", "ipv6"]:
        if self.safi is None:
            raise ValueError("'safi' must be provided when afi is ipv4 or ipv6")
    elif self.safi is not None:
        raise ValueError("'safi' must not be provided when afi is not ipv4 or ipv6")
    elif self.vrf != "default":
        raise ValueError("'vrf' must be default when afi is not ipv4 or ipv6")
    return self

VerifyBGPPeersHealth

Bases: AntaTest

This test verifies the health of BGP peers.

It will validate that all BGP sessions are established and all message queues for these BGP sessions are empty for a given address family.

It supports multiple types of address families (AFI) and subsequent service families (SAFI). Please refer to the Input class attributes below for details.

Expected Results
  • success: If all BGP sessions are established and all messages queues are empty for each address family and VRF.
  • failure: If there are issues with any of the BGP sessions, or if BGP is not configured for an expected VRF or address family.
Source code in anta/tests/routing/bgp.py 
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
288
289
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
class VerifyBGPPeersHealth(AntaTest):
    """
    This test verifies the health of BGP peers.

    It will validate that all BGP sessions are established and all message queues for these BGP sessions are empty for a given address family.

    It supports multiple types of address families (AFI) and subsequent service families (SAFI).
    Please refer to the Input class attributes below for details.

    Expected Results:
        * success: If all BGP sessions are established and all messages queues are empty for each address family and VRF.
        * failure: If there are issues with any of the BGP sessions, or if BGP is not configured for an expected VRF or address family.
    """

    name = "VerifyBGPPeersHealth"
    description = "Verifies the health of BGP peers"
    categories = ["routing", "bgp"]
    commands = [
        AntaTemplate(template="show bgp {afi} {safi} summary vrf {vrf}"),
        AntaTemplate(template="show bgp {afi} summary"),
    ]

    class Input(AntaTest.Input):  # pylint: disable=missing-class-docstring
        address_families: List[BgpAfi]
        """
        List of BGP address families (BgpAfi)
        """

        class BgpAfi(BaseModel):  # pylint: disable=missing-class-docstring
            afi: Afi
            """BGP address family (AFI)"""
            safi: Optional[Safi] = None
            """Optional BGP subsequent service family (SAFI).

            If the input `afi` is `ipv4` or `ipv6`, a valid `safi` must be provided.
            """
            vrf: str = "default"
            """
            Optional VRF for IPv4 and IPv6. If not provided, it defaults to `default`.

            If the input `afi` is not `ipv4` or `ipv6`, e.g. `evpn`, `vrf` must be `default`.
            """

            @model_validator(mode="after")
            def validate_inputs(self: BaseModel) -> BaseModel:
                """
                Validate the inputs provided to the BgpAfi class.

                If afi is either ipv4 or ipv6, safi must be provided.

                If afi is not ipv4 or ipv6, safi must not be provided and vrf must be default.
                """
                if self.afi in ["ipv4", "ipv6"]:
                    if self.safi is None:
                        raise ValueError("'safi' must be provided when afi is ipv4 or ipv6")
                elif self.safi is not None:
                    raise ValueError("'safi' must not be provided when afi is not ipv4 or ipv6")
                elif self.vrf != "default":
                    raise ValueError("'vrf' must be default when afi is not ipv4 or ipv6")
                return self

    def render(self, template: AntaTemplate) -> list[AntaCommand]:
        commands = []
        for afi in self.inputs.address_families:
            if template == VerifyBGPPeersHealth.commands[0] and afi.afi in ["ipv4", "ipv6"]:
                commands.append(template.render(afi=afi.afi, safi=afi.safi, vrf=afi.vrf))
            elif template == VerifyBGPPeersHealth.commands[1] and afi.afi not in ["ipv4", "ipv6"]:
                commands.append(template.render(afi=afi.afi, vrf=afi.vrf))
        return commands

    @AntaTest.anta_test
    def test(self) -> None:
        self.result.is_success()

        failures: dict[tuple[str, Any], dict[str, Any]] = {}

        for command in self.instance_commands:
            command_output = command.json_output

            afi = cast(Afi, command.params.get("afi"))
            safi = cast(Optional[Safi], command.params.get("safi"))
            afi_vrf = cast(str, command.params.get("vrf"))

            if not (vrfs := command_output.get("vrfs")):
                _add_bgp_failures(failures=failures, afi=afi, safi=safi, vrf=afi_vrf, issue="Not Configured")
                continue

            for vrf, vrf_data in vrfs.items():
                if not (peers := vrf_data.get("peers")):
                    _add_bgp_failures(failures=failures, afi=afi, safi=safi, vrf=afi_vrf, issue="No Peers")
                    continue

                peer_issues = {}
                for peer, peer_data in peers.items():
                    issues = _check_peer_issues(peer_data)

                    if issues:
                        peer_issues[peer] = issues

                if peer_issues:
                    _add_bgp_failures(failures=failures, afi=afi, safi=safi, vrf=vrf, issue=peer_issues)

        if failures:
            self.result.is_failure(f"Failures: {list(failures.values())}")

Input

Bases: Input

Source code in anta/tests/routing/bgp.py 
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
288
289
290
291
292
293
294
295
296
class Input(AntaTest.Input):  # pylint: disable=missing-class-docstring
    address_families: List[BgpAfi]
    """
    List of BGP address families (BgpAfi)
    """

    class BgpAfi(BaseModel):  # pylint: disable=missing-class-docstring
        afi: Afi
        """BGP address family (AFI)"""
        safi: Optional[Safi] = None
        """Optional BGP subsequent service family (SAFI).

        If the input `afi` is `ipv4` or `ipv6`, a valid `safi` must be provided.
        """
        vrf: str = "default"
        """
        Optional VRF for IPv4 and IPv6. If not provided, it defaults to `default`.

        If the input `afi` is not `ipv4` or `ipv6`, e.g. `evpn`, `vrf` must be `default`.
        """

        @model_validator(mode="after")
        def validate_inputs(self: BaseModel) -> BaseModel:
            """
            Validate the inputs provided to the BgpAfi class.

            If afi is either ipv4 or ipv6, safi must be provided.

            If afi is not ipv4 or ipv6, safi must not be provided and vrf must be default.
            """
            if self.afi in ["ipv4", "ipv6"]:
                if self.safi is None:
                    raise ValueError("'safi' must be provided when afi is ipv4 or ipv6")
            elif self.safi is not None:
                raise ValueError("'safi' must not be provided when afi is not ipv4 or ipv6")
            elif self.vrf != "default":
                raise ValueError("'vrf' must be default when afi is not ipv4 or ipv6")
            return self

address_families instance-attribute 

address_families: List[BgpAfi]

List of BGP address families (BgpAfi)

BgpAfi

Bases: BaseModel

Source code in anta/tests/routing/bgp.py 
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
class BgpAfi(BaseModel):  # pylint: disable=missing-class-docstring
    afi: Afi
    """BGP address family (AFI)"""
    safi: Optional[Safi] = None
    """Optional BGP subsequent service family (SAFI).

    If the input `afi` is `ipv4` or `ipv6`, a valid `safi` must be provided.
    """
    vrf: str = "default"
    """
    Optional VRF for IPv4 and IPv6. If not provided, it defaults to `default`.

    If the input `afi` is not `ipv4` or `ipv6`, e.g. `evpn`, `vrf` must be `default`.
    """

    @model_validator(mode="after")
    def validate_inputs(self: BaseModel) -> BaseModel:
        """
        Validate the inputs provided to the BgpAfi class.

        If afi is either ipv4 or ipv6, safi must be provided.

        If afi is not ipv4 or ipv6, safi must not be provided and vrf must be default.
        """
        if self.afi in ["ipv4", "ipv6"]:
            if self.safi is None:
                raise ValueError("'safi' must be provided when afi is ipv4 or ipv6")
        elif self.safi is not None:
            raise ValueError("'safi' must not be provided when afi is not ipv4 or ipv6")
        elif self.vrf != "default":
            raise ValueError("'vrf' must be default when afi is not ipv4 or ipv6")
        return self
afi instance-attribute 
afi: Afi

BGP address family (AFI)

safi class-attribute instance-attribute 
safi: Optional[Safi] = None

Optional BGP subsequent service family (SAFI).

If the input afi is ipv4 or ipv6, a valid safi must be provided.

vrf class-attribute instance-attribute 
vrf: str = 'default'

Optional VRF for IPv4 and IPv6. If not provided, it defaults to default.

If the input afi is not ipv4 or ipv6, e.g. evpn, vrf must be default.

validate_inputs 
validate_inputs() -> BaseModel

Validate the inputs provided to the BgpAfi class.

If afi is either ipv4 or ipv6, safi must be provided.

If afi is not ipv4 or ipv6, safi must not be provided and vrf must be default.

Source code in anta/tests/routing/bgp.py 
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
@model_validator(mode="after")
def validate_inputs(self: BaseModel) -> BaseModel:
    """
    Validate the inputs provided to the BgpAfi class.

    If afi is either ipv4 or ipv6, safi must be provided.

    If afi is not ipv4 or ipv6, safi must not be provided and vrf must be default.
    """
    if self.afi in ["ipv4", "ipv6"]:
        if self.safi is None:
            raise ValueError("'safi' must be provided when afi is ipv4 or ipv6")
    elif self.safi is not None:
        raise ValueError("'safi' must not be provided when afi is not ipv4 or ipv6")
    elif self.vrf != "default":
        raise ValueError("'vrf' must be default when afi is not ipv4 or ipv6")
    return self

VerifyBGPSpecificPeers

Bases: AntaTest

This test verifies the health of specific BGP peer(s).

It will validate that the BGP session is established and all message queues for this BGP session are empty for the given peer(s).

It supports multiple types of address families (AFI) and subsequent service families (SAFI). Please refer to the Input class attributes below for details.

Expected Results
  • success: If the BGP session is established and all messages queues are empty for each given peer.
  • failure: If the BGP session has issues or is not configured, or if BGP is not configured for an expected VRF or address family.
Source code in anta/tests/routing/bgp.py 
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
class VerifyBGPSpecificPeers(AntaTest):
    """
    This test verifies the health of specific BGP peer(s).

    It will validate that the BGP session is established and all message queues for this BGP session are empty for the given peer(s).

    It supports multiple types of address families (AFI) and subsequent service families (SAFI).
    Please refer to the Input class attributes below for details.

    Expected Results:
        * success: If the BGP session is established and all messages queues are empty for each given peer.
        * failure: If the BGP session has issues or is not configured, or if BGP is not configured for an expected VRF or address family.
    """

    name = "VerifyBGPSpecificPeers"
    description = "Verifies the health of specific BGP peer(s)."
    categories = ["routing", "bgp"]
    commands = [
        AntaTemplate(template="show bgp {afi} {safi} summary vrf {vrf}"),
        AntaTemplate(template="show bgp {afi} summary"),
    ]

    class Input(AntaTest.Input):  # pylint: disable=missing-class-docstring
        address_families: List[BgpAfi]
        """
        List of BGP address families (BgpAfi)
        """

        class BgpAfi(BaseModel):  # pylint: disable=missing-class-docstring
            afi: Afi
            """BGP address family (AFI)"""
            safi: Optional[Safi] = None
            """Optional BGP subsequent service family (SAFI).

            If the input `afi` is `ipv4` or `ipv6`, a valid `safi` must be provided.
            """
            vrf: str = "default"
            """
            Optional VRF for IPv4 and IPv6. If not provided, it defaults to `default`.

            `all` is NOT supported.

            If the input `afi` is not `ipv4` or `ipv6`, e.g. `evpn`, `vrf` must be `default`.
            """
            peers: List[Union[IPv4Address, IPv6Address]]
            """List of BGP IPv4 or IPv6 peer"""

            @model_validator(mode="after")
            def validate_inputs(self: BaseModel) -> BaseModel:
                """
                Validate the inputs provided to the BgpAfi class.

                If afi is either ipv4 or ipv6, safi must be provided and vrf must NOT be all.

                If afi is not ipv4 or ipv6, safi must not be provided and vrf must be default.
                """
                if self.afi in ["ipv4", "ipv6"]:
                    if self.safi is None:
                        raise ValueError("'safi' must be provided when afi is ipv4 or ipv6")
                    if self.vrf == "all":
                        raise ValueError("'all' is not supported in this test. Use VerifyBGPPeersHealth test instead.")
                elif self.safi is not None:
                    raise ValueError("'safi' must not be provided when afi is not ipv4 or ipv6")
                elif self.vrf != "default":
                    raise ValueError("'vrf' must be default when afi is not ipv4 or ipv6")
                return self

    def render(self, template: AntaTemplate) -> list[AntaCommand]:
        commands = []
        for afi in self.inputs.address_families:
            if template == VerifyBGPSpecificPeers.commands[0] and afi.afi in ["ipv4", "ipv6"]:
                commands.append(template.render(afi=afi.afi, safi=afi.safi, vrf=afi.vrf, peers=afi.peers))
            elif template == VerifyBGPSpecificPeers.commands[1] and afi.afi not in ["ipv4", "ipv6"]:
                commands.append(template.render(afi=afi.afi, vrf=afi.vrf, peers=afi.peers))
        return commands

    @AntaTest.anta_test
    def test(self) -> None:
        self.result.is_success()

        failures: dict[tuple[str, Any], dict[str, Any]] = {}

        for command in self.instance_commands:
            command_output = command.json_output

            afi = cast(Afi, command.params.get("afi"))
            safi = cast(Optional[Safi], command.params.get("safi"))
            afi_vrf = cast(str, command.params.get("vrf"))
            afi_peers = cast(List[Union[IPv4Address, IPv6Address]], command.params.get("peers", []))

            if not (vrfs := command_output.get("vrfs")):
                _add_bgp_failures(failures=failures, afi=afi, safi=safi, vrf=afi_vrf, issue="Not Configured")
                continue

            peer_issues = {}
            for peer in afi_peers:
                peer_ip = str(peer)
                peer_data = get_value(dictionary=vrfs, key=f"{afi_vrf}_peers_{peer_ip}", separator="_")
                issues = _check_peer_issues(peer_data)
                if issues:
                    peer_issues[peer_ip] = issues

            if peer_issues:
                _add_bgp_failures(failures=failures, afi=afi, safi=safi, vrf=afi_vrf, issue=peer_issues)

        if failures:
            self.result.is_failure(f"Failures: {list(failures.values())}")

Input

Bases: Input

Source code in anta/tests/routing/bgp.py 
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
class Input(AntaTest.Input):  # pylint: disable=missing-class-docstring
    address_families: List[BgpAfi]
    """
    List of BGP address families (BgpAfi)
    """

    class BgpAfi(BaseModel):  # pylint: disable=missing-class-docstring
        afi: Afi
        """BGP address family (AFI)"""
        safi: Optional[Safi] = None
        """Optional BGP subsequent service family (SAFI).

        If the input `afi` is `ipv4` or `ipv6`, a valid `safi` must be provided.
        """
        vrf: str = "default"
        """
        Optional VRF for IPv4 and IPv6. If not provided, it defaults to `default`.

        `all` is NOT supported.

        If the input `afi` is not `ipv4` or `ipv6`, e.g. `evpn`, `vrf` must be `default`.
        """
        peers: List[Union[IPv4Address, IPv6Address]]
        """List of BGP IPv4 or IPv6 peer"""

        @model_validator(mode="after")
        def validate_inputs(self: BaseModel) -> BaseModel:
            """
            Validate the inputs provided to the BgpAfi class.

            If afi is either ipv4 or ipv6, safi must be provided and vrf must NOT be all.

            If afi is not ipv4 or ipv6, safi must not be provided and vrf must be default.
            """
            if self.afi in ["ipv4", "ipv6"]:
                if self.safi is None:
                    raise ValueError("'safi' must be provided when afi is ipv4 or ipv6")
                if self.vrf == "all":
                    raise ValueError("'all' is not supported in this test. Use VerifyBGPPeersHealth test instead.")
            elif self.safi is not None:
                raise ValueError("'safi' must not be provided when afi is not ipv4 or ipv6")
            elif self.vrf != "default":
                raise ValueError("'vrf' must be default when afi is not ipv4 or ipv6")
            return self

address_families instance-attribute 

address_families: List[BgpAfi]

List of BGP address families (BgpAfi)

BgpAfi

Bases: BaseModel

Source code in anta/tests/routing/bgp.py 
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
class BgpAfi(BaseModel):  # pylint: disable=missing-class-docstring
    afi: Afi
    """BGP address family (AFI)"""
    safi: Optional[Safi] = None
    """Optional BGP subsequent service family (SAFI).

    If the input `afi` is `ipv4` or `ipv6`, a valid `safi` must be provided.
    """
    vrf: str = "default"
    """
    Optional VRF for IPv4 and IPv6. If not provided, it defaults to `default`.

    `all` is NOT supported.

    If the input `afi` is not `ipv4` or `ipv6`, e.g. `evpn`, `vrf` must be `default`.
    """
    peers: List[Union[IPv4Address, IPv6Address]]
    """List of BGP IPv4 or IPv6 peer"""

    @model_validator(mode="after")
    def validate_inputs(self: BaseModel) -> BaseModel:
        """
        Validate the inputs provided to the BgpAfi class.

        If afi is either ipv4 or ipv6, safi must be provided and vrf must NOT be all.

        If afi is not ipv4 or ipv6, safi must not be provided and vrf must be default.
        """
        if self.afi in ["ipv4", "ipv6"]:
            if self.safi is None:
                raise ValueError("'safi' must be provided when afi is ipv4 or ipv6")
            if self.vrf == "all":
                raise ValueError("'all' is not supported in this test. Use VerifyBGPPeersHealth test instead.")
        elif self.safi is not None:
            raise ValueError("'safi' must not be provided when afi is not ipv4 or ipv6")
        elif self.vrf != "default":
            raise ValueError("'vrf' must be default when afi is not ipv4 or ipv6")
        return self
afi instance-attribute 
afi: Afi

BGP address family (AFI)

peers instance-attribute 
peers: List[Union[IPv4Address, IPv6Address]]

List of BGP IPv4 or IPv6 peer

safi class-attribute instance-attribute 
safi: Optional[Safi] = None

Optional BGP subsequent service family (SAFI).

If the input afi is ipv4 or ipv6, a valid safi must be provided.

vrf class-attribute instance-attribute 
vrf: str = 'default'

Optional VRF for IPv4 and IPv6. If not provided, it defaults to default.

all is NOT supported.

If the input afi is not ipv4 or ipv6, e.g. evpn, vrf must be default.

validate_inputs 
validate_inputs() -> BaseModel

Validate the inputs provided to the BgpAfi class.

If afi is either ipv4 or ipv6, safi must be provided and vrf must NOT be all.

If afi is not ipv4 or ipv6, safi must not be provided and vrf must be default.

Source code in anta/tests/routing/bgp.py 
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
@model_validator(mode="after")
def validate_inputs(self: BaseModel) -> BaseModel:
    """
    Validate the inputs provided to the BgpAfi class.

    If afi is either ipv4 or ipv6, safi must be provided and vrf must NOT be all.

    If afi is not ipv4 or ipv6, safi must not be provided and vrf must be default.
    """
    if self.afi in ["ipv4", "ipv6"]:
        if self.safi is None:
            raise ValueError("'safi' must be provided when afi is ipv4 or ipv6")
        if self.vrf == "all":
            raise ValueError("'all' is not supported in this test. Use VerifyBGPPeersHealth test instead.")
    elif self.safi is not None:
        raise ValueError("'safi' must not be provided when afi is not ipv4 or ipv6")
    elif self.vrf != "default":
        raise ValueError("'vrf' must be default when afi is not ipv4 or ipv6")
    return self