Chapter 1.
RPC Exports for core
Lists all RPC methods supported by the server.
Returns an array.
1.2. system.methodSignature
Returns signature of given method.
Print the help string for given method.
Returns the strings given as parameters.
Returns an array.
Returns the integers given as parameters.
Returns an array.
Returns back its parameters.
Returns an array.
Returns the version string of the server.
Returns the compile flags.
Verbose info, including version number, compile flags,
compiler,repository hash a.s.o.
Returns uptime of SIP server.
Returns the description of running processes.
Returns an array.
Returns the detailed description of running processes.
Returns an array.
Returns the working directory of server.
Returns an array.
Returns the list of command line arguments used on startup.
Returns an array.
Sends the given signal to server.
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.
Returns tcp related info.
Returns active tcp options.
Returns tcp connections details.
Returns udp4_raw related info.
List local SIP server host aliases
List local SIP server listen sockets
dns cache dump in a human-readable format
deletes all the non-permanent entries from the DNS cache
1.29. dns.delete_all_force
deletes all the entries from the DNS cache including the
permanent ones
adds an A record to the DNS cache
adds an AAAA record to the DNS cache
adds an SRV record to the DNS cache
deletes an A record from the DNS cache
deletes an AAAA record from the DNS cache
deletes an SRV record from the DNS cache
deletes a NAPTR record from the DNS cache
deletes a CNAME record from the DNS cache
deletes a TXT record from the DNS cache
deletes an EBL record from the DNS cache
deletes an PTR record from the DNS cache
1.41. dst_blacklist.mem_info
dst blacklist memory usage info.
1.42. dst_blacklist.debug
dst blacklist debug info.
dst blacklist dump in human-readable format.
1.44. dst_blacklist.delete_all
Deletes all the entries from the dst blacklist except the
permanent ones.
Adds a new entry to the dst blacklist.
Chapter 12.
RPC Exports for cfg_rpc
Documentation missing (rpc_set_now_doc).
Documentation missing (rpc_set_now_doc).
Documentation missing (rpc_set_now_doc).
Documentation missing (rpc_set_now_doc).
Documentation missing (rpc_set_now_doc).
Documentation missing (rpc_del_now_doc).
Documentation missing (rpc_set_delayed_doc).
12.8. cfg.set_delayed_int
Documentation missing (rpc_set_delayed_doc).
12.9. cfg.set_delayed_string
Documentation missing (rpc_set_delayed_doc).
Documentation missing (rpc_del_delayed_doc).
Documentation missing (rpc_commit_doc).
Documentation missing (rpc_rollback_doc).
Documentation missing (rpc_get_doc).
Documentation missing (rpc_help_doc).
Documentation missing (rpc_list_doc).
Documentation missing (rpc_diff_doc).
12.17. cfg.add_group_inst
Documentation missing (rpc_add_group_inst_doc).
12.18. cfg.del_group_inst
Documentation missing (rpc_del_group_inst_doc).
Chapter 14.
RPC Exports for cfgutils
Documentation missing (cfgutils_rpc_is_gflag_doc).
Documentation missing (cfgutils_rpc_set_gflag_doc).
14.3. cfgutils.get_gflags
Documentation missing (cfgutils_rpc_get_gflags_doc).
14.4. cfgutils.reset_gflag
Documentation missing (cfgutils_rpc_reset_gflag_doc).
14.5. cfgutils.rand_set_prob
Documentation missing (cfgutils_rpc_set_prob_doc).
14.6. cfgutils.rand_reset_prob
Documentation missing (cfgutils_rpc_reset_prob_doc).
14.7. cfgutils.rand_get_prob
Documentation missing (cfgutils_rpc_get_prob_doc).
14.8. cfgutils.get_config_hash
Documentation missing (cfgutils_rpc_get_hash_doc).
14.9. cfgutils.check_config_hash
Documentation missing (cfgutils_rpc_check_hash_doc).
Chapter 17.
RPC Exports for counters
Documentation missing (cnt_get_doc).
Documentation missing (cnt_reset_doc).
Documentation missing (cnt_get_raw_doc).
Documentation missing (cnt_grps_list_doc).
Returns an array.
Documentation missing (cnt_grps_list_doc).
Returns an array.
Documentation missing (cnt_var_list_doc).
Returns an array.
Documentation missing (cnt_var_list_doc).
Returns an array.
Documentation missing (cnt_grp_get_all_doc).
Documentation missing (cnt_grp_get_all_doc).
Documentation missing (cnt_help_doc).
Chapter 25.
RPC Exports for dialog
Print all dialogs
Returns an array.
Print all dialogs with associated context
Returns an array.
Print dialog based on callid and optionally fromtag
Print dialog with associated context based on callid and
optionally fromtag
End a given dialog based on [h_entry] [h_id]
25.6. dlg.profile_get_size
Returns the number of dialogs belonging to a profile
Lists all the dialogs belonging to a profile
Returns an array.
Bridge two SIP addresses in a call using INVITE(hold)-REFER-BYE
mechanism: to, from, [outbound SIP proxy]
End a given dialog based on callid
Chapter 43.
RPC Exports for lcr
Reload lcr tables from database.
Dump the contents of lcr_gws table.
Dump the contents of the lcr_rules table.
Defunct gateway until specified time (Unix timestamp).
Load matching gateways and prints their ids in priority order.
Mandatory parameters are lcr_id and uri_user followed by
optional parameters caller_uri and request_uri. Error is
reported if an lcr_rule with matching prefix and from_uri has
non-null request_uri and request_uri parameter has not been
given.
Chapter 44.
RPC Exports for malloc_test
Allocates the specified number of bytes (debugging/test
function).Use b|k|m|g to specify the desired size unit
Frees the specified number of bytes, previously allocated by
one of the other malloc_test functions (e.g. mt.mem_alloc or
the script mt_mem_alloc). Use b|k|m|g to specify the desired
size unit.Returns the number of bytes freed (can be higher or
smaller then the requested size)
Reallocates the specified number of bytes from a pre-allocated
randomly selected memory chunk. If no pre-allocated memory
chunks exists, it will fail. Make sure mt.mem_used is non 0 or
call mt.mem_alloc prior to calling this function. Returns the
difference in bytes (<0 if bytes were freed, >0 if more
bytes were allocated).Use b|k|m|g to specify the desired size
unit
Returns how many memory chunks and how many bytes are currently
allocated via the mem_alloc module functions. Use b|k|m|g to
specify the desired size unit.
Takes 4 parameters: min, max, total_size and an optional unit
(b|k|m|g). It will allocate total_size memory, in pieces of
random size betweenmin .. max (inclusive).
Takes 7 parameters: min, max, total_size, min_interval,
max_interval, test_time and an optional size unit (b|k|m|g).
All the time units are ms. It will run a memory allocation test
for test_time ms. At a random interval between min_interval and
max_interval ms. it will allocate a memory chunk with random
size, between min and max. Each time total_size is reached, it
will free all the memory allocated and start again.Returns the
test id (integer)
Takes 1 parameter: the test id. It will stop the corresponding
test.Note: the test is stopped, but not destroyed.
44.8. mt.mem_test_destroy
Takes 1 parameter: the test id. It will destroy the
corresponding test.
44.9. mt.mem_test_destroy_all
It will destroy all the tests (running or stopped).
If a test id parameter is provided it will list the
corresponding test, else it will list all of them. Use b |k | m
| g as a second parameter for the size units (default bytes)
Chapter 52.
RPC Exports for permissions
52.1. permissions.trustedReload
Documentation missing (rpc_trusted_reload_doc).
52.2. permissions.addressReload
Documentation missing (rpc_address_reload_doc).
52.3. permissions.trustedDump
Documentation missing (rpc_trusted_dump_doc).
52.4. permissions.addressDump
Documentation missing (rpc_address_dump_doc).
Returns an array.
52.5. permissions.subnetDump
Documentation missing (rpc_subnet_dump_doc).
Returns an array.
52.6. permissions.domainDump
Documentation missing (rpc_domain_name_dump_doc).
52.7. permissions.testUri
Documentation missing (rpc_test_uri_doc).
52.8. permissions.allowUri
Documentation missing (rpc_test_uri_doc).
Chapter 54.
RPC Exports for pipelimit
Documentation missing (rpc_pl_stats_doc).
Returns an array.
Documentation missing (rpc_pl_get_pipes_doc).
Returns an array.
Documentation missing (rpc_pl_set_pipe_doc).
Print PID Controller parameters for the FEEDBACK algorithm:
<ki> <kp> <kd>
Sets the PID Controller parameters for the FEEDBACK algorithm:
<ki> <kp> <kd>
Force the value of the load parameter for FEEDBACK algorithm:
<load>
Chapter 60.
RPC Exports for ratelimit
Print ratelimit statistics: PIPE[<pipe_id>]:
<last_counter>/<pipe_limit> (drop rate:
<drop_rate>)
Print pipes info: PIPE[<pipe_id>]:
<pipe_algo_id>:<pipe_algo>
<last_counter>/<pipe_limit> (drop rate:
<drop_rate>) [<current_counter>]
Sets a pipe params: <pipe_id> <pipe_algorithm>
<pipe_limit>
Print queues info: QUEUE[queue_id]:
<pipe_id>:<queue_method>
Sets queue params: <quue_id> <queue_method>
<pipe_id>
Print PID Controller parameters for the FEEDBACK algorithm:
<ki> <kp> <kd>
Sets the PID Controller parameters for the FEEDBACK algorithm:
<ki> <kp> <kd>
Force the value of the load parameter for FEEDBACK algorithm:
<load>
Sets the ratelimit debug/monitoing logs: 0-off 1-on
Chapter 65.
RPC Exports for sca
65.1. sca.all_subscriptions
Documentation missing (sca_rpc_show_all_subscriptions_doc).
65.2. sca.subscription_count
Documentation missing (sca_rpc_subscription_count_doc).
65.3. sca.show_subscription
Documentation missing (sca_rpc_show_subscription_doc).
Documentation missing (sca_rpc_show_subscribers_doc).
65.5. sca.deactivate_all_subscriptions
Documentation missing
(sca_rpc_deactivate_all_subscriptions_doc).
65.6. sca.deactivate_subscription
Documentation missing (sca_rpc_deactivate_subscription_doc).
65.7. sca.all_appearances
Documentation missing (sca_rpc_show_all_appearances_doc).
65.8. sca.show_appearance
Documentation missing (sca_rpc_show_appearance_doc).
65.9. sca.seize_appearance
Documentation missing (sca_rpc_seize_appearance_doc).
65.10. sca.update_appearance
Documentation missing (sca_rpc_update_appearance_doc).
65.11. sca.release_appearance
Documentation missing (sca_rpc_release_appearance_doc).
Chapter 72.
RPC Exports for tm
Documentation missing (rpc_cancel_doc).
Documentation missing (rpc_reply_doc).
Documentation missing (rpc_reply_callid_doc).
Documentation missing (tm_rpc_stats_doc).
Documentation missing (tm_rpc_hash_stats_doc).
Documentation missing (rpc_t_uac_start_doc).
Documentation missing (rpc_t_uac_wait_doc).
Returns an array.
Chapter 74.
RPC Exports for uac
Documentation missing (rpc_uac_reg_dump_doc).
Returns an array.
Documentation missing (rpc_uac_reg_info_doc).
Documentation missing (rpc_uac_reg_enable_doc).
Documentation missing (rpc_uac_reg_disable_doc).
Documentation missing (rpc_uac_reg_reload_doc).
Documentation missing (rpc_uac_reg_refresh_doc).
Documentation missing (rpc_uac_reg_remove_doc).
Chapter 78.
RPC Exports for usrloc
Dump user location tables
Lookup one AOR in the usrloc location table
Delete a address of record including its contacts
Delete a contact from an AOR record
Flush the usrloc memory cache to DB
Add a new contact for an address of record
Tell number of different unexpired users (AoRs) in database
table (db_mode!=0 only)
Tell number of unexpired contacts in database table (db_mode=3
only)
78.9. ul.db_expired_contacts
Tell number of expired contacts in database table (db_mode=3
only)