From 7bda0ce9525c1b7e04de2879f7645dd097b23d02 Mon Sep 17 00:00:00 2001 From: Mikko Lehto Date: Tue, 10 Jan 2017 12:31:11 +0200 Subject: [PATCH 1/3] modules/dispatcher: remove duplicate text --- src/modules/dispatcher/doc/dispatcher_admin.xml | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) diff --git a/src/modules/dispatcher/doc/dispatcher_admin.xml b/src/modules/dispatcher/doc/dispatcher_admin.xml index 680319b6239..d0dc575d657 100644 --- a/src/modules/dispatcher/doc/dispatcher_admin.xml +++ b/src/modules/dispatcher/doc/dispatcher_admin.xml @@ -1020,16 +1020,10 @@ modparam("dispatcher", "force_dst", 1) stored in AVP list for further failovers (the first selected destination and default destination are the first to be put in the list) - - + + - If the bit 2 in 'flags' is set, the rest of the addresses from the - destination set is stored in AVP list. You can use 'ds_next_dst()' to - use next address to achieve serial forking to all possible - destinations. - - This function can be used from REQUEST_ROUTE, FAILURE_ROUTE. From 1b7bc21145c91aef1f9fcc32cca8fe7418ca0d17 Mon Sep 17 00:00:00 2001 From: Mikko Lehto Date: Fri, 13 Jan 2017 12:15:28 +0200 Subject: [PATCH 2/3] modules: update documentation to mention RPC instead of MI --- src/modules/benchmark/doc/benchmark_admin.xml | 6 +-- src/modules/carrierroute/doc/carrierroute.xml | 2 +- .../carrierroute/doc/carrierroute_admin.xml | 22 +++------ .../carrierroute/doc/carrierroute_db.xml | 2 +- src/modules/carrierroute/doc/rpc.xml | 46 +++++++++++++++++++ src/modules/dialog/doc/dialog_admin.xml | 2 +- src/modules/dialplan/doc/dialplan_admin.xml | 11 ++--- src/modules/htable/doc/htable_admin.xml | 2 +- src/modules/kex/doc/kex_admin.xml | 14 +++--- src/modules/pdt/doc/pdt_admin.xml | 7 +-- src/modules/presence/doc/presence_admin.xml | 2 +- src/modules/presence/doc/presence_devel.xml | 2 +- .../presence_xml/doc/presence_xml_admin.xml | 2 +- src/modules/ratelimit/doc/ratelimit_admin.xml | 2 +- src/modules/regex/doc/regex_admin.xml | 2 +- src/modules/stun/doc/stun_admin.xml | 4 +- .../xcap_server/doc/xcap_server_admin.xml | 2 +- 17 files changed, 81 insertions(+), 49 deletions(-) create mode 100644 src/modules/carrierroute/doc/rpc.xml diff --git a/src/modules/benchmark/doc/benchmark_admin.xml b/src/modules/benchmark/doc/benchmark_admin.xml index 33ddfd688ec..e666d105d2f 100644 --- a/src/modules/benchmark/doc/benchmark_admin.xml +++ b/src/modules/benchmark/doc/benchmark_admin.xml @@ -74,7 +74,7 @@ 0 - Enable per-timer enabling. Single timers are inactive by default - and can be activated through the MI interface as soon as that feature is + and can be activated through the RPC interface as soon as that feature is implemented. @@ -297,8 +297,8 @@ bm_log_timer("test"); -
- <function moreinfo="none">benachmark.granularity</function> +
+ <function moreinfo="none">benchmark.granularity</function> Modifies the benchmarking granularity. See "granularity" variable. diff --git a/src/modules/carrierroute/doc/carrierroute.xml b/src/modules/carrierroute/doc/carrierroute.xml index 004a954e8a9..1071afd41ca 100644 --- a/src/modules/carrierroute/doc/carrierroute.xml +++ b/src/modules/carrierroute/doc/carrierroute.xml @@ -1,4 +1,4 @@ - + + %docentities; @@ -37,7 +38,7 @@ database driven routing creates. - Routing tables can be reloaded and edited (in config file mode) with the MI + Routing tables can be reloaded and edited (in config file mode) with the RPC interface, the config file is updated according the changes. This is not implemented for the db interface, because its easier to do the changes directly on the db. But the reload and dump functions works of course here @@ -648,6 +649,8 @@ cr_tree_rewrite_uri(tree, domain)
+ +
<acronym>MI</acronym> Commands All commands understand the "-?" parameter to print a short help message. @@ -656,22 +659,9 @@ cr_tree_rewrite_uri(tree, domain) like "-d prox*").
<function moreinfo="none">cr_reload_routes</function> - - This command reloads the routing data from the data source. - - - Important: When new domains have been added, a restart of the server must be - done, because the mapping of the ids used in the config script cannot be - updated at runtime at the moment. So a reload could result in a wrong routing - behaviour, because the ids used in the script could differ from the one used - internally from the server. Modifying of already existing domains is no problem. -
<function moreinfo="none">cr_dump_routes</function> - - This command prints the route rules on the command line. -
<function moreinfo="none">cr_replace_host</function> diff --git a/src/modules/carrierroute/doc/carrierroute_db.xml b/src/modules/carrierroute/doc/carrierroute_db.xml index 5d9fa117dc1..6ef7eb04b54 100644 --- a/src/modules/carrierroute/doc/carrierroute_db.xml +++ b/src/modules/carrierroute/doc/carrierroute_db.xml @@ -1,4 +1,4 @@ - + + + +
+ RPC Commands + +
+ + <function moreinfo="none">cr.reload_routes</function> + + This command reloads the routing data from the data source. + + Name: cr.reload_routes + + Parameters: + + + none + + + + Important: When new domains have been added, a restart of the server must be + done, because the mapping of the ids used in the config script cannot be + updated at runtime at the moment. So a reload could result in a wrong routing + behaviour, because the ids used in the script could differ from the one used + internally from the server. Modifying of already existing domains is no problem. +
+ +
+ + <function moreinfo="none">cr.dump_routes</function> + + This command prints the route rules on the command line. + + Name: cr.dump_routes + + Parameters: + + + none + + +
+ +
diff --git a/src/modules/dialog/doc/dialog_admin.xml b/src/modules/dialog/doc/dialog_admin.xml index 926cc0db6c1..bb136b7d89b 100644 --- a/src/modules/dialog/doc/dialog_admin.xml +++ b/src/modules/dialog/doc/dialog_admin.xml @@ -2130,7 +2130,7 @@ dlg_remote_profile("add", "caller", "test", "$sruid", "$var(exp)"); RPC Command Format: ... -&kamcmd; dlg_list +&kamcmd; dlg.list ...
diff --git a/src/modules/dialplan/doc/dialplan_admin.xml b/src/modules/dialplan/doc/dialplan_admin.xml index 17d011a9fe9..8153974401d 100644 --- a/src/modules/dialplan/doc/dialplan_admin.xml +++ b/src/modules/dialplan/doc/dialplan_admin.xml @@ -531,7 +531,7 @@ xlog("translated to var $var(y) \n"); Example: - &sercmd; dialplan.dump 100 + &kamcmd; dialplan.dump 100
@@ -547,11 +547,11 @@ xlog("translated to var $var(y) \n"); Example: - &sercmd; dialplan.reload + &kamcmd; dialplan.reload
-
+
<varname>dialplan.translate</varname> Will apply a translation rule identified by a dialplan @@ -572,9 +572,8 @@ xlog("translated to var $var(y) \n"); Example: - - # &sercmd; dp_translate dpid "input" - &sercmd; dp_translate 1 "abcdxyz" + + &kamcmd; dialplan.translate 1 "abcdxyz"
diff --git a/src/modules/htable/doc/htable_admin.xml b/src/modules/htable/doc/htable_admin.xml index 71c751bf72b..1ebd18b4550 100644 --- a/src/modules/htable/doc/htable_admin.xml +++ b/src/modules/htable/doc/htable_admin.xml @@ -623,7 +623,7 @@ modparam("htable", "db_expires", 1) If set to 1, will enable DMQ replication of actions performed upon entries in all tables having "dmqreplicate" parameter set. Any update - action performed via pseudo-variables, MI and RPC commands will be + action performed via pseudo-variables and RPC commands will be repeated on all other nodes. Therefore, it is important to ensure the table definition (size, autoexpire etc.) is identical across all instances. diff --git a/src/modules/kex/doc/kex_admin.xml b/src/modules/kex/doc/kex_admin.xml index 9ceb2cc6082..d6971e69633 100644 --- a/src/modules/kex/doc/kex_admin.xml +++ b/src/modules/kex/doc/kex_admin.xml @@ -516,7 +516,7 @@ resetdebug(); ... -
+
<function moreinfo="none">version</function> @@ -544,7 +544,7 @@ resetdebug(); Print list of available RPC commands. - Name: which + Name: system.listMethods Parameters: none. @@ -588,7 +588,7 @@ resetdebug(); Reset internal statistics. - Name: statsreset_statistics + Name: stats.reset_statistics Parameters: statsid - which statistics to be reset, give as name. @@ -597,19 +597,19 @@ resetdebug(); ... -&kamcmd; reset_statistics _statsid_ +&kamcmd; stats.reset_statistics _statsid_ ...
- <function moreinfo="none">clear_statistics</function> + <function moreinfo="none">stats.clear_statistics</function> Return statistics and reset their value in one command. - Name: stats.get_statistics + Name: stats.clear_statistics Parameters: statsid - same as for get_statistics. @@ -618,7 +618,7 @@ resetdebug(); ... -&kamcmd; clear_statistics _statsid_ +&kamcmd; stats.clear_statistics _statsid_ ...
diff --git a/src/modules/pdt/doc/pdt_admin.xml b/src/modules/pdt/doc/pdt_admin.xml index c1cb42ac853..bfcc156bee9 100644 --- a/src/modules/pdt/doc/pdt_admin.xml +++ b/src/modules/pdt/doc/pdt_admin.xml @@ -501,11 +501,8 @@ pd_translate("*", "$var(a)"); RPC Command Example: - -... -# &kamcmd; _sdomain_ _prefix_ _domain_ -&kamcmd; kamailio.org 123 -... + + &kamcmd; pdt.list kamailio.org 123 Examples: diff --git a/src/modules/presence/doc/presence_admin.xml b/src/modules/presence/doc/presence_admin.xml index 62923408985..91ebe245e14 100644 --- a/src/modules/presence/doc/presence_admin.xml +++ b/src/modules/presence/doc/presence_admin.xml @@ -1183,7 +1183,7 @@ pres_update_watchers("sip:test@kamailio.org", "presence"); ... -&kamcmd; refreshWatchers sip:test@kamailio.org presence 1 +&kamcmd; presence.refreshWatchers sip:test@kamailio.org presence 1 ...
diff --git a/src/modules/presence/doc/presence_devel.xml b/src/modules/presence/doc/presence_devel.xml index b202e294b30..0313414ecaa 100644 --- a/src/modules/presence/doc/presence_devel.xml +++ b/src/modules/presence/doc/presence_devel.xml @@ -375,7 +375,7 @@ str* rules_doc); This function is an external command that can be used to announce a change in authorization rules for a presentity. It updates the stored status and sends a Notify to the watchers whose status has changes. (used by - presence_xml module when notified through an MI command of a change in + presence_xml module when notified through an RPC command of a change in an xcap document). diff --git a/src/modules/presence_xml/doc/presence_xml_admin.xml b/src/modules/presence_xml/doc/presence_xml_admin.xml index a1b17767844..8c4213bd049 100644 --- a/src/modules/presence_xml/doc/presence_xml_admin.xml +++ b/src/modules/presence_xml/doc/presence_xml_admin.xml @@ -228,7 +228,7 @@ modparam("presence_xml", "force_active", 1) XCAP server implemented in xcap_server module, the parameter should be set to a positive value. Apart from updating in xcap table, if the integrated server is not running on the same &kamailio; instance, - it must send an MI command refershWatchers + it must send an RPC command presence.refreshWatchers [pres_uri] [event] when a user modifies a rules document, to instruct the presence_xml module to update states from the database and, if needed, send NOTIFY updates. diff --git a/src/modules/ratelimit/doc/ratelimit_admin.xml b/src/modules/ratelimit/doc/ratelimit_admin.xml index 9f0ceffbe4a..6eb4816ffe9 100644 --- a/src/modules/ratelimit/doc/ratelimit_admin.xml +++ b/src/modules/ratelimit/doc/ratelimit_admin.xml @@ -18,7 +18,7 @@ This module implements rate limiting for SIP requests. In contrast to the PIKE module this limits the flow based on a per SIP request type - basis and not per source IP. The MI interface can be used to + basis and not per source IP. The RPC interface can be used to change tunables while running &kamailio;. diff --git a/src/modules/regex/doc/regex_admin.xml b/src/modules/regex/doc/regex_admin.xml index ae590632fff..e0e052a82f3 100644 --- a/src/modules/regex/doc/regex_admin.xml +++ b/src/modules/regex/doc/regex_admin.xml @@ -26,7 +26,7 @@ A text file containing regular expressions categorized in groups is compiled when the module is loaded, the resulting PCRE objects are stored in an array. A function to match a string or pseudo-variable against any of these groups is - provided. The text file can be modified and reloaded at any time via a MI command. + provided. The text file can be modified and reloaded at any time via a RPC command. The module also offers a function to perform a PCRE matching operation against a regular expression provided as function parameter. diff --git a/src/modules/stun/doc/stun_admin.xml b/src/modules/stun/doc/stun_admin.xml index 63b2db2a167..a18c7baee5b 100644 --- a/src/modules/stun/doc/stun_admin.xml +++ b/src/modules/stun/doc/stun_admin.xml @@ -41,7 +41,7 @@ &kamailio; with this module loaded: - none. + None @@ -60,7 +60,7 @@
- MI Commands + RPC Commands None
diff --git a/src/modules/xcap_server/doc/xcap_server_admin.xml b/src/modules/xcap_server/doc/xcap_server_admin.xml index 1510b2b623c..4beb39a3606 100644 --- a/src/modules/xcap_server/doc/xcap_server_admin.xml +++ b/src/modules/xcap_server/doc/xcap_server_admin.xml @@ -34,7 +34,7 @@ the Presence server has access imediatelly to the latest version of XCAP documents. No more need to trigger refresh of XCAP - documents via MI command + documents via RPC command. From 06a0a1f6e91e4d1c0f87afb33519f1de4584a918 Mon Sep 17 00:00:00 2001 From: Mikko Lehto Date: Fri, 13 Jan 2017 22:30:57 +0200 Subject: [PATCH 3/3] modules/pdt: restore dots and indentation for better layout in README --- src/modules/pdt/doc/pdt_admin.xml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/modules/pdt/doc/pdt_admin.xml b/src/modules/pdt/doc/pdt_admin.xml index bfcc156bee9..5f5ed8eba2f 100644 --- a/src/modules/pdt/doc/pdt_admin.xml +++ b/src/modules/pdt/doc/pdt_admin.xml @@ -502,7 +502,9 @@ pd_translate("*", "$var(a)"); RPC Command Example: - &kamcmd; pdt.list kamailio.org 123 +... +&kamcmd; pdt.list kamailio.org 123 +... Examples: