Gitiles
Code Review Sign In
gerrit.osmocom.org / osmo-hlr / c41572330d6038172c98b6837df10e87e82e5dec / . / doc / manuals / vty / hlr_vty_reference.xml
blob: cc97dc4fdec5593a720702130fdf6324f16c6093 [file] [log] [blame]
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1<vtydoc xmlns='urn:osmocom:xml:libosmocore:vty:doc:1.0'>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]2 <node id='_common_cmds_'>
3 <name>Common Commands</name>
4 <description>These commands are available on all VTY nodes. They are listed here only once, to unclutter the VTY reference.</description>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]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>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]49 <command id='end'>
50 <params>
51 <param name='end' doc='End current mode and change to enable mode.' />
52 </params>
53 </command>
54 </node>
55 <node id='view'>
56 <name>view</name>
57 <command id='show version'>
58 <params>
59 <param name='show' doc='Show running system information' />
60 <param name='version' doc='Displays program version' />
61 </params>
62 </command>
63 <command id='show online-help'>
64 <params>
65 <param name='show' doc='Show running system information' />
66 <param name='online-help' doc='Online help' />
67 </params>
68 </command>
69 <command id='enable'>
70 <params>
71 <param name='enable' doc='Turn on privileged mode command' />
72 </params>
73 </command>
74 <command id='terminal length &lt;0-512&gt;'>
75 <params>
76 <param name='terminal' doc='Set terminal line parameters' />
77 <param name='length' doc='Set number of lines on a screen' />
78 <param name='&lt;0-512&gt;' doc='Number of lines on screen (0 for no pausing)' />
79 </params>
80 </command>
81 <command id='terminal no length'>
82 <params>
83 <param name='terminal' doc='Set terminal line parameters' />
84 <param name='no' doc='Negate a command or set its defaults' />
85 <param name='length' doc='Set number of lines on a screen' />
86 </params>
87 </command>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]88 <command id='who'>
89 <params>
90 <param name='who' doc='Display who is on vty' />
91 </params>
92 </command>
93 <command id='show history'>
94 <params>
95 <param name='show' doc='Show running system information' />
96 <param name='history' doc='Display the session command history' />
97 </params>
98 </command>
99 <command id='logging enable'>
100 <params>
101 <param name='logging' doc='Configure logging' />
102 <param name='enable' doc='Enables logging to this vty' />
103 </params>
104 </command>
105 <command id='logging disable'>
106 <params>
107 <param name='logging' doc='Configure logging' />
108 <param name='disable' doc='Disables logging to this vty' />
109 </params>
110 </command>
111 <command id='logging filter all (0|1)'>
112 <params>
113 <param name='logging' doc='Configure logging' />
114 <param name='filter' doc='Filter log messages' />
115 <param name='all' doc='Do you want to log all messages?' />
116 <param name='0' doc='Only print messages matched by other filters' />
117 <param name='1' doc='Bypass filter and print all messages' />
118 </params>
119 </command>
120 <command id='logging color (0|1)'>
121 <params>
122 <param name='logging' doc='Configure logging' />
123 <param name='color' doc='Configure color-printing for log messages' />
124 <param name='0' doc='Don&apos;t use color for printing messages' />
125 <param name='1' doc='Use color for printing messages' />
126 </params>
127 </command>
128 <command id='logging timestamp (0|1)'>
129 <params>
130 <param name='logging' doc='Configure logging' />
131 <param name='timestamp' doc='Configure log message timestamping' />
132 <param name='0' doc='Don&apos;t prefix each log message' />
133 <param name='1' doc='Prefix each log message with current timestamp' />
134 </params>
135 </command>
136 <command id='logging print extended-timestamp (0|1)'>
137 <params>
138 <param name='logging' doc='Configure logging' />
139 <param name='print' doc='Log output settings' />
140 <param name='extended-timestamp' doc='Configure log message timestamping' />
141 <param name='0' doc='Don&apos;t prefix each log message' />
142 <param name='1' doc='Prefix each log message with current timestamp with YYYYMMDDhhmmssnnn' />
143 </params>
144 </command>
145 <command id='logging print category (0|1)'>
146 <params>
147 <param name='logging' doc='Configure logging' />
148 <param name='print' doc='Log output settings' />
149 <param name='category' doc='Configure log message' />
150 <param name='0' doc='Don&apos;t prefix each log message' />
151 <param name='1' doc='Prefix each log message with category/subsystem name' />
152 </params>
153 </command>
154 <command id='logging print category-hex (0|1)'>
155 <params>
156 <param name='logging' doc='Configure logging' />
157 <param name='print' doc='Log output settings' />
158 <param name='category-hex' doc='Configure log message' />
159 <param name='0' doc='Don&apos;t prefix each log message' />
160 <param name='1' doc='Prefix each log message with category/subsystem nr in hex (&apos;&lt;000b&gt;&apos;)' />
161 </params>
162 </command>
163 <command id='logging print level (0|1)'>
164 <params>
165 <param name='logging' doc='Configure logging' />
166 <param name='print' doc='Log output settings' />
167 <param name='level' doc='Configure log message' />
168 <param name='0' doc='Don&apos;t prefix each log message' />
169 <param name='1' doc='Prefix each log message with the log level name' />
170 </params>
171 </command>
Neels Hofmeyrbf6b4eb2018-11-05 03:18:46 +0100[diff] [blame]172 <command id='logging print file (0|1|basename) [last]'>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]173 <params>
174 <param name='logging' doc='Configure logging' />
175 <param name='print' doc='Log output settings' />
176 <param name='file' doc='Configure log message' />
177 <param name='0' doc='Don&apos;t prefix each log message' />
178 <param name='1' doc='Prefix each log message with the source file and line' />
179 <param name='basename' doc='Prefix each log message with the source file&apos;s basename (strip leading paths) and line' />
Neels Hofmeyrbf6b4eb2018-11-05 03:18:46 +0100[diff] [blame]180 <param name='[last]' doc='Log source file info at the end of a log line. If omitted, log source file info just before the log text.' />
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]181 </params>
182 </command>
183 <command id='logging set-log-mask MASK'>
184 <params>
185 <param name='logging' doc='Configure logging' />
186 <param name='set-log-mask' doc='Set the logmask of this logging target' />
187 <param name='MASK' doc='List of logging categories to log, e.g. &apos;abc:mno:xyz&apos;. Available log categories depend on the specific application, refer to the &apos;logging level&apos; command. Optionally add individual log levels like &apos;abc,1:mno,3:xyz,5&apos;, where the level numbers are LOGL_DEBUG=1 LOGL_INFO=3 LOGL_NOTICE=5 LOGL_ERROR=7 LOGL_FATAL=8' />
188 </params>
189 </command>
Neels Hofmeyrbf6b4eb2018-11-05 03:18:46 +0100[diff] [blame]190 <command id='logging level (main|db|auc|ss|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf) (debug|info|notice|error|fatal)'>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]191 <params>
192 <param name='logging' doc='Configure logging' />
193 <param name='level' doc='Set the log level for a specified category' />
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]194 <param name='main' doc='Main Program' />
195 <param name='db' doc='Database Layer' />
196 <param name='auc' doc='Authentication Center' />
Neels Hofmeyrbf6b4eb2018-11-05 03:18:46 +0100[diff] [blame]197 <param name='ss' doc='Supplementary Services' />
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]198 <param name='lglobal' doc='Library-internal global log family' />
199 <param name='llapd' doc='LAPD in libosmogsm' />
200 <param name='linp' doc='A-bis Intput Subsystem' />
201 <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' />
202 <param name='lmi' doc='A-bis Input Driver for Signalling' />
203 <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' />
204 <param name='lsms' doc='Layer3 Short Message Service (SMS)' />
205 <param name='lctrl' doc='Control Interface' />
206 <param name='lgtp' doc='GPRS GTP library' />
207 <param name='lstats' doc='Statistics messages and logging' />
208 <param name='lgsup' doc='Generic Subscriber Update Protocol' />
209 <param name='loap' doc='Osmocom Authentication Protocol' />
210 <param name='lss7' doc='libosmo-sigtran Signalling System 7' />
211 <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' />
212 <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' />
213 <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' />
214 <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' />
215 <param name='ljibuf' doc='libosmo-netif Jitter Buffer' />
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]216 <param name='debug' doc='Log debug messages and higher levels' />
217 <param name='info' doc='Log informational messages and higher levels' />
218 <param name='notice' doc='Log noticeable messages and higher levels' />
219 <param name='error' doc='Log error messages and higher levels' />
220 <param name='fatal' doc='Log only fatal messages' />
221 </params>
222 </command>
Neels Hofmeyrbf6b4eb2018-11-05 03:18:46 +0100[diff] [blame]223 <command id='logging level set-all (debug|info|notice|error|fatal)'>
224 <params>
225 <param name='logging' doc='Configure logging' />
226 <param name='level' doc='Set the log level for a specified category' />
227 <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.' />
228 <param name='debug' doc='Log debug messages and higher levels' />
229 <param name='info' doc='Log informational messages and higher levels' />
230 <param name='notice' doc='Log noticeable messages and higher levels' />
231 <param name='error' doc='Log error messages and higher levels' />
232 <param name='fatal' doc='Log only fatal messages' />
233 </params>
234 </command>
235 <command id='logging level force-all (debug|info|notice|error|fatal)'>
236 <params>
237 <param name='logging' doc='Configure logging' />
238 <param name='level' doc='Set the log level for a specified category' />
239 <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.' />
240 <param name='debug' doc='Log debug messages and higher levels' />
241 <param name='info' doc='Log informational messages and higher levels' />
242 <param name='notice' doc='Log noticeable messages and higher levels' />
243 <param name='error' doc='Log error messages and higher levels' />
244 <param name='fatal' doc='Log only fatal messages' />
245 </params>
246 </command>
247 <command id='no logging level force-all'>
248 <params>
249 <param name='no' doc='Negate a command or set its defaults' />
250 <param name='logging' doc='Configure logging' />
251 <param name='level' doc='Set the log level for a specified category' />
252 <param name='force-all' doc='Release any globally forced log level set with &apos;logging level force-all &lt;level&gt;&apos;' />
253 </params>
254 </command>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]255 <command id='show logging vty'>
256 <params>
257 <param name='show' doc='Show running system information' />
258 <param name='logging' doc='Show current logging configuration' />
259 <param name='vty' doc='Show current logging configuration for this vty' />
260 </params>
261 </command>
262 <command id='show alarms'>
263 <params>
264 <param name='show' doc='Show running system information' />
265 <param name='alarms' doc='Show current logging configuration' />
266 </params>
267 </command>
268 <command id='show talloc-context (application|all) (full|brief|DEPTH)'>
269 <params>
270 <param name='show' doc='Show running system information' />
271 <param name='talloc-context' doc='Show talloc memory hierarchy' />
272 <param name='application' doc='Application&apos;s context' />
273 <param name='all' doc='All contexts, if NULL-context tracking is enabled' />
274 <param name='full' doc='Display a full talloc memory hierarchy' />
275 <param name='brief' doc='Display a brief talloc memory hierarchy' />
276 <param name='DEPTH' doc='Specify required maximal depth value' />
277 </params>
278 </command>
279 <command id='show talloc-context (application|all) (full|brief|DEPTH) tree ADDRESS'>
280 <params>
281 <param name='show' doc='Show running system information' />
282 <param name='talloc-context' doc='Show talloc memory hierarchy' />
283 <param name='application' doc='Application&apos;s context' />
284 <param name='all' doc='All contexts, if NULL-context tracking is enabled' />
285 <param name='full' doc='Display a full talloc memory hierarchy' />
286 <param name='brief' doc='Display a brief talloc memory hierarchy' />
287 <param name='DEPTH' doc='Specify required maximal depth value' />
288 <param name='tree' doc='Display only a specific memory chunk' />
289 <param name='ADDRESS' doc='Chunk address (e.g. 0xdeadbeef)' />
290 </params>
291 </command>
292 <command id='show talloc-context (application|all) (full|brief|DEPTH) filter REGEXP'>
293 <params>
294 <param name='show' doc='Show running system information' />
295 <param name='talloc-context' doc='Show talloc memory hierarchy' />
296 <param name='application' doc='Application&apos;s context' />
297 <param name='all' doc='All contexts, if NULL-context tracking is enabled' />
298 <param name='full' doc='Display a full talloc memory hierarchy' />
299 <param name='brief' doc='Display a brief talloc memory hierarchy' />
300 <param name='DEPTH' doc='Specify required maximal depth value' />
301 <param name='filter' doc='Filter chunks using regular expression' />
302 <param name='REGEXP' doc='Regular expression' />
303 </params>
304 </command>
Neels Hofmeyrbf6b4eb2018-11-05 03:18:46 +0100[diff] [blame]305 <command id='show gsup-connections'>
306 <params>
307 <param name='show' doc='Show running system information' />
308 <param name='gsup-connections' doc='GSUP Connections from VLRs, SGSNs, EUSEs' />
309 </params>
310 </command>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]311 <command id='subscriber (imsi|msisdn|id) IDENT show'>
312 <params>
313 <param name='subscriber' doc='Subscriber management commands' />
314 <param name='imsi' doc='Identify subscriber by IMSI' />
315 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
316 <param name='id' doc='Identify subscriber by database ID' />
317 <param name='IDENT' doc='IMSI/MSISDN/ID of the subscriber' />
318 <param name='show' doc='Show subscriber information' />
319 </params>
320 </command>
321 </node>
322 <node id='enable'>
323 <name>enable</name>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]324 <command id='disable'>
325 <params>
326 <param name='disable' doc='Turn off privileged mode command' />
327 </params>
328 </command>
329 <command id='configure terminal'>
330 <params>
331 <param name='configure' doc='Configuration from vty interface' />
332 <param name='terminal' doc='Configuration terminal' />
333 </params>
334 </command>
335 <command id='copy running-config startup-config'>
336 <params>
337 <param name='copy' doc='Copy configuration' />
338 <param name='running-config' doc='Copy running config to... ' />
339 <param name='startup-config' doc='Copy running config to startup config (same as write file)' />
340 </params>
341 </command>
342 <command id='show startup-config'>
343 <params>
344 <param name='show' doc='Show running system information' />
345 <param name='startup-config' doc='Contentes of startup configuration' />
346 </params>
347 </command>
348 <command id='show version'>
349 <params>
350 <param name='show' doc='Show running system information' />
351 <param name='version' doc='Displays program version' />
352 </params>
353 </command>
354 <command id='show online-help'>
355 <params>
356 <param name='show' doc='Show running system information' />
357 <param name='online-help' doc='Online help' />
358 </params>
359 </command>
360 <command id='terminal length &lt;0-512&gt;'>
361 <params>
362 <param name='terminal' doc='Set terminal line parameters' />
363 <param name='length' doc='Set number of lines on a screen' />
364 <param name='&lt;0-512&gt;' doc='Number of lines on screen (0 for no pausing)' />
365 </params>
366 </command>
367 <command id='terminal no length'>
368 <params>
369 <param name='terminal' doc='Set terminal line parameters' />
370 <param name='no' doc='Negate a command or set its defaults' />
371 <param name='length' doc='Set number of lines on a screen' />
372 </params>
373 </command>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]374 <command id='who'>
375 <params>
376 <param name='who' doc='Display who is on vty' />
377 </params>
378 </command>
379 <command id='show history'>
380 <params>
381 <param name='show' doc='Show running system information' />
382 <param name='history' doc='Display the session command history' />
383 </params>
384 </command>
385 <command id='terminal monitor'>
386 <params>
387 <param name='terminal' doc='Set terminal line parameters' />
388 <param name='monitor' doc='Copy debug output to the current terminal line' />
389 </params>
390 </command>
391 <command id='terminal no monitor'>
392 <params>
393 <param name='terminal' doc='Set terminal line parameters' />
394 <param name='no' doc='Negate a command or set its defaults' />
395 <param name='monitor' doc='Copy debug output to the current terminal line' />
396 </params>
397 </command>
398 <command id='logging enable'>
399 <params>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]400 <param name='logging' doc='Configure logging' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]401 <param name='enable' doc='Enables logging to this vty' />
402 </params>
403 </command>
404 <command id='logging disable'>
405 <params>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]406 <param name='logging' doc='Configure logging' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]407 <param name='disable' doc='Disables logging to this vty' />
408 </params>
409 </command>
410 <command id='logging filter all (0|1)'>
411 <params>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]412 <param name='logging' doc='Configure logging' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]413 <param name='filter' doc='Filter log messages' />
414 <param name='all' doc='Do you want to log all messages?' />
415 <param name='0' doc='Only print messages matched by other filters' />
416 <param name='1' doc='Bypass filter and print all messages' />
417 </params>
418 </command>
419 <command id='logging color (0|1)'>
420 <params>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]421 <param name='logging' doc='Configure logging' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]422 <param name='color' doc='Configure color-printing for log messages' />
423 <param name='0' doc='Don&apos;t use color for printing messages' />
424 <param name='1' doc='Use color for printing messages' />
425 </params>
426 </command>
427 <command id='logging timestamp (0|1)'>
428 <params>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]429 <param name='logging' doc='Configure logging' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]430 <param name='timestamp' doc='Configure log message timestamping' />
431 <param name='0' doc='Don&apos;t prefix each log message' />
432 <param name='1' doc='Prefix each log message with current timestamp' />
433 </params>
434 </command>
435 <command id='logging print extended-timestamp (0|1)'>
436 <params>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]437 <param name='logging' doc='Configure logging' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]438 <param name='print' doc='Log output settings' />
439 <param name='extended-timestamp' doc='Configure log message timestamping' />
440 <param name='0' doc='Don&apos;t prefix each log message' />
441 <param name='1' doc='Prefix each log message with current timestamp with YYYYMMDDhhmmssnnn' />
442 </params>
443 </command>
444 <command id='logging print category (0|1)'>
445 <params>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]446 <param name='logging' doc='Configure logging' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]447 <param name='print' doc='Log output settings' />
448 <param name='category' doc='Configure log message' />
449 <param name='0' doc='Don&apos;t prefix each log message' />
450 <param name='1' doc='Prefix each log message with category/subsystem name' />
451 </params>
452 </command>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]453 <command id='logging print category-hex (0|1)'>
454 <params>
455 <param name='logging' doc='Configure logging' />
456 <param name='print' doc='Log output settings' />
457 <param name='category-hex' doc='Configure log message' />
458 <param name='0' doc='Don&apos;t prefix each log message' />
459 <param name='1' doc='Prefix each log message with category/subsystem nr in hex (&apos;&lt;000b&gt;&apos;)' />
460 </params>
461 </command>
462 <command id='logging print level (0|1)'>
463 <params>
464 <param name='logging' doc='Configure logging' />
465 <param name='print' doc='Log output settings' />
466 <param name='level' doc='Configure log message' />
467 <param name='0' doc='Don&apos;t prefix each log message' />
468 <param name='1' doc='Prefix each log message with the log level name' />
469 </params>
470 </command>
Neels Hofmeyrbf6b4eb2018-11-05 03:18:46 +0100[diff] [blame]471 <command id='logging print file (0|1|basename) [last]'>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]472 <params>
473 <param name='logging' doc='Configure logging' />
474 <param name='print' doc='Log output settings' />
475 <param name='file' doc='Configure log message' />
476 <param name='0' doc='Don&apos;t prefix each log message' />
477 <param name='1' doc='Prefix each log message with the source file and line' />
478 <param name='basename' doc='Prefix each log message with the source file&apos;s basename (strip leading paths) and line' />
Neels Hofmeyrbf6b4eb2018-11-05 03:18:46 +0100[diff] [blame]479 <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 Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]480 </params>
481 </command>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]482 <command id='logging set-log-mask MASK'>
483 <params>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]484 <param name='logging' doc='Configure logging' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]485 <param name='set-log-mask' doc='Set the logmask of this logging target' />
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]486 <param name='MASK' doc='List of logging categories to log, e.g. &apos;abc:mno:xyz&apos;. Available log categories depend on the specific application, refer to the &apos;logging level&apos; command. Optionally add individual log levels like &apos;abc,1:mno,3:xyz,5&apos;, where the level numbers are LOGL_DEBUG=1 LOGL_INFO=3 LOGL_NOTICE=5 LOGL_ERROR=7 LOGL_FATAL=8' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]487 </params>
488 </command>
Neels Hofmeyrbf6b4eb2018-11-05 03:18:46 +0100[diff] [blame]489 <command id='logging level (main|db|auc|ss|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf) (debug|info|notice|error|fatal)'>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]490 <params>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]491 <param name='logging' doc='Configure logging' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]492 <param name='level' doc='Set the log level for a specified category' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]493 <param name='main' doc='Main Program' />
494 <param name='db' doc='Database Layer' />
495 <param name='auc' doc='Authentication Center' />
Neels Hofmeyrbf6b4eb2018-11-05 03:18:46 +0100[diff] [blame]496 <param name='ss' doc='Supplementary Services' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]497 <param name='lglobal' doc='Library-internal global log family' />
498 <param name='llapd' doc='LAPD in libosmogsm' />
499 <param name='linp' doc='A-bis Intput Subsystem' />
500 <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' />
501 <param name='lmi' doc='A-bis Input Driver for Signalling' />
502 <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' />
503 <param name='lsms' doc='Layer3 Short Message Service (SMS)' />
504 <param name='lctrl' doc='Control Interface' />
505 <param name='lgtp' doc='GPRS GTP library' />
506 <param name='lstats' doc='Statistics messages and logging' />
507 <param name='lgsup' doc='Generic Subscriber Update Protocol' />
508 <param name='loap' doc='Osmocom Authentication Protocol' />
509 <param name='lss7' doc='libosmo-sigtran Signalling System 7' />
510 <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' />
511 <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' />
512 <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' />
513 <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' />
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]514 <param name='ljibuf' doc='libosmo-netif Jitter Buffer' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]515 <param name='debug' doc='Log debug messages and higher levels' />
516 <param name='info' doc='Log informational messages and higher levels' />
517 <param name='notice' doc='Log noticeable messages and higher levels' />
518 <param name='error' doc='Log error messages and higher levels' />
519 <param name='fatal' doc='Log only fatal messages' />
520 </params>
521 </command>
Neels Hofmeyrbf6b4eb2018-11-05 03:18:46 +0100[diff] [blame]522 <command id='logging level set-all (debug|info|notice|error|fatal)'>
523 <params>
524 <param name='logging' doc='Configure logging' />
525 <param name='level' doc='Set the log level for a specified category' />
526 <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.' />
527 <param name='debug' doc='Log debug messages and higher levels' />
528 <param name='info' doc='Log informational messages and higher levels' />
529 <param name='notice' doc='Log noticeable messages and higher levels' />
530 <param name='error' doc='Log error messages and higher levels' />
531 <param name='fatal' doc='Log only fatal messages' />
532 </params>
533 </command>
534 <command id='logging level force-all (debug|info|notice|error|fatal)'>
535 <params>
536 <param name='logging' doc='Configure logging' />
537 <param name='level' doc='Set the log level for a specified category' />
538 <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.' />
539 <param name='debug' doc='Log debug messages and higher levels' />
540 <param name='info' doc='Log informational messages and higher levels' />
541 <param name='notice' doc='Log noticeable messages and higher levels' />
542 <param name='error' doc='Log error messages and higher levels' />
543 <param name='fatal' doc='Log only fatal messages' />
544 </params>
545 </command>
546 <command id='no logging level force-all'>
547 <params>
548 <param name='no' doc='Negate a command or set its defaults' />
549 <param name='logging' doc='Configure logging' />
550 <param name='level' doc='Set the log level for a specified category' />
551 <param name='force-all' doc='Release any globally forced log level set with &apos;logging level force-all &lt;level&gt;&apos;' />
552 </params>
553 </command>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]554 <command id='show logging vty'>
555 <params>
556 <param name='show' doc='Show running system information' />
557 <param name='logging' doc='Show current logging configuration' />
558 <param name='vty' doc='Show current logging configuration for this vty' />
559 </params>
560 </command>
561 <command id='show alarms'>
562 <params>
563 <param name='show' doc='Show running system information' />
564 <param name='alarms' doc='Show current logging configuration' />
565 </params>
566 </command>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]567 <command id='show talloc-context (application|all) (full|brief|DEPTH)'>
568 <params>
569 <param name='show' doc='Show running system information' />
570 <param name='talloc-context' doc='Show talloc memory hierarchy' />
571 <param name='application' doc='Application&apos;s context' />
572 <param name='all' doc='All contexts, if NULL-context tracking is enabled' />
573 <param name='full' doc='Display a full talloc memory hierarchy' />
574 <param name='brief' doc='Display a brief talloc memory hierarchy' />
575 <param name='DEPTH' doc='Specify required maximal depth value' />
576 </params>
577 </command>
578 <command id='show talloc-context (application|all) (full|brief|DEPTH) tree ADDRESS'>
579 <params>
580 <param name='show' doc='Show running system information' />
581 <param name='talloc-context' doc='Show talloc memory hierarchy' />
582 <param name='application' doc='Application&apos;s context' />
583 <param name='all' doc='All contexts, if NULL-context tracking is enabled' />
584 <param name='full' doc='Display a full talloc memory hierarchy' />
585 <param name='brief' doc='Display a brief talloc memory hierarchy' />
586 <param name='DEPTH' doc='Specify required maximal depth value' />
587 <param name='tree' doc='Display only a specific memory chunk' />
588 <param name='ADDRESS' doc='Chunk address (e.g. 0xdeadbeef)' />
589 </params>
590 </command>
591 <command id='show talloc-context (application|all) (full|brief|DEPTH) filter REGEXP'>
592 <params>
593 <param name='show' doc='Show running system information' />
594 <param name='talloc-context' doc='Show talloc memory hierarchy' />
595 <param name='application' doc='Application&apos;s context' />
596 <param name='all' doc='All contexts, if NULL-context tracking is enabled' />
597 <param name='full' doc='Display a full talloc memory hierarchy' />
598 <param name='brief' doc='Display a brief talloc memory hierarchy' />
599 <param name='DEPTH' doc='Specify required maximal depth value' />
600 <param name='filter' doc='Filter chunks using regular expression' />
601 <param name='REGEXP' doc='Regular expression' />
602 </params>
603 </command>
Neels Hofmeyrbf6b4eb2018-11-05 03:18:46 +0100[diff] [blame]604 <command id='show gsup-connections'>
605 <params>
606 <param name='show' doc='Show running system information' />
607 <param name='gsup-connections' doc='GSUP Connections from VLRs, SGSNs, EUSEs' />
608 </params>
609 </command>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]610 <command id='subscriber (imsi|msisdn|id) IDENT show'>
611 <params>
612 <param name='subscriber' doc='Subscriber management commands' />
613 <param name='imsi' doc='Identify subscriber by IMSI' />
614 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
615 <param name='id' doc='Identify subscriber by database ID' />
616 <param name='IDENT' doc='IMSI/MSISDN/ID of the subscriber' />
617 <param name='show' doc='Show subscriber information' />
618 </params>
619 </command>
620 <command id='subscriber imsi IDENT create'>
621 <params>
622 <param name='subscriber' doc='Subscriber management commands' />
Neels Hofmeyrbf6b4eb2018-11-05 03:18:46 +0100[diff] [blame]623 <param name='imsi' doc='Identify subscriber by IMSI' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]624 <param name='IDENT' doc='IMSI/MSISDN/ID of the subscriber' />
Neels Hofmeyrbf6b4eb2018-11-05 03:18:46 +0100[diff] [blame]625 <param name='create' doc='Create subscriber by IMSI' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]626 </params>
627 </command>
628 <command id='subscriber (imsi|msisdn|id) IDENT delete'>
629 <params>
630 <param name='subscriber' doc='Subscriber management commands' />
631 <param name='imsi' doc='Identify subscriber by IMSI' />
632 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
633 <param name='id' doc='Identify subscriber by database ID' />
634 <param name='IDENT' doc='IMSI/MSISDN/ID of the subscriber' />
635 <param name='delete' doc='Delete subscriber from database' />
636 </params>
637 </command>
638 <command id='subscriber (imsi|msisdn|id) IDENT update msisdn MSISDN'>
639 <params>
640 <param name='subscriber' doc='Subscriber management commands' />
641 <param name='imsi' doc='Identify subscriber by IMSI' />
642 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
643 <param name='id' doc='Identify subscriber by database ID' />
644 <param name='IDENT' doc='IMSI/MSISDN/ID of the subscriber' />
645 <param name='update' doc='Set or update subscriber data' />
646 <param name='msisdn' doc='Set MSISDN (phone number) of the subscriber' />
647 <param name='MSISDN' doc='New MSISDN (phone number)' />
648 </params>
649 </command>
650 <command id='subscriber (imsi|msisdn|id) IDENT update aud2g none'>
651 <params>
652 <param name='subscriber' doc='Subscriber management commands' />
653 <param name='imsi' doc='Identify subscriber by IMSI' />
654 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
655 <param name='id' doc='Identify subscriber by database ID' />
656 <param name='IDENT' doc='IMSI/MSISDN/ID of the subscriber' />
657 <param name='update' doc='Set or update subscriber data' />
658 <param name='aud2g' doc='Set 2G authentication data' />
659 <param name='none' doc='Delete 2G authentication data' />
660 </params>
661 </command>
662 <command id='subscriber (imsi|msisdn|id) IDENT update aud2g (comp128v1|comp128v2|comp128v3|xor) ki KI'>
663 <params>
664 <param name='subscriber' doc='Subscriber management commands' />
665 <param name='imsi' doc='Identify subscriber by IMSI' />
666 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
667 <param name='id' doc='Identify subscriber by database ID' />
668 <param name='IDENT' doc='IMSI/MSISDN/ID of the subscriber' />
669 <param name='update' doc='Set or update subscriber data' />
670 <param name='aud2g' doc='Set 2G authentication data' />
671 <param name='comp128v1' doc='Use COMP128v1 algorithm' />
672 <param name='comp128v2' doc='Use COMP128v2 algorithm' />
673 <param name='comp128v3' doc='Use COMP128v3 algorithm' />
674 <param name='xor' doc='Use XOR algorithm' />
675 <param name='ki' doc='Set Ki Encryption Key' />
676 <param name='KI' doc='Ki as 32 hexadecimal characters' />
677 </params>
678 </command>
679 <command id='subscriber (imsi|msisdn|id) IDENT update aud3g none'>
680 <params>
681 <param name='subscriber' doc='Subscriber management commands' />
682 <param name='imsi' doc='Identify subscriber by IMSI' />
683 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
684 <param name='id' doc='Identify subscriber by database ID' />
685 <param name='IDENT' doc='IMSI/MSISDN/ID of the subscriber' />
686 <param name='update' doc='Set or update subscriber data' />
687 <param name='aud3g' doc='Set UMTS authentication data (3G, and 2G with UMTS AKA)' />
688 <param name='none' doc='Delete 3G authentication data' />
689 </params>
690 </command>
691 <command id='subscriber (imsi|msisdn|id) IDENT update aud3g milenage k K (op|opc) OP_C [ind-bitlen] [&lt;0-28&gt;]'>
692 <params>
693 <param name='subscriber' doc='Subscriber management commands' />
694 <param name='imsi' doc='Identify subscriber by IMSI' />
695 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
696 <param name='id' doc='Identify subscriber by database ID' />
697 <param name='IDENT' doc='IMSI/MSISDN/ID of the subscriber' />
698 <param name='update' doc='Set or update subscriber data' />
699 <param name='aud3g' doc='Set UMTS authentication data (3G, and 2G with UMTS AKA)' />
700 <param name='milenage' doc='Use Milenage algorithm' />
701 <param name='k' doc='Set Encryption Key K' />
702 <param name='K' doc='K as 32 hexadecimal characters' />
703 <param name='op' doc='Set OP key' />
704 <param name='opc' doc='Set OPC key' />
705 <param name='OP_C' doc='OP or OPC as 32 hexadecimal characters' />
706 <param name='[ind-bitlen]' doc='Set IND bit length' />
707 <param name='[&lt;0-28&gt;]' doc='IND bit length value (default: 5)' />
708 </params>
709 </command>
710 </node>
711 <node id='config'>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]712 <name>config</name>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]713 <command id='hostname WORD'>
714 <params>
715 <param name='hostname' doc='Set system&apos;s network name' />
716 <param name='WORD' doc='This system&apos;s network name' />
717 </params>
718 </command>
719 <command id='no hostname [HOSTNAME]'>
720 <params>
721 <param name='no' doc='Negate a command or set its defaults' />
722 <param name='hostname' doc='Reset system&apos;s network name' />
723 <param name='[HOSTNAME]' doc='Host name of this router' />
724 </params>
725 </command>
726 <command id='password (8|) WORD'>
727 <params>
728 <param name='password' doc='Assign the terminal connection password' />
729 <param name='8' doc='Specifies a HIDDEN password will follow' />
730 <param name='' doc='dummy string ' />
731 <param name='WORD' doc='The HIDDEN line password string' />
732 </params>
733 </command>
734 <command id='password LINE'>
735 <params>
736 <param name='password' doc='Assign the terminal connection password' />
737 <param name='LINE' doc='The UNENCRYPTED (cleartext) line password' />
738 </params>
739 </command>
740 <command id='enable password (8|) WORD'>
741 <params>
742 <param name='enable' doc='Modify enable password parameters' />
743 <param name='password' doc='Assign the privileged level password' />
744 <param name='8' doc='Specifies a HIDDEN password will follow' />
745 <param name='' doc='dummy string ' />
746 <param name='WORD' doc='The HIDDEN &apos;enable&apos; password string' />
747 </params>
748 </command>
749 <command id='enable password LINE'>
750 <params>
751 <param name='enable' doc='Modify enable password parameters' />
752 <param name='password' doc='Assign the privileged level password' />
753 <param name='LINE' doc='The UNENCRYPTED (cleartext) &apos;enable&apos; password' />
754 </params>
755 </command>
756 <command id='no enable password'>
757 <params>
758 <param name='no' doc='Negate a command or set its defaults' />
759 <param name='enable' doc='Modify enable password parameters' />
760 <param name='password' doc='Assign the privileged level password' />
761 </params>
762 </command>
763 <command id='banner motd default'>
764 <params>
765 <param name='banner' doc='Set banner string' />
766 <param name='motd' doc='Strings for motd' />
767 <param name='default' doc='Default string' />
768 </params>
769 </command>
770 <command id='banner motd file [FILE]'>
771 <params>
772 <param name='banner' doc='Set banner' />
773 <param name='motd' doc='Banner for motd' />
774 <param name='file' doc='Banner from a file' />
775 <param name='[FILE]' doc='Filename' />
776 </params>
777 </command>
778 <command id='no banner motd'>
779 <params>
780 <param name='no' doc='Negate a command or set its defaults' />
781 <param name='banner' doc='Set banner string' />
782 <param name='motd' doc='Strings for motd' />
783 </params>
784 </command>
785 <command id='service terminal-length &lt;0-512&gt;'>
786 <params>
787 <param name='service' doc='Set up miscellaneous service' />
788 <param name='terminal-length' doc='System wide terminal length configuration' />
789 <param name='&lt;0-512&gt;' doc='Number of lines of VTY (0 means no line control)' />
790 </params>
791 </command>
792 <command id='no service terminal-length [&lt;0-512&gt;]'>
793 <params>
794 <param name='no' doc='Negate a command or set its defaults' />
795 <param name='service' doc='Set up miscellaneous service' />
796 <param name='terminal-length' doc='System wide terminal length configuration' />
797 <param name='[&lt;0-512&gt;]' doc='Number of lines of VTY (0 means no line control)' />
798 </params>
799 </command>
800 <command id='line vty'>
801 <params>
802 <param name='line' doc='Configure a terminal line' />
803 <param name='vty' doc='Virtual terminal' />
804 </params>
805 </command>
806 <command id='service advanced-vty'>
807 <params>
808 <param name='service' doc='Set up miscellaneous service' />
809 <param name='advanced-vty' doc='Enable advanced mode vty interface' />
810 </params>
811 </command>
812 <command id='no service advanced-vty'>
813 <params>
814 <param name='no' doc='Negate a command or set its defaults' />
815 <param name='service' doc='Set up miscellaneous service' />
816 <param name='advanced-vty' doc='Enable advanced mode vty interface' />
817 </params>
818 </command>
819 <command id='show history'>
820 <params>
821 <param name='show' doc='Show running system information' />
822 <param name='history' doc='Display the session command history' />
823 </params>
824 </command>
825 <command id='ctrl'>
826 <params>
827 <param name='ctrl' doc='Configure the Control Interface' />
828 </params>
829 </command>
830 <command id='log stderr'>
831 <params>
832 <param name='log' doc='Configure logging sub-system' />
833 <param name='stderr' doc='Logging via STDERR of the process' />
834 </params>
835 </command>
836 <command id='no log stderr'>
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='stderr' doc='Logging via STDERR of the process' />
841 </params>
842 </command>
843 <command id='log file .FILENAME'>
844 <params>
845 <param name='log' doc='Configure logging sub-system' />
846 <param name='file' doc='Logging to text file' />
847 <param name='.FILENAME' doc='Filename' />
848 </params>
849 </command>
850 <command id='no log file .FILENAME'>
851 <params>
852 <param name='no' doc='Negate a command or set its defaults' />
853 <param name='log' doc='Configure logging sub-system' />
854 <param name='file' doc='Logging to text file' />
855 <param name='.FILENAME' doc='Filename' />
856 </params>
857 </command>
858 <command id='log alarms &lt;2-32700&gt;'>
859 <params>
860 <param name='log' doc='Configure logging sub-system' />
861 <param name='alarms' doc='Logging alarms to osmo_strrb' />
862 <param name='&lt;2-32700&gt;' doc='Maximum number of messages to log' />
863 </params>
864 </command>
865 <command id='no log alarms'>
866 <params>
867 <param name='no' doc='Negate a command or set its defaults' />
868 <param name='log' doc='Configure logging sub-system' />
869 <param name='alarms' doc='Logging alarms to osmo_strrb' />
870 </params>
871 </command>
872 <command id='log syslog (authpriv|cron|daemon|ftp|lpr|mail|news|user|uucp)'>
873 <params>
874 <param name='log' doc='Configure logging sub-system' />
875 <param name='syslog' doc='Logging via syslog' />
876 <param name='authpriv' doc='Security/authorization messages facility' />
877 <param name='cron' doc='Clock daemon (cron/at) facility' />
878 <param name='daemon' doc='General system daemon facility' />
879 <param name='ftp' doc='Ftp daemon facility' />
880 <param name='lpr' doc='Line printer facility' />
881 <param name='mail' doc='Mail facility' />
882 <param name='news' doc='News facility' />
883 <param name='user' doc='Generic facility' />
884 <param name='uucp' doc='UUCP facility' />
885 </params>
Neels Hofmeyrbf6b4eb2018-11-05 03:18:46 +0100[diff] [blame]886 </command> <command id='log syslog local &lt;0-7&gt;'>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]887 <params>
888 <param name='log' doc='Configure logging sub-system' />
889 <param name='syslog' doc='Logging via syslog' />
890 <param name='local' doc='Syslog LOCAL facility' />
891 <param name='&lt;0-7&gt;' doc='Local facility number' />
892 </params>
893 </command>
894 <command id='no log syslog'>
895 <params>
896 <param name='no' doc='Negate a command or set its defaults' />
897 <param name='log' doc='Configure logging sub-system' />
898 <param name='syslog' doc='Logging via syslog' />
899 </params>
900 </command>
901 <command id='log gsmtap [HOSTNAME]'>
902 <params>
903 <param name='log' doc='Configure logging sub-system' />
904 <param name='gsmtap' doc='Logging via GSMTAP' />
905 <param name='[HOSTNAME]' doc='Host name to send the GSMTAP logging to (UDP port 4729)' />
906 </params>
907 </command>
908 <command id='hlr'>
909 <params>
910 <param name='hlr' doc='Configure the HLR' />
911 </params>
912 </command>
913 </node>
914 <node id='config-log'>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]915 <name>config-log</name>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]916 <command id='logging filter all (0|1)'>
917 <params>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]918 <param name='logging' doc='Configure logging' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]919 <param name='filter' doc='Filter log messages' />
920 <param name='all' doc='Do you want to log all messages?' />
921 <param name='0' doc='Only print messages matched by other filters' />
922 <param name='1' doc='Bypass filter and print all messages' />
923 </params>
924 </command>
925 <command id='logging color (0|1)'>
926 <params>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]927 <param name='logging' doc='Configure logging' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]928 <param name='color' doc='Configure color-printing for log messages' />
929 <param name='0' doc='Don&apos;t use color for printing messages' />
930 <param name='1' doc='Use color for printing messages' />
931 </params>
932 </command>
933 <command id='logging timestamp (0|1)'>
934 <params>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]935 <param name='logging' doc='Configure logging' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]936 <param name='timestamp' doc='Configure log message timestamping' />
937 <param name='0' doc='Don&apos;t prefix each log message' />
938 <param name='1' doc='Prefix each log message with current timestamp' />
939 </params>
940 </command>
941 <command id='logging print extended-timestamp (0|1)'>
942 <params>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]943 <param name='logging' doc='Configure logging' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]944 <param name='print' doc='Log output settings' />
945 <param name='extended-timestamp' doc='Configure log message timestamping' />
946 <param name='0' doc='Don&apos;t prefix each log message' />
947 <param name='1' doc='Prefix each log message with current timestamp with YYYYMMDDhhmmssnnn' />
948 </params>
949 </command>
950 <command id='logging print category (0|1)'>
951 <params>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]952 <param name='logging' doc='Configure logging' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]953 <param name='print' doc='Log output settings' />
954 <param name='category' doc='Configure log message' />
955 <param name='0' doc='Don&apos;t prefix each log message' />
956 <param name='1' doc='Prefix each log message with category/subsystem name' />
957 </params>
958 </command>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]959 <command id='logging print category-hex (0|1)'>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]960 <params>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]961 <param name='logging' doc='Configure logging' />
962 <param name='print' doc='Log output settings' />
963 <param name='category-hex' doc='Configure log message' />
964 <param name='0' doc='Don&apos;t prefix each log message' />
965 <param name='1' doc='Prefix each log message with category/subsystem nr in hex (&apos;&lt;000b&gt;&apos;)' />
966 </params>
967 </command>
968 <command id='logging print level (0|1)'>
969 <params>
970 <param name='logging' doc='Configure logging' />
971 <param name='print' doc='Log output settings' />
972 <param name='level' doc='Configure log message' />
973 <param name='0' doc='Don&apos;t prefix each log message' />
974 <param name='1' doc='Prefix each log message with the log level name' />
975 </params>
976 </command>
Neels Hofmeyrbf6b4eb2018-11-05 03:18:46 +0100[diff] [blame]977 <command id='logging print file (0|1|basename) [last]'>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]978 <params>
979 <param name='logging' doc='Configure logging' />
980 <param name='print' doc='Log output settings' />
981 <param name='file' doc='Configure log message' />
982 <param name='0' doc='Don&apos;t prefix each log message' />
983 <param name='1' doc='Prefix each log message with the source file and line' />
984 <param name='basename' doc='Prefix each log message with the source file&apos;s basename (strip leading paths) and line' />
Neels Hofmeyrbf6b4eb2018-11-05 03:18:46 +0100[diff] [blame]985 <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 Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]986 </params>
987 </command>
Neels Hofmeyrbf6b4eb2018-11-05 03:18:46 +0100[diff] [blame]988 <command id='logging level (main|db|auc|ss|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf) (debug|info|notice|error|fatal)'>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]989 <params>
990 <param name='logging' doc='Configure logging' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]991 <param name='level' doc='Set the log level for a specified category' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]992 <param name='main' doc='Main Program' />
993 <param name='db' doc='Database Layer' />
994 <param name='auc' doc='Authentication Center' />
Neels Hofmeyrbf6b4eb2018-11-05 03:18:46 +0100[diff] [blame]995 <param name='ss' doc='Supplementary Services' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]996 <param name='lglobal' doc='Library-internal global log family' />
997 <param name='llapd' doc='LAPD in libosmogsm' />
998 <param name='linp' doc='A-bis Intput Subsystem' />
999 <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' />
1000 <param name='lmi' doc='A-bis Input Driver for Signalling' />
1001 <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' />
1002 <param name='lsms' doc='Layer3 Short Message Service (SMS)' />
1003 <param name='lctrl' doc='Control Interface' />
1004 <param name='lgtp' doc='GPRS GTP library' />
1005 <param name='lstats' doc='Statistics messages and logging' />
1006 <param name='lgsup' doc='Generic Subscriber Update Protocol' />
1007 <param name='loap' doc='Osmocom Authentication Protocol' />
1008 <param name='lss7' doc='libosmo-sigtran Signalling System 7' />
1009 <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' />
1010 <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' />
1011 <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' />
1012 <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' />
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]1013 <param name='ljibuf' doc='libosmo-netif Jitter Buffer' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1014 <param name='debug' doc='Log debug messages and higher levels' />
1015 <param name='info' doc='Log informational messages and higher levels' />
1016 <param name='notice' doc='Log noticeable messages and higher levels' />
1017 <param name='error' doc='Log error messages and higher levels' />
1018 <param name='fatal' doc='Log only fatal messages' />
1019 </params>
1020 </command>
Neels Hofmeyrbf6b4eb2018-11-05 03:18:46 +0100[diff] [blame]1021 <command id='logging level set-all (debug|info|notice|error|fatal)'>
1022 <params>
1023 <param name='logging' doc='Configure logging' />
1024 <param name='level' doc='Set the log level for a specified category' />
1025 <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.' />
1026 <param name='debug' doc='Log debug messages and higher levels' />
1027 <param name='info' doc='Log informational messages and higher levels' />
1028 <param name='notice' doc='Log noticeable messages and higher levels' />
1029 <param name='error' doc='Log error messages and higher levels' />
1030 <param name='fatal' doc='Log only fatal messages' />
1031 </params>
1032 </command>
1033 <command id='logging level force-all (debug|info|notice|error|fatal)'>
1034 <params>
1035 <param name='logging' doc='Configure logging' />
1036 <param name='level' doc='Set the log level for a specified category' />
1037 <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.' />
1038 <param name='debug' doc='Log debug messages and higher levels' />
1039 <param name='info' doc='Log informational messages and higher levels' />
1040 <param name='notice' doc='Log noticeable messages and higher levels' />
1041 <param name='error' doc='Log error messages and higher levels' />
1042 <param name='fatal' doc='Log only fatal messages' />
1043 </params>
1044 </command>
1045 <command id='no logging level force-all'>
1046 <params>
1047 <param name='no' doc='Negate a command or set its defaults' />
1048 <param name='logging' doc='Configure logging' />
1049 <param name='level' doc='Set the log level for a specified category' />
1050 <param name='force-all' doc='Release any globally forced log level set with &apos;logging level force-all &lt;level&gt;&apos;' />
1051 </params>
1052 </command>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1053 </node>
1054 <node id='config-line'>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]1055 <name>config-line</name>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1056 <command id='login'>
1057 <params>
1058 <param name='login' doc='Enable password checking' />
1059 </params>
1060 </command>
1061 <command id='no login'>
1062 <params>
1063 <param name='no' doc='Negate a command or set its defaults' />
1064 <param name='login' doc='Enable password checking' />
1065 </params>
1066 </command>
1067 <command id='bind A.B.C.D'>
1068 <params>
1069 <param name='bind' doc='Accept VTY telnet connections on local interface' />
1070 <param name='A.B.C.D' doc='Local interface IP address (default: 127.0.0.1)' />
1071 </params>
1072 </command>
1073 </node>
1074 <node id='config-ctrl'>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]1075 <name>config-ctrl</name>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1076 <command id='bind A.B.C.D'>
1077 <params>
1078 <param name='bind' doc='Set bind address to listen for Control connections' />
1079 <param name='A.B.C.D' doc='Local IP address (default 127.0.0.1)' />
1080 </params>
1081 </command>
1082 </node>
1083 <node id='config-hlr'>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]1084 <name>config-hlr</name>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1085 <command id='gsup'>
1086 <params>
1087 <param name='gsup' doc='Configure GSUP options' />
1088 </params>
1089 </command>
Neels Hofmeyrbf6b4eb2018-11-05 03:18:46 +0100[diff] [blame]1090 <command id='euse NAME'>
1091 <params>
1092 <param name='euse' doc='Configure a particular External USSD Entity' />
1093 <param name='NAME' doc='Alphanumeric name of the External USSD Entity' />
1094 </params>
1095 </command>
1096 <command id='no euse NAME'>
1097 <params>
1098 <param name='no' doc='Negate a command or set its defaults' />
1099 <param name='euse' doc='Remove a particular External USSD Entity' />
1100 <param name='NAME' doc='Alphanumeric name of the External USSD Entity' />
1101 </params>
1102 </command>
1103 <command id='ussd route prefix PREFIX internal (own-msisdn|own-imsi)'>
1104 <params>
1105 <param name='ussd' doc='USSD Configuration' />
1106 <param name='route' doc='Routing Configuration' />
1107 <param name='prefix' doc='Prefix-Matching Route' />
1108 <param name='PREFIX' doc='USSD Prefix' />
1109 <param name='internal' doc='Internal USSD Handler' />
1110 <param name='own-msisdn' doc='Respond with subscribers&apos; own MSISDN' />
1111 <param name='own-imsi' doc='Respond with subscribers&apos; own IMSI' />
1112 </params>
1113 </command>
1114 <command id='ussd route prefix PREFIX external EUSE'>
1115 <params>
1116 <param name='ussd' doc='USSD Configuration' />
1117 <param name='route' doc='Routing Configuration' />
1118 <param name='prefix' doc='Prefix-Matching Route' />
1119 <param name='PREFIX' doc='USSD Prefix' />
1120 <param name='external' doc='External USSD Handler' />
1121 <param name='EUSE' doc='Name of External USSD Handler (IPA CCM ID)' />
1122 </params>
1123 </command>
1124 <command id='no ussd route prefix PREFIX'>
1125 <params>
1126 <param name='no' doc='Negate a command or set its defaults' />
1127 <param name='ussd' doc='USSD Configuration' />
1128 <param name='route' doc='Routing Configuration' />
1129 <param name='prefix' doc='Prefix-Matching Route' />
1130 <param name='PREFIX' doc='USSD Prefix' />
1131 </params>
1132 </command>
1133 <command id='ussd default-route external EUSE'>
1134 <params>
1135 <param name='ussd' doc='USSD Configuration' />
1136 <param name='default-route' doc='Configure default-route for all USSD to unknown destinations' />
1137 <param name='external' doc='External USSD Handler' />
1138 <param name='EUSE' doc='Name of External USSD Handler (IPA CCM ID)' />
1139 </params>
1140 </command>
1141 <command id='no ussd default-route'>
1142 <params>
1143 <param name='no' doc='Negate a command or set its defaults' />
1144 <param name='ussd' doc='USSD Configuration' />
1145 <param name='default-route' doc='Remove the default-route for all USSD to unknown destinations' />
1146 </params>
1147 </command>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1148 </node>
1149 <node id='config-hlr-gsup'>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]1150 <name>config-hlr-gsup</name>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1151 <command id='bind ip A.B.C.D'>
1152 <params>
1153 <param name='bind' doc='Listen/Bind related socket option' />
1154 <param name='ip' doc='IP information' />
1155 <param name='A.B.C.D' doc='IPv4 Address to bind the GSUP interface to' />
1156 </params>
1157 </command>
1158 </node>
Neels Hofmeyrbf6b4eb2018-11-05 03:18:46 +0100[diff] [blame]1159 <node id='config-hlr-euse'>
1160 <name>config-hlr-euse</name>
1161 </node>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1162</vtydoc>