:orphan: .. index:: pair: group; Agent namespaces configuration .. _doxid-group__tapi__namespaces: Agent namespaces configuration ============================== .. toctree:: :hidden: Overview ~~~~~~~~ Definition of test API for linux namespaces configuration model (``doc/cm/cm_namespace.xml``). :ref:`More...` .. ref-code-block:: cpp :class: doxyrest-overview-code-block // global functions :ref:`te_errno` :ref:`tapi_netns_add_rsrc`(const char* ta, const char* ns_name); :ref:`te_errno` :ref:`tapi_netns_del_rsrc`(const char* ta, const char* ns_name); :ref:`te_errno` :ref:`tapi_netns_add`(const char* ta, const char* ns_name); :ref:`te_errno` :ref:`tapi_netns_del`(const char* ta, const char* ns_name); :ref:`te_errno` :ref:`tapi_netns_if_set`(const char* ta, const char* ns_name, const char* if_name); :ref:`te_errno` :ref:`tapi_netns_if_unset`(const char* ta, const char* ns_name, const char* if_name); :ref:`te_errno` :ref:`tapi_netns_create_ns_with_net_channel`(const char* ta, const char* ns_name, const char* veth1, const char* veth2, const char* ctl_if, int rcfport); :ref:`te_errno` :ref:`tapi_netns_add_ta`(const char* host, const char* ns_name, const char* ta_name, const char* ta_type, int rcfport, const char* ta_conn, const char* ld_preload, bool ext_rcf_listener); :ref:`te_errno` :ref:`tapi_netns_create_ns_with_macvlan`(const char* ta, const char* ns_name, const char* ctl_if, const char* macvlan_if, char* addr, size_t addr_len); :ref:`te_errno` :ref:`tapi_netns_destroy_ns_with_macvlan`(const char* ta, const char* ns_name, const char* ctl_if, const char* macvlan_if); :ref:`te_errno` :ref:`tapi_netns_create_ns_with_ipvlan`(const char* ta, const char* ns_name, const char* ctl_if, const char* ipvlan_if, char* addr, size_t addr_len); :ref:`te_errno` :ref:`tapi_netns_destroy_ns_with_ipvlan`(const char* ta, const char* ns_name, const char* ctl_if, const char* ipvlan_if); .. _details-group__tapi__namespaces: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ Definition of test API for linux namespaces configuration model (``doc/cm/cm_namespace.xml``). Copyright (C) 2004-2022 OKTET Labs Ltd. All rights reserved. Global Functions ---------------- .. index:: pair: function; tapi_netns_add_rsrc .. _doxid-group__tapi__namespaces_1ga021d91b7d468b07d15256ed5f9d4f195: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_netns_add_rsrc(const char* ta, const char* ns_name) Add network namespace ``ns_name`` to the agent ``ta`` resources. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_netns_del_rsrc .. _doxid-group__tapi__namespaces_1gabb180f926531498dbf330d4d3b7af3ac: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_netns_del_rsrc(const char* ta, const char* ns_name) Delete network namespace ``ns_name`` from the agent ``ta`` resources. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_netns_add .. _doxid-group__tapi__namespaces_1ga41ee81ac4384d5b772894642cc5c7671: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_netns_add(const char* ta, const char* ns_name) Add network namespace ``ns_name`` to agent ``ta`` and grab it as the resource. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_netns_del .. _doxid-group__tapi__namespaces_1ga7a60e53ffbd0a98c77f2b685d99cce8d: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_netns_del(const char* ta, const char* ns_name) Delete network namespace ``ns_name`` from the agent ``ta`` and from its reources. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_netns_if_set .. _doxid-group__tapi__namespaces_1gab616b68ab601ea172cde1f36428795b0: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_netns_if_set(const char* ta, const char* ns_name, const char* if_name) Move network interface ``if_name`` to namespace ``ns_name``. Status code. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test agent. * - ns_name - The namespace name. * - if_name - The interface name. .. index:: pair: function; tapi_netns_if_unset .. _doxid-group__tapi__namespaces_1ga9bd3d9dd9b96542868d7176dea1f4809: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_netns_if_unset(const char* ta, const char* ns_name, const char* if_name) Move network interface ``if_name`` from namespace ``ns_name``. Status code. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test agent. * - ns_name - The namespace name. * - if_name - The interface name. .. index:: pair: function; tapi_netns_create_ns_with_net_channel .. _doxid-group__tapi__namespaces_1gad617211e067a647d0730f2f1b73bff38: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_netns_create_ns_with_net_channel(const char* ta, const char* ns_name, const char* veth1, const char* veth2, const char* ctl_if, int rcfport) Create network namespace and configure control network channel using veth interfaces and iptables to route control traffic. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test agent name * - ns_name - The network namespace name * - veth1 - Veth interface name * - veth2 - Veth interface peer name * - ctl_if - Control interface name on the test agent * - rcfport - Port number to communicate with RCF .. rubric:: Returns: Status code. .. index:: pair: function; tapi_netns_add_ta .. _doxid-group__tapi__namespaces_1ga4b171c8ebe701afd20d0a17c16d912b4: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_netns_add_ta(const char* host, const char* ns_name, const char* ta_name, const char* ta_type, int rcfport, const char* ta_conn, const char* ld_preload, bool ext_rcf_listener) Add new test agent located in the specified network namespace ``ns_name``. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - host - The target hostname * - ns_name - The network namespace name * - ta_name - The test agent name * - ta_type - The test agent type * - rcfport - Port number to communicate with RCF * - ta_conn - Connection hostname or address or ``NULL`` * - ld_preload - The ``LD_PRELOAD`` variable or ``NULL`` * - ext_rcf_listener - If ``true``, create listener socket for accepting RCF connection before exec(ta). Such socket will be able to accept connections via interfaces from default network namespace, no additional routes or interfaces in the new namespace will be required. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_netns_create_ns_with_macvlan .. _doxid-group__tapi__namespaces_1gae4d4c5c946acf8d4f36986c3a7352a85: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_netns_create_ns_with_macvlan(const char* ta, const char* ns_name, const char* ctl_if, const char* macvlan_if, char* addr, size_t addr_len) Create network namespace and configure control network channel using auxiliary macvlan interface. IP address is obtained using **dhclient**. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test agent name * - ns_name - The network namespace name * - ctl_if - Control interface name on the test agent * - macvlan_if - MAC VLAN interface name * - addr - Obtained IP address * - addr_len - Length of the buffer ``addr`` .. rubric:: Returns: Status code. .. index:: pair: function; tapi_netns_destroy_ns_with_macvlan .. _doxid-group__tapi__namespaces_1ga1b94e2b0bab72a524fb756ddede3f26c: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_netns_destroy_ns_with_macvlan(const char* ta, const char* ns_name, const char* ctl_if, const char* macvlan_if) Destroy network namespace and undo other configurations applied by function :ref:`tapi_netns_create_ns_with_macvlan() `. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test agent name * - ns_name - The network namespace name * - ctl_if - Control interface name on the test agent * - macvlan_if - MAC VLAN interface name .. rubric:: Returns: Status code. .. index:: pair: function; tapi_netns_create_ns_with_ipvlan .. _doxid-group__tapi__namespaces_1gaa59ac98ef70494ef897b30dbe8e7598d: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_netns_create_ns_with_ipvlan(const char* ta, const char* ns_name, const char* ctl_if, const char* ipvlan_if, char* addr, size_t addr_len) Create network namespace and configure control network channel using auxiliary ipvlan interface. IP address is obtained using **dhclient**. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test agent name * - ns_name - The network namespace name * - ctl_if - Control interface name on the test agent * - ipvlan_if - IP VLAN interface name * - addr - Obtained IP address * - addr_len - Length of the buffer ``addr`` .. rubric:: Returns: Status code. .. index:: pair: function; tapi_netns_destroy_ns_with_ipvlan .. _doxid-group__tapi__namespaces_1gaf8b9c7d0e575f965ec2dcd6924553c4f: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_netns_destroy_ns_with_ipvlan(const char* ta, const char* ns_name, const char* ctl_if, const char* ipvlan_if) Destroy network namespace and undo other configurations applied by function :ref:`tapi_netns_create_ns_with_ipvlan() `. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test agent name * - ns_name - The network namespace name * - ctl_if - Control interface name on the test agent * - ipvlan_if - IP VLAN interface name .. rubric:: Returns: Status code.