:orphan: .. index:: pair: group; iptables configuration .. _doxid-group__tapi__conf__iptable: iptables configuration ====================== .. toctree:: :hidden: Overview ~~~~~~~~ .. ref-code-block:: cpp :class: doxyrest-overview-code-block // global functions :ref:`te_errno` :ref:`tapi_cfg_iptables_cmd`(const char* ta, const char* ifname, unsigned int af, const char* table, const char* chain, const char* rule); :ref:`te_errno` :ref:`tapi_cfg_iptables_cmd_fmt`(const char* ta, const char* ifname, unsigned int af, const char* table, const char* chain, const char* rule, ...); :ref:`te_errno` :ref:`tapi_cfg_iptables_rules`(const char* ta, const char* ifname, unsigned int af, const char* table, const char* chain, const char* rules); :ref:`te_errno` :ref:`tapi_cfg_iptables_rules_fmt`(const char* ta, const char* ifname, unsigned int af, const char* table, const char* chain, const char* rules, ...); :ref:`te_errno` :ref:`tapi_cfg_iptables_chain_set`(const char* ta, const char* ifname, unsigned int af, const char* table, const char* chain, bool enable); :ref:`te_errno` :ref:`tapi_cfg_iptables_chain_add`(const char* ta, const char* ifname, unsigned int af, const char* table, const char* chain, bool enable); :ref:`te_errno` :ref:`tapi_cfg_iptables_chain_del`(const char* ta, const char* ifname, unsigned int af, const char* table, const char* chain); // macros #define :target:`TAPI_CFG_IPTABLES_CMD_LEN_MAX` .. _details-group__tapi__conf__iptable: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ Global Functions ---------------- .. index:: pair: function; tapi_cfg_iptables_cmd .. _doxid-group__tapi__conf__iptable_1ga414470c33b712b0379ef0b7c0f1bd358: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_iptables_cmd(const char* ta, const char* ifname, unsigned int af, const char* table, const char* chain, const char* rule) Execute an iptables rule for the specific chain .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - - Test agent name * - ifname - - Interface name * - table - - Table to operate with (raw, filter, mangle, nat) * - chain - - Chain name to operate with (without prefix) * - rule - - Rule to add .. rubric:: Returns: Status of the operation .. index:: pair: function; tapi_cfg_iptables_cmd_fmt .. _doxid-group__tapi__conf__iptable_1gab2b1667921fe92f21c7c4af008fca481: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_iptables_cmd_fmt(const char* ta, const char* ifname, unsigned int af, const char* table, const char* chain, const char* rule, ...) Execute an iptables rule for the specific chain. The rule is specified using a format string with arguments. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - - Test agent name * - ifname - - Interface name * - table - - Table to operate with (raw, filter, mangle, nat) * - chain - - Chain name to operate with (without prefix) * - rule - - Formatted argument to combine the rule .. rubric:: Returns: Status of the operation .. index:: pair: function; tapi_cfg_iptables_rules .. _doxid-group__tapi__conf__iptable_1ga8e38bd563db6261efc2b51e934cc8c2e: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_iptables_rules(const char* ta, const char* ifname, unsigned int af, const char* table, const char* chain, const char* rules) Set iptables rules for the specified chain .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test agent name. * - ifname - Interface name. * - af - Address family. * - table - Table to operate with (raw, filter, mangle, nat). * - chain - Chain name to operate with (without prefix). * - rules - Rules to add. .. rubric:: Returns: Status of the operation. .. index:: pair: function; tapi_cfg_iptables_rules_fmt .. _doxid-group__tapi__conf__iptable_1gaf8ef9ff612003f5ffdb5919bb96db076: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_iptables_rules_fmt(const char* ta, const char* ifname, unsigned int af, const char* table, const char* chain, const char* rules, ...) Set iptables rules for the specified chain. The rules are specified using a format string with arguments. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test agent name. * - ifname - Interface name. * - af - Address family. * - table - Table to operate with (raw, filter, mangle, nat). * - chain - Chain name to operate with (without prefix). * - rules - Rules to add. .. rubric:: Returns: Status of the operation. .. index:: pair: function; tapi_cfg_iptables_chain_set .. _doxid-group__tapi__conf__iptable_1ga71e4c31800a9bfed01831b4a9303c87e: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_iptables_chain_set(const char* ta, const char* ifname, unsigned int af, const char* table, const char* chain, bool enable) Install or delete jumping rule for the per-interface chain .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - - Test agent name * - ifname - - Interface name * - table - - Table to operate with (raw, filter, mangle, nat) * - chain - - Chain name to operate with (without prefix) * - enable - - Install or delete jumping rule .. rubric:: Returns: Status of the operation .. index:: pair: function; tapi_cfg_iptables_chain_add .. _doxid-group__tapi__conf__iptable_1ga4d70a670018022a563d6d041f191f433: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_iptables_chain_add(const char* ta, const char* ifname, unsigned int af, const char* table, const char* chain, bool enable) Add per-interface chain to the system .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - - Test agent name * - ifname - - Interface name * - table - - Table to operate with (raw, filter, mangle, nat) * - chain - - Chain name to operate with (without prefix) * - enable - - Install or not jumping rule to the built-in chain .. rubric:: Returns: Status of the operation .. index:: pair: function; tapi_cfg_iptables_chain_del .. _doxid-group__tapi__conf__iptable_1gaaa912f0a9e54cb03b42b30caecc86a72: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_iptables_chain_del(const char* ta, const char* ifname, unsigned int af, const char* table, const char* chain) Delete per-interface chain from the system .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - - Test agent name * - ifname - - Interface name * - table - - Table to operate with (raw, filter, mangle, nat) * - chain - - Chain name to operate with (without prefix) .. rubric:: Returns: Status of the operation