RPC Exports List

Revision History
Revision sip-router git-c21808 Tue, 14 Oct 2014 14:24:16 +0200
Automatically generated by: make -C doc/rpc_list all

Table of Contents

1. RPC Exports for core
2. RPC Exports for app_lua
3. RPC Exports for app_perl
4. RPC Exports for carrierroute
5. RPC Exports for cdp
6. RPC Exports for cfg_rpc
7. RPC Exports for cnxcc
8. RPC Exports for corex
9. RPC Exports for counters
10. RPC Exports for ctl
11. RPC Exports for db_flatstore
12. RPC Exports for db_flatstore
13. RPC Exports for db_text
14. RPC Exports for debugger
15. RPC Exports for dialog
16. RPC Exports for dialog_ng
17. RPC Exports for dialplan
18. RPC Exports for dispatcher
19. RPC Exports for dmq
20. RPC Exports for domain
21. RPC Exports for drouting
22. RPC Exports for htable
23. RPC Exports for ims_usrloc_pcscf
24. RPC Exports for ims_usrloc_scscf
25. RPC Exports for jsonrpc-s
26. RPC Exports for kex
27. RPC Exports for kex
28. RPC Exports for lcr
29. RPC Exports for malloc_test
30. RPC Exports for mi_rpc
31. RPC Exports for msrp
32. RPC Exports for mtree
33. RPC Exports for pdt
34. RPC Exports for permissions
35. RPC Exports for pike
36. RPC Exports for pipelimit
37. RPC Exports for prefix_route
38. RPC Exports for presence
39. RPC Exports for pv
40. RPC Exports for ratelimit
41. RPC Exports for sca
42. RPC Exports for sctp
43. RPC Exports for sipcapture
44. RPC Exports for siptrace
45. RPC Exports for sl
46. RPC Exports for tls
47. RPC Exports for tm
48. RPC Exports for uac
49. RPC Exports for uid_domain
50. RPC Exports for uid_gflags
51. RPC Exports for usrloc
52. RPC Exports for xhttp_pi

Chapter 1.  RPC Exports for core

1. system.listMethods

Lists all RPC methods supported by the server.

Returns an array.

2. system.methodSignature

Returns signature of given method.

3. system.methodHelp

Print the help string for given method.

4. core.prints

Returns the strings given as parameters.

Returns an array.

5. core.printi

Returns the integers given as parameters.

Returns an array.

6. core.echo

Returns back its parameters.

Returns an array.

7. core.version

Returns the version string of the server.

8. core.flags

Returns the compile flags.

9. core.info

Verbose info, including version number, compile flags, compiler,repository hash a.s.o.

10. core.uptime

Returns uptime of SER server.

11. core.ps

Returns the description of running SER processes.

Returns an array.

12. core.psx

Returns the detailed description of running SER processes.

Returns an array.

13. core.pwd

Returns the working directory of SER server.

Returns an array.

14. core.arg

Returns the list of command line arguments used on SER startup.

Returns an array.

15. core.kill

Sends the given signal to SER.

16. core.shmmem

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.

17. core.tcp_info

Returns tcp related info.

18. core.tcp_options

Returns active tcp options.

19. core.tcp_list

Returns tcp connections details.

20. core.udp4_raw_info

Returns udp4_raw related info.

21. core.aliases_list

List local SIP server host aliases

22. core.sockets_list

List local SIP server listen sockets

23. dns.mem_info

dns cache memory info.

24. dns.debug

dns debug info.

25. dns.debug_all

complete dns debug dump

26. dns.view

dns cache dump in a human-readable format

27. dns.lookup

perform a dns lookup

28. dns.delete_all

deletes all the non-permanent entries from the DNS cache

29. dns.delete_all_force

deletes all the entries from the DNS cache including the permanent ones

30. dns.add_a

adds an A record to the DNS cache

31. dns.add_aaaa

adds an AAAA record to the DNS cache

32. dns.add_srv

adds an SRV record to the DNS cache

33. dns.delete_a

deletes an A record from the DNS cache

34. dns.delete_aaaa

deletes an AAAA record from the DNS cache

35. dns.delete_srv

deletes an SRV record from the DNS cache

36. dns.delete_naptr

deletes a NAPTR record from the DNS cache

37. dns.delete_cname

deletes a CNAME record from the DNS cache

38. dns.delete_txt

