Inventory & Tests catalog
Inventory & Catalog definition¶
This page describes how to create an inventory and a tests catalog.
Create an inventory file¶
anta cli needs an inventory file to list all devices to tests. This inventory is a YAML file with the folowing keys:
anta_inventory:
hosts:
- host: < ip address value >
port: < TCP port for eAPI. Default is 443 (Optional)>
name: < name to display in report. Default is host:port (Optional) >
tags: < list of tags to use to filter inventory during tests. Default is ['all']. (Optional) >
networks:
- network: < network using CIDR notation >
tags: < list of tags to use to filter inventory during tests. Default is ['all']. (Optional) >
ranges:
- start: < first ip address value of the range >
end: < last ip address value of the range >
tags: < list of tags to use to filter inventory during tests. Default is ['all']. (Optional) >
Your inventory file can be based on any of these 3 keys and shall start with anta_inventory key. A full description of inventory model is available in API documentation
The next output is an inventory example:
---
anta_inventory:
hosts:
- host: 192.168.0.10
name: spine01
tags: ['fabric', 'spine']
- host: 192.168.0.11
name: spine02
tags: ['fabric', 'spine']
networks:
- network: '192.168.110.0/24'
tags: ['fabric', 'leaf']
ranges:
- start: 10.0.0.9
end: 10.0.0.11
tags: ['fabric', 'l2leaf']
Test Catalog¶
In addition to your inventory file, you also have to define a catalog of tests to execute against all your devices. This catalogue list all your tests and their parameters.
Its format is a YAML file and keys are tests functions inherited from the python path. Let’s take an example below:
Default tests catalog¶
All tests are located under anta.tests module and are categorised per family (one submodule). So to run test for software version, you can do:
anta.tests.software:
- verify_eos_version:
It will load the test verify_eos_version located in anta.tests.software. But since this function has parameters, we will create a catalog with the following structure:
anta.tests.software:
- verify_eos_version:
# List of allowed EOS versions.
versions:
- 4.25.4M
- 4.26.1F
To get a list of all available tests and their respective parameters, you can read the tests section of this website.
The following example gives a very minimal tests catalog you can use in almost any situation
---
# Load anta.tests.software
anta.tests.software:
# Verifies the device is running one of the allowed EOS version.
- verify_eos_version:
# List of allowed EOS versions.
versions:
- 4.25.4M
- 4.26.1F
# Load anta.tests.system
anta.tests.system:
# Verifies the device uptime is higher than a value.
- verify_uptime:
minimum: 1
# Load anta.tests.configuration
anta.tests.configuration:
# Verifies ZeroTouch is disabled.
- verify_zerotouch:
- verify_running_config_diffs:
Custom tests catalog¶
In case you want to leverage your own tests collection, you can use the following syntax:
<your package name>:
- <your test in your package name>:
So for instance, it could be:
titom73.tests.system:
- verify_platform:
type: ['cEOS-LAB']
How to create custom tests
To create your custom tests, you should refer to this following documentation