ANTA catalog for BFD tests
Tests¶
VerifyBFDPeersHealth ¶
Verifies the health of IPv4 BFD peers across all VRFs.
This test performs the following checks for BFD peers across all VRFs:
- Validates that the state is
up
. - Confirms that the remote discriminator identifier (disc) is non-zero.
- Optionally verifies that the peer have not been down before a specified threshold of hours.
Expected Results
- Success: If all of the following conditions are met:
- All BFD peers across the VRFs are up and remote disc is non-zero.
- Last downtime of each peer is above the defined threshold, if specified.
- Failure: If any of the following occur:
- Any BFD peer session is not up or the remote discriminator identifier is zero.
- Last downtime of any peer is below the defined threshold, if specified.
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
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 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 |
|
VerifyBFDPeersIntervals ¶
Verifies the timers of IPv4 BFD peer sessions.
This test performs the following checks for each specified peer:
- Confirms that the specified VRF is configured.
- Verifies that the peer exists in the BFD configuration.
- Confirms that BFD peer is correctly configured with the
Transmit interval, Receive interval and Multiplier
.
Expected Results
- Success: If all of the following conditions are met:
- All specified peers are found in the BFD configuration within the specified VRF.
- All BFD peers are correctly configured with the
Transmit interval, Receive interval and Multiplier
.
- Failure: If any of the following occur:
- A specified peer is not found in the BFD configuration within the specified VRF.
- Any BFD peer not correctly configured with the
Transmit interval, Receive interval and Multiplier
.
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¶
Source code in anta/tests/bfd.py
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 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 |
|
VerifyBFDPeersRegProtocols ¶
Verifies the registered routing protocol of IPv4 BFD peer sessions.
This test performs the following checks for each specified peer:
- Confirms that the specified VRF is configured.
- Verifies that the peer exists in the BFD configuration.
- Confirms that BFD peer is correctly configured with the
routing protocol
.
Expected Results
- Success: If all of the following conditions are met:
- All specified peers are found in the BFD configuration within the specified VRF.
- All BFD peers are correctly configured with the
routing protocol
.
- Failure: If any of the following occur:
- A specified peer is not found in the BFD configuration within the specified VRF.
- Any BFD peer not correctly configured with the
routing protocol
.
Examples
anta.tests.bfd:
- VerifyBFDPeersRegProtocols:
bfd_peers:
- peer_address: 192.0.255.7
vrf: default
protocols:
- bgp
Inputs¶
Source code in anta/tests/bfd.py
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 |
|
VerifyBFDSpecificPeers ¶
Verifies the state of IPv4 BFD peer sessions.
This test performs the following checks for each specified peer:
- Confirms that the specified VRF is configured.
- Verifies that the peer exists in the BFD configuration.
- For each specified BFD peer:
- Validates that the state is
up
- Confirms that the remote discriminator identifier (disc) is non-zero.
- Validates that the state is
Expected Results
- Success: If all of the following conditions are met:
- All specified peers are found in the BFD configuration within the specified VRF.
- All BFD peers are
up
and remote disc is non-zero.
- Failure: If any of the following occur:
- A specified peer is not found in the BFD configuration within the specified VRF.
- Any BFD peer session is not
up
or the remote discriminator identifier is zero.
Examples
anta.tests.bfd:
- VerifyBFDSpecificPeers:
bfd_peers:
- peer_address: 192.0.255.8
vrf: default
- peer_address: 192.0.255.7
vrf: default
Inputs¶
Source code in anta/tests/bfd.py
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 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 |
|
Input models¶
BFDPeer ¶
BFD (Bidirectional Forwarding Detection) model representing the peer details.
Only IPv4 peers are supported for now.
Name | Type | Description | Default |
---|---|---|---|
peer_address |
IPv4Address
|
IPv4 address of a BFD peer.
|
- |
vrf |
str
|
Optional VRF for the BFD peer. Defaults to `default`.
|
'default'
|
tx_interval |
BfdInterval | None
|
Tx interval of BFD peer in milliseconds. Required field in the `VerifyBFDPeersIntervals` test.
|
None
|
rx_interval |
BfdInterval | None
|
Rx interval of BFD peer in milliseconds. Required field in the `VerifyBFDPeersIntervals` test.
|
None
|
multiplier |
BfdMultiplier | None
|
Multiplier of BFD peer. Required field in the `VerifyBFDPeersIntervals` test.
|
None
|
protocols |
list[BfdProtocol] | None
|
List of protocols to be verified. Required field in the `VerifyBFDPeersRegProtocols` test.
|
None
|
Source code in anta/input_models/bfd.py
15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
|