# &adminguide;

## Overview

This module collects extensions from &kamailio; core.

&kamailio; Core Cookbook is available at: &kamwikilink;

## Dependencies

### &kamailio; Modules

The following modules must be loaded before this module:

- No dependencies on other &kamailio; modules.

### External Libraries or Applications

The following libraries or applications must be installed before running &kamailio; with this module loaded:

- None.

## Functions

### `setsflag(flag)`

Set the script flag.

Meaning of the parameters is as follows:

- flag - the index of the script flag to be set. Can be integer or pseudo-variable with integer value.

This function can be used from ANY_ROUTE.

#### `setsflag` usage

    ...
    setsflag("1");
    ...
    $var(flag) = 11;
    setsflag("$var(flag)");
    ...

### `issflagset(flag)`

Return true if the script flag is set.

Meaning of the parameters is as follows:

- flag - the index of the script flag to be tested. Can be integer or pseudo-variable with integer value.

This function can be used from ANY_ROUTE.

#### `issflagset` usage

    ...
    if(issflagset("1"))
    {
        ...
    }
    ...

### `resetsflag(flag)`

Reset the script flag.

Meaning of the parameters is as follows:

- flag - the index of the script flag to be reset. Can be integer or pseudo-variable with integer value.

This function can be used from ANY_ROUTE.

#### `resetsflag` usage

    ...
    resetsflag("1");
    ...

### `setbflag(flag [, branch])`

Set the branch flag.

Meaning of the parameters is as follows:

- flag - the index of the branch flag to be set. Can be integer or pseudo-variable with integer value.

- branch - the index of the branch whose flag to be set. Can be integer or pseudo-variable with integer value. If omitted, then branch 0 is used (R-URI).

This function can be used from ANY_ROUTE.

#### `setbflag` usage

    ...
    setbflag("1");
    ...
    $var(flag) = 11;
    setbflag("$var(flag)", "1");
    ...

### `isbflagset(flag [, branch])`

Return true if the branch flag is set.

Meaning of the parameters is as follows:

- flag - the index of the branch flag to be tested. Can be integer or pseudo-variable with integer value.

- branch - the index of the branch whose flag to be set. Can be integer or pseudo-variable with integer value. If omitted, then branch 0 is used (R-URI).

This function can be used from ANY_ROUTE.

#### `isbflagset` usage

    ...
    if(isbflagset("1"))
    {
        ...
    }
    ...

### `resetbflag(flag [, branch])`

Reset the branch flag.

Meaning of the parameters is as follows:

- flag - the index of the branch flag to be reset. Can be integer or pseudo-variable with integer value.

- branch - the index of the branch whose flag to be set. Can be integer or pseudo-variable with integer value. If omitted, then branch 0 is used (R-URI).

This function can be used from ANY_ROUTE.

#### `resetbflag` usage

    ...
    resetbflag("1");
    ...

### `setdsturi(uri)`

Set the destination address URI (outbound proxy address).

Meaning of the parameters is as follows:

- uri - Valid SIP URI representing the address where to send the request. It must be a static string, no variables are evaluated at runtime. If you need to set outbound proxy address via a variable, use assignment to $du.

This function can be used from ANY_ROUTE.

#### `setdsturi` usage

    ...
    setdsturi("sip:10.0.0.10");
    ...

### `resetdsturi()`

Reset the destination address URI (outbound proxy address).

This function can be used from ANY_ROUTE.

#### `resetdsturi` usage

    ...
    resetdsturi();
    ...

### `isdsturiset()`

Check if the destination address URI (outbound proxy address) is set.

This function can be used from ANY_ROUTE.

#### `isdsturiset` usage

    ...
    if(isdsturiset())
    {
       ...
    }
    ...

### `pv_printf(var, str)`

Evaluates the str and sets the resulting value to variable var. For backward compatibility reasons, the same function can be executed via 'avp_printf(var, str)'.

Meaning of the parameters is as follows:

- var - name of a writable variable

- str - string that may contain variables which will be evaluated at runtime.

This function can be used from ANY_ROUTE.

#### `pv_printf` usage

    ...
    pv_printf("$ru", "sip:$rU@$fd");
    pv_printf("$avp(x)", "From: $fU - To: $tU");
    ...

### `is_myself(uri)`

Check if the parameter matches the 'myself' condition (i.e., is a local IP or domain). Note that if the port is missing in the URI, then no port matching is done (in other words, port matching is skipped -- it does not use default SIP ports 5060 or 5061 for matching).

Meaning of the parameters is as follows:

- uri - Valid SIP URI or IP address to check against the list of local IP addresses or domains, matching as well the port and protocol if they are provided. The parameter value can contain pseudo-variables.

This function can be used from ANY_ROUTE.

#### `is_myself` usage

    ...
    if(is_myself("$fu")) {
        ...
    }
    ...

### `is_myhost(uri)`

Check if the host part of the parameter matches a local domain or IP address.

Meaning of the parameters is as follows:

