From 2064efeace7d974b2767f3ba26895433ca84231e Mon Sep 17 00:00:00 2001 From: Kamailio Dev Date: Sat, 14 Jan 2017 13:16:33 +0100 Subject: [PATCH] modules: readme files regenerated - benchmark ... --- src/modules/benchmark/README | 10 +-- src/modules/carrierroute/README | 139 +++++++++++++++++++------------- src/modules/dialog/README | 2 +- src/modules/dialplan/README | 3 +- src/modules/dispatcher/README | 5 -- src/modules/htable/README | 7 +- src/modules/kex/README | 18 ++--- src/modules/pdt/README | 3 +- src/modules/presence/README | 4 +- src/modules/presence_xml/README | 8 +- src/modules/ratelimit/README | 2 +- src/modules/regex/README | 2 +- src/modules/stun/README | 8 +- src/modules/xcap_server/README | 2 +- 14 files changed, 117 insertions(+), 96 deletions(-) diff --git a/src/modules/benchmark/README b/src/modules/benchmark/README index 0235fe57958..6f38bcdbfff 100644 --- a/src/modules/benchmark/README +++ b/src/modules/benchmark/README @@ -49,7 +49,7 @@ Bastian Friedrich 6.1. benchmark.enable_global 6.2. benchmark.enable_timer - 6.3. benachmark.granularity + 6.3. benchmark.granularity 6.4. benchmark.loglevel 7. Example of usage @@ -104,7 +104,7 @@ Chapter 1. Admin Guide 6.1. benchmark.enable_global 6.2. benchmark.enable_timer - 6.3. benachmark.granularity + 6.3. benchmark.granularity 6.4. benchmark.loglevel 7. Example of usage @@ -147,7 +147,7 @@ Chapter 1. Admin Guide default. This variable may have three different values: * -1 - Globally disable benchmarking * 0 - Enable per-timer enabling. Single timers are inactive by - default and can be activated through the MI interface as soon as + default and can be activated through the RPC interface as soon as that feature is implemented. * 1 - Globally enable benchmarking @@ -256,7 +256,7 @@ bm_log_timer("test"); 6.1. benchmark.enable_global 6.2. benchmark.enable_timer - 6.3. benachmark.granularity + 6.3. benchmark.granularity 6.4. benchmark.loglevel 6.1. benchmark.enable_global @@ -274,7 +274,7 @@ bm_log_timer("test"); kamcmd benchmark.enable_timer test 1 ... -6.3. benachmark.granularity +6.3. benchmark.granularity Modifies the benchmarking granularity. See "granularity" variable. diff --git a/src/modules/carrierroute/README b/src/modules/carrierroute/README index 7b76b50f72d..ba402136b77 100644 --- a/src/modules/carrierroute/README +++ b/src/modules/carrierroute/README @@ -51,22 +51,27 @@ Lucian Balaceanu 4.4. cr_next_domain(carrier, domain, prefix_matching, host, reply_code, dstavp) - 5. MI Commands + 5. RPC Commands - 5.1. cr_reload_routes - 5.2. cr_dump_routes - 5.3. cr_replace_host - 5.4. cr_deactivate_host - 5.5. cr_activate_host - 5.6. cr_add_host - 5.7. cr_delete_host + 5.1. cr.reload_routes + 5.2. cr.dump_routes - 6. Configuration examples - 7. Installation and Running + 6. MI Commands - 7.1. Database setup - 7.2. Database examples - 7.3. User specific routing + 6.1. cr_reload_routes + 6.2. cr_dump_routes + 6.3. cr_replace_host + 6.4. cr_deactivate_host + 6.5. cr_activate_host + 6.6. cr_add_host + 6.7. cr_delete_host + + 7. Configuration examples + 8. Installation and Running + + 8.1. Database setup + 8.2. Database examples + 8.3. User specific routing 2. Module parameter for database access. @@ -200,22 +205,27 @@ Chapter 1. Admin Guide 4.4. cr_next_domain(carrier, domain, prefix_matching, host, reply_code, dstavp) - 5. MI Commands + 5. RPC Commands + + 5.1. cr.reload_routes + 5.2. cr.dump_routes - 5.1. cr_reload_routes - 5.2. cr_dump_routes - 5.3. cr_replace_host - 5.4. cr_deactivate_host - 5.5. cr_activate_host - 5.6. cr_add_host - 5.7. cr_delete_host + 6. MI Commands - 6. Configuration examples - 7. Installation and Running + 6.1. cr_reload_routes + 6.2. cr_dump_routes + 6.3. cr_replace_host + 6.4. cr_deactivate_host + 6.5. cr_activate_host + 6.6. cr_add_host + 6.7. cr_delete_host - 7.1. Database setup - 7.2. Database examples - 7.3. User specific routing + 7. Configuration examples + 8. Installation and Running + + 8.1. Database setup + 8.2. Database examples + 8.3. User specific routing 1. Overview @@ -246,7 +256,7 @@ Chapter 1. Admin Guide database driven routing creates. Routing tables can be reloaded and edited (in config file mode) with - the MI interface, the config file is updated according the changes. + 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 too. @@ -643,25 +653,20 @@ dstavp) as input. * dstavp - Name of the AVP where to store the next routing domain. -5. MI Commands +5. RPC Commands - 5.1. cr_reload_routes - 5.2. cr_dump_routes - 5.3. cr_replace_host - 5.4. cr_deactivate_host - 5.5. cr_activate_host - 5.6. cr_add_host - 5.7. cr_delete_host + 5.1. cr.reload_routes + 5.2. cr.dump_routes - All commands understand the "-?" parameter to print a short help - message. The options have to be quoted as one string to be passed to MI - interface. Each option except host and new host can be wildcarded by * - (but only * and not things like "-d prox*"). - -5.1. cr_reload_routes +5.1. cr.reload_routes 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 @@ -669,11 +674,35 @@ dstavp) differ from the one used internally from the server. Modifying of already existing domains is no problem. -5.2. cr_dump_routes +5.2. cr.dump_routes This command prints the route rules on the command line. -5.3. cr_replace_host + Name: cr.dump_routes + + Parameters: + * none + +6. MI Commands + + 6.1. cr_reload_routes + 6.2. cr_dump_routes + 6.3. cr_replace_host + 6.4. cr_deactivate_host + 6.5. cr_activate_host + 6.6. cr_add_host + 6.7. cr_delete_host + + All commands understand the "-?" parameter to print a short help + message. The options have to be quoted as one string to be passed to MI + interface. Each option except host and new host can be wildcarded by * + (but only * and not things like "-d prox*"). + +6.1. cr_reload_routes + +6.2. cr_dump_routes + +6.3. cr_replace_host This command can replace the rewrite_host of a route rule, it is only usable in file mode. Following options are possible: @@ -689,7 +718,7 @@ dstavp) kamctl fifo cr_replace_host "-d proxy -p 49 -h proxy1 -t proxy2" ... -5.4. cr_deactivate_host +6.4. cr_deactivate_host This command deactivates the specified host, i.e. it sets its status to 0. It is only usable in file mode. Following options are possible: @@ -710,7 +739,7 @@ kamctl fifo cr_replace_host "-d proxy -p 49 -h proxy1 -t proxy2" kamctl fifo cr_deactivate_host "-d proxy -p 49 -h proxy1" ... -5.5. cr_activate_host +6.5. cr_activate_host This command activates the specified host, i.e. it sets its status to 1. It is only usable in file mode. Following options are possible: @@ -725,7 +754,7 @@ kamctl fifo cr_deactivate_host "-d proxy -p 49 -h proxy1" kamctl fifo cr_activate_host "-d proxy -p 49 -h proxy1" ... -5.6. cr_add_host +6.6. cr_add_host This command adds a route rule, it is only usable in file mode. Following options are possible: @@ -745,7 +774,7 @@ kamctl fifo cr_activate_host "-d proxy -p 49 -h proxy1" kamctl fifo cr_add_host "-d proxy -p 49 -h proxy1 -w 0.25" ... -5.7. cr_delete_host +6.7. cr_delete_host This command delete the specified hosts or rules, i.e. remove them from the route tree. It is only usable in file mode. Following options are @@ -766,7 +795,7 @@ kamctl fifo cr_add_host "-d proxy -p 49 -h proxy1 -w 0.25" kamctl fifo cr_delete_host "-d proxy -p 49 -h proxy1 -w 0.25" ... -6. Configuration examples +7. Configuration examples Example 1.19. Configuration example - Routing to default tree ... @@ -900,13 +929,13 @@ domain register { } ... -7. Installation and Running +8. Installation and Running - 7.1. Database setup - 7.2. Database examples - 7.3. User specific routing + 8.1. Database setup + 8.2. Database examples + 8.3. User specific routing -7.1. Database setup +8.1. Database setup Before running Kamailio with carrierroute, you have to setup the database table where the module will store the routing data. For that, @@ -925,7 +954,7 @@ domain register { For a minimal configuration either use the config file given above, or insert some data into the tables of the module. -7.2. Database examples +8.2. Database examples Example 1.22. Example database content - carrierroute table ... @@ -1039,7 +1068,7 @@ domain register { This table contains the mapping of the domain id to actual names. -7.3. User specific routing +8.3. User specific routing For a functional routing the “cr_preferred_carrier” column must be added to the subscriber table (or to the table and column that you diff --git a/src/modules/dialog/README b/src/modules/dialog/README index ae93d9644a0..755b0f7cb5c 100644 --- a/src/modules/dialog/README +++ b/src/modules/dialog/README @@ -1679,7 +1679,7 @@ dlg_remote_profile("add", "caller", "test", "$sruid", "$var(exp)"); RPC Command Format: ... -kamcmd dlg_list +kamcmd dlg.list ... 9.2. dlg.list_ctx diff --git a/src/modules/dialplan/README b/src/modules/dialplan/README index 7b69fc0846d..a05a3424354 100644 --- a/src/modules/dialplan/README +++ b/src/modules/dialplan/README @@ -472,8 +472,7 @@ xlog("translated to var $var(y) \n"); * Input String Example: - # kamcmd dp_translate dpid "input" - kamcmd dp_translate 1 "abcdxyz" + kamcmd dialplan.translate 1 "abcdxyz" 8. Installation diff --git a/src/modules/dispatcher/README b/src/modules/dispatcher/README index 08fdc375798..4be9271a43f 100644 --- a/src/modules/dispatcher/README +++ b/src/modules/dispatcher/README @@ -891,11 +891,6 @@ Note 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. Example 1.35. ds_select_dst usage diff --git a/src/modules/htable/README b/src/modules/htable/README index 478c3da930c..131126cad98 100644 --- a/src/modules/htable/README +++ b/src/modules/htable/README @@ -582,10 +582,9 @@ 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 - repeated on all other nodes. Therefore, it is important to ensure the - table definition (size, autoexpire etc.) is identical across all - instances. + 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. Important: If this parameter is enabled, the DMQ module must be loaded first - otherwise, startup will fail. diff --git a/src/modules/kex/README b/src/modules/kex/README index 963b8b6a73d..c02d28e0153 100644 --- a/src/modules/kex/README +++ b/src/modules/kex/README @@ -63,7 +63,7 @@ Ovidiu Sas 4.6. system.listMethods 4.7. get_statistics 4.8. stats.reset_statistics - 4.9. clear_statistics + 4.9. stats.clear_statistics 4.10. pkg.stats 4.11. stats.get_statistics 4.12. stats.reset_statistics @@ -123,7 +123,7 @@ Chapter 1. Admin Guide 4.6. system.listMethods 4.7. get_statistics 4.8. stats.reset_statistics - 4.9. clear_statistics + 4.9. stats.clear_statistics 4.10. pkg.stats 4.11. stats.get_statistics 4.12. stats.reset_statistics @@ -405,7 +405,7 @@ resetdebug(); 4.6. system.listMethods 4.7. get_statistics 4.8. stats.reset_statistics - 4.9. clear_statistics + 4.9. stats.clear_statistics 4.10. pkg.stats 4.11. stats.get_statistics 4.12. stats.reset_statistics @@ -481,7 +481,7 @@ kamcmd core.version Print list of available RPC commands. - Name: which + Name: system.listMethods Parameters: none. @@ -510,26 +510,26 @@ kamcmd stats.get_statistics Reset internal statistics. - Name: statsreset_statistics + Name: stats.reset_statistics Parameters: statsid - which statistics to be reset, give as name. RPC Command Format: ... -kamcmd reset_statistics _statsid_ +kamcmd stats.reset_statistics _statsid_ ... -4.9. clear_statistics +4.9. stats.clear_statistics Return statistics and reset their value in one command. - Name: stats.get_statistics + Name: stats.clear_statistics Parameters: statsid - same as for get_statistics. RPC Command Format: ... -kamcmd clear_statistics _statsid_ +kamcmd stats.clear_statistics _statsid_ ... 4.10. pkg.stats diff --git a/src/modules/pdt/README b/src/modules/pdt/README index 603dc59b764..dff0f75236f 100644 --- a/src/modules/pdt/README +++ b/src/modules/pdt/README @@ -407,8 +407,7 @@ 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/README b/src/modules/presence/README index 110ed81d640..2b3454f154e 100644 --- a/src/modules/presence/README +++ b/src/modules/presence/README @@ -985,7 +985,7 @@ kamcmd presence.cleanup RPC Command Format: ... -kamcmd refreshWatchers sip:test@kamailio.org presence 1 +kamcmd presence.refreshWatchers sip:test@kamailio.org presence 1 ... 6. Exported Variables @@ -1347,7 +1347,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 + (used by presence_xml module when notified through an RPC command of a change in an xcap document). 15. get_sphere diff --git a/src/modules/presence_xml/README b/src/modules/presence_xml/README index 0067676f994..6af102d6ade 100644 --- a/src/modules/presence_xml/README +++ b/src/modules/presence_xml/README @@ -225,10 +225,10 @@ modparam("presence_xml", "force_active", 1) same database tables directly, like the embedded 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 [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. + server is not running on the same Kamailio instance, 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. Otherwise, it uses xcap_client module to fetch documents from the XCAP servers with HTTP requests. diff --git a/src/modules/ratelimit/README b/src/modules/ratelimit/README index 4ab849e2793..78648295eab 100644 --- a/src/modules/ratelimit/README +++ b/src/modules/ratelimit/README @@ -123,7 +123,7 @@ Chapter 1. Admin Guide 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 change + basis and not per source IP. The RPC interface can be used to change tunables while running Kamailio. The module implements the pipe/queue policy from BSD's ipfw manual, diff --git a/src/modules/regex/README b/src/modules/regex/README index 7eac762cbf6..6e836e1170d 100644 --- a/src/modules/regex/README +++ b/src/modules/regex/README @@ -105,7 +105,7 @@ Chapter 1. Admin Guide 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. The module also offers a + 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/README b/src/modules/stun/README index b33fd59925e..0b21280cff7 100644 --- a/src/modules/stun/README +++ b/src/modules/stun/README @@ -21,7 +21,7 @@ Peter Dunkley 3. Parameters 4. Functions - 5. MI Commands + 5. RPC Commands Chapter 1. Admin Guide @@ -35,7 +35,7 @@ Chapter 1. Admin Guide 3. Parameters 4. Functions - 5. MI Commands + 5. RPC Commands 1. Overview @@ -57,7 +57,7 @@ Chapter 1. Admin Guide The following libraries must be installed before running Kamailio with this module loaded: - * none. + * None 3. Parameters @@ -67,6 +67,6 @@ Chapter 1. Admin Guide None -5. MI Commands +5. RPC Commands None diff --git a/src/modules/xcap_server/README b/src/modules/xcap_server/README index b68559d0b2e..8cb037d4873 100644 --- a/src/modules/xcap_server/README +++ b/src/modules/xcap_server/README @@ -98,7 +98,7 @@ Chapter 1. Admin Guide requests. * 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 + via RPC command. * can be used stand-alone, with a different Presence server. It is not specific for Kamailio or SER. Documents can be fetched via GET * no exotic dependencies, it is written in C. It depends on libxml2,