Adding upstream version 0.13.0.

Signed-off-by: Daniel Baumann <daniel@debian.org>
This commit is contained in:
Daniel Baumann 2025-02-05 11:32:35 +01:00
parent c0ae77e0f6
commit ecf5ca3300
Signed by: daniel
GPG key ID: FBB4F0E80A80222F
272 changed files with 33172 additions and 0 deletions

13
docs/api/catalog.md Normal file
View file

@ -0,0 +1,13 @@
<!--
~ 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.catalog.AntaCatalog
options:
filters: ["!^_[^_]", "!__str__"]
### ::: anta.catalog.AntaTestDefinition
### ::: anta.catalog.AntaCatalogFile

25
docs/api/device.md Normal file
View file

@ -0,0 +1,25 @@
<!--
~ 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.
-->
# AntaDevice base class
## UML representation
![](../imgs/uml/anta.device.AntaDevice.jpeg)
### ::: anta.device.AntaDevice
options:
filters: ["!^_[^_]", "!__(eq|rich_repr)__"]
# Async EOS device class
## UML representation
![](../imgs/uml/anta.device.AsyncEOSDevice.jpeg)
### ::: anta.device.AsyncEOSDevice
options:
filters: ["!^_[^_]", "!__(eq|rich_repr)__"]

11
docs/api/inventory.md Normal file
View file

@ -0,0 +1,11 @@
<!--
~ 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.AntaInventory
options:
filters: ["!^_[^_]", "!__str__"]
### ::: anta.inventory.exceptions

View file

@ -0,0 +1,13 @@
<!--
~ 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

37
docs/api/models.md Normal file
View file

@ -0,0 +1,37 @@
<!--
~ 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
## UML Diagram
![](../imgs/uml/anta.models.AntaTest.jpeg)
### ::: anta.models.AntaTest
options:
filters: ["!^_[^_]", "!__init_subclass__", "!update_progress"]
# Command definition
## UML Diagram
![](../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
## UML Diagram
![](../imgs/uml/anta.models.AntaTemplate.jpeg)
### ::: anta.models.AntaTemplate

View file

@ -0,0 +1,7 @@
<!--
~ 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.ReportTable

View file

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

View file

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

13
docs/api/tests.aaa.md Normal file
View file

@ -0,0 +1,13 @@
<!--
~ 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 catalog for interfaces tests
::: anta.tests.aaa
options:
show_root_heading: false
show_root_toc_entry: false
merge_init_into_class: false

13
docs/api/tests.bfd.md Normal file
View file

@ -0,0 +1,13 @@
<!--
~ 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 catalog for bfd tests
::: anta.tests.bfd
options:
show_root_heading: false
show_root_toc_entry: false
merge_init_into_class: false

View file

@ -0,0 +1,13 @@
<!--
~ 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 catalog for configuration tests
::: anta.tests.configuration
options:
show_root_heading: false
show_root_toc_entry: false
merge_init_into_class: false

View file

@ -0,0 +1,13 @@
<!--
~ 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 catalog for connectivity tests
::: anta.tests.connectivity
options:
show_root_heading: false
show_root_toc_entry: false
merge_init_into_class: false

View file

@ -0,0 +1,13 @@
<!--
~ 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 catalog for Field Notices tests
::: anta.tests.field_notices
options:
show_root_heading: false
show_root_toc_entry: false
merge_init_into_class: false

View file

@ -0,0 +1,13 @@
<!--
~ 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 catalog for hardware tests
::: anta.tests.hardware
options:
show_root_heading: false
show_root_toc_entry: false
merge_init_into_class: false

View file

@ -0,0 +1,13 @@
<!--
~ 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 catalog for interfaces tests
::: anta.tests.interfaces
options:
show_root_heading: false
show_root_toc_entry: false
merge_init_into_class: false

13
docs/api/tests.logging.md Normal file
View file

@ -0,0 +1,13 @@
<!--
~ 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 catalog for logging tests
::: anta.tests.logging
options:
show_root_heading: false
show_root_toc_entry: false
merge_init_into_class: false

37
docs/api/tests.md Normal file
View file

@ -0,0 +1,37 @@
<!--
~ 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 landing page
This section describes all the available tests provided by ANTA package.
- [AAA](tests.aaa.md)
- [BFD](tests.bfd.md)
- [Configuration](tests.configuration.md)
- [Connectivity](tests.connectivity.md)
- [Field Notice](tests.field_notices.md)
- [Hardware](tests.hardware.md)
- [Interfaces](tests.interfaces.md)
- [Logging](tests.logging.md)
- [MLAG](tests.mlag.md)
- [Multicast](tests.multicast.md)
- [Profiles](tests.profiles.md)
- [Routing Generic](tests.routing.generic.md)
- [Routing BGP](tests.routing.bgp.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)
- [System](tests.system.md)
- [VLAN](tests.vlan.md)
- [VXLAN](tests.vxlan.md)
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)

