Add API reference docs for 2.23.0

aristanetworks · Jun 8, 2024 · 62c18ab · 62c18ab
1 parent af305f9
commit 62c18ab
Show file tree

Hide file tree

Showing 127 changed files with 61,271 additions and 0 deletions.
diff --git a/docs/2.23.0/ref/.buildinfo b/docs/2.23.0/ref/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 842dab674828198eb4f1bc74cee8fc45
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/2.23.0/ref/_sources/acl.rst.txt b/docs/2.23.0/ref/_sources/acl.rst.txt
@@ -0,0 +1,13 @@
+**acl**
+-------
+
+
+.. doxygenfile:: eos/acl.h
+   :project: eossdk
+
+Type definitions in **acl**
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. doxygenfile:: eos/types/acl.h
+   :project: eossdk
+
diff --git a/docs/2.23.0/ref/_sources/agent.rst.txt b/docs/2.23.0/ref/_sources/agent.rst.txt
@@ -0,0 +1,7 @@
+**agent**
+---------
+
+
+.. doxygenfile:: eos/agent.h
+   :project: eossdk
+
diff --git a/docs/2.23.0/ref/_sources/aresolve.rst.txt b/docs/2.23.0/ref/_sources/aresolve.rst.txt
@@ -0,0 +1,13 @@
+**aresolve**
+------------
+
+
+.. doxygenfile:: eos/aresolve.h
+   :project: eossdk
+
+Type definitions in **aresolve**
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. doxygenfile:: eos/types/aresolve.h
+   :project: eossdk
+
diff --git a/docs/2.23.0/ref/_sources/base.rst.txt b/docs/2.23.0/ref/_sources/base.rst.txt
@@ -0,0 +1,7 @@
+**base**
+--------
+
+
+.. doxygenfile:: eos/base.h
+   :project: eossdk
+
diff --git a/docs/2.23.0/ref/_sources/base_handler.rst.txt b/docs/2.23.0/ref/_sources/base_handler.rst.txt
@@ -0,0 +1,7 @@
+**base_handler**
+----------------
+
+
+.. doxygenfile:: eos/base_handler.h
+   :project: eossdk
+
diff --git a/docs/2.23.0/ref/_sources/base_mgr.rst.txt b/docs/2.23.0/ref/_sources/base_mgr.rst.txt
@@ -0,0 +1,7 @@
+**base_mgr**
+------------
+
+
+.. doxygenfile:: eos/base_mgr.h
+   :project: eossdk
+
diff --git a/docs/2.23.0/ref/_sources/bfd.rst.txt b/docs/2.23.0/ref/_sources/bfd.rst.txt
@@ -0,0 +1,13 @@
+**bfd**
+-------
+
+
+.. doxygenfile:: eos/bfd.h
+   :project: eossdk
+
+Type definitions in **bfd**
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. doxygenfile:: eos/types/bfd.h
+   :project: eossdk
+
diff --git a/docs/2.23.0/ref/_sources/bgp.rst.txt b/docs/2.23.0/ref/_sources/bgp.rst.txt
@@ -0,0 +1,13 @@
+**bgp**
+-------
+
+
+.. doxygenfile:: eos/bgp.h
+   :project: eossdk
+
+Type definitions in **bgp**
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. doxygenfile:: eos/types/bgp.h
+   :project: eossdk
+
diff --git a/docs/2.23.0/ref/_sources/bgp_path.rst.txt b/docs/2.23.0/ref/_sources/bgp_path.rst.txt
@@ -0,0 +1,13 @@
+**bgp_path**
+------------
+
+
+.. doxygenfile:: eos/bgp_path.h
+   :project: eossdk
+
+Type definitions in **bgp_path**
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. doxygenfile:: eos/types/bgp_path.h
+   :project: eossdk
+
diff --git a/docs/2.23.0/ref/_sources/class_map.rst.txt b/docs/2.23.0/ref/_sources/class_map.rst.txt
@@ -0,0 +1,13 @@
+**class_map**
+-------------
+
+
+.. doxygenfile:: eos/class_map.h
+   :project: eossdk
+
+Type definitions in **class_map**
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. doxygenfile:: eos/types/class_map.h
+   :project: eossdk
+
diff --git a/docs/2.23.0/ref/_sources/decap_group.rst.txt b/docs/2.23.0/ref/_sources/decap_group.rst.txt
@@ -0,0 +1,13 @@
+**decap_group**
+---------------
+
+
+.. doxygenfile:: eos/decap_group.h
+   :project: eossdk
+
+Type definitions in **decap_group**
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. doxygenfile:: eos/types/decap_group.h
+   :project: eossdk
+
diff --git a/docs/2.23.0/ref/_sources/directflow.rst.txt b/docs/2.23.0/ref/_sources/directflow.rst.txt
@@ -0,0 +1,13 @@
+**directflow**
+--------------
+
+
+.. doxygenfile:: eos/directflow.h
+   :project: eossdk
+
+Type definitions in **directflow**
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. doxygenfile:: eos/types/directflow.h
+   :project: eossdk
+
diff --git a/docs/2.23.0/ref/_sources/eapi.rst.txt b/docs/2.23.0/ref/_sources/eapi.rst.txt
@@ -0,0 +1,13 @@
+**eapi**
+--------
+
+
+.. doxygenfile:: eos/eapi.h
+   :project: eossdk
+
+Type definitions in **eapi**
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. doxygenfile:: eos/types/eapi.h
+   :project: eossdk
+
diff --git a/docs/2.23.0/ref/_sources/eth.rst.txt b/docs/2.23.0/ref/_sources/eth.rst.txt
@@ -0,0 +1,13 @@
+**eth**
+-------
+
+
+.. doxygenfile:: eos/eth.h
+   :project: eossdk
+
+Type definitions in **eth**
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. doxygenfile:: eos/types/eth.h
+   :project: eossdk
+
diff --git a/docs/2.23.0/ref/_sources/eth_intf.rst.txt b/docs/2.23.0/ref/_sources/eth_intf.rst.txt
@@ -0,0 +1,13 @@
+**eth_intf**
+------------
+
+
+.. doxygenfile:: eos/eth_intf.h
+   :project: eossdk
+
+Type definitions in **eth_intf**
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. doxygenfile:: eos/types/eth_intf.h
+   :project: eossdk
+
diff --git a/docs/2.23.0/ref/_sources/eth_lag_intf.rst.txt b/docs/2.23.0/ref/_sources/eth_lag_intf.rst.txt
@@ -0,0 +1,13 @@
+**eth_lag_intf**
+----------------
+
+
+.. doxygenfile:: eos/eth_lag_intf.h
+   :project: eossdk
+
+Type definitions in **eth_lag_intf**
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. doxygenfile:: eos/types/eth_lag_intf.h
+   :project: eossdk
+
diff --git a/docs/2.23.0/ref/_sources/eth_phy_intf.rst.txt b/docs/2.23.0/ref/_sources/eth_phy_intf.rst.txt
@@ -0,0 +1,13 @@
+**eth_phy_intf**
+----------------
+
+
+.. doxygenfile:: eos/eth_phy_intf.h
+   :project: eossdk
+
+Type definitions in **eth_phy_intf**
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. doxygenfile:: eos/types/eth_phy_intf.h
+   :project: eossdk
+
diff --git a/docs/2.23.0/ref/_sources/event_loop.rst.txt b/docs/2.23.0/ref/_sources/event_loop.rst.txt
@@ -0,0 +1,7 @@
+**event_loop**
+--------------
+
+
+.. doxygenfile:: eos/event_loop.h
+   :project: eossdk
+
diff --git a/docs/2.23.0/ref/_sources/exception.rst.txt b/docs/2.23.0/ref/_sources/exception.rst.txt
@@ -0,0 +1,7 @@
+**exception**
+-------------
+
+
+.. doxygenfile:: eos/exception.h
+   :project: eossdk
+
diff --git a/docs/2.23.0/ref/_sources/fd.rst.txt b/docs/2.23.0/ref/_sources/fd.rst.txt
@@ -0,0 +1,7 @@
+**fd**
+------
+
+
+.. doxygenfile:: eos/fd.h
+   :project: eossdk
+
diff --git a/docs/2.23.0/ref/_sources/fib.rst.txt b/docs/2.23.0/ref/_sources/fib.rst.txt
@@ -0,0 +1,13 @@
+**fib**
+-------
+
+
+.. doxygenfile:: eos/fib.h
+   :project: eossdk
+
+Type definitions in **fib**
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. doxygenfile:: eos/types/fib.h
+   :project: eossdk
+
diff --git a/docs/2.23.0/ref/_sources/hardware_table.rst.txt b/docs/2.23.0/ref/_sources/hardware_table.rst.txt
@@ -0,0 +1,13 @@
+**hardware_table**
+------------------
+
+
+.. doxygenfile:: eos/hardware_table.h
+   :project: eossdk
+
+Type definitions in **hardware_table**
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. doxygenfile:: eos/types/hardware_table.h
+   :project: eossdk
+
diff --git a/docs/2.23.0/ref/_sources/hash_mix.rst.txt b/docs/2.23.0/ref/_sources/hash_mix.rst.txt
@@ -0,0 +1,7 @@
+**hash_mix**
+------------
+
+
+.. doxygenfile:: eos/hash_mix.h
+   :project: eossdk
+
diff --git a/docs/2.23.0/ref/_sources/index.rst.txt b/docs/2.23.0/ref/_sources/index.rst.txt
@@ -0,0 +1,45 @@
+
+Arista EOS SDK reference guide
+==============================
+
+The Arista EOS SDK allows development of high performance on switch
+agents that react to and interact directly with EOS. These agents can
+bridge feature configuration with existing systems or provide
+automated system maintenance facilities due to the SDK's state based
+programming approach. Refer to the EOS SDK wiki_ for more information
+including example code using the SDK.
+
+Switch management modules
+-------------------------
+
+The SDK is split up into modules that manage one particular part of
+the system, such as the ``intf`` module for generic interface management
+(admin state, description) or the ``acl`` module for configuration of
+Access Control Lists. Each module consists of a module manager class,
+such as ``eos::intf_mgr``. Modules that provide notifications also have
+a handler class, e.g., ``eos::intf_handler``. Handler sub-classes are
+provided by your implementation and provide the notification callbacks
+for notifications from EOS.
+
+| :doc:`acl` | :doc:`bfd` | :doc:`bgp` | :doc:`bgp_path` | :doc:`class_map` | :doc:`decap_group` | :doc:`directflow` | :doc:`eapi` | :doc:`eth` | :doc:`eth_intf` | :doc:`eth_lag_intf` | :doc:`eth_phy_intf` | :doc:`fib` | :doc:`hardware_table` | :doc:`intf` | :doc:`ip` | :doc:`ip_intf` | :doc:`ip_route` | :doc:`lldp` | :doc:`mac_table` | :doc:`macsec` | :doc:`mlag` | :doc:`mpls` | :doc:`mpls_route` | :doc:`mpls_vrf_label` | :doc:`neighbor_table` | :doc:`nexthop_group` | :doc:`nexthop_group_tunnel` | :doc:`policy_map` | :doc:`route_map` | :doc:`structured_filter` | :doc:`subintf` | :doc:`vrf` | :doc:`xcvr` 
+
+
+Infrastructure modules
+----------------------
+
+In addition, there are a number of framework modules that provide
+access to the SDK components (``sdk``), offer an asynchronous
+file-descriptor interface for use with asynchronous networking
+libraries (``fd``) and provide debug logging facilities (``tracing``).
+
+| :doc:`agent` | :doc:`aresolve` | :doc:`base` | :doc:`base_handler` | :doc:`base_mgr` | :doc:`event_loop` | :doc:`exception` | :doc:`fd` | :doc:`hash_mix` | :doc:`iterator` | :doc:`panic` | :doc:`sdk` | :doc:`system` | :doc:`timer` | :doc:`tracing` | :doc:`utility` | :doc:`version` 
+
+
+.. toctree::
+   :hidden:
+   :glob:
+
+   **
+
+
+.. _wiki: https://github.com/aristanetworks/EosSdk/wiki
diff --git a/docs/2.23.0/ref/_sources/intf.rst.txt b/docs/2.23.0/ref/_sources/intf.rst.txt
@@ -0,0 +1,13 @@
+**intf**
+--------
+
+
+.. doxygenfile:: eos/intf.h
+   :project: eossdk
+
+Type definitions in **intf**
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. doxygenfile:: eos/types/intf.h
+   :project: eossdk
+
diff --git a/docs/2.23.0/ref/_sources/ip.rst.txt b/docs/2.23.0/ref/_sources/ip.rst.txt
@@ -0,0 +1,13 @@
+**ip**
+------
+
+
+.. doxygenfile:: eos/ip.h
+   :project: eossdk
+
+Type definitions in **ip**
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. doxygenfile:: eos/types/ip.h
+   :project: eossdk
+
diff --git a/docs/2.23.0/ref/_sources/ip_intf.rst.txt b/docs/2.23.0/ref/_sources/ip_intf.rst.txt
@@ -0,0 +1,7 @@
+**ip_intf**
+-----------
+
+
+.. doxygenfile:: eos/ip_intf.h
+   :project: eossdk
+
diff --git a/docs/2.23.0/ref/_sources/ip_route.rst.txt b/docs/2.23.0/ref/_sources/ip_route.rst.txt
@@ -0,0 +1,13 @@
+**ip_route**
+------------
+
+
+.. doxygenfile:: eos/ip_route.h
+   :project: eossdk
+
+Type definitions in **ip_route**
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. doxygenfile:: eos/types/ip_route.h
+   :project: eossdk
+
diff --git a/docs/2.23.0/ref/_sources/iterator.rst.txt b/docs/2.23.0/ref/_sources/iterator.rst.txt
@@ -0,0 +1,7 @@
+**iterator**
+------------
+
+
+.. doxygenfile:: eos/iterator.h
+   :project: eossdk
+
diff --git a/docs/2.23.0/ref/_sources/lldp.rst.txt b/docs/2.23.0/ref/_sources/lldp.rst.txt
@@ -0,0 +1,13 @@
+**lldp**
+--------
+
+
+.. doxygenfile:: eos/lldp.h
+   :project: eossdk
+
+Type definitions in **lldp**
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. doxygenfile:: eos/types/lldp.h
+   :project: eossdk
+