:orphan:

.. index:: pair: group; High level TAPI to configure network
.. _doxid-group__ts__tapi__network:

High level TAPI to configure network
====================================

.. toctree::
	:hidden:

Overview
~~~~~~~~

This API can be used to set up network configurations like resources reservation, assigning IP addresses etc with minimum efforts. :ref:`More...<details-group__ts__tapi__network>`


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

	
	// global functions

	void :ref:`tapi_network_setup<doxid-group__ts__tapi__network_1gaf300bf00bd986286ad67a5456700178b>`(bool ipv6_supp);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_neight_flush<doxid-group__ts__tapi__network_1gae15c43f4fbe95a7fc6b4264f4c4a1a23>`(:ref:`rcf_rpc_server<doxid-structrcf__rpc__server>`* rpcs, const char* ifname);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_neight_flush_ta<doxid-group__ts__tapi__network_1gae3f71166409d0b18b1eeac2b0a583587>`(:ref:`rcf_rpc_server<doxid-structrcf__rpc__server>`* rpcs);

.. _details-group__ts__tapi__network:

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

This API can be used to set up network configurations like resources reservation, assigning IP addresses etc with minimum efforts.

Copyright (C) 2004-2022 OKTET Labs Ltd. All rights reserved.

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

.. index:: pair: function; tapi_network_setup
.. _doxid-group__ts__tapi__network_1gaf300bf00bd986286ad67a5456700178b:

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

	void tapi_network_setup(bool ipv6_supp)

Reserve resources, set IP addresses and static ARP (if required) in accordance to the current Configurator configuration.

The function jumps to **cleanup** in case of failure.



.. rubric:: Parameters:

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

	*
		- ipv6_supp

		- ``true`` if IPv6 addressing is supported.

.. index:: pair: function; tapi_neight_flush
.. _doxid-group__ts__tapi__network_1gae15c43f4fbe95a7fc6b4264f4c4a1a23:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_neight_flush(:ref:`rcf_rpc_server<doxid-structrcf__rpc__server>`* rpcs, const char* ifname)

Flush ARP table for the interface ``ifname``.



.. rubric:: Parameters:

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

	*
		- rpcs

		- RPC server handle

	*
		- ifname

		- Interface name



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_neight_flush_ta
.. _doxid-group__ts__tapi__network_1gae3f71166409d0b18b1eeac2b0a583587:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_neight_flush_ta(:ref:`rcf_rpc_server<doxid-structrcf__rpc__server>`* rpcs)

Flush ARP table for all interfaces on test agent ``rpcs->ta``.



.. rubric:: Parameters:

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

	*
		- rpcs

		- RPC server handle



.. rubric:: Returns:

Status code.