-
Notifications
You must be signed in to change notification settings - Fork 30
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix: Add missing testcases in example folder (#749)
* fix: Add missing testcases for ISIS in example folder * fix: Add missing testcases for anta.tests.configuration.VerifyRunningConfigLines in example folder * doc: Update example README with missing files * Apply suggestions from code review --------- Co-authored-by: Guillaume Mulocher <gmulocher@arista.com>
- Loading branch information
Showing
2 changed files
with
55 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,34 @@ | ||
# ANTA Example files | ||
|
||
This section provides some examples about how to use ANTA as listed in [the documentation](https://anta.arista.com) | ||
|
||
## Device Inventory | ||
|
||
- Filename: [`inventory.yaml`](./inventory.yaml) | ||
|
||
The file [inventory.yaml](inventory.yaml) is an example of [device inventory](https://anta.arista.com/stable/usage-inventory-catalog/#create-an-inventory-file). | ||
|
||
## Test Catalog | ||
|
||
- Filename: [`tests.yaml`](./tests.yaml) | ||
|
||
The file [tests.yaml](tests.yaml) is an example of a [test catalog](https://anta.arista.com/stable/usage-inventory-catalog/#test-catalog). | ||
This file should contain all the tests implemented in [anta.tests](../anta/tests) with arbitrary parameters. | ||
|
||
## eos-commands.yaml file | ||
## Commands to get from snapshot | ||
|
||
- Filename: [`eos-commands.yaml file`](./eos-commands.yaml) | ||
|
||
The file [eos-commands.yaml](eos-commands.yaml) is an example of input given with the `--commands-list` option to the [anta exec snapshot](https://anta.arista.com/stable/cli/exec/#collect-a-set-of-commands) command. | ||
|
||
## ANTA runner in Python | ||
|
||
- Filename: [`anta_runner.py`](./anta_runner.py) | ||
|
||
The file is an example demonstrating how to run ANTA using a python script | ||
|
||
## ANTA template for results rendering | ||
|
||
- Filename: [`template.j2`](./template.j2) | ||
|
||
This file is a simple Jinja2 file to customize ANTA CLI output as documented in [anta documentation](https://anta.arista.com/stable/cli/nrfu/#performing-nrfu-with-custom-reports) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters