Merging upstream version 1.2.0.

Signed-off-by: Daniel Baumann <daniel@debian.org>
2025-02-05 11:55:22 +01:00 · 2025-02-05 11:55:22 +01:00 · afeccccd6a
commit afeccccd6a
parent ae7b7df396
154 changed files with 7346 additions and 5000 deletions
--- a/docs/api/tests.avt.md
+++ b/docs/api/tests.avt.md
@ -7,7 +7,10 @@ anta_title: ANTA catalog for Adaptive Virtual Topology (AVT) tests
  ~ that can be found in the LICENSE file.
  -->

+# Tests
+
 ::: anta.tests.avt
+
    options:
      show_root_heading: false
      show_root_toc_entry: false
@ -18,3 +21,18 @@ anta_title: ANTA catalog for Adaptive Virtual Topology (AVT) tests
      filters:
        - "!test"
        - "!render"
+
+# Input models
+
+::: anta.input_models.avt
+
+    options:
+      show_root_heading: false
+      show_root_toc_entry: false
+      show_bases: false
+      anta_hide_test_module_description: true
+      merge_init_into_class: false
+      show_labels: true
+      filters:
+        - "!^__init__"
+        - "!^__str__"
--- a/docs/api/tests.bfd.md
+++ b/docs/api/tests.bfd.md
@ -7,7 +7,10 @@ anta_title: ANTA catalog for BFD tests
  ~ that can be found in the LICENSE file.
  -->

+# Tests
+
 ::: anta.tests.bfd
+
    options:
      show_root_heading: false
      show_root_toc_entry: false
@ -18,3 +21,16 @@ anta_title: ANTA catalog for BFD tests
      filters:
        - "!test"
        - "!render"
+
+# Input models
+
+::: anta.input_models.bfd
+
+    options:
+      show_root_heading: false
+      show_root_toc_entry: false
+      show_bases: false
+      merge_init_into_class: false
+      anta_hide_test_module_description: true
+      show_labels: true
+      filters: ["!^__str__"]
--- a/docs/api/tests.connectivity.md
+++ b/docs/api/tests.connectivity.md
@ -7,7 +7,10 @@ anta_title: ANTA catalog for connectivity tests
  ~ that can be found in the LICENSE file.
  -->

+# Tests
+
 ::: anta.tests.connectivity
+
    options:
      show_root_heading: false
      show_root_toc_entry: false
@ -18,3 +21,16 @@ anta_title: ANTA catalog for connectivity tests
      filters:
        - "!test"
        - "!render"
+
+# Input models
+
+::: anta.input_models.connectivity
+
+    options:
+      show_root_heading: false
+      show_root_toc_entry: false
+      show_bases: false
+      merge_init_into_class: false
+      anta_hide_test_module_description: true
+      show_labels: true
+      filters: ["!^__str__"]
--- a/docs/api/tests.cvx.md
+++ b/docs/api/tests.cvx.md
@ -0,0 +1,20 @@
+---
+anta_title: ANTA catalog for CVX tests
+---
+<!--
+  ~ Copyright (c) 2023-2024 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
+::: anta.tests.cvx
+    options:
+      show_root_heading: false
+      show_root_toc_entry: false
+      show_bases: false
+      merge_init_into_class: false
+      anta_hide_test_module_description: true
+      show_labels: true
+      filters:
+        - "!test"
+        - "!render"
--- a/docs/api/tests.interfaces.md
+++ b/docs/api/tests.interfaces.md
@ -7,7 +7,10 @@ anta_title: ANTA catalog for interfaces tests
  ~ that can be found in the LICENSE file.
  -->

+# Tests
+
 ::: anta.tests.interfaces
+
    options:
      show_root_heading: false
      show_root_toc_entry: false
@ -18,3 +21,16 @@ anta_title: ANTA catalog for interfaces tests
      filters:
        - "!test"
        - "!render"
+
+# Input models
+
+::: anta.input_models.interfaces
+
+    options:
+      show_root_heading: false
+      show_root_toc_entry: false
+      show_bases: false
+      merge_init_into_class: false
+      anta_hide_test_module_description: true
+      show_labels: true
+      filters: ["!^__str__"]
--- a/docs/api/tests.md
+++ b/docs/api/tests.md
@ -18,6 +18,7 @@ Here are the tests that we currently provide:
 - [BFD](tests.bfd.md)
 - [Configuration](tests.configuration.md)
 - [Connectivity](tests.connectivity.md)
+- [CVX](tests.cvx.md)
 - [Field Notices](tests.field_notices.md)
 - [Flow Tracking](tests.flow_tracking.md)
 - [GreenT](tests.greent.md)
@ -44,6 +45,10 @@ Here are the tests that we currently provide:
 - [VLAN](tests.vlan.md)
 - [VXLAN](tests.vxlan.md)

+!!! tip
+
+    You can use `anta get tests` from the CLI to list all the tests available with an example. Refer to [documentation](../cli/get-tests.md) for more options.
+
 ## Using the Tests

 All these tests can be imported in a [catalog](../usage-inventory-catalog.md) to be used by [the ANTA CLI](../cli/nrfu.md) or in your [own framework](../advanced_usages/as-python-lib.md).
--- a/docs/api/tests.routing.bgp.md
+++ b/docs/api/tests.routing.bgp.md
@ -7,7 +7,13 @@ anta_title: ANTA catalog for BGP tests
  ~ that can be found in the LICENSE file.
  -->