13
docs/api/tests.mlag.md Normal file
View file

@ -0,0 +1,13 @@
<!--
~ 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 catalog for mlag tests
::: anta.tests.mlag
options:
show_root_heading: false
show_root_toc_entry: false
merge_init_into_class: false

View file

@ -0,0 +1,13 @@
<!--
~ 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 catalog for multicast tests
::: anta.tests.multicast
options:
show_root_heading: false
show_root_toc_entry: false
merge_init_into_class: false

View file

@ -0,0 +1,13 @@
<!--
~ 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 catalog for profiles tests
::: anta.tests.profiles
options:
show_root_heading: false
show_root_toc_entry: false
merge_init_into_class: false

View file

@ -0,0 +1,13 @@
<!--
~ 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 catalog for BGP tests
::: anta.tests.routing.bgp
options:
show_root_heading: false
show_root_toc_entry: false
merge_init_into_class: false

View file

@ -0,0 +1,13 @@
<!--
~ 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 catalog for routing-generic tests
::: anta.tests.routing.generic
options:
show_root_heading: false
show_root_toc_entry: false
merge_init_into_class: false

View file

@ -0,0 +1,13 @@
<!--
~ 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 catalog for routing-ospf tests
::: anta.tests.routing.ospf
options:
show_root_heading: false
show_root_toc_entry: false
merge_init_into_class: false

View file

@ -0,0 +1,13 @@
<!--
~ 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 catalog for security tests
::: anta.tests.security
options:
show_root_heading: false
show_root_toc_entry: false
merge_init_into_class: false

View file

@ -0,0 +1,13 @@
<!--
~ 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 catalog for services tests
::: anta.tests.services
options:
show_root_heading: false
show_root_toc_entry: false
merge_init_into_class: false

13
docs/api/tests.snmp.md Normal file
View file

@ -0,0 +1,13 @@
<!--
~ 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 catalog for SNMP tests
::: anta.tests.snmp
options:
show_root_heading: false
show_root_toc_entry: false
merge_init_into_class: false

View file

@ -0,0 +1,13 @@
<!--
~ 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 catalog for software tests
::: anta.tests.software
options:
show_root_heading: false
show_root_toc_entry: false
merge_init_into_class: false

13
docs/api/tests.stp.md Normal file
View file

@ -0,0 +1,13 @@
<!--
~ 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 catalog for STP tests
::: anta.tests.stp
options:
show_root_heading: false
show_root_toc_entry: false
merge_init_into_class: false

13
docs/api/tests.system.md Normal file
View file

@ -0,0 +1,13 @@
<!--
~ 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 catalog for system tests
::: anta.tests.system
options:
show_root_heading: false
show_root_toc_entry: false
merge_init_into_class: false

13
docs/api/tests.vlan.md Normal file
View file

@ -0,0 +1,13 @@
<!--
~ 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 catalog for vlan tests
::: anta.tests.vlan
options:
show_root_heading: false
show_root_toc_entry: false
merge_init_into_class: false

13
docs/api/tests.vxlan.md Normal file
View file

@ -0,0 +1,13 @@
<!--
~ 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 catalog for VXLAN tests
::: anta.tests.vxlan
options:
show_root_heading: false
show_root_toc_entry: false
merge_init_into_class: false

10
docs/api/types.md Normal file
View file

@ -0,0 +1,10 @@
<!--
~ 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.custom_types
options:
show_if_no_docstring: true
show_root_full_path: true