From 1fd6a618b60d7168fd8f37585d5d39d22d775afd Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Thu, 28 Mar 2024 07:11:39 +0100 Subject: Adding upstream version 0.13.0. Signed-off-by: Daniel Baumann --- docs/api/catalog.md | 13 +++++++++++++ docs/api/device.md | 25 +++++++++++++++++++++++++ docs/api/inventory.md | 11 +++++++++++ docs/api/inventory.models.input.md | 13 +++++++++++++ docs/api/models.md | 37 +++++++++++++++++++++++++++++++++++++ docs/api/report_manager.md | 7 +++++++ docs/api/result_manager.md | 15 +++++++++++++++ docs/api/result_manager_models.md | 15 +++++++++++++++ docs/api/tests.aaa.md | 13 +++++++++++++ docs/api/tests.bfd.md | 13 +++++++++++++ docs/api/tests.configuration.md | 13 +++++++++++++ docs/api/tests.connectivity.md | 13 +++++++++++++ docs/api/tests.field_notices.md | 13 +++++++++++++ docs/api/tests.hardware.md | 13 +++++++++++++ docs/api/tests.interfaces.md | 13 +++++++++++++ docs/api/tests.logging.md | 13 +++++++++++++ docs/api/tests.md | 37 +++++++++++++++++++++++++++++++++++++ docs/api/tests.mlag.md | 13 +++++++++++++ docs/api/tests.multicast.md | 13 +++++++++++++ docs/api/tests.profiles.md | 13 +++++++++++++ docs/api/tests.routing.bgp.md | 13 +++++++++++++ docs/api/tests.routing.generic.md | 13 +++++++++++++ docs/api/tests.routing.ospf.md | 13 +++++++++++++ docs/api/tests.security.md | 13 +++++++++++++ docs/api/tests.services.md | 13 +++++++++++++ docs/api/tests.snmp.md | 13 +++++++++++++ docs/api/tests.software.md | 13 +++++++++++++ docs/api/tests.stp.md | 13 +++++++++++++ docs/api/tests.system.md | 13 +++++++++++++ docs/api/tests.vlan.md | 13 +++++++++++++ docs/api/tests.vxlan.md | 13 +++++++++++++ docs/api/types.md | 10 ++++++++++ 32 files changed, 469 insertions(+) create mode 100644 docs/api/catalog.md create mode 100644 docs/api/device.md create mode 100644 docs/api/inventory.md create mode 100644 docs/api/inventory.models.input.md create mode 100644 docs/api/models.md create mode 100644 docs/api/report_manager.md create mode 100644 docs/api/result_manager.md create mode 100644 docs/api/result_manager_models.md create mode 100644 docs/api/tests.aaa.md create mode 100644 docs/api/tests.bfd.md create mode 100644 docs/api/tests.configuration.md create mode 100644 docs/api/tests.connectivity.md create mode 100644 docs/api/tests.field_notices.md create mode 100644 docs/api/tests.hardware.md create mode 100644 docs/api/tests.interfaces.md create mode 100644 docs/api/tests.logging.md create mode 100644 docs/api/tests.md create mode 100644 docs/api/tests.mlag.md create mode 100644 docs/api/tests.multicast.md create mode 100644 docs/api/tests.profiles.md create mode 100644 docs/api/tests.routing.bgp.md create mode 100644 docs/api/tests.routing.generic.md create mode 100644 docs/api/tests.routing.ospf.md create mode 100644 docs/api/tests.security.md create mode 100644 docs/api/tests.services.md create mode 100644 docs/api/tests.snmp.md create mode 100644 docs/api/tests.software.md create mode 100644 docs/api/tests.stp.md create mode 100644 docs/api/tests.system.md create mode 100644 docs/api/tests.vlan.md create mode 100644 docs/api/tests.vxlan.md create mode 100644 docs/api/types.md (limited to 'docs/api') diff --git a/docs/api/catalog.md b/docs/api/catalog.md new file mode 100644 index 0000000..fc719ea --- /dev/null +++ b/docs/api/catalog.md @@ -0,0 +1,13 @@ + + +### ::: anta.catalog.AntaCatalog + options: + filters: ["!^_[^_]", "!__str__"] + +### ::: anta.catalog.AntaTestDefinition + +### ::: anta.catalog.AntaCatalogFile diff --git a/docs/api/device.md b/docs/api/device.md new file mode 100644 index 0000000..03cff19 --- /dev/null +++ b/docs/api/device.md @@ -0,0 +1,25 @@ + + +# 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)__"] diff --git a/docs/api/inventory.md b/docs/api/inventory.md new file mode 100644 index 0000000..5e4400c --- /dev/null +++ b/docs/api/inventory.md @@ -0,0 +1,11 @@ + + +### ::: anta.inventory.AntaInventory + options: + filters: ["!^_[^_]", "!__str__"] + +### ::: anta.inventory.exceptions diff --git a/docs/api/inventory.models.input.md b/docs/api/inventory.models.input.md new file mode 100644 index 0000000..a15c20e --- /dev/null +++ b/docs/api/inventory.models.input.md @@ -0,0 +1,13 @@ + + +### ::: anta.inventory.models.AntaInventoryInput + +### ::: anta.inventory.models.AntaInventoryHost + +### ::: anta.inventory.models.AntaInventoryNetwork + +### ::: anta.inventory.models.AntaInventoryRange diff --git a/docs/api/models.md b/docs/api/models.md new file mode 100644 index 0000000..b0c1e91 --- /dev/null +++ b/docs/api/models.md @@ -0,0 +1,37 @@ + + +# 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 diff --git a/docs/api/report_manager.md b/docs/api/report_manager.md new file mode 100644 index 0000000..f0e3818 --- /dev/null +++ b/docs/api/report_manager.md @@ -0,0 +1,7 @@ + + +### ::: anta.reporter.ReportTable diff --git a/docs/api/result_manager.md b/docs/api/result_manager.md new file mode 100644 index 0000000..72e05aa --- /dev/null +++ b/docs/api/result_manager.md @@ -0,0 +1,15 @@ + + +# Result Manager definition + +## UML Diagram + +![](../imgs/uml/anta.result_manager.ResultManager.jpeg) + +### ::: anta.result_manager.ResultManager + options: + filters: ["!^_[^_]", "!^__len__"] diff --git a/docs/api/result_manager_models.md b/docs/api/result_manager_models.md new file mode 100644 index 0000000..096bd03 --- /dev/null +++ b/docs/api/result_manager_models.md @@ -0,0 +1,15 @@ + + +# Test Result model + +## UML Diagram + +![](../imgs/uml/anta.result_manager.models.TestResult.jpeg) + +### ::: anta.result_manager.models.TestResult + options: + filters: ["!^_[^_]", "!__str__"] diff --git a/docs/api/tests.aaa.md b/docs/api/tests.aaa.md new file mode 100644 index 0000000..bdbe7ec --- /dev/null +++ b/docs/api/tests.aaa.md @@ -0,0 +1,13 @@ + + +# ANTA catalog for interfaces tests + +::: anta.tests.aaa + options: + show_root_heading: false + show_root_toc_entry: false + merge_init_into_class: false diff --git a/docs/api/tests.bfd.md b/docs/api/tests.bfd.md new file mode 100644 index 0000000..d28521f --- /dev/null +++ b/docs/api/tests.bfd.md @@ -0,0 +1,13 @@ + + +# ANTA catalog for bfd tests + +::: anta.tests.bfd + options: + show_root_heading: false + show_root_toc_entry: false + merge_init_into_class: false diff --git a/docs/api/tests.configuration.md b/docs/api/tests.configuration.md new file mode 100644 index 0000000..aaee1f4 --- /dev/null +++ b/docs/api/tests.configuration.md @@ -0,0 +1,13 @@ + + +# ANTA catalog for configuration tests + +::: anta.tests.configuration + options: + show_root_heading: false + show_root_toc_entry: false + merge_init_into_class: false diff --git a/docs/api/tests.connectivity.md b/docs/api/tests.connectivity.md new file mode 100644 index 0000000..8a1b8a2 --- /dev/null +++ b/docs/api/tests.connectivity.md @@ -0,0 +1,13 @@ + + +# ANTA catalog for connectivity tests + +::: anta.tests.connectivity + options: + show_root_heading: false + show_root_toc_entry: false + merge_init_into_class: false diff --git a/docs/api/tests.field_notices.md b/docs/api/tests.field_notices.md new file mode 100644 index 0000000..ed0e837 --- /dev/null +++ b/docs/api/tests.field_notices.md @@ -0,0 +1,13 @@ + + +# 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 diff --git a/docs/api/tests.hardware.md b/docs/api/tests.hardware.md new file mode 100644 index 0000000..6e84196 --- /dev/null +++ b/docs/api/tests.hardware.md @@ -0,0 +1,13 @@ + + +# ANTA catalog for hardware tests + +::: anta.tests.hardware + options: + show_root_heading: false + show_root_toc_entry: false + merge_init_into_class: false diff --git a/docs/api/tests.interfaces.md b/docs/api/tests.interfaces.md new file mode 100644 index 0000000..b21da40 --- /dev/null +++ b/docs/api/tests.interfaces.md @@ -0,0 +1,13 @@ + + +# ANTA catalog for interfaces tests + +::: anta.tests.interfaces + options: + show_root_heading: false + show_root_toc_entry: false + merge_init_into_class: false diff --git a/docs/api/tests.logging.md b/docs/api/tests.logging.md new file mode 100644 index 0000000..e9acc20 --- /dev/null +++ b/docs/api/tests.logging.md @@ -0,0 +1,13 @@ + + +# ANTA catalog for logging tests + +::: anta.tests.logging + options: + show_root_heading: false + show_root_toc_entry: false + merge_init_into_class: false diff --git a/docs/api/tests.md b/docs/api/tests.md new file mode 100644 index 0000000..40c7d8a --- /dev/null +++ b/docs/api/tests.md @@ -0,0 +1,37 @@ + + +# 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) diff --git a/docs/api/tests.mlag.md b/docs/api/tests.mlag.md new file mode 100644 index 0000000..6ce419b --- /dev/null +++ b/docs/api/tests.mlag.md @@ -0,0 +1,13 @@ + + +# ANTA catalog for mlag tests + +::: anta.tests.mlag + options: + show_root_heading: false + show_root_toc_entry: false + merge_init_into_class: false diff --git a/docs/api/tests.multicast.md b/docs/api/tests.multicast.md new file mode 100644 index 0000000..2b03420 --- /dev/null +++ b/docs/api/tests.multicast.md @@ -0,0 +1,13 @@ + + +# ANTA catalog for multicast tests + +::: anta.tests.multicast + options: + show_root_heading: false + show_root_toc_entry: false + merge_init_into_class: false diff --git a/docs/api/tests.profiles.md b/docs/api/tests.profiles.md new file mode 100644 index 0000000..c6d06e7 --- /dev/null +++ b/docs/api/tests.profiles.md @@ -0,0 +1,13 @@ + + +# ANTA catalog for profiles tests + +::: anta.tests.profiles + options: + show_root_heading: false + show_root_toc_entry: false + merge_init_into_class: false diff --git a/docs/api/tests.routing.bgp.md b/docs/api/tests.routing.bgp.md new file mode 100644 index 0000000..2346866 --- /dev/null +++ b/docs/api/tests.routing.bgp.md @@ -0,0 +1,13 @@ + + +# ANTA catalog for BGP tests + +::: anta.tests.routing.bgp + options: + show_root_heading: false + show_root_toc_entry: false + merge_init_into_class: false diff --git a/docs/api/tests.routing.generic.md b/docs/api/tests.routing.generic.md new file mode 100644 index 0000000..3853fb0 --- /dev/null +++ b/docs/api/tests.routing.generic.md @@ -0,0 +1,13 @@ + + +# 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 diff --git a/docs/api/tests.routing.ospf.md b/docs/api/tests.routing.ospf.md new file mode 100644 index 0000000..c4e6fed --- /dev/null +++ b/docs/api/tests.routing.ospf.md @@ -0,0 +1,13 @@ + + +# 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 diff --git a/docs/api/tests.security.md b/docs/api/tests.security.md new file mode 100644 index 0000000..1186b31 --- /dev/null +++ b/docs/api/tests.security.md @@ -0,0 +1,13 @@ + + +# ANTA catalog for security tests + +::: anta.tests.security + options: + show_root_heading: false + show_root_toc_entry: false + merge_init_into_class: false diff --git a/docs/api/tests.services.md b/docs/api/tests.services.md new file mode 100644 index 0000000..82a7b38 --- /dev/null +++ b/docs/api/tests.services.md @@ -0,0 +1,13 @@ + + +# ANTA catalog for services tests + +::: anta.tests.services + options: + show_root_heading: false + show_root_toc_entry: false + merge_init_into_class: false diff --git a/docs/api/tests.snmp.md b/docs/api/tests.snmp.md new file mode 100644 index 0000000..a015d04 --- /dev/null +++ b/docs/api/tests.snmp.md @@ -0,0 +1,13 @@ + + +# ANTA catalog for SNMP tests + +::: anta.tests.snmp + options: + show_root_heading: false + show_root_toc_entry: false + merge_init_into_class: false diff --git a/docs/api/tests.software.md b/docs/api/tests.software.md new file mode 100644 index 0000000..7a2f0ec --- /dev/null +++ b/docs/api/tests.software.md @@ -0,0 +1,13 @@ + + +# ANTA catalog for software tests + +::: anta.tests.software + options: + show_root_heading: false + show_root_toc_entry: false + merge_init_into_class: false diff --git a/docs/api/tests.stp.md b/docs/api/tests.stp.md new file mode 100644 index 0000000..f86dac4 --- /dev/null +++ b/docs/api/tests.stp.md @@ -0,0 +1,13 @@ + + +# ANTA catalog for STP tests + +::: anta.tests.stp + options: + show_root_heading: false + show_root_toc_entry: false + merge_init_into_class: false diff --git a/docs/api/tests.system.md b/docs/api/tests.system.md new file mode 100644 index 0000000..621c17b --- /dev/null +++ b/docs/api/tests.system.md @@ -0,0 +1,13 @@ + + +# ANTA catalog for system tests + +::: anta.tests.system + options: + show_root_heading: false + show_root_toc_entry: false + merge_init_into_class: false diff --git a/docs/api/tests.vlan.md b/docs/api/tests.vlan.md new file mode 100644 index 0000000..0e1aa15 --- /dev/null +++ b/docs/api/tests.vlan.md @@ -0,0 +1,13 @@ + + +# ANTA catalog for vlan tests + +::: anta.tests.vlan + options: + show_root_heading: false + show_root_toc_entry: false + merge_init_into_class: false diff --git a/docs/api/tests.vxlan.md b/docs/api/tests.vxlan.md new file mode 100644 index 0000000..a4dcff3 --- /dev/null +++ b/docs/api/tests.vxlan.md @@ -0,0 +1,13 @@ + + +# ANTA catalog for VXLAN tests + +::: anta.tests.vxlan + options: + show_root_heading: false + show_root_toc_entry: false + merge_init_into_class: false diff --git a/docs/api/types.md b/docs/api/types.md new file mode 100644 index 0000000..806ab63 --- /dev/null +++ b/docs/api/types.md @@ -0,0 +1,10 @@ + + +### ::: anta.custom_types + options: + show_if_no_docstring: true + show_root_full_path: true -- cgit v1.2.3