Adding upstream version 1.4.0.
Signed-off-by: Daniel Baumann <daniel@debian.org>
This commit is contained in:
parent
dc7df702ea
commit
7996c81031
166 changed files with 13787 additions and 11959 deletions
19
docs/snippets/anta_get_commands_help.txt
Normal file
19
docs/snippets/anta_get_commands_help.txt
Normal file
|
@ -0,0 +1,19 @@
|
|||
$ anta get commands --help
|
||||
Usage: anta get commands [OPTIONS]
|
||||
|
||||
Print all EOS commands used by the selected ANTA tests.
|
||||
|
||||
It can be filtered by module, test or using a catalog. If no filter is
|
||||
given, all built-in ANTA tests commands are retrieved.
|
||||
|
||||
Options:
|
||||
--module TEXT Filter commands by module name. [default:
|
||||
anta.tests]
|
||||
--test TEXT Filter by specific test name. If module is
|
||||
specified, searches only within that module.
|
||||
-c, --catalog FILE Path to the test catalog file [env var:
|
||||
ANTA_CATALOG]
|
||||
--catalog-format [yaml|json] Format of the catalog file, either 'yaml' or
|
||||
'json' [env var: ANTA_CATALOG_FORMAT]
|
||||
--unique Print only the unique commands.
|
||||
--help Show this message and exit.
|
17
docs/snippets/anta_get_fromansible_help.txt
Normal file
17
docs/snippets/anta_get_fromansible_help.txt
Normal file
|
@ -0,0 +1,17 @@
|
|||
$ anta get from-ansible --help
|
||||
Usage: anta get from-ansible [OPTIONS]
|
||||
|
||||
Build ANTA inventory from an ansible inventory YAML file.
|
||||
|
||||
NOTE: This command does not support inline vaulted variables. Make sure to
|
||||
comment them out.
|
||||
|
||||
Options:
|
||||
-o, --output FILE Path to save inventory file [env var:
|
||||
ANTA_INVENTORY; required]
|
||||
--overwrite Do not prompt when overriding current inventory
|
||||
[env var: ANTA_GET_FROM_ANSIBLE_OVERWRITE]
|
||||
-g, --ansible-group TEXT Ansible group to filter
|
||||
--ansible-inventory FILE Path to your ansible inventory file to read
|
||||
[required]
|
||||
--help Show this message and exit.
|
22
docs/snippets/anta_get_fromcvp_help.txt
Normal file
22
docs/snippets/anta_get_fromcvp_help.txt
Normal file
|
@ -0,0 +1,22 @@
|
|||
$ anta get from-cvp --help
|
||||
Usage: anta get from-cvp [OPTIONS]
|
||||
|
||||
Build ANTA inventory from CloudVision.
|
||||
|
||||
NOTE: Only username/password authentication is supported for on-premises
|
||||
CloudVision instances. Token authentication for both on-premises and
|
||||
CloudVision as a Service (CVaaS) is not supported.
|
||||
|
||||
Options:
|
||||
-o, --output FILE Path to save inventory file [env var: ANTA_INVENTORY;
|
||||
required]
|
||||
--overwrite Do not prompt when overriding current inventory [env
|
||||
var: ANTA_GET_FROM_CVP_OVERWRITE]
|
||||
-host, --host TEXT CloudVision instance FQDN or IP [required]
|
||||
-u, --username TEXT CloudVision username [required]
|
||||
-p, --password TEXT CloudVision password [required]
|
||||
-c, --container TEXT CloudVision container where devices are configured
|
||||
--ignore-cert Ignore verifying the SSL certificate when connecting
|
||||
to CloudVision [env var:
|
||||
ANTA_GET_FROM_CVP_IGNORE_CERT]
|
||||
--help Show this message and exit.
|
37
docs/snippets/anta_get_inventory_help.txt
Normal file
37
docs/snippets/anta_get_inventory_help.txt
Normal file
|
@ -0,0 +1,37 @@
|
|||
$ anta get inventory --help
|
||||
Usage: anta get inventory [OPTIONS]
|
||||
|
||||
Show inventory loaded in ANTA.
|
||||
|
||||
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]
|
||||
--connected / --not-connected Display inventory after connection has been
|
||||
created
|
||||
--help Show this message and exit.
|
13
docs/snippets/anta_get_tests_help.txt
Normal file
13
docs/snippets/anta_get_tests_help.txt
Normal file
|
@ -0,0 +1,13 @@
|
|||
$ anta get tests --help
|
||||
Usage: anta get tests [OPTIONS]
|
||||
|
||||
Show all builtin ANTA tests with an example output retrieved from each test
|
||||
documentation.
|
||||
|
||||
Options:
|
||||
--module TEXT Filter tests by module name. [default: anta.tests]
|
||||
--test TEXT Filter by specific test name. If module is specified,
|
||||
searches only within that module.
|
||||
--short Display test names without their inputs.
|
||||
--count Print only the number of tests found.
|
||||
--help Show this message and exit.
|
Loading…
Add table
Add a link
Reference in a new issue