:orphan: .. index:: pair: group; Agents, namespaces and interfaces relations .. _doxid-group__tapi__host__ns: Agents, namespaces and interfaces relations =========================================== .. toctree:: :hidden: Overview ~~~~~~~~ Definition of test API to manage the configurator subtree ``/local/host``. :ref:`More...` .. ref-code-block:: cpp :class: doxyrest-overview-code-block // typedefs typedef :ref:`te_errno` (*:ref:`tapi_host_ns_if_cb_func`)( const char *ta, const char *ifname, void *opaque ); // global functions bool :ref:`tapi_host_ns_enabled`(void); :ref:`te_errno` :ref:`tapi_host_ns_get_host`(const char* ta, char** host); :ref:`te_errno` :ref:`tapi_host_ns_agent_add`(const char* host, const char* ta, const char* netns); :ref:`te_errno` :ref:`tapi_host_ns_agent_del`(const char* ta); :ref:`te_errno` :ref:`tapi_host_ns_if_add`(const char* ta, const char* ifname, const char* parent_ifname); :ref:`te_errno` :ref:`tapi_host_ns_if_del`(const char* ta, const char* ifname, bool del_refs); :ref:`te_errno` :ref:`tapi_host_ns_if_parent_add`(const char* ta, const char* ifname, const char* parent_ta, const char* parent_ifname); :ref:`te_errno` :ref:`tapi_host_ns_if_parent_del`(const char* ta, const char* ifname, const char* parent_ta, const char* parent_ifname); :ref:`te_errno` :ref:`tapi_host_ns_if_change_ns`(const char* ta, const char* ifname, const char* ns_name, const char* ns_ta); :ref:`te_errno` :ref:`tapi_host_ns_if_child_iter`(const char* ta, const char* ifname, :ref:`tapi_host_ns_if_cb_func` cb, void* opaque); :ref:`te_errno` :ref:`tapi_host_ns_if_parent_iter`(const char* ta, const char* ifname, :ref:`tapi_host_ns_if_cb_func` cb, void* opaque); :ref:`te_errno` :ref:`tapi_host_ns_if_ta_iter`(const char* ta, :ref:`tapi_host_ns_if_cb_func` cb, void* opaque); :ref:`te_errno` :ref:`tapi_host_ns_if_host_iter`(const char* host, :ref:`tapi_host_ns_if_cb_func` cb, void* opaque); :ref:`te_errno` :ref:`tapi_host_ns_agent_default`(const char* ta, char** ta_default); .. _details-group__tapi__host__ns: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ Definition of test API to manage the configurator subtree ``/local/host``. (``storage/cm/cm_local.xml``) Copyright (C) 2004-2022 OKTET Labs Ltd. All rights reserved. Typedefs -------- .. index:: pair: typedef; tapi_host_ns_if_cb_func .. _doxid-group__tapi__host__ns_1gae96d4a84b7be6c07d76aeb0e3aba3ae9: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef :ref:`te_errno` (*tapi_host_ns_if_cb_func)( const char *ta, const char *ifname, void *opaque ) Type of callback function which can be passed to :ref:`tapi_host_ns_if_child_iter() ` or :ref:`tapi_host_ns_if_parent_iter() `. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test agent name * - ifname - Interface name * - opaque - Opaque user data .. rubric:: Returns: Status code. Also see :ref:`tapi_host_ns_if_child_iter() ` and :ref:`tapi_host_ns_if_parent_iter() ` description for details. Global Functions ---------------- .. index:: pair: function; tapi_host_ns_enabled .. _doxid-group__tapi__host__ns_1ga4f9b9f65ba5d1c0db8a82130021f5acb: .. ref-code-block:: cpp :class: doxyrest-title-code-block bool tapi_host_ns_enabled(void) Consider this API is enabled if Configurator object **/local/host** is registered. .. rubric:: Returns: ``true`` if the test API is enabled. .. index:: pair: function; tapi_host_ns_get_host .. _doxid-group__tapi__host__ns_1ga6cfa1f512cb289e0c02e0fb3513a7730: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_host_ns_get_host(const char* ta, char** host) Get hostname of test agent ``ta``. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test agent name * - host - Hostname .. rubric:: Returns: Status code. .. index:: pair: function; tapi_host_ns_agent_add .. _doxid-group__tapi__host__ns_1ga184050b5099e9919b7cb833f5c32a74a: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_host_ns_agent_add(const char* host, const char* ta, const char* netns) Register test agent in the configuration tree **/local/host**. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - host - Hostname * - ta - Test agent name * - netns - Network namespace name .. rubric:: Returns: Status code. .. index:: pair: function; tapi_host_ns_agent_del .. _doxid-group__tapi__host__ns_1gac0f66f226af6d863232d8d13c6830e2d: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_host_ns_agent_del(const char* ta) Delete test agent from the configuration tree **/local/host**. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test agent name .. rubric:: Returns: Status code. .. index:: pair: function; tapi_host_ns_if_add .. _doxid-group__tapi__host__ns_1gac750f04f5f3f4d3789c1fbb7147266d8: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_host_ns_if_add(const char* ta, const char* ifname, const char* parent_ifname) Add interface to the agent subtree. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test agent name * - ifname - Interface name * - parent_ifname - Parent interface name or ``NULL`` .. rubric:: Returns: Status code. .. index:: pair: function; tapi_host_ns_if_del .. _doxid-group__tapi__host__ns_1gada9af70d48280028f9aa9eb03a5e6c4a: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_host_ns_if_del(const char* ta, const char* ifname, bool del_refs) Delete interface from the agent subtree. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test agent name * - ifname - Interface name * - del_refs - Delete all parent referencesto this interface if ``true`` .. rubric:: Returns: Status code. .. index:: pair: function; tapi_host_ns_if_parent_add .. _doxid-group__tapi__host__ns_1ga10d6b251535a3c999500e09fededf017: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_host_ns_if_parent_add(const char* ta, const char* ifname, const char* parent_ta, const char* parent_ifname) Add reference to a parent interface. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test agent name * - ifname - Interface name * - parent_ta - Owner agent of the parent interface * - parent_ifname - Parent interface name .. rubric:: Returns: Status code. .. index:: pair: function; tapi_host_ns_if_parent_del .. _doxid-group__tapi__host__ns_1ga6cf7d25b8cf75fc8d67655da5282a985: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_host_ns_if_parent_del(const char* ta, const char* ifname, const char* parent_ta, const char* parent_ifname) Delete reference to a parent interface. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test agent name * - ifname - Interface name * - parent_ta - Owner agent of the parent interface * - parent_ifname - Parent interface name .. rubric:: Returns: Status code. .. index:: pair: function; tapi_host_ns_if_change_ns .. _doxid-group__tapi__host__ns_1ga76c6faac5e4b1b7a2afef465264f578b: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_host_ns_if_change_ns(const char* ta, const char* ifname, const char* ns_name, const char* ns_ta) Change interface net namespace and update all parents references accordingly. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test agent name * - ifname - Interface name * - ns_name - Network namespace name * - ns_ta - Test agent in the namespace - new owner of the interface .. rubric:: Returns: Status code. .. index:: pair: function; tapi_host_ns_if_child_iter .. _doxid-group__tapi__host__ns_1ga73ae7e565b0beaf0e1a1a39e8757c166: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_host_ns_if_child_iter(const char* ta, const char* ifname, :ref:`tapi_host_ns_if_cb_func` cb, void* opaque) Iterate by child interfaces. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test agent name * - ifname - Interface name * - opaque - Opaque user data * - cb - A callback function .. rubric:: Returns: Status code. The function stops iterating if ``cb`` returns non-zero value. .. index:: pair: function; tapi_host_ns_if_parent_iter .. _doxid-group__tapi__host__ns_1ga84dd1e55d42e062ccc25149802c22477: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_host_ns_if_parent_iter(const char* ta, const char* ifname, :ref:`tapi_host_ns_if_cb_func` cb, void* opaque) Iterate by parent interfaces. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test agent name * - ifname - Interface name * - opaque - Opaque user data * - cb - A callback function .. rubric:: Returns: Status code. The function stops iterating if ``cb`` returns non-zero value. .. index:: pair: function; tapi_host_ns_if_ta_iter .. _doxid-group__tapi__host__ns_1ga2a4c6e0f94e473a8377eaf91537790ef: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_host_ns_if_ta_iter(const char* ta, :ref:`tapi_host_ns_if_cb_func` cb, void* opaque) Iterate by all grabbed interfaces on ``ta``. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test agent name * - opaque - Opaque user data * - cb - A callback function .. rubric:: Returns: Status code. The function stops iterating if ``cb`` returns non-zero value. .. index:: pair: function; tapi_host_ns_if_host_iter .. _doxid-group__tapi__host__ns_1ga6856d17912bf15c1cbc2e686a892f6ca: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_host_ns_if_host_iter(const char* host, :ref:`tapi_host_ns_if_cb_func` cb, void* opaque) Iterate by all grabbed interfaces on the ``host``. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - host - Host name * - opaque - Opaque user data * - cb - A callback function .. rubric:: Returns: Status code. The function stops iterating if ``cb`` returns non-zero value. .. index:: pair: function; tapi_host_ns_agent_default .. _doxid-group__tapi__host__ns_1gaef1cb68d5789b9f0bc734dce3872fdf4: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_host_ns_agent_default(const char* ta, char** ta_default) Get name of test agent which is in default net namespace on the same host where ``ta`` is located. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test agent name * - ta_default - Name of the agent in default net namespace .. rubric:: Returns: Status code.