blob: 746002667e01cb2a648d0b547a6591e7fc3661df [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>
Neels Hofmeyrf4530442017-12-09 03:22:34 +010088 <command id='who'>
89 <params>
90 <param name='who' doc='Display who is on vty' />
91 </params>
92 </command>
93 <command id='show history'>
94 <params>
95 <param name='show' doc='Show running system information' />
96 <param name='history' doc='Display the session command history' />
97 </params>
98 </command>
99 <command id='logging enable'>
100 <params>
Neels Hofmeyre010dea2017-12-09 03:26:01 +0100101 <param name='logging' doc='Configure logging' />
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100102 <param name='enable' doc='Enables logging to this vty' />
103 </params>
104 </command>
105 <command id='logging disable'>
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='disable' doc='Disables logging to this vty' />
109 </params>
110 </command>
111 <command id='logging filter all (0|1)'>
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='filter' doc='Filter log messages' />
115 <param name='all' doc='Do you want to log all messages?' />
116 <param name='0' doc='Only print messages matched by other filters' />
117 <param name='1' doc='Bypass filter and print all messages' />
118 </params>
119 </command>
120 <command id='logging color (0|1)'>
121 <params>
Neels Hofmeyre010dea2017-12-09 03:26:01 +0100122 <param name='logging' doc='Configure logging' />
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100123 <param name='color' doc='Configure color-printing for log messages' />
124 <param name='0' doc='Don&apos;t use color for printing messages' />
125 <param name='1' doc='Use color for printing messages' />
126 </params>
127 </command>
128 <command id='logging timestamp (0|1)'>
129 <params>
Neels Hofmeyre010dea2017-12-09 03:26:01 +0100130 <param name='logging' doc='Configure logging' />
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100131 <param name='timestamp' doc='Configure log message timestamping' />
132 <param name='0' doc='Don&apos;t prefix each log message' />
133 <param name='1' doc='Prefix each log message with current timestamp' />
134 </params>
135 </command>
136 <command id='logging print extended-timestamp (0|1)'>
137 <params>
Neels Hofmeyre010dea2017-12-09 03:26:01 +0100138 <param name='logging' doc='Configure logging' />
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100139 <param name='print' doc='Log output settings' />
140 <param name='extended-timestamp' doc='Configure log message timestamping' />
141 <param name='0' doc='Don&apos;t prefix each log message' />
142 <param name='1' doc='Prefix each log message with current timestamp with YYYYMMDDhhmmssnnn' />
143 </params>
144 </command>
145 <command id='logging print category (0|1)'>
146 <params>
Neels Hofmeyre010dea2017-12-09 03:26:01 +0100147 <param name='logging' doc='Configure logging' />
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100148 <param name='print' doc='Log output settings' />
149 <param name='category' doc='Configure log message' />
150 <param name='0' doc='Don&apos;t prefix each log message' />
151 <param name='1' doc='Prefix each log message with category/subsystem name' />
152 </params>
153 </command>
Neels Hofmeyra491e422018-03-06 15:13:25 +0100154 <command id='logging print category-hex (0|1)'>
155 <params>
156 <param name='logging' doc='Configure logging' />
157 <param name='print' doc='Log output settings' />
158 <param name='category-hex' doc='Configure log message' />
159 <param name='0' doc='Don&apos;t prefix each log message' />
160 <param name='1' doc='Prefix each log message with category/subsystem nr in hex (&apos;&lt;000b&gt;&apos;)' />
161 </params>
162 </command>
163 <command id='logging print level (0|1)'>
164 <params>
165 <param name='logging' doc='Configure logging' />
166 <param name='print' doc='Log output settings' />
167 <param name='level' doc='Configure log message' />
168 <param name='0' doc='Don&apos;t prefix each log message' />
169 <param name='1' doc='Prefix each log message with the log level name' />
170 </params>
171 </command>
Neels Hofmeyr932eeec2018-11-05 03:07:53 +0100172 <command id='logging print file (0|1|basename) [last]'>
Neels Hofmeyra491e422018-03-06 15:13:25 +0100173 <params>
174 <param name='logging' doc='Configure logging' />
175 <param name='print' doc='Log output settings' />
176 <param name='file' doc='Configure log message' />
177 <param name='0' doc='Don&apos;t prefix each log message' />
178 <param name='1' doc='Prefix each log message with the source file and line' />
179 <param name='basename' doc='Prefix each log message with the source file&apos;s basename (strip leading paths) and line' />
Neels Hofmeyr932eeec2018-11-05 03:07:53 +0100180 <param name='[last]' doc='Log source file info at the end of a log line. If omitted, log source file info just before the log text.' />
Neels Hofmeyra491e422018-03-06 15:13:25 +0100181 </params>
182 </command>
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100183 <command id='logging set-log-mask MASK'>
184 <params>
Neels Hofmeyre010dea2017-12-09 03:26:01 +0100185 <param name='logging' doc='Configure logging' />
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100186 <param name='set-log-mask' doc='Set the logmask of this logging target' />
Neels Hofmeyre010dea2017-12-09 03:26:01 +0100187 <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 +0100188 </params>
189 </command>
Neels Hofmeyr932eeec2018-11-05 03:07:53 +0100190 <command id='logging level (ip|tun|ggsn|sgsn|icmp6|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf) (debug|info|notice|error|fatal)'>
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100191 <params>
Neels Hofmeyre010dea2017-12-09 03:26:01 +0100192 <param name='logging' doc='Configure logging' />
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100193 <param name='level' doc='Set the log level for a specified category' />
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100194 <param name='ip' doc='IP Pool and other groups' />
195 <param name='tun' doc='Tunnel interface' />
196 <param name='ggsn' doc='GGSN' />
197 <param name='sgsn' doc='SGSN Emulator' />
198 <param name='icmp6' doc='ICMPv6' />
199 <param name='lglobal' doc='Library-internal global log family' />
200 <param name='llapd' doc='LAPD in libosmogsm' />
201 <param name='linp' doc='A-bis Intput Subsystem' />
202 <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' />
203 <param name='lmi' doc='A-bis Input Driver for Signalling' />
204 <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' />
205 <param name='lsms' doc='Layer3 Short Message Service (SMS)' />
206 <param name='lctrl' doc='Control Interface' />
207 <param name='lgtp' doc='GPRS GTP library' />
208 <param name='lstats' doc='Statistics messages and logging' />
209 <param name='lgsup' doc='Generic Subscriber Update Protocol' />
210 <param name='loap' doc='Osmocom Authentication Protocol' />
211 <param name='lss7' doc='libosmo-sigtran Signalling System 7' />
212 <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' />
213 <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' />
214 <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' />
215 <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' />
Neels Hofmeyra491e422018-03-06 15:13:25 +0100216 <param name='ljibuf' doc='libosmo-netif Jitter Buffer' />
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100217 <param name='debug' doc='Log debug messages and higher levels' />
218 <param name='info' doc='Log informational messages and higher levels' />
219 <param name='notice' doc='Log noticeable messages and higher levels' />
220 <param name='error' doc='Log error messages and higher levels' />
221 <param name='fatal' doc='Log only fatal messages' />
222 </params>
223 </command>
Neels Hofmeyr932eeec2018-11-05 03:07:53 +0100224 <command id='logging level set-all (debug|info|notice|error|fatal)'>
225 <params>
226 <param name='logging' doc='Configure logging' />
227 <param name='level' doc='Set the log level for a specified category' />
228 <param name='set-all' doc='Once-off set all categories to the given log level. There is no single command to take back these changes -- each category is set to the given level, period.' />
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='logging level force-all (debug|info|notice|error|fatal)'>
237 <params>
238 <param name='logging' doc='Configure logging' />
239 <param name='level' doc='Set the log level for a specified category' />
240 <param name='force-all' doc='Globally force all logging categories to a specific level. This is released by the &apos;no logging level force-all&apos; command. Note: any &apos;logging level &lt;category&gt; &lt;level&gt;&apos; commands will have no visible effect after this, until the forced level is released.' />
241 <param name='debug' doc='Log debug messages and higher levels' />
242 <param name='info' doc='Log informational messages and higher levels' />
243 <param name='notice' doc='Log noticeable messages and higher levels' />
244 <param name='error' doc='Log error messages and higher levels' />
245 <param name='fatal' doc='Log only fatal messages' />
246 </params>
247 </command>
248 <command id='no logging level force-all'>
249 <params>
250 <param name='no' doc='Negate a command or set its defaults' />
251 <param name='logging' doc='Configure logging' />
252 <param name='level' doc='Set the log level for a specified category' />
253 <param name='force-all' doc='Release any globally forced log level set with &apos;logging level force-all &lt;level&gt;&apos;' />
254 </params>
255 </command>
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100256 <command id='show logging vty'>
257 <params>
258 <param name='show' doc='Show running system information' />
259 <param name='logging' doc='Show current logging configuration' />
260 <param name='vty' doc='Show current logging configuration for this vty' />
261 </params>
262 </command>
263 <command id='show alarms'>
264 <params>
265 <param name='show' doc='Show running system information' />
266 <param name='alarms' doc='Show current logging configuration' />
267 </params>
268 </command>
Neels Hofmeyra491e422018-03-06 15:13:25 +0100269 <command id='show talloc-context (application|all) (full|brief|DEPTH)'>
270 <params>
271 <param name='show' doc='Show running system information' />
272 <param name='talloc-context' doc='Show talloc memory hierarchy' />
273 <param name='application' doc='Application&apos;s context' />
274 <param name='all' doc='All contexts, if NULL-context tracking is enabled' />
275 <param name='full' doc='Display a full talloc memory hierarchy' />
276 <param name='brief' doc='Display a brief talloc memory hierarchy' />
277 <param name='DEPTH' doc='Specify required maximal depth value' />
278 </params>
279 </command>
280 <command id='show talloc-context (application|all) (full|brief|DEPTH) tree ADDRESS'>
281 <params>
282 <param name='show' doc='Show running system information' />
283 <param name='talloc-context' doc='Show talloc memory hierarchy' />
284 <param name='application' doc='Application&apos;s context' />
285 <param name='all' doc='All contexts, if NULL-context tracking is enabled' />
286 <param name='full' doc='Display a full talloc memory hierarchy' />
287 <param name='brief' doc='Display a brief talloc memory hierarchy' />
288 <param name='DEPTH' doc='Specify required maximal depth value' />
289 <param name='tree' doc='Display only a specific memory chunk' />
290 <param name='ADDRESS' doc='Chunk address (e.g. 0xdeadbeef)' />
291 </params>
292 </command>
293 <command id='show talloc-context (application|all) (full|brief|DEPTH) filter REGEXP'>
294 <params>
295 <param name='show' doc='Show running system information' />
296 <param name='talloc-context' doc='Show talloc memory hierarchy' />
297 <param name='application' doc='Application&apos;s context' />
298 <param name='all' doc='All contexts, if NULL-context tracking is enabled' />
299 <param name='full' doc='Display a full talloc memory hierarchy' />
300 <param name='brief' doc='Display a brief talloc memory hierarchy' />
301 <param name='DEPTH' doc='Specify required maximal depth value' />
302 <param name='filter' doc='Filter chunks using regular expression' />
303 <param name='REGEXP' doc='Regular expression' />
304 </params>
305 </command>
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100306 <command id='show stats'>
307 <params>
308 <param name='show' doc='Show running system information' />
309 <param name='stats' doc='Show statistical values' />
310 </params>
311 </command>
312 <command id='show stats level (global|peer|subscriber)'>
313 <params>
314 <param name='show' doc='Show running system information' />
315 <param name='stats' doc='Show statistical values' />
316 <param name='level' doc='Set the maximum group level' />
317 <param name='global' doc='Show global groups only' />
318 <param name='peer' doc='Show global and network peer related groups' />
319 <param name='subscriber' doc='Show global, peer, and subscriber groups' />
320 </params>
321 </command>
322 <command id='show asciidoc counters'>
323 <params>
324 <param name='show' doc='Show running system information' />
325 <param name='asciidoc' doc='Asciidoc generation' />
326 <param name='counters' doc='Generate table of all registered counters' />
327 </params>
328 </command>
Neels Hofmeyr932eeec2018-11-05 03:07:53 +0100329 <command id='show rate-counters'>
330 <params>
331 <param name='show' doc='Show running system information' />
332 <param name='rate-counters' doc='Show all rate counters' />
333 </params>
334 </command>
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100335 <command id='show pdp-context ggsn NAME [apn APN]'>
336 <params>
337 <param name='show' doc='Show running system information' />
338 <param name='pdp-context' doc='Show PDP Context Information' />
339 <param name='ggsn' doc='Gateway GPRS Support NODE (GGSN)' />
340 <param name='NAME' doc='GGSN Name' />
341 <param name='[apn' doc='(null)' />
342 <param name='APN]' doc='(null)' />
343 </params>
344 </command>
345 <command id='show pdp-context imsi IMSI [&lt;0-15&gt;]'>
346 <params>
347 <param name='show' doc='Show running system information' />
348 <param name='pdp-context' doc='Display information on PDP Context' />
349 <param name='imsi' doc='PDP contexts for given IMSI' />
350 <param name='IMSI' doc='PDP context for given NSAPI' />
351 <param name='[&lt;0-15&gt;]' doc='(null)' />
352 </params>
353 </command>
354 <command id='show ggsn [NAME]'>
355 <params>
356 <param name='show' doc='Show running system information' />
357 <param name='ggsn' doc='Display information on the GGSN' />
358 <param name='[NAME]' doc='(null)' />
359 </params>
360 </command>
361 </node>
Neels Hofmeyre010dea2017-12-09 03:26:01 +0100362 <node id='enable'>
363 <name>enable</name>
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100364 <command id='disable'>
365 <params>
366 <param name='disable' doc='Turn off privileged mode command' />
367 </params>
368 </command>
369 <command id='configure terminal'>
370 <params>
371 <param name='configure' doc='Configuration from vty interface' />
372 <param name='terminal' doc='Configuration terminal' />
373 </params>
374 </command>
375 <command id='copy running-config startup-config'>
376 <params>
377 <param name='copy' doc='Copy configuration' />
378 <param name='running-config' doc='Copy running config to... ' />
379 <param name='startup-config' doc='Copy running config to startup config (same as write file)' />
380 </params>
381 </command>
382 <command id='show startup-config'>
383 <params>
384 <param name='show' doc='Show running system information' />
385 <param name='startup-config' doc='Contentes of startup configuration' />
386 </params>
387 </command>
388 <command id='show version'>
389 <params>
390 <param name='show' doc='Show running system information' />
391 <param name='version' doc='Displays program version' />
392 </params>
393 </command>
394 <command id='show online-help'>
395 <params>
396 <param name='show' doc='Show running system information' />
397 <param name='online-help' doc='Online help' />
398 </params>
399 </command>
400 <command id='terminal length &lt;0-512&gt;'>
401 <params>
402 <param name='terminal' doc='Set terminal line parameters' />
403 <param name='length' doc='Set number of lines on a screen' />
404 <param name='&lt;0-512&gt;' doc='Number of lines on screen (0 for no pausing)' />
405 </params>
406 </command>
407 <command id='terminal no length'>
408 <params>
409 <param name='terminal' doc='Set terminal line parameters' />
410 <param name='no' doc='Negate a command or set its defaults' />
411 <param name='length' doc='Set number of lines on a screen' />
412 </params>
413 </command>
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100414 <command id='who'>
415 <params>
416 <param name='who' doc='Display who is on vty' />
417 </params>
418 </command>
419 <command id='show history'>
420 <params>
421 <param name='show' doc='Show running system information' />
422 <param name='history' doc='Display the session command history' />
423 </params>
424 </command>
425 <command id='terminal monitor'>
426 <params>
427 <param name='terminal' doc='Set terminal line parameters' />
428 <param name='monitor' doc='Copy debug output to the current terminal line' />
429 </params>
430 </command>
431 <command id='terminal no monitor'>
432 <params>
433 <param name='terminal' doc='Set terminal line parameters' />
434 <param name='no' doc='Negate a command or set its defaults' />
435 <param name='monitor' doc='Copy debug output to the current terminal line' />
436 </params>
437 </command>
438 <command id='logging enable'>
439 <params>
Neels Hofmeyre010dea2017-12-09 03:26:01 +0100440 <param name='logging' doc='Configure logging' />
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100441 <param name='enable' doc='Enables logging to this vty' />
442 </params>
443 </command>
444 <command id='logging disable'>
445 <params>
Neels Hofmeyre010dea2017-12-09 03:26:01 +0100446 <param name='logging' doc='Configure logging' />
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100447 <param name='disable' doc='Disables logging to this vty' />
448 </params>
449 </command>
450 <command id='logging filter all (0|1)'>
451 <params>
Neels Hofmeyre010dea2017-12-09 03:26:01 +0100452 <param name='logging' doc='Configure logging' />
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100453 <param name='filter' doc='Filter log messages' />
454 <param name='all' doc='Do you want to log all messages?' />
455 <param name='0' doc='Only print messages matched by other filters' />
456 <param name='1' doc='Bypass filter and print all messages' />
457 </params>
458 </command>
459 <command id='logging color (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='color' doc='Configure color-printing for log messages' />
463 <param name='0' doc='Don&apos;t use color for printing messages' />
464 <param name='1' doc='Use color for printing messages' />
465 </params>
466 </command>
467 <command id='logging timestamp (0|1)'>
468 <params>
Neels Hofmeyre010dea2017-12-09 03:26:01 +0100469 <param name='logging' doc='Configure logging' />
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100470 <param name='timestamp' doc='Configure log message timestamping' />
471 <param name='0' doc='Don&apos;t prefix each log message' />
472 <param name='1' doc='Prefix each log message with current timestamp' />
473 </params>
474 </command>
475 <command id='logging print extended-timestamp (0|1)'>
476 <params>
Neels Hofmeyre010dea2017-12-09 03:26:01 +0100477 <param name='logging' doc='Configure logging' />
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100478 <param name='print' doc='Log output settings' />
479 <param name='extended-timestamp' doc='Configure log message timestamping' />
480 <param name='0' doc='Don&apos;t prefix each log message' />
481 <param name='1' doc='Prefix each log message with current timestamp with YYYYMMDDhhmmssnnn' />
482 </params>
483 </command>
484 <command id='logging print category (0|1)'>
485 <params>
Neels Hofmeyre010dea2017-12-09 03:26:01 +0100486 <param name='logging' doc='Configure logging' />
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100487 <param name='print' doc='Log output settings' />
488 <param name='category' doc='Configure log message' />
489 <param name='0' doc='Don&apos;t prefix each log message' />
490 <param name='1' doc='Prefix each log message with category/subsystem name' />
491 </params>
492 </command>
Neels Hofmeyra491e422018-03-06 15:13:25 +0100493 <command id='logging print category-hex (0|1)'>
494 <params>
495 <param name='logging' doc='Configure logging' />
496 <param name='print' doc='Log output settings' />
497 <param name='category-hex' doc='Configure log message' />
498 <param name='0' doc='Don&apos;t prefix each log message' />
499 <param name='1' doc='Prefix each log message with category/subsystem nr in hex (&apos;&lt;000b&gt;&apos;)' />
500 </params>
501 </command>
502 <command id='logging print level (0|1)'>
503 <params>
504 <param name='logging' doc='Configure logging' />
505 <param name='print' doc='Log output settings' />
506 <param name='level' doc='Configure log message' />
507 <param name='0' doc='Don&apos;t prefix each log message' />
508 <param name='1' doc='Prefix each log message with the log level name' />
509 </params>
510 </command>
Neels Hofmeyr932eeec2018-11-05 03:07:53 +0100511 <command id='logging print file (0|1|basename) [last]'>
Neels Hofmeyra491e422018-03-06 15:13:25 +0100512 <params>
513 <param name='logging' doc='Configure logging' />
514 <param name='print' doc='Log output settings' />
515 <param name='file' doc='Configure log message' />
516 <param name='0' doc='Don&apos;t prefix each log message' />
517 <param name='1' doc='Prefix each log message with the source file and line' />
518 <param name='basename' doc='Prefix each log message with the source file&apos;s basename (strip leading paths) and line' />
Neels Hofmeyr932eeec2018-11-05 03:07:53 +0100519 <param name='[last]' doc='Log source file info at the end of a log line. If omitted, log source file info just before the log text.' />
Neels Hofmeyra491e422018-03-06 15:13:25 +0100520 </params>
521 </command>
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100522 <command id='logging set-log-mask MASK'>
523 <params>
Neels Hofmeyre010dea2017-12-09 03:26:01 +0100524 <param name='logging' doc='Configure logging' />
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100525 <param name='set-log-mask' doc='Set the logmask of this logging target' />
Neels Hofmeyre010dea2017-12-09 03:26:01 +0100526 <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 +0100527 </params>
528 </command>
Neels Hofmeyr932eeec2018-11-05 03:07:53 +0100529 <command id='logging level (ip|tun|ggsn|sgsn|icmp6|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf) (debug|info|notice|error|fatal)'>
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100530 <params>
Neels Hofmeyre010dea2017-12-09 03:26:01 +0100531 <param name='logging' doc='Configure logging' />
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100532 <param name='level' doc='Set the log level for a specified category' />
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100533 <param name='ip' doc='IP Pool and other groups' />
534 <param name='tun' doc='Tunnel interface' />
535 <param name='ggsn' doc='GGSN' />
536 <param name='sgsn' doc='SGSN Emulator' />
537 <param name='icmp6' doc='ICMPv6' />
538 <param name='lglobal' doc='Library-internal global log family' />
539 <param name='llapd' doc='LAPD in libosmogsm' />
540 <param name='linp' doc='A-bis Intput Subsystem' />
541 <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' />
542 <param name='lmi' doc='A-bis Input Driver for Signalling' />
543 <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' />
544 <param name='lsms' doc='Layer3 Short Message Service (SMS)' />
545 <param name='lctrl' doc='Control Interface' />
546 <param name='lgtp' doc='GPRS GTP library' />
547 <param name='lstats' doc='Statistics messages and logging' />
548 <param name='lgsup' doc='Generic Subscriber Update Protocol' />
549 <param name='loap' doc='Osmocom Authentication Protocol' />
550 <param name='lss7' doc='libosmo-sigtran Signalling System 7' />
551 <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' />
552 <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' />
553 <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' />
554 <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' />
Neels Hofmeyra491e422018-03-06 15:13:25 +0100555 <param name='ljibuf' doc='libosmo-netif Jitter Buffer' />
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100556 <param name='debug' doc='Log debug messages and higher levels' />
557 <param name='info' doc='Log informational messages and higher levels' />
558 <param name='notice' doc='Log noticeable messages and higher levels' />
559 <param name='error' doc='Log error messages and higher levels' />
560 <param name='fatal' doc='Log only fatal messages' />
561 </params>
562 </command>
Neels Hofmeyr932eeec2018-11-05 03:07:53 +0100563 <command id='logging level set-all (debug|info|notice|error|fatal)'>
564 <params>
565 <param name='logging' doc='Configure logging' />
566 <param name='level' doc='Set the log level for a specified category' />
567 <param name='set-all' doc='Once-off set all categories to the given log level. There is no single command to take back these changes -- each category is set to the given level, period.' />
568 <param name='debug' doc='Log debug messages and higher levels' />
569 <param name='info' doc='Log informational messages and higher levels' />
570 <param name='notice' doc='Log noticeable messages and higher levels' />
571 <param name='error' doc='Log error messages and higher levels' />
572 <param name='fatal' doc='Log only fatal messages' />
573 </params>
574 </command>
575 <command id='logging level force-all (debug|info|notice|error|fatal)'>
576 <params>
577 <param name='logging' doc='Configure logging' />
578 <param name='level' doc='Set the log level for a specified category' />
579 <param name='force-all' doc='Globally force all logging categories to a specific level. This is released by the &apos;no logging level force-all&apos; command. Note: any &apos;logging level &lt;category&gt; &lt;level&gt;&apos; commands will have no visible effect after this, until the forced level is released.' />
580 <param name='debug' doc='Log debug messages and higher levels' />
581 <param name='info' doc='Log informational messages and higher levels' />
582 <param name='notice' doc='Log noticeable messages and higher levels' />
583 <param name='error' doc='Log error messages and higher levels' />
584 <param name='fatal' doc='Log only fatal messages' />
585 </params>
586 </command>
587 <command id='no logging level force-all'>
588 <params>
589 <param name='no' doc='Negate a command or set its defaults' />
590 <param name='logging' doc='Configure logging' />
591 <param name='level' doc='Set the log level for a specified category' />
592 <param name='force-all' doc='Release any globally forced log level set with &apos;logging level force-all &lt;level&gt;&apos;' />
593 </params>
594 </command>
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100595 <command id='show logging vty'>
596 <params>
597 <param name='show' doc='Show running system information' />
598 <param name='logging' doc='Show current logging configuration' />
599 <param name='vty' doc='Show current logging configuration for this vty' />
600 </params>
601 </command>
602 <command id='show alarms'>
603 <params>
604 <param name='show' doc='Show running system information' />
605 <param name='alarms' doc='Show current logging configuration' />
606 </params>
607 </command>
Neels Hofmeyra491e422018-03-06 15:13:25 +0100608 <command id='show talloc-context (application|all) (full|brief|DEPTH)'>
609 <params>
610 <param name='show' doc='Show running system information' />
611 <param name='talloc-context' doc='Show talloc memory hierarchy' />
612 <param name='application' doc='Application&apos;s context' />
613 <param name='all' doc='All contexts, if NULL-context tracking is enabled' />
614 <param name='full' doc='Display a full talloc memory hierarchy' />
615 <param name='brief' doc='Display a brief talloc memory hierarchy' />
616 <param name='DEPTH' doc='Specify required maximal depth value' />
617 </params>
618 </command>
619 <command id='show talloc-context (application|all) (full|brief|DEPTH) tree ADDRESS'>
620 <params>
621 <param name='show' doc='Show running system information' />
622 <param name='talloc-context' doc='Show talloc memory hierarchy' />
623 <param name='application' doc='Application&apos;s context' />
624 <param name='all' doc='All contexts, if NULL-context tracking is enabled' />
625 <param name='full' doc='Display a full talloc memory hierarchy' />
626 <param name='brief' doc='Display a brief talloc memory hierarchy' />
627 <param name='DEPTH' doc='Specify required maximal depth value' />
628 <param name='tree' doc='Display only a specific memory chunk' />
629 <param name='ADDRESS' doc='Chunk address (e.g. 0xdeadbeef)' />
630 </params>
631 </command>
632 <command id='show talloc-context (application|all) (full|brief|DEPTH) filter REGEXP'>
633 <params>
634 <param name='show' doc='Show running system information' />
635 <param name='talloc-context' doc='Show talloc memory hierarchy' />
636 <param name='application' doc='Application&apos;s context' />
637 <param name='all' doc='All contexts, if NULL-context tracking is enabled' />
638 <param name='full' doc='Display a full talloc memory hierarchy' />
639 <param name='brief' doc='Display a brief talloc memory hierarchy' />
640 <param name='DEPTH' doc='Specify required maximal depth value' />
641 <param name='filter' doc='Filter chunks using regular expression' />
642 <param name='REGEXP' doc='Regular expression' />
643 </params>
644 </command>
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100645 <command id='show stats'>
646 <params>
647 <param name='show' doc='Show running system information' />
648 <param name='stats' doc='Show statistical values' />
649 </params>
650 </command>
651 <command id='show stats level (global|peer|subscriber)'>
652 <params>
653 <param name='show' doc='Show running system information' />
654 <param name='stats' doc='Show statistical values' />
655 <param name='level' doc='Set the maximum group level' />
656 <param name='global' doc='Show global groups only' />
657 <param name='peer' doc='Show global and network peer related groups' />
658 <param name='subscriber' doc='Show global, peer, and subscriber groups' />
659 </params>
660 </command>
661 <command id='show asciidoc counters'>
662 <params>
663 <param name='show' doc='Show running system information' />
664 <param name='asciidoc' doc='Asciidoc generation' />
665 <param name='counters' doc='Generate table of all registered counters' />
666 </params>
667 </command>
Neels Hofmeyr932eeec2018-11-05 03:07:53 +0100668 <command id='show rate-counters'>
669 <params>
670 <param name='show' doc='Show running system information' />
671 <param name='rate-counters' doc='Show all rate counters' />
672 </params>
673 </command>
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100674 <command id='show pdp-context ggsn NAME [apn APN]'>
675 <params>
676 <param name='show' doc='Show running system information' />
677 <param name='pdp-context' doc='Show PDP Context Information' />
678 <param name='ggsn' doc='Gateway GPRS Support NODE (GGSN)' />
679 <param name='NAME' doc='GGSN Name' />
680 <param name='[apn' doc='(null)' />
681 <param name='APN]' doc='(null)' />
682 </params>
683 </command>
684 <command id='show pdp-context imsi IMSI [&lt;0-15&gt;]'>
685 <params>
686 <param name='show' doc='Show running system information' />
687 <param name='pdp-context' doc='Display information on PDP Context' />
688 <param name='imsi' doc='PDP contexts for given IMSI' />
689 <param name='IMSI' doc='PDP context for given NSAPI' />
690 <param name='[&lt;0-15&gt;]' doc='(null)' />
691 </params>
692 </command>
693 <command id='show ggsn [NAME]'>
694 <params>
695 <param name='show' doc='Show running system information' />
696 <param name='ggsn' doc='Display information on the GGSN' />
697 <param name='[NAME]' doc='(null)' />
698 </params>
699 </command>
700 </node>
Neels Hofmeyre010dea2017-12-09 03:26:01 +0100701 <node id='config'>
702 <name>config</name>
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100703 <command id='hostname WORD'>
704 <params>
705 <param name='hostname' doc='Set system&apos;s network name' />
706 <param name='WORD' doc='This system&apos;s network name' />
707 </params>
708 </command>
709 <command id='no hostname [HOSTNAME]'>
710 <params>
711 <param name='no' doc='Negate a command or set its defaults' />
712 <param name='hostname' doc='Reset system&apos;s network name' />
713 <param name='[HOSTNAME]' doc='Host name of this router' />
714 </params>
715 </command>
716 <command id='password (8|) WORD'>
717 <params>
718 <param name='password' doc='Assign the terminal connection password' />
719 <param name='8' doc='Specifies a HIDDEN password will follow' />
720 <param name='' doc='dummy string ' />
721 <param name='WORD' doc='The HIDDEN line password string' />
722 </params>
723 </command>
724 <command id='password LINE'>
725 <params>
726 <param name='password' doc='Assign the terminal connection password' />
727 <param name='LINE' doc='The UNENCRYPTED (cleartext) line password' />
728 </params>
729 </command>
730 <command id='enable password (8|) WORD'>
731 <params>
732 <param name='enable' doc='Modify enable password parameters' />
733 <param name='password' doc='Assign the privileged level password' />
734 <param name='8' doc='Specifies a HIDDEN password will follow' />
735 <param name='' doc='dummy string ' />
736 <param name='WORD' doc='The HIDDEN &apos;enable&apos; password string' />
737 </params>
738 </command>
739 <command id='enable password LINE'>
740 <params>
741 <param name='enable' doc='Modify enable password parameters' />
742 <param name='password' doc='Assign the privileged level password' />
743 <param name='LINE' doc='The UNENCRYPTED (cleartext) &apos;enable&apos; password' />
744 </params>
745 </command>
746 <command id='no enable password'>
747 <params>
748 <param name='no' doc='Negate a command or set its defaults' />
749 <param name='enable' doc='Modify enable password parameters' />
750 <param name='password' doc='Assign the privileged level password' />
751 </params>
752 </command>
753 <command id='banner motd default'>
754 <params>
755 <param name='banner' doc='Set banner string' />
756 <param name='motd' doc='Strings for motd' />
757 <param name='default' doc='Default string' />
758 </params>
759 </command>
760 <command id='banner motd file [FILE]'>
761 <params>
762 <param name='banner' doc='Set banner' />
763 <param name='motd' doc='Banner for motd' />
764 <param name='file' doc='Banner from a file' />
765 <param name='[FILE]' doc='Filename' />
766 </params>
767 </command>
768 <command id='no banner motd'>
769 <params>
770 <param name='no' doc='Negate a command or set its defaults' />
771 <param name='banner' doc='Set banner string' />
772 <param name='motd' doc='Strings for motd' />
773 </params>
774 </command>
775 <command id='service terminal-length &lt;0-512&gt;'>
776 <params>
777 <param name='service' doc='Set up miscellaneous service' />
778 <param name='terminal-length' doc='System wide terminal length configuration' />
779 <param name='&lt;0-512&gt;' doc='Number of lines of VTY (0 means no line control)' />
780 </params>
781 </command>
782 <command id='no service terminal-length [&lt;0-512&gt;]'>
783 <params>
784 <param name='no' doc='Negate a command or set its defaults' />
785 <param name='service' doc='Set up miscellaneous service' />
786 <param name='terminal-length' doc='System wide terminal length configuration' />
787 <param name='[&lt;0-512&gt;]' doc='Number of lines of VTY (0 means no line control)' />
788 </params>
789 </command>
790 <command id='line vty'>
791 <params>
792 <param name='line' doc='Configure a terminal line' />
793 <param name='vty' doc='Virtual terminal' />
794 </params>
795 </command>
796 <command id='service advanced-vty'>
797 <params>
798 <param name='service' doc='Set up miscellaneous service' />
799 <param name='advanced-vty' doc='Enable advanced mode vty interface' />
800 </params>
801 </command>
802 <command id='no service advanced-vty'>
803 <params>
804 <param name='no' doc='Negate a command or set its defaults' />
805 <param name='service' doc='Set up miscellaneous service' />
806 <param name='advanced-vty' doc='Enable advanced mode vty interface' />
807 </params>
808 </command>
809 <command id='show history'>
810 <params>
811 <param name='show' doc='Show running system information' />
812 <param name='history' doc='Display the session command history' />
813 </params>
814 </command>
815 <command id='log stderr'>
816 <params>
817 <param name='log' doc='Configure logging sub-system' />
818 <param name='stderr' doc='Logging via STDERR of the process' />
819 </params>
820 </command>
821 <command id='no log stderr'>
822 <params>
823 <param name='no' doc='Negate a command or set its defaults' />
Neels Hofmeyr932eeec2018-11-05 03:07:53 +0100824 <param name='log' doc='Configure logging sub-system' /> <param name='stderr' doc='Logging via STDERR of the process' />
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100825 </params>
826 </command>
827 <command id='log file .FILENAME'>
828 <params>
829 <param name='log' doc='Configure logging sub-system' />
830 <param name='file' doc='Logging to text file' />
831 <param name='.FILENAME' doc='Filename' />
832 </params>
833 </command>
834 <command id='no log file .FILENAME'>
835 <params>
836 <param name='no' doc='Negate a command or set its defaults' />
837 <param name='log' doc='Configure logging sub-system' />
838 <param name='file' doc='Logging to text file' />
839 <param name='.FILENAME' doc='Filename' />
840 </params>
841 </command>
842 <command id='log alarms &lt;2-32700&gt;'>
843 <params>
844 <param name='log' doc='Configure logging sub-system' />
845 <param name='alarms' doc='Logging alarms to osmo_strrb' />
846 <param name='&lt;2-32700&gt;' doc='Maximum number of messages to log' />
847 </params>
848 </command>
849 <command id='no log alarms'>
850 <params>
851 <param name='no' doc='Negate a command or set its defaults' />
852 <param name='log' doc='Configure logging sub-system' />
853 <param name='alarms' doc='Logging alarms to osmo_strrb' />
854 </params>
855 </command>
856 <command id='log syslog (authpriv|cron|daemon|ftp|lpr|mail|news|user|uucp)'>
857 <params>
858 <param name='log' doc='Configure logging sub-system' />
859 <param name='syslog' doc='Logging via syslog' />
860 <param name='authpriv' doc='Security/authorization messages facility' />
861 <param name='cron' doc='Clock daemon (cron/at) facility' />
862 <param name='daemon' doc='General system daemon facility' />
863 <param name='ftp' doc='Ftp daemon facility' />
864 <param name='lpr' doc='Line printer facility' />
865 <param name='mail' doc='Mail facility' />
866 <param name='news' doc='News facility' />
867 <param name='user' doc='Generic facility' />
868 <param name='uucp' doc='UUCP facility' />
869 </params>
870 </command>
871 <command id='log syslog local &lt;0-7&gt;'>
872 <params>
873 <param name='log' doc='Configure logging sub-system' />
874 <param name='syslog' doc='Logging via syslog' />
875 <param name='local' doc='Syslog LOCAL facility' />
876 <param name='&lt;0-7&gt;' doc='Local facility number' />
877 </params>
878 </command>
879 <command id='no log syslog'>
880 <params>
881 <param name='no' doc='Negate a command or set its defaults' />
882 <param name='log' doc='Configure logging sub-system' />
883 <param name='syslog' doc='Logging via syslog' />
884 </params>
885 </command>
886 <command id='log gsmtap [HOSTNAME]'>
887 <params>
888 <param name='log' doc='Configure logging sub-system' />
889 <param name='gsmtap' doc='Logging via GSMTAP' />
890 <param name='[HOSTNAME]' doc='Host name to send the GSMTAP logging to (UDP port 4729)' />
891 </params>
892 </command>
893 <command id='stats reporter statsd'>
894 <params>
895 <param name='stats' doc='Configure stats sub-system' />
896 <param name='reporter' doc='Configure a stats reporter' />
897 <param name='statsd' doc='Report to a STATSD server' />
898 </params>
899 </command>
900 <command id='no stats reporter statsd'>
901 <params>
902 <param name='no' doc='Negate a command or set its defaults' />
903 <param name='stats' doc='Configure stats sub-system' />
904 <param name='reporter' doc='Configure a stats reporter' />
905 <param name='statsd' doc='Report to a STATSD server' />
906 </params>
907 </command>
908 <command id='stats reporter log'>
909 <params>
910 <param name='stats' doc='Configure stats sub-system' />
911 <param name='reporter' doc='Configure a stats reporter' />
912 <param name='log' doc='Report to the logger' />
913 </params>
914 </command>
915 <command id='no stats reporter log'>
916 <params>
917 <param name='no' doc='Negate a command or set its defaults' />
918 <param name='stats' doc='Configure stats sub-system' />
919 <param name='reporter' doc='Configure a stats reporter' />
920 <param name='log' doc='Report to the logger' />
921 </params>
922 </command>
923 <command id='stats interval &lt;1-65535&gt;'>
924 <params>
925 <param name='stats' doc='Configure stats sub-system' />
926 <param name='interval' doc='Set the reporting interval' />
927 <param name='&lt;1-65535&gt;' doc='Interval in seconds' />
928 </params>
929 </command>
930 <command id='ggsn NAME'>
931 <params>
932 <param name='ggsn' doc='Configure the Gateway GPRS Support Node' />
933 <param name='NAME' doc='GGSN Name (has only local significance)' />
934 </params>
935 </command>
936 <command id='no ggsn NAME'>
937 <params>
938 <param name='no' doc='Negate a command or set its defaults' />
939 <param name='ggsn' doc='Remove the named Gateway GPRS Support Node' />
940 <param name='NAME' doc='GGSN Name (has only local significance)' />
941 </params>
942 </command>
943 <command id='ctrl'>
944 <params>
945 <param name='ctrl' doc='Configure the Control Interface' />
946 </params>
947 </command>
948 </node>
Neels Hofmeyre010dea2017-12-09 03:26:01 +0100949 <node id='config-log'>
950 <name>config-log</name>
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100951 <command id='logging filter all (0|1)'>
952 <params>
Neels Hofmeyre010dea2017-12-09 03:26:01 +0100953 <param name='logging' doc='Configure logging' />
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100954 <param name='filter' doc='Filter log messages' />
955 <param name='all' doc='Do you want to log all messages?' />
956 <param name='0' doc='Only print messages matched by other filters' />
957 <param name='1' doc='Bypass filter and print all messages' />
958 </params>
959 </command>
960 <command id='logging color (0|1)'>
961 <params>
Neels Hofmeyre010dea2017-12-09 03:26:01 +0100962 <param name='logging' doc='Configure logging' />
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100963 <param name='color' doc='Configure color-printing for log messages' />
964 <param name='0' doc='Don&apos;t use color for printing messages' />
965 <param name='1' doc='Use color for printing messages' />
966 </params>
967 </command>
968 <command id='logging timestamp (0|1)'>
969 <params>
Neels Hofmeyre010dea2017-12-09 03:26:01 +0100970 <param name='logging' doc='Configure logging' />
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100971 <param name='timestamp' doc='Configure log message timestamping' />
972 <param name='0' doc='Don&apos;t prefix each log message' />
973 <param name='1' doc='Prefix each log message with current timestamp' />
974 </params>
975 </command>
976 <command id='logging print extended-timestamp (0|1)'>
977 <params>
Neels Hofmeyre010dea2017-12-09 03:26:01 +0100978 <param name='logging' doc='Configure logging' />
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100979 <param name='print' doc='Log output settings' />
980 <param name='extended-timestamp' doc='Configure log message timestamping' />
981 <param name='0' doc='Don&apos;t prefix each log message' />
982 <param name='1' doc='Prefix each log message with current timestamp with YYYYMMDDhhmmssnnn' />
983 </params>
984 </command>
985 <command id='logging print category (0|1)'>
986 <params>
Neels Hofmeyre010dea2017-12-09 03:26:01 +0100987 <param name='logging' doc='Configure logging' />
Neels Hofmeyrf4530442017-12-09 03:22:34 +0100988 <param name='print' doc='Log output settings' />
989 <param name='category' doc='Configure log message' />
990 <param name='0' doc='Don&apos;t prefix each log message' />
991 <param name='1' doc='Prefix each log message with category/subsystem name' />
992 </params>
993 </command>
Neels Hofmeyra491e422018-03-06 15:13:25 +0100994 <command id='logging print category-hex (0|1)'>
Neels Hofmeyre010dea2017-12-09 03:26:01 +0100995 <params>
996 <param name='logging' doc='Configure logging' />
Neels Hofmeyra491e422018-03-06 15:13:25 +0100997 <param name='print' doc='Log output settings' />
998 <param name='category-hex' doc='Configure log message' />
999 <param name='0' doc='Don&apos;t prefix each log message' />
1000 <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 +01001001 </params>
1002 </command>
Neels Hofmeyra491e422018-03-06 15:13:25 +01001003 <command id='logging print level (0|1)'>
1004 <params>
1005 <param name='logging' doc='Configure logging' />
1006 <param name='print' doc='Log output settings' />
1007 <param name='level' doc='Configure log message' />
1008 <param name='0' doc='Don&apos;t prefix each log message' />
1009 <param name='1' doc='Prefix each log message with the log level name' />
1010 </params>
1011 </command>
Neels Hofmeyr932eeec2018-11-05 03:07:53 +01001012 <command id='logging print file (0|1|basename) [last]'>
Neels Hofmeyra491e422018-03-06 15:13:25 +01001013 <params>
1014 <param name='logging' doc='Configure logging' />
1015 <param name='print' doc='Log output settings' />
1016 <param name='file' doc='Configure log message' />
1017 <param name='0' doc='Don&apos;t prefix each log message' />
1018 <param name='1' doc='Prefix each log message with the source file and line' />
1019 <param name='basename' doc='Prefix each log message with the source file&apos;s basename (strip leading paths) and line' />
Neels Hofmeyr932eeec2018-11-05 03:07:53 +01001020 <param name='[last]' doc='Log source file info at the end of a log line. If omitted, log source file info just before the log text.' />
Neels Hofmeyra491e422018-03-06 15:13:25 +01001021 </params>
1022 </command>
Neels Hofmeyr932eeec2018-11-05 03:07:53 +01001023 <command id='logging level (ip|tun|ggsn|sgsn|icmp6|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf) (debug|info|notice|error|fatal)'>
Neels Hofmeyrf4530442017-12-09 03:22:34 +01001024 <params>
Neels Hofmeyre010dea2017-12-09 03:26:01 +01001025 <param name='logging' doc='Configure logging' />
Neels Hofmeyrf4530442017-12-09 03:22:34 +01001026 <param name='level' doc='Set the log level for a specified category' />
Neels Hofmeyrf4530442017-12-09 03:22:34 +01001027 <param name='ip' doc='IP Pool and other groups' />
1028 <param name='tun' doc='Tunnel interface' />
1029 <param name='ggsn' doc='GGSN' />
1030 <param name='sgsn' doc='SGSN Emulator' />
1031 <param name='icmp6' doc='ICMPv6' />
1032 <param name='lglobal' doc='Library-internal global log family' />
1033 <param name='llapd' doc='LAPD in libosmogsm' />
1034 <param name='linp' doc='A-bis Intput Subsystem' />
1035 <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' />
1036 <param name='lmi' doc='A-bis Input Driver for Signalling' />
1037 <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' />
1038 <param name='lsms' doc='Layer3 Short Message Service (SMS)' />
1039 <param name='lctrl' doc='Control Interface' />
1040 <param name='lgtp' doc='GPRS GTP library' />
1041 <param name='lstats' doc='Statistics messages and logging' />
1042 <param name='lgsup' doc='Generic Subscriber Update Protocol' />
1043 <param name='loap' doc='Osmocom Authentication Protocol' />
1044 <param name='lss7' doc='libosmo-sigtran Signalling System 7' />
1045 <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' />
1046 <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' />
1047 <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' />
1048 <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' />
Neels Hofmeyra491e422018-03-06 15:13:25 +01001049 <param name='ljibuf' doc='libosmo-netif Jitter Buffer' />
Neels Hofmeyrf4530442017-12-09 03:22:34 +01001050 <param name='debug' doc='Log debug messages and higher levels' />
1051 <param name='info' doc='Log informational messages and higher levels' />
1052 <param name='notice' doc='Log noticeable messages and higher levels' />
1053 <param name='error' doc='Log error messages and higher levels' />
1054 <param name='fatal' doc='Log only fatal messages' />
1055 </params>
1056 </command>
Neels Hofmeyr932eeec2018-11-05 03:07:53 +01001057 <command id='logging level set-all (debug|info|notice|error|fatal)'>
1058 <params>
1059 <param name='logging' doc='Configure logging' />
1060 <param name='level' doc='Set the log level for a specified category' />
1061 <param name='set-all' doc='Once-off set all categories to the given log level. There is no single command to take back these changes -- each category is set to the given level, period.' />
1062 <param name='debug' doc='Log debug messages and higher levels' />
1063 <param name='info' doc='Log informational messages and higher levels' />
1064 <param name='notice' doc='Log noticeable messages and higher levels' />
1065 <param name='error' doc='Log error messages and higher levels' />
1066 <param name='fatal' doc='Log only fatal messages' />
1067 </params>
1068 </command>
1069 <command id='logging level force-all (debug|info|notice|error|fatal)'>
1070 <params>
1071 <param name='logging' doc='Configure logging' />
1072 <param name='level' doc='Set the log level for a specified category' />
1073 <param name='force-all' doc='Globally force all logging categories to a specific level. This is released by the &apos;no logging level force-all&apos; command. Note: any &apos;logging level &lt;category&gt; &lt;level&gt;&apos; commands will have no visible effect after this, until the forced level is released.' />
1074 <param name='debug' doc='Log debug messages and higher levels' />
1075 <param name='info' doc='Log informational messages and higher levels' />
1076 <param name='notice' doc='Log noticeable messages and higher levels' />
1077 <param name='error' doc='Log error messages and higher levels' />
1078 <param name='fatal' doc='Log only fatal messages' />
1079 </params>
1080 </command>
1081 <command id='no logging level force-all'>
1082 <params>
1083 <param name='no' doc='Negate a command or set its defaults' />
1084 <param name='logging' doc='Configure logging' />
1085 <param name='level' doc='Set the log level for a specified category' />
1086 <param name='force-all' doc='Release any globally forced log level set with &apos;logging level force-all &lt;level&gt;&apos;' />
1087 </params>
1088 </command>
Neels Hofmeyrf4530442017-12-09 03:22:34 +01001089 </node>
Neels Hofmeyre010dea2017-12-09 03:26:01 +01001090 <node id='config-stats'>
1091 <name>config-stats</name>
Neels Hofmeyrf4530442017-12-09 03:22:34 +01001092 <command id='local-ip ADDR'>
1093 <params>
1094 <param name='local-ip' doc='Set the IP address to which we bind locally' />
1095 <param name='ADDR' doc='IP Address' />
1096 </params>
1097 </command>
1098 <command id='no local-ip'>
1099 <params>
1100 <param name='no' doc='Negate a command or set its defaults' />
1101 <param name='local-ip' doc='Set the IP address to which we bind locally' />
1102 </params>
1103 </command>
1104 <command id='remote-ip ADDR'>
1105 <params>
1106 <param name='remote-ip' doc='Set the remote IP address to which we connect' />
1107 <param name='ADDR' doc='IP Address' />
1108 </params>
1109 </command>
1110 <command id='remote-port &lt;1-65535&gt;'>
1111 <params>
1112 <param name='remote-port' doc='Set the remote port to which we connect' />
1113 <param name='&lt;1-65535&gt;' doc='Remote port number' />
1114 </params>
1115 </command>
1116 <command id='mtu &lt;100-65535&gt;'>
1117 <params>
1118 <param name='mtu' doc='Set the maximum packet size' />
1119 <param name='&lt;100-65535&gt;' doc='Size in byte' />
1120 </params>
1121 </command>
1122 <command id='no mtu'>
1123 <params>
1124 <param name='no' doc='Negate a command or set its defaults' />
1125 <param name='mtu' doc='Set the maximum packet size' />
1126 </params>
1127 </command>
1128 <command id='prefix PREFIX'>
1129 <params>
1130 <param name='prefix' doc='Set the item name prefix' />
1131 <param name='PREFIX' doc='The prefix string' />
1132 </params>
1133 </command>
1134 <command id='no prefix'>
1135 <params>
1136 <param name='no' doc='Negate a command or set its defaults' />
1137 <param name='prefix' doc='Set the item name prefix' />
1138 </params>
1139 </command>
1140 <command id='level (global|peer|subscriber)'>
1141 <params>
1142 <param name='level' doc='Set the maximum group level' />
1143 <param name='global' doc='Report global groups only' />
1144 <param name='peer' doc='Report global and network peer related groups' />
1145 <param name='subscriber' doc='Report global, peer, and subscriber groups' />
1146 </params>
1147 </command>
1148 <command id='enable'>
1149 <params>
1150 <param name='enable' doc='Enable the reporter' />
1151 </params>
1152 </command>
1153 <command id='disable'>
1154 <params>
1155 <param name='disable' doc='Disable the reporter' />
1156 </params>
1157 </command>
1158 </node>
Neels Hofmeyre010dea2017-12-09 03:26:01 +01001159 <node id='config-line'>
1160 <name>config-line</name>
Neels Hofmeyrf4530442017-12-09 03:22:34 +01001161 <command id='login'>
1162 <params>
1163 <param name='login' doc='Enable password checking' />
1164 </params>
1165 </command>
1166 <command id='no login'>
1167 <params>
1168 <param name='no' doc='Negate a command or set its defaults' />
1169 <param name='login' doc='Enable password checking' />
1170 </params>
1171 </command>
1172 <command id='bind A.B.C.D'>
1173 <params>
1174 <param name='bind' doc='Accept VTY telnet connections on local interface' />
1175 <param name='A.B.C.D' doc='Local interface IP address (default: 127.0.0.1)' />
1176 </params>
1177 </command>
1178 </node>
Neels Hofmeyre010dea2017-12-09 03:26:01 +01001179 <node id='config-ctrl'>
1180 <name>config-ctrl</name>
Neels Hofmeyrf4530442017-12-09 03:22:34 +01001181 <command id='bind A.B.C.D'>
1182 <params>
1183 <param name='bind' doc='Set bind address to listen for Control connections' />
1184 <param name='A.B.C.D' doc='Local IP address (default 127.0.0.1)' />
1185 </params>
1186 </command>
1187 </node>
Neels Hofmeyre010dea2017-12-09 03:26:01 +01001188 <node id='config-ggsn'>
1189 <name>config-ggsn</name>
Neels Hofmeyrf4530442017-12-09 03:22:34 +01001190 <command id='description .TEXT'>
1191 <params>
1192 <param name='description' doc='Save human-readable description of the object' />
1193 <param name='.TEXT' doc='Text until the end of the line' />
1194 </params>
1195 </command>
1196 <command id='no description'>
1197 <params>
1198 <param name='no' doc='Negate a command or set its defaults' />
1199 <param name='description' doc='Remove description of the object' />
1200 </params>
1201 </command>
1202 <command id='shutdown ggsn'>
1203 <params>
1204 <param name='shutdown' doc='Put the GGSN in administrative shut-down' />
1205 <param name='ggsn' doc='Gateway GPRS Support NODE (GGSN)' />
1206 </params>
1207 </command>
1208 <command id='no shutdown ggsn'>
1209 <params>
1210 <param name='no' doc='Negate a command or set its defaults' />
1211 <param name='shutdown' doc='Gateway GPRS Support NODE (GGSN)' />
1212 <param name='ggsn' doc='Remove the GGSN from administrative shut-down' />
1213 </params>
1214 </command>
1215 <command id='gtp bind-ip A.B.C.D'>
1216 <params>
1217 <param name='gtp' doc='GTP Parameters' />
1218 <param name='bind-ip' doc='Set the IP address for the local GTP bind' />
1219 <param name='A.B.C.D' doc='IPv4 Address' />
1220 </params>
1221 </command>
1222 <command id='gtp control-ip A.B.C.D'>
1223 <params>
1224 <param name='gtp' doc='GTP Parameters' />
1225 <param name='control-ip' doc='Set the IP address states as local IP in GTP-C messages' />
1226 <param name='A.B.C.D' doc='IPv4 Address' />
1227 </params>
1228 </command>
1229 <command id='gtp user-ip A.B.C.D'>
1230 <params>
1231 <param name='gtp' doc='GTP Parameters' />
1232 <param name='user-ip' doc='Set the IP address states as local IP in GTP-U messages' />
1233 <param name='A.B.C.D' doc='IPv4 Address' />
1234 </params>
1235 </command>
1236 <command id='gtp state-dir PATH'>
1237 <params>
1238 <param name='gtp' doc='GTP Parameters' />
1239 <param name='state-dir' doc='Set the directory for the GTP State file' />
1240 <param name='PATH' doc='Local Directory' />
1241 </params>
1242 </command>
1243 <command id='apn NAME'>
1244 <params>
1245 <param name='apn' doc='APN Configuration' />
1246 <param name='NAME' doc='APN Name' />
1247 </params>
1248 </command>
1249 <command id='no apn NAME'>
1250 <params>
1251 <param name='no' doc='Negate a command or set its defaults' />
1252 <param name='apn' doc='Remove APN Configuration' />
1253 <param name='NAME' doc='APN Name' />
1254 </params>
1255 </command>
1256 <command id='default-apn NAME'>
1257 <params>
1258 <param name='default-apn' doc='Set a default-APN to be used if no other APN matches' />
1259 <param name='NAME' doc='APN Name' />
1260 </params>
1261 </command>
1262 <command id='no default-apn'>
1263 <params>
1264 <param name='no' doc='Negate a command or set its defaults' />
1265 <param name='default-apn' doc='Remove default-APN to be used if no other APN matches' />
1266 </params>
1267 </command>
1268 </node>
Neels Hofmeyre010dea2017-12-09 03:26:01 +01001269 <node id='config-ggsn-apn'>
1270 <name>config-ggsn-apn</name>
Neels Hofmeyrf4530442017-12-09 03:22:34 +01001271 <command id='description .TEXT'>
1272 <params>
1273 <param name='description' doc='Save human-readable description of the object' />
1274 <param name='.TEXT' doc='Text until the end of the line' />
1275 </params>
1276 </command>
1277 <command id='no description'>
1278 <params>
1279 <param name='no' doc='Negate a command or set its defaults' />
1280 <param name='description' doc='Remove description of the object' />
1281 </params>
1282 </command>
1283 <command id='shutdown'>
1284 <params>
1285 <param name='shutdown' doc='Put the APN in administrative shut-down' />
1286 </params>
1287 </command>
1288 <command id='no shutdown'>
1289 <params>
1290 <param name='no' doc='Negate a command or set its defaults' />
1291 <param name='shutdown' doc='Remove the APN from administrative shut-down' />
1292 </params>
1293 </command>
1294 <command id='gtpu-mode (tun|kernel-gtp)'>
1295 <params>
1296 <param name='gtpu-mode' doc='Set the Mode for this APN (tun or Linux Kernel GTP)' />
1297 <param name='tun' doc='GTP-U in userspace using TUN device' />
1298 <param name='kernel-gtp' doc='GTP-U in kernel using Linux Kernel GTP' />
1299 </params>
1300 </command>
1301 <command id='type-support (v4|v6|v4v6)'>
1302 <params>
1303 <param name='type-support' doc='Enable support for PDP Type' />
1304 <param name='v4' doc='IPv4(-only) PDP Type' />
1305 <param name='v6' doc='IPv6(-only) PDP Type' />
1306 <param name='v4v6' doc='IPv4v6 (dual-stack) PDP Type' />
1307 </params>
1308 </command>
1309 <command id='no type-support (v4|v6|v4v6)'>
1310 <params>
1311 <param name='no' doc='Negate a command or set its defaults' />
1312 <param name='type-support' doc='Disable support for PDP Type' />
1313 <param name='v4' doc='IPv4(-only) PDP Type' />
1314 <param name='v6' doc='IPv6(-only) PDP Type' />
1315 <param name='v4v6' doc='IPv4v6 (dual-stack) PDP Type' />
1316 </params>
1317 </command>
1318 <command id='tun-device NAME'>
1319 <params>
1320 <param name='tun-device' doc='Configure tun device name' />
1321 <param name='NAME' doc='TUN device name' />
1322 </params>
1323 </command>
1324 <command id='ipup-script PATH'>
1325 <params>
1326 <param name='ipup-script' doc='Configure name/path of ip-up script' />
1327 <param name='PATH' doc='File/Path name of ip-up script' />
1328 </params>
1329 </command>
1330 <command id='no ipup-script'>
1331 <params>
1332 <param name='no' doc='Negate a command or set its defaults' />
1333 <param name='ipup-script' doc='Disable ip-up script' />
1334 </params>
1335 </command>
1336 <command id='ipdown-script PATH'>
1337 <params>
1338 <param name='ipdown-script' doc='Configure name/path of ip-down script' />
1339 <param name='PATH' doc='File/Path name of ip-down script' />
1340 </params>
1341 </command>
1342 <command id='no ipdown-script'>
1343 <params>
1344 <param name='no' doc='Negate a command or set its defaults' />
1345 <param name='ipdown-script' doc='Disable ip-down script' />
1346 </params>
1347 </command>
1348 <command id='ip prefix (static|dynamic) A.B.C.D/M'>
1349 <params>
1350 <param name='ip' doc='IP information' />
1351 <param name='prefix' doc='Prefix (Network/Netmask)' />
1352 <param name='static' doc='IPv4 Adress/Prefix-Length' />
1353 <param name='dynamic' doc='(null)' />
1354 <param name='A.B.C.D/M' doc='(null)' />
1355 </params>
1356 </command>
1357 <command id='ipv6 prefix (static|dynamic) X:X::X:X/M'>
1358 <params>
1359 <param name='ipv6' doc='IPv6 Information' />
1360 <param name='prefix' doc='Prefix (Network/Netmask)' />
1361 <param name='static' doc='IPv6 Address/Prefix-Length' />
1362 <param name='dynamic' doc='(null)' />
1363 <param name='X:X::X:X/M' doc='(null)' />
1364 </params>
1365 </command>
1366 <command id='ip dns &lt;0-1&gt; A.B.C.D'>
1367 <params>
1368 <param name='ip' doc='IP information' />
1369 <param name='dns' doc='Configure DNS Server' />
1370 <param name='&lt;0-1&gt;' doc='primary/secondary DNS' />
1371 <param name='A.B.C.D' doc='IP address of DNS Sever' />
1372 </params>
1373 </command>
1374 <command id='ipv6 dns &lt;0-1&gt; X:X::X:X'>
1375 <params>
1376 <param name='ipv6' doc='IPv6 Information' />
1377 <param name='dns' doc='Configure DNS Server' />
1378 <param name='&lt;0-1&gt;' doc='primary/secondary DNS' />
1379 <param name='X:X::X:X' doc='IP address of DNS Sever' />
1380 </params>
1381 </command>
1382 <command id='no (ip|ipv6) dns &lt;0-1&gt;'>
1383 <params>
1384 <param name='no' doc='Negate a command or set its defaults' />
1385 <param name='ip' doc='IP information' />
1386 <param name='ipv6' doc='IPv6 Information' />
1387 <param name='dns' doc='Disable DNS Server' />
1388 <param name='&lt;0-1&gt;' doc='primary/secondary DNS' />
1389 </params>
1390 </command>
1391 <command id='ip ifconfig A.B.C.D/M'>
1392 <params>
1393 <param name='ip' doc='IP information' />
1394 <param name='ifconfig' doc='GGSN-based interface configuration' />
1395 <param name='A.B.C.D/M' doc='IPv4 Adress/Prefix-Length' />
1396 </params>
1397 </command>
1398 <command id='no ip ifconfig'>
1399 <params>
1400 <param name='no' doc='Negate a command or set its defaults' />
1401 <param name='ip' doc='IP information' />
1402 <param name='ifconfig' doc='GGSN-based interface configuration' />
1403 </params>
1404 </command>
1405 <command id='ipv6 ifconfig X:X::X:X/M'>
1406 <params>
1407 <param name='ipv6' doc='IPv6 Information' />
1408 <param name='ifconfig' doc='GGSN-based interface configuration' />
1409 <param name='X:X::X:X/M' doc='IPv6 Adress/Prefix-Length' />
1410 </params>
1411 </command>
1412 <command id='no ipv6 ifconfig'>
1413 <params>
1414 <param name='no' doc='Negate a command or set its defaults' />
1415 <param name='ipv6' doc='IPv6 Information' />
1416 <param name='ifconfig' doc='GGSN-based interface configuration' />
1417 </params>
1418 </command>
Neels Hofmeyra491e422018-03-06 15:13:25 +01001419 <command id='ipv6 link-local X:X::X:X/M'>
1420 <params>
1421 <param name='ipv6' doc='IPv6 Information' />
1422 <param name='link-local' doc='GGSN-based interface configuration' />
1423 <param name='X:X::X:X/M' doc='IPv6 Link-local Adress/Prefix-Length' />
1424 </params>
1425 </command>
1426 <command id='no ipv6 link-local'>
1427 <params>
1428 <param name='no' doc='Negate a command or set its defaults' />
1429 <param name='ipv6' doc='IPv6 Information' />
1430 <param name='link-local' doc='GGSN-based interface configuration' />
1431 </params>
1432 </command>
Neels Hofmeyre010dea2017-12-09 03:26:01 +01001433 <command id='g-pdu tx-sequence-numbers'>
1434 <params>
1435 <param name='g-pdu' doc='G-PDU Configuration' />
1436 <param name='tx-sequence-numbers' doc='Enable transmission of G-PDU sequence numbers' />
1437 </params>
1438 </command>
1439 <command id='no g-pdu tx-sequence-numbers'>
1440 <params>
1441 <param name='no' doc='Negate a command or set its defaults' />
1442 <param name='g-pdu' doc='G-PDU Configuration' />
1443 <param name='tx-sequence-numbers' doc='Disable transmission of G-PDU sequence numbers' />
1444 </params>
1445 </command>
Neels Hofmeyrf4530442017-12-09 03:22:34 +01001446 </node>
1447</vtydoc>