deletes a TXT record from the DNS cache

39. dns.delete_ebl

deletes an EBL record from the DNS cache

40. dns.delete_ptr

deletes an PTR record from the DNS cache

41. dst_blacklist.mem_info

dst blacklist memory usage info.

42. dst_blacklist.debug

dst blacklist debug info.

43. dst_blacklist.view

dst blacklist dump in human-readable format.

44. dst_blacklist.delete_all

Deletes all the entries from the dst blacklist except the permanent ones.

45. dst_blacklist.add

Adds a new entry to the dst blacklist.

Chapter 2.  RPC Exports for app_lua

1. app_lua.reload

Reload lua script

2. app_lua.list

list lua scripts

Chapter 3.  RPC Exports for app_perl

1. app_perl.set_reset_cycles

Set the value for reset_cycles

2. app_perl.get_reset_cycles

Get the value for reset_cycles

Chapter 4.  RPC Exports for carrierroute

Table of Contents

1. cr.reload_routes

1. cr.reload_routes

Reload routes

Chapter 5.  RPC Exports for cdp

1. cdp.disable_peer

disable diameter peer

2. cdp.enable_peer

enable diameter peer

3. cdp.list_peers

list diameter peers and their state

Chapter 6.  RPC Exports for cfg_rpc

1. cfg.set

Set the value of a configuration variable and commit the change immediately

2. cfg.set_now_int

Set the value of a configuration variable and commit the change immediately

3. cfg.seti

Set the value of a configuration variable and commit the change immediately

4. cfg.set_now_string

Set the value of a configuration variable and commit the change immediately

5. cfg.sets

Set the value of a configuration variable and commit the change immediately

6. cfg.del

Delete the value of a configuration variable from a group instance and commit the change immediately

7. cfg.set_delayed

Prepare the change of a configuration variable, but does not commit the new value yet

8. cfg.set_delayed_int

Prepare the change of a configuration variable, but does not commit the new value yet

9. cfg.set_delayed_string

Prepare the change of a configuration variable, but does not commit the new value yet

10. cfg.del_delayed

Prepare the deletion of the value of a configuration variable from a group instance, but does not commit the change yet

11. cfg.commit

Commit the previously prepared configuration changes

12. cfg.rollback

Drop the prepared configuration changes

13. cfg.get

Get the value of a configuration variable

14. cfg.help

Print the description of a configuration variable

15. cfg.list

List the configuration variables

16. cfg.diff

List the pending configuration changes that have not been committed yet

17. cfg.add_group_inst

Add a new instance to an existing configuration group

18. cfg.del_group_inst

Delte an instance of a configuration group

Chapter 7.  RPC Exports for cnxcc

1. cnxcc.active_clients

List of clients with active calls

2. cnxcc.check_client

Check specific client calls

3. cnxcc.kill_call

Kill call using its call ID

Chapter 8.  RPC Exports for corex

1. corex.list_sockets

List listening sockets

Returns an array.

2. corex.list_aliases

List socket aliases

Returns an array.

3. corex.shm_status

Trigger shm status dump to syslog

4. corex.shm_summary

Trigger shm summary dump to syslog

Chapter 9.  RPC Exports for counters

1. cnt.get

get counter value (takes group and counter name as parameters)

2. cnt.reset

reset counter (takes group and counter name as parameters)

3. cnt.get_raw

get raw counter value (debugging version)

4. cnt.grps_list

list all the counter group names

Returns an array.

5. cnt.var_list

list all the counters names in a specified group

Returns an array.

6. cnt.grp_get_all

list all counter names and values in a specified group

7. cnt.help

print the description of a counter (group and counter name required).

Chapter 10.  RPC Exports for ctl

1. ctl.who

list open connections

2. ctl.connections

returns number of open connections

3. ctl.listen

list ctl listen sockets

Chapter 11.  RPC Exports for db_flatstore

Table of Contents

1. flatstore.k_rotate

1. flatstore.k_rotate

Close and reopen flatrotate files during log rotation.

Chapter 12.  RPC Exports for db_flatstore

Table of Contents

1. flatstore.k_rotate

1. flatstore.k_rotate

Close and reopen flatrotate files during log rotation.

Chapter 13.  RPC Exports for db_text

Table of Contents

1. db_text.dump

1. db_text.dump

Write back to disk modified tables

Chapter 14.  RPC Exports for debugger

