Table of Contents
List of Examples
Table of Contents
The module implements RPC commands to set and get configuration variables on-the-fly, that are declared by Kamailio core and by the modules.
For example, it can be used to fine-tune values for global parameters such as debug, tcp/sctp/dns attributes, without the need of restart.
RPC connector modules, such as “ctl” or “xmlrpc”, although not a dependecy, should be loaded in order to execute the RPC commands exported by this module. When the ctl module is loaded, the tool 'kamcmd' can be used to execute the RPC commands implemented in this module.
The following modules must be loaded before this module:
No dependencies on other SIP Router modules.
The module implements the RPC commands documented in the next sections.
cfg.list - List the configuration variables. The function has one optional parameter: group name.
cfg.get - Get the value of a configuration variable. The function accepts two parameters: group name, variable name. The group name can optionally contain the group instance id, for example foo[5].
cfg.seti - Set the value of a configuration variable and commit the change immediately. The function accepts three parameters: group name, variable name, integer value. The group name can optionally contain the group instance id, for example foo[5].
cfg.sets - Set the value of a configuration variable and commit the change immediately. The function accepts three parameters: group name, variable name, string value. The group name can optionally contain the group instance id, for example foo[5].
cfg.set - Set the value of a configuration variable and commit the change immediately. This is a wrapper command for cfg.set_now_int and cfg.set_now_string depending on the type of the value provided. The function accepts three parameters: group name, variable name, int/string value. The group name can optionally contain the group instance id, for example foo[5].
cfg.del - Delete the value of a configuration variable from a group instance and commit the change immediately. The value is reset to the default value and it follows the changes of that. The function accepts two parameters: group name, variable name. The group name must contain the group instance id, for example foo[5].
cfg.set_delayed_int - Prepare the change of a configuration variable, but does not commit the new value yet. The function accepts three parameters: group name, variable name, integer value. The group name can optionally contain the group instance id, for example foo[5].
cfg.set_delayed_string - Prepare the change of a configuration variable, but does not commit the new value yet. The function accepts three parameters: group name, variable name, string value. The group name can optionally contain the group instance id, for example foo[5].
cfg.set_delayed - Prepare the change of a configuration variable, but does not commit the new value yet. This is a wrapper command for cfg.set_delayed_int and cfg.set_delayed_string depending on the type of the value provided. The function accepts three parameters: group name, variable name, int/string value. The group name can optionally contain the group instance id, for example foo[5].
cfg.del_delayed - Prepare the deletion of the value of a configuration variable from a group instance, but does not commit the change yet. The value is reset to the default value and it follows the changes of that. The function accepts two parameters: group name, variable name. The group name must contain the group instance id, for example foo[5].
cfg.commit - Commit the previously prepared configuration changes. The function does not have any parameters.
cfg.rollback - Drop the prepared configuration changes. The function does not have any parameters.
cfg.help - Print the description of a configuration variable. The function accepts two parameters: group name, variable name.
cfg.diff - List the pending configuration changes that have not been committed yet. The function does not have any parameters.
cfg.add_group_inst - Add a new instance to an existing configuration group. The function accepts one parameter: group name[instance id], for example foo[5].