Gitiles
Code Review Sign In
gerrit.osmocom.org / osmo-mgw / 3ac604e3adabd373ddd94a22654e72aabcd96346 / . / doc / manuals / vty / mgw_vty_reference.xml
blob: 834db040b37db88bf3f4cf102a292adc8ed9ef83 [file] [log] [blame]
Neels Hofmeyr2818db82018-03-06 14:59:00 +0100[diff] [blame]1<vtydoc xmlns='urn:osmocom:xml:libosmocore:vty:doc:1.0'>
2 <node id='_common_cmds_'>
3 <name>Common Commands</name>
4 <description>These commands are available on all VTY nodes. They are listed here only once, to unclutter the VTY reference.</description>
5 <command id='help'>
6 <params>
7 <param name='help' doc='Description of the interactive help system' />
8 </params>
9 </command>
10 <command id='list'>
11 <params>
12 <param name='list' doc='Print command list' />
13 </params>
14 </command>
15 <command id='write terminal'>
16 <params>
17 <param name='write' doc='Write running configuration to memory, network, or terminal' />
18 <param name='terminal' doc='Write to terminal' />
19 </params>
20 </command>
21 <command id='write file'>
22 <params>
23 <param name='write' doc='Write running configuration to memory, network, or terminal' />
24 <param name='file' doc='Write to configuration file' />
25 </params>
26 </command>
27 <command id='write memory'>
28 <params>
29 <param name='write' doc='Write running configuration to memory, network, or terminal' />
30 <param name='memory' doc='Write configuration to the file (same as write file)' />
31 </params>
32 </command>
33 <command id='write'>
34 <params>
35 <param name='write' doc='Write running configuration to memory, network, or terminal' />
36 </params>
37 </command>
38 <command id='show running-config'>
39 <params>
40 <param name='show' doc='Show running system information' />
41 <param name='running-config' doc='running configuration' />
42 </params>
43 </command>
44 <command id='exit'>
45 <params>
46 <param name='exit' doc='Exit current mode and down to previous mode' />
47 </params>
48 </command>
49 <command id='end'>
50 <params>
51 <param name='end' doc='End current mode and change to enable mode.' />
52 </params>
53 </command>
54 </node>
55 <node id='view'>
56 <name>view</name>
57 <command id='show version'>
58 <params>
59 <param name='show' doc='Show running system information' />
60 <param name='version' doc='Displays program version' />
61 </params>
62 </command>
63 <command id='show online-help'>
64 <params>
65 <param name='show' doc='Show running system information' />
66 <param name='online-help' doc='Online help' />
67 </params>
68 </command>
69 <command id='enable'>
70 <params>
71 <param name='enable' doc='Turn on privileged mode command' />
72 </params>
73 </command>
74 <command id='terminal length &lt;0-512&gt;'>
75 <params>
76 <param name='terminal' doc='Set terminal line parameters' />
77 <param name='length' doc='Set number of lines on a screen' />
78 <param name='&lt;0-512&gt;' doc='Number of lines on screen (0 for no pausing)' />
79 </params>
80 </command>
81 <command id='terminal no length'>
82 <params>
83 <param name='terminal' doc='Set terminal line parameters' />
84 <param name='no' doc='Negate a command or set its defaults' />
85 <param name='length' doc='Set number of lines on a screen' />
86 </params>
87 </command>
Neels Hofmeyr2818db82018-03-06 14:59:00 +0100[diff] [blame]88 <command id='who'>
89 <params>
90 <param name='who' doc='Display who is on vty' />
91 </params>
92 </command>
93 <command id='show history'>
94 <params>
95 <param name='show' doc='Show running system information' />
96 <param name='history' doc='Display the session command history' />
97 </params>
98 </command>
99 <command id='logging enable'>
100 <params>
101 <param name='logging' doc='Configure logging' />
102 <param name='enable' doc='Enables logging to this vty' />
103 </params>
104 </command>
105 <command id='logging disable'>
106 <params>
107 <param name='logging' doc='Configure logging' />
108 <param name='disable' doc='Disables logging to this vty' />
109 </params>
110 </command>
111 <command id='logging filter all (0|1)'>
112 <params>
113 <param name='logging' doc='Configure logging' />
114 <param name='filter' doc='Filter log messages' />
115 <param name='all' doc='Do you want to log all messages?' />
116 <param name='0' doc='Only print messages matched by other filters' />
117 <param name='1' doc='Bypass filter and print all messages' />
118 </params>
119 </command>
120 <command id='logging color (0|1)'>
121 <params>
122 <param name='logging' doc='Configure logging' />
123 <param name='color' doc='Configure color-printing for log messages' />
124 <param name='0' doc='Don&apos;t use color for printing messages' />
125 <param name='1' doc='Use color for printing messages' />
126 </params>
127 </command>
128 <command id='logging timestamp (0|1)'>
129 <params>
130 <param name='logging' doc='Configure logging' />
131 <param name='timestamp' doc='Configure log message timestamping' />
132 <param name='0' doc='Don&apos;t prefix each log message' />
133 <param name='1' doc='Prefix each log message with current timestamp' />
134 </params>
135 </command>
136 <command id='logging print extended-timestamp (0|1)'>
137 <params>
138 <param name='logging' doc='Configure logging' />
139 <param name='print' doc='Log output settings' />
140 <param name='extended-timestamp' doc='Configure log message timestamping' />
141 <param name='0' doc='Don&apos;t prefix each log message' />
142 <param name='1' doc='Prefix each log message with current timestamp with YYYYMMDDhhmmssnnn' />
143 </params>
144 </command>
145 <command id='logging print category (0|1)'>
146 <params>
147 <param name='logging' doc='Configure logging' />
148 <param name='print' doc='Log output settings' />
149 <param name='category' doc='Configure log message' />
150 <param name='0' doc='Don&apos;t prefix each log message' />
151 <param name='1' doc='Prefix each log message with category/subsystem name' />
152 </params>
153 </command>
154 <command id='logging print category-hex (0|1)'>
155 <params>
156 <param name='logging' doc='Configure logging' />
157 <param name='print' doc='Log output settings' />
158 <param name='category-hex' doc='Configure log message' />
159 <param name='0' doc='Don&apos;t prefix each log message' />
160 <param name='1' doc='Prefix each log message with category/subsystem nr in hex (&apos;&lt;000b&gt;&apos;)' />
161 </params>
162 </command>
163 <command id='logging print level (0|1)'>
164 <params>
165 <param name='logging' doc='Configure logging' />
166 <param name='print' doc='Log output settings' />
167 <param name='level' doc='Configure log message' />
168 <param name='0' doc='Don&apos;t prefix each log message' />
169 <param name='1' doc='Prefix each log message with the log level name' />
170 </params>
171 </command>
Neels Hofmeyrc0a21962018-11-05 03:18:55 +0100[diff] [blame]172 <command id='logging print file (0|1|basename) [last]'>
Neels Hofmeyr2818db82018-03-06 14:59:00 +0100[diff] [blame]173 <params>
174 <param name='logging' doc='Configure logging' />
175 <param name='print' doc='Log output settings' />
176 <param name='file' doc='Configure log message' />
177 <param name='0' doc='Don&apos;t prefix each log message' />
178 <param name='1' doc='Prefix each log message with the source file and line' />
179 <param name='basename' doc='Prefix each log message with the source file&apos;s basename (strip leading paths) and line' />
Neels Hofmeyrc0a21962018-11-05 03:18:55 +0100[diff] [blame]180 <param name='[last]' doc='Log source file info at the end of a log line. If omitted, log source file info just before the log text.' />
Neels Hofmeyr2818db82018-03-06 14:59:00 +0100[diff] [blame]181 </params>
182 </command>
183 <command id='logging set-log-mask MASK'>
184 <params>
185 <param name='logging' doc='Configure logging' />
186 <param name='set-log-mask' doc='Set the logmask of this logging target' />
187 <param name='MASK' doc='List of logging categories to log, e.g. &apos;abc:mno:xyz&apos;. Available log categories depend on the specific application, refer to the &apos;logging level&apos; command. Optionally add individual log levels like &apos;abc,1:mno,3:xyz,5&apos;, where the level numbers are LOGL_DEBUG=1 LOGL_INFO=3 LOGL_NOTICE=5 LOGL_ERROR=7 LOGL_FATAL=8' />
188 </params>
189 </command>
Neels Hofmeyrc0a21962018-11-05 03:18:55 +0100[diff] [blame]190 <command id='logging level (rtp|iuup|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf) (debug|info|notice|error|fatal)'>
Neels Hofmeyr2818db82018-03-06 14:59:00 +0100[diff] [blame]191 <params>
192 <param name='logging' doc='Configure logging' />
193 <param name='level' doc='Set the log level for a specified category' />
Neels Hofmeyr2818db82018-03-06 14:59:00 +0100[diff] [blame]194 <param name='rtp' doc='RTP stream handling' />
Neels Hofmeyrc0a21962018-11-05 03:18:55 +0100[diff] [blame]195 <param name='iuup' doc='IuUP within RTP stream handling' />
Neels Hofmeyr2818db82018-03-06 14:59:00 +0100[diff] [blame]196 <param name='lglobal' doc='Library-internal global log family' />
197 <param name='llapd' doc='LAPD in libosmogsm' />
198 <param name='linp' doc='A-bis Intput Subsystem' />
199 <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' />
200 <param name='lmi' doc='A-bis Input Driver for Signalling' />
201 <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' />
202 <param name='lsms' doc='Layer3 Short Message Service (SMS)' />
203 <param name='lctrl' doc='Control Interface' />
204 <param name='lgtp' doc='GPRS GTP library' />
205 <param name='lstats' doc='Statistics messages and logging' />
206 <param name='lgsup' doc='Generic Subscriber Update Protocol' />
207 <param name='loap' doc='Osmocom Authentication Protocol' />
208 <param name='lss7' doc='libosmo-sigtran Signalling System 7' />
209 <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' />
210 <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' />
211 <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' />
212 <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' />
213 <param name='ljibuf' doc='libosmo-netif Jitter Buffer' />
Neels Hofmeyr2818db82018-03-06 14:59:00 +0100[diff] [blame]214 <param name='debug' doc='Log debug messages and higher levels' />
215 <param name='info' doc='Log informational messages and higher levels' />
216 <param name='notice' doc='Log noticeable messages and higher levels' />
217 <param name='error' doc='Log error messages and higher levels' />
218 <param name='fatal' doc='Log only fatal messages' />
219 </params>
220 </command>
Neels Hofmeyrc0a21962018-11-05 03:18:55 +0100[diff] [blame]221 <command id='logging level set-all (debug|info|notice|error|fatal)'>
222 <params>
223 <param name='logging' doc='Configure logging' />
224 <param name='level' doc='Set the log level for a specified category' />
225 <param name='set-all' doc='Once-off set all categories to the given log level. There is no single command to take back these changes -- each category is set to the given level, period.' />
226 <param name='debug' doc='Log debug messages and higher levels' />
227 <param name='info' doc='Log informational messages and higher levels' />
228 <param name='notice' doc='Log noticeable messages and higher levels' />
229 <param name='error' doc='Log error messages and higher levels' />
230 <param name='fatal' doc='Log only fatal messages' />
231 </params>
232 </command>
233 <command id='logging level force-all (debug|info|notice|error|fatal)'>
234 <params>
235 <param name='logging' doc='Configure logging' />
236 <param name='level' doc='Set the log level for a specified category' />
237 <param name='force-all' doc='Globally force all logging categories to a specific level. This is released by the &apos;no logging level force-all&apos; command. Note: any &apos;logging level &lt;category&gt; &lt;level&gt;&apos; commands will have no visible effect after this, until the forced level is released.' />
238 <param name='debug' doc='Log debug messages and higher levels' />
239 <param name='info' doc='Log informational messages and higher levels' />
240 <param name='notice' doc='Log noticeable messages and higher levels' />
241 <param name='error' doc='Log error messages and higher levels' />
242 <param name='fatal' doc='Log only fatal messages' />
243 </params>
244 </command>
245 <command id='no logging level force-all'>
246 <params>
247 <param name='no' doc='Negate a command or set its defaults' />
248 <param name='logging' doc='Configure logging' />
249 <param name='level' doc='Set the log level for a specified category' />
250 <param name='force-all' doc='Release any globally forced log level set with &apos;logging level force-all &lt;level&gt;&apos;' />
251 </params>
252 </command>
Neels Hofmeyr2818db82018-03-06 14:59:00 +0100[diff] [blame]253 <command id='show logging vty'>
254 <params>
255 <param name='show' doc='Show running system information' />
256 <param name='logging' doc='Show current logging configuration' />
257 <param name='vty' doc='Show current logging configuration for this vty' />
258 </params>
259 </command>
260 <command id='show alarms'>
261 <params>
262 <param name='show' doc='Show running system information' />
263 <param name='alarms' doc='Show current logging configuration' />
264 </params>
265 </command>
266 <command id='show talloc-context (application|all) (full|brief|DEPTH)'>
267 <params>
268 <param name='show' doc='Show running system information' />
269 <param name='talloc-context' doc='Show talloc memory hierarchy' />
270 <param name='application' doc='Application&apos;s context' />
271 <param name='all' doc='All contexts, if NULL-context tracking is enabled' />
272 <param name='full' doc='Display a full talloc memory hierarchy' />
273 <param name='brief' doc='Display a brief talloc memory hierarchy' />
274 <param name='DEPTH' doc='Specify required maximal depth value' />
275 </params>
276 </command>
277 <command id='show talloc-context (application|all) (full|brief|DEPTH) tree ADDRESS'>
278 <params>
279 <param name='show' doc='Show running system information' />
280 <param name='talloc-context' doc='Show talloc memory hierarchy' />
281 <param name='application' doc='Application&apos;s context' />
282 <param name='all' doc='All contexts, if NULL-context tracking is enabled' />
283 <param name='full' doc='Display a full talloc memory hierarchy' />
284 <param name='brief' doc='Display a brief talloc memory hierarchy' />
285 <param name='DEPTH' doc='Specify required maximal depth value' />
286 <param name='tree' doc='Display only a specific memory chunk' />
287 <param name='ADDRESS' doc='Chunk address (e.g. 0xdeadbeef)' />
288 </params>
289 </command>
290 <command id='show talloc-context (application|all) (full|brief|DEPTH) filter REGEXP'>
291 <params>
292 <param name='show' doc='Show running system information' />
293 <param name='talloc-context' doc='Show talloc memory hierarchy' />
294 <param name='application' doc='Application&apos;s context' />
295 <param name='all' doc='All contexts, if NULL-context tracking is enabled' />
296 <param name='full' doc='Display a full talloc memory hierarchy' />
297 <param name='brief' doc='Display a brief talloc memory hierarchy' />
298 <param name='DEPTH' doc='Specify required maximal depth value' />
299 <param name='filter' doc='Filter chunks using regular expression' />
300 <param name='REGEXP' doc='Regular expression' />
301 </params>
302 </command>
303 <command id='show stats'>
304 <params>
305 <param name='show' doc='Show running system information' />
306 <param name='stats' doc='Show statistical values' />
307 </params>
308 </command>
309 <command id='show stats level (global|peer|subscriber)'>
310 <params>
311 <param name='show' doc='Show running system information' />
312 <param name='stats' doc='Show statistical values' />
313 <param name='level' doc='Set the maximum group level' />
314 <param name='global' doc='Show global groups only' />
315 <param name='peer' doc='Show global and network peer related groups' />
316 <param name='subscriber' doc='Show global, peer, and subscriber groups' />
317 </params>
318 </command>
319 <command id='show asciidoc counters'>
320 <params>
321 <param name='show' doc='Show running system information' />
322 <param name='asciidoc' doc='Asciidoc generation' />
323 <param name='counters' doc='Generate table of all registered counters' />
324 </params>
325 </command>
Daniel Willmanne5ed9462018-07-31 18:54:34 +0200[diff] [blame]326 <command id='show rate-counters'>
327 <params>
328 <param name='show' doc='Show running system information' />
329 <param name='rate-counters' doc='Show all rate counters' />
330 </params>
331 </command>
Neels Hofmeyr2818db82018-03-06 14:59:00 +0100[diff] [blame]332 <command id='show mgcp [stats]'>
333 <params>
334 <param name='show' doc='Show running system information' />
335 <param name='mgcp' doc='Display information about the MGCP Media Gateway' />
336 <param name='[stats]' doc='Include Statistics' />
337 </params>
338 </command>
Neels Hofmeyrc0a21962018-11-05 03:18:55 +0100[diff] [blame]339 <command id='show mgcp endpoint NAME'>
340 <params>
341 <param name='show' doc='Show running system information' />
342 <param name='mgcp' doc='Display information about the MGCP Media Gateway' />
343 <param name='endpoint' doc='Display information about an endpoint' />
344 <param name='NAME' doc='The name of the endpoint' />
345 </params>
346 </command>
347 <command id='show mgcp trunk &lt;0-64&gt; endpoint NAME'>
348 <params>
349 <param name='show' doc='Show running system information' />
350 <param name='mgcp' doc='Display information about the MGCP Media Gateway' />
351 <param name='trunk' doc='Display information about a trunk' />
352 <param name='&lt;0-64&gt;' doc='Trunk number' />
353 <param name='endpoint' doc='Display information about an endpoint' />
354 <param name='NAME' doc='The name of the endpoint' />
355 </params>
356 </command>
Neels Hofmeyr2818db82018-03-06 14:59:00 +0100[diff] [blame]357 </node>
358 <node id='enable'>
359 <name>enable</name>
360 <command id='disable'>
361 <params>
362 <param name='disable' doc='Turn off privileged mode command' />
363 </params>
364 </command>
365 <command id='configure terminal'>
366 <params>
367 <param name='configure' doc='Configuration from vty interface' />
368 <param name='terminal' doc='Configuration terminal' />
369 </params>
370 </command>
371 <command id='copy running-config startup-config'>
372 <params>
373 <param name='copy' doc='Copy configuration' />
374 <param name='running-config' doc='Copy running config to... ' />
375 <param name='startup-config' doc='Copy running config to startup config (same as write file)' />
376 </params>
377 </command>
378 <command id='show startup-config'>
379 <params>
380 <param name='show' doc='Show running system information' />
381 <param name='startup-config' doc='Contentes of startup configuration' />
382 </params>
383 </command>
384 <command id='show version'>
385 <params>
386 <param name='show' doc='Show running system information' />
387 <param name='version' doc='Displays program version' />
388 </params>
389 </command>
390 <command id='show online-help'>
391 <params>
392 <param name='show' doc='Show running system information' />
393 <param name='online-help' doc='Online help' />
394 </params>
395 </command>
396 <command id='terminal length &lt;0-512&gt;'>
397 <params>
398 <param name='terminal' doc='Set terminal line parameters' />
399 <param name='length' doc='Set number of lines on a screen' />
400 <param name='&lt;0-512&gt;' doc='Number of lines on screen (0 for no pausing)' />
401 </params>
402 </command>
403 <command id='terminal no length'>
404 <params>
405 <param name='terminal' doc='Set terminal line parameters' />
406 <param name='no' doc='Negate a command or set its defaults' />
407 <param name='length' doc='Set number of lines on a screen' />
408 </params>
409 </command>
Neels Hofmeyr2818db82018-03-06 14:59:00 +0100[diff] [blame]410 <command id='who'>
411 <params>
412 <param name='who' doc='Display who is on vty' />
413 </params>
414 </command>
415 <command id='show history'>
416 <params>
417 <param name='show' doc='Show running system information' />
418 <param name='history' doc='Display the session command history' />
419 </params>
420 </command>
421 <command id='terminal monitor'>
422 <params>
423 <param name='terminal' doc='Set terminal line parameters' />
424 <param name='monitor' doc='Copy debug output to the current terminal line' />
425 </params>
426 </command>
427 <command id='terminal no monitor'>
428 <params>
429 <param name='terminal' doc='Set terminal line parameters' />
430 <param name='no' doc='Negate a command or set its defaults' />
431 <param name='monitor' doc='Copy debug output to the current terminal line' />
432 </params>
433 </command>
434 <command id='logging enable'>
435 <params>
436 <param name='logging' doc='Configure logging' />
437 <param name='enable' doc='Enables logging to this vty' />
438 </params>
439 </command>
440 <command id='logging disable'>
441 <params>
442 <param name='logging' doc='Configure logging' />
443 <param name='disable' doc='Disables logging to this vty' />
444 </params>
445 </command>
446 <command id='logging filter all (0|1)'>
447 <params>
448 <param name='logging' doc='Configure logging' />
449 <param name='filter' doc='Filter log messages' />
450 <param name='all' doc='Do you want to log all messages?' />
451 <param name='0' doc='Only print messages matched by other filters' />
452 <param name='1' doc='Bypass filter and print all messages' />
453 </params>
454 </command>
455 <command id='logging color (0|1)'>
456 <params>
457 <param name='logging' doc='Configure logging' />
458 <param name='color' doc='Configure color-printing for log messages' />
459 <param name='0' doc='Don&apos;t use color for printing messages' />
460 <param name='1' doc='Use color for printing messages' />
461 </params>
462 </command>
463 <command id='logging timestamp (0|1)'>
464 <params>
465 <param name='logging' doc='Configure logging' />
466 <param name='timestamp' doc='Configure log message timestamping' />
467 <param name='0' doc='Don&apos;t prefix each log message' />
468 <param name='1' doc='Prefix each log message with current timestamp' />
469 </params>
470 </command>
471 <command id='logging print extended-timestamp (0|1)'>
472 <params>
473 <param name='logging' doc='Configure logging' />
474 <param name='print' doc='Log output settings' />
475 <param name='extended-timestamp' doc='Configure log message timestamping' />
476 <param name='0' doc='Don&apos;t prefix each log message' />
477 <param name='1' doc='Prefix each log message with current timestamp with YYYYMMDDhhmmssnnn' />
478 </params>
479 </command>
480 <command id='logging print category (0|1)'>
481 <params>
482 <param name='logging' doc='Configure logging' />
483 <param name='print' doc='Log output settings' />
484 <param name='category' doc='Configure log message' />
485 <param name='0' doc='Don&apos;t prefix each log message' />
486 <param name='1' doc='Prefix each log message with category/subsystem name' />
487 </params>
488 </command>
489 <command id='logging print category-hex (0|1)'>
490 <params>
491 <param name='logging' doc='Configure logging' />
492 <param name='print' doc='Log output settings' />
493 <param name='category-hex' doc='Configure log message' />
494 <param name='0' doc='Don&apos;t prefix each log message' />
495 <param name='1' doc='Prefix each log message with category/subsystem nr in hex (&apos;&lt;000b&gt;&apos;)' />
496 </params>
497 </command>
498 <command id='logging print level (0|1)'>
499 <params>
500 <param name='logging' doc='Configure logging' />
501 <param name='print' doc='Log output settings' />
502 <param name='level' doc='Configure log message' />
503 <param name='0' doc='Don&apos;t prefix each log message' />
504 <param name='1' doc='Prefix each log message with the log level name' />
505 </params>
506 </command>
Neels Hofmeyrc0a21962018-11-05 03:18:55 +0100[diff] [blame]507 <command id='logging print file (0|1|basename) [last]'>
Neels Hofmeyr2818db82018-03-06 14:59:00 +0100[diff] [blame]508 <params>
509 <param name='logging' doc='Configure logging' />
510 <param name='print' doc='Log output settings' />
511 <param name='file' doc='Configure log message' />
512 <param name='0' doc='Don&apos;t prefix each log message' />
513 <param name='1' doc='Prefix each log message with the source file and line' />
514 <param name='basename' doc='Prefix each log message with the source file&apos;s basename (strip leading paths) and line' />
Neels Hofmeyrc0a21962018-11-05 03:18:55 +0100[diff] [blame]515 <param name='[last]' doc='Log source file info at the end of a log line. If omitted, log source file info just before the log text.' />
Neels Hofmeyr2818db82018-03-06 14:59:00 +0100[diff] [blame]516 </params>
517 </command>
518 <command id='logging set-log-mask MASK'>
519 <params>
520 <param name='logging' doc='Configure logging' />
521 <param name='set-log-mask' doc='Set the logmask of this logging target' />
522 <param name='MASK' doc='List of logging categories to log, e.g. &apos;abc:mno:xyz&apos;. Available log categories depend on the specific application, refer to the &apos;logging level&apos; command. Optionally add individual log levels like &apos;abc,1:mno,3:xyz,5&apos;, where the level numbers are LOGL_DEBUG=1 LOGL_INFO=3 LOGL_NOTICE=5 LOGL_ERROR=7 LOGL_FATAL=8' />
523 </params>
524 </command>
Neels Hofmeyrc0a21962018-11-05 03:18:55 +0100[diff] [blame]525 <command id='logging level (rtp|iuup|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf) (debug|info|notice|error|fatal)'>
Neels Hofmeyr2818db82018-03-06 14:59:00 +0100[diff] [blame]526 <params>
527 <param name='logging' doc='Configure logging' />
528 <param name='level' doc='Set the log level for a specified category' />
Neels Hofmeyr2818db82018-03-06 14:59:00 +0100[diff] [blame]529 <param name='rtp' doc='RTP stream handling' />
Neels Hofmeyrc0a21962018-11-05 03:18:55 +0100[diff] [blame]530 <param name='iuup' doc='IuUP within RTP stream handling' />
Neels Hofmeyr2818db82018-03-06 14:59:00 +0100[diff] [blame]531 <param name='lglobal' doc='Library-internal global log family' />
532 <param name='llapd' doc='LAPD in libosmogsm' />
533 <param name='linp' doc='A-bis Intput Subsystem' />
534 <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' />
535 <param name='lmi' doc='A-bis Input Driver for Signalling' />
536 <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' />
537 <param name='lsms' doc='Layer3 Short Message Service (SMS)' />
538 <param name='lctrl' doc='Control Interface' />
539 <param name='lgtp' doc='GPRS GTP library' />
540 <param name='lstats' doc='Statistics messages and logging' />
541 <param name='lgsup' doc='Generic Subscriber Update Protocol' />
542 <param name='loap' doc='Osmocom Authentication Protocol' />
543 <param name='lss7' doc='libosmo-sigtran Signalling System 7' />
544 <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' />
545 <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' />
546 <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' />
547 <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' />
548 <param name='ljibuf' doc='libosmo-netif Jitter Buffer' />
Neels Hofmeyr2818db82018-03-06 14:59:00 +0100[diff] [blame]549 <param name='debug' doc='Log debug messages and higher levels' />
550 <param name='info' doc='Log informational messages and higher levels' />
551 <param name='notice' doc='Log noticeable messages and higher levels' />
552 <param name='error' doc='Log error messages and higher levels' />
553 <param name='fatal' doc='Log only fatal messages' />
554 </params>
555 </command>
Neels Hofmeyrc0a21962018-11-05 03:18:55 +0100[diff] [blame]556 <command id='logging level set-all (debug|info|notice|error|fatal)'>
557 <params>
558 <param name='logging' doc='Configure logging' />
559 <param name='level' doc='Set the log level for a specified category' />
560 <param name='set-all' doc='Once-off set all categories to the given log level. There is no single command to take back these changes -- each category is set to the given level, period.' />
561 <param name='debug' doc='Log debug messages and higher levels' />
562 <param name='info' doc='Log informational messages and higher levels' />
563 <param name='notice' doc='Log noticeable messages and higher levels' />
564 <param name='error' doc='Log error messages and higher levels' />
565 <param name='fatal' doc='Log only fatal messages' />
566 </params>
567 </command>
568 <command id='logging level force-all (debug|info|notice|error|fatal)'>
569 <params>
570 <param name='logging' doc='Configure logging' />
571 <param name='level' doc='Set the log level for a specified category' />
572 <param name='force-all' doc='Globally force all logging categories to a specific level. This is released by the &apos;no logging level force-all&apos; command. Note: any &apos;logging level &lt;category&gt; &lt;level&gt;&apos; commands will have no visible effect after this, until the forced level is released.' />
573 <param name='debug' doc='Log debug messages and higher levels' />
574 <param name='info' doc='Log informational messages and higher levels' />
575 <param name='notice' doc='Log noticeable messages and higher levels' />
576 <param name='error' doc='Log error messages and higher levels' />
577 <param name='fatal' doc='Log only fatal messages' />
578 </params>
579 </command>
580 <command id='no logging level force-all'>
581 <params>
582 <param name='no' doc='Negate a command or set its defaults' />
583 <param name='logging' doc='Configure logging' />
584 <param name='level' doc='Set the log level for a specified category' />
585 <param name='force-all' doc='Release any globally forced log level set with &apos;logging level force-all &lt;level&gt;&apos;' />
586 </params>
587 </command>
Neels Hofmeyr2818db82018-03-06 14:59:00 +0100[diff] [blame]588 <command id='show logging vty'>
589 <params>
590 <param name='show' doc='Show running system information' />
591 <param name='logging' doc='Show current logging configuration' />
592 <param name='vty' doc='Show current logging configuration for this vty' />
593 </params>
594 </command>
595 <command id='show alarms'>
596 <params>
597 <param name='show' doc='Show running system information' />
598 <param name='alarms' doc='Show current logging configuration' />
599 </params>
600 </command>
601 <command id='show talloc-context (application|all) (full|brief|DEPTH)'>
602 <params>
603 <param name='show' doc='Show running system information' />
604 <param name='talloc-context' doc='Show talloc memory hierarchy' />
605 <param name='application' doc='Application&apos;s context' />
606 <param name='all' doc='All contexts, if NULL-context tracking is enabled' />
607 <param name='full' doc='Display a full talloc memory hierarchy' />
608 <param name='brief' doc='Display a brief talloc memory hierarchy' />
609 <param name='DEPTH' doc='Specify required maximal depth value' />
610 </params>
611 </command>
612 <command id='show talloc-context (application|all) (full|brief|DEPTH) tree ADDRESS'>
613 <params>
614 <param name='show' doc='Show running system information' />
615 <param name='talloc-context' doc='Show talloc memory hierarchy' />
616 <param name='application' doc='Application&apos;s context' />
617 <param name='all' doc='All contexts, if NULL-context tracking is enabled' />
618 <param name='full' doc='Display a full talloc memory hierarchy' />
619 <param name='brief' doc='Display a brief talloc memory hierarchy' />
620 <param name='DEPTH' doc='Specify required maximal depth value' />
621 <param name='tree' doc='Display only a specific memory chunk' />
622 <param name='ADDRESS' doc='Chunk address (e.g. 0xdeadbeef)' />
623 </params>
624 </command>
625 <command id='show talloc-context (application|all) (full|brief|DEPTH) filter REGEXP'>
626 <params>
627 <param name='show' doc='Show running system information' />
628 <param name='talloc-context' doc='Show talloc memory hierarchy' />
629 <param name='application' doc='Application&apos;s context' />
630 <param name='all' doc='All contexts, if NULL-context tracking is enabled' />
631 <param name='full' doc='Display a full talloc memory hierarchy' />
632 <param name='brief' doc='Display a brief talloc memory hierarchy' />
633 <param name='DEPTH' doc='Specify required maximal depth value' />
634 <param name='filter' doc='Filter chunks using regular expression' />
635 <param name='REGEXP' doc='Regular expression' />
636 </params>
637 </command>
638 <command id='show stats'>
639 <params>
640 <param name='show' doc='Show running system information' />
641 <param name='stats' doc='Show statistical values' />
642 </params>
643 </command>
644 <command id='show stats level (global|peer|subscriber)'>
645 <params>
646 <param name='show' doc='Show running system information' />
647 <param name='stats' doc='Show statistical values' />
648 <param name='level' doc='Set the maximum group level' />
649 <param name='global' doc='Show global groups only' />
650 <param name='peer' doc='Show global and network peer related groups' />
651 <param name='subscriber' doc='Show global, peer, and subscriber groups' />
652 </params>
653 </command>
654 <command id='show asciidoc counters'>
655 <params>
656 <param name='show' doc='Show running system information' />
657 <param name='asciidoc' doc='Asciidoc generation' />
658 <param name='counters' doc='Generate table of all registered counters' />
659 </params>
660 </command>
Daniel Willmanne5ed9462018-07-31 18:54:34 +0200[diff] [blame]661 <command id='show rate-counters'>
662 <params>
663 <param name='show' doc='Show running system information' />
664 <param name='rate-counters' doc='Show all rate counters' />
665 </params>
666 </command>
Neels Hofmeyr2818db82018-03-06 14:59:00 +0100[diff] [blame]667 <command id='show mgcp [stats]'>
668 <params>
669 <param name='show' doc='Show running system information' />
670 <param name='mgcp' doc='Display information about the MGCP Media Gateway' />
671 <param name='[stats]' doc='Include Statistics' />
672 </params>
673 </command>
Neels Hofmeyrc0a21962018-11-05 03:18:55 +0100[diff] [blame]674 <command id='show mgcp endpoint NAME'>
675 <params>
676 <param name='show' doc='Show running system information' />
677 <param name='mgcp' doc='Display information about the MGCP Media Gateway' />
678 <param name='endpoint' doc='Display information about an endpoint' />
679 <param name='NAME' doc='The name of the endpoint' />
680 </params>
681 </command>
682 <command id='show mgcp trunk &lt;0-64&gt; endpoint NAME'>
683 <params>
684 <param name='show' doc='Show running system information' />
685 <param name='mgcp' doc='Display information about the MGCP Media Gateway' />
686 <param name='trunk' doc='Display information about a trunk' />
687 <param name='&lt;0-64&gt;' doc='Trunk number' />
688 <param name='endpoint' doc='Display information about an endpoint' />
689 <param name='NAME' doc='The name of the endpoint' />
690 </params>
691 </command>
Neels Hofmeyr2818db82018-03-06 14:59:00 +0100[diff] [blame]692 <command id='loop-endpoint &lt;0-64&gt; NAME (0|1)'>
693 <params>
694 <param name='loop-endpoint' doc='Loop a given endpoint' />
695 <param name='&lt;0-64&gt;' doc='Trunk number' />
696 <param name='NAME' doc='The name in hex of the endpoint' />
697 <param name='0' doc='Disable the loop' />
698 <param name='1' doc='Enable the loop' />
699 </params>
700 </command>
701 <command id='tap-rtp &lt;0-64&gt; ENDPOINT CONN (in|out) A.B.C.D &lt;0-65534&gt;'>
702 <params>
703 <param name='tap-rtp' doc='Forward data on endpoint to a different system' />
704 <param name='&lt;0-64&gt;' doc='Trunk number' />
705 <param name='ENDPOINT' doc='The endpoint in hex' />
706 <param name='CONN' doc='The connection id in hex' />
707 <param name='in' doc='Forward incoming data' />
708 <param name='out' doc='Forward leaving data' />
709 <param name='A.B.C.D' doc='destination IP of the data' />
710 <param name='&lt;0-65534&gt;' doc='destination port' />
711 </params>
712 </command>
713 <command id='free-endpoint &lt;0-64&gt; NUMBER'>
714 <params>
715 <param name='free-endpoint' doc='Free the given endpoint' />
716 <param name='&lt;0-64&gt;' doc='Trunk number' />
717 <param name='NUMBER' doc='Endpoint number in hex.' />
718 </params>
719 </command>
720 <command id='reset-endpoint &lt;0-64&gt; NUMBER'>
721 <params>
722 <param name='reset-endpoint' doc='Reset the given endpoint' />
723 <param name='&lt;0-64&gt;' doc='Trunk number' />
724 <param name='NUMBER' doc='Endpoint number in hex.' />
725 </params>
726 </command>
727 <command id='reset-all-endpoints'>
728 <params>
729 <param name='reset-all-endpoints' doc='Reset all endpoints' />
730 </params>
731 </command>
732 </node>
733 <node id='config'>
734 <name>config</name>
735 <command id='hostname WORD'>
736 <params>
737 <param name='hostname' doc='Set system&apos;s network name' />
738 <param name='WORD' doc='This system&apos;s network name' />
739 </params>
740 </command>
741 <command id='no hostname [HOSTNAME]'>
742 <params>
743 <param name='no' doc='Negate a command or set its defaults' />
744 <param name='hostname' doc='Reset system&apos;s network name' />
745 <param name='[HOSTNAME]' doc='Host name of this router' />
746 </params>
747 </command>
748 <command id='password (8|) WORD'>
749 <params>
750 <param name='password' doc='Assign the terminal connection password' />
751 <param name='8' doc='Specifies a HIDDEN password will follow' />
752 <param name='' doc='dummy string ' />
753 <param name='WORD' doc='The HIDDEN line password string' />
754 </params>
755 </command>
756 <command id='password LINE'>
757 <params>
758 <param name='password' doc='Assign the terminal connection password' />
759 <param name='LINE' doc='The UNENCRYPTED (cleartext) line password' />
760 </params>
761 </command>
762 <command id='enable password (8|) WORD'>
763 <params>
764 <param name='enable' doc='Modify enable password parameters' />
765 <param name='password' doc='Assign the privileged level password' />
766 <param name='8' doc='Specifies a HIDDEN password will follow' />
767 <param name='' doc='dummy string ' />
768 <param name='WORD' doc='The HIDDEN &apos;enable&apos; password string' />
769 </params>
770 </command>
771 <command id='enable password LINE'>
772 <params>
773 <param name='enable' doc='Modify enable password parameters' />
774 <param name='password' doc='Assign the privileged level password' />
775 <param name='LINE' doc='The UNENCRYPTED (cleartext) &apos;enable&apos; password' />
776 </params>
777 </command>
778 <command id='no enable password'>
779 <params>
780 <param name='no' doc='Negate a command or set its defaults' />
781 <param name='enable' doc='Modify enable password parameters' />
782 <param name='password' doc='Assign the privileged level password' />
783 </params>
784 </command>
785 <command id='banner motd default'>
786 <params>
787 <param name='banner' doc='Set banner string' />
788 <param name='motd' doc='Strings for motd' />
789 <param name='default' doc='Default string' />
790 </params>
791 </command>
792 <command id='banner motd file [FILE]'>
793 <params>
794 <param name='banner' doc='Set banner' />
795 <param name='motd' doc='Banner for motd' />
796 <param name='file' doc='Banner from a file' />
797 <param name='[FILE]' doc='Filename' />
798 </params>
799 </command>
800 <command id='no banner motd'>
801 <params>
802 <param name='no' doc='Negate a command or set its defaults' />
803 <param name='banner' doc='Set banner string' />
804 <param name='motd' doc='Strings for motd' />
805 </params>
806 </command>
807 <command id='service terminal-length &lt;0-512&gt;'>
808 <params>
809 <param name='service' doc='Set up miscellaneous service' />
810 <param name='terminal-length' doc='System wide terminal length configuration' />
811 <param name='&lt;0-512&gt;' doc='Number of lines of VTY (0 means no line control)' />
812 </params>
813 </command>
814 <command id='no service terminal-length [&lt;0-512&gt;]'>
815 <params>
816 <param name='no' doc='Negate a command or set its defaults' />
817 <param name='service' doc='Set up miscellaneous service' />
818 <param name='terminal-length' doc='System wide terminal length configuration' />
819 <param name='[&lt;0-512&gt;]' doc='Number of lines of VTY (0 means no line control)' />
820 </params>
821 </command>
822 <command id='line vty'>
823 <params>
824 <param name='line' doc='Configure a terminal line' />
825 <param name='vty' doc='Virtual terminal' />
826 </params>
827 </command>
828 <command id='service advanced-vty'>
829 <params>
830 <param name='service' doc='Set up miscellaneous service' />
831 <param name='advanced-vty' doc='Enable advanced mode vty interface' />
832 </params>
833 </command>
834 <command id='no service advanced-vty'>
835 <params>
836 <param name='no' doc='Negate a command or set its defaults' />
837 <param name='service' doc='Set up miscellaneous service' />
838 <param name='advanced-vty' doc='Enable advanced mode vty interface' />
839 </params>
840 </command>
841 <command id='show history'>
842 <params>
843 <param name='show' doc='Show running system information' />
844 <param name='history' doc='Display the session command history' />
845 </params>
846 </command>
847 <command id='log stderr'>
848 <params>
849 <param name='log' doc='Configure logging sub-system' />
850 <param name='stderr' doc='Logging via STDERR of the process' />
851 </params>
852 </command>
853 <command id='no log stderr'>
854 <params>
855 <param name='no' doc='Negate a command or set its defaults' />
856 <param name='log' doc='Configure logging sub-system' />
857 <param name='stderr' doc='Logging via STDERR of the process' />
858 </params>
859 </command>
860 <command id='log file .FILENAME'>
861 <params>
862 <param name='log' doc='Configure logging sub-system' />
863 <param name='file' doc='Logging to text file' />
864 <param name='.FILENAME' doc='Filename' />
865 </params>
866 </command>
867 <command id='no log file .FILENAME'>
868 <params>
869 <param name='no' doc='Negate a command or set its defaults' />
870 <param name='log' doc='Configure logging sub-system' />
871 <param name='file' doc='Logging to text file' />
872 <param name='.FILENAME' doc='Filename' />
873 </params>
874 </command>
875 <command id='log alarms &lt;2-32700&gt;'>
876 <params>
877 <param name='log' doc='Configure logging sub-system' />
878 <param name='alarms' doc='Logging alarms to osmo_strrb' />
879 <param name='&lt;2-32700&gt;' doc='Maximum number of messages to log' />
880 </params>
881 </command>
882 <command id='no log alarms'>
883 <params>
884 <param name='no' doc='Negate a command or set its defaults' />
885 <param name='log' doc='Configure logging sub-system' />
886 <param name='alarms' doc='Logging alarms to osmo_strrb' />
887 </params>
888 </command>
889 <command id='log syslog (authpriv|cron|daemon|ftp|lpr|mail|news|user|uucp)'>
890 <params>
891 <param name='log' doc='Configure logging sub-system' />
892 <param name='syslog' doc='Logging via syslog' />
893 <param name='authpriv' doc='Security/authorization messages facility' />
894 <param name='cron' doc='Clock daemon (cron/at) facility' />
895 <param name='daemon' doc='General system daemon facility' />
896 <param name='ftp' doc='Ftp daemon facility' />
897 <param name='lpr' doc='Line printer facility' />
898 <param name='mail' doc='Mail facility' />
899 <param name='news' doc='News facility' />
900 <param name='user' doc='Generic facility' />
901 <param name='uucp' doc='UUCP facility' />
902 </params>
903 </command>
904 <command id='log syslog local &lt;0-7&gt;'>
905 <params>
906 <param name='log' doc='Configure logging sub-system' />
907 <param name='syslog' doc='Logging via syslog' />
908 <param name='local' doc='Syslog LOCAL facility' />
909 <param name='&lt;0-7&gt;' doc='Local facility number' />
910 </params>
911 </command>
912 <command id='no log syslog'>
913 <params>
914 <param name='no' doc='Negate a command or set its defaults' />
915 <param name='log' doc='Configure logging sub-system' />
916 <param name='syslog' doc='Logging via syslog' />
917 </params>
918 </command>
919 <command id='log gsmtap [HOSTNAME]'>
920 <params>
921 <param name='log' doc='Configure logging sub-system' />
922 <param name='gsmtap' doc='Logging via GSMTAP' />
923 <param name='[HOSTNAME]' doc='Host name to send the GSMTAP logging to (UDP port 4729)' />
924 </params>
925 </command>
926 <command id='stats reporter statsd'>
927 <params>
928 <param name='stats' doc='Configure stats sub-system' />
929 <param name='reporter' doc='Configure a stats reporter' />
930 <param name='statsd' doc='Report to a STATSD server' />
931 </params>
932 </command>
933 <command id='no stats reporter statsd'>
934 <params>
935 <param name='no' doc='Negate a command or set its defaults' />
936 <param name='stats' doc='Configure stats sub-system' />
937 <param name='reporter' doc='Configure a stats reporter' />
938 <param name='statsd' doc='Report to a STATSD server' />
939 </params>
940 </command>
941 <command id='stats reporter log'>
942 <params>
943 <param name='stats' doc='Configure stats sub-system' />
944 <param name='reporter' doc='Configure a stats reporter' />
945 <param name='log' doc='Report to the logger' />
946 </params>
947 </command>
948 <command id='no stats reporter log'>
949 <params>
950 <param name='no' doc='Negate a command or set its defaults' />
951 <param name='stats' doc='Configure stats sub-system' />
952 <param name='reporter' doc='Configure a stats reporter' />
953 <param name='log' doc='Report to the logger' />
954 </params>
955 </command>
956 <command id='stats interval &lt;1-65535&gt;'>
957 <params>
958 <param name='stats' doc='Configure stats sub-system' />
959 <param name='interval' doc='Set the reporting interval' />
960 <param name='&lt;1-65535&gt;' doc='Interval in seconds' />
961 </params>
962 </command>
963 <command id='mgcp'>
964 <params>
965 <param name='mgcp' doc='Configure the MGCP' />
966 </params>
967 </command>
968 </node>
969 <node id='config-log'>
970 <name>config-log</name>
971 <command id='logging filter all (0|1)'>
972 <params>
973 <param name='logging' doc='Configure logging' />
974 <param name='filter' doc='Filter log messages' />
975 <param name='all' doc='Do you want to log all messages?' />
976 <param name='0' doc='Only print messages matched by other filters' />
977 <param name='1' doc='Bypass filter and print all messages' />
978 </params>
979 </command>
980 <command id='logging color (0|1)'>
981 <params>
982 <param name='logging' doc='Configure logging' />
983 <param name='color' doc='Configure color-printing for log messages' />
984 <param name='0' doc='Don&apos;t use color for printing messages' />
985 <param name='1' doc='Use color for printing messages' />
986 </params>
987 </command>
988 <command id='logging timestamp (0|1)'>
989 <params>
990 <param name='logging' doc='Configure logging' />
991 <param name='timestamp' doc='Configure log message timestamping' />
992 <param name='0' doc='Don&apos;t prefix each log message' />
993 <param name='1' doc='Prefix each log message with current timestamp' />
994 </params>
995 </command>
996 <command id='logging print extended-timestamp (0|1)'>
997 <params>
998 <param name='logging' doc='Configure logging' />
999 <param name='print' doc='Log output settings' />
1000 <param name='extended-timestamp' doc='Configure log message timestamping' />
1001 <param name='0' doc='Don&apos;t prefix each log message' />
1002 <param name='1' doc='Prefix each log message with current timestamp with YYYYMMDDhhmmssnnn' />
1003 </params>
1004 </command>
1005 <command id='logging print category (0|1)'>
1006 <params>
1007 <param name='logging' doc='Configure logging' />
1008 <param name='print' doc='Log output settings' />
1009 <param name='category' doc='Configure log message' />
1010 <param name='0' doc='Don&apos;t prefix each log message' />
1011 <param name='1' doc='Prefix each log message with category/subsystem name' />
1012 </params>
1013 </command>
1014 <command id='logging print category-hex (0|1)'>
1015 <params>
1016 <param name='logging' doc='Configure logging' />
1017 <param name='print' doc='Log output settings' />
1018 <param name='category-hex' doc='Configure log message' />
1019 <param name='0' doc='Don&apos;t prefix each log message' />
1020 <param name='1' doc='Prefix each log message with category/subsystem nr in hex (&apos;&lt;000b&gt;&apos;)' />
1021 </params>
1022 </command>
1023 <command id='logging print level (0|1)'>
1024 <params>
1025 <param name='logging' doc='Configure logging' />
1026 <param name='print' doc='Log output settings' />
1027 <param name='level' doc='Configure log message' />
1028 <param name='0' doc='Don&apos;t prefix each log message' />
1029 <param name='1' doc='Prefix each log message with the log level name' />
1030 </params>
1031 </command>
Neels Hofmeyrc0a21962018-11-05 03:18:55 +0100[diff] [blame]1032 <command id='logging print file (0|1|basename) [last]'>
Neels Hofmeyr2818db82018-03-06 14:59:00 +0100[diff] [blame]1033 <params>
1034 <param name='logging' doc='Configure logging' />
1035 <param name='print' doc='Log output settings' />
1036 <param name='file' doc='Configure log message' />
1037 <param name='0' doc='Don&apos;t prefix each log message' />
1038 <param name='1' doc='Prefix each log message with the source file and line' />
1039 <param name='basename' doc='Prefix each log message with the source file&apos;s basename (strip leading paths) and line' />
Neels Hofmeyrc0a21962018-11-05 03:18:55 +0100[diff] [blame]1040 <param name='[last]' doc='Log source file info at the end of a log line. If omitted, log source file info just before the log text.' />
Neels Hofmeyr2818db82018-03-06 14:59:00 +0100[diff] [blame]1041 </params>
1042 </command>
Neels Hofmeyrc0a21962018-11-05 03:18:55 +0100[diff] [blame]1043 <command id='logging level (rtp|iuup|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf) (debug|info|notice|error|fatal)'>
Neels Hofmeyr2818db82018-03-06 14:59:00 +0100[diff] [blame]1044 <params>
1045 <param name='logging' doc='Configure logging' />
1046 <param name='level' doc='Set the log level for a specified category' />
Neels Hofmeyr2818db82018-03-06 14:59:00 +0100[diff] [blame]1047 <param name='rtp' doc='RTP stream handling' />
Neels Hofmeyrc0a21962018-11-05 03:18:55 +0100[diff] [blame]1048 <param name='iuup' doc='IuUP within RTP stream handling' />
Neels Hofmeyr2818db82018-03-06 14:59:00 +0100[diff] [blame]1049 <param name='lglobal' doc='Library-internal global log family' />
1050 <param name='llapd' doc='LAPD in libosmogsm' />
1051 <param name='linp' doc='A-bis Intput Subsystem' />
1052 <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' />
1053 <param name='lmi' doc='A-bis Input Driver for Signalling' />
1054 <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' />
1055 <param name='lsms' doc='Layer3 Short Message Service (SMS)' />
1056 <param name='lctrl' doc='Control Interface' />
1057 <param name='lgtp' doc='GPRS GTP library' />
1058 <param name='lstats' doc='Statistics messages and logging' />
1059 <param name='lgsup' doc='Generic Subscriber Update Protocol' />
1060 <param name='loap' doc='Osmocom Authentication Protocol' />
1061 <param name='lss7' doc='libosmo-sigtran Signalling System 7' />
1062 <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' />
1063 <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' />
1064 <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' />
1065 <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' />
1066 <param name='ljibuf' doc='libosmo-netif Jitter Buffer' />
Neels Hofmeyr2818db82018-03-06 14:59:00 +0100[diff] [blame]1067 <param name='debug' doc='Log debug messages and higher levels' />
1068 <param name='info' doc='Log informational messages and higher levels' />
1069 <param name='notice' doc='Log noticeable messages and higher levels' />
1070 <param name='error' doc='Log error messages and higher levels' />
1071 <param name='fatal' doc='Log only fatal messages' />
1072 </params>
1073 </command>
Neels Hofmeyrc0a21962018-11-05 03:18:55 +0100[diff] [blame]1074 <command id='logging level set-all (debug|info|notice|error|fatal)'>
1075 <params>
1076 <param name='logging' doc='Configure logging' />
1077 <param name='level' doc='Set the log level for a specified category' />
1078 <param name='set-all' doc='Once-off set all categories to the given log level. There is no single command to take back these changes -- each category is set to the given level, period.' />
1079 <param name='debug' doc='Log debug messages and higher levels' />
1080 <param name='info' doc='Log informational messages and higher levels' />
1081 <param name='notice' doc='Log noticeable messages and higher levels' />
1082 <param name='error' doc='Log error messages and higher levels' />
1083 <param name='fatal' doc='Log only fatal messages' />
1084 </params>
1085 </command>
1086 <command id='logging level force-all (debug|info|notice|error|fatal)'>
1087 <params>
1088 <param name='logging' doc='Configure logging' />
1089 <param name='level' doc='Set the log level for a specified category' />
1090 <param name='force-all' doc='Globally force all logging categories to a specific level. This is released by the &apos;no logging level force-all&apos; command. Note: any &apos;logging level &lt;category&gt; &lt;level&gt;&apos; commands will have no visible effect after this, until the forced level is released.' />
1091 <param name='debug' doc='Log debug messages and higher levels' />
1092 <param name='info' doc='Log informational messages and higher levels' />
1093 <param name='notice' doc='Log noticeable messages and higher levels' />
1094 <param name='error' doc='Log error messages and higher levels' />
1095 <param name='fatal' doc='Log only fatal messages' />
1096 </params>
1097 </command>
1098 <command id='no logging level force-all'>
1099 <params>
1100 <param name='no' doc='Negate a command or set its defaults' />
1101 <param name='logging' doc='Configure logging' />
1102 <param name='level' doc='Set the log level for a specified category' />
1103 <param name='force-all' doc='Release any globally forced log level set with &apos;logging level force-all &lt;level&gt;&apos;' />
1104 </params>
1105 </command>
Neels Hofmeyr2818db82018-03-06 14:59:00 +0100[diff] [blame]1106 </node>
1107 <node id='config-stats'>
1108 <name>config-stats</name>
1109 <command id='local-ip ADDR'>
1110 <params>
1111 <param name='local-ip' doc='Set the IP address to which we bind locally' />
1112 <param name='ADDR' doc='IP Address' />
1113 </params>
1114 </command>
1115 <command id='no local-ip'>
1116 <params>
1117 <param name='no' doc='Negate a command or set its defaults' />
1118 <param name='local-ip' doc='Set the IP address to which we bind locally' />
1119 </params>
1120 </command>
1121 <command id='remote-ip ADDR'>
1122 <params>
1123 <param name='remote-ip' doc='Set the remote IP address to which we connect' />
1124 <param name='ADDR' doc='IP Address' />
1125 </params>
1126 </command>
1127 <command id='remote-port &lt;1-65535&gt;'>
1128 <params>
1129 <param name='remote-port' doc='Set the remote port to which we connect' />
1130 <param name='&lt;1-65535&gt;' doc='Remote port number' />
1131 </params>
1132 </command>
1133 <command id='mtu &lt;100-65535&gt;'>
1134 <params>
1135 <param name='mtu' doc='Set the maximum packet size' />
1136 <param name='&lt;100-65535&gt;' doc='Size in byte' />
1137 </params>
1138 </command>
1139 <command id='no mtu'>
1140 <params>
1141 <param name='no' doc='Negate a command or set its defaults' />
1142 <param name='mtu' doc='Set the maximum packet size' />
1143 </params>
1144 </command>
1145 <command id='prefix PREFIX'>
1146 <params>
1147 <param name='prefix' doc='Set the item name prefix' />
1148 <param name='PREFIX' doc='The prefix string' />
1149 </params>
1150 </command>
1151 <command id='no prefix'>
1152 <params>
1153 <param name='no' doc='Negate a command or set its defaults' />
1154 <param name='prefix' doc='Set the item name prefix' />
1155 </params>
1156 </command>
1157 <command id='level (global|peer|subscriber)'>
1158 <params>
1159 <param name='level' doc='Set the maximum group level' />
1160 <param name='global' doc='Report global groups only' />
1161 <param name='peer' doc='Report global and network peer related groups' />
1162 <param name='subscriber' doc='Report global, peer, and subscriber groups' />
1163 </params>
1164 </command>
1165 <command id='enable'>
1166 <params>
1167 <param name='enable' doc='Enable the reporter' />
1168 </params>
1169 </command>
1170 <command id='disable'>
1171 <params>
1172 <param name='disable' doc='Disable the reporter' />
1173 </params>
1174 </command>
1175 </node>
1176 <node id='config-line'>
1177 <name>config-line</name>
1178 <command id='login'>
1179 <params>
1180 <param name='login' doc='Enable password checking' />
1181 </params>
1182 </command>
1183 <command id='no login'>
1184 <params>
1185 <param name='no' doc='Negate a command or set its defaults' />
1186 <param name='login' doc='Enable password checking' />
1187 </params>
1188 </command>
1189 <command id='bind A.B.C.D'>
1190 <params>
1191 <param name='bind' doc='Accept VTY telnet connections on local interface' />
1192 <param name='A.B.C.D' doc='Local interface IP address (default: 127.0.0.1)' />
1193 </params>
1194 </command>
1195 </node>
1196 <node id='config-mgcp'>
1197 <name>config-mgcp</name>
1198 <command id='local ip A.B.C.D'>
1199 <params>
1200 <param name='local' doc='Local options for the SDP record' />
1201 <param name='ip' doc='IP information' />
1202 <param name='A.B.C.D' doc='IPv4 Address to use in SDP record' />
1203 </params>
1204 </command>
1205 <command id='bind ip A.B.C.D'>
1206 <params>
1207 <param name='bind' doc='Listen/Bind related socket option' />
1208 <param name='ip' doc='IP information' />
1209 <param name='A.B.C.D' doc='IPv4 Address to bind to' />
1210 </params>
1211 </command>
1212 <command id='bind port &lt;0-65534&gt;'>
1213 <params>
1214 <param name='bind' doc='Listen/Bind related socket option' />
1215 <param name='port' doc='Port information' />
1216 <param name='&lt;0-65534&gt;' doc='UDP port to listen for MGCP messages' />
1217 </params>
1218 </command>
1219 <command id='bind early (0|1)'>
1220 <params>
1221 <param name='bind' doc='Listen/Bind related socket option' />
1222 <param name='early' doc='Bind local ports on start up' />
1223 <param name='0' doc='Bind on demand' />
1224 <param name='1' doc='Bind on startup' />
1225 </params>
1226 </command>
Daniel Willmanne5ed9462018-07-31 18:54:34 +0200[diff] [blame]1227 <command id='rtp port-range &lt;1024-65534&gt; &lt;1025-65535&gt;'>
Neels Hofmeyr2818db82018-03-06 14:59:00 +0100[diff] [blame]1228 <params>
1229 <param name='rtp' doc='RTP configuration' />
1230 <param name='port-range' doc='Range of ports to use for the NET side' />
Daniel Willmanne5ed9462018-07-31 18:54:34 +0200[diff] [blame]1231 <param name='&lt;1024-65534&gt;' doc='Start of the range of ports' />
1232 <param name='&lt;1025-65535&gt;' doc='End of the range of ports' />
Neels Hofmeyr2818db82018-03-06 14:59:00 +0100[diff] [blame]1233 </params>
1234 </command>
1235 <command id='rtp bind-ip A.B.C.D'>
1236 <params>
1237 <param name='rtp' doc='RTP configuration' />
1238 <param name='bind-ip' doc='Bind endpoints facing the Network' />
1239 <param name='A.B.C.D' doc='Address to bind to' />
1240 </params>
1241 </command>
Neels Hofmeyr2818db82018-03-06 14:59:00 +0100[diff] [blame]1242 <command id='no rtp bind-ip'>
1243 <params>
1244 <param name='no' doc='Negate a command or set its defaults' />
1245 <param name='rtp' doc='RTP configuration' />
1246 <param name='bind-ip' doc='Bind endpoints facing the Network' />
1247 </params>
1248 </command>
1249 <command id='rtp ip-probing'>
1250 <params>
1251 <param name='rtp' doc='RTP configuration' />
1252 <param name='ip-probing' doc='automatic rtp bind ip selection' />
1253 </params>
1254 </command>
1255 <command id='no rtp ip-probing'>
1256 <params>
1257 <param name='no' doc='Negate a command or set its defaults' />
1258 <param name='rtp' doc='RTP configuration' />
1259 <param name='ip-probing' doc='no automatic rtp bind ip selection' />
1260 </params>
1261 </command>
1262 <command id='rtp ip-dscp &lt;0-255&gt;'>
1263 <params>
1264 <param name='rtp' doc='RTP configuration' />
1265 <param name='ip-dscp' doc='Apply IP_TOS to the audio stream (including Osmux)' />
1266 <param name='&lt;0-255&gt;' doc='The DSCP value' />
1267 </params>
1268 </command>
Neels Hofmeyr2818db82018-03-06 14:59:00 +0100[diff] [blame]1269 <command id='rtp force-ptime (10|20|40)'>
1270 <params>
1271 <param name='rtp' doc='RTP configuration' />
1272 <param name='force-ptime' doc='Force a fixed ptime for packets sentThe required ptime (packet duration) in ms' />
1273 <param name='10' doc='10 ms' />
1274 <param name='20' doc='20 ms' />
1275 <param name='40' doc='40 ms' />
1276 </params>
1277 </command>
1278 <command id='no rtp force-ptime'>
1279 <params>
1280 <param name='no' doc='Negate a command or set its defaults' />
1281 <param name='rtp' doc='RTP configuration' />
1282 <param name='force-ptime' doc='Force a fixed ptime for packets sent' />
1283 </params>
1284 </command>
1285 <command id='rtp keep-alive &lt;1-120&gt;'>
1286 <params>
1287 <param name='rtp' doc='RTP configuration' />
1288 <param name='keep-alive' doc='Send dummy UDP packet to net RTP destination' />
1289 <param name='&lt;1-120&gt;' doc='Keep alive interval in secs' />
1290 </params>
1291 </command>
1292 <command id='rtp keep-alive once'>
1293 <params>
1294 <param name='rtp' doc='RTP configuration' />
1295 <param name='keep-alive' doc='Send dummy UDP packet to net RTP destination' />
1296 <param name='once' doc='Send dummy packet only once after CRCX/MDCX' />
1297 </params>
1298 </command>
1299 <command id='no rtp keep-alive'>
1300 <params>
1301 <param name='no' doc='Negate a command or set its defaults' />
1302 <param name='rtp' doc='RTP configuration' />
1303 <param name='keep-alive' doc='Send dummy UDP packet to net RTP destination' />
1304 </params>
1305 </command>
1306 <command id='call-agent ip A.B.C.D'>
1307 <params>
1308 <param name='call-agent' doc='Callagent information' />
1309 <param name='ip' doc='IP information' />
1310 <param name='A.B.C.D' doc='IPv4 Address of the callagent' />
1311 </params>
1312 </command>
Neels Hofmeyr2818db82018-03-06 14:59:00 +0100[diff] [blame]1313 <command id='sdp audio-payload number &lt;0-255&gt;'>
1314 <params>
1315 <param name='sdp' doc='SDP File related options' />
1316 <param name='audio-payload' doc='Audio payload options' />
1317 <param name='number' doc='Number' />
1318 <param name='&lt;0-255&gt;' doc='Payload number' />
1319 </params>
1320 </command>
1321 <command id='sdp audio-payload name NAME'>
1322 <params>
1323 <param name='sdp' doc='SDP File related options' />
1324 <param name='audio-payload' doc='Audio payload options' />
1325 <param name='name' doc='Name' />
1326 <param name='NAME' doc='Payload name' />
1327 </params>
1328 </command>
Neels Hofmeyr2818db82018-03-06 14:59:00 +0100[diff] [blame]1329 <command id='loop (0|1)'>
1330 <params>
1331 <param name='loop' doc='Loop audio for all endpoints on main trunk' />
1332 <param name='0' doc='Don&apos;t Loop' />
1333 <param name='1' doc='Loop' />
1334 </params>
1335 </command>
1336 <command id='force-realloc (0|1)'>
1337 <params>
1338 <param name='force-realloc' doc='Force endpoint reallocation when the endpoint is still seized' />
1339 <param name='0' doc='Don&apos;t force reallocation' />
1340 <param name='1' doc='force reallocation' />
1341 </params>
1342 </command>
1343 <command id='rtp-accept-all (0|1)'>
1344 <params>
1345 <param name='rtp-accept-all' doc='Accept all RTP packets, even when the originating IP/Port does not match' />
1346 <param name='0' doc='enable filter' />
1347 <param name='1' doc='disable filter' />
1348 </params>
1349 </command>
1350 <command id='number endpoints &lt;0-65534&gt;'>
1351 <params>
1352 <param name='number' doc='Number options' />
1353 <param name='endpoints' doc='Endpoints available' />
1354 <param name='&lt;0-65534&gt;' doc='Number endpoints' />
1355 </params>
1356 </command>
1357 <command id='rtcp-omit'>
1358 <params>
1359 <param name='rtcp-omit' doc='Drop RTCP packets in both directions' />
1360 </params>
1361 </command>
1362 <command id='no rtcp-omit'>
1363 <params>
1364 <param name='no' doc='Negate a command or set its defaults' />
1365 <param name='rtcp-omit' doc='Drop RTCP packets in both directions' />
1366 </params>
1367 </command>
1368 <command id='rtp-patch ssrc'>
1369 <params>
1370 <param name='rtp-patch' doc='Modify RTP packet header in both directions' />
1371 <param name='ssrc' doc='Force a fixed SSRC' />
1372 </params>
1373 </command>
1374 <command id='no rtp-patch ssrc'>
1375 <params>
1376 <param name='no' doc='Negate a command or set its defaults' />
1377 <param name='rtp-patch' doc='Modify RTP packet header in both directions' />
1378 <param name='ssrc' doc='Force a fixed SSRC' />
1379 </params>
1380 </command>
1381 <command id='rtp-patch timestamp'>
1382 <params>
1383 <param name='rtp-patch' doc='Modify RTP packet header in both directions' />
1384 <param name='timestamp' doc='Adjust RTP timestamp' />
1385 </params>
1386 </command>
1387 <command id='no rtp-patch timestamp'>
1388 <params>
1389 <param name='no' doc='Negate a command or set its defaults' />
1390 <param name='rtp-patch' doc='Modify RTP packet header in both directions' />
1391 <param name='timestamp' doc='Adjust RTP timestamp' />
1392 </params>
1393 </command>
1394 <command id='no rtp-patch'>
1395 <params>
1396 <param name='no' doc='Negate a command or set its defaults' />
1397 <param name='rtp-patch' doc='Modify RTP packet header in both directions' />
1398 </params>
1399 </command>
1400 <command id='sdp audio fmtp-extra .NAME'>
1401 <params>
1402 <param name='sdp' doc='Add extra fmtp for the SDP file' />
1403 <param name='audio' doc='Audio' />
1404 <param name='fmtp-extra' doc='Fmtp-extra' />
1405 <param name='.NAME' doc='Extra Information' />
1406 </params>
1407 </command>
1408 <command id='sdp audio-payload send-ptime'>
1409 <params>
1410 <param name='sdp' doc='SDP File related options' />
1411 <param name='audio-payload' doc='Audio payload options' />
1412 <param name='send-ptime' doc='Send SDP ptime (packet duration) attribute' />
1413 </params>
1414 </command>
1415 <command id='no sdp audio-payload send-ptime'>
1416 <params>
1417 <param name='no' doc='Negate a command or set its defaults' />
1418 <param name='sdp' doc='SDP File related options' />
1419 <param name='audio-payload' doc='Audio payload options' />
1420 <param name='send-ptime' doc='Send SDP ptime (packet duration) attribute' />
1421 </params>
1422 </command>
1423 <command id='sdp audio-payload send-name'>
1424 <params>
1425 <param name='sdp' doc='SDP File related options' />
1426 <param name='audio-payload' doc='Audio payload options' />
1427 <param name='send-name' doc='Send SDP rtpmap with the audio name' />
1428 </params>
1429 </command>
1430 <command id='no sdp audio-payload send-name'>
1431 <params>
1432 <param name='no' doc='Negate a command or set its defaults' />
1433 <param name='sdp' doc='SDP File related options' />
1434 <param name='audio-payload' doc='Audio payload options' />
1435 <param name='send-name' doc='Send SDP rtpmap with the audio name' />
1436 </params>
1437 </command>
1438 <command id='osmux (on|off|only)'>
1439 <params>
1440 <param name='osmux' doc='RTP multiplexing' />
1441 <param name='on' doc='Enable OSMUX' />
1442 <param name='off' doc='Disable OSMUX' />
1443 <param name='only' doc='Only use OSMUX' />
1444 </params>
1445 </command>
1446 <command id='osmux bind-ip A.B.C.D'>
1447 <params>
1448 <param name='osmux' doc='RTP multiplexing' />
1449 <param name='bind-ip' doc='IP information' />
1450 <param name='A.B.C.D' doc='IPv4 Address to bind to' />
1451 </params>
1452 </command>
1453 <command id='osmux batch-factor &lt;1-8&gt;'>
1454 <params>
1455 <param name='osmux' doc='RTP multiplexing' />
1456 <param name='batch-factor' doc='Batching factor' />
1457 <param name='&lt;1-8&gt;' doc='Number of messages in the batch' />
1458 </params>
1459 </command>
1460 <command id='osmux batch-size &lt;1-65535&gt;'>
1461 <params>
1462 <param name='osmux' doc='RTP multiplexing' />
1463 <param name='batch-size' doc='batch size' />
1464 <param name='&lt;1-65535&gt;' doc='Batch size in bytes' />
1465 </params>
1466 </command>
1467 <command id='osmux port &lt;1-65535&gt;'>
1468 <params>
1469 <param name='osmux' doc='RTP multiplexing' />
1470 <param name='port' doc='port' />
1471 <param name='&lt;1-65535&gt;' doc='UDP port' />
1472 </params>
1473 </command>
1474 <command id='osmux dummy (on|off)'>
1475 <params>
1476 <param name='osmux' doc='RTP multiplexing' />
1477 <param name='dummy' doc='Dummy padding' />
1478 <param name='on' doc='Enable dummy padding' />
1479 <param name='off' doc='Disable dummy padding' />
1480 </params>
1481 </command>
1482 <command id='allow-transcoding'>
1483 <params>
1484 <param name='allow-transcoding' doc='Allow transcoding' />
1485 </params>
1486 </command>
1487 <command id='no allow-transcoding'>
1488 <params>
1489 <param name='no' doc='Negate a command or set its defaults' />
1490 <param name='allow-transcoding' doc='Allow transcoding' />
1491 </params>
1492 </command>
1493 <command id='domain NAME'>
1494 <params>
Neels Hofmeyrc0a21962018-11-05 03:18:55 +0100[diff] [blame]1495 <param name='domain' doc='Set the domain part expected in MGCP messages&apos; endpoint names' />
1496 <param name='NAME' doc='Qualified domain name expected in MGCP endpoint names, or &apos;*&apos; to accept any domain' />
Neels Hofmeyr2818db82018-03-06 14:59:00 +0100[diff] [blame]1497 </params>
1498 </command>
1499 <command id='trunk &lt;1-64&gt;'>
1500 <params>
1501 <param name='trunk' doc='Configure a SS7 trunk' />
1502 <param name='&lt;1-64&gt;' doc='Trunk Nr' />
1503 </params>
1504 </command>
1505 </node>
1506 <node id='config-mgcp-trunk'>
1507 <name>config-mgcp-trunk</name>
1508 <command id='rtp keep-alive &lt;1-120&gt;'>
1509 <params>
1510 <param name='rtp' doc='RTP configuration' />
1511 <param name='keep-alive' doc='Send dummy UDP packet to net RTP destination' />
1512 <param name='&lt;1-120&gt;' doc='Keep-alive interval in secs' />
1513 </params>
1514 </command>
1515 <command id='rtp keep-alive once'>
1516 <params>
1517 <param name='rtp' doc='RTP configuration' />
1518 <param name='keep-alive' doc='Send dummy UDP packet to net RTP destination' />
1519 <param name='once' doc='Send dummy packet only once after CRCX/MDCX' />
1520 </params>
1521 </command>
1522 <command id='no rtp keep-alive'>
1523 <params>
1524 <param name='no' doc='Negate a command or set its defaults' />
1525 <param name='rtp' doc='RTP configuration' />
1526 <param name='keep-alive' doc='Send dummy UDP packet to net RTP destination' />
1527 </params>
1528 </command>
1529 <command id='sdp audio-payload number &lt;0-255&gt;'>
1530 <params>
1531 <param name='sdp' doc='SDP File related options' />
1532 <param name='audio-payload' doc='Audio payload options' />
1533 <param name='number' doc='Number' />
1534 <param name='&lt;0-255&gt;' doc='Payload Number' />
1535 </params>
1536 </command>
1537 <command id='sdp audio-payload name NAME'>
1538 <params>
1539 <param name='sdp' doc='SDP File related options' />
1540 <param name='audio-payload' doc='Audio payload options' />
1541 <param name='name' doc='Payload' />
1542 <param name='NAME' doc='Payload Name' />
1543 </params>
1544 </command>
Neels Hofmeyr2818db82018-03-06 14:59:00 +0100[diff] [blame]1545 <command id='loop (0|1)'>
1546 <params>
1547 <param name='loop' doc='Loop audio for all endpoints on this trunk' />
1548 <param name='0' doc='Don&apos;t Loop' />
1549 <param name='1' doc='Loop' />
1550 </params>
1551 </command>
1552 <command id='rtcp-omit'>
1553 <params>
1554 <param name='rtcp-omit' doc='Drop RTCP packets in both directions' />
1555 </params>
1556 </command>
1557 <command id='no rtcp-omit'>
1558 <params>
1559 <param name='no' doc='Negate a command or set its defaults' />
1560 <param name='rtcp-omit' doc='Drop RTCP packets in both directions' />
1561 </params>
1562 </command>
1563 <command id='rtp-patch ssrc'>
1564 <params>
1565 <param name='rtp-patch' doc='Modify RTP packet header in both directions' />
1566 <param name='ssrc' doc='Force a fixed SSRC' />
1567 </params>
1568 </command>
1569 <command id='no rtp-patch ssrc'>
1570 <params>
1571 <param name='no' doc='Negate a command or set its defaults' />
1572 <param name='rtp-patch' doc='Modify RTP packet header in both directions' />
1573 <param name='ssrc' doc='Force a fixed SSRC' />
1574 </params>
1575 </command>
1576 <command id='rtp-patch timestamp'>
1577 <params>
1578 <param name='rtp-patch' doc='Modify RTP packet header in both directions' />
1579 <param name='timestamp' doc='Adjust RTP timestamp' />
1580 </params>
1581 </command>
1582 <command id='no rtp-patch timestamp'>
1583 <params>
1584 <param name='no' doc='Negate a command or set its defaults' />
1585 <param name='rtp-patch' doc='Modify RTP packet header in both directions' />
1586 <param name='timestamp' doc='Adjust RTP timestamp' />
1587 </params>
1588 </command>
1589 <command id='no rtp-patch'>
1590 <params>
1591 <param name='no' doc='Negate a command or set its defaults' />
1592 <param name='rtp-patch' doc='Modify RTP packet header in both directions' />
1593 </params>
1594 </command>
1595 <command id='sdp audio fmtp-extra .NAME'>
1596 <params>
1597 <param name='sdp' doc='Add extra fmtp for the SDP file' />
1598 <param name='audio' doc='Audio' />
1599 <param name='fmtp-extra' doc='Fmtp-extra' />
1600 <param name='.NAME' doc='Extra Information' />
1601 </params>
1602 </command>
1603 <command id='sdp audio-payload send-ptime'>
1604 <params>
1605 <param name='sdp' doc='SDP File related options' />
1606 <param name='audio-payload' doc='Audio payload options' />
1607 <param name='send-ptime' doc='Send SDP ptime (packet duration) attribute' />
1608 </params>
1609 </command>
1610 <command id='no sdp audio-payload send-ptime'>
1611 <params>
1612 <param name='no' doc='Negate a command or set its defaults' />
1613 <param name='sdp' doc='SDP File related options' />
1614 <param name='audio-payload' doc='Audio payload options' />
1615 <param name='send-ptime' doc='Send SDP ptime (packet duration) attribute' />
1616 </params>
1617 </command>
1618 <command id='sdp audio-payload send-name'>
1619 <params>
1620 <param name='sdp' doc='SDP File related options' />
1621 <param name='audio-payload' doc='Audio payload options' />
1622 <param name='send-name' doc='Send SDP rtpmap with the audio name' />
1623 </params>
1624 </command>
1625 <command id='no sdp audio-payload send-name'>
1626 <params>
1627 <param name='no' doc='Negate a command or set its defaults' />
1628 <param name='sdp' doc='SDP File related options' />
1629 <param name='audio-payload' doc='Audio payload options' />
1630 <param name='send-name' doc='Send SDP rtpmap with the audio name' />
1631 </params>
1632 </command>
1633 <command id='allow-transcoding'>
1634 <params>
1635 <param name='allow-transcoding' doc='Allow transcoding' />
1636 </params>
1637 </command>
1638 <command id='no allow-transcoding'>
1639 <params>
1640 <param name='no' doc='Negate a command or set its defaults' />
1641 <param name='allow-transcoding' doc='Allow transcoding' />
1642 </params>
1643 </command>
1644 </node>
1645</vtydoc>