:orphan:

.. index:: pair: group; Tunnel configuration
.. _doxid-group__tapi__conf__tunnel:

Tunnel configuration
====================

.. toctree::
	:hidden:

	enum_tapi_cfg_tunnel_type.rst
	struct_tapi_cfg_tunnel.rst
	struct_tapi_cfg_tunnel_vxlan.rst

Overview
~~~~~~~~

Definition of TAPI to configure tunnel. :ref:`More...<details-group__tapi__conf__tunnel>`


.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	
	// typedefs

	typedef enum :ref:`tapi_cfg_tunnel_type<doxid-group__tapi__conf__tunnel_1ga54d7e435dc8c58714f1ad61c3f6a48e8>` :ref:`tapi_cfg_tunnel_type<doxid-group__tapi__conf__tunnel_1gae437f135fdc675663c5bf70cce85ffd0>`;
	typedef struct :ref:`tapi_cfg_tunnel_vxlan<doxid-structtapi__cfg__tunnel__vxlan>` :target:`tapi_cfg_tunnel_vxlan<doxid-group__tapi__conf__tunnel_1ga47e5a6370b40b989ee874f8974e209a6>`;
	typedef struct :ref:`tapi_cfg_tunnel<doxid-structtapi__cfg__tunnel>` :ref:`tapi_cfg_tunnel<doxid-group__tapi__conf__tunnel_1ga62d4a51acac94174f33dbda36c84a3e2>`;

	// enums

	enum :ref:`tapi_cfg_tunnel_type<doxid-group__tapi__conf__tunnel_1ga54d7e435dc8c58714f1ad61c3f6a48e8>`;

	// structs

	struct :ref:`tapi_cfg_tunnel<doxid-structtapi__cfg__tunnel>`;
	struct :ref:`tapi_cfg_tunnel_vxlan<doxid-structtapi__cfg__tunnel__vxlan>`;

	// global functions

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_tunnel_add<doxid-group__tapi__conf__tunnel_1gad7211a72bfba062890e88a6c6c820ec8>`(const char* ta, const :ref:`tapi_cfg_tunnel<doxid-structtapi__cfg__tunnel>`* conf);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_tunnel_enable<doxid-group__tapi__conf__tunnel_1ga32336f03040a3e58482c56fac99ddb8c>`(const char* ta, const :ref:`tapi_cfg_tunnel<doxid-structtapi__cfg__tunnel>`* conf);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_tunnel_disable<doxid-group__tapi__conf__tunnel_1gaf18d9ec197fa2210ec47b85c03933cc4>`(const char* ta, const :ref:`tapi_cfg_tunnel<doxid-structtapi__cfg__tunnel>`* conf);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_tunnel_del<doxid-group__tapi__conf__tunnel_1ga8490f20c818d0a6256969abf7d7e0c66>`(const char* ta, const char* tunnel_name);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_tunnel_get<doxid-group__tapi__conf__tunnel_1gaabbd273cea5e3d817144fed4a8ec3c0b>`(const char* ta, const char* tunnel_name, :ref:`tapi_cfg_tunnel<doxid-structtapi__cfg__tunnel>`* conf);

.. _details-group__tapi__conf__tunnel:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~

Definition of TAPI to configure tunnel.

Typedefs
--------

.. index:: pair: typedef; tapi_cfg_tunnel_type
.. _doxid-group__tapi__conf__tunnel_1gae437f135fdc675663c5bf70cce85ffd0:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	typedef enum :ref:`tapi_cfg_tunnel_type<doxid-group__tapi__conf__tunnel_1ga54d7e435dc8c58714f1ad61c3f6a48e8>` tapi_cfg_tunnel_type

List of supported tunnels

.. index:: pair: typedef; tapi_cfg_tunnel
.. _doxid-group__tapi__conf__tunnel_1ga62d4a51acac94174f33dbda36c84a3e2:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	typedef struct :ref:`tapi_cfg_tunnel<doxid-structtapi__cfg__tunnel>` tapi_cfg_tunnel

Tunnel configuration

Global Functions
----------------

.. index:: pair: function; tapi_cfg_tunnel_add
.. _doxid-group__tapi__conf__tunnel_1gad7211a72bfba062890e88a6c6c820ec8:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_cfg_tunnel_add(const char* ta, const :ref:`tapi_cfg_tunnel<doxid-structtapi__cfg__tunnel>`* conf)

Add tunnel interface.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- ta

		- Test Agent.

	*
		- conf

		- Tunnel configuration.



.. rubric:: Returns:

Status code

.. index:: pair: function; tapi_cfg_tunnel_enable
.. _doxid-group__tapi__conf__tunnel_1ga32336f03040a3e58482c56fac99ddb8c:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_cfg_tunnel_enable(const char* ta, const :ref:`tapi_cfg_tunnel<doxid-structtapi__cfg__tunnel>`* conf)

Enable tunnel.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- ta

		- Test Agent.

	*
		- conf

		- Tunnel configuration.



.. rubric:: Returns:

Status code

.. index:: pair: function; tapi_cfg_tunnel_disable
.. _doxid-group__tapi__conf__tunnel_1gaf18d9ec197fa2210ec47b85c03933cc4:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_cfg_tunnel_disable(const char* ta, const :ref:`tapi_cfg_tunnel<doxid-structtapi__cfg__tunnel>`* conf)

Disable tunnel.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- ta

		- Test Agent.

	*
		- conf

		- Tunnel configuration.



.. rubric:: Returns:

Status code

.. index:: pair: function; tapi_cfg_tunnel_del
.. _doxid-group__tapi__conf__tunnel_1ga8490f20c818d0a6256969abf7d7e0c66:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_cfg_tunnel_del(const char* ta, const char* tunnel_name)

Delete tunnel.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- ta

		- Test Agent.

	*
		- tunnel_name

		- Tunnel name.



.. rubric:: Returns:

Status code

.. index:: pair: function; tapi_cfg_tunnel_get
.. _doxid-group__tapi__conf__tunnel_1gaabbd273cea5e3d817144fed4a8ec3c0b:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_cfg_tunnel_get(const char* ta, const char* tunnel_name, :ref:`tapi_cfg_tunnel<doxid-structtapi__cfg__tunnel>`* conf)

Get tunnel configuration information.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- ta

		- Test Agent.

	*
		- tunnel_name

		- Tunnel name.

	*
		- conf

		- Pointer of tunnel configuration to store.



.. rubric:: Returns:

Status code