Home

ANTA Documentation

This website provides generic documentation related to the Arista Network Test Automation framework (ANTA)

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 provides a set of tests to validate the state of your network.
• 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)

This repository comes with a cli to run Arista Network Test Automation (ANTA) framework using your preferred shell:

# Install ANTA
pip install anta

# Run ANTA cli
$ anta
Usage: anta [OPTIONS] COMMAND [ARGS]...

  Arista Network Test Automation (ANTA) CLI

Options:
  --version                       Show the version and exit.
  --username TEXT                 Username to connect to EOS  [env var:
                                  ANTA_USERNAME; required]
  --password TEXT                 Password to connect to EOS  [env var:
                                  ANTA_PASSWORD; required]
  --timeout INTEGER               Global connection timeout  [env var:
                                  ANTA_TIMEOUT; default: 5]
  --insecure                      Disable SSH Host Key validation  [env var:
                                  ANTA_INSECURE]
  --enable-password TEXT          Enable password if required to connect  [env
                                  var: ANTA_ENABLE_PASSWORD]
  -i, --inventory FILE            Path to the inventory YAML file  [env var:
                                  ANTA_INVENTORY; required]
  --log-level, --log [CRITICAL|ERROR|WARNING|INFO|DEBUG]
                                  ANTA logging level  [env var:
                                  ANTA_LOG_LEVEL; default: INFO]
  --ignore-status                 Always exit with success  [env var:
                                  ANTA_IGNORE_STATUS]
  --ignore-error                  Only report failures and not errors  [env
                                  var: ANTA_IGNORE_ERROR]
  --help                          Show this message and exit.

Commands:
  debug  Debug commands for building ANTA
  exec   Execute commands to inventory devices
  get    Get data from/to ANTA
  nrfu   Run NRFU against inventory devices

---

Last update: July 19, 2023