diff --git a/modules/cfg_rpc/Makefile b/modules/cfg_rpc/Makefile index fbb72ed82ef..6be8b1beeec 100644 --- a/modules/cfg_rpc/Makefile +++ b/modules/cfg_rpc/Makefile @@ -1,5 +1,3 @@ -# $Id$ -# # cfg_rpc module makefile # # WARNING: do not run this directly, it should be run by the master Makefile diff --git a/modules/cfg_rpc/README b/modules/cfg_rpc/README index 6827a60132a..ea0df0ed64e 100644 --- a/modules/cfg_rpc/README +++ b/modules/cfg_rpc/README @@ -1,4 +1,3 @@ - cfg_rpc Module Miklos Tirpak @@ -6,7 +5,7 @@ Miklos Tirpak Copyright © 2007 iptelorg GmbH - _________________________________________________________________ + __________________________________________________________________ Table of Contents @@ -78,18 +77,18 @@ Chapter 1. Admin Guide 1. Overview - The module implements RPC commands to set and get configuration - variables on-the-fly, that are declared by SIP Router core and by the + 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, a.s.o. without the need of - restart. + 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 ctl module is loaded, the tool 'kamcmd' - can be used to execute the RPC commands implemented in this module. + 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. 2. Dependencies @@ -103,7 +102,7 @@ Chapter 1. Admin Guide 2.2. External Libraries or Applications - The following libraries or applications must be installed before + The following libraries or applications must be installed before running SIP Router with this module loaded: * None. @@ -128,12 +127,11 @@ Chapter 1. Admin Guide 3.17. cfg.add_group_inst 3.18. cfg.del_group_inst - The module implements the RPC commands documented in the next - sections. + The module implements the RPC commands documented in the next sections. 3.1. cfg.list - cfg.list - List the configuration variables. The function has one + cfg.list - List the configuration variables. The function has one optional parameter: group name. Example 1.1. Use cfg.get RPC command @@ -143,8 +141,8 @@ Chapter 1. Admin Guide 3.2. cfg.get - cfg.get - Get the value of a configuration variable. The function - accepts two parameters: group name, variable name. The group name can + 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]. Example 1.2. Use cfg.get RPC command @@ -154,10 +152,10 @@ Chapter 1. Admin Guide 3.3. cfg.seti - cfg.seti - Set the value of a configuration variable and commit the + 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]. + variable name, integer value. The group name can optionally contain the + group instance id, for example foo[5]. Example 1.3. Use cfg.seti RPC command ... @@ -170,7 +168,7 @@ Chapter 1. Admin Guide 3.5. cfg.sets - cfg.sets - Set the value of a configuration variable and commit the + 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]. @@ -181,51 +179,51 @@ Chapter 1. Admin Guide 3.7. cfg.set - 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 + 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]. 3.8. cfg.del - cfg.del - Delete the value of a configuration variable from a group - instance and commit the change immediately. The value is reset to the + 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]. 3.9. cfg.set_delayed_int - 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 + 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]. 3.10. cfg.set_delayed_string - 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 + 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]. 3.11. cfg.set_delayed - 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.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]. 3.12. cfg.del_delayed 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]. + 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]. 3.13. cfg.commit @@ -234,27 +232,27 @@ Chapter 1. Admin Guide 3.14. cfg.rollback - cfg.rollback - Drop the prepared configuration changes. The function + cfg.rollback - Drop the prepared configuration changes. The function does not have any parameters. 3.15. cfg.help - cfg.help - Print the description of a configuration variable. The + cfg.help - Print the description of a configuration variable. The function accepts two parameters: group name, variable name. 3.16. cfg.diff - cfg.diff - List the pending configuration changes that have not been + cfg.diff - List the pending configuration changes that have not been committed yet. The function does not have any parameters. 3.17. cfg.add_group_inst - 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]. + 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]. 3.18. cfg.del_group_inst - cfg.del_group_inst - Delete an instance of an existing configuration - group. The function accepts one parameter: group name[instance id], - for example foo[5]. + cfg.del_group_inst - Delete an instance of an existing configuration + group. The function accepts one parameter: group name[instance id], for + example foo[5]. diff --git a/modules/cfg_rpc/doc/cfg_rpc.xml b/modules/cfg_rpc/doc/cfg_rpc.xml index c7a9990f858..b57eea3b964 100644 --- a/modules/cfg_rpc/doc/cfg_rpc.xml +++ b/modules/cfg_rpc/doc/cfg_rpc.xml @@ -31,17 +31,17 @@ The module implements RPC commands to set and get configuration variables on-the-fly, that are declared - by &siprouter; core and by the modules. + 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, - a.s.o. without the need of restart. + 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 ctl module + the RPC commands exported by this module. When the ctl module is loaded, the tool '&sercmd;' can be used to execute the RPC commands implemented in this module.