blob: 7a4326306174468ad80d19d3e8e68f427b176010 [file] [log] [blame]
Neels Hofmeyrf4530442017-12-09 03:22:34 +01001<vtydoc xmlns='urn:osmocom:xml:libosmocore:vty:doc:1.0'>
Neels Hofmeyre010dea2017-12-09 03:26:01 +01002 <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>
Neels Hofmeyrf4530442017-12-09 03:22:34 +010054 </node>
Neels Hofmeyre010dea2017-12-09 03:26:01 +010055 <node id='view'>
56 <name>view</name>
Neels Hofmeyrf4530442017-12-09 03:22:34 +010057 <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>
Neels Hofmeyrf4530442017-12-09 03:22:34 +010069 <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>
Neels Hofmeyre010dea2017-12-09 03:26:01 +0100107 <param name='logging' doc='Configure logging' />
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100108 <param name='enable' doc='Enables logging to this vty' />
109 </params>
110 </command>
111 <command id='logging disable'>
112 <params>
Neels Hofmeyre010dea2017-12-09 03:26:01 +0100113 <param name='logging' doc='Configure logging' />
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100114 <param name='disable' doc='Disables logging to this vty' />
115 </params>
116 </command>
117 <command id='logging filter all (0|1)'>
118 <params>
Neels Hofmeyre010dea2017-12-09 03:26:01 +0100119 <param name='logging' doc='Configure logging' />
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100120 <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>
Neels Hofmeyre010dea2017-12-09 03:26:01 +0100128 <param name='logging' doc='Configure logging' />
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100129 <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>
Neels Hofmeyre010dea2017-12-09 03:26:01 +0100136 <param name='logging' doc='Configure logging' />
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100137 <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>
Neels Hofmeyre010dea2017-12-09 03:26:01 +0100144 <param name='logging' doc='Configure logging' />
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100145 <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>
Neels Hofmeyre010dea2017-12-09 03:26:01 +0100153 <param name='logging' doc='Configure logging' />
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100154 <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>
Neels Hofmeyra491e422018-03-06 15:13:25 +0100160 <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>
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100188 <command id='logging set-log-mask MASK'>
189 <params>
Neels Hofmeyre010dea2017-12-09 03:26:01 +0100190 <param name='logging' doc='Configure logging' />
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100191 <param name='set-log-mask' doc='Set the logmask of this logging target' />
Neels Hofmeyre010dea2017-12-09 03:26:01 +0100192 <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' />
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100193 </params>
194 </command>
195 <command id='logging set log mask MASK'>
196 <params>
Neels Hofmeyre010dea2017-12-09 03:26:01 +0100197 <param name='logging' doc='Configure logging' />
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100198 <param name='set' doc='Decide which categories to output.' />
199 <param name='log' doc='Log commands' />
200 <param name='mask' doc='Mask commands' />
Neels Hofmeyre010dea2017-12-09 03:26:01 +0100201 <param name='MASK' doc='&apos;set log mask&apos; is deprecated, please refer to the docs of &apos;set-log-mask&apos; instead' />
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100202 </params>
203 </command>
Neels Hofmeyra491e422018-03-06 15:13:25 +0100204 <command id='logging level (all|ip|tun|ggsn|sgsn|icmp6|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf) (everything|debug|info|notice|error|fatal)'>
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100205 <params>
Neels Hofmeyre010dea2017-12-09 03:26:01 +0100206 <param name='logging' doc='Configure logging' />
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100207 <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='ip' doc='IP Pool and other groups' />
210 <param name='tun' doc='Tunnel interface' />
211 <param name='ggsn' doc='GGSN' />
212 <param name='sgsn' doc='SGSN Emulator' />
213 <param name='icmp6' doc='ICMPv6' />
214 <param name='lglobal' doc='Library-internal global log family' />
215 <param name='llapd' doc='LAPD in libosmogsm' />
216 <param name='linp' doc='A-bis Intput Subsystem' />
217 <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' />
218 <param name='lmi' doc='A-bis Input Driver for Signalling' />
219 <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' />
220 <param name='lsms' doc='Layer3 Short Message Service (SMS)' />
221 <param name='lctrl' doc='Control Interface' />
222 <param name='lgtp' doc='GPRS GTP library' />
223 <param name='lstats' doc='Statistics messages and logging' />
224 <param name='lgsup' doc='Generic Subscriber Update Protocol' />
225 <param name='loap' doc='Osmocom Authentication Protocol' />
226 <param name='lss7' doc='libosmo-sigtran Signalling System 7' />
227 <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' />
228 <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' />
229 <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' />
230 <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' />
Neels Hofmeyra491e422018-03-06 15:13:25 +0100231 <param name='ljibuf' doc='libosmo-netif Jitter Buffer' />
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100232 <param name='everything' doc='Don&apos;t use. It doesn&apos;t log anything' />
233 <param name='debug' doc='Log debug messages and higher levels' />
234 <param name='info' doc='Log informational messages and higher levels' />
235 <param name='notice' doc='Log noticeable messages and higher levels' />
236 <param name='error' doc='Log error messages and higher levels' />
237 <param name='fatal' doc='Log only fatal messages' />
238 </params>
239 </command>
240 <command id='show logging vty'>
241 <params>
242 <param name='show' doc='Show running system information' />
243 <param name='logging' doc='Show current logging configuration' />
244 <param name='vty' doc='Show current logging configuration for this vty' />
245 </params>
246 </command>
247 <command id='show alarms'>
248 <params>
249 <param name='show' doc='Show running system information' />
250 <param name='alarms' doc='Show current logging configuration' />
251 </params>
252 </command>
Neels Hofmeyra491e422018-03-06 15:13:25 +0100253 <command id='show talloc-context (application|all) (full|brief|DEPTH)'>
254 <params>
255 <param name='show' doc='Show running system information' />
256 <param name='talloc-context' doc='Show talloc memory hierarchy' />
257 <param name='application' doc='Application&apos;s context' />
258 <param name='all' doc='All contexts, if NULL-context tracking is enabled' />
259 <param name='full' doc='Display a full talloc memory hierarchy' />
260 <param name='brief' doc='Display a brief talloc memory hierarchy' />
261 <param name='DEPTH' doc='Specify required maximal depth value' />
262 </params>
263 </command>
264 <command id='show talloc-context (application|all) (full|brief|DEPTH) tree ADDRESS'>
265 <params>
266 <param name='show' doc='Show running system information' />
267 <param name='talloc-context' doc='Show talloc memory hierarchy' />
268 <param name='application' doc='Application&apos;s context' />
269 <param name='all' doc='All contexts, if NULL-context tracking is enabled' />
270 <param name='full' doc='Display a full talloc memory hierarchy' />
271 <param name='brief' doc='Display a brief talloc memory hierarchy' />
272 <param name='DEPTH' doc='Specify required maximal depth value' />
273 <param name='tree' doc='Display only a specific memory chunk' />
274 <param name='ADDRESS' doc='Chunk address (e.g. 0xdeadbeef)' />
275 </params>
276 </command>
277 <command id='show talloc-context (application|all) (full|brief|DEPTH) filter REGEXP'>
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='filter' doc='Filter chunks using regular expression' />
287 <param name='REGEXP' doc='Regular expression' />
288 </params>
289 </command>
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100290 <command id='show stats'>
291 <params>
292 <param name='show' doc='Show running system information' />
293 <param name='stats' doc='Show statistical values' />
294 </params>
295 </command>
296 <command id='show stats level (global|peer|subscriber)'>
297 <params>
298 <param name='show' doc='Show running system information' />
299 <param name='stats' doc='Show statistical values' />
300 <param name='level' doc='Set the maximum group level' />
301 <param name='global' doc='Show global groups only' />
302 <param name='peer' doc='Show global and network peer related groups' />
303 <param name='subscriber' doc='Show global, peer, and subscriber groups' />
304 </params>
305 </command>
306 <command id='show asciidoc counters'>
307 <params>
308 <param name='show' doc='Show running system information' />
309 <param name='asciidoc' doc='Asciidoc generation' />
310 <param name='counters' doc='Generate table of all registered counters' />
311 </params>
312 </command>
313 <command id='show pdp-context ggsn NAME [apn APN]'>
314 <params>
315 <param name='show' doc='Show running system information' />
316 <param name='pdp-context' doc='Show PDP Context Information' />
317 <param name='ggsn' doc='Gateway GPRS Support NODE (GGSN)' />
318 <param name='NAME' doc='GGSN Name' />
319 <param name='[apn' doc='(null)' />
320 <param name='APN]' doc='(null)' />
321 </params>
322 </command>
323 <command id='show pdp-context imsi IMSI [&lt;0-15&gt;]'>
324 <params>
325 <param name='show' doc='Show running system information' />
326 <param name='pdp-context' doc='Display information on PDP Context' />
327 <param name='imsi' doc='PDP contexts for given IMSI' />
328 <param name='IMSI' doc='PDP context for given NSAPI' />
329 <param name='[&lt;0-15&gt;]' doc='(null)' />
330 </params>
331 </command>
332 <command id='show ggsn [NAME]'>
333 <params>
334 <param name='show' doc='Show running system information' />
335 <param name='ggsn' doc='Display information on the GGSN' />
336 <param name='[NAME]' doc='(null)' />
337 </params>
338 </command>
339 </node>
Neels Hofmeyre010dea2017-12-09 03:26:01 +0100340 <node id='enable'>
341 <name>enable</name>
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100342 <command id='disable'>
343 <params>
344 <param name='disable' doc='Turn off privileged mode command' />
345 </params>
346 </command>
347 <command id='configure terminal'>
348 <params>
349 <param name='configure' doc='Configuration from vty interface' />
350 <param name='terminal' doc='Configuration terminal' />
351 </params>
352 </command>
353 <command id='copy running-config startup-config'>
354 <params>
355 <param name='copy' doc='Copy configuration' />
356 <param name='running-config' doc='Copy running config to... ' />
357 <param name='startup-config' doc='Copy running config to startup config (same as write file)' />
358 </params>
359 </command>
360 <command id='show startup-config'>
361 <params>
362 <param name='show' doc='Show running system information' />
363 <param name='startup-config' doc='Contentes of startup configuration' />
364 </params>
365 </command>
366 <command id='show version'>
367 <params>
368 <param name='show' doc='Show running system information' />
369 <param name='version' doc='Displays program version' />
370 </params>
371 </command>
372 <command id='show online-help'>
373 <params>
374 <param name='show' doc='Show running system information' />
375 <param name='online-help' doc='Online help' />
376 </params>
377 </command>
378 <command id='terminal length &lt;0-512&gt;'>
379 <params>
380 <param name='terminal' doc='Set terminal line parameters' />
381 <param name='length' doc='Set number of lines on a screen' />
382 <param name='&lt;0-512&gt;' doc='Number of lines on screen (0 for no pausing)' />
383 </params>
384 </command>
385 <command id='terminal no length'>
386 <params>
387 <param name='terminal' doc='Set terminal line parameters' />
388 <param name='no' doc='Negate a command or set its defaults' />
389 <param name='length' doc='Set number of lines on a screen' />
390 </params>
391 </command>
392 <command id='echo .MESSAGE'>
393 <params>
394 <param name='echo' doc='Echo a message back to the vty' />
395 <param name='.MESSAGE' doc='The message to echo' />
396 </params>
397 </command>
398 <command id='who'>
399 <params>
400 <param name='who' doc='Display who is on vty' />
401 </params>
402 </command>
403 <command id='show history'>
404 <params>
405 <param name='show' doc='Show running system information' />
406 <param name='history' doc='Display the session command history' />
407 </params>
408 </command>
409 <command id='terminal monitor'>
410 <params>
411 <param name='terminal' doc='Set terminal line parameters' />
412 <param name='monitor' doc='Copy debug output to the current terminal line' />
413 </params>
414 </command>
415 <command id='terminal no monitor'>
416 <params>
417 <param name='terminal' doc='Set terminal line parameters' />
418 <param name='no' doc='Negate a command or set its defaults' />
419 <param name='monitor' doc='Copy debug output to the current terminal line' />
420 </params>
421 </command>
422 <command id='logging enable'>
423 <params>
Neels Hofmeyre010dea2017-12-09 03:26:01 +0100424 <param name='logging' doc='Configure logging' />
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100425 <param name='enable' doc='Enables logging to this vty' />
426 </params>
427 </command>
428 <command id='logging disable'>
429 <params>
Neels Hofmeyre010dea2017-12-09 03:26:01 +0100430 <param name='logging' doc='Configure logging' />
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100431 <param name='disable' doc='Disables logging to this vty' />
432 </params>
433 </command>
434 <command id='logging filter all (0|1)'>
435 <params>
Neels Hofmeyre010dea2017-12-09 03:26:01 +0100436 <param name='logging' doc='Configure logging' />
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100437 <param name='filter' doc='Filter log messages' />
438 <param name='all' doc='Do you want to log all messages?' />
439 <param name='0' doc='Only print messages matched by other filters' />
440 <param name='1' doc='Bypass filter and print all messages' />
441 </params>
442 </command>
443 <command id='logging color (0|1)'>
444 <params>
Neels Hofmeyre010dea2017-12-09 03:26:01 +0100445 <param name='logging' doc='Configure logging' />
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100446 <param name='color' doc='Configure color-printing for log messages' />
447 <param name='0' doc='Don&apos;t use color for printing messages' />
448 <param name='1' doc='Use color for printing messages' />
449 </params>
450 </command>
451 <command id='logging timestamp (0|1)'>
452 <params>
Neels Hofmeyre010dea2017-12-09 03:26:01 +0100453 <param name='logging' doc='Configure logging' />
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100454 <param name='timestamp' doc='Configure log message timestamping' />
455 <param name='0' doc='Don&apos;t prefix each log message' />
456 <param name='1' doc='Prefix each log message with current timestamp' />
457 </params>
458 </command>
459 <command id='logging print extended-timestamp (0|1)'>
460 <params>
Neels Hofmeyre010dea2017-12-09 03:26:01 +0100461 <param name='logging' doc='Configure logging' />
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100462 <param name='print' doc='Log output settings' />
463 <param name='extended-timestamp' doc='Configure log message timestamping' />
464 <param name='0' doc='Don&apos;t prefix each log message' />
465 <param name='1' doc='Prefix each log message with current timestamp with YYYYMMDDhhmmssnnn' />
466 </params>
467 </command>
468 <command id='logging print category (0|1)'>
469 <params>
Neels Hofmeyre010dea2017-12-09 03:26:01 +0100470 <param name='logging' doc='Configure logging' />
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100471 <param name='print' doc='Log output settings' />
472 <param name='category' doc='Configure log message' />
473 <param name='0' doc='Don&apos;t prefix each log message' />
474 <param name='1' doc='Prefix each log message with category/subsystem name' />
475 </params>
476 </command>
Neels Hofmeyra491e422018-03-06 15:13:25 +0100477 <command id='logging print category-hex (0|1)'>
478 <params>
479 <param name='logging' doc='Configure logging' />
480 <param name='print' doc='Log output settings' />
481 <param name='category-hex' doc='Configure log message' />
482 <param name='0' doc='Don&apos;t prefix each log message' />
483 <param name='1' doc='Prefix each log message with category/subsystem nr in hex (&apos;&lt;000b&gt;&apos;)' />
484 </params>
485 </command>
486 <command id='logging print level (0|1)'>
487 <params>
488 <param name='logging' doc='Configure logging' />
489 <param name='print' doc='Log output settings' />
490 <param name='level' doc='Configure log message' />
491 <param name='0' doc='Don&apos;t prefix each log message' />
492 <param name='1' doc='Prefix each log message with the log level name' />
493 </params>
494 </command>
495 <command id='logging print file (0|1|basename)'>
496 <params>
497 <param name='logging' doc='Configure logging' />
498 <param name='print' doc='Log output settings' />
499 <param name='file' doc='Configure log message' />
500 <param name='0' doc='Don&apos;t prefix each log message' />
501 <param name='1' doc='Prefix each log message with the source file and line' />
502 <param name='basename' doc='Prefix each log message with the source file&apos;s basename (strip leading paths) and line' />
503 </params>
504 </command>
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100505 <command id='logging set-log-mask MASK'>
506 <params>
Neels Hofmeyre010dea2017-12-09 03:26:01 +0100507 <param name='logging' doc='Configure logging' />
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100508 <param name='set-log-mask' doc='Set the logmask of this logging target' />
Neels Hofmeyre010dea2017-12-09 03:26:01 +0100509 <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' />
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100510 </params>
511 </command>
512 <command id='logging set log mask MASK'>
513 <params>
Neels Hofmeyre010dea2017-12-09 03:26:01 +0100514 <param name='logging' doc='Configure logging' />
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100515 <param name='set' doc='Decide which categories to output.' />
516 <param name='log' doc='Log commands' />
517 <param name='mask' doc='Mask commands' />
Neels Hofmeyre010dea2017-12-09 03:26:01 +0100518 <param name='MASK' doc='&apos;set log mask&apos; is deprecated, please refer to the docs of &apos;set-log-mask&apos; instead' />
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100519 </params>
520 </command>
Neels Hofmeyra491e422018-03-06 15:13:25 +0100521 <command id='logging level (all|ip|tun|ggsn|sgsn|icmp6|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf) (everything|debug|info|notice|error|fatal)'>
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100522 <params>
Neels Hofmeyre010dea2017-12-09 03:26:01 +0100523 <param name='logging' doc='Configure logging' />
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100524 <param name='level' doc='Set the log level for a specified category' />
525 <param name='all' doc='Global setting for all subsystems' />
526 <param name='ip' doc='IP Pool and other groups' />
527 <param name='tun' doc='Tunnel interface' />
528 <param name='ggsn' doc='GGSN' />
529 <param name='sgsn' doc='SGSN Emulator' />
530 <param name='icmp6' doc='ICMPv6' />
531 <param name='lglobal' doc='Library-internal global log family' />
532 <param name='llapd' doc='LAPD in libosmogsm' />
533 <param name='linp' doc='A-bis Intput Subsystem' />
534 <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' />
535 <param name='lmi' doc='A-bis Input Driver for Signalling' />
536 <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' />
537 <param name='lsms' doc='Layer3 Short Message Service (SMS)' />
538 <param name='lctrl' doc='Control Interface' />
539 <param name='lgtp' doc='GPRS GTP library' />
540 <param name='lstats' doc='Statistics messages and logging' />
541 <param name='lgsup' doc='Generic Subscriber Update Protocol' />
542 <param name='loap' doc='Osmocom Authentication Protocol' />
543 <param name='lss7' doc='libosmo-sigtran Signalling System 7' />
544 <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' />
545 <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' />
546 <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' />
547 <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' />
Neels Hofmeyra491e422018-03-06 15:13:25 +0100548 <param name='ljibuf' doc='libosmo-netif Jitter Buffer' />
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100549 <param name='everything' doc='Don&apos;t use. It doesn&apos;t log anything' />
550 <param name='debug' doc='Log debug messages and higher levels' />
551 <param name='info' doc='Log informational messages and higher levels' />
552 <param name='notice' doc='Log noticeable messages and higher levels' />
553 <param name='error' doc='Log error messages and higher levels' />
554 <param name='fatal' doc='Log only fatal messages' />
555 </params>
556 </command>
557 <command id='show logging vty'>
558 <params>
559 <param name='show' doc='Show running system information' />
560 <param name='logging' doc='Show current logging configuration' />
561 <param name='vty' doc='Show current logging configuration for this vty' />
562 </params>
563 </command>
564 <command id='show alarms'>
565 <params>
566 <param name='show' doc='Show running system information' />
567 <param name='alarms' doc='Show current logging configuration' />
568 </params>
569 </command>
Neels Hofmeyra491e422018-03-06 15:13:25 +0100570 <command id='show talloc-context (application|all) (full|brief|DEPTH)'>
571 <params>
572 <param name='show' doc='Show running system information' />
573 <param name='talloc-context' doc='Show talloc memory hierarchy' />
574 <param name='application' doc='Application&apos;s context' />
575 <param name='all' doc='All contexts, if NULL-context tracking is enabled' />
576 <param name='full' doc='Display a full talloc memory hierarchy' />
577 <param name='brief' doc='Display a brief talloc memory hierarchy' />
578 <param name='DEPTH' doc='Specify required maximal depth value' />
579 </params>
580 </command>
581 <command id='show talloc-context (application|all) (full|brief|DEPTH) tree ADDRESS'>
582 <params>
583 <param name='show' doc='Show running system information' />
584 <param name='talloc-context' doc='Show talloc memory hierarchy' />
585 <param name='application' doc='Application&apos;s context' />
586 <param name='all' doc='All contexts, if NULL-context tracking is enabled' />
587 <param name='full' doc='Display a full talloc memory hierarchy' />
588 <param name='brief' doc='Display a brief talloc memory hierarchy' />
589 <param name='DEPTH' doc='Specify required maximal depth value' />
590 <param name='tree' doc='Display only a specific memory chunk' />
591 <param name='ADDRESS' doc='Chunk address (e.g. 0xdeadbeef)' />
592 </params>
593 </command>
594 <command id='show talloc-context (application|all) (full|brief|DEPTH) filter REGEXP'>
595 <params>
596 <param name='show' doc='Show running system information' />
597 <param name='talloc-context' doc='Show talloc memory hierarchy' />
598 <param name='application' doc='Application&apos;s context' />
599 <param name='all' doc='All contexts, if NULL-context tracking is enabled' />
600 <param name='full' doc='Display a full talloc memory hierarchy' />
601 <param name='brief' doc='Display a brief talloc memory hierarchy' />
602 <param name='DEPTH' doc='Specify required maximal depth value' />
603 <param name='filter' doc='Filter chunks using regular expression' />
604 <param name='REGEXP' doc='Regular expression' />
605 </params>
606 </command>
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100607 <command id='show stats'>
608 <params>
609 <param name='show' doc='Show running system information' />
610 <param name='stats' doc='Show statistical values' />
611 </params>
612 </command>
613 <command id='show stats level (global|peer|subscriber)'>
614 <params>
615 <param name='show' doc='Show running system information' />
616 <param name='stats' doc='Show statistical values' />
617 <param name='level' doc='Set the maximum group level' />
618 <param name='global' doc='Show global groups only' />
619 <param name='peer' doc='Show global and network peer related groups' />
620 <param name='subscriber' doc='Show global, peer, and subscriber groups' />
621 </params>
622 </command>
623 <command id='show asciidoc counters'>
624 <params>
625 <param name='show' doc='Show running system information' />
626 <param name='asciidoc' doc='Asciidoc generation' />
627 <param name='counters' doc='Generate table of all registered counters' />
628 </params>
629 </command>
630 <command id='show pdp-context ggsn NAME [apn APN]'>
631 <params>
632 <param name='show' doc='Show running system information' />
633 <param name='pdp-context' doc='Show PDP Context Information' />
634 <param name='ggsn' doc='Gateway GPRS Support NODE (GGSN)' />
635 <param name='NAME' doc='GGSN Name' />
636 <param name='[apn' doc='(null)' />
637 <param name='APN]' doc='(null)' />
638 </params>
639 </command>
640 <command id='show pdp-context imsi IMSI [&lt;0-15&gt;]'>
641 <params>
642 <param name='show' doc='Show running system information' />
643 <param name='pdp-context' doc='Display information on PDP Context' />
644 <param name='imsi' doc='PDP contexts for given IMSI' />
645 <param name='IMSI' doc='PDP context for given NSAPI' />
646 <param name='[&lt;0-15&gt;]' doc='(null)' />
647 </params>
648 </command>
649 <command id='show ggsn [NAME]'>
650 <params>
651 <param name='show' doc='Show running system information' />
652 <param name='ggsn' doc='Display information on the GGSN' />
653 <param name='[NAME]' doc='(null)' />
654 </params>
655 </command>
656 </node>
Neels Hofmeyre010dea2017-12-09 03:26:01 +0100657 <node id='config'>
658 <name>config</name>
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100659 <command id='hostname WORD'>
660 <params>
661 <param name='hostname' doc='Set system&apos;s network name' />
662 <param name='WORD' doc='This system&apos;s network name' />
663 </params>
664 </command>
665 <command id='no hostname [HOSTNAME]'>
666 <params>
667 <param name='no' doc='Negate a command or set its defaults' />
668 <param name='hostname' doc='Reset system&apos;s network name' />
669 <param name='[HOSTNAME]' doc='Host name of this router' />
670 </params>
671 </command>
672 <command id='password (8|) WORD'>
673 <params>
674 <param name='password' doc='Assign the terminal connection password' />
675 <param name='8' doc='Specifies a HIDDEN password will follow' />
676 <param name='' doc='dummy string ' />
677 <param name='WORD' doc='The HIDDEN line password string' />
678 </params>
679 </command>
680 <command id='password LINE'>
681 <params>
682 <param name='password' doc='Assign the terminal connection password' />
683 <param name='LINE' doc='The UNENCRYPTED (cleartext) line password' />
684 </params>
685 </command>
686 <command id='enable password (8|) WORD'>
687 <params>
688 <param name='enable' doc='Modify enable password parameters' />
689 <param name='password' doc='Assign the privileged level password' />
690 <param name='8' doc='Specifies a HIDDEN password will follow' />
691 <param name='' doc='dummy string ' />
692 <param name='WORD' doc='The HIDDEN &apos;enable&apos; password string' />
693 </params>
694 </command>
695 <command id='enable password LINE'>
696 <params>
697 <param name='enable' doc='Modify enable password parameters' />
698 <param name='password' doc='Assign the privileged level password' />
699 <param name='LINE' doc='The UNENCRYPTED (cleartext) &apos;enable&apos; password' />
700 </params>
701 </command>
702 <command id='no enable password'>
703 <params>
704 <param name='no' doc='Negate a command or set its defaults' />
705 <param name='enable' doc='Modify enable password parameters' />
706 <param name='password' doc='Assign the privileged level password' />
707 </params>
708 </command>
709 <command id='banner motd default'>
710 <params>
711 <param name='banner' doc='Set banner string' />
712 <param name='motd' doc='Strings for motd' />
713 <param name='default' doc='Default string' />
714 </params>
715 </command>
716 <command id='banner motd file [FILE]'>
717 <params>
718 <param name='banner' doc='Set banner' />
719 <param name='motd' doc='Banner for motd' />
720 <param name='file' doc='Banner from a file' />
721 <param name='[FILE]' doc='Filename' />
722 </params>
723 </command>
724 <command id='no banner motd'>
725 <params>
726 <param name='no' doc='Negate a command or set its defaults' />
727 <param name='banner' doc='Set banner string' />
728 <param name='motd' doc='Strings for motd' />
729 </params>
730 </command>
731 <command id='service terminal-length &lt;0-512&gt;'>
732 <params>
733 <param name='service' doc='Set up miscellaneous service' />
734 <param name='terminal-length' doc='System wide terminal length configuration' />
735 <param name='&lt;0-512&gt;' doc='Number of lines of VTY (0 means no line control)' />
736 </params>
737 </command>
738 <command id='no service terminal-length [&lt;0-512&gt;]'>
739 <params>
740 <param name='no' doc='Negate a command or set its defaults' />
741 <param name='service' doc='Set up miscellaneous service' />
742 <param name='terminal-length' doc='System wide terminal length configuration' />
743 <param name='[&lt;0-512&gt;]' doc='Number of lines of VTY (0 means no line control)' />
744 </params>
745 </command>
746 <command id='line vty'>
747 <params>
748 <param name='line' doc='Configure a terminal line' />
749 <param name='vty' doc='Virtual terminal' />
750 </params>
751 </command>
752 <command id='service advanced-vty'>
753 <params>
754 <param name='service' doc='Set up miscellaneous service' />
755 <param name='advanced-vty' doc='Enable advanced mode vty interface' />
756 </params>
757 </command>
758 <command id='no service advanced-vty'>
759 <params>
760 <param name='no' doc='Negate a command or set its defaults' />
761 <param name='service' doc='Set up miscellaneous service' />
762 <param name='advanced-vty' doc='Enable advanced mode vty interface' />
763 </params>
764 </command>
765 <command id='show history'>
766 <params>
767 <param name='show' doc='Show running system information' />
768 <param name='history' doc='Display the session command history' />
769 </params>
770 </command>
771 <command id='log stderr'>
772 <params>
773 <param name='log' doc='Configure logging sub-system' />
774 <param name='stderr' doc='Logging via STDERR of the process' />
775 </params>
776 </command>
777 <command id='no log stderr'>
778 <params>
779 <param name='no' doc='Negate a command or set its defaults' />
780 <param name='log' doc='Configure logging sub-system' />
781 <param name='stderr' doc='Logging via STDERR of the process' />
782 </params>
783 </command>
784 <command id='log file .FILENAME'>
785 <params>
786 <param name='log' doc='Configure logging sub-system' />
787 <param name='file' doc='Logging to text file' />
788 <param name='.FILENAME' doc='Filename' />
789 </params>
790 </command>
791 <command id='no log file .FILENAME'>
792 <params>
793 <param name='no' doc='Negate a command or set its defaults' />
794 <param name='log' doc='Configure logging sub-system' />
795 <param name='file' doc='Logging to text file' />
796 <param name='.FILENAME' doc='Filename' />
797 </params>
798 </command>
799 <command id='log alarms &lt;2-32700&gt;'>
800 <params>
801 <param name='log' doc='Configure logging sub-system' />
802 <param name='alarms' doc='Logging alarms to osmo_strrb' />
803 <param name='&lt;2-32700&gt;' doc='Maximum number of messages to log' />
804 </params>
805 </command>
806 <command id='no log alarms'>
807 <params>
808 <param name='no' doc='Negate a command or set its defaults' />
809 <param name='log' doc='Configure logging sub-system' />
810 <param name='alarms' doc='Logging alarms to osmo_strrb' />
811 </params>
812 </command>
813 <command id='log syslog (authpriv|cron|daemon|ftp|lpr|mail|news|user|uucp)'>
814 <params>
815 <param name='log' doc='Configure logging sub-system' />
816 <param name='syslog' doc='Logging via syslog' />
817 <param name='authpriv' doc='Security/authorization messages facility' />
818 <param name='cron' doc='Clock daemon (cron/at) facility' />
819 <param name='daemon' doc='General system daemon facility' />
820 <param name='ftp' doc='Ftp daemon facility' />
821 <param name='lpr' doc='Line printer facility' />
822 <param name='mail' doc='Mail facility' />
823 <param name='news' doc='News facility' />
824 <param name='user' doc='Generic facility' />
825 <param name='uucp' doc='UUCP facility' />
826 </params>
827 </command>
828 <command id='log syslog local &lt;0-7&gt;'>
829 <params>
830 <param name='log' doc='Configure logging sub-system' />
831 <param name='syslog' doc='Logging via syslog' />
832 <param name='local' doc='Syslog LOCAL facility' />
833 <param name='&lt;0-7&gt;' doc='Local facility number' />
834 </params>
835 </command>
836 <command id='no log syslog'>
837 <params>
838 <param name='no' doc='Negate a command or set its defaults' />
839 <param name='log' doc='Configure logging sub-system' />
840 <param name='syslog' doc='Logging via syslog' />
841 </params>
842 </command>
843 <command id='log gsmtap [HOSTNAME]'>
844 <params>
845 <param name='log' doc='Configure logging sub-system' />
846 <param name='gsmtap' doc='Logging via GSMTAP' />
847 <param name='[HOSTNAME]' doc='Host name to send the GSMTAP logging to (UDP port 4729)' />
848 </params>
849 </command>
850 <command id='stats reporter statsd'>
851 <params>
852 <param name='stats' doc='Configure stats sub-system' />
853 <param name='reporter' doc='Configure a stats reporter' />
854 <param name='statsd' doc='Report to a STATSD server' />
855 </params>
856 </command>
857 <command id='no stats reporter statsd'>
858 <params>
859 <param name='no' doc='Negate a command or set its defaults' />
860 <param name='stats' doc='Configure stats sub-system' />
861 <param name='reporter' doc='Configure a stats reporter' />
862 <param name='statsd' doc='Report to a STATSD server' />
863 </params>
864 </command>
865 <command id='stats reporter log'>
866 <params>
867 <param name='stats' doc='Configure stats sub-system' />
868 <param name='reporter' doc='Configure a stats reporter' />
869 <param name='log' doc='Report to the logger' />
870 </params>
871 </command>
872 <command id='no stats reporter log'>
873 <params>
874 <param name='no' doc='Negate a command or set its defaults' />
875 <param name='stats' doc='Configure stats sub-system' />
876 <param name='reporter' doc='Configure a stats reporter' />
877 <param name='log' doc='Report to the logger' />
878 </params>
879 </command>
880 <command id='stats interval &lt;1-65535&gt;'>
881 <params>
882 <param name='stats' doc='Configure stats sub-system' />
883 <param name='interval' doc='Set the reporting interval' />
884 <param name='&lt;1-65535&gt;' doc='Interval in seconds' />
885 </params>
886 </command>
887 <command id='ggsn NAME'>
888 <params>
889 <param name='ggsn' doc='Configure the Gateway GPRS Support Node' />
890 <param name='NAME' doc='GGSN Name (has only local significance)' />
891 </params>
892 </command>
893 <command id='no ggsn NAME'>
894 <params>
895 <param name='no' doc='Negate a command or set its defaults' />
896 <param name='ggsn' doc='Remove the named Gateway GPRS Support Node' />
897 <param name='NAME' doc='GGSN Name (has only local significance)' />
898 </params>
899 </command>
900 <command id='ctrl'>
901 <params>
902 <param name='ctrl' doc='Configure the Control Interface' />
903 </params>
904 </command>
905 </node>
Neels Hofmeyre010dea2017-12-09 03:26:01 +0100906 <node id='config-log'>
907 <name>config-log</name>
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100908 <command id='logging filter all (0|1)'>
909 <params>
Neels Hofmeyre010dea2017-12-09 03:26:01 +0100910 <param name='logging' doc='Configure logging' />
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100911 <param name='filter' doc='Filter log messages' />
912 <param name='all' doc='Do you want to log all messages?' />
913 <param name='0' doc='Only print messages matched by other filters' />
914 <param name='1' doc='Bypass filter and print all messages' />
915 </params>
916 </command>
917 <command id='logging color (0|1)'>
918 <params>
Neels Hofmeyre010dea2017-12-09 03:26:01 +0100919 <param name='logging' doc='Configure logging' />
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100920 <param name='color' doc='Configure color-printing for log messages' />
921 <param name='0' doc='Don&apos;t use color for printing messages' />
922 <param name='1' doc='Use color for printing messages' />
923 </params>
924 </command>
925 <command id='logging timestamp (0|1)'>
926 <params>
Neels Hofmeyre010dea2017-12-09 03:26:01 +0100927 <param name='logging' doc='Configure logging' />
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100928 <param name='timestamp' doc='Configure log message timestamping' />
929 <param name='0' doc='Don&apos;t prefix each log message' />
930 <param name='1' doc='Prefix each log message with current timestamp' />
931 </params>
932 </command>
933 <command id='logging print extended-timestamp (0|1)'>
934 <params>
Neels Hofmeyre010dea2017-12-09 03:26:01 +0100935 <param name='logging' doc='Configure logging' />
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100936 <param name='print' doc='Log output settings' />
937 <param name='extended-timestamp' doc='Configure log message timestamping' />
938 <param name='0' doc='Don&apos;t prefix each log message' />
939 <param name='1' doc='Prefix each log message with current timestamp with YYYYMMDDhhmmssnnn' />
940 </params>
941 </command>
942 <command id='logging print category (0|1)'>
943 <params>
Neels Hofmeyre010dea2017-12-09 03:26:01 +0100944 <param name='logging' doc='Configure logging' />
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100945 <param name='print' doc='Log output settings' />
946 <param name='category' doc='Configure log message' />
947 <param name='0' doc='Don&apos;t prefix each log message' />
948 <param name='1' doc='Prefix each log message with category/subsystem name' />
949 </params>
950 </command>
Neels Hofmeyra491e422018-03-06 15:13:25 +0100951 <command id='logging print category-hex (0|1)'>
Neels Hofmeyre010dea2017-12-09 03:26:01 +0100952 <params>
953 <param name='logging' doc='Configure logging' />
Neels Hofmeyra491e422018-03-06 15:13:25 +0100954 <param name='print' doc='Log output settings' />
955 <param name='category-hex' doc='Configure log message' />
956 <param name='0' doc='Don&apos;t prefix each log message' />
957 <param name='1' doc='Prefix each log message with category/subsystem nr in hex (&apos;&lt;000b&gt;&apos;)' />
Neels Hofmeyre010dea2017-12-09 03:26:01 +0100958 </params>
959 </command>
Neels Hofmeyra491e422018-03-06 15:13:25 +0100960 <command id='logging print level (0|1)'>
961 <params>
962 <param name='logging' doc='Configure logging' />
963 <param name='print' doc='Log output settings' />
964 <param name='level' doc='Configure log message' />
965 <param name='0' doc='Don&apos;t prefix each log message' />
966 <param name='1' doc='Prefix each log message with the log level name' />
967 </params>
968 </command>
969 <command id='logging print file (0|1|basename)'>
970 <params>
971 <param name='logging' doc='Configure logging' />
972 <param name='print' doc='Log output settings' />
973 <param name='file' doc='Configure log message' />
974 <param name='0' doc='Don&apos;t prefix each log message' />
975 <param name='1' doc='Prefix each log message with the source file and line' />
976 <param name='basename' doc='Prefix each log message with the source file&apos;s basename (strip leading paths) and line' />
977 </params>
978 </command>
979 <command id='logging level (all|ip|tun|ggsn|sgsn|icmp6|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf) (everything|debug|info|notice|error|fatal)'>
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100980 <params>
Neels Hofmeyre010dea2017-12-09 03:26:01 +0100981 <param name='logging' doc='Configure logging' />
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100982 <param name='level' doc='Set the log level for a specified category' />
983 <param name='all' doc='Global setting for all subsystems' />
984 <param name='ip' doc='IP Pool and other groups' />
985 <param name='tun' doc='Tunnel interface' />
986 <param name='ggsn' doc='GGSN' />
987 <param name='sgsn' doc='SGSN Emulator' />
988 <param name='icmp6' doc='ICMPv6' />
989 <param name='lglobal' doc='Library-internal global log family' />
990 <param name='llapd' doc='LAPD in libosmogsm' />
991 <param name='linp' doc='A-bis Intput Subsystem' />
992 <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' />
993 <param name='lmi' doc='A-bis Input Driver for Signalling' />
994 <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' />
995 <param name='lsms' doc='Layer3 Short Message Service (SMS)' />
996 <param name='lctrl' doc='Control Interface' />
997 <param name='lgtp' doc='GPRS GTP library' />
998 <param name='lstats' doc='Statistics messages and logging' />
999 <param name='lgsup' doc='Generic Subscriber Update Protocol' />
1000 <param name='loap' doc='Osmocom Authentication Protocol' />
1001 <param name='lss7' doc='libosmo-sigtran Signalling System 7' />
1002 <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' />
1003 <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' />
1004 <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' />
1005 <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' />
Neels Hofmeyra491e422018-03-06 15:13:25 +01001006 <param name='ljibuf' doc='libosmo-netif Jitter Buffer' />
Neels Hofmeyrf4530442017-12-09 03:22:34 +01001007 <param name='everything' doc='Don&apos;t use. It doesn&apos;t log anything' />
1008 <param name='debug' doc='Log debug messages and higher levels' />
1009 <param name='info' doc='Log informational messages and higher levels' />
1010 <param name='notice' doc='Log noticeable messages and higher levels' />
1011 <param name='error' doc='Log error messages and higher levels' />
1012 <param name='fatal' doc='Log only fatal messages' />
1013 </params>
1014 </command>
1015 </node>
Neels Hofmeyre010dea2017-12-09 03:26:01 +01001016 <node id='config-stats'>
1017 <name>config-stats</name>
Neels Hofmeyrf4530442017-12-09 03:22:34 +01001018 <command id='local-ip ADDR'>
1019 <params>
1020 <param name='local-ip' doc='Set the IP address to which we bind locally' />
1021 <param name='ADDR' doc='IP Address' />
1022 </params>
1023 </command>
1024 <command id='no local-ip'>
1025 <params>
1026 <param name='no' doc='Negate a command or set its defaults' />
1027 <param name='local-ip' doc='Set the IP address to which we bind locally' />
1028 </params>
1029 </command>
1030 <command id='remote-ip ADDR'>
1031 <params>
1032 <param name='remote-ip' doc='Set the remote IP address to which we connect' />
1033 <param name='ADDR' doc='IP Address' />
1034 </params>
1035 </command>
1036 <command id='remote-port &lt;1-65535&gt;'>
1037 <params>
1038 <param name='remote-port' doc='Set the remote port to which we connect' />
1039 <param name='&lt;1-65535&gt;' doc='Remote port number' />
1040 </params>
1041 </command>
1042 <command id='mtu &lt;100-65535&gt;'>
1043 <params>
1044 <param name='mtu' doc='Set the maximum packet size' />
1045 <param name='&lt;100-65535&gt;' doc='Size in byte' />
1046 </params>
1047 </command>
1048 <command id='no mtu'>
1049 <params>
1050 <param name='no' doc='Negate a command or set its defaults' />
1051 <param name='mtu' doc='Set the maximum packet size' />
1052 </params>
1053 </command>
1054 <command id='prefix PREFIX'>
1055 <params>
1056 <param name='prefix' doc='Set the item name prefix' />
1057 <param name='PREFIX' doc='The prefix string' />
1058 </params>
1059 </command>
1060 <command id='no prefix'>
1061 <params>
1062 <param name='no' doc='Negate a command or set its defaults' />
1063 <param name='prefix' doc='Set the item name prefix' />
1064 </params>
1065 </command>
1066 <command id='level (global|peer|subscriber)'>
1067 <params>
1068 <param name='level' doc='Set the maximum group level' />
1069 <param name='global' doc='Report global groups only' />
1070 <param name='peer' doc='Report global and network peer related groups' />
1071 <param name='subscriber' doc='Report global, peer, and subscriber groups' />
1072 </params>
1073 </command>
1074 <command id='enable'>
1075 <params>
1076 <param name='enable' doc='Enable the reporter' />
1077 </params>
1078 </command>
1079 <command id='disable'>
1080 <params>
1081 <param name='disable' doc='Disable the reporter' />
1082 </params>
1083 </command>
1084 </node>
Neels Hofmeyre010dea2017-12-09 03:26:01 +01001085 <node id='config-line'>
1086 <name>config-line</name>
Neels Hofmeyrf4530442017-12-09 03:22:34 +01001087 <command id='login'>
1088 <params>
1089 <param name='login' doc='Enable password checking' />
1090 </params>
1091 </command>
1092 <command id='no login'>
1093 <params>
1094 <param name='no' doc='Negate a command or set its defaults' />
1095 <param name='login' doc='Enable password checking' />
1096 </params>
1097 </command>
1098 <command id='bind A.B.C.D'>
1099 <params>
1100 <param name='bind' doc='Accept VTY telnet connections on local interface' />
1101 <param name='A.B.C.D' doc='Local interface IP address (default: 127.0.0.1)' />
1102 </params>
1103 </command>
1104 </node>
Neels Hofmeyre010dea2017-12-09 03:26:01 +01001105 <node id='config-ctrl'>
1106 <name>config-ctrl</name>
Neels Hofmeyrf4530442017-12-09 03:22:34 +01001107 <command id='bind A.B.C.D'>
1108 <params>
1109 <param name='bind' doc='Set bind address to listen for Control connections' />
1110 <param name='A.B.C.D' doc='Local IP address (default 127.0.0.1)' />
1111 </params>
1112 </command>
1113 </node>
Neels Hofmeyre010dea2017-12-09 03:26:01 +01001114 <node id='config-ggsn'>
1115 <name>config-ggsn</name>
Neels Hofmeyrf4530442017-12-09 03:22:34 +01001116 <command id='description .TEXT'>
1117 <params>
1118 <param name='description' doc='Save human-readable description of the object' />
1119 <param name='.TEXT' doc='Text until the end of the line' />
1120 </params>
1121 </command>
1122 <command id='no description'>
1123 <params>
1124 <param name='no' doc='Negate a command or set its defaults' />
1125 <param name='description' doc='Remove description of the object' />
1126 </params>
1127 </command>
1128 <command id='shutdown ggsn'>
1129 <params>
1130 <param name='shutdown' doc='Put the GGSN in administrative shut-down' />
1131 <param name='ggsn' doc='Gateway GPRS Support NODE (GGSN)' />
1132 </params>
1133 </command>
1134 <command id='no shutdown ggsn'>
1135 <params>
1136 <param name='no' doc='Negate a command or set its defaults' />
1137 <param name='shutdown' doc='Gateway GPRS Support NODE (GGSN)' />
1138 <param name='ggsn' doc='Remove the GGSN from administrative shut-down' />
1139 </params>
1140 </command>
1141 <command id='gtp bind-ip A.B.C.D'>
1142 <params>
1143 <param name='gtp' doc='GTP Parameters' />
1144 <param name='bind-ip' doc='Set the IP address for the local GTP bind' />
1145 <param name='A.B.C.D' doc='IPv4 Address' />
1146 </params>
1147 </command>
1148 <command id='gtp control-ip A.B.C.D'>
1149 <params>
1150 <param name='gtp' doc='GTP Parameters' />
1151 <param name='control-ip' doc='Set the IP address states as local IP in GTP-C messages' />
1152 <param name='A.B.C.D' doc='IPv4 Address' />
1153 </params>
1154 </command>
1155 <command id='gtp user-ip A.B.C.D'>
1156 <params>
1157 <param name='gtp' doc='GTP Parameters' />
1158 <param name='user-ip' doc='Set the IP address states as local IP in GTP-U messages' />
1159 <param name='A.B.C.D' doc='IPv4 Address' />
1160 </params>
1161 </command>
1162 <command id='gtp state-dir PATH'>
1163 <params>
1164 <param name='gtp' doc='GTP Parameters' />
1165 <param name='state-dir' doc='Set the directory for the GTP State file' />
1166 <param name='PATH' doc='Local Directory' />
1167 </params>
1168 </command>
1169 <command id='apn NAME'>
1170 <params>
1171 <param name='apn' doc='APN Configuration' />
1172 <param name='NAME' doc='APN Name' />
1173 </params>
1174 </command>
1175 <command id='no apn NAME'>
1176 <params>
1177 <param name='no' doc='Negate a command or set its defaults' />
1178 <param name='apn' doc='Remove APN Configuration' />
1179 <param name='NAME' doc='APN Name' />
1180 </params>
1181 </command>
1182 <command id='default-apn NAME'>
1183 <params>
1184 <param name='default-apn' doc='Set a default-APN to be used if no other APN matches' />
1185 <param name='NAME' doc='APN Name' />
1186 </params>
1187 </command>
1188 <command id='no default-apn'>
1189 <params>
1190 <param name='no' doc='Negate a command or set its defaults' />
1191 <param name='default-apn' doc='Remove default-APN to be used if no other APN matches' />
1192 </params>
1193 </command>
1194 </node>
Neels Hofmeyre010dea2017-12-09 03:26:01 +01001195 <node id='config-ggsn-apn'>
1196 <name>config-ggsn-apn</name>
Neels Hofmeyrf4530442017-12-09 03:22:34 +01001197 <command id='description .TEXT'>
1198 <params>
1199 <param name='description' doc='Save human-readable description of the object' />
1200 <param name='.TEXT' doc='Text until the end of the line' />
1201 </params>
1202 </command>
1203 <command id='no description'>
1204 <params>
1205 <param name='no' doc='Negate a command or set its defaults' />
1206 <param name='description' doc='Remove description of the object' />
1207 </params>
1208 </command>
1209 <command id='shutdown'>
1210 <params>
1211 <param name='shutdown' doc='Put the APN in administrative shut-down' />
1212 </params>
1213 </command>
1214 <command id='no shutdown'>
1215 <params>
1216 <param name='no' doc='Negate a command or set its defaults' />
1217 <param name='shutdown' doc='Remove the APN from administrative shut-down' />
1218 </params>
1219 </command>
1220 <command id='gtpu-mode (tun|kernel-gtp)'>
1221 <params>
1222 <param name='gtpu-mode' doc='Set the Mode for this APN (tun or Linux Kernel GTP)' />
1223 <param name='tun' doc='GTP-U in userspace using TUN device' />
1224 <param name='kernel-gtp' doc='GTP-U in kernel using Linux Kernel GTP' />
1225 </params>
1226 </command>
1227 <command id='type-support (v4|v6|v4v6)'>
1228 <params>
1229 <param name='type-support' doc='Enable support for PDP Type' />
1230 <param name='v4' doc='IPv4(-only) PDP Type' />
1231 <param name='v6' doc='IPv6(-only) PDP Type' />
1232 <param name='v4v6' doc='IPv4v6 (dual-stack) PDP Type' />
1233 </params>
1234 </command>
1235 <command id='no type-support (v4|v6|v4v6)'>
1236 <params>
1237 <param name='no' doc='Negate a command or set its defaults' />
1238 <param name='type-support' doc='Disable support for PDP Type' />
1239 <param name='v4' doc='IPv4(-only) PDP Type' />
1240 <param name='v6' doc='IPv6(-only) PDP Type' />
1241 <param name='v4v6' doc='IPv4v6 (dual-stack) PDP Type' />
1242 </params>
1243 </command>
1244 <command id='tun-device NAME'>
1245 <params>
1246 <param name='tun-device' doc='Configure tun device name' />
1247 <param name='NAME' doc='TUN device name' />
1248 </params>
1249 </command>
1250 <command id='ipup-script PATH'>
1251 <params>
1252 <param name='ipup-script' doc='Configure name/path of ip-up script' />
1253 <param name='PATH' doc='File/Path name of ip-up script' />
1254 </params>
1255 </command>
1256 <command id='no ipup-script'>
1257 <params>
1258 <param name='no' doc='Negate a command or set its defaults' />
1259 <param name='ipup-script' doc='Disable ip-up script' />
1260 </params>
1261 </command>
1262 <command id='ipdown-script PATH'>
1263 <params>
1264 <param name='ipdown-script' doc='Configure name/path of ip-down script' />
1265 <param name='PATH' doc='File/Path name of ip-down script' />
1266 </params>
1267 </command>
1268 <command id='no ipdown-script'>
1269 <params>
1270 <param name='no' doc='Negate a command or set its defaults' />
1271 <param name='ipdown-script' doc='Disable ip-down script' />
1272 </params>
1273 </command>
1274 <command id='ip prefix (static|dynamic) A.B.C.D/M'>
1275 <params>
1276 <param name='ip' doc='IP information' />
1277 <param name='prefix' doc='Prefix (Network/Netmask)' />
1278 <param name='static' doc='IPv4 Adress/Prefix-Length' />
1279 <param name='dynamic' doc='(null)' />
1280 <param name='A.B.C.D/M' doc='(null)' />
1281 </params>
1282 </command>
1283 <command id='ipv6 prefix (static|dynamic) X:X::X:X/M'>
1284 <params>
1285 <param name='ipv6' doc='IPv6 Information' />
1286 <param name='prefix' doc='Prefix (Network/Netmask)' />
1287 <param name='static' doc='IPv6 Address/Prefix-Length' />
1288 <param name='dynamic' doc='(null)' />
1289 <param name='X:X::X:X/M' doc='(null)' />
1290 </params>
1291 </command>
1292 <command id='ip dns &lt;0-1&gt; A.B.C.D'>
1293 <params>
1294 <param name='ip' doc='IP information' />
1295 <param name='dns' doc='Configure DNS Server' />
1296 <param name='&lt;0-1&gt;' doc='primary/secondary DNS' />
1297 <param name='A.B.C.D' doc='IP address of DNS Sever' />
1298 </params>
1299 </command>
1300 <command id='ipv6 dns &lt;0-1&gt; X:X::X:X'>
1301 <params>
1302 <param name='ipv6' doc='IPv6 Information' />
1303 <param name='dns' doc='Configure DNS Server' />
1304 <param name='&lt;0-1&gt;' doc='primary/secondary DNS' />
1305 <param name='X:X::X:X' doc='IP address of DNS Sever' />
1306 </params>
1307 </command>
1308 <command id='no (ip|ipv6) dns &lt;0-1&gt;'>
1309 <params>
1310 <param name='no' doc='Negate a command or set its defaults' />
1311 <param name='ip' doc='IP information' />
1312 <param name='ipv6' doc='IPv6 Information' />
1313 <param name='dns' doc='Disable DNS Server' />
1314 <param name='&lt;0-1&gt;' doc='primary/secondary DNS' />
1315 </params>
1316 </command>
1317 <command id='ip ifconfig A.B.C.D/M'>
1318 <params>
1319 <param name='ip' doc='IP information' />
1320 <param name='ifconfig' doc='GGSN-based interface configuration' />
1321 <param name='A.B.C.D/M' doc='IPv4 Adress/Prefix-Length' />
1322 </params>
1323 </command>
1324 <command id='no ip ifconfig'>
1325 <params>
1326 <param name='no' doc='Negate a command or set its defaults' />
1327 <param name='ip' doc='IP information' />
1328 <param name='ifconfig' doc='GGSN-based interface configuration' />
1329 </params>
1330 </command>
1331 <command id='ipv6 ifconfig X:X::X:X/M'>
1332 <params>
1333 <param name='ipv6' doc='IPv6 Information' />
1334 <param name='ifconfig' doc='GGSN-based interface configuration' />
1335 <param name='X:X::X:X/M' doc='IPv6 Adress/Prefix-Length' />
1336 </params>
1337 </command>
1338 <command id='no ipv6 ifconfig'>
1339 <params>
1340 <param name='no' doc='Negate a command or set its defaults' />
1341 <param name='ipv6' doc='IPv6 Information' />
1342 <param name='ifconfig' doc='GGSN-based interface configuration' />
1343 </params>
1344 </command>
Neels Hofmeyra491e422018-03-06 15:13:25 +01001345 <command id='ipv6 link-local X:X::X:X/M'>
1346 <params>
1347 <param name='ipv6' doc='IPv6 Information' />
1348 <param name='link-local' doc='GGSN-based interface configuration' />
1349 <param name='X:X::X:X/M' doc='IPv6 Link-local Adress/Prefix-Length' />
1350 </params>
1351 </command>
1352 <command id='no ipv6 link-local'>
1353 <params>
1354 <param name='no' doc='Negate a command or set its defaults' />
1355 <param name='ipv6' doc='IPv6 Information' />
1356 <param name='link-local' doc='GGSN-based interface configuration' />
1357 </params>
1358 </command>
Neels Hofmeyre010dea2017-12-09 03:26:01 +01001359 <command id='g-pdu tx-sequence-numbers'>
1360 <params>
1361 <param name='g-pdu' doc='G-PDU Configuration' />
1362 <param name='tx-sequence-numbers' doc='Enable transmission of G-PDU sequence numbers' />
1363 </params>
1364 </command>
1365 <command id='no g-pdu tx-sequence-numbers'>
1366 <params>
1367 <param name='no' doc='Negate a command or set its defaults' />
1368 <param name='g-pdu' doc='G-PDU Configuration' />
1369 <param name='tx-sequence-numbers' doc='Disable transmission of G-PDU sequence numbers' />
1370 </params>
1371 </command>
Neels Hofmeyrf4530442017-12-09 03:22:34 +01001372 </node>
1373</vtydoc>