RPC Exports List

Revision History
Revision sip-router git-0ea931 Fri, 25 Nov 2011 23:59:50 +0100
Automatically generated by: make -C doc/rpc_list all

Table of Contents

1. RPC Exports for core
2. RPC Exports for cfg_rpc
3. RPC Exports for counters
4. RPC Exports for ctl
5. RPC Exports for db_flatstore
6. RPC Exports for debugger
7. RPC Exports for dialplan
8. RPC Exports for lcr
9. RPC Exports for malloc_test
10. RPC Exports for mi_rpc
11. RPC Exports for prefix_route
12. RPC Exports for ratelimit
13. RPC Exports for sl
14. RPC Exports for tls
15. RPC Exports for tm
16. RPC Exports for dialog
17. RPC Exports for dispatcher
18. RPC Exports for domain
19. RPC Exports for htable
20. RPC Exports for kex
21. RPC Exports for uac
22. RPC Exports for usrloc
23. RPC Exports for cpl-c
24. RPC Exports for dispatcher_s
25. RPC Exports for domain_s
26. RPC Exports for gflags
27. RPC Exports for pdt
28. RPC Exports for pike
29. RPC Exports for presence_b2b
30. RPC Exports for usrloc_s

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.

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

20. core.sctp_info

Returns sctp related info.

21. core.udp4_raw_info

Returns udp4_raw related info.

22. dns.mem_info

dns cache memory info.

23. dns.debug

dns debug info.

24. dns.debug_all

complete dns debug dump

25. dns.view

dns cache dump in a human-readable format

26. dns.lookup

perform a dns lookup

27. dns.delete_all

deletes all the non-permanent entries from the DNS cache

28. dns.delete_all_force

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

29. dns.add_a

adds an A record to the DNS cache

30. dns.add_aaaa

adds an AAAA record to the DNS cache

31. dns.add_srv

adds an SRV record to the DNS cache

32. dns.delete_a

deletes an A record from the DNS cache

33. dns.delete_aaaa

deletes an AAAA record from the DNS cache

34. dns.delete_srv

deletes an SRV record from the DNS cache

35. dns.delete_naptr

deletes a NAPTR record from the DNS cache

36. dns.delete_cname

deletes a CNAME record from the DNS cache

37. dns.delete_txt

deletes a TXT record from the DNS cache

38. dns.delete_ebl

deletes an EBL record from the DNS cache

39. dns.delete_ptr

deletes an PTR record from the DNS cache

40. dst_blacklist.mem_info

dst blacklist memory usage info.

41. dst_blacklist.debug

dst blacklist debug info.

42. dst_blacklist.view

dst blacklist dump in human-readable format.

43. dst_blacklist.delete_all

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

44. dst_blacklist.add

Adds a new entry to the dst blacklist.

Chapter 2.  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 3.  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 4.  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 5.  RPC Exports for db_flatstore

Table of Contents

1. flatstore.rotate

1. flatstore.rotate

Documentation missing (flat_rotate_doc).

Chapter 6.  RPC Exports for debugger

Table of Contents

1. dbg.bp
2. dbg.ls
3. dbg.trace

1. dbg.bp

Documentation missing (dbg_rpc_bp_doc).

2. dbg.ls

List debugging process array

3. dbg.trace

Config trace command

Chapter 7.  RPC Exports for dialplan

1. dialplan.reload

Reload dialplan table from database

2. dialplan.dump

Perform dialplan translation

Chapter 8.  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.

Chapter 9.  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 10.  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 11.  RPC Exports for prefix_route

1. prefix_route.reload

Documentation missing (rpc_reload_doc).

2. prefix_route.dump

Documentation missing (rpc_dump_doc).

Chapter 12.  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 13.  RPC Exports for sl

Table of Contents

1. sl.stats

1. sl.stats

Documentation missing (rpc_stats_doc).

Chapter 14.  RPC Exports for tls

1. tls.reload

Documentation missing (tls_reload_doc).

2. tls.list

Documentation missing (tls_list_doc).

Returns an array.

3. tls.info

Documentation missing (tls_info_doc).

4. tls.options

Documentation missing (tls_options_doc).

Chapter 15.  RPC Exports for tm

1. tm.cancel

Documentation missing (rpc_cancel_doc).

2. tm.reply

Documentation missing (rpc_reply_doc).

3. tm.stats

Documentation missing (tm_rpc_stats_doc).

4. tm.hash_stats

Documentation missing (tm_rpc_hash_stats_doc).

5. tm.t_uac_start

Documentation missing (rpc_t_uac_start_doc).

6. tm.t_uac_wait

Documentation missing (rpc_t_uac_wait_doc).

Returns an array.

Chapter 16.  RPC Exports for dialog

1. dlg.list

Print all dialogs

2. dlg.list_ctx

Print all dialogs with associated context

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

8. dlg.bridge_dlg

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

Chapter 17.  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 18.  RPC Exports for 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 19.  RPC Exports for htable

Table of Contents

1. htable.dump

1. htable.dump

Dump the contents of hash table.

Chapter 20.  RPC Exports for kex

Table of Contents

1. pkg.stats

1. pkg.stats

Private memory (pkg) statistics per process

Chapter 21.  RPC Exports for uac

Table of Contents

1. uac.reg_dump

1. uac.reg_dump

Dump the contents of user registrations table.

Chapter 22.  RPC Exports for usrloc

Table of Contents

1. ul.dump

1. ul.dump

Dump user location tables

Chapter 23.  RPC Exports for cpl-c

1. cpl.load

Load a CPL script to the server.

2. cpl.remove

Remove a CPL script from server.

3. cpl.get

Return a CPL script.

Chapter 24.  RPC Exports for dispatcher_s

1. dispatcher.dump

Dump dispatcher set configuration

2. dispatcher.reload

Reload dispatcher list from file

Chapter 25.  RPC Exports for domain_s

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 26.  RPC Exports for 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 27.  RPC Exports for pdt

1. pdt.add

Add new prefix/domain translation rule.

2. pdt.delete

Delete prefix/domain translation rule.

3. pdt.list

List existin prefix/domain translation rules

Returns an array.

Chapter 28.  RPC Exports for pike

Table of Contents

1. pike.top

1. pike.top

pike.top doc.

Chapter 29.  RPC Exports for presence_b2b

1. presence_b2b.test

Testing events.

2. presence_b2b.trace

Trace events.

Chapter 30.  RPC Exports for usrloc_s

1. usrloc.stats

Documentation missing (rpc_stats_doc).

Returns an array.

2. usrloc.delete_uid

Documentation missing (rpc_delete_uid_doc).

3. usrloc.delete_contact

Documentation missing (rpc_delete_contact_doc).

4. usrloc.dump

Documentation missing (rpc_dump_doc).

5. usrloc.dump_file

Documentation missing (rpc_dump_file_doc).

6. usrloc.flush

Documentation missing (rpc_flush_doc).

7. usrloc.add_contact

Documentation missing (rpc_add_contact_doc).

8. usrloc.show_contacts

Documentation missing (rpc_show_contacts_doc).

Returns an array.