From 22d77875935c92490e7ff3082f914b1eba634ac4 Mon Sep 17 00:00:00 2001 From: gmuloc Date: Mon, 21 Oct 2024 22:53:24 +0200 Subject: [PATCH 1/8] Doc: Fix wrong example commands --- docs/getting-started.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/getting-started.md b/docs/getting-started.md index aac88c640..338b28772 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -145,7 +145,8 @@ anta nrfu \ --enable-password t \ --inventory .personal/inventory_atd.yml \ --catalog .personal/tests-bases.yml \ - table --tags leaf + --tags leaf \ + table ╭────────────────────── Settings ──────────────────────╮ @@ -186,7 +187,8 @@ $ anta nrfu \ --enable-password t \ --inventory .personal/inventory_atd.yml \ --catalog .personal/tests-bases.yml \ - text --tags leaf + --tags leaf \ + text ╭────────────────────── Settings ──────────────────────╮ │ Running ANTA tests: │ @@ -216,7 +218,8 @@ $ anta nrfu \ --enable-password t \ --inventory .personal/inventory_atd.yml \ --catalog .personal/tests-bases.yml \ - json --tags leaf + --tags leaf \ + json ╭────────────────────── Settings ──────────────────────╮ │ Running ANTA tests: │ From d959ef425094665af80e7402983a71b6605f5efd Mon Sep 17 00:00:00 2001 From: gmuloc Date: Wed, 23 Oct 2024 17:25:35 +0200 Subject: [PATCH 2/8] Doc: Remove tags --- docs/getting-started.md | 3 --- docs/scripts/generate_svg.py | 2 +- 2 files changed, 1 insertion(+), 4 deletions(-) diff --git a/docs/getting-started.md b/docs/getting-started.md index 338b28772..8fd7e625c 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -145,7 +145,6 @@ anta nrfu \ --enable-password t \ --inventory .personal/inventory_atd.yml \ --catalog .personal/tests-bases.yml \ - --tags leaf \ table @@ -187,7 +186,6 @@ $ anta nrfu \ --enable-password t \ --inventory .personal/inventory_atd.yml \ --catalog .personal/tests-bases.yml \ - --tags leaf \ text ╭────────────────────── Settings ──────────────────────╮ @@ -218,7 +216,6 @@ $ anta nrfu \ --enable-password t \ --inventory .personal/inventory_atd.yml \ --catalog .personal/tests-bases.yml \ - --tags leaf \ json ╭────────────────────── Settings ──────────────────────╮ diff --git a/docs/scripts/generate_svg.py b/docs/scripts/generate_svg.py index f017b243d..2eca6ac4a 100644 --- a/docs/scripts/generate_svg.py +++ b/docs/scripts/generate_svg.py @@ -94,7 +94,7 @@ def custom_progress_bar() -> Progress: # Redirect stdout of the program towards another StringIO to capture help # that is not part or anta rich console # redirect potential progress bar output to console by patching - with patch("anta.cli.nrfu.anta_progress_bar", custom_progress_bar), suppress(SystemExit): + with patch("anta.cli.nrfu.utils.anta_progress_bar", custom_progress_bar), suppress(SystemExit): function() if "--help" in args: From 9b963579b78687b669ae92371dc37e12b5da2629 Mon Sep 17 00:00:00 2001 From: arista Date: Thu, 24 Oct 2024 10:34:45 +0000 Subject: [PATCH 3/8] doc: Update examples --- docs/getting-started.md | 158 +----------------- docs/imgs/getting_started_anta_nrfu_json.svg | 70 ++++++++ .../getting-started/anta_nrfu_json.output | 56 +++++++ .../getting-started/anta_nrfu_json.sh | 9 + .../getting-started/anta_nrfu_table.output | 45 +++++ .../getting-started/anta_nrfu_table.sh | 10 ++ .../getting-started/anta_nrfu_text.output | 35 ++++ .../getting-started/anta_nrfu_text.sh | 9 + docs/snippets/getting-started/catalog.yml | 24 +++ docs/snippets/getting-started/inventory.yml | 20 +++ 10 files changed, 286 insertions(+), 150 deletions(-) create mode 100644 docs/imgs/getting_started_anta_nrfu_json.svg create mode 100644 docs/snippets/getting-started/anta_nrfu_json.output create mode 100644 docs/snippets/getting-started/anta_nrfu_json.sh create mode 100644 docs/snippets/getting-started/anta_nrfu_table.output create mode 100644 docs/snippets/getting-started/anta_nrfu_table.sh create mode 100644 docs/snippets/getting-started/anta_nrfu_text.output create mode 100644 docs/snippets/getting-started/anta_nrfu_text.sh create mode 100644 docs/snippets/getting-started/catalog.yml create mode 100644 docs/snippets/getting-started/inventory.yml diff --git a/docs/getting-started.md b/docs/getting-started.md index 8fd7e625c..2d8cab34b 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -48,26 +48,7 @@ management api http-commands ANTA uses an inventory to list the target devices for the tests. You can create a file manually with this format: ```yaml -anta_inventory: - hosts: - - host: 192.168.0.10 - name: spine01 - tags: ['fabric', 'spine'] - - host: 192.168.0.11 - name: spine02 - tags: ['fabric', 'spine'] - - host: 192.168.0.12 - name: leaf01 - tags: ['fabric', 'leaf'] - - host: 192.168.0.13 - name: leaf02 - tags: ['fabric', 'leaf'] - - host: 192.168.0.14 - name: leaf03 - tags: ['fabric', 'leaf'] - - host: 192.168.0.15 - name: leaf04 - tags: ['fabric', 'leaf'] +--8<-- "getting-started/inventory.yml" ``` > You can read more details about how to build your inventory [here](usage-inventory-catalog.md#device-inventory) @@ -90,31 +71,7 @@ The structure to follow is like: Here is an example for basic tests: ```yaml -# Load anta.tests.software -anta.tests.software: - - VerifyEOSVersion: # Verifies the device is running one of the allowed EOS version. - versions: # List of allowed EOS versions. - - 4.25.4M - - 4.26.1F - - '4.28.3M-28837868.4283M (engineering build)' - - VerifyTerminAttrVersion: - versions: - - v1.22.1 - -anta.tests.system: - - VerifyUptime: # Verifies the device uptime is higher than a value. - minimum: 1 - - VerifyNTP: - - VerifySyslog: - -anta.tests.mlag: - - VerifyMlagStatus: - - VerifyMlagInterfaces: - - VerifyMlagConfigSanity: - -anta.tests.configuration: - - VerifyZeroTouch: # Verifies ZeroTouch is disabled. - - VerifyRunningConfigDiffs: +--8<-- "getting-started/catalog.yml" ``` ## Test your network @@ -138,121 +95,22 @@ To run the NRFU, you need to select an output format amongst ["json", "table", " #### Default report using table ```bash -anta nrfu \ - --username tom \ - --password arista123 \ - --enable \ - --enable-password t \ - --inventory .personal/inventory_atd.yml \ - --catalog .personal/tests-bases.yml \ - table - - -╭────────────────────── Settings ──────────────────────╮ -│ Running ANTA tests: │ -│ - ANTA Inventory contains 6 devices (AsyncEOSDevice) │ -│ - Tests catalog contains 10 tests │ -╰──────────────────────────────────────────────────────╯ -[10:17:24] INFO Running ANTA tests... runner.py:75 - • Running NRFU Tests...100% ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 40/40 • 0:00:02 • 0:00:00 - - All tests results -┏━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┓ -┃ Device IP ┃ Test Name ┃ Test Status ┃ Message(s) ┃ Test description ┃ Test category ┃ -┡━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━┩ -│ leaf01 │ VerifyEOSVersion │ success │ │ Verifies the device is running one of the allowed EOS version. │ software │ -│ leaf01 │ VerifyTerminAttrVersion │ success │ │ Verifies the device is running one of the allowed TerminAttr │ software │ -│ │ │ │ │ version. │ │ -│ leaf01 │ VerifyUptime │ success │ │ Verifies the device uptime is higher than a value. │ system │ -│ leaf01 │ VerifyNTP │ success │ │ Verifies NTP is synchronised. │ system │ -│ leaf01 │ VerifySyslog │ success │ │ Verifies the device had no syslog message with a severity of warning │ system │ -│ │ │ │ │ (or a more severe message) during the last 7 days. │ │ -│ leaf01 │ VerifyMlagStatus │ skipped │ MLAG is disabled │ This test verifies the health status of the MLAG configuration. │ mlag │ -│ leaf01 │ VerifyMlagInterfaces │ skipped │ MLAG is disabled │ This test verifies there are no inactive or active-partial MLAG │ mlag │ -[...] -│ leaf04 │ VerifyMlagConfigSanity │ skipped │ MLAG is disabled │ This test verifies there are no MLAG config-sanity inconsistencies. │ mlag │ -│ leaf04 │ VerifyZeroTouch │ success │ │ Verifies ZeroTouch is disabled. │ configuration │ -│ leaf04 │ VerifyRunningConfigDiffs │ success │ │ │ configuration │ -└───────────┴──────────────────────────┴─────────────┴──────────────────┴──────────────────────────────────────────────────────────────────────┴───────────────┘ +--8<-- "getting-started/anta_nrfu_table.sh" +--8<-- "getting-started/anta_nrfu_table.output" ``` #### Report in text mode ```bash -$ anta nrfu \ - --username tom \ - --password arista123 \ - --enable \ - --enable-password t \ - --inventory .personal/inventory_atd.yml \ - --catalog .personal/tests-bases.yml \ - text - -╭────────────────────── Settings ──────────────────────╮ -│ Running ANTA tests: │ -│ - ANTA Inventory contains 6 devices (AsyncEOSDevice) │ -│ - Tests catalog contains 10 tests │ -╰──────────────────────────────────────────────────────╯ -[10:20:47] INFO Running ANTA tests... runner.py:75 - • Running NRFU Tests...100% ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 40/40 • 0:00:01 • 0:00:00 -leaf01 :: VerifyEOSVersion :: SUCCESS -leaf01 :: VerifyTerminAttrVersion :: SUCCESS -leaf01 :: VerifyUptime :: SUCCESS -leaf01 :: VerifyNTP :: SUCCESS -leaf01 :: VerifySyslog :: SUCCESS -leaf01 :: VerifyMlagStatus :: SKIPPED (MLAG is disabled) -leaf01 :: VerifyMlagInterfaces :: SKIPPED (MLAG is disabled) -leaf01 :: VerifyMlagConfigSanity :: SKIPPED (MLAG is disabled) -[...] +--8<-- "getting-started/anta_nrfu_text.sh" +--8<-- "getting-started/anta_nrfu_text.output" ``` #### Report in JSON format ```bash -$ anta nrfu \ - --username tom \ - --password arista123 \ - --enable \ - --enable-password t \ - --inventory .personal/inventory_atd.yml \ - --catalog .personal/tests-bases.yml \ - json - -╭────────────────────── Settings ──────────────────────╮ -│ Running ANTA tests: │ -│ - ANTA Inventory contains 6 devices (AsyncEOSDevice) │ -│ - Tests catalog contains 10 tests │ -╰──────────────────────────────────────────────────────╯ -[10:21:51] INFO Running ANTA tests... runner.py:75 - • Running NRFU Tests...100% ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 40/40 • 0:00:02 • 0:00:00 -╭──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│ JSON results of all tests │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ -[ - { - "name": "leaf01", - "test": "VerifyEOSVersion", - "categories": [ - "software" - ], - "description": "Verifies the device is running one of the allowed EOS version.", - "result": "success", - "messages": [], - "custom_field": "None", - }, - { - "name": "leaf01", - "test": "VerifyTerminAttrVersion", - "categories": [ - "software" - ], - "description": "Verifies the device is running one of the allowed TerminAttr version.", - "result": "success", - "messages": [], - "custom_field": "None", - }, -[...] -] +--8<-- "getting-started/anta_nrfu_json.sh" +--8<-- "getting-started/anta_nrfu_json.output" ``` You can find more information under the **usage** section of the website diff --git a/docs/imgs/getting_started_anta_nrfu_json.svg b/docs/imgs/getting_started_anta_nrfu_json.svg new file mode 100644 index 000000000..3f82d741f --- /dev/null +++ b/docs/imgs/getting_started_anta_nrfu_json.svg @@ -0,0 +1,70 @@ + + + + + + + + + + + + + + + + + anta nrfu \ --username arista \ --password $LABPASSPHRASE \ --inventory ./inventory.yml \ --catalog ./catalog.yml \ json # uncomment the two next lines if you have an enable password \ # --enable \ # --enable-password <password> \ + + + + + + + + + + ant@anthill$ anta nrfu \ --username arista \ --password $LABPASSPHRASE \ --inventory ./inventory.yml \ --catalog  +./catalog.yml \ json # uncomment the two next lines if you have an enable password \ # --enable \ # --enable-password  +<password> \ + + + + diff --git a/docs/snippets/getting-started/anta_nrfu_json.output b/docs/snippets/getting-started/anta_nrfu_json.output new file mode 100644 index 000000000..43f941080 --- /dev/null +++ b/docs/snippets/getting-started/anta_nrfu_json.output @@ -0,0 +1,56 @@ +╭────────────────────── Settings ──────────────────────╮ +│ - ANTA Inventory contains 5 devices (AsyncEOSDevice) │ +│ - Tests catalog contains 9 tests │ +╰──────────────────────────────────────────────────────╯ + +[10:25:04] INFO Preparing ANTA NRFU Run ... tools.py:294 + INFO Connecting to devices ... tools.py:294 + INFO Connecting to devices completed in: 0:00:00.056. tools.py:302 + INFO Preparing the tests ... tools.py:294 + INFO Preparing the tests completed in: 0:00:00.001. tools.py:302 + INFO --- ANTA NRFU Run Information --- runner.py:270 + Number of devices: 5 (5 established) + Total number of selected tests: 45 + Maximum number of open file descriptors for the current ANTA process: 16384 + --------------------------------- + INFO Preparing ANTA NRFU Run completed in: 0:00:00.069. tools.py:302 + INFO Running ANTA tests ... tools.py:294 + INFO Running ANTA tests completed in: 0:00:00.909. tools.py:302 + INFO Cache statistics for 's1-spine1': 1 hits / 9 command(s) (11.11%) runner.py:75 + INFO Cache statistics for 's1-spine2': 1 hits / 9 command(s) (11.11%) runner.py:75 + INFO Cache statistics for 's1-leaf1': 1 hits / 9 command(s) (11.11%) runner.py:75 + INFO Cache statistics for 's1-leaf2': 1 hits / 9 command(s) (11.11%) runner.py:75 + INFO Cache statistics for 's1-leaf3': 1 hits / 9 command(s) (11.11%) runner.py:75 + • Running NRFU Tests...100% ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 45/45 • 0:00:00 • 0:00:00 + +╭──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│ JSON results │ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ +[ + { + "name": "s1-spine1", + "test": "VerifyMlagStatus", + "categories": [ + "mlag" + ], + "description": "Verifies the health status of the MLAG configuration.", + "result": "skipped", + "messages": [ + "MLAG is disabled" + ], + "custom_field": null + }, + { + "name": "s1-spine1", + "test": "VerifyEOSVersion", + "categories": [ + "software" + ], + "description": "Verifies the EOS version of the device.", + "result": "failure", + "messages": [ + "device is running version \"4.32.2F-38195967.4322F (engineering build)\" not in expected versions: ['4.25.4M', '4.26.1F', '4.28.3M-28837868.4283M (engineering build)']" + ], + "custom_field": null + }, + [...] diff --git a/docs/snippets/getting-started/anta_nrfu_json.sh b/docs/snippets/getting-started/anta_nrfu_json.sh new file mode 100644 index 000000000..faeb42982 --- /dev/null +++ b/docs/snippets/getting-started/anta_nrfu_json.sh @@ -0,0 +1,9 @@ +anta nrfu \ + --username arista \ + --password $LABPASSPHRASE \ + --inventory ./inventory.yml \ + `# uncomment the two next lines if you have an enable password `\ + `# --enable `\ + `# --enable-password `\ + --catalog ./catalog.yml \ + json diff --git a/docs/snippets/getting-started/anta_nrfu_table.output b/docs/snippets/getting-started/anta_nrfu_table.output new file mode 100644 index 000000000..858b355a9 --- /dev/null +++ b/docs/snippets/getting-started/anta_nrfu_table.output @@ -0,0 +1,45 @@ +╭────────────────────── Settings ──────────────────────╮ +│ - ANTA Inventory contains 5 devices (AsyncEOSDevice) │ +│ - Tests catalog contains 9 tests │ +╰──────────────────────────────────────────────────────╯ + +[10:29:08] INFO Preparing ANTA NRFU Run ... tools.py:294 + INFO Connecting to devices ... tools.py:294 + INFO Connecting to devices completed in: 0:00:00.056. tools.py:302 + INFO Preparing the tests ... tools.py:294 + INFO Preparing the tests completed in: 0:00:00.001. tools.py:302 + INFO --- ANTA NRFU Run Information --- runner.py:270 + Number of devices: 5 (5 established) + Total number of selected tests: 45 + Maximum number of open file descriptors for the current ANTA process: 16384 + --------------------------------- + INFO Preparing ANTA NRFU Run completed in: 0:00:00.069. tools.py:302 + INFO Running ANTA tests ... tools.py:294 +[10:29:09] INFO Running ANTA tests completed in: 0:00:00.936. tools.py:302 + INFO Cache statistics for 's1-spine1': 1 hits / 9 command(s) (11.11%) runner.py:75 + INFO Cache statistics for 's1-spine2': 1 hits / 9 command(s) (11.11%) runner.py:75 + INFO Cache statistics for 's1-leaf1': 1 hits / 9 command(s) (11.11%) runner.py:75 + INFO Cache statistics for 's1-leaf2': 1 hits / 9 command(s) (11.11%) runner.py:75 + INFO Cache statistics for 's1-leaf3': 1 hits / 9 command(s) (11.11%) runner.py:75 + • Running NRFU Tests...100% ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 45/45 • 0:00:00 • 0:00:00 + + All tests results +┏━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┓ +┃ Device ┃ Test Name ┃ Test Status ┃ Message(s) ┃ Test description ┃ Test category ┃ +┡━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━┩ +│ s1-spine1 │ VerifyMlagInterfaces │ skipped │ MLAG is disabled │ Verifies there are no inactive or active-partial MLAG ports. │ MLAG │ +├───────────┼──────────────────────────┼─────────────┼─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────┼───────────────┤ +│ s1-spine1 │ VerifyZeroTouch │ success │ │ Verifies ZeroTouch is disabled │ Configuration │ +├───────────┼──────────────────────────┼─────────────┼─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────┼───────────────┤ +│ s1-spine1 │ VerifyMlagConfigSanity │ skipped │ MLAG is disabled │ Verifies there are no MLAG config-sanity inconsistencies. │ MLAG │ +├───────────┼──────────────────────────┼─────────────┼─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────┼───────────────┤ +│ s1-spine1 │ VerifyUptime │ success │ │ Verifies the device uptime. │ System │ +├───────────┼──────────────────────────┼─────────────┼─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────┼───────────────┤ +│ s1-spine1 │ VerifyRunningConfigDiffs │ success │ │ Verifies there is no difference between the running-config and the startup-config │ Configuration │ +├───────────┼──────────────────────────┼─────────────┼─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────┼───────────────┤ +[...] +├───────────┼──────────────────────────┼─────────────┼─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────┼───────────────┤ +│ s1-leaf3 │ VerifyNTP │ success │ │ Verifies if NTP is synchronised. │ System │ +├───────────┼──────────────────────────┼─────────────┼─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────┼───────────────┤ +│ s1-leaf3 │ VerifyTerminAttrVersion │ failure │ device is running TerminAttr version v1.34.0 and is not in the allowed list: ['v1.22.1'] │ Verifies the TerminAttr version of the device. │ Software │ +└───────────┴──────────────────────────┴─────────────┴─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┴───────────────────────────────────────────────────────────────────────────────────┴───────────────┘ diff --git a/docs/snippets/getting-started/anta_nrfu_table.sh b/docs/snippets/getting-started/anta_nrfu_table.sh new file mode 100644 index 000000000..a798c767a --- /dev/null +++ b/docs/snippets/getting-started/anta_nrfu_table.sh @@ -0,0 +1,10 @@ +anta nrfu \ + --username arista \ + --password $LABPASSPHRASE \ + --inventory ./inventory.yml \ + `# uncomment the two next lines if you have an enable password` \ + `# --enable` \ + `# --enable-password ` \ + --catalog ./catalog.yml \ + `# table is default if not provided` \ + table diff --git a/docs/snippets/getting-started/anta_nrfu_text.output b/docs/snippets/getting-started/anta_nrfu_text.output new file mode 100644 index 000000000..1b86cd413 --- /dev/null +++ b/docs/snippets/getting-started/anta_nrfu_text.output @@ -0,0 +1,35 @@ +╭────────────────────── Settings ──────────────────────╮ +│ - ANTA Inventory contains 5 devices (AsyncEOSDevice) │ +│ - Tests catalog contains 9 tests │ +╰──────────────────────────────────────────────────────╯ + +[10:25:49] INFO Preparing ANTA NRFU Run ... tools.py:294 + INFO Connecting to devices ... tools.py:294 + INFO Connecting to devices completed in: 0:00:00.056. tools.py:302 + INFO Preparing the tests ... tools.py:294 + INFO Preparing the tests completed in: 0:00:00.002. tools.py:302 + INFO --- ANTA NRFU Run Information --- runner.py:270 + Number of devices: 5 (5 established) + Total number of selected tests: 45 + Maximum number of open file descriptors for the current ANTA process: 16384 + --------------------------------- + INFO Preparing ANTA NRFU Run completed in: 0:00:00.070. tools.py:302 + INFO Running ANTA tests ... tools.py:294 +[10:25:50] INFO Running ANTA tests completed in: 0:00:00.854. tools.py:302 + INFO Cache statistics for 's1-spine1': 1 hits / 9 command(s) (11.11%) runner.py:75 + INFO Cache statistics for 's1-spine2': 1 hits / 9 command(s) (11.11%) runner.py:75 + INFO Cache statistics for 's1-leaf1': 1 hits / 9 command(s) (11.11%) runner.py:75 + INFO Cache statistics for 's1-leaf2': 1 hits / 9 command(s) (11.11%) runner.py:75 + INFO Cache statistics for 's1-leaf3': 1 hits / 9 command(s) (11.11%) runner.py:75 + • Running NRFU Tests...100% ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 45/45 • 0:00:00 • 0:00:00 + +s1-spine1 :: VerifyRunningConfigDiffs :: SUCCESS +s1-spine1 :: VerifyNTP :: SUCCESS +s1-spine1 :: VerifyTerminAttrVersion :: FAILURE (device is running TerminAttr version v1.34.0 and is not in the allowed list: ['v1.22.1']) +s1-spine1 :: VerifyMlagStatus :: SKIPPED (MLAG is disabled) +s1-spine1 :: VerifyUptime :: SUCCESS +s1-spine1 :: VerifyEOSVersion :: FAILURE (device is running version "4.32.2F-38195967.4322F (engineering build)" not in expected versions: ['4.25.4M', '4.26.1F', '4.28.3M-28837868.4283M (engineering build)']) +s1-spine1 :: VerifyZeroTouch :: SUCCESS +s1-spine1 :: VerifyMlagInterfaces :: SKIPPED (MLAG is disabled) +[...] +s1-leaf3 :: VerifyMlagConfigSanity :: SKIPPED (MLAG is disabled) diff --git a/docs/snippets/getting-started/anta_nrfu_text.sh b/docs/snippets/getting-started/anta_nrfu_text.sh new file mode 100644 index 000000000..641fac86e --- /dev/null +++ b/docs/snippets/getting-started/anta_nrfu_text.sh @@ -0,0 +1,9 @@ +anta nrfu \ + --username arista \ + --password $LABPASSPHRASE \ + --inventory ./inventory.yml \ + `# uncomment the two next lines if you have an enable password` \ + `# --enable` \ + `# --enable-password ` \ + --catalog ./catalog.yml \ + text diff --git a/docs/snippets/getting-started/catalog.yml b/docs/snippets/getting-started/catalog.yml new file mode 100644 index 000000000..cc7e7810a --- /dev/null +++ b/docs/snippets/getting-started/catalog.yml @@ -0,0 +1,24 @@ +--- +anta.tests.software: + - VerifyEOSVersion: # Verifies the device is running one of the allowed EOS version. + versions: # List of allowed EOS versions. + - 4.25.4M + - 4.26.1F + - '4.28.3M-28837868.4283M (engineering build)' + - VerifyTerminAttrVersion: + versions: + - v1.22.1 + +anta.tests.system: + - VerifyUptime: # Verifies the device uptime is higher than a value. + minimum: 1 + - VerifyNTP: + +anta.tests.mlag: + - VerifyMlagStatus: + - VerifyMlagInterfaces: + - VerifyMlagConfigSanity: + +anta.tests.configuration: + - VerifyZeroTouch: # Verifies ZeroTouch is disabled. + - VerifyRunningConfigDiffs: diff --git a/docs/snippets/getting-started/inventory.yml b/docs/snippets/getting-started/inventory.yml new file mode 100644 index 000000000..2f3d5127a --- /dev/null +++ b/docs/snippets/getting-started/inventory.yml @@ -0,0 +1,20 @@ +anta_inventory: + hosts: + - host: 192.168.0.10 + name: s1-spine1 + tags: ['fabric', 'spine'] + - host: 192.168.0.11 + name: s1-spine2 + tags: ['fabric', 'spine'] + - host: 192.168.0.12 + name: s1-leaf1 + tags: ['fabric', 'leaf'] + - host: 192.168.0.13 + name: s1-leaf2 + tags: ['fabric', 'leaf'] + - host: 192.168.0.14 + name: s1-leaf3 + tags: ['fabric', 'leaf'] + - host: 192.168.0.15 + name: s1-leaf3 + tags: ['fabric', 'leaf'] From 5176a07a4a16a78c7da622c630af5a7e2687ffcd Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Thu, 24 Oct 2024 10:38:50 +0000 Subject: [PATCH 4/8] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- docs/snippets/getting-started/anta_nrfu_json.output | 8 ++++---- docs/snippets/getting-started/anta_nrfu_table.output | 10 +++++----- docs/snippets/getting-started/anta_nrfu_text.output | 8 ++++---- 3 files changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/snippets/getting-started/anta_nrfu_json.output b/docs/snippets/getting-started/anta_nrfu_json.output index 43f941080..36d065acf 100644 --- a/docs/snippets/getting-started/anta_nrfu_json.output +++ b/docs/snippets/getting-started/anta_nrfu_json.output @@ -9,10 +9,10 @@ INFO Preparing the tests ... tools.py:294 INFO Preparing the tests completed in: 0:00:00.001. tools.py:302 INFO --- ANTA NRFU Run Information --- runner.py:270 - Number of devices: 5 (5 established) - Total number of selected tests: 45 - Maximum number of open file descriptors for the current ANTA process: 16384 - --------------------------------- + Number of devices: 5 (5 established) + Total number of selected tests: 45 + Maximum number of open file descriptors for the current ANTA process: 16384 + --------------------------------- INFO Preparing ANTA NRFU Run completed in: 0:00:00.069. tools.py:302 INFO Running ANTA tests ... tools.py:294 INFO Running ANTA tests completed in: 0:00:00.909. tools.py:302 diff --git a/docs/snippets/getting-started/anta_nrfu_table.output b/docs/snippets/getting-started/anta_nrfu_table.output index 858b355a9..fb41a0ef4 100644 --- a/docs/snippets/getting-started/anta_nrfu_table.output +++ b/docs/snippets/getting-started/anta_nrfu_table.output @@ -9,10 +9,10 @@ INFO Preparing the tests ... tools.py:294 INFO Preparing the tests completed in: 0:00:00.001. tools.py:302 INFO --- ANTA NRFU Run Information --- runner.py:270 - Number of devices: 5 (5 established) - Total number of selected tests: 45 - Maximum number of open file descriptors for the current ANTA process: 16384 - --------------------------------- + Number of devices: 5 (5 established) + Total number of selected tests: 45 + Maximum number of open file descriptors for the current ANTA process: 16384 + --------------------------------- INFO Preparing ANTA NRFU Run completed in: 0:00:00.069. tools.py:302 INFO Running ANTA tests ... tools.py:294 [10:29:09] INFO Running ANTA tests completed in: 0:00:00.936. tools.py:302 @@ -23,7 +23,7 @@ INFO Cache statistics for 's1-leaf3': 1 hits / 9 command(s) (11.11%) runner.py:75 • Running NRFU Tests...100% ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 45/45 • 0:00:00 • 0:00:00 - All tests results + All tests results ┏━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┓ ┃ Device ┃ Test Name ┃ Test Status ┃ Message(s) ┃ Test description ┃ Test category ┃ ┡━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━┩ diff --git a/docs/snippets/getting-started/anta_nrfu_text.output b/docs/snippets/getting-started/anta_nrfu_text.output index 1b86cd413..c7105d3f6 100644 --- a/docs/snippets/getting-started/anta_nrfu_text.output +++ b/docs/snippets/getting-started/anta_nrfu_text.output @@ -9,10 +9,10 @@ INFO Preparing the tests ... tools.py:294 INFO Preparing the tests completed in: 0:00:00.002. tools.py:302 INFO --- ANTA NRFU Run Information --- runner.py:270 - Number of devices: 5 (5 established) - Total number of selected tests: 45 - Maximum number of open file descriptors for the current ANTA process: 16384 - --------------------------------- + Number of devices: 5 (5 established) + Total number of selected tests: 45 + Maximum number of open file descriptors for the current ANTA process: 16384 + --------------------------------- INFO Preparing ANTA NRFU Run completed in: 0:00:00.070. tools.py:302 INFO Running ANTA tests ... tools.py:294 [10:25:50] INFO Running ANTA tests completed in: 0:00:00.854. tools.py:302 From 1bce0dea0d4b8154885c7c9713bfcd8bc87a43f6 Mon Sep 17 00:00:00 2001 From: gmuloc Date: Mon, 28 Oct 2024 22:50:36 +0100 Subject: [PATCH 5/8] Doc: Clean unused image --- docs/imgs/getting_started_anta_nrfu_json.svg | 70 -------------------- 1 file changed, 70 deletions(-) delete mode 100644 docs/imgs/getting_started_anta_nrfu_json.svg diff --git a/docs/imgs/getting_started_anta_nrfu_json.svg b/docs/imgs/getting_started_anta_nrfu_json.svg deleted file mode 100644 index 3f82d741f..000000000 --- a/docs/imgs/getting_started_anta_nrfu_json.svg +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - - - - - - - - - - - anta nrfu \ --username arista \ --password $LABPASSPHRASE \ --inventory ./inventory.yml \ --catalog ./catalog.yml \ json # uncomment the two next lines if you have an enable password \ # --enable \ # --enable-password <password> \ - - - - - - - - - - ant@anthill$ anta nrfu \ --username arista \ --password $LABPASSPHRASE \ --inventory ./inventory.yml \ --catalog  -./catalog.yml \ json # uncomment the two next lines if you have an enable password \ # --enable \ # --enable-password  -<password> \ - - - - From aa8da4c1f4933e8876025c2c76e01786d304ac15 Mon Sep 17 00:00:00 2001 From: gmuloc Date: Thu, 31 Oct 2024 11:38:43 +0100 Subject: [PATCH 6/8] doc: Address some PR comments --- docs/getting-started.md | 7 +++- .../getting-started/anta_nrfu_json.output | 8 ++-- .../getting-started/anta_nrfu_json.sh | 4 +- .../getting-started/anta_nrfu_table.output | 39 ++++++++++--------- .../getting-started/anta_nrfu_table.sh | 4 +- .../getting-started/anta_nrfu_text.output | 2 +- .../getting-started/anta_nrfu_text.sh | 4 +- 7 files changed, 36 insertions(+), 32 deletions(-) diff --git a/docs/getting-started.md b/docs/getting-started.md index 2d8cab34b..bcd5a2c51 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -92,6 +92,11 @@ This entrypoint has multiple options to manage test coverage and reporting. To run the NRFU, you need to select an output format amongst ["json", "table", "text", "tpl-report"]. For a first usage, `table` is recommended. By default all test results for all devices are rendered but it can be changed to a report per test case or per host +!!! Note + The following examples shows how to pass all the CLI options. + + See how to use environment variables instead in the [CLI overview](cli/overview.md#anta-environment-variables) + #### Default report using table ```bash @@ -113,8 +118,6 @@ To run the NRFU, you need to select an output format amongst ["json", "table", " --8<-- "getting-started/anta_nrfu_json.output" ``` -You can find more information under the **usage** section of the website - ### Basic usage in a Python script ```python diff --git a/docs/snippets/getting-started/anta_nrfu_json.output b/docs/snippets/getting-started/anta_nrfu_json.output index 36d065acf..61437d37a 100644 --- a/docs/snippets/getting-started/anta_nrfu_json.output +++ b/docs/snippets/getting-started/anta_nrfu_json.output @@ -21,11 +21,11 @@ INFO Cache statistics for 's1-leaf1': 1 hits / 9 command(s) (11.11%) runner.py:75 INFO Cache statistics for 's1-leaf2': 1 hits / 9 command(s) (11.11%) runner.py:75 INFO Cache statistics for 's1-leaf3': 1 hits / 9 command(s) (11.11%) runner.py:75 - • Running NRFU Tests...100% ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 45/45 • 0:00:00 • 0:00:00 + • Running NRFU Tests...100% ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 45/45 • 0:00:00 • 0:00:00 -╭──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│ JSON results │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ +╭──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│ JSON results │ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ [ { "name": "s1-spine1", diff --git a/docs/snippets/getting-started/anta_nrfu_json.sh b/docs/snippets/getting-started/anta_nrfu_json.sh index faeb42982..932aeb33c 100644 --- a/docs/snippets/getting-started/anta_nrfu_json.sh +++ b/docs/snippets/getting-started/anta_nrfu_json.sh @@ -1,8 +1,8 @@ anta nrfu \ --username arista \ - --password $LABPASSPHRASE \ + --password arista \ --inventory ./inventory.yml \ - `# uncomment the two next lines if you have an enable password `\ + `# uncomment the next two lines if you have an enable password `\ `# --enable `\ `# --enable-password `\ --catalog ./catalog.yml \ diff --git a/docs/snippets/getting-started/anta_nrfu_table.output b/docs/snippets/getting-started/anta_nrfu_table.output index fb41a0ef4..d7b314ca2 100644 --- a/docs/snippets/getting-started/anta_nrfu_table.output +++ b/docs/snippets/getting-started/anta_nrfu_table.output @@ -21,25 +21,26 @@ INFO Cache statistics for 's1-leaf1': 1 hits / 9 command(s) (11.11%) runner.py:75 INFO Cache statistics for 's1-leaf2': 1 hits / 9 command(s) (11.11%) runner.py:75 INFO Cache statistics for 's1-leaf3': 1 hits / 9 command(s) (11.11%) runner.py:75 - • Running NRFU Tests...100% ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 45/45 • 0:00:00 • 0:00:00 + • Running NRFU Tests...100% ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 45/45 • 0:00:00 • 0:00:00 All tests results -┏━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┓ -┃ Device ┃ Test Name ┃ Test Status ┃ Message(s) ┃ Test description ┃ Test category ┃ -┡━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━┩ -│ s1-spine1 │ VerifyMlagInterfaces │ skipped │ MLAG is disabled │ Verifies there are no inactive or active-partial MLAG ports. │ MLAG │ -├───────────┼──────────────────────────┼─────────────┼─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────┼───────────────┤ -│ s1-spine1 │ VerifyZeroTouch │ success │ │ Verifies ZeroTouch is disabled │ Configuration │ -├───────────┼──────────────────────────┼─────────────┼─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────┼───────────────┤ -│ s1-spine1 │ VerifyMlagConfigSanity │ skipped │ MLAG is disabled │ Verifies there are no MLAG config-sanity inconsistencies. │ MLAG │ -├───────────┼──────────────────────────┼─────────────┼─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────┼───────────────┤ -│ s1-spine1 │ VerifyUptime │ success │ │ Verifies the device uptime. │ System │ -├───────────┼──────────────────────────┼─────────────┼─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────┼───────────────┤ -│ s1-spine1 │ VerifyRunningConfigDiffs │ success │ │ Verifies there is no difference between the running-config and the startup-config │ Configuration │ -├───────────┼──────────────────────────┼─────────────┼─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────┼───────────────┤ +┏━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┓ +┃ Device ┃ Test Name ┃ Test Status ┃ Message(s) ┃ Test description ┃ Test category ┃ +┡━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━┩ +│ s1-spine1 │ VerifyMlagInterfaces │ skipped │ MLAG is disabled │ Verifies there are no inactive or active-partial MLAG ports. │ MLAG │ +├───────────┼──────────────────────────┼─────────────┼─────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────┼───────────────┤ +│ s1-spine1 │ VerifyZeroTouch │ success │ │ Verifies ZeroTouch is disabled │ Configuration │ +├───────────┼──────────────────────────┼─────────────┼─────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────┼───────────────┤ +│ s1-spine1 │ VerifyMlagConfigSanity │ skipped │ MLAG is disabled │ Verifies there are no MLAG config-sanity inconsistencies. │ MLAG │ +├───────────┼──────────────────────────┼─────────────┼─────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────┼───────────────┤ +│ s1-spine1 │ VerifyUptime │ success │ │ Verifies the device uptime. │ System │ +├───────────┼──────────────────────────┼─────────────┼─────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────┼───────────────┤ +│ s1-spine1 │ VerifyRunningConfigDiffs │ success │ │ Verifies there is no difference between the running-config and the startup-config │ Configuration │ +├───────────┼──────────────────────────┼─────────────┼─────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────┼───────────────┤ [...] -├───────────┼──────────────────────────┼─────────────┼─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────┼───────────────┤ -│ s1-leaf3 │ VerifyNTP │ success │ │ Verifies if NTP is synchronised. │ System │ -├───────────┼──────────────────────────┼─────────────┼─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────┼───────────────┤ -│ s1-leaf3 │ VerifyTerminAttrVersion │ failure │ device is running TerminAttr version v1.34.0 and is not in the allowed list: ['v1.22.1'] │ Verifies the TerminAttr version of the device. │ Software │ -└───────────┴──────────────────────────┴─────────────┴─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┴───────────────────────────────────────────────────────────────────────────────────┴───────────────┘ +├───────────┼──────────────────────────┼─────────────┼─────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────┼───────────────┤ +│ s1-leaf3 │ VerifyNTP │ success │ │ Verifies if NTP is synchronised. │ System │ +├───────────┼──────────────────────────┼─────────────┼─────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────┼───────────────┤ +│ s1-leaf3 │ VerifyTerminAttrVersion │ failure │ device is running TerminAttr version v1.34.0 and is │ Verifies the TerminAttr version of the device. │ Software │ +│ │ │ │ not in the allowed list: ['v1.22.1'] │ │ +└───────────┴──────────────────────────┴─────────────┴─────────────────────────────────────────────────────┴───────────────────────────────────────────────────────────────────────────────────┴───────────────┘ diff --git a/docs/snippets/getting-started/anta_nrfu_table.sh b/docs/snippets/getting-started/anta_nrfu_table.sh index a798c767a..785c41854 100644 --- a/docs/snippets/getting-started/anta_nrfu_table.sh +++ b/docs/snippets/getting-started/anta_nrfu_table.sh @@ -1,8 +1,8 @@ anta nrfu \ --username arista \ - --password $LABPASSPHRASE \ + --password arista \ --inventory ./inventory.yml \ - `# uncomment the two next lines if you have an enable password` \ + `# uncomment the next two lines if you have an enable password `\ `# --enable` \ `# --enable-password ` \ --catalog ./catalog.yml \ diff --git a/docs/snippets/getting-started/anta_nrfu_text.output b/docs/snippets/getting-started/anta_nrfu_text.output index c7105d3f6..4537adf58 100644 --- a/docs/snippets/getting-started/anta_nrfu_text.output +++ b/docs/snippets/getting-started/anta_nrfu_text.output @@ -21,7 +21,7 @@ INFO Cache statistics for 's1-leaf1': 1 hits / 9 command(s) (11.11%) runner.py:75 INFO Cache statistics for 's1-leaf2': 1 hits / 9 command(s) (11.11%) runner.py:75 INFO Cache statistics for 's1-leaf3': 1 hits / 9 command(s) (11.11%) runner.py:75 - • Running NRFU Tests...100% ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 45/45 • 0:00:00 • 0:00:00 + • Running NRFU Tests...100% ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 45/45 • 0:00:00 • 0:00:00 s1-spine1 :: VerifyRunningConfigDiffs :: SUCCESS s1-spine1 :: VerifyNTP :: SUCCESS diff --git a/docs/snippets/getting-started/anta_nrfu_text.sh b/docs/snippets/getting-started/anta_nrfu_text.sh index 641fac86e..3835b51c8 100644 --- a/docs/snippets/getting-started/anta_nrfu_text.sh +++ b/docs/snippets/getting-started/anta_nrfu_text.sh @@ -1,8 +1,8 @@ anta nrfu \ --username arista \ - --password $LABPASSPHRASE \ + --password arista \ --inventory ./inventory.yml \ - `# uncomment the two next lines if you have an enable password` \ + `# uncomment the next two lines if you have an enable password `\ `# --enable` \ `# --enable-password ` \ --catalog ./catalog.yml \ From f7adbc6a01aee8c2eb5f2aecde518baf9dc07eba Mon Sep 17 00:00:00 2001 From: arista Date: Thu, 31 Oct 2024 10:57:19 +0000 Subject: [PATCH 7/8] doc: Fix snippet length --- .../getting-started/anta_nrfu_json.output | 66 ++++++++-------- .../getting-started/anta_nrfu_table.output | 79 ++++++++++--------- .../getting-started/anta_nrfu_text.output | 53 ++++++------- 3 files changed, 96 insertions(+), 102 deletions(-) diff --git a/docs/snippets/getting-started/anta_nrfu_json.output b/docs/snippets/getting-started/anta_nrfu_json.output index 61437d37a..9dba4119a 100644 --- a/docs/snippets/getting-started/anta_nrfu_json.output +++ b/docs/snippets/getting-started/anta_nrfu_json.output @@ -3,53 +3,51 @@ │ - Tests catalog contains 9 tests │ ╰──────────────────────────────────────────────────────╯ -[10:25:04] INFO Preparing ANTA NRFU Run ... tools.py:294 - INFO Connecting to devices ... tools.py:294 - INFO Connecting to devices completed in: 0:00:00.056. tools.py:302 - INFO Preparing the tests ... tools.py:294 - INFO Preparing the tests completed in: 0:00:00.001. tools.py:302 - INFO --- ANTA NRFU Run Information --- runner.py:270 - Number of devices: 5 (5 established) - Total number of selected tests: 45 - Maximum number of open file descriptors for the current ANTA process: 16384 - --------------------------------- - INFO Preparing ANTA NRFU Run completed in: 0:00:00.069. tools.py:302 - INFO Running ANTA tests ... tools.py:294 - INFO Running ANTA tests completed in: 0:00:00.909. tools.py:302 - INFO Cache statistics for 's1-spine1': 1 hits / 9 command(s) (11.11%) runner.py:75 - INFO Cache statistics for 's1-spine2': 1 hits / 9 command(s) (11.11%) runner.py:75 - INFO Cache statistics for 's1-leaf1': 1 hits / 9 command(s) (11.11%) runner.py:75 - INFO Cache statistics for 's1-leaf2': 1 hits / 9 command(s) (11.11%) runner.py:75 - INFO Cache statistics for 's1-leaf3': 1 hits / 9 command(s) (11.11%) runner.py:75 - • Running NRFU Tests...100% ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 45/45 • 0:00:00 • 0:00:00 +[10:53:11] INFO Preparing ANTA NRFU Run ... tools.py:294 + INFO Connecting to devices ... tools.py:294 + INFO Connecting to devices completed in: 0:00:00.053. tools.py:302 + INFO Preparing the tests ... tools.py:294 + INFO Preparing the tests completed in: 0:00:00.001. tools.py:302 + INFO --- ANTA NRFU Run Information --- runner.py:276 + Number of devices: 5 (5 established) + Total number of selected tests: 45 + Maximum number of open file descriptors for the current ANTA process: 16384 + --------------------------------- + INFO Preparing ANTA NRFU Run completed in: 0:00:00.065. tools.py:302 + INFO Running ANTA tests ... tools.py:294 +[10:53:12] INFO Running ANTA tests completed in: 0:00:00.857. tools.py:302 + INFO Cache statistics for 's1-spine1': 1 hits / 9 command(s) (11.11%) runner.py:75 + INFO Cache statistics for 's1-spine2': 1 hits / 9 command(s) (11.11%) runner.py:75 + INFO Cache statistics for 's1-leaf1': 1 hits / 9 command(s) (11.11%) runner.py:75 + INFO Cache statistics for 's1-leaf2': 1 hits / 9 command(s) (11.11%) runner.py:75 + INFO Cache statistics for 's1-leaf3': 1 hits / 9 command(s) (11.11%) runner.py:75 + • Running NRFU Tests...100% ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 45/45 • 0:00:00 • 0:00:00 -╭──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│ JSON results │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ +╭──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│ JSON results │ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ [ { "name": "s1-spine1", - "test": "VerifyMlagStatus", + "test": "VerifyNTP", "categories": [ - "mlag" - ], - "description": "Verifies the health status of the MLAG configuration.", - "result": "skipped", - "messages": [ - "MLAG is disabled" + "system" ], + "description": "Verifies if NTP is synchronised.", + "result": "success", + "messages": [], "custom_field": null }, { "name": "s1-spine1", - "test": "VerifyEOSVersion", + "test": "VerifyMlagConfigSanity", "categories": [ - "software" + "mlag" ], - "description": "Verifies the EOS version of the device.", - "result": "failure", + "description": "Verifies there are no MLAG config-sanity inconsistencies.", + "result": "skipped", "messages": [ - "device is running version \"4.32.2F-38195967.4322F (engineering build)\" not in expected versions: ['4.25.4M', '4.26.1F', '4.28.3M-28837868.4283M (engineering build)']" + "MLAG is disabled" ], "custom_field": null }, diff --git a/docs/snippets/getting-started/anta_nrfu_table.output b/docs/snippets/getting-started/anta_nrfu_table.output index d7b314ca2..915a5f4a3 100644 --- a/docs/snippets/getting-started/anta_nrfu_table.output +++ b/docs/snippets/getting-started/anta_nrfu_table.output @@ -3,44 +3,45 @@ │ - Tests catalog contains 9 tests │ ╰──────────────────────────────────────────────────────╯ -[10:29:08] INFO Preparing ANTA NRFU Run ... tools.py:294 - INFO Connecting to devices ... tools.py:294 - INFO Connecting to devices completed in: 0:00:00.056. tools.py:302 - INFO Preparing the tests ... tools.py:294 - INFO Preparing the tests completed in: 0:00:00.001. tools.py:302 - INFO --- ANTA NRFU Run Information --- runner.py:270 - Number of devices: 5 (5 established) - Total number of selected tests: 45 - Maximum number of open file descriptors for the current ANTA process: 16384 - --------------------------------- - INFO Preparing ANTA NRFU Run completed in: 0:00:00.069. tools.py:302 - INFO Running ANTA tests ... tools.py:294 -[10:29:09] INFO Running ANTA tests completed in: 0:00:00.936. tools.py:302 - INFO Cache statistics for 's1-spine1': 1 hits / 9 command(s) (11.11%) runner.py:75 - INFO Cache statistics for 's1-spine2': 1 hits / 9 command(s) (11.11%) runner.py:75 - INFO Cache statistics for 's1-leaf1': 1 hits / 9 command(s) (11.11%) runner.py:75 - INFO Cache statistics for 's1-leaf2': 1 hits / 9 command(s) (11.11%) runner.py:75 - INFO Cache statistics for 's1-leaf3': 1 hits / 9 command(s) (11.11%) runner.py:75 - • Running NRFU Tests...100% ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 45/45 • 0:00:00 • 0:00:00 +[10:53:01] INFO Preparing ANTA NRFU Run ... tools.py:294 + INFO Connecting to devices ... tools.py:294 + INFO Connecting to devices completed in: 0:00:00.058. tools.py:302 + INFO Preparing the tests ... tools.py:294 + INFO Preparing the tests completed in: 0:00:00.001. tools.py:302 + INFO --- ANTA NRFU Run Information --- runner.py:276 + Number of devices: 5 (5 established) + Total number of selected tests: 45 + Maximum number of open file descriptors for the current ANTA process: 16384 + --------------------------------- + INFO Preparing ANTA NRFU Run completed in: 0:00:00.069. tools.py:302 + INFO Running ANTA tests ... tools.py:294 +[10:53:02] INFO Running ANTA tests completed in: 0:00:00.969. tools.py:302 + INFO Cache statistics for 's1-spine1': 1 hits / 9 command(s) (11.11%) runner.py:75 + INFO Cache statistics for 's1-spine2': 1 hits / 9 command(s) (11.11%) runner.py:75 + INFO Cache statistics for 's1-leaf1': 1 hits / 9 command(s) (11.11%) runner.py:75 + INFO Cache statistics for 's1-leaf2': 1 hits / 9 command(s) (11.11%) runner.py:75 + INFO Cache statistics for 's1-leaf3': 1 hits / 9 command(s) (11.11%) runner.py:75 + • Running NRFU Tests...100% ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 45/45 • 0:00:00 • 0:00:00 - All tests results -┏━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┓ -┃ Device ┃ Test Name ┃ Test Status ┃ Message(s) ┃ Test description ┃ Test category ┃ -┡━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━┩ -│ s1-spine1 │ VerifyMlagInterfaces │ skipped │ MLAG is disabled │ Verifies there are no inactive or active-partial MLAG ports. │ MLAG │ -├───────────┼──────────────────────────┼─────────────┼─────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────┼───────────────┤ -│ s1-spine1 │ VerifyZeroTouch │ success │ │ Verifies ZeroTouch is disabled │ Configuration │ -├───────────┼──────────────────────────┼─────────────┼─────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────┼───────────────┤ -│ s1-spine1 │ VerifyMlagConfigSanity │ skipped │ MLAG is disabled │ Verifies there are no MLAG config-sanity inconsistencies. │ MLAG │ -├───────────┼──────────────────────────┼─────────────┼─────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────┼───────────────┤ -│ s1-spine1 │ VerifyUptime │ success │ │ Verifies the device uptime. │ System │ -├───────────┼──────────────────────────┼─────────────┼─────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────┼───────────────┤ -│ s1-spine1 │ VerifyRunningConfigDiffs │ success │ │ Verifies there is no difference between the running-config and the startup-config │ Configuration │ -├───────────┼──────────────────────────┼─────────────┼─────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────┼───────────────┤ + All tests results +┏━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┓ +┃ Device ┃ Test Name ┃ Test Status ┃ Message(s) ┃ Test description ┃ Test category ┃ +┡━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━┩ +│ s1-spine1 │ VerifyMlagConfigSanity │ skipped │ MLAG is disabled │ Verifies there are no MLAG config-sanity │ MLAG │ +│ │ │ │ │ inconsistencies. │ │ +├───────────┼──────────────────────────┼─────────────┼────────────────────────────────────────────┼────────────────────────────────────────────┼───────────────┤ +│ s1-spine1 │ VerifyEOSVersion │ failure │ device is running version │ Verifies the EOS version of the device. │ Software │ +│ │ │ │ "4.32.2F-38195967.4322F (engineering │ │ │ +│ │ │ │ build)" not in expected versions: │ │ │ +│ │ │ │ ['4.25.4M', '4.26.1F', │ │ │ +│ │ │ │ '4.28.3M-28837868.4283M (engineering │ │ │ +│ │ │ │ build)'] │ │ │ +├───────────┼──────────────────────────┼─────────────┼────────────────────────────────────────────┼────────────────────────────────────────────┼───────────────┤ [...] -├───────────┼──────────────────────────┼─────────────┼─────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────┼───────────────┤ -│ s1-leaf3 │ VerifyNTP │ success │ │ Verifies if NTP is synchronised. │ System │ -├───────────┼──────────────────────────┼─────────────┼─────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────┼───────────────┤ -│ s1-leaf3 │ VerifyTerminAttrVersion │ failure │ device is running TerminAttr version v1.34.0 and is │ Verifies the TerminAttr version of the device. │ Software │ -│ │ │ │ not in the allowed list: ['v1.22.1'] │ │ -└───────────┴──────────────────────────┴─────────────┴─────────────────────────────────────────────────────┴───────────────────────────────────────────────────────────────────────────────────┴───────────────┘ +├───────────┼──────────────────────────┼─────────────┼────────────────────────────────────────────┼────────────────────────────────────────────┼───────────────┤ +│ s1-leaf3 │ VerifyTerminAttrVersion │ failure │ device is running TerminAttr version │ Verifies the TerminAttr version of the │ Software │ +│ │ │ │ v1.34.0 and is not in the allowed list: │ device. │ │ +│ │ │ │ ['v1.22.1'] │ │ │ +├───────────┼──────────────────────────┼─────────────┼────────────────────────────────────────────┼────────────────────────────────────────────┼───────────────┤ +│ s1-leaf3 │ VerifyZeroTouch │ success │ │ Verifies ZeroTouch is disabled │ Configuration │ +└───────────┴──────────────────────────┴─────────────┴────────────────────────────────────────────┴────────────────────────────────────────────┴───────────────┘ diff --git a/docs/snippets/getting-started/anta_nrfu_text.output b/docs/snippets/getting-started/anta_nrfu_text.output index 4537adf58..4c05dda7f 100644 --- a/docs/snippets/getting-started/anta_nrfu_text.output +++ b/docs/snippets/getting-started/anta_nrfu_text.output @@ -3,33 +3,28 @@ │ - Tests catalog contains 9 tests │ ╰──────────────────────────────────────────────────────╯ -[10:25:49] INFO Preparing ANTA NRFU Run ... tools.py:294 - INFO Connecting to devices ... tools.py:294 - INFO Connecting to devices completed in: 0:00:00.056. tools.py:302 - INFO Preparing the tests ... tools.py:294 - INFO Preparing the tests completed in: 0:00:00.002. tools.py:302 - INFO --- ANTA NRFU Run Information --- runner.py:270 - Number of devices: 5 (5 established) - Total number of selected tests: 45 - Maximum number of open file descriptors for the current ANTA process: 16384 - --------------------------------- - INFO Preparing ANTA NRFU Run completed in: 0:00:00.070. tools.py:302 - INFO Running ANTA tests ... tools.py:294 -[10:25:50] INFO Running ANTA tests completed in: 0:00:00.854. tools.py:302 - INFO Cache statistics for 's1-spine1': 1 hits / 9 command(s) (11.11%) runner.py:75 - INFO Cache statistics for 's1-spine2': 1 hits / 9 command(s) (11.11%) runner.py:75 - INFO Cache statistics for 's1-leaf1': 1 hits / 9 command(s) (11.11%) runner.py:75 - INFO Cache statistics for 's1-leaf2': 1 hits / 9 command(s) (11.11%) runner.py:75 - INFO Cache statistics for 's1-leaf3': 1 hits / 9 command(s) (11.11%) runner.py:75 - • Running NRFU Tests...100% ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 45/45 • 0:00:00 • 0:00:00 +[10:52:39] INFO Preparing ANTA NRFU Run ... tools.py:294 + INFO Connecting to devices ... tools.py:294 + INFO Connecting to devices completed in: 0:00:00.057. tools.py:302 + INFO Preparing the tests ... tools.py:294 + INFO Preparing the tests completed in: 0:00:00.001. tools.py:302 + INFO --- ANTA NRFU Run Information --- runner.py:276 + Number of devices: 5 (5 established) + Total number of selected tests: 45 + Maximum number of open file descriptors for the current ANTA process: 16384 + --------------------------------- + INFO Preparing ANTA NRFU Run completed in: 0:00:00.068. tools.py:302 + INFO Running ANTA tests ... tools.py:294 +[10:52:40] INFO Running ANTA tests completed in: 0:00:00.863. tools.py:302 + INFO Cache statistics for 's1-spine1': 1 hits / 9 command(s) (11.11%) runner.py:75 + INFO Cache statistics for 's1-spine2': 1 hits / 9 command(s) (11.11%) runner.py:75 + INFO Cache statistics for 's1-leaf1': 1 hits / 9 command(s) (11.11%) runner.py:75 + INFO Cache statistics for 's1-leaf2': 1 hits / 9 command(s) (11.11%) runner.py:75 + INFO Cache statistics for 's1-leaf3': 1 hits / 9 command(s) (11.11%) runner.py:75 + • Running NRFU Tests...100% ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 45/45 • 0:00:00 • 0:00:00 -s1-spine1 :: VerifyRunningConfigDiffs :: SUCCESS -s1-spine1 :: VerifyNTP :: SUCCESS -s1-spine1 :: VerifyTerminAttrVersion :: FAILURE (device is running TerminAttr version v1.34.0 and is not in the allowed list: ['v1.22.1']) -s1-spine1 :: VerifyMlagStatus :: SKIPPED (MLAG is disabled) -s1-spine1 :: VerifyUptime :: SUCCESS -s1-spine1 :: VerifyEOSVersion :: FAILURE (device is running version "4.32.2F-38195967.4322F (engineering build)" not in expected versions: ['4.25.4M', '4.26.1F', '4.28.3M-28837868.4283M (engineering build)']) -s1-spine1 :: VerifyZeroTouch :: SUCCESS -s1-spine1 :: VerifyMlagInterfaces :: SKIPPED (MLAG is disabled) -[...] -s1-leaf3 :: VerifyMlagConfigSanity :: SKIPPED (MLAG is disabled) +s1-spine1 :: VerifyEOSVersion :: FAILURE(device is running version "4.32.2F-38195967.4322F (engineering build)" not in expected versions: ['4.25.4M', '4.26.1F', +'4.28.3M-28837868.4283M (engineering build)']) +s1-spine1 :: VerifyTerminAttrVersion :: FAILURE(device is running TerminAttr version v1.34.0 and is not in the allowed list: ['v1.22.1']) +s1-spine1 :: VerifyZeroTouch :: SUCCESS() +s1-spine1 :: VerifyMlagConfigSanity :: SKIPPED(MLAG is disabled) From ae72533237e0dfcdafff17abd78f175a83d6482c Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Thu, 31 Oct 2024 10:59:26 +0000 Subject: [PATCH 8/8] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- docs/snippets/getting-started/anta_nrfu_json.output | 8 ++++---- docs/snippets/getting-started/anta_nrfu_table.output | 10 +++++----- docs/snippets/getting-started/anta_nrfu_text.output | 8 ++++---- 3 files changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/snippets/getting-started/anta_nrfu_json.output b/docs/snippets/getting-started/anta_nrfu_json.output index 9dba4119a..c6db49d43 100644 --- a/docs/snippets/getting-started/anta_nrfu_json.output +++ b/docs/snippets/getting-started/anta_nrfu_json.output @@ -9,10 +9,10 @@ INFO Preparing the tests ... tools.py:294 INFO Preparing the tests completed in: 0:00:00.001. tools.py:302 INFO --- ANTA NRFU Run Information --- runner.py:276 - Number of devices: 5 (5 established) - Total number of selected tests: 45 - Maximum number of open file descriptors for the current ANTA process: 16384 - --------------------------------- + Number of devices: 5 (5 established) + Total number of selected tests: 45 + Maximum number of open file descriptors for the current ANTA process: 16384 + --------------------------------- INFO Preparing ANTA NRFU Run completed in: 0:00:00.065. tools.py:302 INFO Running ANTA tests ... tools.py:294 [10:53:12] INFO Running ANTA tests completed in: 0:00:00.857. tools.py:302 diff --git a/docs/snippets/getting-started/anta_nrfu_table.output b/docs/snippets/getting-started/anta_nrfu_table.output index 915a5f4a3..a34b5bd99 100644 --- a/docs/snippets/getting-started/anta_nrfu_table.output +++ b/docs/snippets/getting-started/anta_nrfu_table.output @@ -9,10 +9,10 @@ INFO Preparing the tests ... tools.py:294 INFO Preparing the tests completed in: 0:00:00.001. tools.py:302 INFO --- ANTA NRFU Run Information --- runner.py:276 - Number of devices: 5 (5 established) - Total number of selected tests: 45 - Maximum number of open file descriptors for the current ANTA process: 16384 - --------------------------------- + Number of devices: 5 (5 established) + Total number of selected tests: 45 + Maximum number of open file descriptors for the current ANTA process: 16384 + --------------------------------- INFO Preparing ANTA NRFU Run completed in: 0:00:00.069. tools.py:302 INFO Running ANTA tests ... tools.py:294 [10:53:02] INFO Running ANTA tests completed in: 0:00:00.969. tools.py:302 @@ -23,7 +23,7 @@ INFO Cache statistics for 's1-leaf3': 1 hits / 9 command(s) (11.11%) runner.py:75 • Running NRFU Tests...100% ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 45/45 • 0:00:00 • 0:00:00 - All tests results + All tests results ┏━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┓ ┃ Device ┃ Test Name ┃ Test Status ┃ Message(s) ┃ Test description ┃ Test category ┃ ┡━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━┩ diff --git a/docs/snippets/getting-started/anta_nrfu_text.output b/docs/snippets/getting-started/anta_nrfu_text.output index 4c05dda7f..872f60810 100644 --- a/docs/snippets/getting-started/anta_nrfu_text.output +++ b/docs/snippets/getting-started/anta_nrfu_text.output @@ -9,10 +9,10 @@ INFO Preparing the tests ... tools.py:294 INFO Preparing the tests completed in: 0:00:00.001. tools.py:302 INFO --- ANTA NRFU Run Information --- runner.py:276 - Number of devices: 5 (5 established) - Total number of selected tests: 45 - Maximum number of open file descriptors for the current ANTA process: 16384 - --------------------------------- + Number of devices: 5 (5 established) + Total number of selected tests: 45 + Maximum number of open file descriptors for the current ANTA process: 16384 + --------------------------------- INFO Preparing ANTA NRFU Run completed in: 0:00:00.068. tools.py:302 INFO Running ANTA tests ... tools.py:294 [10:52:40] INFO Running ANTA tests completed in: 0:00:00.863. tools.py:302