8000 doc(anta.cli): Update readme with anta cli. by titom73 · Pull Request #139 · aristanetworks/anta · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

doc(anta.cli): Update readme with anta cli. #139

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 13, 2023
Merged

doc(anta.cli): Update readme with anta cli. #139

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fed68d7
doc: Update readme with anta cli
titom73 Feb 13, 2023
82fcf4e
Update README.md
titom73 Feb 13, 2023
ffec849
Update README.md
titom73 Feb 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 26 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,36 @@ This repository is a Python package to automate tests on Arista devices.
- 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 set of [scripts](./scripts) to run __Arista Network Test Automation__ (ANTA) framework
This repository comes with a [cli](./anta/cli/) to run __Arista Network Test Automation__ (ANTA) framework using your preferred shell:

- `check-devices.py` is an easy to use script to test your network with ANTA.
- `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
```
$ anta
Usage: anta [OPTIONS] COMMAND [ARGS]...

Arista Network Test CLI

Options:
--username TEXT Username to connect to EOS [env var: ANTA_USERNAME]
--password TEXT Password to connect to EOS [env var: ANTA_PASSWORD]
--timeout INTEGER Connection timeout (default 5) [env var: ANTA_TIMEOUT]
--enable-password TEXT Enable password if required to connect [env var: ANTA_ENABLE_PASSWORD]
-i, --inventory PATH Path to your inventory file [env var: ANTA_INVENTORY]
--timeout INTEGER Connection timeout (default 5) [env var: ANTA_TIMEOUT]
--help Show this message and exit.

<img src="./docs/imgs/anta-getting-started.png"></img>
Commands:
exec Execute commands to inventory devices
get Get data from/to ANTA
nrfu Run NRFU against inventory devices
```

In addition you have also some useful scripts to help around testing:
<img src="./docs/imgs/anta-nrfu-table-output.png"></img>

In addition, previous scripts are now marked as __deprecated__ and will be removed in a future release:

- `check-devices.py` is an easy to use script to test your network with ANTA.
- `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
- `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)
Expand Down
0