- uri - Valid SIP URI, hostname of IP address to check against the list of local IP addresses or domains. If it is a SIP URI, the port and protocol are ignored. The parameter value can contain pseudo-variables.

This function can be used from ANY_ROUTE.

#### `is_myhost` usage

    ...
    if(is_myhost("$tu")) {
        ...
    }
    ...

### `setdebug(level)`

Set the debug log level per process.

Meaning of the parameters is as follows:

- level - the debug log level to be set. Can be integer or pseudo-variable with integer value.

This function can be used from ANY_ROUTE.

#### `setdebug` usage

    ...
    setdebug("1");
    ...
    $var(level) = 2;
    setdebug("$var(level)");
    ...

### `resetdebug()`

Reset the local debug log level back to the value of core parameter 'debug'.

This function can be used from ANY_ROUTE.

#### `resetdebug` usage

    ...
    resetdebug();
    ...

### `km_append_branch([uri])`

This function was replaced by append_branch() from corex module, starting with version 4.0.0.

## RPC Commands

### `core.aliases_list`

Returns the list of local SIP server host aliases.

### `core.arg`

Print command line arguments.

Name: core.arg

Parameters: none.

RPC Command Format:

    ...
    &kamctl; rpc core.arg
    ...

### `core.echo`

Returns back its parameters.

### `core.flags`

Returns the compile flags.

### `core.info`

Verbose info, including version number, compile flags, compiler, repository, hash

### `core.runinfo`

Runtime details like running version, uptime, ...

### `core.kill`

Kill the application.

Name: core.kill

Parameters: none.

RPC Command Format:

    ...
    &kamctl; rpc core.kill
    ...

### `core.printi`

Returns the integers given as parameters.

### `core.prints`

Returns the strings given as parameters.

### `core.ps`

Returns the description of running processes.

### `core.psx`

Returns the detailed description of running processes.

### `core.pwd`

Print working directory.

Name: core.pwd

Parameters: none.

RPC Command Format:

    ...
    &kamctl; rpc core.pwd
    ...

### `core.shmmem`

Returns shared memory info. It has an optional parameter that specifies the measuring unit: b - bytes (default), k or kb, m or mb, g or gb. Note: when using something different from bytes, the value is truncated.

### `core.sockets_list`

Returns the list of local SIP server listen sockets.

### `core.tcp_info`

Returns TCP related info.

### `core.tcp_list`

Returns TCP connections details.

### `core.tcp_options`

Returns active TCP options.

### `core.udp4_raw_info`

Returns udp4_raw mode related info.

### `core.uptime`

Print uptime.

Name: core.uptime

Parameters: none.

RPC Command Format:

    ...
    &kamctl; rpc core.uptime
    ...

### `core.version`

Print version information.

Name: core.version

Parameters: none.

RPC Command Format:

    ...
    &kamctl; rpc core.version
    ...

### `core.ppdefines`

List preprocessor defines enabled in config.

Name: core.ppdefines

Parameters: none.

RPC Command Format:

    ...
    &kamctl; rpc core.ppdefines
    ...

### `core.modules`

List loaded modules in config.

Name: core.modules

Parameters: none.

RPC Command Format:

    ...
    &kamctl; rpc core.modules
    ...

### `modparam.getn`

Get the value of a module parameter with integer value.

Name: modparam.getn

Parameters: module_name and parameter_name.

RPC Command Format:

    ...
    kamcli rpc modparam.getn tls keylog_mode
    ...

### `modparam.gets`

Get the value of a module parameter with string value.

Name: modparam.gets

Parameters: module_name and parameter_name.

RPC Command Format:

    ...
    kamcli rpc modparam.gets tls config
    ...

### `modparam.setn`

Set the value of a module parameter with integer value stored in shared memory.

Name: modparam.setn

Parameters: module_name, parameter_name and value.

RPC Command Format:

    ...
    kamcli rpc modparam.setn tls keylog_mode 15
    ...

### `modparam.list`

List the parameters of the loaded modules.

Name: modparam.list

Parameters: module_name (optional).

RPC Command Format:

    ...
    kamcli rpc modparam.list
    kamcli rpc modparam.list tls
    ...

### `pkg.stats`

Print private memory (pkg) usage statistics per process. It can take optionally a filter to print statistics only for a specific process or set of processes. If no filter is given, it prints statistics for all processes.

The filter can be:

- pid value - print statistics for specific process pid.

- rank value - print statistics for specific process rank.

- index value - print statistics for specific index in process table.

Examples:

    		&kamctl; rpc pkg.stats
    		&kamctl; rpc pkg.stats pid 1234
    		&kamctl; rpc pkg.stats rank 1
    		&kamctl; rpc pkg.stats index 10

### `pkg.info`

Get pkg manager details.

Example:

    		&kamcli; rpc pkg.info

### `stats.get_statistics`

Print the list of available internal statistics.

