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