Skip to content

ANTA Tests

This section describes all the available tests provided by the ANTA package.

Available Tests

Here are the tests that we currently provide:

Tip

You can use anta get tests from the CLI to list all the tests available with an example. Refer to documentation for more options.

Using the Tests

All these tests can be imported in a catalog to be used by the ANTA CLI or in your own framework.

Atomic result support

Tests marked with the following badge in the documentation support Atomic Results: Atomic support badge

This means that when anta nrfu <command> is run with the --expand flag (currently supported for table and text), the report expands the test results to show one entry per input.

For instance, consider the following inventory and catalog:

inventory.yml
---
anta_inventory:
  hosts:
    - host: 10.42.42.42
      name: pf1
catalog.yml
---
anta.tests.connectivity:
  - VerifyReachability:
      hosts:
        - destination: 8.8.8.8
          vrf: MGMT
        - destination: 8.8.4.4
          vrf: default

Normal Run:

anta nrfu table

Expanded Run:

anta nrfu table

Warning

If the command collection fails for any reason, the results for that test will not be expanded. This includes command collection failures based on known EOS errors tracked by ANTA.

Info

If you would like a test to support atomic results, please open an issue on GitHub