1. dbg.bp

Breakpoint command

2. dbg.ls

List debugging process array

3. dbg.trace

Config trace command

4. dbg.mod_level

Specify module log level

5. dbg.reset_msgid

Reset msgid on all process

Chapter 15.  RPC Exports for dialog

1. dlg.list

Print all dialogs

Returns an array.

2. dlg.list_ctx

Print all dialogs with associated context

Returns an array.

3. dlg.dlg_list

Print dialog based on callid and fromtag

4. dlg.dlg_list_ctx

Print dialog with associated context based on callid and fromtag

5. dlg.end_dlg

End a given dialog based on [h_entry] [h_id]

6. dlg.profile_get_size

Returns the number of dialogs belonging to a profile

7. dlg.profile_list

Lists all the dialogs belonging to a profile

Returns an array.

8. dlg.bridge_dlg

Bridge two SIP addresses in a call using INVITE(hold)-REFER-BYE mechanism: to, from, [outbound SIP proxy]

Chapter 16.  RPC Exports for dialog_ng

Table of Contents

1. dlg2.list

1. dlg2.list

Print all dialogs

Chapter 17.  RPC Exports for dialplan

1. dialplan.reload

Reload dialplan table from database

2. dialplan.translate

Perform dialplan translation

Chapter 18.  RPC Exports for dispatcher

1. dispatcher.reload

Reload dispatcher destination sets

2. dispatcher.list

Return the content of dispatcher sets

3. dispatcher.set_state

Set the state of a destination address

Chapter 19.  RPC Exports for dmq

Table of Contents

1. dmq.list_nodes

1. dmq.list_nodes

Print all nodes

Returns an array.

Chapter 20.  RPC Exports for domain

Table of Contents

1. domain.reload
2. domain.dump

1. domain.reload

Reload domain tables from database

2. domain.dump

Return the contents of domain and domain_attrs tables

Chapter 21.  RPC Exports for drouting

Table of Contents

1. drouting.reload

1. drouting.reload

Write back to disk modified tables

Chapter 22.  RPC Exports for htable

1. htable.dump

Dump the contents of hash table.

Returns an array.

2. htable.delete

Delete one key from a hash table.

3. htable.get

Get one key from a hash table.

4. htable.sets

Set one key in a hash table to a string value.

5. htable.seti

Set one key in a hash table to an integer value.

6. htable.listTables

List all htables.

Returns an array.

7. htable.reload

Reload hash table.

8. htable.stats

Statistics about htables.

Returns an array.

Chapter 23.  RPC Exports for ims_usrloc_pcscf

Table of Contents

1. ulpcscf.status

1. ulpcscf.status

Dump PCSCF contacts and associated identitites

Chapter 24.  RPC Exports for ims_usrloc_scscf

1. ulscscf.status

Dump SCSCF user location tables

2. ulscscf.showimpu

Dump SCSCF IMPU information

Chapter 25.  RPC Exports for jsonrpc-s

Table of Contents

1. jsonrpc.echo

1. jsonrpc.echo

Sample echo command

Returns an array.

Chapter 26.  RPC Exports for kex

Table of Contents

1. pkg.stats

1. pkg.stats

Private memory (pkg) statistics per process

Returns an array.

Chapter 27.  RPC Exports for kex

Table of Contents

1. pkg.stats

1. pkg.stats

Private memory (pkg) statistics per process

Returns an array.

Chapter 28.  RPC Exports for lcr

1. lcr.reload

Reload lcr tables from database.

2. lcr.dump_gws

Dump the contents of lcr_gws table.

3. lcr.dump_rules

Dump the contents of the lcr_rules table.

4. lcr.defunct_gw

Defunct gateway until specified time (Unix timestamp).

Chapter 29.  RPC Exports for malloc_test

1. mt.mem_alloc

Allocates the specified number of bytes (debugging/test function).Use b|k|m|g to specify the desired size unit

2. mt.mem_free

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)

3. mt.mem_realloc

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

4. mt.mem_used

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.

5. mt.mem_rnd_alloc

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).

6. mt.mem_test_start

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)

7. mt.mem_test_stop

Takes 1 parameter: the test id. It will stop the corresponding test.Note: the test is stopped, but not destroyed.

8. mt.mem_test_destroy

Takes 1 parameter: the test id. It will destroy the corresponding test.

9. mt.mem_test_destroy_all

