diff options
Diffstat (limited to 'examples/README.md')
| -rw-r--r-- | examples/README.md | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/examples/README.md b/examples/README.md new file mode 100644 index 0000000..5c24087 --- /dev/null +++ b/examples/README.md @@ -0,0 +1,12 @@ +## Device Inventory + +The file [inventory.yaml](inventory.yaml) is an example of [device inventory](https://www.anta.ninja/usage-inventory-catalog/#create-an-inventory-file). + +## Test Catalog + +The file [tests.yaml](tests.yaml) is an example of a [test catalog](https://www.anta.ninja/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 + +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://www.anta.ninja/cli/exec/#collect-a-set-of-commands) command. |