doc/rpc_list: regenerated the lists of rpc commands
[sip-router] / doc / rpc_list / docbook / rpc_core.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!-- this file is autogenerated, do not edit! -->
3 <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
4         "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
5 <chapter id="rpc_exports.core">
6         <title>
7 RPC Exports for core
8         </title>
9
10
11 <section id="system.listMethods"><title>system.listMethods</title>
12 <para>
13         Lists all RPC methods supported by the server.
14 </para>
15 <para>
16         Returns an array.
17 </para>
18 </section>
19
20 <section id="system.methodSignature"><title>system.methodSignature</title>
21 <para>
22         Returns signature of given method.
23 </para>
24 <para>
25 </para>
26 </section>
27
28 <section id="system.methodHelp"><title>system.methodHelp</title>
29 <para>
30         Print the help string for given method.
31 </para>
32 <para>
33 </para>
34 </section>
35
36 <section id="core.prints"><title>core.prints</title>
37 <para>
38         Returns the strings given as parameters.
39 </para>
40 <para>
41         Returns an array.
42 </para>
43 </section>
44
45 <section id="core.printi"><title>core.printi</title>
46 <para>
47         Returns the integers given as parameters.
48 </para>
49 <para>
50         Returns an array.
51 </para>
52 </section>
53
54 <section id="core.echo"><title>core.echo</title>
55 <para>
56         Returns back its parameters.
57 </para>
58 <para>
59         Returns an array.
60 </para>
61 </section>
62
63 <section id="core.version"><title>core.version</title>
64 <para>
65         Returns the version string of the server.
66 </para>
67 <para>
68 </para>
69 </section>
70
71 <section id="core.flags"><title>core.flags</title>
72 <para>
73         Returns the compile flags.
74 </para>
75 <para>
76 </para>
77 </section>
78
79 <section id="core.info"><title>core.info</title>
80 <para>
81         Verbose info, including version number, compile flags,
82         compiler,repository hash a.s.o.
83 </para>
84 <para>
85 </para>
86 </section>
87
88 <section id="core.uptime"><title>core.uptime</title>
89 <para>
90         Returns uptime of SER server.
91 </para>
92 <para>
93 </para>
94 </section>
95
96 <section id="core.ps"><title>core.ps</title>
97 <para>
98         Returns the description of running SER processes.
99 </para>
100 <para>
101         Returns an array.
102 </para>
103 </section>
104
105 <section id="core.psx"><title>core.psx</title>
106 <para>
107         Returns the detailed description of running SER processes.
108 </para>
109 <para>
110 </para>
111 </section>
112
113 <section id="core.pwd"><title>core.pwd</title>
114 <para>
115         Returns the working directory of SER server.
116 </para>
117 <para>
118         Returns an array.
119 </para>
120 </section>
121
122 <section id="core.arg"><title>core.arg</title>
123 <para>
124         Returns the list of command line arguments used on SER startup.
125 </para>
126 <para>
127         Returns an array.
128 </para>
129 </section>
130
131 <section id="core.kill"><title>core.kill</title>
132 <para>
133         Sends the given signal to SER.
134 </para>
135 <para>
136 </para>
137 </section>
138
139 <section id="core.shmmem"><title>core.shmmem</title>
140 <para>
141         Returns shared memory info. It has an optional parameter that
142         specifies the measuring unit: b - bytes (default), k or kb, m
143         or mb, g or gb. Note: when using something different from
144         bytes, the value is truncated.
145 </para>
146 <para>
147 </para>
148 </section>
149
150 <section id="core.tcp_info"><title>core.tcp_info</title>
151 <para>
152         Returns tcp related info.
153 </para>
154 <para>
155 </para>
156 </section>
157
158 <section id="core.tcp_options"><title>core.tcp_options</title>
159 <para>
160         Returns active tcp options.
161 </para>
162 <para>
163 </para>
164 </section>
165
166 <section id="core.tcp_list"><title>core.tcp_list</title>
167 <para>
168         Returns tcp connections details.
169 </para>
170 <para>
171 </para>
172 </section>
173
174 <section id="core.udp4_raw_info"><title>core.udp4_raw_info</title>
175 <para>
176         Returns udp4_raw related info.
177 </para>
178 <para>
179 </para>
180 </section>
181
182 <section id="core.aliases_list"><title>core.aliases_list</title>
183 <para>
184         List local SIP server host aliases
185 </para>
186 <para>
187 </para>
188 </section>
189
190 <section id="core.sockets_list"><title>core.sockets_list</title>
191 <para>
192         List local SIP server listen sockets
193 </para>
194 <para>
195 </para>
196 </section>
197
198 <section id="dns.mem_info"><title>dns.mem_info</title>
199 <para>
200         dns cache memory info.
201 </para>
202 <para>
203 </para>
204 </section>
205
206 <section id="dns.debug"><title>dns.debug</title>
207 <para>
208         dns debug  info.
209 </para>
210 <para>
211 </para>
212 </section>
213
214 <section id="dns.debug_all"><title>dns.debug_all</title>
215 <para>
216         complete dns debug  dump
217 </para>
218 <para>
219 </para>
220 </section>
221
222 <section id="dns.view"><title>dns.view</title>
223 <para>
224         dns cache dump in a human-readable format
225 </para>
226 <para>
227 </para>
228 </section>
229
230 <section id="dns.lookup"><title>dns.lookup</title>
231 <para>
232         perform a dns lookup
233 </para>
234 <para>
235 </para>
236 </section>
237
238 <section id="dns.delete_all"><title>dns.delete_all</title>
239 <para>
240         deletes all the non-permanent entries from the DNS cache
241 </para>
242 <para>
243 </para>
244 </section>
245
246 <section id="dns.delete_all_force"><title>dns.delete_all_force</title>
247 <para>
248         deletes all the entries from the DNS cache including the
249         permanent ones
250 </para>
251 <para>
252 </para>
253 </section>
254
255 <section id="dns.add_a"><title>dns.add_a</title>
256 <para>
257         adds an A record to the DNS cache
258 </para>
259 <para>
260 </para>
261 </section>
262
263 <section id="dns.add_aaaa"><title>dns.add_aaaa</title>
264 <para>
265         adds an AAAA record to the DNS cache
266 </para>
267 <para>
268 </para>
269 </section>
270
271 <section id="dns.add_srv"><title>dns.add_srv</title>
272 <para>
273         adds an SRV record to the DNS cache
274 </para>
275 <para>
276 </para>
277 </section>
278
279 <section id="dns.delete_a"><title>dns.delete_a</title>
280 <para>
281         deletes an A record from the DNS cache
282 </para>
283 <para>
284 </para>
285 </section>
286
287 <section id="dns.delete_aaaa"><title>dns.delete_aaaa</title>
288 <para>
289         deletes an AAAA record from the DNS cache
290 </para>
291 <para>
292 </para>
293 </section>
294
295 <section id="dns.delete_srv"><title>dns.delete_srv</title>
296 <para>
297         deletes an SRV record from the DNS cache
298 </para>
299 <para>
300 </para>
301 </section>
302
303 <section id="dns.delete_naptr"><title>dns.delete_naptr</title>
304 <para>
305         deletes a NAPTR record from the DNS cache
306 </para>
307 <para>
308 </para>
309 </section>
310
311 <section id="dns.delete_cname"><title>dns.delete_cname</title>
312 <para>
313         deletes a CNAME record from the DNS cache
314 </para>
315 <para>
316 </para>
317 </section>
318
319 <section id="dns.delete_txt"><title>dns.delete_txt</title>
320 <para>
321         deletes a TXT record from the DNS cache
322 </para>
323 <para>
324 </para>
325 </section>
326
327 <section id="dns.delete_ebl"><title>dns.delete_ebl</title>
328 <para>
329         deletes an EBL record from the DNS cache
330 </para>
331 <para>
332 </para>
333 </section>
334
335 <section id="dns.delete_ptr"><title>dns.delete_ptr</title>
336 <para>
337         deletes an PTR record from the DNS cache
338 </para>
339 <para>
340 </para>
341 </section>
342
343 <section id="dst_blacklist.mem_info"><title>dst_blacklist.mem_info</title>
344 <para>
345         dst blacklist memory usage info.
346 </para>
347 <para>
348 </para>
349 </section>
350
351 <section id="dst_blacklist.debug"><title>dst_blacklist.debug</title>
352 <para>
353         dst blacklist  debug  info.
354 </para>
355 <para>
356 </para>
357 </section>
358
359 <section id="dst_blacklist.view"><title>dst_blacklist.view</title>
360 <para>
361         dst blacklist dump in human-readable format.
362 </para>
363 <para>
364 </para>
365 </section>
366
367 <section id="dst_blacklist.delete_all"><title>dst_blacklist.delete_all</title>
368 <para>
369         Deletes all the entries from the dst blacklist except the
370         permanent ones.
371 </para>
372 <para>
373 </para>
374 </section>
375
376 <section id="dst_blacklist.add"><title>dst_blacklist.add</title>
377 <para>
378         Adds a new entry to the dst blacklist.
379 </para>
380 <para>
381 </para>
382 </section>
383
384 </chapter>