60 lines
3.6 KiB
Text
60 lines
3.6 KiB
Text
Usage: anta nrfu [OPTIONS] COMMAND [ARGS]...
|
|
|
|
Run ANTA tests on selected inventory 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]
|
|
-i, --inventory FILE Path to the inventory YAML file. [env var:
|
|
ANTA_INVENTORY; required]
|
|
--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:
|
|
ANTA_CATALOG; required]
|
|
--catalog-format [yaml|json] Format of the catalog file, either 'yaml' or
|
|
'json' [env var: ANTA_CATALOG_FORMAT]
|
|
-d, --device TEXT Run tests on a specific device. Can be
|
|
provided multiple times.
|
|
-t, --test TEXT Run a specific test. Can be provided
|
|
multiple times.
|
|
--ignore-status Exit code will always be 0. [env var:
|
|
ANTA_NRFU_IGNORE_STATUS]
|
|
--ignore-error Exit code will be 0 if all tests succeeded
|
|
or 1 if any test failed. [env var:
|
|
ANTA_NRFU_IGNORE_ERROR]
|
|
--hide [success|failure|error|skipped]
|
|
Hide results by type: success / failure /
|
|
error / skipped'.
|
|
--dry-run Run anta nrfu command but stop before
|
|
starting to execute the tests. Considers all
|
|
devices as connected. [env var:
|
|
ANTA_NRFU_DRY_RUN]
|
|
--help Show this message and exit.
|
|
|
|
Commands:
|
|
csv ANTA command to check network state with CSV report.
|
|
json ANTA command to check network state with JSON results.
|
|
md-report ANTA command to check network state with Markdown report.
|
|
table ANTA command to check network state with table results.
|
|
text ANTA command to check network state with text results.
|
|
tpl-report ANTA command to check network state with templated report.
|