Execute commands
ANTA CLI provides a set of entrypoints to facilitate remote command execution on EOS devices.
EXEC command overview¶
$ anta exec --help
Usage: anta exec [OPTIONS] COMMAND [ARGS]...
Commands to execute various scripts on EOS devices.
Options:
--help Show this message and exit.
Commands:
clear-counters Clear counter statistics on EOS devices.
collect-tech-support Collect scheduled tech-support from EOS devices.
snapshot Collect commands output from devices in inventory.
Clear interfaces counters¶
This command clears interface counters on EOS devices specified in your inventory.
Command overview¶
$ anta exec clear-counters --help
Usage: anta exec clear-counters [OPTIONS]
Clear counter statistics on EOS devices.
Options:
-u, --username TEXT Username to connect to EOS [env var:
ANTA_USERNAME; required]
-p, --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. [env var: ANTA_PROMPT]
--timeout FLOAT Global API timeout. This value will be used
for all devices. [env var: ANTA_TIMEOUT;
default: 30.0]
--insecure Disable SSH Host Key validation. [env var:
ANTA_INSECURE]
--disable-cache Disable cache globally. [env var:
ANTA_DISABLE_CACHE]
--use-session-auth / --no-session-auth
Enable or explicitly disable eAPI session
authentication globally. When unset, per-
device inventory values apply. [env var:
ANTA_USE_SESSION_AUTH]
-i, --inventory FILE Path to the inventory YAML file. [env var:
ANTA_INVENTORY; required]
--inventory-format [yaml|json] Format of the inventory file, either 'yaml'
or 'json' [env var: ANTA_INVENTORY_FORMAT]
--tags TEXT List of tags using comma as separator:
tag1,tag2,tag3. [env var: ANTA_TAGS]
--help Show this message and exit.
Tip
username, password, enable-password, enable, timeout and insecure values are the same for all devices
Example¶
anta exec clear-counters --tags spine
Warning
This command changes operational state by clearing interface counters on the selected devices. Run it only when that is intended.
Collect a set of commands¶
This command collects all the commands specified in a commands-list file, which can be in either json or text format.
Command overview¶
$ anta exec snapshot --help
Usage: anta exec snapshot [OPTIONS]
Collect commands output from devices in inventory.
Options:
-u, --username TEXT Username to connect to EOS [env var:
ANTA_USERNAME; required]
-p, --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. [env var: ANTA_PROMPT]
--timeout FLOAT Global API timeout. This value will be used
for all devices. [env var: ANTA_TIMEOUT;
default: 30.0]
--insecure Disable SSH Host Key validation. [env var:
ANTA_INSECURE]
--disable-cache Disable cache globally. [env var:
ANTA_DISABLE_CACHE]
--use-session-auth / --no-session-auth
Enable or explicitly disable eAPI session
authentication globally. When unset, per-
device inventory values apply. [env var:
ANTA_USE_SESSION_AUTH]
-i, --inventory FILE Path to the inventory YAML file. [env var:
ANTA_INVENTORY; required]
--inventory-format [yaml|json] Format of the inventory file, either 'yaml'
or 'json' [env var: ANTA_INVENTORY_FORMAT]
--tags TEXT List of tags using comma as separator:
tag1,tag2,tag3. [env var: ANTA_TAGS]
-c, --commands-list FILE File with list of commands to collect [env
var: ANTA_EXEC_SNAPSHOT_COMMANDS_LIST;
required]
-o, --output DIRECTORY Directory to save commands output. [env
var: ANTA_EXEC_SNAPSHOT_OUTPUT; default:
anta_snapshot_<date>_<time>]
--help Show this message and exit.
username,password,enable-password,enable,timeoutandinsecurevalues are the same for all devices
The commands-list file should follow this structure:
---
json_format:
- show version
text_format:
- show bfd peers
Example¶
anta exec snapshot --tags spine --commands-list ./commands.yaml --output ./anta_snapshot
The results of the executed commands will be stored in the output directory specified during command execution:
tree anta_snapshot
anta_snapshot
├── dc1-spine1
│ ├── json
│ │ └── show version.json
│ └── text
│ └── show bfd peers.log
└── dc1-spine2
├── json
│ └── show version.json
└── text
└── show bfd peers.log
6 directories, 4 files
Get Scheduled tech-support¶
EOS offers a feature that automatically creates a tech-support archive every hour by default. These archives are stored under /mnt/flash/schedule/tech-support.
leaf1#show schedule summary
Maximum concurrent jobs 1
Prepend host name to logfile: Yes
Name At Time Last Interval Timeout Max Max Logfile Location Status
Time (mins) (mins) Log Logs
Files Size
----------------- ------------- ----------- -------------- ------------- ----------- ---------- --------------------------------- ------
tech-support now 08:37 60 30 100 - flash:schedule/tech-support/ Success
leaf1#bash ls /mnt/flash/schedule/tech-support
leaf1_tech-support_2023-03-09.1337.log.gz leaf1_tech-support_2023-03-10.0837.log.gz leaf1_tech-support_2023-03-11.0337.log.gz
For Network Readiness for Use (NRFU) tests and to keep a comprehensive report of the system state before going live, ANTA provides a command-line interface that efficiently retrieves these files.
Command overview¶
$ anta exec collect-tech-support --help
Usage: anta exec collect-tech-support [OPTIONS]
Collect scheduled tech-support from EOS devices.
Options:
-u, --username TEXT Username to connect to EOS [env var:
ANTA_USERNAME; required]
-p, --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. [env var: ANTA_PROMPT]
--timeout FLOAT Global API timeout. This value will be used
for all devices. [env var: ANTA_TIMEOUT;
default: 30.0]
--insecure Disable SSH Host Key validation. [env var:
ANTA_INSECURE]
--disable-cache Disable cache globally. [env var:
ANTA_DISABLE_CACHE]
--use-session-auth / --no-session-auth
Enable or explicitly disable eAPI session
authentication globally. When unset, per-
device inventory values apply. [env var:
ANTA_USE_SESSION_AUTH]
-i, --inventory FILE Path to the inventory YAML file. [env var:
ANTA_INVENTORY; required]
--inventory-format [yaml|json] Format of the inventory file, either 'yaml'
or 'json' [env var: ANTA_INVENTORY_FORMAT]
--tags TEXT List of tags using comma as separator:
tag1,tag2,tag3. [env var: ANTA_TAGS]
-o, --output PATH Path for test catalog [default: ./tech-
support]
--latest INTEGER Number of scheduled show-tech to retrieve
--configure [DEPRECATED] Ensure devices have 'aaa
authorization exec default local' configured
(required for SCP on EOS). THIS WILL CHANGE
THE CONFIGURATION OF YOUR NETWORK.
--help Show this message and exit.
Tip
username, password, enable-password, enable, timeout and insecure values are the same for all devices
When executed, this command fetches tech-support files and downloads them locally into a device-specific subfolder within the designated folder. You can specify the output folder with the --output option.
ANTA uses SCP to download files from devices and will not trust unknown SSH hosts by default. Add the SSH public keys of your devices to your known_hosts file or use the anta --insecure option to ignore SSH host keys validation.
The configuration aaa authorization exec default must be present on devices to be able to use SCP.
Warning
Deprecation
ANTA can automatically configure aaa authorization exec default local using the anta exec collect-tech-support --configure option but this option is deprecated and will be removed in ANTA 2.0.0.
If you require specific AAA configuration for aaa authorization exec default, like aaa authorization exec default none or aaa authorization exec default group tacacs+, you will need to configure it manually.
The --latest option allows retrieval of a specific number of the most recent tech-support files.
Warning
By default all the tech-support files present on the devices are retrieved.
Example¶
anta exec collect-tech-support --insecure --tags spine --latest 1 --configure
The --configure option makes this example self-contained by adding the required AAA authorization configuration when it is missing. As noted above, this option is deprecated and changes the device configuration.
After a successful collection, the output folder structure is as follows:
tree tech-support/
tech-support/
├── dc1-spine1
│ └── dc1-spine1_tech-support_<date>.<time>.log.gz
└── dc1-spine2
└── dc1-spine2_tech-support_<date>.<time>.log.gz
2 directories, 2 files
Each device has its own subdirectory containing the collected tech-support files.