:orphan: .. index:: pair: group; System parameters .. _doxid-group__tapi__cfg__sys: System parameters ================= .. toctree:: :hidden: enum_tapi_cfg_sys_ip_instance_kind.rst enum_tapi_cfg_sys_ip_net_subtree.rst Overview ~~~~~~~~ Definitions of TAPI to get/set system parameters using ``/agent/sys/`` Configurator subtree (``doc/cm/cm_base.xml``). :ref:`More...` .. ref-code-block:: cpp :class: doxyrest-overview-code-block // typedefs typedef :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` enum :ref:`tapi_cfg_sys_ip_net_subtree` :ref:`tapi_cfg_sys_ip_net_subtree`; typedef enum :ref:`tapi_cfg_sys_ip_instance_kind` :ref:`tapi_cfg_sys_ip_instance_kind`; // enums enum :ref:`tapi_cfg_sys_ip_instance_kind`; enum :ref:`tapi_cfg_sys_ip_net_subtree`; // global functions :ref:`te_errno` :ref:`tapi_cfg_sys_get_int`(const char* ta, int* val, const char* fmt, ...); :ref:`te_errno` :ref:`te_errno` :ref:`tapi_cfg_sys_set_int`(const char* ta, int val, int* old_val, const char* fmt, ...); :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`tapi_cfg_sys_get_uint64`(const char* ta, uint64_t* val, const char* fmt, ...); :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`tapi_cfg_sys_set_uint64`(const char* ta, uint64_t val, uint64_t* old_val, const char* fmt, ...); :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`tapi_cfg_sys_get_str`(const char* ta, char** val, const char* fmt, ...); :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`tapi_cfg_sys_set_str`(const char* ta, const char* val, char** old_val, const char* fmt, ...); :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`tapi_cfg_sys_ns_get_int`(const char* ta, int* val, const char* fmt, ...); :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`tapi_cfg_sys_ns_set_int`(const char* ta, int val, int* old_val, const char* fmt, ...); :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`tapi_cfg_sys_ns_get_uint64`(const char* ta, uint64_t* val, const char* fmt, ...); :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`tapi_cfg_sys_ns_set_uint64`(const char* ta, uint64_t val, uint64_t* old_val, const char* fmt, ...); :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`tapi_cfg_sys_ns_get_str`(const char* ta, char** val, const char* fmt, ...); :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`tapi_cfg_sys_ns_set_str`(const char* ta, const char* val, char** old_val, const char* fmt, ...); :ref:`te_errno` :ref:`tapi_cfg_sys_ip_grab`(const char* ta, int af, :ref:`tapi_cfg_sys_ip_net_subtree` subtree, :ref:`tapi_cfg_sys_ip_instance_kind` inst, :ref:`cs_rsrc_lock_type` lock_type); .. _details-group__tapi__cfg__sys: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ Definitions of TAPI to get/set system parameters using ``/agent/sys/`` Configurator subtree (``doc/cm/cm_base.xml``). Copyright (C) 2004-2022 OKTET Labs Ltd. All rights reserved. Typedefs -------- .. index:: pair: typedef; tapi_cfg_sys_ip_net_subtree .. _doxid-group__tapi__cfg__sys_1gafff6d8bbf9514ec9a6e52d9fa0f3123a: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` enum :ref:`tapi_cfg_sys_ip_net_subtree` tapi_cfg_sys_ip_net_subtree Sysctl subtrees under /net/ipv4 and /net/ipv6. .. index:: pair: typedef; tapi_cfg_sys_ip_instance_kind .. _doxid-group__tapi__cfg__sys_1ga16ac1c885d50398a545418791a16c8dd: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef enum :ref:`tapi_cfg_sys_ip_instance_kind` tapi_cfg_sys_ip_instance_kind Specific instance inside a sysctl subtree. Global Functions ---------------- .. index:: pair: function; tapi_cfg_sys_get_int .. _doxid-group__tapi__cfg__sys_1ga50f845c09e292925d5953bf747259d40: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_sys_get_int(const char* ta, int* val, const char* fmt, ...) Get value of integer parameter in /sys: subtree. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test agent name. * - val - Where to save value. * - fmt - Format string of the path. * - ... - List of arguments for format string. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_cfg_sys_set_int .. _doxid-group__tapi__cfg__sys_1gafbcb7bd7d9fdfe86e59ff3ba87b53019: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` :ref:`te_errno` tapi_cfg_sys_set_int(const char* ta, int val, int* old_val, const char* fmt, ...) Set value of integer parameter in /sys: subtree. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test agent name. * - val - Value to set. * - old_val - Where to save previous value (may be ``NULL``). * - fmt - Format string of the path. * - ... - List of arguments for format string. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_cfg_sys_get_uint64 .. _doxid-group__tapi__cfg__sys_1gab57215fba0ade3b1a669853a7770119d: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` tapi_cfg_sys_get_uint64(const char* ta, uint64_t* val, const char* fmt, ...) Get value of uint64_t parameter in /sys: subtree. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test agent name. * - val - Where to save value. * - fmt - Format string of the path. * - ... - Format arguments. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_cfg_sys_set_uint64 .. _doxid-group__tapi__cfg__sys_1ga79752fde3fc2284c035ecc016100c392: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` tapi_cfg_sys_set_uint64(const char* ta, uint64_t val, uint64_t* old_val, const char* fmt, ...) Set value of uint64_t parameter in /sys: subtree. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test agent name. * - val - Value to set. * - old_val - Where to save previous value (may be ``NULL``). * - fmt - Format string of the path. * - ... - Format arguments. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_cfg_sys_get_str .. _doxid-group__tapi__cfg__sys_1ga85373d85f914a77fe58312ae15e95b7a: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` tapi_cfg_sys_get_str(const char* ta, char** val, const char* fmt, ...) Get value of string parameter in /sys: subtree. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test agent name. * - val - Where to save pointer to allocated string containing requested value. * - fmt - Format string of the path. * - ... - List of arguments for format string. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_cfg_sys_set_str .. _doxid-group__tapi__cfg__sys_1ga57e59df4190be7a450ecb8522a670538: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` tapi_cfg_sys_set_str(const char* ta, const char* val, char** old_val, const char* fmt, ...) Set value of string parameter in /sys: subtree. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test agent name. * - val - Value to set. * - old_val - Where to save pointer to allocated string containing the previous value (may be ``NULL``). * - fmt - Format string of the path. * - ... - List of arguments for format string. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_cfg_sys_ns_get_int .. _doxid-group__tapi__cfg__sys_1ga681cba2a9622b7fea645baea92dd1c07: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` tapi_cfg_sys_ns_get_int(const char* ta, int* val, const char* fmt, ...) The same as :ref:`tapi_cfg_sys_get_int() ` but try to get the option value in default net namespace if it does not exist in current namespace. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test agent name. * - val - Where to save value. * - fmt - Format string of the path. * - ... - List of arguments for format string. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_cfg_sys_ns_set_int .. _doxid-group__tapi__cfg__sys_1gabdffd0b927fb94caec92c29180fa1f38: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` tapi_cfg_sys_ns_set_int(const char* ta, int val, int* old_val, const char* fmt, ...) The same as :ref:`tapi_cfg_sys_set_int() ` but try to set the option value in default net namespace if it does not exist in current namespace. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test agent name. * - val - Value to set. * - old_val - Where to save previous value (may be ``NULL``). * - fmt - Format string of the path. * - ... - List of arguments for format string. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_cfg_sys_ns_get_uint64 .. _doxid-group__tapi__cfg__sys_1gabcb17c08aa6d226c84f30ce81f035530: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` tapi_cfg_sys_ns_get_uint64(const char* ta, uint64_t* val, const char* fmt, ...) The same as :ref:`tapi_cfg_sys_get_uint64() ` but try to get the option value in default net namespace if it does not exist in current namespace. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test agent name. * - val - Where to save value. * - fmt - Format string of the path. * - ... - Format arguments. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_cfg_sys_ns_set_uint64 .. _doxid-group__tapi__cfg__sys_1gad107c37d6c33e32b1ef1d9c882040bd9: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` tapi_cfg_sys_ns_set_uint64(const char* ta, uint64_t val, uint64_t* old_val, const char* fmt, ...) The same as :ref:`tapi_cfg_sys_set_uint64() ` but try to set the option value in default net namespace if it does not exist in current namespace. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test agent name. * - val - Value to set. * - old_val - Where to save previous value (may be ``NULL``). * - fmt - Format string of the path. * - ... - Format arguments. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_cfg_sys_ns_get_str .. _doxid-group__tapi__cfg__sys_1gaa2d9820c871e34fdbd6da80b69a5cb5f: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` tapi_cfg_sys_ns_get_str(const char* ta, char** val, const char* fmt, ...) The same as :ref:`tapi_cfg_sys_get_str() ` but try to get the option value in default net namespace if it does not exist in current namespace. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test agent name. * - val - Where to save pointer to allocated string containing requested value. * - fmt - Format string of the path. * - ... - List of arguments for format string. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_cfg_sys_ns_set_str .. _doxid-group__tapi__cfg__sys_1gaccad9666a6f7768a445c97f2c6172911: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` tapi_cfg_sys_ns_set_str(const char* ta, const char* val, char** old_val, const char* fmt, ...) The same as :ref:`tapi_cfg_sys_set_str() ` but try to set the option value in default net namespace if it does not exist in current namespace. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test agent name. * - val - Value to set. * - old_val - Where to save pointer to allocated string containing the previous value (may be ``NULL``). * - fmt - Format string of the path. * - ... - List of arguments for format string. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_cfg_sys_ip_grab .. _doxid-group__tapi__cfg__sys_1gae60bd92cf785ec7e2572bcb07a734a69: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_sys_ip_grab(const char* ta, int af, :ref:`tapi_cfg_sys_ip_net_subtree` subtree, :ref:`tapi_cfg_sys_ip_instance_kind` inst, :ref:`cs_rsrc_lock_type` lock_type) Acquire a Configurator resource associated with an IP-related sysctl subtree. The resource is managed by the Configurator framework and is released automatically during configuration cleanup. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test agent name. * - af - Address family. * - subtree - Sysctl subtree. * - inst - Target instance. * - shared - Lock type. .. rubric:: Returns: Status code.