:orphan:

.. index:: pair: group; Network Base configuration
.. _doxid-group__tapi__conf__base__net:

Network Base configuration
==========================

.. toctree::
	:hidden:

Overview
~~~~~~~~




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

	
	// global functions

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_base_ipv4_fw<doxid-group__tapi__conf__base__net_1ga14daf8b137e887a96e339a135eb817cc>`(const char* ta, bool enable);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_base_ipv4_fw_enabled<doxid-group__tapi__conf__base__net_1gac9c618efa5b78ff5d86d39a2b325525a>`(const char* ta, bool* enabled);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_ipv4_fw_set<doxid-group__tapi__conf__base__net_1gaaf916c044d2c35b787465ac5ff55ab9f>`(const char* ta, const char* ifname, bool enable);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_ipv4_fw_get<doxid-group__tapi__conf__base__net_1ga4992d3795ecfd8b7e5d5d6f7c8d7c198>`(const char* ta, const char* ifname, bool* enabled);
	static :ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_ipv4_fw_enable<doxid-group__tapi__conf__base__net_1ga27319ce10f0c70002afc0d8f080a6cee>`(const char* ta, const char* ifname);
	static :ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_ipv4_fw_disable<doxid-group__tapi__conf__base__net_1gafaf3c2d6426ce005d978862e8b3b536c>`(const char* ta, const char* ifname);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_ipv6_fw_set<doxid-group__tapi__conf__base__net_1ga66b94275be8095ff493d0e61e55efc98>`(const char* ta, const char* ifname, bool enable);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_ipv6_fw_get<doxid-group__tapi__conf__base__net_1ga164dd2b6c47f20bd6a2305ea653aec1a>`(const char* ta, const char* ifname, bool* enabled);
	static :ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_ipv6_fw_enable<doxid-group__tapi__conf__base__net_1ga100c242fc0baadac6ae9448b9de419ff>`(const char* ta, const char* ifname);
	static :ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_ipv6_fw_disable<doxid-group__tapi__conf__base__net_1gac86edbfdf56e87b172ab0612d9463168>`(const char* ta, const char* ifname);
	static :ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_base_ipv6_fw<doxid-group__tapi__conf__base__net_1gaf63c0465556741f2ed2a01bb1dff1966>`(const char* ta, bool enable);
	static :ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_base_ipv6_fw_enabled<doxid-group__tapi__conf__base__net_1ga48c7fb35600a39999577dead1f833929>`(const char* ta, bool* enabled);

	// macros

	#define :ref:`TAPI_CFG_IPVLAN_FLAG_BRIDGE<doxid-group__tapi__conf__base__net_1ga83698b1706676a25b07a9b83bd79ab89>`
	#define :ref:`TAPI_CFG_IPVLAN_FLAG_DEFAULT<doxid-group__tapi__conf__base__net_1ga964a99f341aeae13c6ac1f09e157b182>`
	#define :ref:`TAPI_CFG_IPVLAN_FLAG_PRIVATE<doxid-group__tapi__conf__base__net_1ga94c49433bc444455ed4a6c5e6f516f64>`
	#define :ref:`TAPI_CFG_IPVLAN_FLAG_VEPA<doxid-group__tapi__conf__base__net_1gaf70df3226b38cf89ccf7f74776f0f9a2>`
	#define :ref:`TAPI_CFG_IPVLAN_MODE_DEFAULT<doxid-group__tapi__conf__base__net_1ga3d6ac25330ad12d2a5887d84cbbf6783>`
	#define :ref:`TAPI_CFG_IPVLAN_MODE_L2<doxid-group__tapi__conf__base__net_1gae4f685d1beb5eac65002081aff998c3c>`
	#define :ref:`TAPI_CFG_IPVLAN_MODE_L3<doxid-group__tapi__conf__base__net_1ga1455c9ff685ed60292edd9ad93b31777>`
	#define :ref:`TAPI_CFG_IPVLAN_MODE_L3S<doxid-group__tapi__conf__base__net_1ga38e6e175dcd63587239b27b8ff026b5c>`
	#define :ref:`TAPI_CFG_MACVLAN_MODE_BRIDGE<doxid-group__tapi__conf__base__net_1gaa422d2cfc6992b9f87452aceceea54f8>`
	#define :ref:`TAPI_CFG_MACVLAN_MODE_PASSTHRU<doxid-group__tapi__conf__base__net_1ga497508034ffb41632db2f4371cfec64a>`
	#define :ref:`TAPI_CFG_MACVLAN_MODE_PRIVATE<doxid-group__tapi__conf__base__net_1gaf2df86ced96790ecc398a4e2758a5b7a>`
	#define :ref:`TAPI_CFG_MACVLAN_MODE_VEPA<doxid-group__tapi__conf__base__net_1gabfc25eec2c5d57bf7db8c0b0d250d5ac>`

.. _details-group__tapi__conf__base__net:

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



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

.. index:: pair: function; tapi_cfg_base_ipv4_fw
.. _doxid-group__tapi__conf__base__net_1ga14daf8b137e887a96e339a135eb817cc:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_cfg_base_ipv4_fw(const char* ta, bool enable)