It will destroy all the tests (running or stopped).

10. mt.mem_test_list

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 30.  RPC Exports for mi_rpc

1. mi

Execute MI command

Returns an array.

2. mi_fifo

Execute MI command

Returns an array.

3. mi_dg

Execute MI command

Returns an array.

4. mi_xmlrpc

Execute MI command

Returns an array.

Chapter 31.  RPC Exports for msrp

Table of Contents

1. msrp.cmaplist

1. msrp.cmaplist

Return the content of dispatcher sets

Chapter 32.  RPC Exports for mtree

1. mtree.summary

Print summary of loaded mtree tables

Returns an array.

2. mtree.reload

Reload mtrees from database to memory

3. mtree.match

Match prefix value against mtree

Chapter 33.  RPC Exports for pdt

Table of Contents

1. pdt.reload
2. pdt.list

1. pdt.reload

Reload PDT database records

2. pdt.list

List PDT memory records

Chapter 34.  RPC Exports for permissions

1. permissions.trustedReload

Reload permissions trusted table

2. permissions.addressReload

Reload permissions address table

3. permissions.trustedDump

Dump permissions trusted table

4. permissions.addressDump

Dump permissions address table

5. permissions.subnetDump

Dump permissions subnet table

6. permissions.domainDump

Dump permissions domain name table

7. permissions.testUri

Tests if (URI, Contact) pair is allowed according to allow/deny files

Chapter 35.  RPC Exports for pike

Table of Contents

1. pike.top

1. pike.top

pike.top Dump parts of the pike table

Chapter 36.  RPC Exports for pipelimit

1. pl.stats

Print pipelimit statistics: <id> <load> <counter>

2. pl.get_pipes

Print pipes info: <id> <algorithm> <limit> <counter>

3. pl.set_pipe

Sets a pipe params: <pipe_id> <pipe_algorithm> <pipe_limit>

4. pl.get_pid

Print PID Controller parameters for the FEEDBACK algorithm: <ki> <kp> <kd>

5. pl.set_pid

Sets the PID Controller parameters for the FEEDBACK algorithm: <ki> <kp> <kd>

6. pl.push_load

Force the value of the load parameter for FEEDBACK algorithm: <load>

Chapter 37.  RPC Exports for prefix_route

1. prefix_route.reload

Reload prefix routes from DB

2. prefix_route.dump

Dump the prefix route tree

Chapter 38.  RPC Exports for presence

Table of Contents

1. presence.cleanup

1. presence.cleanup

Manually triggers the cleanup functions for the active_watchers, presentity, and watchers tables.

Chapter 39.  RPC Exports for pv

Table of Contents

1. pv.shvSet
2. pv.shvGet

1. pv.shvSet

Set a shared variable (args: name type value)

2. pv.shvGet

Get the value of a shared variable. If no argument, dumps all

Chapter 40.  RPC Exports for ratelimit

1. rl.stats

Print ratelimit statistics: PIPE[<pipe_id>]: <last_counter>/<pipe_limit> (drop rate: <drop_rate>)

2. rl.get_pipes

Print pipes info: PIPE[<pipe_id>]: <pipe_algo_id>:<pipe_algo> <last_counter>/<pipe_limit> (drop rate: <drop_rate>) [<current_counter>]

3. rl.set_pipe

Sets a pipe params: <pipe_id> <pipe_algorithm> <pipe_limit>

4. rl.get_queues

Print queues info: QUEUE[queue_id]: <pipe_id>:<queue_method>

5. rl.set_queue

Sets queue params: <quue_id> <queue_method> <pipe_id>

6. rl.get_pid

Print PID Controller parameters for the FEEDBACK algorithm: <ki> <kp> <kd>

7. rl.set_pid

Sets the PID Controller parameters for the FEEDBACK algorithm: <ki> <kp> <kd>

8. rl.push_load

Force the value of the load parameter for FEEDBACK algorithm: <load>

9. rl.set_dbg

Sets the ratelimit debug/monitoing logs: 0-off 1-on

Chapter 41.  RPC Exports for sca

1. sca.all_subscriptions

Documentation missing (sca_rpc_show_all_subscriptions_doc).

2. sca.subscription_count

Documentation missing (sca_rpc_subscription_count_doc).

3. sca.show_subscription

Documentation missing (sca_rpc_show_subscription_doc).

