System parameters configuration

Overview

Definitions of TAPI to get/set system parameters using /agent/sys/ Configurator subtree (doc/cm/cm_base.xml). More…

// global functions

te_errno tapi_cfg_sys_get_int(const char* ta, int* val, const char* fmt, ...);
te_errno tapi_cfg_sys_set_int(const char* ta, int val, int* old_val, const char* fmt, ...);
te_errno tapi_cfg_sys_get_uint64(const char* ta, uint64_t* val, const char* fmt, ...);
te_errno tapi_cfg_sys_set_uint64(const char* ta, uint64_t val, uint64_t* old_val, const char* fmt, ...);
te_errno tapi_cfg_sys_get_str(const char* ta, char** val, const char* fmt, ...);
te_errno tapi_cfg_sys_set_str(const char* ta, const char* val, char** old_val, const char* fmt, ...);
te_errno tapi_cfg_sys_ns_get_int(const char* ta, int* val, const char* fmt, ...);
te_errno tapi_cfg_sys_ns_set_int(const char* ta, int val, int* old_val, const char* fmt, ...);
te_errno tapi_cfg_sys_ns_get_uint64(const char* ta, uint64_t* val, const char* fmt, ...);
te_errno tapi_cfg_sys_ns_set_uint64(const char* ta, uint64_t val, uint64_t* old_val, const char* fmt, ...);
te_errno tapi_cfg_sys_ns_get_str(const char* ta, char** val, const char* fmt, ...);
te_errno tapi_cfg_sys_ns_set_str(const char* ta, const char* val, char** old_val, const char* fmt, ...);

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.

Global Functions

te_errno tapi_cfg_sys_get_int(const char* ta, int* val, const char* fmt, ...)

Get value of integer parameter in /sys: subtree.

Parameters:

ta

Test agent name.

val

Where to save value.

fmt

Format string of the path.

List of arguments for format string.

Returns:

Status code.

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.

Parameters:

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.

Returns:

Status code.

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.

Parameters:

ta

Test agent name.

val

Where to save value.

fmt

Format string of the path.

Format arguments.

Returns:

Status code.

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.

Parameters:

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.

Returns:

Status code.

te_errno tapi_cfg_sys_get_str(const char* ta, char** val, const char* fmt, ...)

Get value of string parameter in /sys: subtree.

Parameters:

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.

Returns:

Status code.

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.

Parameters:

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.

Returns:

Status code.

te_errno tapi_cfg_sys_ns_get_int(const char* ta, int* val, const char* fmt, ...)

The same as tapi_cfg_sys_get_int() but try to get the option value in default net namespace if it does not exist in current namespace.

Parameters:

ta

Test agent name.

val

Where to save value.

fmt

Format string of the path.

List of arguments for format string.

Returns:

Status code.

te_errno tapi_cfg_sys_ns_set_int(const char* ta, int val, int* old_val, const char* fmt, ...)

The same as tapi_cfg_sys_set_int() but try to set the option value in default net namespace if it does not exist in current namespace.

Parameters:

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.

Returns:

Status code.

te_errno tapi_cfg_sys_ns_get_uint64(const char* ta, uint64_t* val, const char* fmt, ...)

The same as tapi_cfg_sys_get_uint64() but try to get the option value in default net namespace if it does not exist in current namespace.

Parameters:

ta

Test agent name.

val

Where to save value.

fmt

Format string of the path.

Format arguments.

Returns:

Status code.

te_errno tapi_cfg_sys_ns_set_uint64(const char* ta, uint64_t val, uint64_t* old_val, const char* fmt, ...)

The same as tapi_cfg_sys_set_uint64() but try to set the option value in default net namespace if it does not exist in current namespace.

Parameters:

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.

Returns:

Status code.

te_errno tapi_cfg_sys_ns_get_str(const char* ta, char** val, const char* fmt, ...)

The same as tapi_cfg_sys_get_str() but try to get the option value in default net namespace if it does not exist in current namespace.

Parameters:

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.

Returns:

Status code.

te_errno tapi_cfg_sys_ns_set_str(const char* ta, const char* val, char** old_val, const char* fmt, ...)

The same as tapi_cfg_sys_set_str() but try to set the option value in default net namespace if it does not exist in current namespace.

Parameters:

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.

Returns:

Status code.