Overview
Overview of ANTA’s Command-Line Interface (CLI)¶
ANTA provides a powerful Command-Line Interface (CLI) to perform a wide range of operations. This document provides a comprehensive overview of ANTA CLI usage and its commands.
ANTA can also be used as a Python library, allowing you to build your own tools based on it. Visit this page for more details.
To start using the ANTA CLI, open your terminal and type anta.
Invoking ANTA CLI¶
$ anta --help
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 that must be
provided. It can be prompted using '--
prompt' option. [env var: ANTA_PASSWORD]
--enable-password TEXT Password to access EOS Privileged EXEC mode.
It can be prompted using '--prompt' option.
Requires '--enable' option. [env var:
ANTA_ENABLE_PASSWORD]
--enable Some commands may require EOS Privileged
EXEC mode. This option tries to access this
mode before sending a command to the device.
[env var: ANTA_ENABLE]
-P, --prompt Prompt for passwords if they are not
provided.
--timeout INTEGER Global connection timeout [env var:
ANTA_TIMEOUT; default: 30]
--insecure Disable SSH Host Key validation [env var:
ANTA_INSECURE]
-i, --inventory FILE Path to the inventory YAML file [env var:
ANTA_INVENTORY; required]
--log-file FILE Send the logs to a file. If logging level is
DEBUG, only INFO or higher will be sent to
stdout. [env var: ANTA_LOG_FILE]
--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]
--disable-cache Disable cache globally [env var:
ANTA_DISABLE_CACHE]
--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
ANTA Global Parameters¶
Certain parameters are globally required and can be either passed to the ANTA CLI or set as an environment variable (ENV VAR).
To pass the parameters via the CLI:
anta --username tom --password arista123 --inventory inventory.yml <anta cli>
To set them as ENV VAR:
export ANTA_USERNAME=tom
export ANTA_PASSWORD=arista123
export ANTA_INVENTORY=inventory.yml
Then, run the CLI:
anta <anta cli>
Info
Caching can be disabled with the global parameter --disable-cache. For more details about how caching is implemented in ANTA, please refer to Caching in ANTA.
ANTA Exit Codes¶
ANTA utilizes different exit codes to indicate the status of the test runs.
For all subcommands, ANTA will return the exit code 0, indicating a successful operation, except for the nrfu command.
For the nrfu command, ANTA uses the following exit codes:
Exit code 0- All tests passed successfully.Exit code 1- Tests were run, but at least one test returned a failure.Exit code 2- Tests were run, but at least one test returned an error.Exit code 3- An internal error occurred while executing tests.
To ignore the test status, use anta --ignore-status nrfu, and the exit code will always be 0.
To ignore errors, use anta --ignore-error nrfu, and the exit code will be 0 if all tests succeeded or 1 if any test failed.
Shell Completion¶
You can enable shell completion for the ANTA CLI:
If you use ZSH shell, add the following line in your ~/.zshrc:
eval "$(_ANTA_COMPLETE=zsh_source anta)" > /dev/null
With bash, add the following line in your ~/.bashrc:
eval "$(_ANTA_COMPLETE=bash_source anta)" > /dev/null