Enable/disable IPv4 forwarding on a Test Agent.



.. rubric:: Parameters:

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

	*
		- ta

		- TA name

	*
		- enable

		- ``true`` - enable, ``false`` - disable



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_cfg_base_ipv4_fw_enabled
.. _doxid-group__tapi__conf__base__net_1gac9c618efa5b78ff5d86d39a2b325525a:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_cfg_base_ipv4_fw_enabled(const char* ta, bool* enabled)

Get IPv4 forwarding status on a Test Agent.



.. rubric:: Parameters:

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

	*
		- ta

		- TA name

	*
		- enabled

		- ``true`` - enabled, ``false`` - disabled



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_cfg_ipv4_fw_set
.. _doxid-group__tapi__conf__base__net_1gaaf916c044d2c35b787465ac5ff55ab9f:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_cfg_ipv4_fw_set(const char* ta, const char* ifname, bool enable)

Enable/disable IPv4 forwarding on a specified network interface



.. rubric:: Parameters:

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

	*
		- ta

		- TA name

	*
		- ifname

		- Name of network interface

	*
		- enable

		- ``true`` - enable, ``false`` - disable



.. rubric:: Returns:

Status code

.. index:: pair: function; tapi_cfg_ipv4_fw_get
.. _doxid-group__tapi__conf__base__net_1ga4992d3795ecfd8b7e5d5d6f7c8d7c198:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_cfg_ipv4_fw_get(const char* ta, const char* ifname, bool* enabled)

Get IPv4 forwarding status of a specified network interface



.. rubric:: Parameters:

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

	*
		- ta

		- TA name

	*
		- ifname

		- Name of network interface

	*
		- enabled

		- ``true`` - enabled, ``false`` - disabled



.. rubric:: Returns:

Status code

.. index:: pair: function; tapi_cfg_ipv4_fw_enable
.. _doxid-group__tapi__conf__base__net_1ga27319ce10f0c70002afc0d8f080a6cee:

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

	static :ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_cfg_ipv4_fw_enable(const char* ta, const char* ifname)

It's a wrapper for :ref:`tapi_cfg_ipv4_fw_set() <doxid-group__tapi__conf__base__net_1gaaf916c044d2c35b787465ac5ff55ab9f>` to enable IPv4 forwarding on a specified network interface

.. index:: pair: function; tapi_cfg_ipv4_fw_disable
.. _doxid-group__tapi__conf__base__net_1gafaf3c2d6426ce005d978862e8b3b536c:

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

	static :ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_cfg_ipv4_fw_disable(const char* ta, const char* ifname)

It's a wrapper for :ref:`tapi_cfg_ipv4_fw_set() <doxid-group__tapi__conf__base__net_1gaaf916c044d2c35b787465ac5ff55ab9f>` to disable IPv4 forwarding on a specified network interface

.. index:: pair: function; tapi_cfg_ipv6_fw_set
.. _doxid-group__tapi__conf__base__net_1ga66b94275be8095ff493d0e61e55efc98:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_cfg_ipv6_fw_set(const char* ta, const char* ifname, bool enable)

Enable/disable IPv6 forwarding on a specified network interface



.. rubric:: Parameters:

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

	*
		- ta

		- TA name

	*
		- ifname

		- Name of network interface

	*
		- enable

		- ``true`` - enable, ``false`` - disable



.. rubric:: Returns:

Status code

.. index:: pair: function; tapi_cfg_ipv6_fw_get
.. _doxid-group__tapi__conf__base__net_1ga164dd2b6c47f20bd6a2305ea653aec1a:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_cfg_ipv6_fw_get(const char* ta, const char* ifname, bool* enabled)

Get IPv6 forwarding status of a specified network interface



.. rubric:: Parameters:

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

	*
		- ta

		- TA name

	*
		- ifname

		- Name of network interface

	*
		- enabled

		- ``true`` - enabled, ``false`` - disabled



.. rubric:: Returns:

Status code

.. index:: pair: function; tapi_cfg_ipv6_fw_enable
.. _doxid-group__tapi__conf__base__net_1ga100c242fc0baadac6ae9448b9de419ff:

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

	static :ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_cfg_ipv6_fw_enable(const char* ta, const char* ifname)

It's a wrapper for :ref:`tapi_cfg_ipv6_fw_set() <doxid-group__tapi__conf__base__net_1ga66b94275be8095ff493d0e61e55efc98>` to enable IPv6 forwarding on a specified network interface

.. index:: pair: function; tapi_cfg_ipv6_fw_disable
.. _doxid-group__tapi__conf__base__net_1gac86edbfdf56e87b172ab0612d9463168:

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

	static :ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_cfg_ipv6_fw_disable(const char* ta, const char* ifname)

It's a wrapper for :ref:`tapi_cfg_ipv6_fw_set() <doxid-group__tapi__conf__base__net_1ga66b94275be8095ff493d0e61e55efc98>` to disable IPv6 forwarding on a specified network interface

