Gitiles
Code Review Sign In
gerrit.osmocom.org / osmo-mgw / efe3f98ec77d1ec0dbec88032fe021e32b62895a / . / doc / manuals / vty / mgw_vty_reference.xml
blob: 047a2ad29eafc6c43e65b4e23c3c462d2787bdf1 [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>
Daniel Willmannef9420a2019-06-19 14:08:22 +0200[diff] [blame]190 <command id='logging level (rtp|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro) (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' />
195 <param name='lglobal' doc='Library-internal global log family' />
196 <param name='llapd' doc='LAPD in libosmogsm' />
197 <param name='linp' doc='A-bis Intput Subsystem' />
198 <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' />
199 <param name='lmi' doc='A-bis Input Driver for Signalling' />
200 <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' />
201 <param name='lsms' doc='Layer3 Short Message Service (SMS)' />
202 <param name='lctrl' doc='Control Interface' />
203 <param name='lgtp' doc='GPRS GTP library' />
204 <param name='lstats' doc='Statistics messages and logging' />
205 <param name='lgsup' doc='Generic Subscriber Update Protocol' />
206 <param name='loap' doc='Osmocom Authentication Protocol' />
207 <param name='lss7' doc='libosmo-sigtran Signalling System 7' />
208 <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' />
209 <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' />
210 <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' />
211 <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' />
212 <param name='ljibuf' doc='libosmo-netif Jitter Buffer' />
Daniel Willmannef9420a2019-06-19 14:08:22 +0200[diff] [blame]213 <param name='lrspro' doc='Remote SIM protocol' />
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>
Daniel Willmannef9420a2019-06-19 14:08:22 +0200[diff] [blame]525 <command id='logging level (rtp|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro) (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' />
530 <param name='lglobal' doc='Library-internal global log family' />
531 <param name='llapd' doc='LAPD in libosmogsm' />
532 <param name='linp' doc='A-bis Intput Subsystem' />
533 <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' />
534 <param name='lmi' doc='A-bis Input Driver for Signalling' />
535 <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' />
536 <param name='lsms' doc='Layer3 Short Message Service (SMS)' />
537 <param name='lctrl' doc='Control Interface' />
538 <param name='lgtp' doc='GPRS GTP library' />
539 <param name='lstats' doc='Statistics messages and logging' />
540 <param name='lgsup' doc='Generic Subscriber Update Protocol' />
541 <param name='loap' doc='Osmocom Authentication Protocol' />
542 <param name='lss7' doc='libosmo-sigtran Signalling System 7' />
543 <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' />
544 <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' />
545 <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' />
546 <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' />
547 <param name='ljibuf' doc='libosmo-netif Jitter Buffer' />
Daniel Willmannef9420a2019-06-19 14:08:22 +0200[diff] [blame]548 <param name='lrspro' doc='Remote SIM protocol' />
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' />
Daniel Willmannef9420a2019-06-19 14:08:22 +0200[diff] [blame]564 <param name='error' doc='Log error messages and higher levels' /> <param name='fatal' doc='Log only fatal messages' />
Neels Hofmeyrc0a21962018-11-05 03:18:55 +0100[diff] [blame]565 </params>
566 </command>
567 <command id='logging level force-all (debug|info|notice|error|fatal)'>
568 <params>
569 <param name='logging' doc='Configure logging' />
570 <param name='level' doc='Set the log level for a specified category' />
571 <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.' />
572 <param name='debug' doc='Log debug messages and higher levels' />
573 <param name='info' doc='Log informational messages and higher levels' />
574 <param name='notice' doc='Log noticeable messages and higher levels' />
575 <param name='error' doc='Log error messages and higher levels' />
576 <param name='fatal' doc='Log only fatal messages' />
577 </params>
578 </command>
579 <command id='no logging level force-all'>
580 <params>
581 <param name='no' doc='Negate a command or set its defaults' />
582 <param name='logging' doc='Configure logging' />
583 <param name='level' doc='Set the log level for a specified category' />
584 <param name='force-all' doc='Release any globally forced log level set with &apos;logging level force-all &lt;level&gt;&apos;' />
585 </params>
586 </command>
Neels Hofmeyr2818db82018-03-06 14:59:00 +0100[diff] [blame]587 <command id='show logging vty'>
588 <params>
589 <param name='show' doc='Show running system information' />
590 <param name='logging' doc='Show current logging configuration' />
591 <param name='vty' doc='Show current logging configuration for this vty' />
592 </params>
593 </command>
594 <command id='show alarms'>
595 <params>
596 <param name='show' doc='Show running system information' />
597 <param name='alarms' doc='Show current logging configuration' />
598 </params>
599 </command>
600 <command id='show talloc-context (application|all) (full|brief|DEPTH)'>
601 <params>
602 <param name='show' doc='Show running system information' />
603 <param name='talloc-context' doc='Show talloc memory hierarchy' />
604 <param name='application' doc='Application&apos;s context' />
605 <param name='all' doc='All contexts, if NULL-context tracking is enabled' />
606 <param name='full' doc='Display a full talloc memory hierarchy' />
607 <param name='brief' doc='Display a brief talloc memory hierarchy' />
608 <param name='DEPTH' doc='Specify required maximal depth value' />
609 </params>
610 </command>
611 <command id='show talloc-context (application|all) (full|brief|DEPTH) tree ADDRESS'>
612 <params>
613 <param name='show' doc='Show running system information' />
614 <param name='talloc-context' doc='Show talloc memory hierarchy' />
615 <param name='application' doc='Application&apos;s context' />
616 <param name='all' doc='All contexts, if NULL-context tracking is enabled' />
617 <param name='full' doc='Display a full talloc memory hierarchy' />
618 <param name='brief' doc='Display a brief talloc memory hierarchy' />
619 <param name='DEPTH' doc='Specify required maximal depth value' />
620 <param name='tree' doc='Display only a specific memory chunk' />
621 <param name='ADDRESS' doc='Chunk address (e.g. 0xdeadbeef)' />
622 </params>
623 </command>
624 <command id='show talloc-context (application|all) (full|brief|DEPTH) filter REGEXP'>
625 <params>
626 <param name='show' doc='Show running system information' />
627 <param name='talloc-context' doc='Show talloc memory hierarchy' />
628 <param name='application' doc='Application&apos;s context' />
629 <param name='all' doc='All contexts, if NULL-context tracking is enabled' />
630 <param name='full' doc='Display a full talloc memory hierarchy' />
631 <param name='brief' doc='Display a brief talloc memory hierarchy' />
632 <param name='DEPTH' doc='Specify required maximal depth value' />
633 <param name='filter' doc='Filter chunks using regular expression' />
634 <param name='REGEXP' doc='Regular expression' />
635 </params>
636 </command>
637 <command id='show stats'>
638 <params>
639 <param name='show' doc='Show running system information' />
640 <param name='stats' doc='Show statistical values' />
641 </params>
642 </command>
643 <command id='show stats level (global|peer|subscriber)'>
644 <params>
645 <param name='show' doc='Show running system information' />
646 <param name='stats' doc='Show statistical values' />
647 <param name='level' doc='Set the maximum group level' />
648 <param name='global' doc='Show global groups only' />
649 <param name='peer' doc='Show global and network peer related groups' />
650 <param name='subscriber' doc='Show global, peer, and subscriber groups' />
651 </params>
652 </command>
653 <command id='show asciidoc counters'>
654 <params>
655 <param name='show' doc='Show running system information' />
656 <param name='asciidoc' doc='Asciidoc generation' />
657 <param name='counters' doc='Generate table of all registered counters' />
658 </params>
659 </command>
Daniel Willmanne5ed9462018-07-31 18:54:34 +0200[diff] [blame]660 <command id='show rate-counters'>
661 <params>
662 <param name='show' doc='Show running system information' />
663 <param name='rate-counters' doc='Show all rate counters' />
664 </params>
665 </command>
Neels Hofmeyr2818db82018-03-06 14:59:00 +0100[diff] [blame]666 <command id='show mgcp [stats]'>
667 <params>
668 <param name='show' doc='Show running system information' />
669 <param name='mgcp' doc='Display information about the MGCP Media Gateway' />
670 <param name='[stats]' doc='Include Statistics' />
671 </params>
672 </command>
Neels Hofmeyrc0a21962018-11-05 03:18:55 +0100[diff] [blame]673 <command id='show mgcp endpoint NAME'>
674 <params>
675 <param name='show' doc='Show running system information' />
676 <param name='mgcp' doc='Display information about the MGCP Media Gateway' />
677 <param name='endpoint' doc='Display information about an endpoint' />
678 <param name='NAME' doc='The name of the endpoint' />
679 </params>
680 </command>
681 <command id='show mgcp trunk &lt;0-64&gt; endpoint NAME'>
682 <params>
683 <param name='show' doc='Show running system information' />
684 <param name='mgcp' doc='Display information about the MGCP Media Gateway' />
685 <param name='trunk' doc='Display information about a trunk' />
686 <param name='&lt;0-64&gt;' doc='Trunk number' />
687 <param name='endpoint' doc='Display information about an endpoint' />
688 <param name='NAME' doc='The name of the endpoint' />
689 </params>
690 </command>
Neels Hofmeyr2818db82018-03-06 14:59:00 +0100[diff] [blame]691 <command id='loop-endpoint &lt;0-64&gt; NAME (0|1)'>
692 <params>
693 <param name='loop-endpoint' doc='Loop a given endpoint' />
694 <param name='&lt;0-64&gt;' doc='Trunk number' />
695 <param name='NAME' doc='The name in hex of the endpoint' />
696 <param name='0' doc='Disable the loop' />
697 <param name='1' doc='Enable the loop' />
698 </params>
699 </command>
700 <command id='tap-rtp &lt;0-64&gt; ENDPOINT CONN (in|out) A.B.C.D &lt;0-65534&gt;'>
701 <params>
702 <param name='tap-rtp' doc='Forward data on endpoint to a different system' />
703 <param name='&lt;0-64&gt;' doc='Trunk number' />
704 <param name='ENDPOINT' doc='The endpoint in hex' />
705 <param name='CONN' doc='The connection id in hex' />
706 <param name='in' doc='Forward incoming data' />
707 <param name='out' doc='Forward leaving data' />
708 <param name='A.B.C.D' doc='destination IP of the data' />
709 <param name='&lt;0-65534&gt;' doc='destination port' />
710 </params>
711 </command>
712 <command id='free-endpoint &lt;0-64&gt; NUMBER'>
713 <params>
714 <param name='free-endpoint' doc='Free the given endpoint' />
715 <param name='&lt;0-64&gt;' doc='Trunk number' />
716 <param name='NUMBER' doc='Endpoint number in hex.' />
717 </params>
718 </command>
719 <command id='reset-endpoint &lt;0-64&gt; NUMBER'>
720 <params>
721 <param name='reset-endpoint' doc='Reset the given endpoint' />
722 <param name='&lt;0-64&gt;' doc='Trunk number' />
723 <param name='NUMBER' doc='Endpoint number in hex.' />
724 </params>
725 </command>
726 <command id='reset-all-endpoints'>
727 <params>
728 <param name='reset-all-endpoints' doc='Reset all endpoints' />
729 </params>
730 </command>
731 </node>
732 <node id='config'>
733 <name>config</name>
734 <command id='hostname WORD'>
735 <params>
736 <param name='hostname' doc='Set system&apos;s network name' />
737 <param name='WORD' doc='This system&apos;s network name' />
738 </params>
739 </command>
740 <command id='no hostname [HOSTNAME]'>
741 <params>
742 <param name='no' doc='Negate a command or set its defaults' />
743 <param name='hostname' doc='Reset system&apos;s network name' />
744 <param name='[HOSTNAME]' doc='Host name of this router' />
745 </params>
746 </command>
747 <command id='password (8|) WORD'>
748 <params>
749 <param name='password' doc='Assign the terminal connection password' />
750 <param name='8' doc='Specifies a HIDDEN password will follow' />
751 <param name='' doc='dummy string ' />
752 <param name='WORD' doc='The HIDDEN line password string' />
753 </params>
754 </command>
755 <command id='password LINE'>
756 <params>
757 <param name='password' doc='Assign the terminal connection password' />
758 <param name='LINE' doc='The UNENCRYPTED (cleartext) line password' />
759 </params>
760 </command>
761 <command id='enable password (8|) WORD'>
762 <params>
763 <param name='enable' doc='Modify enable password parameters' />
764 <param name='password' doc='Assign the privileged level password' />
765 <param name='8' doc='Specifies a HIDDEN password will follow' />
766 <param name='' doc='dummy string ' />
767 <param name='WORD' doc='The HIDDEN &apos;enable&apos; password string' />
768 </params>
769 </command>
770 <command id='enable password LINE'>
771 <params>
772 <param name='enable' doc='Modify enable password parameters' />
773 <param name='password' doc='Assign the privileged level password' />
774 <param name='LINE' doc='The UNENCRYPTED (cleartext) &apos;enable&apos; password' />
775 </params>
776 </command>
777 <command id='no enable password'>
778 <params>
779 <param name='no' doc='Negate a command or set its defaults' />
780 <param name='enable' doc='Modify enable password parameters' />
781 <param name='password' doc='Assign the privileged level password' />
782 </params>
783 </command>
784 <command id='banner motd default'>
785 <params>
786 <param name='banner' doc='Set banner string' />
787 <param name='motd' doc='Strings for motd' />
788 <param name='default' doc='Default string' />
789 </params>
790 </command>
791 <command id='banner motd file [FILE]'>
792 <params>
793 <param name='banner' doc='Set banner' />
794 <param name='motd' doc='Banner for motd' />
795 <param name='file' doc='Banner from a file' />
796 <param name='[FILE]' doc='Filename' />
797 </params>
798 </command>
799 <command id='no banner motd'>
800 <params>
801 <param name='no' doc='Negate a command or set its defaults' />
802 <param name='banner' doc='Set banner string' />
803 <param name='motd' doc='Strings for motd' />
804 </params>
805 </command>
806 <command id='service terminal-length &lt;0-512&gt;'>
807 <params>
808 <param name='service' doc='Set up miscellaneous service' />
809 <param name='terminal-length' doc='System wide terminal length configuration' />
810 <param name='&lt;0-512&gt;' doc='Number of lines of VTY (0 means no line control)' />
811 </params>
812 </command>
813 <command id='no service terminal-length [&lt;0-512&gt;]'>
814 <params>
815 <param name='no' doc='Negate a command or set its defaults' />
816 <param name='service' doc='Set up miscellaneous service' />
817 <param name='terminal-length' doc='System wide terminal length configuration' />
818 <param name='[&lt;0-512&gt;]' doc='Number of lines of VTY (0 means no line control)' />
819 </params>
820 </command>
821 <command id='line vty'>
822 <params>
823 <param name='line' doc='Configure a terminal line' />
824 <param name='vty' doc='Virtual terminal' />
825 </params>
826 </command>
827 <command id='service advanced-vty'>
828 <params>
829 <param name='service' doc='Set up miscellaneous service' />
830 <param name='advanced-vty' doc='Enable advanced mode vty interface' />
831 </params>
832 </command>
833 <command id='no service advanced-vty'>
834 <params>
835 <param name='no' doc='Negate a command or set its defaults' />
836 <param name='service' doc='Set up miscellaneous service' />
837 <param name='advanced-vty' doc='Enable advanced mode vty interface' />
838 </params>
839 </command>
840 <command id='show history'>
841 <params>
842 <param name='show' doc='Show running system information' />
843 <param name='history' doc='Display the session command history' />
844 </params>
845 </command>
846 <command id='log stderr'>
847 <params>
848 <param name='log' doc='Configure logging sub-system' />
849 <param name='stderr' doc='Logging via STDERR of the process' />
850 </params>
851 </command>
852 <command id='no log stderr'>
853 <params>
854 <param name='no' doc='Negate a command or set its defaults' />
855 <param name='log' doc='Configure logging sub-system' />
856 <param name='stderr' doc='Logging via STDERR of the process' />
857 </params>
858 </command>
859 <command id='log file .FILENAME'>
860 <params>
861 <param name='log' doc='Configure logging sub-system' />
862 <param name='file' doc='Logging to text file' />
863 <param name='.FILENAME' doc='Filename' />
864 </params>
865 </command>
866 <command id='no log file .FILENAME'>
867 <params>
868 <param name='no' doc='Negate a command or set its defaults' />
869 <param name='log' doc='Configure logging sub-system' />
870 <param name='file' doc='Logging to text file' />
871 <param name='.FILENAME' doc='Filename' />
872 </params>
873 </command>
874 <command id='log alarms &lt;2-32700&gt;'>
875 <params>
876 <param name='log' doc='Configure logging sub-system' />
877 <param name='alarms' doc='Logging alarms to osmo_strrb' />
878 <param name='&lt;2-32700&gt;' doc='Maximum number of messages to log' />
879 </params>
880 </command>
881 <command id='no log alarms'>
882 <params>
883 <param name='no' doc='Negate a command or set its defaults' />
884 <param name='log' doc='Configure logging sub-system' />
885 <param name='alarms' doc='Logging alarms to osmo_strrb' />
886 </params>
887 </command>
888 <command id='log syslog (authpriv|cron|daemon|ftp|lpr|mail|news|user|uucp)'>
889 <params>
890 <param name='log' doc='Configure logging sub-system' />
891 <param name='syslog' doc='Logging via syslog' />
892 <param name='authpriv' doc='Security/authorization messages facility' />
893 <param name='cron' doc='Clock daemon (cron/at) facility' />
894 <param name='daemon' doc='General system daemon facility' />
895 <param name='ftp' doc='Ftp daemon facility' />
896 <param name='lpr' doc='Line printer facility' />
897 <param name='mail' doc='Mail facility' />
898 <param name='news' doc='News facility' />
899 <param name='user' doc='Generic facility' />
900 <param name='uucp' doc='UUCP facility' />
901 </params>
902 </command>
903 <command id='log syslog local &lt;0-7&gt;'>
904 <params>
905 <param name='log' doc='Configure logging sub-system' />
906 <param name='syslog' doc='Logging via syslog' />
907 <param name='local' doc='Syslog LOCAL facility' />
908 <param name='&lt;0-7&gt;' doc='Local facility number' />
909 </params>
910 </command>
911 <command id='no log syslog'>
912 <params>
913 <param name='no' doc='Negate a command or set its defaults' />
914 <param name='log' doc='Configure logging sub-system' />
915 <param name='syslog' doc='Logging via syslog' />
916 </params>
917 </command>
918 <command id='log gsmtap [HOSTNAME]'>
919 <params>
920 <param name='log' doc='Configure logging sub-system' />
921 <param name='gsmtap' doc='Logging via GSMTAP' />
922 <param name='[HOSTNAME]' doc='Host name to send the GSMTAP logging to (UDP port 4729)' />
923 </params>
924 </command>
925 <command id='stats reporter statsd'>
926 <params>
927 <param name='stats' doc='Configure stats sub-system' />
928 <param name='reporter' doc='Configure a stats reporter' />
929 <param name='statsd' doc='Report to a STATSD server' />
930 </params>
931 </command>
932 <command id='no stats reporter statsd'>
933 <params>
934 <param name='no' doc='Negate a command or set its defaults' />
935 <param name='stats' doc='Configure stats sub-system' />
936 <param name='reporter' doc='Configure a stats reporter' />
937 <param name='statsd' doc='Report to a STATSD server' />
938 </params>
939 </command>
940 <command id='stats reporter log'>
941 <params>
942 <param name='stats' doc='Configure stats sub-system' />
943 <param name='reporter' doc='Configure a stats reporter' />
944 <param name='log' doc='Report to the logger' />
945 </params>
946 </command>
947 <command id='no stats reporter log'>
948 <params>
949 <param name='no' doc='Negate a command or set its defaults' />
950 <param name='stats' doc='Configure stats sub-system' />
951 <param name='reporter' doc='Configure a stats reporter' />
952 <param name='log' doc='Report to the logger' />
953 </params>
954 </command>
955 <command id='stats interval &lt;1-65535&gt;'>
956 <params>
957 <param name='stats' doc='Configure stats sub-system' />
958 <param name='interval' doc='Set the reporting interval' />
959 <param name='&lt;1-65535&gt;' doc='Interval in seconds' />
960 </params>
961 </command>
962 <command id='mgcp'>
963 <params>
964 <param name='mgcp' doc='Configure the MGCP' />
965 </params>
966 </command>
967 </node>
968 <node id='config-log'>
969 <name>config-log</name>
970 <command id='logging filter all (0|1)'>
971 <params>
972 <param name='logging' doc='Configure logging' />
973 <param name='filter' doc='Filter log messages' />
974 <param name='all' doc='Do you want to log all messages?' />
975 <param name='0' doc='Only print messages matched by other filters' />
976 <param name='1' doc='Bypass filter and print all messages' />
977 </params>
978 </command>
979 <command id='logging color (0|1)'>
980 <params>
981 <param name='logging' doc='Configure logging' />
982 <param name='color' doc='Configure color-printing for log messages' />
983 <param name='0' doc='Don&apos;t use color for printing messages' />
984 <param name='1' doc='Use color for printing messages' />
985 </params>
986 </command>
987 <command id='logging timestamp (0|1)'>
988 <params>
989 <param name='logging' doc='Configure logging' />
990 <param name='timestamp' doc='Configure log message timestamping' />
991 <param name='0' doc='Don&apos;t prefix each log message' />
992 <param name='1' doc='Prefix each log message with current timestamp' />
993 </params>
994 </command>
995 <command id='logging print extended-timestamp (0|1)'>
996 <params>
997 <param name='logging' doc='Configure logging' />
998 <param name='print' doc='Log output settings' />
999 <param name='extended-timestamp' doc='Configure log message timestamping' />
1000 <param name='0' doc='Don&apos;t prefix each log message' />
1001 <param name='1' doc='Prefix each log message with current timestamp with YYYYMMDDhhmmssnnn' />
1002 </params>
1003 </command>
1004 <command id='logging print category (0|1)'>
1005 <params>
1006 <param name='logging' doc='Configure logging' />
1007 <param name='print' doc='Log output settings' />
1008 <param name='category' doc='Configure log message' />
1009 <param name='0' doc='Don&apos;t prefix each log message' />
1010 <param name='1' doc='Prefix each log message with category/subsystem name' />
1011 </params>
1012 </command>
1013 <command id='logging print category-hex (0|1)'>
1014 <params>
1015 <param name='logging' doc='Configure logging' />
1016 <param name='print' doc='Log output settings' />
1017 <param name='category-hex' doc='Configure log message' />
1018 <param name='0' doc='Don&apos;t prefix each log message' />
1019 <param name='1' doc='Prefix each log message with category/subsystem nr in hex (&apos;&lt;000b&gt;&apos;)' />
1020 </params>
1021 </command>
1022 <command id='logging print level (0|1)'>
1023 <params>
1024 <param name='logging' doc='Configure logging' />
1025 <param name='print' doc='Log output settings' />
1026 <param name='level' doc='Configure log message' />
1027 <param name='0' doc='Don&apos;t prefix each log message' />
1028 <param name='1' doc='Prefix each log message with the log level name' />
1029 </params>
1030 </command>
Neels Hofmeyrc0a21962018-11-05 03:18:55 +0100[diff] [blame]1031 <command id='logging print file (0|1|basename) [last]'>
Neels Hofmeyr2818db82018-03-06 14:59:00 +0100[diff] [blame]1032 <params>
1033 <param name='logging' doc='Configure logging' />
1034 <param name='print' doc='Log output settings' />
1035 <param name='file' doc='Configure log message' />
1036 <param name='0' doc='Don&apos;t prefix each log message' />
1037 <param name='1' doc='Prefix each log message with the source file and line' />
1038 <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]1039 <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]1040 </params>
1041 </command>
Daniel Willmannef9420a2019-06-19 14:08:22 +0200[diff] [blame]1042 <command id='logging level (rtp|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro) (debug|info|notice|error|fatal)'>
Neels Hofmeyr2818db82018-03-06 14:59:00 +0100[diff] [blame]1043 <params>
1044 <param name='logging' doc='Configure logging' />
1045 <param name='level' doc='Set the log level for a specified category' />
Neels Hofmeyr2818db82018-03-06 14:59:00 +0100[diff] [blame]1046 <param name='rtp' doc='RTP stream handling' />
1047 <param name='lglobal' doc='Library-internal global log family' />
1048 <param name='llapd' doc='LAPD in libosmogsm' />
1049 <param name='linp' doc='A-bis Intput Subsystem' />
1050 <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' />
1051 <param name='lmi' doc='A-bis Input Driver for Signalling' />
1052 <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' />
1053 <param name='lsms' doc='Layer3 Short Message Service (SMS)' />
1054 <param name='lctrl' doc='Control Interface' />
1055 <param name='lgtp' doc='GPRS GTP library' />
1056 <param name='lstats' doc='Statistics messages and logging' />
1057 <param name='lgsup' doc='Generic Subscriber Update Protocol' />
1058 <param name='loap' doc='Osmocom Authentication Protocol' />
1059 <param name='lss7' doc='libosmo-sigtran Signalling System 7' />
1060 <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' />
1061 <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' />
1062 <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' />
1063 <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' />
1064 <param name='ljibuf' doc='libosmo-netif Jitter Buffer' />
Daniel Willmannef9420a2019-06-19 14:08:22 +0200[diff] [blame]1065 <param name='lrspro' doc='Remote SIM protocol' />
Neels Hofmeyr2818db82018-03-06 14:59:00 +0100[diff] [blame]1066 <param name='debug' doc='Log debug messages and higher levels' />
1067 <param name='info' doc='Log informational messages and higher levels' />
1068 <param name='notice' doc='Log noticeable messages and higher levels' />
1069 <param name='error' doc='Log error messages and higher levels' />
1070 <param name='fatal' doc='Log only fatal messages' />
1071 </params>
1072 </command>
Neels Hofmeyrc0a21962018-11-05 03:18:55 +0100[diff] [blame]1073 <command id='logging level set-all (debug|info|notice|error|fatal)'>
1074 <params>
1075 <param name='logging' doc='Configure logging' />
1076 <param name='level' doc='Set the log level for a specified category' />
1077 <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.' />
1078 <param name='debug' doc='Log debug messages and higher levels' />
1079 <param name='info' doc='Log informational messages and higher levels' />
1080 <param name='notice' doc='Log noticeable messages and higher levels' />
1081 <param name='error' doc='Log error messages and higher levels' />
1082 <param name='fatal' doc='Log only fatal messages' />
1083 </params>
1084 </command>
1085 <command id='logging level force-all (debug|info|notice|error|fatal)'>
1086 <params>
1087 <param name='logging' doc='Configure logging' />
1088 <param name='level' doc='Set the log level for a specified category' />
1089 <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.' />
1090 <param name='debug' doc='Log debug messages and higher levels' />
1091 <param name='info' doc='Log informational messages and higher levels' />
1092 <param name='notice' doc='Log noticeable messages and higher levels' />
1093 <param name='error' doc='Log error messages and higher levels' />
1094 <param name='fatal' doc='Log only fatal messages' />
1095 </params>
1096 </command>
1097 <command id='no logging level force-all'>
1098 <params>
1099 <param name='no' doc='Negate a command or set its defaults' />
1100 <param name='logging' doc='Configure logging' />
1101 <param name='level' doc='Set the log level for a specified category' />
1102 <param name='force-all' doc='Release any globally forced log level set with &apos;logging level force-all &lt;level&gt;&apos;' />
1103 </params>
1104 </command>
Neels Hofmeyr2818db82018-03-06 14:59:00 +0100[diff] [blame]1105 </node>
1106 <node id='config-stats'>
1107 <name>config-stats</name>
1108 <command id='local-ip ADDR'>
1109 <params>
1110 <param name='local-ip' doc='Set the IP address to which we bind locally' />
1111 <param name='ADDR' doc='IP Address' />
1112 </params>
1113 </command>
1114 <command id='no local-ip'>
1115 <params>
1116 <param name='no' doc='Negate a command or set its defaults' />
1117 <param name='local-ip' doc='Set the IP address to which we bind locally' />
1118 </params>
1119 </command>
1120 <command id='remote-ip ADDR'>
1121 <params>
1122 <param name='remote-ip' doc='Set the remote IP address to which we connect' />
1123 <param name='ADDR' doc='IP Address' />
1124 </params>
1125 </command>
1126 <command id='remote-port &lt;1-65535&gt;'>
1127 <params>
1128 <param name='remote-port' doc='Set the remote port to which we connect' />
1129 <param name='&lt;1-65535&gt;' doc='Remote port number' />
1130 </params>
1131 </command>
1132 <command id='mtu &lt;100-65535&gt;'>
1133 <params>
1134 <param name='mtu' doc='Set the maximum packet size' />
1135 <param name='&lt;100-65535&gt;' doc='Size in byte' />
1136 </params>
1137 </command>
1138 <command id='no mtu'>
1139 <params>
1140 <param name='no' doc='Negate a command or set its defaults' />
1141 <param name='mtu' doc='Set the maximum packet size' />
1142 </params>
1143 </command>
1144 <command id='prefix PREFIX'>
1145 <params>
1146 <param name='prefix' doc='Set the item name prefix' />
1147 <param name='PREFIX' doc='The prefix string' />
1148 </params>
1149 </command>
1150 <command id='no prefix'>
1151 <params>
1152 <param name='no' doc='Negate a command or set its defaults' />
1153 <param name='prefix' doc='Set the item name prefix' />
1154 </params>
1155 </command>
1156 <command id='level (global|peer|subscriber)'>
1157 <params>
1158 <param name='level' doc='Set the maximum group level' />
1159 <param name='global' doc='Report global groups only' />
1160 <param name='peer' doc='Report global and network peer related groups' />
1161 <param name='subscriber' doc='Report global, peer, and subscriber groups' />
1162 </params>
1163 </command>
1164 <command id='enable'>
1165 <params>
1166 <param name='enable' doc='Enable the reporter' />
1167 </params>
1168 </command>
1169 <command id='disable'>
1170 <params>
1171 <param name='disable' doc='Disable the reporter' />
1172 </params>
1173 </command>
1174 </node>
1175 <node id='config-line'>
1176 <name>config-line</name>
1177 <command id='login'>
1178 <params>
1179 <param name='login' doc='Enable password checking' />
1180 </params>
1181 </command>
1182 <command id='no login'>
1183 <params>
1184 <param name='no' doc='Negate a command or set its defaults' />
1185 <param name='login' doc='Enable password checking' />
1186 </params>
1187 </command>
Daniel Willmannef9420a2019-06-19 14:08:22 +0200[diff] [blame]1188 <command id='bind A.B.C.D [&lt;0-65535&gt;]'>
Neels Hofmeyr2818db82018-03-06 14:59:00 +0100[diff] [blame]1189 <params>
1190 <param name='bind' doc='Accept VTY telnet connections on local interface' />
1191 <param name='A.B.C.D' doc='Local interface IP address (default: 127.0.0.1)' />
Daniel Willmannef9420a2019-06-19 14:08:22 +0200[diff] [blame]1192 <param name='[&lt;0-65535&gt;]' doc='Local TCP port number' />
Neels Hofmeyr2818db82018-03-06 14:59:00 +0100[diff] [blame]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>
Daniel Willmannef9420a2019-06-19 14:08:22 +0200[diff] [blame]1400 <command id='rtp-patch rfc5993hr'>
1401 <params>
1402 <param name='rtp-patch' doc='Modify RTP packet header in both directions' />
1403 <param name='rfc5993hr' doc='Convert GSM-HR from TS101318 to RFC5993 and vice versa' />
1404 </params>
1405 </command>
1406 <command id='no rtp-patch rfc5993hr'>
1407 <params>
1408 <param name='no' doc='Negate a command or set its defaults' />
1409 <param name='rtp-patch' doc='Modify RTP packet header in both directions' />
1410 <param name='rfc5993hr' doc='Convert GSM-HR from TS101318 to RFC5993 and vice versa' />
1411 </params>
1412 </command>
Neels Hofmeyr2818db82018-03-06 14:59:00 +0100[diff] [blame]1413 <command id='sdp audio fmtp-extra .NAME'>
1414 <params>
1415 <param name='sdp' doc='Add extra fmtp for the SDP file' />
1416 <param name='audio' doc='Audio' />
1417 <param name='fmtp-extra' doc='Fmtp-extra' />
1418 <param name='.NAME' doc='Extra Information' />
1419 </params>
1420 </command>
1421 <command id='sdp audio-payload send-ptime'>
1422 <params>
1423 <param name='sdp' doc='SDP File related options' />
1424 <param name='audio-payload' doc='Audio payload options' />
1425 <param name='send-ptime' doc='Send SDP ptime (packet duration) attribute' />
1426 </params>
1427 </command>
1428 <command id='no sdp audio-payload send-ptime'>
1429 <params>
1430 <param name='no' doc='Negate a command or set its defaults' />
1431 <param name='sdp' doc='SDP File related options' />
1432 <param name='audio-payload' doc='Audio payload options' />
1433 <param name='send-ptime' doc='Send SDP ptime (packet duration) attribute' />
1434 </params>
1435 </command>
1436 <command id='sdp audio-payload send-name'>
1437 <params>
1438 <param name='sdp' doc='SDP File related options' />
1439 <param name='audio-payload' doc='Audio payload options' />
1440 <param name='send-name' doc='Send SDP rtpmap with the audio name' />
1441 </params>
1442 </command>
1443 <command id='no sdp audio-payload send-name'>
1444 <params>
1445 <param name='no' doc='Negate a command or set its defaults' />
1446 <param name='sdp' doc='SDP File related options' />
1447 <param name='audio-payload' doc='Audio payload options' />
1448 <param name='send-name' doc='Send SDP rtpmap with the audio name' />
1449 </params>
1450 </command>
1451 <command id='osmux (on|off|only)'>
1452 <params>
1453 <param name='osmux' doc='RTP multiplexing' />
1454 <param name='on' doc='Enable OSMUX' />
1455 <param name='off' doc='Disable OSMUX' />
1456 <param name='only' doc='Only use OSMUX' />
1457 </params>
1458 </command>
1459 <command id='osmux bind-ip A.B.C.D'>
1460 <params>
1461 <param name='osmux' doc='RTP multiplexing' />
1462 <param name='bind-ip' doc='IP information' />
1463 <param name='A.B.C.D' doc='IPv4 Address to bind to' />
1464 </params>
1465 </command>
1466 <command id='osmux batch-factor &lt;1-8&gt;'>
1467 <params>
1468 <param name='osmux' doc='RTP multiplexing' />
1469 <param name='batch-factor' doc='Batching factor' />
1470 <param name='&lt;1-8&gt;' doc='Number of messages in the batch' />
1471 </params>
1472 </command>
1473 <command id='osmux batch-size &lt;1-65535&gt;'>
1474 <params>
1475 <param name='osmux' doc='RTP multiplexing' />
1476 <param name='batch-size' doc='batch size' />
1477 <param name='&lt;1-65535&gt;' doc='Batch size in bytes' />
1478 </params>
1479 </command>
1480 <command id='osmux port &lt;1-65535&gt;'>
1481 <params>
1482 <param name='osmux' doc='RTP multiplexing' />
1483 <param name='port' doc='port' />
1484 <param name='&lt;1-65535&gt;' doc='UDP port' />
1485 </params>
1486 </command>
1487 <command id='osmux dummy (on|off)'>
1488 <params>
1489 <param name='osmux' doc='RTP multiplexing' />
1490 <param name='dummy' doc='Dummy padding' />
1491 <param name='on' doc='Enable dummy padding' />
1492 <param name='off' doc='Disable dummy padding' />
1493 </params>
1494 </command>
1495 <command id='allow-transcoding'>
1496 <params>
1497 <param name='allow-transcoding' doc='Allow transcoding' />
1498 </params>
1499 </command>
1500 <command id='no allow-transcoding'>
1501 <params>
1502 <param name='no' doc='Negate a command or set its defaults' />
1503 <param name='allow-transcoding' doc='Allow transcoding' />
1504 </params>
1505 </command>
1506 <command id='domain NAME'>
1507 <params>
Neels Hofmeyrc0a21962018-11-05 03:18:55 +0100[diff] [blame]1508 <param name='domain' doc='Set the domain part expected in MGCP messages&apos; endpoint names' />
1509 <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]1510 </params>
1511 </command>
Oliver Smith1e4a34d2019-06-27 09:41:35 +0200[diff] [blame]1512 <command id='conn-timeout &lt;0-65534&gt;'>
Daniel Willmannef9420a2019-06-19 14:08:22 +0200[diff] [blame]1513 <params>
Oliver Smith1e4a34d2019-06-27 09:41:35 +0200[diff] [blame]1514 <param name='conn-timeout' doc='Set a time after which inactive connections (CIs) are closed. Set to 0 to disable timeout. This can be used to work around interoperability problems causing connections to stay open forever, and slowly exhausting all available ports. Enable keep-alive packets in MGW clients when using this option together with LCLS (OsmoBSC, OsmoMSC: &apos;rtp keep-alive&apos;)!' />
1515 <param name='&lt;0-65534&gt;' doc='Timeout value (sec.)' />
Daniel Willmannef9420a2019-06-19 14:08:22 +0200[diff] [blame]1516 </params>
1517 </command>
Neels Hofmeyr2818db82018-03-06 14:59:00 +0100[diff] [blame]1518 <command id='trunk &lt;1-64&gt;'>
1519 <params>
1520 <param name='trunk' doc='Configure a SS7 trunk' />
1521 <param name='&lt;1-64&gt;' doc='Trunk Nr' />
1522 </params>
1523 </command>
1524 </node>
1525 <node id='config-mgcp-trunk'>
1526 <name>config-mgcp-trunk</name>
1527 <command id='rtp keep-alive &lt;1-120&gt;'>
1528 <params>
1529 <param name='rtp' doc='RTP configuration' />
1530 <param name='keep-alive' doc='Send dummy UDP packet to net RTP destination' />
1531 <param name='&lt;1-120&gt;' doc='Keep-alive interval in secs' />
1532 </params>
1533 </command>
1534 <command id='rtp keep-alive once'>
1535 <params>
1536 <param name='rtp' doc='RTP configuration' />
1537 <param name='keep-alive' doc='Send dummy UDP packet to net RTP destination' />
1538 <param name='once' doc='Send dummy packet only once after CRCX/MDCX' />
1539 </params>
1540 </command>
1541 <command id='no rtp keep-alive'>
1542 <params>
1543 <param name='no' doc='Negate a command or set its defaults' />
1544 <param name='rtp' doc='RTP configuration' />
1545 <param name='keep-alive' doc='Send dummy UDP packet to net RTP destination' />
1546 </params>
1547 </command>
1548 <command id='sdp audio-payload number &lt;0-255&gt;'>
1549 <params>
1550 <param name='sdp' doc='SDP File related options' />
1551 <param name='audio-payload' doc='Audio payload options' />
1552 <param name='number' doc='Number' />
1553 <param name='&lt;0-255&gt;' doc='Payload Number' />
1554 </params>
1555 </command>
1556 <command id='sdp audio-payload name NAME'>
1557 <params>
1558 <param name='sdp' doc='SDP File related options' />
1559 <param name='audio-payload' doc='Audio payload options' />
1560 <param name='name' doc='Payload' />
1561 <param name='NAME' doc='Payload Name' />
1562 </params>
1563 </command>
Neels Hofmeyr2818db82018-03-06 14:59:00 +0100[diff] [blame]1564 <command id='loop (0|1)'>
1565 <params>
1566 <param name='loop' doc='Loop audio for all endpoints on this trunk' />
1567 <param name='0' doc='Don&apos;t Loop' />
1568 <param name='1' doc='Loop' />
1569 </params>
1570 </command>
1571 <command id='rtcp-omit'>
1572 <params>
1573 <param name='rtcp-omit' doc='Drop RTCP packets in both directions' />
1574 </params>
1575 </command>
1576 <command id='no rtcp-omit'>
1577 <params>
1578 <param name='no' doc='Negate a command or set its defaults' />
1579 <param name='rtcp-omit' doc='Drop RTCP packets in both directions' />
1580 </params>
1581 </command>
1582 <command id='rtp-patch ssrc'>
1583 <params>
1584 <param name='rtp-patch' doc='Modify RTP packet header in both directions' />
1585 <param name='ssrc' doc='Force a fixed SSRC' />
1586 </params>
1587 </command>
1588 <command id='no rtp-patch ssrc'>
1589 <params>
1590 <param name='no' doc='Negate a command or set its defaults' />
1591 <param name='rtp-patch' doc='Modify RTP packet header in both directions' />
1592 <param name='ssrc' doc='Force a fixed SSRC' />
1593 </params>
1594 </command>
1595 <command id='rtp-patch timestamp'>
1596 <params>
1597 <param name='rtp-patch' doc='Modify RTP packet header in both directions' />
1598 <param name='timestamp' doc='Adjust RTP timestamp' />
1599 </params>
1600 </command>
Daniel Willmannef9420a2019-06-19 14:08:22 +0200[diff] [blame]1601 <command id='rtp-patch rfc5993hr'>
1602 <params>
1603 <param name='rtp-patch' doc='Modify RTP packet header in both directions' />
1604 <param name='rfc5993hr' doc='Convert GSM-HR from TS101318 to RFC5993 and vice versa' />
1605 </params>
1606 </command>
1607 <command id='no rtp-patch rfc5993hr'>
1608 <params>
1609 <param name='no' doc='Negate a command or set its defaults' />
1610 <param name='rtp-patch' doc='Modify RTP packet header in both directions' />
1611 <param name='rfc5993hr' doc='Convert GSM-HR from TS101318 to RFC5993 and vice versa' />
1612 </params>
1613 </command>
Neels Hofmeyr2818db82018-03-06 14:59:00 +0100[diff] [blame]1614 <command id='no rtp-patch timestamp'>
1615 <params>
1616 <param name='no' doc='Negate a command or set its defaults' />
1617 <param name='rtp-patch' doc='Modify RTP packet header in both directions' />
1618 <param name='timestamp' doc='Adjust RTP timestamp' />
1619 </params>
1620 </command>
1621 <command id='no rtp-patch'>
1622 <params>
1623 <param name='no' doc='Negate a command or set its defaults' />
1624 <param name='rtp-patch' doc='Modify RTP packet header in both directions' />
1625 </params>
1626 </command>
1627 <command id='sdp audio fmtp-extra .NAME'>
1628 <params>
1629 <param name='sdp' doc='Add extra fmtp for the SDP file' />
1630 <param name='audio' doc='Audio' />
1631 <param name='fmtp-extra' doc='Fmtp-extra' />
1632 <param name='.NAME' doc='Extra Information' />
1633 </params>
1634 </command>
1635 <command id='sdp audio-payload send-ptime'>
1636 <params>
1637 <param name='sdp' doc='SDP File related options' />
1638 <param name='audio-payload' doc='Audio payload options' />
1639 <param name='send-ptime' doc='Send SDP ptime (packet duration) attribute' />
1640 </params>
1641 </command>
1642 <command id='no sdp audio-payload send-ptime'>
1643 <params>
1644 <param name='no' doc='Negate a command or set its defaults' />
1645 <param name='sdp' doc='SDP File related options' />
1646 <param name='audio-payload' doc='Audio payload options' />
1647 <param name='send-ptime' doc='Send SDP ptime (packet duration) attribute' />
1648 </params>
1649 </command>
1650 <command id='sdp audio-payload send-name'>
1651 <params>
1652 <param name='sdp' doc='SDP File related options' />
1653 <param name='audio-payload' doc='Audio payload options' />
1654 <param name='send-name' doc='Send SDP rtpmap with the audio name' />
1655 </params>
1656 </command>
1657 <command id='no sdp audio-payload send-name'>
1658 <params>
1659 <param name='no' doc='Negate a command or set its defaults' />
1660 <param name='sdp' doc='SDP File related options' />
1661 <param name='audio-payload' doc='Audio payload options' />
1662 <param name='send-name' doc='Send SDP rtpmap with the audio name' />
1663 </params>
1664 </command>
1665 <command id='allow-transcoding'>
1666 <params>
1667 <param name='allow-transcoding' doc='Allow transcoding' />
1668 </params>
1669 </command>
1670 <command id='no allow-transcoding'>
1671 <params>
1672 <param name='no' doc='Negate a command or set its defaults' />
1673 <param name='allow-transcoding' doc='Allow transcoding' />
1674 </params>
1675 </command>
1676 </node>
1677</vtydoc>