:orphan:

.. index:: pair: group; IP rules configuration
.. _doxid-group__tapi__conf__ip__rule:

IP rules configuration
======================

.. toctree::
	:hidden:

	struct_tapi_rt_ip_rule_entry.rst

Overview
~~~~~~~~

Copyright (C) 2004-2022 OKTET Labs Ltd. :ref:`More...<details-group__tapi__conf__ip__rule>`


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

	
	// typedefs

	typedef struct :ref:`tapi_rt_ip_rule_entry<doxid-structtapi__rt__ip__rule__entry>` :ref:`tapi_rt_ip_rule_entry<doxid-group__tapi__conf__ip__rule_1ga17fd13ef1d57228a7b1428334abca115>`;

	// structs

	struct :ref:`tapi_rt_ip_rule_entry<doxid-structtapi__rt__ip__rule__entry>`;

	// global functions

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_get_rule_table<doxid-group__tapi__conf__ip__rule_1gacefcb9506667ada33fedf3b540f51867>`(const char* ta, int addr_family, :ref:`tapi_rt_ip_rule_entry<doxid-structtapi__rt__ip__rule__entry>`** tbl, unsigned int* n);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_add_rule<doxid-group__tapi__conf__ip__rule_1ga128bee4ae8496aa333845c5fbf7f2001>`(const char* ta, int addr_family, :ref:`te_conf_ip_rule<doxid-structte__conf__ip__rule>`* ip_rule);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_del_rule<doxid-group__tapi__conf__ip__rule_1ga76964ed2adc11e85c1f9bc8e1dd53430>`(const char* ta, int addr_family, uint32_t required, :ref:`te_conf_ip_rule<doxid-structte__conf__ip__rule>`* ip_rule);

.. _details-group__tapi__conf__ip__rule:

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

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

Typedefs
--------

.. index:: pair: typedef; tapi_rt_ip_rule_entry
.. _doxid-group__tapi__conf__ip__rule_1ga17fd13ef1d57228a7b1428334abca115:

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

	typedef struct :ref:`tapi_rt_ip_rule_entry<doxid-structtapi__rt__ip__rule__entry>` tapi_rt_ip_rule_entry

Entry to keep ip rule data

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

.. index:: pair: function; tapi_cfg_get_rule_table
.. _doxid-group__tapi__conf__ip__rule_1gacefcb9506667ada33fedf3b540f51867:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_cfg_get_rule_table(const char* ta, int addr_family, :ref:`tapi_rt_ip_rule_entry<doxid-structtapi__rt__ip__rule__entry>`** tbl, unsigned int* n)

Get routing policy database by the specified Test Agent

Function allocates memory with **malloc()**, which should be free by the caller.



.. rubric:: Parameters:

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

	*
		- ta

		- Test Agent name

	*
		- addr_family

		- Address family of the rules (``AF_INET``)

	*
		- tbl

		- Pointer to the routing policy database

	*
		- n

		- The number of entries in the ``tbl``



.. rubric:: Returns:

Status code

.. index:: pair: function; tapi_cfg_add_rule
.. _doxid-group__tapi__conf__ip__rule_1ga128bee4ae8496aa333845c5fbf7f2001:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_cfg_add_rule(const char* ta, int addr_family, :ref:`te_conf_ip_rule<doxid-structte__conf__ip__rule>`* ip_rule)

Add new rule into routing policy database



.. rubric:: Parameters:

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

	*
		- ta

		- Test Agent name

	*
		- addr_family

		- Address family of the rules (``AF_INET``)

	*
		- ip_rule

		- Rule for adding



.. rubric:: Returns:

Status code

.. index:: pair: function; tapi_cfg_del_rule
.. _doxid-group__tapi__conf__ip__rule_1ga76964ed2adc11e85c1f9bc8e1dd53430:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_cfg_del_rule(const char* ta, int addr_family, uint32_t required, :ref:`te_conf_ip_rule<doxid-structte__conf__ip__rule>`* ip_rule)

Delete the first existing rule from routing policy database



.. rubric:: Parameters:

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

	*
		- ta

		- Test Agent name

	*
		- addr_family

		- Address family of the rules (``AF_INET``)

	*
		- required

		- Required fields for a rule search

	*
		- ip_rule

		- Data to find and delete rule



.. rubric:: Returns:

Status code