NRFU
Execute Network Readiness For Use (NRFU) Testing¶
ANTA provides a set of commands for performing NRFU tests on devices. These commands are under the anta nrfu namespace and offer multiple output format options:
NRFU Command overview¶
anta nrfu --help
Usage: anta nrfu [OPTIONS] COMMAND [ARGS]...
Run NRFU against inventory devices
Options:
-c, --catalog FILE Path to the tests catalog YAML file [env var:
ANTA_NRFU_CATALOG; required]
--help Show this message and exit.
Commands:
json ANTA command to check network state with JSON result
table ANTA command to check network states with table result
text ANTA command to check network states with text result
tpl-report ANTA command to check network state with templated report
All commands under the anta nrfu namespace require a catalog yaml file specified with the --catalog option.
Performing NRFU with text rendering¶
The text subcommand provides a straightforward text report for each test executed on all devices in your inventory.
Command overview¶
anta nrfu text --help
Usage: anta nrfu text [OPTIONS]
ANTA command to check network states with text result
Options:
-t, --tags TEXT List of tags using comma as separator:
tag1,tag2,tag3
-s, --search TEXT Regular expression to search in both name
and test
--skip-error / --no-skip-error Hide tests in errors due to connectivity
issue [default: no-skip-error]
--help Show this message and exit.
The --tags option allows to target specific devices in your inventory, while the --search option permits filtering based on a regular expression pattern in both the hostname and the test name.
The --skip-error option can be used to exclude tests that failed due to connectivity issues or unsupported commands.
Example¶
anta nrfu text --tags LEAF --search DC1-LEAF1A
Performing NRFU with table rendering¶
The table command under the anta nrfu namespace offers a clear and organized table view of the test results, suitable for filtering. It also has its own set of options for better control over the output.
Command overview¶
anta nrfu table --help
Usage: anta nrfu table [OPTIONS]
ANTA command to check network states with table result
Options:
-t, --tags TEXT List of tags using comma as separator: tag1,tag2,tag3
-d, --device TEXT Show a summary for this device
-t, --test TEXT Show a summary for this test
--help Show this message and exit.
The --tags option can be used to target specific devices in your inventory.
The --device and --test options show a summarized view of the test results for a specific host or test case, respectively.
Example¶
anta nrfu table --tags LEAF
For larger setups, you can also group the results by host or test to get a summarized view:
anta nrfu table --tags LEAF --device DC1-LEAF1A
Performing NRFU with JSON rendering¶
The JSON rendering command in NRFU testing is useful in generating a JSON output that can subsequently be passed on to another tool for reporting purposes.
Command overview¶
anta nrfu json --help
Usage: anta nrfu json [OPTIONS]
ANTA command to check network state with JSON result
Options:
-t, --tags TEXT List of tags using comma as separator: tag1,tag2,tag3
-o, --output FILE Path to save report as a file [env var:
ANTA_NRFU_JSON_OUTPUT]
--help Show this message and exit.
The --tags option can be used to target specific devices in your inventory.
The --output option allows you to save the JSON report as a file.
Example¶
anta nrfu json --tags LEAF
Performing NRFU with custom reports¶
ANTA offers a CLI option for creating custom reports. This leverages the Jinja2 template system, allowing you to tailor reports to your specific needs.
Command overview¶
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]
-t, --tags TEXT List of tags using comma as separator: tag1,tag2,tag3
--help Show this message and exit.
--template option is used to specify the Jinja2 template file for generating the custom report.
The --output option allows you to choose the path where the final report will be saved.
The --tags option can be used to target specific devices in your inventory.
Example¶
anta nrfu tpl-report --tags LEAF --template ./custom_template.j2
The template ./custom_template.j2 is a simple Jinja2 template:
{% for d in data %}
* {{ d.test }} is [green]{{ d.result | upper}}[/green] for {{ d.name }}
{% endfor %}
The Jinja2 template has access to all TestResult elements and their values, as described in this documentation.
You can also save the report result to a file using the --output option:
anta nrfu tpl-report --tags LEAF --template ./custom_template.j2 --output nrfu-tpl-report.txt
The resulting output might look like this:
cat nrfu-tpl-report.txt
* VerifyMlagStatus is [green]SUCCESS[/green] for DC1-LEAF1A
* VerifyMlagInterfaces is [green]SUCCESS[/green] for DC1-LEAF1A
* VerifyMlagConfigSanity is [green]SUCCESS[/green] for DC1-LEAF1A
* VerifyMlagReloadDelay is [green]SUCCESS[/green] for DC1-LEAF1A