Adding upstream version 1.3.0.
Signed-off-by: Daniel Baumann <daniel@debian.org>
This commit is contained in:
parent
6fd6eb426a
commit
dc7df702ea
337 changed files with 16571 additions and 4891 deletions
11
docs/snippets/anta_debug_help.txt
Normal file
11
docs/snippets/anta_debug_help.txt
Normal file
|
@ -0,0 +1,11 @@
|
|||
$ anta debug --help
|
||||
Usage: anta debug [OPTIONS] COMMAND [ARGS]...
|
||||
|
||||
Commands to execute EOS commands on remote devices.
|
||||
|
||||
Options:
|
||||
--help Show this message and exit.
|
||||
|
||||
Commands:
|
||||
run-cmd Run arbitrary command to an ANTA device.
|
||||
run-template Run arbitrary templated command to an ANTA device.
|
35
docs/snippets/anta_get_tags_help.txt
Normal file
35
docs/snippets/anta_get_tags_help.txt
Normal file
|
@ -0,0 +1,35 @@
|
|||
$ anta get tags --help
|
||||
Usage: anta get tags [OPTIONS]
|
||||
|
||||
Get list of configured tags in user 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]
|
||||
-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.
|
|
@ -1,8 +1,10 @@
|
|||
$ anta --help
|
||||
Usage: anta [OPTIONS] COMMAND [ARGS]...
|
||||
|
||||
Arista Network Test Automation (ANTA) CLI.
|
||||
|
||||
Options:
|
||||
--help Show this message and exit.
|
||||
--version Show the version and exit.
|
||||
--log-file FILE Send the logs to a file. If logging level is
|
||||
DEBUG, only INFO or higher will be sent to
|
||||
|
@ -10,7 +12,6 @@ Options:
|
|||
-l, --log-level [CRITICAL|ERROR|WARNING|INFO|DEBUG]
|
||||
ANTA logging level [env var:
|
||||
ANTA_LOG_LEVEL; default: INFO]
|
||||
--help Show this message and exit.
|
||||
|
||||
Commands:
|
||||
check Commands to validate configuration files.
|
||||
|
|
9
docs/snippets/anta_nrfu_csv_help.txt
Normal file
9
docs/snippets/anta_nrfu_csv_help.txt
Normal file
|
@ -0,0 +1,9 @@
|
|||
$ anta nrfu csv --help
|
||||
Usage: anta nrfu csv [OPTIONS]
|
||||
|
||||
ANTA command to check network state with CSV report.
|
||||
|
||||
Options:
|
||||
--csv-output FILE Path to save report as a CSV file [env var:
|
||||
ANTA_NRFU_CSV_CSV_OUTPUT; required]
|
||||
--help Show this message and exit.
|
|
@ -1,3 +1,4 @@
|
|||
$ anta nrfu --help
|
||||
Usage: anta nrfu [OPTIONS] COMMAND [ARGS]...
|
||||
|
||||
Run ANTA tests on selected inventory devices.
|
||||
|
@ -27,6 +28,8 @@ Options:
|
|||
ANTA_DISABLE_CACHE]
|
||||
-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, --catalog FILE Path to the test catalog file [env var:
|
||||
|
|
11
docs/snippets/anta_nrfu_json_help.txt
Normal file
11
docs/snippets/anta_nrfu_json_help.txt
Normal file
|
@ -0,0 +1,11 @@
|
|||
$ anta nrfu json --help
|
||||
Usage: anta nrfu json [OPTIONS]
|
||||
|
||||
ANTA command to check network state with JSON results.
|
||||
|
||||
If no `--output` is specified, the output is printed to stdout.
|
||||
|
||||
Options:
|
||||
-o, --output FILE Path to save report as a JSON file [env var:
|
||||
ANTA_NRFU_JSON_OUTPUT]
|
||||
--help Show this message and exit.
|
9
docs/snippets/anta_nrfu_mdreport_help.txt
Normal file
9
docs/snippets/anta_nrfu_mdreport_help.txt
Normal file
|
@ -0,0 +1,9 @@
|
|||
$ anta nrfu md-report --help
|
||||
Usage: anta nrfu md-report [OPTIONS]
|
||||
|
||||
ANTA command to check network state with Markdown report.
|
||||
|
||||
Options:
|
||||
--md-output FILE Path to save the report as a Markdown file [env var:
|
||||
ANTA_NRFU_MD_REPORT_MD_OUTPUT; required]
|
||||
--help Show this message and exit.
|
8
docs/snippets/anta_nrfu_table_help.txt
Normal file
8
docs/snippets/anta_nrfu_table_help.txt
Normal file
|
@ -0,0 +1,8 @@
|
|||
$ anta nrfu table --help
|
||||
Usage: anta nrfu table [OPTIONS]
|
||||
|
||||
ANTA command to check network state with table results.
|
||||
|
||||
Options:
|
||||
--group-by [device|test] Group result by test or device.
|
||||
--help Show this message and exit.
|
7
docs/snippets/anta_nrfu_text_help.txt
Normal file
7
docs/snippets/anta_nrfu_text_help.txt
Normal file
|
@ -0,0 +1,7 @@
|
|||
$ anta nrfu text --help
|
||||
Usage: anta nrfu text [OPTIONS]
|
||||
|
||||
ANTA command to check network state with text results.
|
||||
|
||||
Options:
|
||||
--help Show this message and exit.
|
11
docs/snippets/anta_nrfu_tplreport_help.txt
Normal file
11
docs/snippets/anta_nrfu_tplreport_help.txt
Normal file
|
@ -0,0 +1,11 @@
|
|||
$ anta nrfu tpl-report --help
|
||||
Usage: anta nrfu tpl-report [OPTIONS]
|
||||
|
||||
ANTA command to check network state with templated report.
|
||||
|
||||
Options:
|
||||
-tpl, --template FILE Path to the template to use for the report [env var:
|
||||
ANTA_NRFU_TPL_REPORT_TEMPLATE; required]
|
||||
-o, --output FILE Path to save report as a file [env var:
|
||||
ANTA_NRFU_TPL_REPORT_OUTPUT]
|
||||
--help Show this message and exit.
|
Loading…
Add table
Add a link
Reference in a new issue