Merging upstream version 1.3.0.

Signed-off-by: Daniel Baumann <daniel@debian.org>

docs/api/catalog.md

@@ -1,14 +1,14 @@
+---
+anta_title: ANTA Catalog API
+---
 <!--
-  ~ Copyright (c) 2023-2024 Arista Networks, Inc.
+  ~ Copyright (c) 2023-2025 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.catalog.AntaCatalog
+::: anta.catalog.AntaCatalog
 
-    options:
-        filters: ["!^_[^_]", "!__str__"]
+::: anta.catalog.AntaTestDefinition
 
-### ::: anta.catalog.AntaTestDefinition
-
-### ::: anta.catalog.AntaCatalogFile
+::: anta.catalog.AntaCatalogFile

docs/api/class-diagram.md

@@ -0,0 +1,15 @@
+---
+anta_title: ANTA Class Diagram
+---
+<!--
+  ~ Copyright (c) 2025 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
+!!! info
+    The classes colored in pink :fontawesome-solid-square-full:{ .pydantic_pink } are [:simple-pydantic:{ .pydantic_pink } pydantic models](https://docs.pydantic.dev/latest/concepts/models/).
+
+``` mermaid
+--8<-- "api/class-diagram.mmd"
+```

docs/api/class-diagram.mmd

@@ -0,0 +1,189 @@
+classDiagram
+  class AntaDevice {
+    <<Abstract>>
+    name : str
+    tags : Optional[set[str]]
+    hw_model : str | None
+    established : bool
+    is_online : bool
+    cache_statistics : dict[str, Any]
+    collect(command: AntaCommand) None
+    collect_commands(commands: list[AntaCommand]) None
+    copy(sources: list[Path], destination: Path, direction: Literal['to', 'from']) None
+    refresh()* None
+    _collect(command: AntaCommand)* None
+  }
+  class AntaTest {
+    <<Abstract>>
+    name : str$
+    description : str$
+    categories : list[str]$
+    commands : list[AntaTemplate | AntaCommand]$
+    device : AntaDevice
+    inputs : Input
+    result : TestResult
+    instance_commands : list[AntaCommand]
+    failed_commands : list[AntaCommand]
+    collected : bool
+    blocked : bool
+    module : str
+    logger : Logger
+    anta_test(function: F) Callable[..., Coroutine[Any, Any, TestResult]]$
+    save_commands_data(eos_data: list[dict[str, Any] | str]) None
+    render(template: AntaTemplate) list[AntaCommand]
+    test() None*
+  }
+  class AntaCommand:::pydantic {
+    command : str
+    version : Literal[1, 'latest']
+    revision : Revision | None
+    ofmt : Literal['json', 'text']
+    output : dict[str, Any] | str | None
+    json_output : dict[str, Any]
+    text_output : str
+    uid : str
+    template : AntaTemplate | None
+    params : AntaParamsBaseModel
+    errors : list[str]
+    error : bool
+    use_cache : bool
+    collected : bool
+    requires_privileges : bool
+    returned_known_eos_error : bool
+    supported : bool
+  }
+  class AntaTemplate {
+    template : str
+    version : Literal[1, 'latest']
+    revision : Revision | None
+    ofmt : Literal['json', 'text']
+    use_cache : bool
+    render() AntaCommand
+  }
+  class AntaTestStatus {
+    <<Enumeration>>
+    UNSET
+    SUCCESS
+    FAILURE
+    ERROR
+    SKIPPED
+  }
+  class Input:::pydantic {
+    filters : Filters | None
+    result_overwrite : ResultOverwrite | None
+  }
+  class ResultManager {
+    results : list[TestResult]
+    status: AntaTestStatus
+    error_status : bool
+    results_by_status: dict[AntaTestStatus, list[TestResult]]
+    sorted_category_stats: dict[str, CategoryStats]
+    dump: list[dict[str, Any]]
+    json : str
+    test_stats: dict[str, TestStats]
+    device_stats: dict[str, DeviceStats]
+    category_stats: dict[str, CategoryStats]
+    add(result: TestResult) None
+    filter(hide: set[AntaTestStatus]) ResultManager
+    filter_by_devices(devices: set[str]) ResultManager
+    filter_by_tests(tests: set[str]) ResultManager
+    get_results(status: set[AntaTestStatus] | None, sort_by: list[str] | None) list[TestResult]
+    get_total_results(status: set[AntaTestStatus] | None) int
+    get_status() str
+    get_tests() set[str]
+    get_devices() set[str]
+    reset() None
+  }
+  class AsyncEOSDevice {
+    enable : bool
+    copy(sources: list[Path], destination: Path, direction: Literal['to', 'from']) None
+    refresh() None
+    _collect(command: AntaCommand) None
+  }
+  class TestResult:::pydantic {
+    name : str
+    test : str
+    categories : list[str]
+    description : str
+    messages : list[str]
+    result : AntaTestStatus
+    custom_field : str | None
+    is_error(message: str | None) None
+    is_failure(message: str | None) None
+    is_skipped(message: str | None) None
+    is_success(message: str | None) None
+  }
+class AntaCatalog {
+    tests : list[AntaTestDefinition]
+    filename: Path | None
+    indexes_built : bool
+    tag_to_tests : defaultdict[str | None, set[AntaTestDefinition]]
+    parse(filename: str | Path, file_format: Literal['yaml', 'json']) AntaCatalog$
+    from_dict(data: RawCatalogInput, filename: str | Path | None) AntaCatalog$
+    from_list(data: ListAntaTestTuples) AntaCatalog$
+    build_indexes(filtered_tests: set[str] | None) None
+    clear_indexes() None
+    get_tests_by_tags(tags: set[str]) set[AntaTestDefinition]
+    merge_catalogs(catalogs: list[AntaCatalog]) AntaCatalog
+    dump() AntaCatalogFile
+  }
+  class AntaCatalogFile:::pydantic {
+    root : dict[ImportString[Any], list[AntaTestDefinition]]
+    yaml() str
+  }
+  class AntaTestDefinition:::pydantic {
+    inputs : Input
+    test : type[AntaTest]
+    check_inputs() Self
+    instantiate_inputs(data: AntaTest.Input | dict[str, Any] | None, info: ValidationInfo) AntaTest.Input
+    serialize_model() dict[str, AntaTest.Input]
+  }
+  class AntaInventory {
+    devices : list[AntaDevice]
+    parse(filename: str | Path, username: str, password: str, enable_password: str | None, timeout: float | None) AntaInventory$
+    add_device(device: AntaDevice) None
+    connect_inventory() None
+    get_inventory() AntaInventory
+  }
+  class AntaInventoryHost:::pydantic {
+    disable_cache : bool
+    host : Hostname | IPvAnyAddress
+    name : str | None
+    port : Port | None
+    tags : set[str] | None
+  }
+  class AntaInventoryInput:::pydantic {
+    hosts : list[AntaInventoryHost] | None
+    networks : list[AntaInventoryNetwork] | None
+    ranges : list[AntaInventoryRange] | None
+    yaml() str
+  }
+  class AntaInventoryNetwork:::pydantic {
+    disable_cache : bool
+    network : IPvAnyNetwork, str
+    tags : set[str] | None
+  }
+  class AntaInventoryRange:::pydantic {
+    disable_cache : bool
+    end : IPvAnyAddress, str
+    start : IPvAnyAddress, str
+    tags : set[str] | None
+  }
+  AsyncEOSDevice --|> AntaDevice
+  Input --* AntaTestDefinition : inputs
+  Input --* AntaTest : inputs
+  AntaTestStatus --* ResultManager : status
+  AntaTestStatus --* TestResult : result
+  TestResult --* AntaTest : result
+  AntaDevice --o AntaTest : device
+  AntaTestDefinition --o AntaCatalog : tests
+  AntaCommand --o AntaTest : commands
+  AntaTemplate ..> AntaCommand : render()
+  AntaTemplate --o AntaTest : commands
+  AntaDevice --o AntaInventory : devices
+  AntaCatalog ..> AntaCatalogFile
+  AntaInventory ..> AntaInventoryInput
+  AntaInventoryInput ..> AntaInventoryHost
+  AntaInventoryInput ..> AntaInventoryNetwork
+  AntaInventoryInput ..> AntaInventoryRange
+  classDef pydantic fill:#D63965

docs/api/commands.md

@@ -0,0 +1,29 @@
+---
+anta_title: ANTA Commands API
+---
+<!--
+  ~ Copyright (c) 2023-2025 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.models.AntaCommand
+
+## ::: anta.models.AntaTemplate
+
+## EOS Commands Error Handling
+
+::: anta.constants.UNSUPPORTED_PLATFORM_ERRORS
+      options:
+        heading_level: 7
+        show_labels: false
+
+::: anta.constants.EOS_BLACKLIST_CMDS
+      options:
+        heading_level: 7
+        show_labels: false
+
+::: anta.constants.KNOWN_EOS_ERRORS
+      options:
+        heading_level: 7
+        show_labels: false

docs/api/device.md

@@ -1,25 +1,18 @@
+---
+anta_title: ANTA Device API
+---
 <!--
-  ~ Copyright (c) 2023-2024 Arista Networks, Inc.
+  ~ Copyright (c) 2023-2025 Arista Networks, Inc.
   ~ Use of this source code is governed by the Apache License 2.0
   ~ that can be found in the LICENSE file.
   -->
 
-# AntaDevice base class
-
-![AntaDevice UML model](../imgs/uml/anta.device.AntaDevice.jpeg)
-
-## ::: anta.device.AntaDevice
-
+::: anta.device.AntaDevice
     options:
-      filters: ["!^_[^_]", "!__(eq|rich_repr)__", "_collect"]
-
-# Async EOS device class
-
-![AsyncEOSDevice UML model](../imgs/uml/anta.device.AsyncEOSDevice.jpeg)
+      filters: ["!^_", "_collect"]
 
 <!-- _collect must be last to be kept -->
 
-## ::: anta.device.AsyncEOSDevice
-
+::: anta.device.AsyncEOSDevice
     options:
-      filters: ["!^_[^_]", "!__(eq|rich_repr)__", "_collect"]
+      filters: ["!^_", "_collect"]

docs/api/inventory.md

@@ -1,12 +1,20 @@
+---
+anta_title: ANTA Inventory API
+---
 <!--
-  ~ Copyright (c) 2023-2024 Arista Networks, Inc.
+  ~ Copyright (c) 2023-2025 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.inventory.AntaInventory
+::: anta.inventory.AntaInventory
 
-    options:
-        filters: ["!^_[^_]", "!__str__"]
+::: anta.inventory.models.AntaInventoryInput
 
-### ::: anta.inventory.exceptions
+::: anta.inventory.models.AntaInventoryHost
+
+::: anta.inventory.models.AntaInventoryNetwork
+
+::: anta.inventory.models.AntaInventoryRange
+
+::: anta.inventory.exceptions

docs/api/inventory.models.input.md

@@ -1,13 +0,0 @@
-<!--
-  ~ 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.inventory.models.AntaInventoryInput
-
-### ::: anta.inventory.models.AntaInventoryHost
-
-### ::: anta.inventory.models.AntaInventoryNetwork
-
-### ::: anta.inventory.models.AntaInventoryRange

docs/api/models.md

@@ -1,33 +0,0 @@
-<!--
-  ~ 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.
-  -->
-
-# Test definition
-
-![AntaTest UML model](../imgs/uml/anta.models.AntaTest.jpeg)
-
-## ::: anta.models.AntaTest
-
-    options:
-        filters: ["!^_[^_]", "!__init_subclass__", "!update_progress"]
-
-# Command definition
-
-![AntaCommand UML model](../imgs/uml/anta.models.AntaCommand.jpeg)
-
-## ::: anta.models.AntaCommand
-
-!!! warning
-    CLI commands are protected to avoid execution of critical commands such as `reload` or `write erase`.
-
-      - Reload command: `^reload\s*\w*`
-      - Configure mode: `^conf\w*\s*(terminal|session)*`
-      - Write: `^wr\w*\s*\w+`
-
-# Template definition
-
-![AntaTemplate UML model](../imgs/uml/anta.models.AntaTemplate.jpeg)
-
-## ::: anta.models.AntaTemplate

docs/api/reporter/csv.md

@@ -2,7 +2,7 @@
 anta_title: CSV Reporter
 ---
 <!--
-  ~ Copyright (c) 2023-2024 Arista Networks, Inc.
+  ~ Copyright (c) 2023-2025 Arista Networks, Inc.
   ~ Use of this source code is governed by the Apache License 2.0
   ~ that can be found in the LICENSE file.
   -->

docs/api/reporter/jinja.md

@@ -0,0 +1,10 @@
+---
+anta_title: Jinja Reporter
+---
+<!--
+  ~ Copyright (c) 2023-2025 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.reporter.ReportJinja

docs/api/reporter/markdown.md

@@ -2,7 +2,7 @@
 anta_title: Markdown Reporter
 ---
 <!--
-  ~ Copyright (c) 2023-2024 Arista Networks, Inc.
+  ~ Copyright (c) 2023-2025 Arista Networks, Inc.
   ~ Use of this source code is governed by the Apache License 2.0
   ~ that can be found in the LICENSE file.
   -->

docs/api/reporter/table.md

@@ -0,0 +1,10 @@
+---
+anta_title: Table Reporter
+---
+<!--
+  ~ Copyright (c) 2023-2025 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.reporter.ReportTable

docs/api/reporters.md

@@ -1,10 +0,0 @@
-<!--
-  ~ 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.reporter
-    options:
-        show_root_heading: false
-        show_root_toc_entry: false

docs/api/result.md

@@ -0,0 +1,13 @@
+---
+anta_title: ANTA Result API
+---
+<!--
+  ~ Copyright (c) 2023-2025 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.result_manager.ResultManager
+    options:
+      extensions: [griffe_warnings_deprecated]
+::: anta.result_manager.models.TestResult

docs/api/result_manager.md

@@ -1,14 +0,0 @@
-<!--
-  ~ 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.
-  -->
-
-# Result Manager definition
-
-![ResultManager UML model](../imgs/uml/anta.result_manager.ResultManager.jpeg)
-
-## ::: anta.result_manager.ResultManager
-
-      options:
-        filters: ["!^_[^_]", "!^__len__"]

docs/api/result_manager_models.md

@@ -1,14 +0,0 @@
-<!--
-  ~ 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.
-  -->
-
-# Test Result model
-
-![TestResult UML model](../imgs/uml/anta.result_manager.models.TestResult.jpeg)
-
-## ::: anta.result_manager.models.TestResult
-
-    options:
-        filters: ["!^_[^_]", "!__str__"]

docs/api/runner.md

@@ -1,10 +1,15 @@
+---
+anta_title: ANTA Runner API
+---
 <!--
-  ~ Copyright (c) 2023-2024 Arista Networks, Inc.
+  ~ Copyright (c) 2023-2025 Arista Networks, Inc.
   ~ Use of this source code is governed by the Apache License 2.0
   ~ that can be found in the LICENSE file.
   -->
 
+Refer to the [Getting started - Basic usage in a Python script](../getting-started.md/#basic-usage-in-a-python-script) section for a usage example.
+
 ### ::: anta.runner
 
     options:
-        filters: ["!^_[^_]", "!__str__"]
+      show_root_full_path: true

docs/api/tests.flow_tracking.md

@@ -1,20 +0,0 @@
----
-anta_title: ANTA catalog for flow tracking 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.flow_tracking
-    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"

docs/api/tests.logging.md

@@ -1,20 +0,0 @@
----
-anta_title: ANTA catalog for logging 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.logging
-    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"

docs/api/tests.md

@@ -1,8 +1,8 @@
 ---
-anta_title: ANTA Tests Landing Page
+anta_title: ANTA Tests
 ---
 <!--
-  ~ Copyright (c) 2023-2024 Arista Networks, Inc.
+  ~ Copyright (c) 2023-2025 Arista Networks, Inc.
   ~ Use of this source code is governed by the Apache License 2.0
   ~ that can be found in the LICENSE file.
   -->
@@ -13,37 +13,37 @@ This section describes all the available tests provided by the ANTA package.
 
 Here are the tests that we currently provide:
 
-- [AAA](tests.aaa.md)
-- [Adaptive Virtual Topology](tests.avt.md)
-- [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)
-- [Hardware](tests.hardware.md)
-- [Interfaces](tests.interfaces.md)
-- [LANZ](tests.lanz.md)
-- [Logging](tests.logging.md)
-- [MLAG](tests.mlag.md)
-- [Multicast](tests.multicast.md)
-- [Profiles](tests.profiles.md)
-- [PTP](tests.ptp.md)
-- [Router Path Selection](tests.path_selection.md)
-- [Routing Generic](tests.routing.generic.md)
-- [Routing BGP](tests.routing.bgp.md)
-- [Routing ISIS](tests.routing.isis.md)
-- [Routing OSPF](tests.routing.ospf.md)
-- [Security](tests.security.md)
-- [Services](tests.services.md)
-- [SNMP](tests.snmp.md)
-- [Software](tests.software.md)
-- [STP](tests.stp.md)
-- [STUN](tests.stun.md)
-- [System](tests.system.md)
-- [VLAN](tests.vlan.md)
-- [VXLAN](tests.vxlan.md)
+- [AAA](tests/aaa.md)
+- [Adaptive Virtual Topology](tests/avt.md)
+- [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)
+- [Hardware](tests/hardware.md)
+- [Interfaces](tests/interfaces.md)
+- [LANZ](tests/lanz.md)
+- [Logging](tests/logging.md)
+- [MLAG](tests/mlag.md)
+- [Multicast](tests/multicast.md)
+- [Profiles](tests/profiles.md)
+- [PTP](tests/ptp.md)
+- [Router Path Selection](tests/path_selection.md)
+- [Routing Generic](tests/routing.generic.md)
+- [Routing BGP](tests/routing.bgp.md)
+- [Routing ISIS](tests/routing.isis.md)
+- [Routing OSPF](tests/routing.ospf.md)
+- [Security](tests/security.md)
+- [Services](tests/services.md)
+- [SNMP](tests/snmp.md)
+- [Software](tests/software.md)
+- [STP](tests/stp.md)
+- [STUN](tests/stun.md)
+- [System](tests/system.md)
+- [VLAN](tests/vlan.md)
+- [VXLAN](tests/vxlan.md)
 
 !!! tip
 

docs/api/tests.path_selection.md

@@ -1,20 +0,0 @@
----
-anta_title: ANTA catalog for Router path-selection 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.path_selection
-    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"

docs/api/tests.routing.isis.md

@@ -1,22 +0,0 @@
----
-anta_title: ANTA catalog for IS-IS 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.routing.isis
-
-    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"
-        - "!^_[^_]"

docs/api/tests.snmp.md

@@ -1,20 +0,0 @@
----
-anta_title: ANTA catalog for SNMP 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.snmp
-    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"

docs/api/tests/aaa.md

@@ -1,20 +1,24 @@
 ---
 anta_title: ANTA catalog for AAA tests
 ---
+
 <!--
-  ~ Copyright (c) 2023-2024 Arista Networks, Inc.
+  ~ Copyright (c) 2023-2025 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.aaa
+
     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"
+      merge_init_into_class: false
+      show_bases: false
+      show_labels: true
+      show_root_heading: false
+      show_root_toc_entry: false
+      show_symbol_type_heading: false
+      show_symbol_type_toc: false

docs/api/tests/anta_test.md

@@ -0,0 +1,10 @@
+---
+anta_title: ANTA Test API
+---
+<!--
+  ~ Copyright (c) 2023-2025 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.models.AntaTest

docs/api/tests/avt.md

@@ -1,8 +1,9 @@
 ---
 anta_title: ANTA catalog for Adaptive Virtual Topology (AVT) tests
 ---
+
 <!--
-  ~ Copyright (c) 2023-2024 Arista Networks, Inc.
+  ~ Copyright (c) 2023-2025 Arista Networks, Inc.
   ~ Use of this source code is governed by the Apache License 2.0
   ~ that can be found in the LICENSE file.
   -->
@@ -12,27 +13,31 @@ anta_title: ANTA catalog for Adaptive Virtual Topology (AVT) tests
 ::: anta.tests.avt
 
     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"
+      merge_init_into_class: false
+      show_bases: false
+      show_labels: true
+      show_root_heading: false
+      show_root_toc_entry: false
+      show_symbol_type_heading: false
+      show_symbol_type_toc: false
 
 # 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__"
+      merge_init_into_class: false
+      show_bases: false
+      show_labels: true
+      show_root_heading: false
+      show_root_toc_entry: false
+      show_symbol_type_heading: false
+      show_symbol_type_toc: false

docs/api/tests/bfd.md

@@ -1,8 +1,9 @@
 ---
 anta_title: ANTA catalog for BFD tests
 ---
+
 <!--
-  ~ Copyright (c) 2023-2024 Arista Networks, Inc.
+  ~ Copyright (c) 2023-2025 Arista Networks, Inc.
   ~ Use of this source code is governed by the Apache License 2.0
   ~ that can be found in the LICENSE file.
   -->
@@ -12,25 +13,30 @@ anta_title: ANTA catalog for BFD tests
 ::: anta.tests.bfd
 
     options:
-      show_root_heading: false
-      show_root_toc_entry: false
-      show_bases: false
-      merge_init_into_class: false
-      show_labels: true
       anta_hide_test_module_description: true
       filters:
         - "!test"
         - "!render"
+      merge_init_into_class: false
+      show_bases: false
+      show_labels: true
+      show_root_heading: false
+      show_root_toc_entry: false
+      show_symbol_type_heading: false
+      show_symbol_type_toc: false
 
 # Input models
 
 ::: anta.input_models.bfd
 
     options:
+      anta_hide_test_module_description: true
+      filters:
+        - "!^__str__"
+      merge_init_into_class: false
+      show_bases: false
+      show_labels: true
       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__"]
+      show_symbol_type_heading: false
+      show_symbol_type_toc: false

docs/api/tests/configuration.md

@@ -1,20 +1,24 @@
 ---
 anta_title: ANTA catalog for device configuration tests
 ---
+
 <!--
-  ~ Copyright (c) 2023-2024 Arista Networks, Inc.
+  ~ Copyright (c) 2023-2025 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.configuration
+
     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"
+      merge_init_into_class: false
+      show_bases: false
+      show_labels: true
+      show_root_heading: false
+      show_root_toc_entry: false
+      show_symbol_type_heading: false
+      show_symbol_type_toc: false

docs/api/tests/connectivity.md

@@ -1,8 +1,9 @@
 ---
 anta_title: ANTA catalog for connectivity tests
 ---
+
 <!--
-  ~ Copyright (c) 2023-2024 Arista Networks, Inc.
+  ~ Copyright (c) 2023-2025 Arista Networks, Inc.
   ~ Use of this source code is governed by the Apache License 2.0
   ~ that can be found in the LICENSE file.
   -->
@@ -12,25 +13,30 @@ anta_title: ANTA catalog for connectivity tests
 ::: anta.tests.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:
         - "!test"
         - "!render"
+      merge_init_into_class: false
+      show_bases: false
+      show_labels: true
+      show_root_heading: false
+      show_root_toc_entry: false
+      show_symbol_type_heading: false
+      show_symbol_type_toc: false
 
 # Input models
 
 ::: anta.input_models.connectivity
 
     options:
+      anta_hide_test_module_description: true
+      filters:
+        - "!^__str__"
+      merge_init_into_class: false
+      show_bases: false
+      show_labels: true
       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__"]
+      show_symbol_type_heading: false
+      show_symbol_type_toc: false

docs/api/tests/cvx.md

@@ -1,20 +1,24 @@
 ---
 anta_title: ANTA catalog for CVX tests
 ---
+
 <!--
-  ~ Copyright (c) 2023-2024 Arista Networks, Inc.
+  ~ Copyright (c) 2023-2025 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"
+      merge_init_into_class: false
+      show_bases: false
+      show_labels: true
+      show_root_heading: false
+      show_root_toc_entry: false
+      show_symbol_type_heading: false
+      show_symbol_type_toc: false

docs/api/tests/field_notices.md

@@ -1,20 +1,24 @@
 ---
 anta_title: ANTA catalog for Field Notices tests
 ---
+
 <!--
-  ~ Copyright (c) 2023-2024 Arista Networks, Inc.
+  ~ Copyright (c) 2023-2025 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.field_notices
+
     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"
+      merge_init_into_class: false
+      show_bases: false
+      show_labels: true
+      show_root_heading: false
+      show_root_toc_entry: false
+      show_symbol_type_heading: false
+      show_symbol_type_toc: false

docs/api/tests/flow_tracking.md

@@ -0,0 +1,44 @@
+---
+anta_title: ANTA catalog for flow tracking tests
+---
+
+<!--
+  ~ Copyright (c) 2023-2025 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
+# Tests
+
+::: anta.tests.flow_tracking
+
+    options:
+      anta_hide_test_module_description: true
+      filters:
+        - "!test"
+        - "!render"
+        - "!validate_exporters"
+      merge_init_into_class: false
+      show_bases: false
+      show_labels: true
+      show_root_heading: false
+      show_root_toc_entry: false
+      show_symbol_type_heading: false
+      show_symbol_type_toc: false
+
+# Input models
+
+::: anta.input_models.flow_tracking
+
+    options:
+      anta_hide_test_module_description: true
+      filters:
+        - "!^__init__"
+        - "!^__str__"
+      merge_init_into_class: false
+      show_bases: false
+      show_labels: true
+      show_root_heading: false
+      show_root_toc_entry: false
+      show_symbol_type_heading: false
+      show_symbol_type_toc: false

docs/api/tests/greent.md

@@ -1,20 +1,24 @@
 ---
 anta_title: ANTA catalog for GreenT tests
 ---
+
 <!--
-  ~ Copyright (c) 2023-2024 Arista Networks, Inc.
+  ~ Copyright (c) 2023-2025 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.greent
+
     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"
+      merge_init_into_class: false
+      show_bases: false
+      show_labels: true
+      show_root_heading: false
+      show_root_toc_entry: false
+      show_symbol_type_heading: false
+      show_symbol_type_toc: false

docs/api/tests/hardware.md

@@ -1,20 +1,24 @@
 ---
 anta_title: ANTA catalog for hardware tests
 ---
+
 <!--
-  ~ Copyright (c) 2023-2024 Arista Networks, Inc.
+  ~ Copyright (c) 2023-2025 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.hardware
+
     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"
+      merge_init_into_class: false
+      show_bases: false
+      show_labels: true
+      show_root_heading: false
+      show_root_toc_entry: false
+      show_symbol_type_heading: false
+      show_symbol_type_toc: false

docs/api/tests/interfaces.md

@@ -1,8 +1,9 @@
 ---
 anta_title: ANTA catalog for interfaces tests
 ---
+
 <!--
-  ~ Copyright (c) 2023-2024 Arista Networks, Inc.
+  ~ Copyright (c) 2023-2025 Arista Networks, Inc.
   ~ Use of this source code is governed by the Apache License 2.0
   ~ that can be found in the LICENSE file.
   -->
@@ -12,25 +13,30 @@ anta_title: ANTA catalog for interfaces tests
 ::: anta.tests.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:
         - "!test"
         - "!render"
+      merge_init_into_class: false
+      show_bases: false
+      show_labels: true
+      show_root_heading: false
+      show_root_toc_entry: false
+      show_symbol_type_heading: false
+      show_symbol_type_toc: false
 
 # Input models
 
 ::: anta.input_models.interfaces
 
     options:
+      anta_hide_test_module_description: true
+      filters:
+        - "!^__str__"
+      merge_init_into_class: false
+      show_bases: false
+      show_labels: true
       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__"]
+      show_symbol_type_heading: false
+      show_symbol_type_toc: false

docs/api/tests/lanz.md

@@ -1,20 +1,24 @@
 ---
 anta_title: ANTA catalog for LANZ tests
 ---
+
 <!--
-  ~ Copyright (c) 2023-2024 Arista Networks, Inc.
+  ~ Copyright (c) 2023-2025 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.lanz
+
     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"
+      merge_init_into_class: false
+      show_bases: false
+      show_labels: true
+      show_root_heading: false
+      show_root_toc_entry: false
+      show_symbol_type_heading: false
+      show_symbol_type_toc: false

docs/api/tests/logging.md

@@ -0,0 +1,43 @@
+---
+anta_title: ANTA catalog for logging tests
+---
+
+<!--
+  ~ Copyright (c) 2023-2025 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
+# Tests
+
+::: anta.tests.logging
+
+    options:
+      anta_hide_test_module_description: true
+      filters:
+        - "!test"
+        - "!render"
+      merge_init_into_class: false
+      show_bases: false
+      show_labels: true
+      show_root_heading: false
+      show_root_toc_entry: false
+      show_symbol_type_heading: false
+      show_symbol_type_toc: false
+
+# Input models
+
+::: anta.input_models.logging
+
+    options:
+      anta_hide_test_module_description: true
+      filters:
+        - "!test"
+        - "!render"
+      merge_init_into_class: false
+      show_bases: false
+      show_labels: true
+      show_root_heading: false
+      show_root_toc_entry: false
+      show_symbol_type_heading: false
+      show_symbol_type_toc: false

docs/api/tests/mlag.md

@@ -1,20 +1,24 @@
 ---
 anta_title: ANTA catalog for MLAG tests
 ---
+
 <!--
-  ~ Copyright (c) 2023-2024 Arista Networks, Inc.
+  ~ Copyright (c) 2023-2025 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.mlag
+
     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"
+      merge_init_into_class: false
+      show_bases: false
+      show_labels: true
+      show_root_heading: false
+      show_root_toc_entry: false
+      show_symbol_type_heading: false
+      show_symbol_type_toc: false

docs/api/tests/multicast.md

@@ -1,20 +1,24 @@
 ---
 anta_title: ANTA catalog for multicast and IGMP tests
 ---
+
 <!--
-  ~ Copyright (c) 2023-2024 Arista Networks, Inc.
+  ~ Copyright (c) 2023-2025 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.multicast
+
     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"
+      merge_init_into_class: false
+      show_bases: false
+      show_labels: true
+      show_root_heading: false
+      show_root_toc_entry: false
+      show_symbol_type_heading: false
+      show_symbol_type_toc: false

docs/api/tests/path_selection.md

@@ -0,0 +1,42 @@
+---
+anta_title: ANTA catalog for Router path-selection tests
+---
+
+<!--
+  ~ Copyright (c) 2023-2025 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
+# Tests
+
+::: anta.tests.path_selection
+
+    options:
+      anta_hide_test_module_description: true
+      filters:
+        - "!test"
+        - "!render"
+      merge_init_into_class: false
+      show_bases: false
+      show_labels: true
+      show_root_heading: false
+      show_root_toc_entry: false
+      show_symbol_type_heading: false
+      show_symbol_type_toc: false
+
+# Input models
+
+::: anta.input_models.path_selection
+
+    options:
+      anta_hide_test_module_description: true
+      filters:
+        - "!^__str__"
+      merge_init_into_class: false
+      show_bases: false
+      show_labels: true
+      show_root_heading: false
+      show_root_toc_entry: false
+      show_symbol_type_heading: false
+      show_symbol_type_toc: false

docs/api/tests/profiles.md

@@ -1,20 +1,24 @@
 ---
 anta_title: ANTA catalog for profiles tests
 ---
+
 <!--
-  ~ Copyright (c) 2023-2024 Arista Networks, Inc.
+  ~ Copyright (c) 2023-2025 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.profiles
+
     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"
+      merge_init_into_class: false
+      show_bases: false
+      show_labels: true
+      show_root_heading: false
+      show_root_toc_entry: false
+      show_symbol_type_heading: false
+      show_symbol_type_toc: false

docs/api/tests/ptp.md

@@ -1,20 +1,24 @@
 ---
 anta_title: ANTA catalog for PTP tests
 ---
+
 <!--
-  ~ Copyright (c) 2023-2024 Arista Networks, Inc.
+  ~ Copyright (c) 2023-2025 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.ptp
+
     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"
+      merge_init_into_class: false
+      show_bases: false
+      show_labels: true
+      show_root_heading: false
+      show_root_toc_entry: false
+      show_symbol_type_heading: false
+      show_symbol_type_toc: false

docs/api/tests/routing.bgp.md

@@ -1,45 +1,55 @@
 ---
 anta_title: ANTA catalog for BGP tests
 ---
+
 <!--
-  ~ Copyright (c) 2023-2024 Arista Networks, Inc.
+  ~ Copyright (c) 2023-2025 Arista Networks, Inc.
   ~ Use of this source code is governed by the Apache License 2.0
   ~ 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.
+!!! info "BGP Test Compatibility Note"
+    ANTA BGP tests are designed for the `multi-agent` routing protocol model. Starting from EOS 4.30.1F, `service routing protocols models` is set to `multi-agent` by default, and from EOS 4.32.0F it becomes the only supported model.
+
+    The following tests are available for devices using the legacy `ribd` model on earlier EOS versions:
+
+      - `VerifyBGPPeerSessionRibd`
+      - `VerifyBGPPeersHealthRibd`
 
 # Tests
 
 ::: anta.tests.routing.bgp
 
     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"
         - "!^_[^_]"
+      merge_init_into_class: false
+      show_bases: false
+      show_labels: true
+      show_root_heading: false
+      show_root_toc_entry: false
+      show_symbol_type_heading: false
+      show_symbol_type_toc: false
 
 # 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"
+      merge_init_into_class: false
+      show_bases: false
+      show_labels: true
+      show_root_heading: false
+      show_root_toc_entry: false
+      show_symbol_type_heading: false
+      show_symbol_type_toc: false

docs/api/tests/routing.generic.md

@@ -1,8 +1,9 @@
 ---
 anta_title: ANTA catalog for generic routing tests
 ---
+
 <!--
-  ~ Copyright (c) 2023-2024 Arista Networks, Inc.
+  ~ Copyright (c) 2023-2025 Arista Networks, Inc.
   ~ Use of this source code is governed by the Apache License 2.0
   ~ that can be found in the LICENSE file.
   -->
@@ -12,25 +13,30 @@ anta_title: ANTA catalog for generic routing tests
 ::: anta.tests.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:
         - "!test"
         - "!render"
+      merge_init_into_class: false
+      show_bases: false
+      show_labels: true
+      show_root_heading: false
+      show_root_toc_entry: false
+      show_symbol_type_heading: false
+      show_symbol_type_toc: false
 
 # Input models
 
 ::: anta.input_models.routing.generic
 
     options:
+      anta_hide_test_module_description: true
+      filters:
+        - "!^__str__"
+      merge_init_into_class: false
+      show_bases: false
+      show_labels: true
       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__"]
+      show_symbol_type_heading: false
+      show_symbol_type_toc: false

docs/api/tests/routing.isis.md

@@ -0,0 +1,44 @@
+---
+anta_title: ANTA catalog for IS-IS tests
+---
+
+<!--
+  ~ Copyright (c) 2023-2025 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
+# Tests
+
+::: anta.tests.routing.isis
+
+    options:
+      anta_hide_test_module_description: true
+      filters:
+        - "!test"
+        - "!render"
+        - "!^_[^_]"
+      merge_init_into_class: false
+      show_bases: false
+      show_labels: true
+      show_root_heading: false
+      show_root_toc_entry: false
+      show_symbol_type_heading: false
+      show_symbol_type_toc: false
+
+# Input models
+
+::: anta.input_models.routing.isis
+
+    options:
+      anta_hide_test_module_description: true
+      filters:
+        - "!^__init__"
+        - "!^__str__"
+      merge_init_into_class: false
+      show_bases: false
+      show_labels: true
+      show_root_heading: false
+      show_root_toc_entry: false
+      show_symbol_type_heading: false
+      show_symbol_type_toc: false

docs/api/tests/routing.ospf.md

@@ -1,8 +1,9 @@
 ---
 anta_title: ANTA catalog for OSPF tests
 ---
+
 <!--
-  ~ Copyright (c) 2023-2024 Arista Networks, Inc.
+  ~ Copyright (c) 2023-2025 Arista Networks, Inc.
   ~ Use of this source code is governed by the Apache License 2.0
   ~ that can be found in the LICENSE file.
   -->
@@ -10,13 +11,15 @@ anta_title: ANTA catalog for OSPF tests
 ::: anta.tests.routing.ospf
 
     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"
         - "!^_[^_]"
+      merge_init_into_class: false
+      show_bases: false
+      show_labels: true
+      show_root_heading: false
+      show_root_toc_entry: false
+      show_symbol_type_heading: false
+      show_symbol_type_toc: false

docs/api/tests/security.md

@@ -1,8 +1,9 @@
 ---
 anta_title: ANTA catalog for security tests
 ---
+
 <!--
-  ~ Copyright (c) 2023-2024 Arista Networks, Inc.
+  ~ Copyright (c) 2023-2025 Arista Networks, Inc.
   ~ Use of this source code is governed by the Apache License 2.0
   ~ that can be found in the LICENSE file.
   -->
@@ -12,27 +13,31 @@ anta_title: ANTA catalog for security tests
 ::: anta.tests.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:
         - "!test"
         - "!render"
+      merge_init_into_class: false
+      show_bases: false
+      show_labels: true
+      show_root_heading: false
+      show_root_toc_entry: false
+      show_symbol_type_heading: false
+      show_symbol_type_toc: false
 
 # 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__"
+      merge_init_into_class: false
+      show_bases: false
+      show_labels: true
+      show_root_heading: false
+      show_root_toc_entry: false
+      show_symbol_type_heading: false
+      show_symbol_type_toc: false

docs/api/tests/services.md

@@ -1,8 +1,9 @@
 ---
 anta_title: ANTA catalog for services tests
 ---
+
 <!--
-  ~ Copyright (c) 2023-2024 Arista Networks, Inc.
+  ~ Copyright (c) 2023-2025 Arista Networks, Inc.
   ~ Use of this source code is governed by the Apache License 2.0
   ~ that can be found in the LICENSE file.
   -->
@@ -12,25 +13,31 @@ anta_title: ANTA catalog for services tests
 ::: anta.tests.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:
         - "!test"
         - "!render"
+      merge_init_into_class: false
+      show_bases: false
+      show_labels: true
+      show_root_heading: false
+      show_root_toc_entry: false
+      show_symbol_type_heading: false
+      show_symbol_type_toc: false
 
 # Input models
 
 ::: anta.input_models.services
 
     options:
+      anta_hide_test_module_description: true
+      filters:
+        - "!^__init__"
+        - "!^__str__"
+      merge_init_into_class: false
+      show_bases: false
+      show_labels: true
       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__"]
+      show_symbol_type_heading: false
+      show_symbol_type_toc: false

docs/api/tests/snmp.md

@@ -0,0 +1,42 @@
+---
+anta_title: ANTA catalog for SNMP tests
+---
+
+<!--
+  ~ Copyright (c) 2023-2025 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
+# Tests
+
+::: anta.tests.snmp
+
+    options:
+      anta_hide_test_module_description: true
+      filters:
+        - "!test"
+        - "!render"
+      merge_init_into_class: false
+      show_bases: false
+      show_labels: true
+      show_root_heading: false
+      show_root_toc_entry: false
+      show_symbol_type_heading: false
+      show_symbol_type_toc: false
+
+# Input models
+
+::: anta.input_models.snmp
+
+    options:
+      anta_hide_test_module_description: true
+      filters:
+        - "!^__str__"
+      merge_init_into_class: false
+      show_bases: false
+      show_labels: true
+      show_root_heading: false
+      show_root_toc_entry: false
+      show_symbol_type_heading: false
+      show_symbol_type_toc: false

docs/api/tests/software.md

@@ -1,20 +1,24 @@
 ---
 anta_title: ANTA catalog for Software tests
 ---
+
 <!--
-  ~ Copyright (c) 2023-2024 Arista Networks, Inc.
+  ~ Copyright (c) 2023-2025 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.software
+
     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"
+      merge_init_into_class: false
+      show_bases: false
+      show_labels: true
+      show_root_heading: false
+      show_root_toc_entry: false
+      show_symbol_type_heading: false
+      show_symbol_type_toc: false

docs/api/tests/stp.md

@@ -1,20 +1,24 @@
 ---
 anta_title: ANTA catalog for STP tests
 ---
+
 <!--
-  ~ Copyright (c) 2023-2024 Arista Networks, Inc.
+  ~ Copyright (c) 2023-2025 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.stp
+
     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"
+      merge_init_into_class: false
+      show_bases: false
+      show_labels: true
+      show_root_heading: false
+      show_root_toc_entry: false
+      show_symbol_type_heading: false
+      show_symbol_type_toc: false

docs/api/tests/stun.md

@@ -1,8 +1,9 @@
 ---
 anta_title: ANTA catalog for STUN tests
 ---
+
 <!--
-  ~ Copyright (c) 2023-2024 Arista Networks, Inc.
+  ~ Copyright (c) 2023-2025 Arista Networks, Inc.
   ~ Use of this source code is governed by the Apache License 2.0
   ~ that can be found in the LICENSE file.
   -->
@@ -10,28 +11,33 @@ anta_title: ANTA catalog for STUN tests
 # Tests
 
 ::: anta.tests.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:
         - "!test"
         - "!render"
+      merge_init_into_class: false
+      show_bases: false
+      show_labels: true
+      show_root_heading: false
+      show_root_toc_entry: false
+      show_symbol_type_heading: false
+      show_symbol_type_toc: false
 
 # 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__"
+      merge_init_into_class: false
+      show_bases: false
+      show_labels: true
+      show_root_heading: false
+      show_root_toc_entry: false
+      show_symbol_type_heading: false
+      show_symbol_type_toc: false

docs/api/tests/system.md

@@ -1,8 +1,9 @@
 ---
 anta_title: ANTA catalog for System tests
 ---
+
 <!--
-  ~ Copyright (c) 2023-2024 Arista Networks, Inc.
+  ~ Copyright (c) 2023-2025 Arista Networks, Inc.
   ~ Use of this source code is governed by the Apache License 2.0
   ~ that can be found in the LICENSE file.
   -->
@@ -12,25 +13,30 @@ anta_title: ANTA catalog for System tests
 ::: anta.tests.system
 
     options:
-      show_root_heading: false
-      show_root_toc_entry: false
-      show_bases: false
-      merge_init_into_class: false
-      show_labels: true
       anta_hide_test_module_description: true
       filters:
         - "!test"
         - "!render"
+      merge_init_into_class: false
+      show_bases: false
+      show_labels: true
+      show_root_heading: false
+      show_root_toc_entry: false
+      show_symbol_type_heading: false
+      show_symbol_type_toc: false
 
 # Input models
 
 ::: anta.input_models.system
 
     options:
+      anta_hide_test_module_description: true
+      filters:
+        - "!^__str__"
+      merge_init_into_class: false
+      show_bases: false
+      show_labels: true
       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__"]
+      show_symbol_type_heading: false
+      show_symbol_type_toc: false

docs/api/tests/types.md

@@ -1,5 +1,8 @@
+---
+anta_title: ANTA Input Types
+---
 <!--
-  ~ Copyright (c) 2023-2024 Arista Networks, Inc.
+  ~ Copyright (c) 2023-2025 Arista Networks, Inc.
   ~ Use of this source code is governed by the Apache License 2.0
   ~ that can be found in the LICENSE file.
   -->

docs/api/tests/vlan.md

@@ -1,20 +1,24 @@
 ---
 anta_title: ANTA catalog for VLAN tests
 ---
+
 <!--
-  ~ Copyright (c) 2023-2024 Arista Networks, Inc.
+  ~ Copyright (c) 2023-2025 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.vlan
+
     options:
-      show_root_heading: false
-      show_root_toc_entry: false
-      show_bases: false
-      merge_init_into_class: false
-      show_labels: true
       anta_hide_test_module_description: true
       filters:
         - "!test"
         - "!render"
+      merge_init_into_class: false
+      show_bases: false
+      show_labels: true
+      show_root_heading: false
+      show_root_toc_entry: false
+      show_symbol_type_heading: false
+      show_symbol_type_toc: false

docs/api/tests/vxlan.md

@@ -1,20 +1,24 @@
 ---
 anta_title: ANTA catalog for VXLAN tests
 ---
+
 <!--
-  ~ Copyright (c) 2023-2024 Arista Networks, Inc.
+  ~ Copyright (c) 2023-2025 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.vxlan
+
     options:
-      show_root_heading: false
-      show_root_toc_entry: false
-      show_bases: false
-      merge_init_into_class: false
-      show_labels: true
       anta_hide_test_module_description: true
       filters:
         - "!test"
         - "!render"
+      merge_init_into_class: false
+      show_bases: false
+      show_labels: true
+      show_root_heading: false
+      show_root_toc_entry: false
+      show_symbol_type_heading: false
+      show_symbol_type_toc: false