+!!! info "`multi-agent` Service Routing Protocols Model Requirements"
+    The BGP tests in this section are only supported on switches running the `multi-agent` routing protocols model. Starting from EOS version 4.30.1F, `service routing protocols model` is set to `multi-agent` by default. These BGP commands may **not** be compatible with switches running the legacy `ribd` routing protocols model and may fail if attempted.
+
+# Tests
+
 ::: anta.tests.routing.bgp
+
    options:
      show_root_heading: false
      show_root_toc_entry: false
@ -19,3 +25,21 @@ anta_title: ANTA catalog for BGP tests
        - "!test"
        - "!render"
        - "!^_[^_]"
+
+# Input models
+
+::: anta.input_models.routing.bgp
+
+    options:
+      show_root_heading: false
+      show_root_toc_entry: false
+      show_bases: false
+      anta_hide_test_module_description: true
+      merge_init_into_class: false
+      show_labels: true
+      filters:
+        - "!^__init__"
+        - "!^__str__"
+        - "!AFI_SAFI_EOS_KEY"
+        - "!eos_key"
+        - "!BgpAfi"
--- a/docs/api/tests.routing.generic.md
+++ b/docs/api/tests.routing.generic.md
@ -7,7 +7,10 @@ anta_title: ANTA catalog for generic routing tests
  ~ that can be found in the LICENSE file.
  -->

+# Tests
+
 ::: anta.tests.routing.generic
+
    options:
      show_root_heading: false
      show_root_toc_entry: false
@ -18,3 +21,16 @@ anta_title: ANTA catalog for generic routing tests
      filters:
        - "!test"
        - "!render"
+
+# Input models
+
+::: anta.input_models.routing.generic
+
+    options:
+      show_root_heading: false
+      show_root_toc_entry: false
+      show_bases: false
+      merge_init_into_class: false
+      anta_hide_test_module_description: true
+      show_labels: true
+      filters: ["!^__str__"]
--- a/docs/api/tests.routing.isis.md
+++ b/docs/api/tests.routing.isis.md
@ -8,6 +8,7 @@ anta_title: ANTA catalog for IS-IS tests
  -->

 ::: anta.tests.routing.isis
+
    options:
      show_root_heading: false
      show_root_toc_entry: false
--- a/docs/api/tests.routing.ospf.md
+++ b/docs/api/tests.routing.ospf.md
@ -8,6 +8,7 @@ anta_title: ANTA catalog for OSPF tests
  -->

 ::: anta.tests.routing.ospf
+
    options:
      show_root_heading: false
      show_root_toc_entry: false
--- a/docs/api/tests.security.md
+++ b/docs/api/tests.security.md
@ -7,7 +7,10 @@ anta_title: ANTA catalog for security tests
  ~ that can be found in the LICENSE file.
  -->

+# Tests
+
 ::: anta.tests.security
+
    options:
      show_root_heading: false
      show_root_toc_entry: false
@ -18,3 +21,18 @@ anta_title: ANTA catalog for security tests
      filters:
        - "!test"
        - "!render"
+
+# Input models
+
+::: anta.input_models.security
+
+    options:
+      show_root_heading: false
+      show_root_toc_entry: false
+      show_bases: false
+      merge_init_into_class: false
+      anta_hide_test_module_description: true
+      show_labels: true
+      filters:
+        - "!^__init__"
+        - "!^__str__"
--- a/docs/api/tests.services.md
+++ b/docs/api/tests.services.md
@ -7,7 +7,10 @@ anta_title: ANTA catalog for services tests
  ~ that can be found in the LICENSE file.
  -->

+# Tests
+
 ::: anta.tests.services
+
    options:
      show_root_heading: false
      show_root_toc_entry: false
@ -18,3 +21,16 @@ anta_title: ANTA catalog for services tests
      filters:
        - "!test"
        - "!render"
+
+# Input models
+
+::: anta.input_models.services
+
+    options:
+      show_root_heading: false
+      show_root_toc_entry: false
+      show_bases: false
+      merge_init_into_class: false
+      anta_hide_test_module_description: true
+      show_labels: true
+      filters: ["!^__str__"]
--- a/docs/api/tests.stun.md
+++ b/docs/api/tests.stun.md
@ -7,6 +7,8 @@ anta_title: ANTA catalog for STUN tests
  ~ that can be found in the LICENSE file.
  -->

+# Tests
+
 ::: anta.tests.stun
    options:
      show_root_heading: false
@ -18,3 +20,18 @@ anta_title: ANTA catalog for STUN tests
      filters:
        - "!test"
        - "!render"
+
+# Input models
+
+::: anta.input_models.stun
+
+    options:
+      show_root_heading: false
+      show_root_toc_entry: false
+      show_bases: false
+      merge_init_into_class: false
+      anta_hide_test_module_description: true
+      show_labels: true
+      filters:
+        - "!^__init__"
+        - "!^__str__"
--- a/docs/api/tests.system.md
+++ b/docs/api/tests.system.md
@ -7,7 +7,10 @@ anta_title: ANTA catalog for System tests
  ~ that can be found in the LICENSE file.
  -->

+# Tests
+
 ::: anta.tests.system
+
    options:
      show_root_heading: false
      show_root_toc_entry: false
@ -18,3 +21,16 @@ anta_title: ANTA catalog for System tests
      filters:
        - "!test"
        - "!render"
+
+# Input models
+
+::: anta.input_models.system
+
+    options:
+      show_root_heading: false
+      show_root_toc_entry: false
+      show_bases: false
+      merge_init_into_class: false
+      anta_hide_test_module_description: true
+      show_labels: true
+      filters: ["!^__str__"]