doc/rpc_list: regenerated rpc commands lists
[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         Returns an array.
111 </para>
112 </section>
113
114 <section id="core.pwd"><title>core.pwd</title>
115 <para>
116         Returns the working directory of SER server.
117 </para>
118 <para>
119         Returns an array.
120 </para>
121 </section>
122
123 <section id="core.arg"><title>core.arg</title>
124 <para>
125         Returns the list of command line arguments used on SER startup.
126 </para>
127 <para>
128         Returns an array.
129 </para>
130 </section>
131
132 <section id="core.kill"><title>core.kill</title>
133 <para>
134         Sends the given signal to SER.
135 </para>
136 <para>
137 </para>
138 </section>
139
140 <section id="core.shmmem"><title>core.shmmem</title>
141 <para>
142         Returns shared memory info. It has an optional parameter that
143         specifies the measuring unit: b - bytes (default), k or kb, m
144         or mb, g or gb. Note: when using something different from
145         bytes, the value is truncated.
146 </para>
147 <para>
148 </para>
149 </section>
150
151 <section id="core.tcp_info"><title>core.tcp_info</title>
152 <para>
153         Returns tcp related info.
154 </para>
155 <para>
156 </para>
157 </section>
158
159 <section id="core.tcp_options"><title>core.tcp_options</title>
160 <para>
161         Returns active tcp options.
162 </para>
163 <para>
164 </para>
165 </section>
166
167 <section id="core.tcp_list"><title>core.tcp_list</title>
168 <para>
169         Returns tcp connections details.
170 </para>
171 <para>
172 </para>
173 </section>
174
175 <section id="core.udp4_raw_info"><title>core.udp4_raw_info</title>
176 <para>
177         Returns udp4_raw related info.
178 </para>
179 <para>
180 </para>
181 </section>
182
183 <section id="core.aliases_list"><title>core.aliases_list</title>
184 <para>
185         List local SIP server host aliases
186 </para>
187 <para>
188 </para>
189 </section>
190
191 <section id="core.sockets_list"><title>core.sockets_list</title>
192 <para>
193         List local SIP server listen sockets
194 </para>
195 <para>
196 </para>
197 </section>
198
199 <section id="dns.mem_info"><title>dns.mem_info</title>
200 <para>
201         dns cache memory info.
202 </para>
203 <para>
204 </para>
205 </section>
206
207 <section id="dns.debug"><title>dns.debug</title>
208 <para>
209         dns debug  info.
210 </para>
211 <para>
212 </para>
213 </section>
214
215 <section id="dns.debug_all"><title>dns.debug_all</title>
216 <para>
217         complete dns debug  dump
218 </para>
219 <para>
220 </para>
221 </section>
222
223 <section id="dns.view"><title>dns.view</title>
224 <para>
225         dns cache dump in a human-readable format
226 </para>
227 <para>
228 </para>
229 </section>
230
231 <section id="dns.lookup"><title>dns.lookup</title>
232 <para>
233         perform a dns lookup
234 </para>
235 <para>
236 </para>
237 </section>
238
239 <section id="dns.delete_all"><title>dns.delete_all</title>
240 <para>
241         deletes all the non-permanent entries from the DNS cache
242 </para>
243 <para>
244 </para>
245 </section>
246
247 <section id="dns.delete_all_force"><title>dns.delete_all_force</title>
248 <para>
249         deletes all the entries from the DNS cache including the
250         permanent ones
251 </para>
252 <para>
253 </para>
254 </section>
255
256 <section id="dns.add_a"><title>dns.add_a</title>
257 <para>
258         adds an A record to the DNS cache
259 </para>
260 <para>
261 </para>
262 </section>
263
264 <section id="dns.add_aaaa"><title>dns.add_aaaa</title>
265 <para>
266         adds an AAAA record to the DNS cache
267 </para>
268 <para>
269 </para>
270 </section>
271
272 <section id="dns.add_srv"><title>dns.add_srv</title>
273 <para>
274         adds an SRV record to the DNS cache
275 </para>
276 <para>
277 </para>
278 </section>
279
280 <section id="dns.delete_a"><title>dns.delete_a</title>
281 <para>
282         deletes an A record from the DNS cache
283 </para>
284 <para>
285 </para>
286 </section>
287
288 <section id="dns.delete_aaaa"><title>dns.delete_aaaa</title>
289 <para>
290         deletes an AAAA record from the DNS cache
291 </para>
292 <para>
293 </para>
294 </section>
295
296 <section id="dns.delete_srv"><title>dns.delete_srv</title>
297 <para>
298         deletes an SRV record from the DNS cache
299 </para>
300 <para>
301 </para>
302 </section>
303
304 <section id="dns.delete_naptr"><title>dns.delete_naptr</title>
305 <para>
306         deletes a NAPTR record from the DNS cache
307 </para>
308 <para>
309 </para>
310 </section>
311
312 <section id="dns.delete_cname"><title>dns.delete_cname</title>
313 <para>
314         deletes a CNAME record from the DNS cache
315 </para>
316 <para>
317 </para>
318 </section>
319
320 <section id="dns.delete_txt"><title>dns.delete_txt</title>
321 <para>
322         deletes a TXT record from the DNS cache
323 </para>
324 <para>
325 </para>
326 </section>
327
328 <section id="dns.delete_ebl"><title>dns.delete_ebl</title>
329 <para>
330         deletes an EBL record from the DNS cache
331 </para>
332 <para>
333 </para>
334 </section>
335
336 <section id="dns.delete_ptr"><title>dns.delete_ptr</title>
337 <para>
338         deletes an PTR record from the DNS cache
339 </para>
340 <para>
341 </para>
342 </section>
343
344 <section id="dst_blacklist.mem_info"><title>dst_blacklist.mem_info</title>
345 <para>
346         dst blacklist memory usage info.
347 </para>
348 <para>
349 </para>
350 </section>
351
352 <section id="dst_blacklist.debug"><title>dst_blacklist.debug</title>
353 <para>
354         dst blacklist  debug  info.
355 </para>
356 <para>
357 </para>
358 </section>
359
360 <section id="dst_blacklist.view"><title>dst_blacklist.view</title>
361 <para>
362         dst blacklist dump in human-readable format.
363 </para>
364 <para>
365 </para>
366 </section>
367
368 <section id="dst_blacklist.delete_all"><title>dst_blacklist.delete_all</title>
369 <para>
370         Deletes all the entries from the dst blacklist except the
371         permanent ones.
372 </para>
373 <para>
374 </para>
375 </section>
376
377 <section id="dst_blacklist.add"><title>dst_blacklist.add</title>
378 <para>
379         Adds a new entry to the dst blacklist.
380 </para>
381 <para>
382 </para>
383 </section>
384
385 </chapter>