4. sca.subscribers

Documentation missing (sca_rpc_show_subscribers_doc).

5. sca.deactivate_all_subscriptions

Documentation missing (sca_rpc_deactivate_all_subscriptions_doc).

6. sca.deactivate_subscription

Documentation missing (sca_rpc_deactivate_subscription_doc).

7. sca.all_appearances

Documentation missing (sca_rpc_show_all_appearances_doc).

8. sca.show_appearance

Documentation missing (sca_rpc_show_appearance_doc).

9. sca.seize_appearance

Documentation missing (sca_rpc_seize_appearance_doc).

10. sca.update_appearance

Documentation missing (sca_rpc_update_appearance_doc).

11. sca.release_appearance

Documentation missing (sca_rpc_release_appearance_doc).

Chapter 42.  RPC Exports for sctp

Table of Contents

1. sctp.options
2. sctp.info

1. sctp.options

Returns active sctp options. With one parameter it returns the sctp options set in the kernel for a specific socket(debugging), with 0 filled in for non-kernel related options. The parameter can be: "default" | "first" | address[:port] . With no parameters it returns ser's idea of the current sctp options (intended non-debugging use).

2. sctp.info

Returns sctp related info.

Chapter 43.  RPC Exports for sipcapture

Table of Contents

1. sipcapture.status

1. sipcapture.status

Get status or turn on/off sipcapture.

Chapter 44.  RPC Exports for siptrace

Table of Contents

1. siptrace.status

1. siptrace.status

Get status or turn on/off siptrace. Parameters: on, off or check.

Chapter 45.  RPC Exports for sl

Table of Contents

1. sl.stats

1. sl.stats

Print reply statistics.

Chapter 46.  RPC Exports for tls

1. tls.reload

Reload TLS configuration file

2. tls.list

List currently open TLS connections

Returns an array.

3. tls.info

Returns internal tls related info.

4. tls.options

Dumps all the tls config options.

Chapter 47.  RPC Exports for tm

1. tm.cancel

Cancel a pending transaction

2. tm.reply

Reply transaction

3. tm.stats

Print transaction statistics.

4. tm.hash_stats

Prints hash table statistics (can be used only if tm is compiled with -DTM_HASH_STATS).

5. tm.t_uac_start

starts a tm uac using a list of string parameters: method, ruri, dst_uri, send_sock, headers (CRLF separated) and body (optional)

6. tm.t_uac_wait

starts a tm uac and waits for the final reply, using a list of string parameters: method, ruri, dst_uri send_sock, headers (CRLF separated) and body (optional)

Returns an array.

Chapter 48.  RPC Exports for uac

1. uac.reg_dump

Dump the contents of user registrations table.

2. uac.reg_info

Return the details of registration for a particular record.

3. uac.reg_enable

Enable registration for a particular record.

4. uac.reg_disable

Disable registration for a particular record.

5. uac.reg_reload

Reload records from database.

6. uac.reg_refresh

Refresh a record from database.

Chapter 49.  RPC Exports for uid_domain

Table of Contents

1. domain.reload
2. domain.dump

1. domain.reload

Reload domain table from database

2. domain.dump

Return the contents of domain table

Chapter 50.  RPC Exports for uid_gflags

1. gflags.set

Load a CPL script to the server.

2. gflags.is_set

Load a CPL script to the server.

3. gflags.reset

Load a CPL script to the server.

4. gflags.flush

Load a CPL script to the server.

5. gflags.dump

Load a CPL script to the server.

6. global.reload

Reload global attributes from database

Chapter 51.  RPC Exports for usrloc

1. ul.dump

Dump user location tables

2. ul.lookup

Lookup one AOR in the usrloc location table

3. ul.rm

Delete a address of record including its contacts

4. ul.rm_contact

Delete a contact from an AOR record

5. ul.flush

Flush the usrloc memory cache to DB

6. ul.add

Add a new contact for an address of record

7. ul.db_users

Tell number of different unexpired users (AoRs) in database table (db_mode!=0 only)

8. ul.db_contacts

Tell number of unexpired contacts in database table (db_mode=3 only)

9. ul.db_expired_contacts

Tell number of expired contacts in database table (db_mode=3 only)

Chapter 52.  RPC Exports for xhttp_pi

Table of Contents

1. xhttp_pi.reload

1. xhttp_pi.reload

Reload the xml framework