diff options
Diffstat (limited to 'docs/api')
27 files changed, 289 insertions, 48 deletions
diff --git a/docs/api/tests.aaa.md b/docs/api/tests.aaa.md index bdbe7ec..e5c4b91 100644 --- a/docs/api/tests.aaa.md +++ b/docs/api/tests.aaa.md @@ -1,13 +1,20 @@ +--- +anta_title: ANTA catalog for AAA 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 catalog for interfaces tests - ::: 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" diff --git a/docs/api/tests.bfd.md b/docs/api/tests.bfd.md index d28521f..719466e 100644 --- a/docs/api/tests.bfd.md +++ b/docs/api/tests.bfd.md @@ -1,13 +1,20 @@ +--- +anta_title: ANTA catalog for BFD 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 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" diff --git a/docs/api/tests.configuration.md b/docs/api/tests.configuration.md index aaee1f4..9b24ea7 100644 --- a/docs/api/tests.configuration.md +++ b/docs/api/tests.configuration.md @@ -1,13 +1,20 @@ +--- +anta_title: ANTA catalog for device configuration 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 catalog for configuration tests - ::: 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" diff --git a/docs/api/tests.connectivity.md b/docs/api/tests.connectivity.md index 8a1b8a2..0dd5d44 100644 --- a/docs/api/tests.connectivity.md +++ b/docs/api/tests.connectivity.md @@ -1,13 +1,20 @@ +--- +anta_title: ANTA catalog for connectivity 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 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" diff --git a/docs/api/tests.field_notices.md b/docs/api/tests.field_notices.md index ed0e837..fe95bf5 100644 --- a/docs/api/tests.field_notices.md +++ b/docs/api/tests.field_notices.md @@ -1,13 +1,20 @@ +--- +anta_title: ANTA catalog for Field Notices 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 catalog for Field Notices tests - ::: 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" diff --git a/docs/api/tests.greent.md b/docs/api/tests.greent.md new file mode 100644 index 0000000..01900a9 --- /dev/null +++ b/docs/api/tests.greent.md @@ -0,0 +1,20 @@ +--- +anta_title: ANTA catalog for GreenT 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.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" diff --git a/docs/api/tests.hardware.md b/docs/api/tests.hardware.md index 6e84196..ad06a50 100644 --- a/docs/api/tests.hardware.md +++ b/docs/api/tests.hardware.md @@ -1,13 +1,20 @@ +--- +anta_title: ANTA catalog for hardware 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 catalog for hardware tests - ::: 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" diff --git a/docs/api/tests.interfaces.md b/docs/api/tests.interfaces.md index b21da40..95630f5 100644 --- a/docs/api/tests.interfaces.md +++ b/docs/api/tests.interfaces.md @@ -1,13 +1,20 @@ +--- +anta_title: ANTA catalog for interfaces 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 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" diff --git a/docs/api/tests.lanz.md b/docs/api/tests.lanz.md new file mode 100644 index 0000000..0685717 --- /dev/null +++ b/docs/api/tests.lanz.md @@ -0,0 +1,20 @@ +--- +anta_title: ANTA catalog for LANZ 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.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" diff --git a/docs/api/tests.logging.md b/docs/api/tests.logging.md index e9acc20..2c4dec0 100644 --- a/docs/api/tests.logging.md +++ b/docs/api/tests.logging.md @@ -1,13 +1,20 @@ +--- +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 catalog for logging tests - ::: 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" diff --git a/docs/api/tests.md b/docs/api/tests.md index 40c7d8a..1db3a8b 100644 --- a/docs/api/tests.md +++ b/docs/api/tests.md @@ -4,22 +4,28 @@ ~ that can be found in the LICENSE file. --> -# ANTA Tests landing page +# ANTA Tests Landing Page -This section describes all the available tests provided by ANTA package. +This section describes all the available tests provided by the ANTA package. +## Available Tests + +Here are the tests that we currently provide: - [AAA](tests.aaa.md) - [BFD](tests.bfd.md) - [Configuration](tests.configuration.md) - [Connectivity](tests.connectivity.md) - [Field Notice](tests.field_notices.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) - [Routing Generic](tests.routing.generic.md) - [Routing BGP](tests.routing.bgp.md) - [Routing OSPF](tests.routing.ospf.md) @@ -28,10 +34,11 @@ This section describes all the available tests provided by ANTA package. - [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) +## 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) +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). diff --git a/docs/api/tests.mlag.md b/docs/api/tests.mlag.md index 6ce419b..5470bcd 100644 --- a/docs/api/tests.mlag.md +++ b/docs/api/tests.mlag.md @@ -1,13 +1,20 @@ +--- +anta_title: ANTA catalog for MLAG 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 catalog for mlag tests - ::: 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" diff --git a/docs/api/tests.multicast.md b/docs/api/tests.multicast.md index 2b03420..7072796 100644 --- a/docs/api/tests.multicast.md +++ b/docs/api/tests.multicast.md @@ -1,13 +1,20 @@ +--- +anta_title: ANTA catalog for multicast and IGMP 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 catalog for multicast tests - ::: 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" diff --git a/docs/api/tests.profiles.md b/docs/api/tests.profiles.md index c6d06e7..a022c6a 100644 --- a/docs/api/tests.profiles.md +++ b/docs/api/tests.profiles.md @@ -1,13 +1,20 @@ +--- +anta_title: ANTA catalog for profiles 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 catalog for profiles tests - ::: 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" diff --git a/docs/api/tests.ptp.md b/docs/api/tests.ptp.md new file mode 100644 index 0000000..3b03ac0 --- /dev/null +++ b/docs/api/tests.ptp.md @@ -0,0 +1,20 @@ +--- +anta_title: ANTA catalog for PTP 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.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" diff --git a/docs/api/tests.routing.bgp.md b/docs/api/tests.routing.bgp.md index 2346866..5c54678 100644 --- a/docs/api/tests.routing.bgp.md +++ b/docs/api/tests.routing.bgp.md @@ -1,13 +1,20 @@ +--- +anta_title: ANTA catalog for BGP 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 catalog for BGP 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" diff --git a/docs/api/tests.routing.generic.md b/docs/api/tests.routing.generic.md index 3853fb0..1c4c39d 100644 --- a/docs/api/tests.routing.generic.md +++ b/docs/api/tests.routing.generic.md @@ -1,13 +1,20 @@ +--- +anta_title: ANTA catalog for generic routing 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 catalog for routing-generic 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" diff --git a/docs/api/tests.routing.ospf.md b/docs/api/tests.routing.ospf.md index c4e6fed..a01eb50 100644 --- a/docs/api/tests.routing.ospf.md +++ b/docs/api/tests.routing.ospf.md @@ -1,13 +1,20 @@ +--- +anta_title: ANTA catalog for OSPF 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 catalog for routing-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" diff --git a/docs/api/tests.security.md b/docs/api/tests.security.md index 1186b31..fe008ba 100644 --- a/docs/api/tests.security.md +++ b/docs/api/tests.security.md @@ -1,13 +1,20 @@ +--- +anta_title: ANTA catalog for security 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 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" diff --git a/docs/api/tests.services.md b/docs/api/tests.services.md index 82a7b38..63d9234 100644 --- a/docs/api/tests.services.md +++ b/docs/api/tests.services.md @@ -1,13 +1,20 @@ +--- +anta_title: ANTA catalog for services 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 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" diff --git a/docs/api/tests.snmp.md b/docs/api/tests.snmp.md index a015d04..be2da48 100644 --- a/docs/api/tests.snmp.md +++ b/docs/api/tests.snmp.md @@ -1,13 +1,20 @@ +--- +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 catalog for SNMP tests - ::: 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" diff --git a/docs/api/tests.software.md b/docs/api/tests.software.md index 7a2f0ec..7600476 100644 --- a/docs/api/tests.software.md +++ b/docs/api/tests.software.md @@ -1,13 +1,20 @@ +--- +anta_title: ANTA catalog for Software 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 catalog for software tests - ::: 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" diff --git a/docs/api/tests.stp.md b/docs/api/tests.stp.md index f86dac4..50a004b 100644 --- a/docs/api/tests.stp.md +++ b/docs/api/tests.stp.md @@ -1,13 +1,20 @@ +--- +anta_title: ANTA catalog for STP 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 catalog for STP tests - ::: 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" diff --git a/docs/api/tests.stun.md b/docs/api/tests.stun.md new file mode 100644 index 0000000..b4274e9 --- /dev/null +++ b/docs/api/tests.stun.md @@ -0,0 +1,20 @@ +--- +anta_title: ANTA catalog for STUN 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.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" diff --git a/docs/api/tests.system.md b/docs/api/tests.system.md index 621c17b..5dcfbc0 100644 --- a/docs/api/tests.system.md +++ b/docs/api/tests.system.md @@ -1,13 +1,20 @@ +--- +anta_title: ANTA catalog for System 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 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" diff --git a/docs/api/tests.vlan.md b/docs/api/tests.vlan.md index 0e1aa15..74cb003 100644 --- a/docs/api/tests.vlan.md +++ b/docs/api/tests.vlan.md @@ -1,13 +1,20 @@ +--- +anta_title: ANTA catalog for VLAN 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 catalog for vlan tests - ::: 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" diff --git a/docs/api/tests.vxlan.md b/docs/api/tests.vxlan.md index a4dcff3..4c3859a 100644 --- a/docs/api/tests.vxlan.md +++ b/docs/api/tests.vxlan.md @@ -1,13 +1,20 @@ +--- +anta_title: ANTA catalog for VXLAN 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 catalog for VXLAN tests - ::: 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" |