.. index:: pair: function; tapi_cfg_base_ipv6_fw
.. _doxid-group__tapi__conf__base__net_1gaf63c0465556741f2ed2a01bb1dff1966:

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

	static :ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_cfg_base_ipv6_fw(const char* ta, bool enable)

It's a wrapper for :ref:`tapi_cfg_ipv6_fw_set() <doxid-group__tapi__conf__base__net_1ga66b94275be8095ff493d0e61e55efc98>` to enable/disable IPv6 forwarding on a Test Agent. It sets forwarding to the interface "all".

.. index:: pair: function; tapi_cfg_base_ipv6_fw_enabled
.. _doxid-group__tapi__conf__base__net_1ga48c7fb35600a39999577dead1f833929:

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

	static :ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_cfg_base_ipv6_fw_enabled(const char* ta, bool* enabled)

It's a wrapper for :ref:`tapi_cfg_ipv6_fw_get() <doxid-group__tapi__conf__base__net_1ga164dd2b6c47f20bd6a2305ea653aec1a>` to get IPv6 forwarding status on a Test Agent, i.e. forwarding status of the interface "all".

Macros
------

.. index:: pair: define; TAPI_CFG_IPVLAN_FLAG_BRIDGE
.. _doxid-group__tapi__conf__base__net_1ga83698b1706676a25b07a9b83bd79ab89:

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

	#define TAPI_CFG_IPVLAN_FLAG_BRIDGE

IP VLAN interface flag bridge

.. index:: pair: define; TAPI_CFG_IPVLAN_FLAG_DEFAULT
.. _doxid-group__tapi__conf__base__net_1ga964a99f341aeae13c6ac1f09e157b182:

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

	#define TAPI_CFG_IPVLAN_FLAG_DEFAULT

IP VLAN default flag value

.. index:: pair: define; TAPI_CFG_IPVLAN_FLAG_PRIVATE
.. _doxid-group__tapi__conf__base__net_1ga94c49433bc444455ed4a6c5e6f516f64:

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

	#define TAPI_CFG_IPVLAN_FLAG_PRIVATE

IP VLAN interface flag private

.. index:: pair: define; TAPI_CFG_IPVLAN_FLAG_VEPA
.. _doxid-group__tapi__conf__base__net_1gaf70df3226b38cf89ccf7f74776f0f9a2:

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

	#define TAPI_CFG_IPVLAN_FLAG_VEPA

IP VLAN interface flag vepa

.. index:: pair: define; TAPI_CFG_IPVLAN_MODE_DEFAULT
.. _doxid-group__tapi__conf__base__net_1ga3d6ac25330ad12d2a5887d84cbbf6783:

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

	#define TAPI_CFG_IPVLAN_MODE_DEFAULT

IP VLAN default mode value

.. index:: pair: define; TAPI_CFG_IPVLAN_MODE_L2
.. _doxid-group__tapi__conf__base__net_1gae4f685d1beb5eac65002081aff998c3c:

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

	#define TAPI_CFG_IPVLAN_MODE_L2

IP VLAN interface mode l2

.. index:: pair: define; TAPI_CFG_IPVLAN_MODE_L3
.. _doxid-group__tapi__conf__base__net_1ga1455c9ff685ed60292edd9ad93b31777:

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

	#define TAPI_CFG_IPVLAN_MODE_L3

IP VLAN interface mode l3

.. index:: pair: define; TAPI_CFG_IPVLAN_MODE_L3S
.. _doxid-group__tapi__conf__base__net_1ga38e6e175dcd63587239b27b8ff026b5c:

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

	#define TAPI_CFG_IPVLAN_MODE_L3S

IP VLAN interface mode l3s

.. index:: pair: define; TAPI_CFG_MACVLAN_MODE_BRIDGE
.. _doxid-group__tapi__conf__base__net_1gaa422d2cfc6992b9f87452aceceea54f8:

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

	#define TAPI_CFG_MACVLAN_MODE_BRIDGE

MAC VLAN interface mode: talk to bridge ports directly.

.. index:: pair: define; TAPI_CFG_MACVLAN_MODE_PASSTHRU
.. _doxid-group__tapi__conf__base__net_1ga497508034ffb41632db2f4371cfec64a:

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

	#define TAPI_CFG_MACVLAN_MODE_PASSTHRU

MAC VLAN interface mode: take over the underlying device.

.. index:: pair: define; TAPI_CFG_MACVLAN_MODE_PRIVATE
.. _doxid-group__tapi__conf__base__net_1gaf2df86ced96790ecc398a4e2758a5b7a:

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

	#define TAPI_CFG_MACVLAN_MODE_PRIVATE

MAC VLAN interface mode: don't talk to other macvlans.

.. index:: pair: define; TAPI_CFG_MACVLAN_MODE_VEPA
.. _doxid-group__tapi__conf__base__net_1gabfc25eec2c5d57bf7db8c0b0d250d5ac:

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

	#define TAPI_CFG_MACVLAN_MODE_VEPA

MAC VLAN interface mode: talk to other ports through ext bridge.