ANTA catalog for interfaces tests
VerifyIPProxyARP ¶
Verifies if Proxy-ARP is enabled for the provided list of interface(s).
Expected Results
- Success: The test will pass if Proxy-ARP is enabled on the specified interface(s).
- Failure: The test will fail if Proxy-ARP is disabled on the specified interface(s).
Examples
anta.tests.interfaces:
- VerifyIPProxyARP:
interfaces:
- Ethernet1
- Ethernet2
Source code in anta/tests/interfaces.py
537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 |
|
VerifyIllegalLACP ¶
Verifies there are no illegal LACP packets in all port channels.
Expected Results
- Success: The test will pass if there are no illegal LACP packets received.
- Failure: The test will fail if there is at least one illegal LACP packet received.
Examples
anta.tests.interfaces:
- VerifyIllegalLACP:
Source code in anta/tests/interfaces.py
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 |
|
VerifyInterfaceDiscards ¶
Verifies that the interfaces packet discard counters are equal to zero.
Expected Results
- Success: The test will pass if all interfaces have discard counters equal to zero.
- Failure: The test will fail if one or more interfaces have non-zero discard counters.
Examples
anta.tests.interfaces:
- VerifyInterfaceDiscards:
Source code in anta/tests/interfaces.py
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 |
|
VerifyInterfaceErrDisabled ¶
Verifies there are no interfaces in the errdisabled state.
Expected Results
- Success: The test will pass if there are no interfaces in the errdisabled state.
- Failure: The test will fail if there is at least one interface in the errdisabled state.
Examples
anta.tests.interfaces:
- VerifyInterfaceErrDisabled:
Source code in anta/tests/interfaces.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 |
|
VerifyInterfaceErrors ¶
Verifies that the interfaces error counters are equal to zero.
Expected Results
- Success: The test will pass if all interfaces have error counters equal to zero.
- Failure: The test will fail if one or more interfaces have non-zero error counters.
Examples
anta.tests.interfaces:
- VerifyInterfaceErrors:
Source code in anta/tests/interfaces.py
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 124 |
|
VerifyInterfaceIPv4 ¶
Verifies if an interface is configured with a correct primary and list of optional secondary IPv4 addresses.
Expected Results
- Success: The test will pass if an interface is configured with a correct primary and secondary IPv4 address.
- Failure: The test will fail if an interface is not found or the primary and secondary IPv4 addresses do not match with the input.
Examples
anta.tests.interfaces:
- VerifyInterfaceIPv4:
interfaces:
- name: Ethernet2
primary_ip: 172.30.11.0/31
secondary_ips:
- 10.10.10.0/31
- 10.10.10.10/31
Inputs¶
Name | Type | Description | Default |
---|---|---|---|
interfaces |
list[InterfaceDetail]
|
List of interfaces with their details.
|
- |
InterfaceDetail¶
Name | Type | Description | Default |
---|---|---|---|
name |
Interface
|
Name of the interface.
|
- |
primary_ip |
IPv4Network
|
Primary IPv4 address in CIDR notation.
|
- |
secondary_ips |
list[IPv4Network] | None
|
Optional list of secondary IPv4 addresses in CIDR notation.
|
None
|
Source code in anta/tests/interfaces.py
650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 |
|
VerifyInterfaceUtilization ¶
Verifies that the utilization of interfaces is below a certain threshold.
Load interval (default to 5 minutes) is defined in device configuration. This test has been implemented for full-duplex interfaces only.
Expected Results
- Success: The test will pass if all interfaces have a usage below the threshold.
- Failure: The test will fail if one or more interfaces have a usage above the threshold.
- Error: The test will error out if the device has at least one non full-duplex interface.
Examples
anta.tests.interfaces:
- VerifyInterfaceUtilization:
threshold: 70.0
Inputs¶
Name | Type | Description | Default |
---|---|---|---|
threshold |
Percent
|
Interface utilization threshold above which the test will fail. Defaults to 75%.
|
75.0
|
Source code in anta/tests/interfaces.py
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 |
|
VerifyInterfacesSpeed ¶
Verifies the speed, lanes, auto-negotiation status, and mode as full duplex for interfaces.
- If the auto-negotiation status is set to True, verifies that auto-negotiation is successful, the mode is full duplex and the speed/lanes match the input.
- If the auto-negotiation status is set to False, verifies that the mode is full duplex and the speed/lanes match the input.
Expected Results
- Success: The test will pass if an interface is configured correctly with the specified speed, lanes, auto-negotiation status, and mode as full duplex.
- Failure: The test will fail if an interface is not found, if the speed, lanes, and auto-negotiation status do not match the input, or mode is not full duplex.
Examples
anta.tests.interfaces:
- VerifyInterfacesSpeed:
interfaces:
- name: Ethernet2
auto: False
speed: 10
- name: Eth3
auto: True
speed: 100
lanes: 1
- name: Eth2
auto: False
speed: 2.5
Inputs¶
Name | Type | Description | Default |
---|---|---|---|
interfaces |
list[InterfaceDetail]
|
List of interfaces to be tested
|
- |
InterfaceDetail¶
Name | Type | Description | Default |
---|---|---|---|
name |
EthernetInterface
|
The name of the interface.
|
- |
auto |
bool
|
The auto-negotiation status of the interface.
|
- |
speed |
float
|
The speed of the interface in Gigabits per second. Valid range is 1 to 1000.
|
Field(ge=1, le=1000)
|
lanes |
None | int
|
The number of lanes in the interface. Valid range is 1 to 8. This field is optional.
|
Field(None, ge=1, le=8)
|
Source code in anta/tests/interfaces.py
791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 |
|
VerifyInterfacesStatus ¶
Verifies if the provided list of interfaces are all in the expected state.
- If line protocol status is provided, prioritize checking against both status and line protocol status
- If line protocol status is not provided and interface status is “up”, expect both status and line protocol to be “up”
- If interface status is not “up”, check only the interface status without considering line protocol status
Expected Results
- Success: The test will pass if the provided interfaces are all in the expected state.
- Failure: The test will fail if any interface is not in the expected state.
Examples
anta.tests.interfaces:
- VerifyInterfacesStatus:
interfaces:
- name: Ethernet1
status: up
- name: Port-Channel100
status: down
line_protocol_status: lowerLayerDown
- name: Ethernet49/1
status: adminDown
line_protocol_status: notPresent
Inputs¶
Name | Type | Description | Default |
---|---|---|---|
interfaces |
list[InterfaceState]
|
List of interfaces with their expected state.
|
- |
InterfaceState¶
Name | Type | Description | Default |
---|---|---|---|
name |
Interface
|
Interface to validate.
|
- |
status |
Literal['up', 'down', 'adminDown']
|
Expected status of the interface.
|
- |
line_protocol_status |
Literal['up', 'down', 'testing', 'unknown', 'dormant', 'notPresent', 'lowerLayerDown'] | None
|
Expected line protocol status of the interface.
|
None
|
Source code in anta/tests/interfaces.py
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 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 |
|
VerifyIpVirtualRouterMac ¶
Verifies the IP virtual router MAC address.
Expected Results
- Success: The test will pass if the IP virtual router MAC address matches the input.
- Failure: The test will fail if the IP virtual router MAC address does not match the input.
Examples
anta.tests.interfaces:
- VerifyIpVirtualRouterMac:
mac_address: 00:1c:73:00:dc:01
Inputs¶
Name | Type | Description | Default |
---|---|---|---|
mac_address |
MacAddress
|
IP virtual router MAC address.
|
- |
Source code in anta/tests/interfaces.py
751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 |
|
VerifyL2MTU ¶
Verifies the global layer 2 Maximum Transfer Unit (MTU) for all L2 interfaces.
Test that L2 interfaces are configured with the correct MTU. It supports Ethernet, Port Channel and VLAN interfaces. You can define a global MTU to check and also an MTU per interface and also ignored some interfaces.
Expected Results
- Success: The test will pass if all layer 2 interfaces have the proper MTU configured.
- Failure: The test will fail if one or many layer 2 interfaces have the wrong MTU configured.
Examples
anta.tests.interfaces:
- VerifyL2MTU:
mtu: 1500
ignored_interfaces:
- Management1
- Vxlan1
specific_mtu:
- Ethernet1/1: 1500
Inputs¶
Name | Type | Description | Default |
---|---|---|---|
mtu |
int
|
Default MTU we should have configured on all non-excluded interfaces. Defaults to 9214.
|
9214
|
ignored_interfaces |
list[str]
|
A list of L2 interfaces to ignore. Defaults to ["Management", "Loopback", "Vxlan", "Tunnel"]
|
Field(default=['Management', 'Loopback', 'Vxlan', 'Tunnel'])
|
specific_mtu |
list[dict[str, int]]
|
A list of dictionary of L2 interfaces with their specific MTU configured
|
Field(default=[])
|
Source code in anta/tests/interfaces.py
585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 |
|
VerifyL3MTU ¶
Verifies the global layer 3 Maximum Transfer Unit (MTU) for all L3 interfaces.
Test that L3 interfaces are configured with the correct MTU. It supports Ethernet, Port Channel and VLAN interfaces.
You can define a global MTU to check, or an MTU per interface and you can also ignored some interfaces.
Expected Results
- Success: The test will pass if all layer 3 interfaces have the proper MTU configured.
- Failure: The test will fail if one or many layer 3 interfaces have the wrong MTU configured.
Examples
anta.tests.interfaces:
- VerifyL3MTU:
mtu: 1500
ignored_interfaces:
- Vxlan1
specific_mtu:
- Ethernet1: 2500
Inputs¶
Name | Type | Description | Default |
---|---|---|---|
mtu |
int
|
Default MTU we should have configured on all non-excluded interfaces. Defaults to 1500.
|
1500
|
ignored_interfaces |
list[str]
|
A list of L3 interfaces to ignore
|
Field(default=['Management', 'Loopback', 'Vxlan', 'Tunnel'])
|
specific_mtu |
list[dict[str, int]]
|
A list of dictionary of L3 interfaces with their specific MTU configured
|
Field(default=[])
|
Source code in anta/tests/interfaces.py
473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 |
|
VerifyLoopbackCount ¶
Verifies that the device has the expected number of loopback interfaces and all are operational.
Expected Results
- Success: The test will pass if the device has the correct number of loopback interfaces and none are down.
- Failure: The test will fail if the loopback interface count is incorrect or any are non-operational.
Examples
anta.tests.interfaces:
- VerifyLoopbackCount:
number: 3
Inputs¶
Name | Type | Description | Default |
---|---|---|---|
number |
PositiveInteger
|
Number of loopback interfaces expected to be present.
|
- |
Source code in anta/tests/interfaces.py
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 |
|
VerifyPortChannels ¶
Verifies there are no inactive ports in all port channels.
Expected Results
- Success: The test will pass if there are no inactive ports in all port channels.
- Failure: The test will fail if there is at least one inactive port in a port channel.
Examples
anta.tests.interfaces:
- VerifyPortChannels:
Source code in anta/tests/interfaces.py
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 |
|
VerifySVI ¶
Verifies the status of all SVIs.
Expected Results
- Success: The test will pass if all SVIs are up.
- Failure: The test will fail if one or many SVIs are not up.
Examples
anta.tests.interfaces:
- VerifySVI:
Source code in anta/tests/interfaces.py
437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 |
|
VerifyStormControlDrops ¶
Verifies there are no interface storm-control drop counters.
Expected Results
- Success: The test will pass if there are no storm-control drop counters.
- Failure: The test will fail if there is at least one storm-control drop counter.
Examples
anta.tests.interfaces:
- VerifyStormControlDrops:
Source code in anta/tests/interfaces.py
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 |
|