ANTA Tests for interfaces
Tests¶
Module related to the device interfaces tests.
VerifyIPProxyARP ¶
Verifies if Proxy ARP is enabled.
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
647 648 649 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 |
|
VerifyIllegalLACP ¶
Verifies there are no illegal LACP packets in 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:
ignored_interfaces:
- Port-Channel1
- Port-Channel2
interfaces:
- Port-Channel10
- Port-Channel12
Inputs¶
Name | Type | Description | Default |
---|---|---|---|
interfaces |
list[PortChannelInterface] | None
|
A list of port-channel interfaces to be tested. If not provided, all port-channel interfaces (excluding any in `ignored_interfaces`) are tested.
|
None
|
ignored_interfaces |
list[PortChannelInterface] | None
|
A list of port-channel interfaces to ignore.
|
None
|
Source code in anta/tests/interfaces.py
455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 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 |
|
VerifyInterfaceDiscards ¶
Verifies that the interfaces packet discard counters are equal to zero.
Expected Results
- Success: The test will pass if all or specified 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:
interfaces:
- Ethernet
- Port-Channel1
ignored_interfaces:
- Vxlan1
- Loopback0
Inputs¶
Name | Type | Description | Default |
---|---|---|---|
interfaces |
list[Interface] | None
|
A list of interfaces to be tested. If not provided, all interfaces (excluding any in `ignored_interfaces`) are tested.
|
None
|
ignored_interfaces |
list[InterfaceType | Interface] | None
|
A list of interfaces or interface types like Management which will ignore all Management interfaces.
|
None
|
Source code in anta/tests/interfaces.py
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 |
|
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
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 |
|
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:
Inputs¶
Name | Type | Description | Default |
---|---|---|---|
interfaces |
list[Interface] | None
|
A list of interfaces to be tested. If not provided, all interfaces (excluding any in `ignored_interfaces`) are tested.
|
None
|
ignored_interfaces |
list[InterfaceType | Interface] | None
|
A list of interfaces or interface types like Management which will ignore all Management interfaces.
|
None
|
Source code in anta/tests/interfaces.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 167 168 169 |
|
VerifyInterfaceIPv4 ¶
Verifies the interface 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.1/31
secondary_ips:
- 10.10.10.1/31
- 10.10.10.10/31
Inputs¶
Name | Type | Description | Default |
---|---|---|---|
interfaces |
list[InterfaceState]
|
List of interfaces with their details.
|
- |
Source code in anta/tests/interfaces.py
748 749 750 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 789 790 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 |
|
VerifyInterfaceUtilization ¶
Verifies that the utilization of interfaces is below a certain threshold.
Load interval (default to 5 minutes) is defined in device configuration.
Warning
This test has been implemented for full-duplex interfaces only.
Expected Results
- Success: The test will pass if all or specified interfaces are full duplex and have a usage below the threshold.
- Failure: The test will fail if any interface is non full-duplex or has a usage above the threshold.
Examples
anta.tests.interfaces:
- VerifyInterfaceUtilization:
threshold: 70.0
ignored_interfaces:
- Ethernet1
- Port-Channel1
interfaces:
- Ethernet10
- Loopback0
Inputs¶
Name | Type | Description | Default |
---|---|---|---|
threshold |
Percent
|
Interface utilization threshold above which the test will fail.
|
75.0
|
interfaces |
list[Interface] | None
|
A list of interfaces to be tested. If not provided, all interfaces (excluding any in `ignored_interfaces`) are tested.
|
None
|
ignored_interfaces |
list[InterfaceType | Interface] | None
|
A list of interfaces or interface types like Management which will ignore all Management interfaces.
|
None
|
Source code in anta/tests/interfaces.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 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 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 |
|
VerifyInterfacesBER ¶
Verifies interfaces pre-FEC bit error rate (BER) and FEC uncorrected codewords.
Expected Results
- Success: The test will pass if all tested interfaces have a pre-FEC BER below the specified maximum threshold and have zero uncorrected FEC codewords.
- Failure: The test will fail if any tested interface has a BER exceeding the maximum threshold or reports any uncorrected FEC codewords.
Examples
anta.tests.interfaces:
- VerifyInterfacesBER:
interfaces:
- Ethernet1/1
- Ethernet2/1
max_ber_threshold: 1e-6
Inputs¶
Name | Type | Description | Default |
---|---|---|---|
interfaces |
list[EthernetInterface] | None
|
A list of Ethernet interfaces to be tested.
If not provided, all Ethernet interfaces (excluding any in `ignored_interfaces`) with PHY details are tested.
|
None
|
ignored_interfaces |
list[EthernetInterface] | None
|
A list of Ethernet interfaces to ignore.
|
None
|
max_ber_threshold |
float
|
The maximum acceptable Pre-FEC BER.
|
1e-07
|
fail_on_uncorrected_codewords |
bool
|
If True, the test will fail if any uncorrected FEC codewords are detected.
|
True
|
Source code in anta/tests/interfaces.py
1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 |
|
VerifyInterfacesCounterDetails ¶
Verifies the interfaces counter details.
Note
This test specifically applies to physical interfaces (e.g., Ethernet and Management interfaces).
It offers a more granular check of interface counters, including link status changes, compared to
VerifyInterfaceDiscards
and VerifyInterfaceErrors
tests.
Expected Results
- Success: The test will pass if all tested interfaces have counters and link status changes at or below the defined thresholds.
- Failure: The test will fail if any tested interface has one or more counters or a link status changes count that exceeds its defined threshold.
Examples
anta.tests.interfaces:
- VerifyInterfacesCounterDetails:
interfaces: # Optionally target specific interfaces
- Ethernet1/1
- Ethernet2/1
ignored_interfaces: # OR ignore specific interfaces
- Management0
counter_threshold: 10
link_status_changes_threshold: 100
Inputs¶
Name | Type | Description | Default |
---|---|---|---|
interfaces |
list[EthernetInterface | ManagementInterface] | None
|
A list of Ethernet or Management interfaces to be tested.
If not provided, all Ethernet or Management interfaces (excluding any in `ignored_interfaces`) are tested.
|
None
|
ignored_interfaces |
list[EthernetInterface | ManagementInterface] | None
|
A list of Ethernet or Management interfaces to ignore.
|
None
|
counters_threshold |
PositiveInteger
|
The maximum acceptable value for each verified counter.
|
0
|
link_status_changes_threshold |
PositiveInteger
|
The maximum acceptable number of link status changes.
|
100
|
Source code in anta/tests/interfaces.py
1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 |
|
VerifyInterfacesEgressQueueDrops ¶
Verifies interface egress queue drop counters.
Expected Results
- Success: The test will pass if all egress queue drop counters are within the defined threshold.
- Failure: The test will fail if any egress queue drop counters exceeds the defined threshold.
Examples
anta.tests.interfaces:
- VerifyInterfacesEgressQueueDrops:
interfaces:
- Et1
- Et2
traffic_classes:
- TC0
- TC3
drop_precedences:
- DP0
Inputs¶
Name | Type | Description | Default |
---|---|---|---|
interfaces |
list[EthernetInterface] | None
|
A list of interfaces to be tested. If not provided, all interfaces are tested.
|
None
|
ignored_interfaces |
list[EthernetInterface] | None
|
A list of Ethernet interfaces to ignore.
|
None
|
traffic_classes |
list[str] | None
|
List of traffic classes to be verified - TC0, TC1, etc. If None, all available traffic classes will be checked.
|
None
|
queue_types |
list[Literal['unicast', 'multicast']]
|
List of queue types to be verified. If None, unicast and multicast queue types will be checked.
|
Field(default=['unicast', 'multicast'])
|
drop_precedences |
list[DropPrecedence]
|
List of drop precedences to be verified - DP0, DP1, etc. If None, only DP0 will be checked.
|
Field(default=['DP0'])
|
packet_drop_threshold |
PositiveInteger
|
Threshold for the number of dropped packets.
|
0
|
Source code in anta/tests/interfaces.py
1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 |
|
VerifyInterfacesOpticsReceivePower ¶
Verifies that the receive power levels of optical interface transceivers are within acceptable limits.
Info
This test only applies to interface transceivers that support Digital Optical Monitoring (DOM).
Unless otherwise stated, DOM capabilities are supported on all Arista AOCs and optical transceivers.
Expected Results
- Success: The test will pass if all tested interfaces have their installed transceiver receive power levels above their low-alarm threshold, considering the defined tolerance.
- Failure: The test will fail if any interface reports a receive power level from its transceiver that, after subtracting the tolerance, falls below its low-alarm threshold.
Examples
anta.tests.interfaces:
- VerifyInterfacesOpticsReceivePower:
interfaces: # Optionally target specific interfaces
- Ethernet1/1
- Ethernet2/1
ignored_interfaces: # OR ignore specific interfaces
- Ethernet3/1
failure_margin: 2
Inputs¶
Name | Type | Description | Default |
---|---|---|---|
interfaces |
list[EthernetInterface] | None
|
A list of Ethernet interfaces to be tested.
If not provided, all Ethernet interfaces (excluding any in `ignored_interfaces`) with DOM support are tested.
|
None
|
ignored_interfaces |
list[EthernetInterface] | None
|
A list of Ethernet interfaces to ignore.
|
None
|
failure_margin |
PositiveInteger
|
Proactive failure margin in dB. The test will fail if the receive power is weaker than the low-alarm threshold plus this margin.
|
Field(default=2)
|
Source code in anta/tests/interfaces.py
1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 |
|
VerifyInterfacesOpticsTemperature ¶
Verifies that the temperature of optical interface transceivers is within acceptable limits.
Info
This test only applies to interface transceivers that support Digital Optical Monitoring (DOM).
Unless otherwise stated, DOM capabilities are supported on all Arista AOCs and optical transceivers.
Expected Results
- Success: The test will pass if the temperature of all tested transceivers is within the defined threshold.
- Failure: The test will fail if any transceiver reports a temperature that exceeds the defined threshold.
Examples
anta.tests.interfaces:
- VerifyInterfacesOpticsTemperature:
interfaces: # Optionally target specific interfaces
- Ethernet1/1
- Ethernet2/1
ignored_interfaces: # OR ignore specific interfaces
- Ethernet3/1
max_transceiver_temperature: 68
Inputs¶
Name | Type | Description | Default |
---|---|---|---|
interfaces |
list[EthernetInterface] | None
|
A list of Ethernet interfaces to be tested.
If not provided, all Ethernet interfaces (excluding any in `ignored_interfaces`) with DOM support are tested.
|
None
|
ignored_interfaces |
list[EthernetInterface] | None
|
A list of Ethernet interfaces to ignore.
|
None
|
max_transceiver_temperature |
float
|
The temperature threshold in degrees Celsius (°C).
|
68.0
|
Source code in anta/tests/interfaces.py
1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 |
|
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[InterfaceState]
|
List of interfaces with their expected state.
|
- |
Source code in anta/tests/interfaces.py
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 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 |
|
VerifyInterfacesStatus ¶
Verifies the operational states of specified interfaces to ensure they match expected configurations.
This test performs the following checks for each specified interface:
- If
line_protocol_status
is defined, bothstatus
andline_protocol_status
are verified for the specified interface. - If
line_protocol_status
is not provided but thestatus
is “up”, it is assumed that both the status and line protocol should be “up”. - If the interface
status
is not “up”, only the interface’s status is validated, with no line protocol check performed.
Expected Results
- Success: If the interface status and line protocol status matches the expected operational state for all specified interfaces.
- Failure: If any of the following occur:
- The specified interface is not configured.
- The specified interface status and line protocol status does not match the expected operational state for any interface.
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.
|
- |
Source code in anta/tests/interfaces.py
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 |
|
VerifyInterfacesTridentCounters ¶
Verifies the Trident debug counters of all interfaces.
Compatible with Arista 7358X, 7300X, 7050X, 7010TX, 750XP, 720 and 710 series platforms featuring the Trident series chip.
Expected Results
- Success: The test will pass if all interfaces have drop and error counter values below the defined threshold.
- Failure: The test will fail if any interface has drop or error counter values above the defined threshold.
Examples
anta.tests.hardware:
- VerifyInterfacesTridentCounters:
ignored_counters:
- nonCongestionDiscard
- rxFpDrop
- rxVlanDrop
packet_drop_threshold: 0
Inputs¶
Name | Type | Description | Default |
---|---|---|---|
packet_drop_threshold |
PositiveInteger
|
Threshold for the number of dropped packets.
|
0
|
ignored_counters |
list[str] | None
|
A list of interface counters to ignore. If None, all available counters will be checked.
|
None
|
Source code in anta/tests/interfaces.py
1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 |
|
VerifyInterfacesVoqAndEgressQueueDrops ¶
Verifies interface ingress VOQ and egress queue drop counters.
Compatible with Arista 7280R, 7500R, 7800R and 7700R series platforms supporting Virtual Output Queues (VOQ).
Expected Results
- Success: The test will pass if all VOQ and egress queue drops are within the defined threshold.
- Failure: The test will fail if any VOQ or egress queue drop exceeds the defined threshold.
Examples
anta.tests.interfaces:
- VerifyInterfacesVoqAndEgressQueueDrops:
interfaces:
- Et1
- Et2
traffic_classes:
- TC0
- TC3
Inputs¶
Name | Type | Description | Default |
---|---|---|---|
interfaces |
list[Interface] | None
|
A list of interfaces to be tested. If not provided, all interfaces are tested.
|
None
|
traffic_classes |
list[str] | None
|
List of traffic classes to be verified - TC0, TC1, etc. If None, all available traffic classes will be checked.
|
None
|
packet_drop_threshold |
PositiveInteger
|
Threshold for the number of dropped packets.
|
0
|
Source code in anta/tests/interfaces.py
1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 |
|
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
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 |
|
VerifyL2MTU ¶
Verifies the L2 MTU of bridged interfaces.
Test that layer 2 (bridged) interfaces are configured with the correct MTU.
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: 9214
ignored_interfaces:
- Ethernet2/1
- Port-Channel # Ignore all Port-Channel interfaces
specific_mtu:
- Ethernet1/1: 1500
Inputs¶
Name | Type | Description | Default |
---|---|---|---|
mtu |
int
|
Expected L2 MTU configured on all non-excluded interfaces.
|
9214
|
ignored_interfaces |
list[InterfaceType | Interface]
|
A list of L2 interfaces or interface types like Ethernet, Port-Channel which will ignore all Ethernet and Port-Channel interfaces.
Takes precedence over the `specific_mtu` field.
|
Field(default=['Dps', 'Fabric', 'Loopback', 'Management', 'Recirc-Channel', 'Tunnel', 'Vlan', 'Vxlan'])
|
specific_mtu |
list[dict[Interface, int]]
|
A list of dictionary of L2 interfaces with their expected L2 MTU configured.
|
Field(default=[])
|
Source code in anta/tests/interfaces.py
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 |
|
VerifyL3MTU ¶
Verifies the L3 MTU of routed interfaces.
Test that layer 3 (routed) interfaces are configured with the correct MTU.
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:
- Management # Ignore all Management interfaces
- Ethernet2.100
- Ethernet1/1
specific_mtu:
- Ethernet10: 9200
Inputs¶
Name | Type | Description | Default |
---|---|---|---|
mtu |
int
|
Expected L3 MTU configured on all non-excluded interfaces.
|
1500
|
ignored_interfaces |
list[InterfaceType | Interface]
|
A list of L3 interfaces or interfaces types like Loopback, Tunnel which will ignore all Loopback and Tunnel interfaces.
Takes precedence over the `specific_mtu` field.
|
Field(default=['Dps', 'Fabric', 'Loopback', 'Management', 'Recirc-Channel', 'Tunnel', 'Vxlan'])
|
specific_mtu |
list[dict[Interface, int]]
|
A list of dictionary of L3 interfaces with their expected L3 MTU configured.
|
Field(default=[])
|
Source code in anta/tests/interfaces.py
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 |
|
VerifyLACPInterfacesStatus ¶
Verifies the Link Aggregation Control Protocol (LACP) status of the interface.
This test performs the following checks for each specified interface:
- Verifies that the interface is a member of the LACP port channel.
- Verifies LACP port states and operational status:
- Activity: Active LACP mode (initiates)
- Timeout: Short (Fast Mode), Long (Slow Mode - default)
- Aggregation: Port aggregable
- Synchronization: Port in sync with partner
- Collecting: Incoming frames aggregating
- Distributing: Outgoing frames aggregating
Expected Results
- Success: Interface is bundled and all LACP states match expected values for both actor and partner
- Failure: If any of the following occur:
- Interface or port channel is not configured.
- Interface is not bundled in port channel.
- Actor or partner port LACP states don’t match expected configuration.
- LACP rate (timeout) mismatch when fast mode is configured.
Examples
anta.tests.interfaces:
- VerifyLACPInterfacesStatus:
interfaces:
- name: Ethernet1
portchannel: Port-Channel100
Inputs¶
Name | Type | Description | Default |
---|---|---|---|
interfaces |
list[InterfaceState]
|
List of interfaces with their expected state.
|
- |
Source code in anta/tests/interfaces.py
942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 |
|
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
511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 |
|
VerifyPortChannels ¶
Verifies there are no inactive ports in port channels.
Expected Results
- Success: The test will pass if there are no inactive ports in all or specified port channels.
- Failure: The test will fail if there is at least one inactive port in a port channel.
Examples
anta.tests.interfaces:
- VerifyPortChannels:
ignored_interfaces:
- Port-Channel1
- Port-Channel2
interfaces:
- Port-Channel11
- Port-Channel22
Inputs¶
Name | Type | Description | Default |
---|---|---|---|
interfaces |
list[PortChannelInterface] | None
|
A list of port-channel interfaces to be tested. If not provided, all port-channel interfaces (excluding any in `ignored_interfaces`) are tested.
|
None
|
ignored_interfaces |
list[PortChannelInterface] | None
|
A list of port-channel interfaces to ignore.
|
None
|
Source code in anta/tests/interfaces.py
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 450 451 452 |
|
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
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 583 584 585 |
|
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:
interfaces:
- Ethernet1
- Ethernet2
ignored_interfaces:
- Vxlan1
- Loopback0
Inputs¶
Name | Type | Description | Default |
---|---|---|---|
interfaces |
list[Interface] | None
|
A list of interfaces to be tested. If not provided, all interfaces (excluding any in `ignored_interfaces`) are tested.
|
None
|
ignored_interfaces |
list[InterfaceType | Interface] | None
|
A list of interfaces or interface types like Management which will ignore all Management interfaces.
|
None
|
Source code in anta/tests/interfaces.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 |
|
Input models¶
Module containing input models for interface tests.
InterfaceDetail ¶
Alias for the InterfaceState model to maintain backward compatibility.
When initialized, it will emit a deprecation warning and call the InterfaceState model.
TODO: Remove this class in ANTA v2.0.0.
Source code in anta/input_models/interfaces.py
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 |
|
InterfaceState ¶
Model for an interface state.
TODO: Need to review this class name in ANTA v2.0.0.
Name | Type | Description | Default |
---|---|---|---|
name |
Interface
|
Interface to validate.
|
- |
status |
Literal['up', 'down', 'adminDown'] | None
|
Expected status of the interface. Required field in the `VerifyInterfacesStatus` test.
|
None
|
line_protocol_status |
Literal['up', 'down', 'testing', 'unknown', 'dormant', 'notPresent', 'lowerLayerDown'] | None
|
Expected line protocol status of the interface. Optional field in the `VerifyInterfacesStatus` test.
|
None
|
portchannel |
PortChannelInterface | None
|
Port-Channel in which the interface is bundled. Required field in the `VerifyLACPInterfacesStatus` test.
|
None
|
lacp_rate_fast |
bool
|
Specifies the LACP timeout mode for the link aggregation group.
Options:
- True: Also referred to as fast mode.
- False: The default mode, also known as slow mode.
Can be enabled in the `VerifyLACPInterfacesStatus` tests.
|
False
|
lacp_churn_state |
bool
|
Flag to validate LACP churn state. Can be enabled in the `VerifyLACPInterfacesStatus` test.
|
False
|
primary_ip |
IPv4Interface | None
|
Primary IPv4 address in CIDR notation. Required field in the `VerifyInterfaceIPv4` test.
|
None
|
secondary_ips |
list[IPv4Interface] | None
|
List of secondary IPv4 addresses in CIDR notation. Can be provided in the `VerifyInterfaceIPv4` test.
|
None
|
auto |
bool
|
The auto-negotiation status of the interface. Can be provided in the `VerifyInterfacesSpeed` test.
|
False
|
speed |
float | None
|
The speed of the interface in Gigabits per second. Valid range is 1 to 1000. Required field in the `VerifyInterfacesSpeed` test.
|
Field(None, ge=1, le=1000)
|
lanes |
int | None
|
The number of lanes in the interface. Valid range is 1 to 8. Can be provided in the `VerifyInterfacesSpeed` test.
|
Field(None, ge=1, le=8)
|
Source code in anta/input_models/interfaces.py
17 18 19 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 |
|