NOTE: the result is an array of strings that have the list of statistics formatted like "name = value", being propagated over the time from the MI variant. Use "stats.fetch" or "stats.fetchn"commands to have a more JSON-friendly output.

Parameters: statsid - which statistics to be printed. If set to 'all' then all statistics are printed; if set to 'statsgroup:' then all statistics in the group are printed; if set to 'statsname' then the statistics identified by the name is printed.

Examples:

    		&kamctl; rpc stats.get_statistics all
    		&kamctl; rpc stats.get_statistics core:
    		&kamctl; rpc stats.get_statistics unsupported_methods
    		&kamctl; rpc stats.get_statistics shmem: fwd_requests fwd_replies

### `stats.fetch`

Print the list of available internal statistics with a more json friendly output. Each printed statistic is a field in the output structure: {"statsgroup.statsname" : "statsvalue"}. The value is represented as string to accommodate large numbers.

Parameters: statsid - which statistics to be printed. If set to 'all' then all statistics are printed; if set to 'statsgroup:' then all statistics in the group are printed; if set to 'statsname' then the statistics identified by the name is printed (can be also 'statsgroup.stastname' or 'statsgroup:statsname').

Examples:

    		&kamctl; rpc stats.fetch all
    		&kamctl; rpc stats.fetch core:
    		&kamctl; rpc stats.fetch unsupported_methods
    		&kamctl; rpc stats.fetch shmem.free_size
    		&kamctl; rpc stats.fetch shmem: fwd_requests fwd_replies

### `stats.fetchn`

Print the list of available internal statistics with a more json friendly output. Each printed statistic is a field in the output structure: {"statsgroup.statsname" : statsvalue}. The value is represented as number.

Parameters: statsid - which statistics to be printed. If set to 'all' then all statistics are printed; if set to 'statsgroup:' then all statistics in the group are printed; if set to 'statsname' then the statistics identified by the name is printed (can be also 'statsgroup.stastname' or 'statsgroup:statsname').

Examples:

    		&kamctl; rpc stats.fetchn all
    		&kamctl; rpc stats.fetchn core:
    		&kamctl; rpc stats.fetchn unsupported_methods
    		&kamctl; rpc stats.fetchn shmem.free_size
    		&kamctl; rpc stats.fetchn shmem: fwd_requests fwd_replies

### `stats.reset_statistics`

Reset internal statistics.

Parameters: statsid - same as for get_statistics.

Examples:

    		&kamctl; rpc stats.reset_statistics all
    		&kamctl; rpc stats.reset_statistics core:
    		&kamctl; rpc stats.reset_statistics unsupported_methods
    		&kamctl; rpc stats.reset_statistics shmem: fwd_requests fwd_replies

### `stats.clear_statistics`

Return statistics and reset their value in one command.

Parameters: statsid - same as for get_statistics.

Examples:

    		&kamctl; rpc stats.reset_statistics all
    		&kamctl; rpc stats.reset_statistics core:
    		&kamctl; rpc stats.reset_statistics unsupported_methods
    		&kamctl; rpc stats.reset_statistics shmem: fwd_requests fwd_replies

### `system.listMethods`

Print list of available RPC commands.

Name: system.listMethods

Parameters: none.

RPC Command Format:

    ...
    &kamctl; rpc system.listMethods
    ...

### `system.methodHelp`

Print the help string for given method.

### `system.methodSignature`

Returns signature of given method.

### `mod.mem_stats`

Print private(pkg) or shared(shm) memory currently allocated a given module or by all modules.

NOTE: Processing is done only when the command is issued and involves iterating through the list of memory fragments and printing details about them.

NOTE: Only the module functions that directly calls shm_alloc or pkg_alloc are taken into consideration.

The first parameter can be one of the following:

- module_name - print statistics for specific module. Either a module name (like "usrloc") or "core" for the &kamailio; core.

- all - print statistics for all modules that uses memory.

The second parameter can be:

- pkg - print private (process) memory statistics.

- shm - print shared memory statistics.

- all - print both private and shared memory statistics.

Examples:

    		&kamctl; rpc mod.stats core all
    		&kamctl; rpc mod.stats tm shm
    		&kamctl; rpc mod.stats kex pkg
    		&kamctl; rpc mod.stats all all

Output:

    Module: kex
    {
        // this is the pkg zone of the module
        // function_name(line_where_pkg_malloc_was_called): size_alloc'ed_by_pkg_malloc
        init_rpc_uptime(74): 56
        Total: 56
    }
    {
        // this is the shm zone of the module
        // function_name(line_where_shm_malloc_was_called): size_alloc'ed_by_shm_malloc
        pkg_proc_stats_init(79): 864
        Total: 864
    }

### `mod.stats`

Same as RPC command "mod.mem_stats", this is an alias command to preserve backward compatibility.

### `mod.mem_statsx`

Similar to RPC command "mod.mem_stats", but the output has an extended format, printing info that includes the allocated size and the count of allocated chunks in a combined string value. The parameters are the same like for "mod.mem_stats".