Arista Network Test Automation (ANTA) Framework

This repository is a Python package to automate tests on Arista devices.

• The package name is ANTA, which stands for Arista Network Test Automation.
• This package (or some functions of this package) can be imported in Python scripts:
  • To automate NRFU (Network Ready For Use) test on a preproduction network
  • To automate tests on a live network (periodically or on demand)

ANTA provides a set of tests to validate the state of your network. All these tests are documented in the repository and can be used in your own python environment by importing this python package in your scripts.

This repository comes with a set of scripts to run Arista Network Test Automation (ANTA) framework

• check-devices.py is an easy to use script to test your network with ANTA.
• check-devices-reachability.py to test your devices are ready to be tested.
• collect-eos-commands.py to collect commands output from devices
• collect-sheduled-show-tech.py to collect the scheduled show tech-support files from devices

In addition you have also some useful scripts to help around testing:

• clear-counters.py to clear counters on devices
• evpn-blacklist-recovery.py to clear the list of MAC addresses which are blacklisted in EVPN
• create-devices-inventory-from-cvp.py: Build inventory for scripts from Arista Cloudvision (CVP)

Most of these scripts use eAPI (EOS API). You can find examples of EOS automation with eAPI in this repository.

Installation

The easiest way to intall ANTA package is to run Python (>=3.7) and its pip package to install:

pip install git+https://github.com/arista-netdevops-community/network-test-automation.git

For more details about how to install package, please see the requirements and intallation docs.

Getting Started

This section shows how to use ANTA scripts with basic configuration. For more information, please refer to this page. Also a demo page is available in the repository with full outputs.

Configure Arista EOS devices

First, you need to configure your management interface

interface Management1
   description oob_management
   vrf MGMT
   ip address 10.73.1.105/24

Then, configure access to eAPI:

management api http-commands
   protocol https port 443
   no shutdown
   vrf MGMT
      no shutdown
   !
!

Create your inventory

First, we need to list devices we want to test. You can create a file manually with this format:

anta_inventory:
  hosts:
  - host: 192.168.0.10
  - host: 192.168.0.11
  - host: 192.168.0.12
  - host: 192.168.0.13
  - host: 192.168.0.14
  - host: 192.168.0.15
  networks:
  - network: '192.168.110.0/24'
  ranges:
  - start: 10.0.0.9
    end: 10.0.0.11
  - start: 10.0.0.100
    end: 10.0.0.101

Or you can use create-devices-inventory-from-cvp.py script to generate from Cloudvision

create-devices-inventory-from-cvp.py -cvp 192.168.0.5 -u arista -o inventory -c Spine

Note: Because repository is transitioning to this YAML inventory, some scripts are still based on legacy text based approach

192.168.0.10
192.168.0.11
192.168.0.12
192.168.0.13
192.168.0.14
192.168.0.15

Test device reachability

Before running NRFU tests, we are going to test if we can connect to devices:

check-devices-reachability.py -i inventory.yml -u username

Test your network

Now we can run tests across the entire inventory

check-devices.py -i inventory.yml -t tests.yaml -o output.txt -u <username>

Note the -t tests.yml that list all your tests. An example is available under examples folder

You can find more information about usage in the following docs. Also a demo page is available in the repository with full outputs.

Contribution guide

Contributions are welcome. Please refer to the contribution guide

Credits

Thank you to Angélique Phillipps, Colin MacGiollaEáin, Khelil Sator, Matthieu Tache, Onur Gashi, Paul Lavelle and Thomas Grimonet for their contributions and guidances.