Gitiles
Code Review Sign In
gerrit.osmocom.org / osmo-hlr / 78abea6a0e4824cb8e5baa770012c41524fa81dd / . / doc / manuals / vty / hlr_vty_reference.xml
blob: e5fd0f243e619f56c6875be7d2e3c2d8fca56f91 [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>
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[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|lrspro) (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' />
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]216 <param name='lrspro' doc='Remote SIM protocol' />
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]217 <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 Hofmeyrbf6b4eb2018-11-05 03:18:46 +0100[diff] [blame]224 <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 Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]256 <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>
269 <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>
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]306 <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>
329 <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 Hofmeyrbf6b4eb2018-11-05 03:18:46 +0100[diff] [blame]335 <command id='show gsup-connections'>
336 <params>
337 <param name='show' doc='Show running system information' />
338 <param name='gsup-connections' doc='GSUP Connections from VLRs, SGSNs, EUSEs' />
339 </params>
340 </command>
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]341 <command id='subscriber (imsi|msisdn|id|imei) IDENT show'>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]342 <params>
343 <param name='subscriber' doc='Subscriber management commands' />
344 <param name='imsi' doc='Identify subscriber by IMSI' />
345 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
346 <param name='id' doc='Identify subscriber by database ID' />
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]347 <param name='imei' doc='Identify subscriber by IMEI' />
348 <param name='IDENT' doc='IMSI/MSISDN/ID/IMEI of the subscriber' />
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]349 <param name='show' doc='Show subscriber information' />
350 </params>
351 </command>
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]352 <command id='show subscriber (imsi|msisdn|id|imei) IDENT'>
353 <params>
354 <param name='show' doc='Show running system information' />
355 <param name='subscriber' doc='Subscriber management commands' />
356 <param name='imsi' doc='Identify subscriber by IMSI' />
357 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
358 <param name='id' doc='Identify subscriber by database ID' />
359 <param name='imei' doc='Identify subscriber by IMEI' />
360 <param name='IDENT' doc='IMSI/MSISDN/ID/IMEI of the subscriber' />
361 </params>
362 </command>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]363 </node>
364 <node id='enable'>
365 <name>enable</name>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]366 <command id='disable'>
367 <params>
368 <param name='disable' doc='Turn off privileged mode command' />
369 </params>
370 </command>
371 <command id='configure terminal'>
372 <params>
373 <param name='configure' doc='Configuration from vty interface' />
374 <param name='terminal' doc='Configuration terminal' />
375 </params>
376 </command>
377 <command id='copy running-config startup-config'>
378 <params>
379 <param name='copy' doc='Copy configuration' />
380 <param name='running-config' doc='Copy running config to... ' />
381 <param name='startup-config' doc='Copy running config to startup config (same as write file)' />
382 </params>
383 </command>
384 <command id='show startup-config'>
385 <params>
386 <param name='show' doc='Show running system information' />
387 <param name='startup-config' doc='Contentes of startup configuration' />
388 </params>
389 </command>
390 <command id='show version'>
391 <params>
392 <param name='show' doc='Show running system information' />
393 <param name='version' doc='Displays program version' />
394 </params>
395 </command>
396 <command id='show online-help'>
397 <params>
398 <param name='show' doc='Show running system information' />
399 <param name='online-help' doc='Online help' />
400 </params>
401 </command>
402 <command id='terminal length &lt;0-512&gt;'>
403 <params>
404 <param name='terminal' doc='Set terminal line parameters' />
405 <param name='length' doc='Set number of lines on a screen' />
406 <param name='&lt;0-512&gt;' doc='Number of lines on screen (0 for no pausing)' />
407 </params>
408 </command>
409 <command id='terminal no length'>
410 <params>
411 <param name='terminal' doc='Set terminal line parameters' />
412 <param name='no' doc='Negate a command or set its defaults' />
413 <param name='length' doc='Set number of lines on a screen' />
414 </params>
415 </command>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]416 <command id='who'>
417 <params>
418 <param name='who' doc='Display who is on vty' />
419 </params>
420 </command>
421 <command id='show history'>
422 <params>
423 <param name='show' doc='Show running system information' />
424 <param name='history' doc='Display the session command history' />
425 </params>
426 </command>
427 <command id='terminal monitor'>
428 <params>
429 <param name='terminal' doc='Set terminal line parameters' />
430 <param name='monitor' doc='Copy debug output to the current terminal line' />
431 </params>
432 </command>
433 <command id='terminal no monitor'>
434 <params>
435 <param name='terminal' doc='Set terminal line parameters' />
436 <param name='no' doc='Negate a command or set its defaults' />
437 <param name='monitor' doc='Copy debug output to the current terminal line' />
438 </params>
439 </command>
440 <command id='logging enable'>
441 <params>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]442 <param name='logging' doc='Configure logging' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]443 <param name='enable' doc='Enables logging to this vty' />
444 </params>
445 </command>
446 <command id='logging disable'>
447 <params>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]448 <param name='logging' doc='Configure logging' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]449 <param name='disable' doc='Disables logging to this vty' />
450 </params>
451 </command>
452 <command id='logging filter all (0|1)'>
453 <params>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]454 <param name='logging' doc='Configure logging' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]455 <param name='filter' doc='Filter log messages' />
456 <param name='all' doc='Do you want to log all messages?' />
457 <param name='0' doc='Only print messages matched by other filters' />
458 <param name='1' doc='Bypass filter and print all messages' />
459 </params>
460 </command>
461 <command id='logging color (0|1)'>
462 <params>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]463 <param name='logging' doc='Configure logging' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]464 <param name='color' doc='Configure color-printing for log messages' />
465 <param name='0' doc='Don&apos;t use color for printing messages' />
466 <param name='1' doc='Use color for printing messages' />
467 </params>
468 </command>
469 <command id='logging timestamp (0|1)'>
470 <params>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]471 <param name='logging' doc='Configure logging' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]472 <param name='timestamp' doc='Configure log message timestamping' />
473 <param name='0' doc='Don&apos;t prefix each log message' />
474 <param name='1' doc='Prefix each log message with current timestamp' />
475 </params>
476 </command>
477 <command id='logging print extended-timestamp (0|1)'>
478 <params>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]479 <param name='logging' doc='Configure logging' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]480 <param name='print' doc='Log output settings' />
481 <param name='extended-timestamp' doc='Configure log message timestamping' />
482 <param name='0' doc='Don&apos;t prefix each log message' />
483 <param name='1' doc='Prefix each log message with current timestamp with YYYYMMDDhhmmssnnn' />
484 </params>
485 </command>
486 <command id='logging print category (0|1)'>
487 <params>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]488 <param name='logging' doc='Configure logging' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]489 <param name='print' doc='Log output settings' />
490 <param name='category' doc='Configure log message' />
491 <param name='0' doc='Don&apos;t prefix each log message' />
492 <param name='1' doc='Prefix each log message with category/subsystem name' />
493 </params>
494 </command>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]495 <command id='logging print category-hex (0|1)'>
496 <params>
497 <param name='logging' doc='Configure logging' />
498 <param name='print' doc='Log output settings' />
499 <param name='category-hex' doc='Configure log message' />
500 <param name='0' doc='Don&apos;t prefix each log message' />
501 <param name='1' doc='Prefix each log message with category/subsystem nr in hex (&apos;&lt;000b&gt;&apos;)' />
502 </params>
503 </command>
504 <command id='logging print level (0|1)'>
505 <params>
506 <param name='logging' doc='Configure logging' />
507 <param name='print' doc='Log output settings' />
508 <param name='level' doc='Configure log message' />
509 <param name='0' doc='Don&apos;t prefix each log message' />
510 <param name='1' doc='Prefix each log message with the log level name' />
511 </params>
512 </command>
Neels Hofmeyrbf6b4eb2018-11-05 03:18:46 +0100[diff] [blame]513 <command id='logging print file (0|1|basename) [last]'>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]514 <params>
515 <param name='logging' doc='Configure logging' />
516 <param name='print' doc='Log output settings' />
517 <param name='file' doc='Configure log message' />
518 <param name='0' doc='Don&apos;t prefix each log message' />
519 <param name='1' doc='Prefix each log message with the source file and line' />
520 <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]521 <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]522 </params>
523 </command>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]524 <command id='logging set-log-mask MASK'>
525 <params>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]526 <param name='logging' doc='Configure logging' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]527 <param name='set-log-mask' doc='Set the logmask of this logging target' />
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]528 <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]529 </params>
530 </command>
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]531 <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|lrspro) (debug|info|notice|error|fatal)'>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]532 <params>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]533 <param name='logging' doc='Configure logging' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]534 <param name='level' doc='Set the log level for a specified category' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]535 <param name='main' doc='Main Program' />
536 <param name='db' doc='Database Layer' />
537 <param name='auc' doc='Authentication Center' />
Neels Hofmeyrbf6b4eb2018-11-05 03:18:46 +0100[diff] [blame]538 <param name='ss' doc='Supplementary Services' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]539 <param name='lglobal' doc='Library-internal global log family' />
540 <param name='llapd' doc='LAPD in libosmogsm' />
541 <param name='linp' doc='A-bis Intput Subsystem' />
542 <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' />
543 <param name='lmi' doc='A-bis Input Driver for Signalling' />
544 <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' />
545 <param name='lsms' doc='Layer3 Short Message Service (SMS)' />
546 <param name='lctrl' doc='Control Interface' />
547 <param name='lgtp' doc='GPRS GTP library' />
548 <param name='lstats' doc='Statistics messages and logging' />
549 <param name='lgsup' doc='Generic Subscriber Update Protocol' />
550 <param name='loap' doc='Osmocom Authentication Protocol' />
551 <param name='lss7' doc='libosmo-sigtran Signalling System 7' />
552 <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' />
553 <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' />
554 <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' />
555 <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' />
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]556 <param name='ljibuf' doc='libosmo-netif Jitter Buffer' />
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]557 <param name='lrspro' doc='Remote SIM protocol' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]558 <param name='debug' doc='Log debug messages and higher levels' />
559 <param name='info' doc='Log informational messages and higher levels' />
560 <param name='notice' doc='Log noticeable messages and higher levels' />
561 <param name='error' doc='Log error messages and higher levels' />
562 <param name='fatal' doc='Log only fatal messages' />
563 </params>
564 </command>
Neels Hofmeyrbf6b4eb2018-11-05 03:18:46 +0100[diff] [blame]565 <command id='logging level set-all (debug|info|notice|error|fatal)'>
566 <params>
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]567 <param name='logging' doc='Configure logging' /> <param name='level' doc='Set the log level for a specified category' />
Neels Hofmeyrbf6b4eb2018-11-05 03:18:46 +0100[diff] [blame]568 <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.' />
569 <param name='debug' doc='Log debug messages and higher levels' />
570 <param name='info' doc='Log informational messages and higher levels' />
571 <param name='notice' doc='Log noticeable messages and higher levels' />
572 <param name='error' doc='Log error messages and higher levels' />
573 <param name='fatal' doc='Log only fatal messages' />
574 </params>
575 </command>
576 <command id='logging level force-all (debug|info|notice|error|fatal)'>
577 <params>
578 <param name='logging' doc='Configure logging' />
579 <param name='level' doc='Set the log level for a specified category' />
580 <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.' />
581 <param name='debug' doc='Log debug messages and higher levels' />
582 <param name='info' doc='Log informational messages and higher levels' />
583 <param name='notice' doc='Log noticeable messages and higher levels' />
584 <param name='error' doc='Log error messages and higher levels' />
585 <param name='fatal' doc='Log only fatal messages' />
586 </params>
587 </command>
588 <command id='no logging level force-all'>
589 <params>
590 <param name='no' doc='Negate a command or set its defaults' />
591 <param name='logging' doc='Configure logging' />
592 <param name='level' doc='Set the log level for a specified category' />
593 <param name='force-all' doc='Release any globally forced log level set with &apos;logging level force-all &lt;level&gt;&apos;' />
594 </params>
595 </command>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]596 <command id='show logging vty'>
597 <params>
598 <param name='show' doc='Show running system information' />
599 <param name='logging' doc='Show current logging configuration' />
600 <param name='vty' doc='Show current logging configuration for this vty' />
601 </params>
602 </command>
603 <command id='show alarms'>
604 <params>
605 <param name='show' doc='Show running system information' />
606 <param name='alarms' doc='Show current logging configuration' />
607 </params>
608 </command>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]609 <command id='show talloc-context (application|all) (full|brief|DEPTH)'>
610 <params>
611 <param name='show' doc='Show running system information' />
612 <param name='talloc-context' doc='Show talloc memory hierarchy' />
613 <param name='application' doc='Application&apos;s context' />
614 <param name='all' doc='All contexts, if NULL-context tracking is enabled' />
615 <param name='full' doc='Display a full talloc memory hierarchy' />
616 <param name='brief' doc='Display a brief talloc memory hierarchy' />
617 <param name='DEPTH' doc='Specify required maximal depth value' />
618 </params>
619 </command>
620 <command id='show talloc-context (application|all) (full|brief|DEPTH) tree ADDRESS'>
621 <params>
622 <param name='show' doc='Show running system information' />
623 <param name='talloc-context' doc='Show talloc memory hierarchy' />
624 <param name='application' doc='Application&apos;s context' />
625 <param name='all' doc='All contexts, if NULL-context tracking is enabled' />
626 <param name='full' doc='Display a full talloc memory hierarchy' />
627 <param name='brief' doc='Display a brief talloc memory hierarchy' />
628 <param name='DEPTH' doc='Specify required maximal depth value' />
629 <param name='tree' doc='Display only a specific memory chunk' />
630 <param name='ADDRESS' doc='Chunk address (e.g. 0xdeadbeef)' />
631 </params>
632 </command>
633 <command id='show talloc-context (application|all) (full|brief|DEPTH) filter REGEXP'>
634 <params>
635 <param name='show' doc='Show running system information' />
636 <param name='talloc-context' doc='Show talloc memory hierarchy' />
637 <param name='application' doc='Application&apos;s context' />
638 <param name='all' doc='All contexts, if NULL-context tracking is enabled' />
639 <param name='full' doc='Display a full talloc memory hierarchy' />
640 <param name='brief' doc='Display a brief talloc memory hierarchy' />
641 <param name='DEPTH' doc='Specify required maximal depth value' />
642 <param name='filter' doc='Filter chunks using regular expression' />
643 <param name='REGEXP' doc='Regular expression' />
644 </params>
645 </command>
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]646 <command id='show stats'>
647 <params>
648 <param name='show' doc='Show running system information' />
649 <param name='stats' doc='Show statistical values' />
650 </params>
651 </command>
652 <command id='show stats level (global|peer|subscriber)'>
653 <params>
654 <param name='show' doc='Show running system information' />
655 <param name='stats' doc='Show statistical values' />
656 <param name='level' doc='Set the maximum group level' />
657 <param name='global' doc='Show global groups only' />
658 <param name='peer' doc='Show global and network peer related groups' />
659 <param name='subscriber' doc='Show global, peer, and subscriber groups' />
660 </params>
661 </command>
662 <command id='show asciidoc counters'>
663 <params>
664 <param name='show' doc='Show running system information' />
665 <param name='asciidoc' doc='Asciidoc generation' />
666 <param name='counters' doc='Generate table of all registered counters' />
667 </params>
668 </command>
669 <command id='show rate-counters'>
670 <params>
671 <param name='show' doc='Show running system information' />
672 <param name='rate-counters' doc='Show all rate counters' />
673 </params>
674 </command>
Neels Hofmeyrbf6b4eb2018-11-05 03:18:46 +0100[diff] [blame]675 <command id='show gsup-connections'>
676 <params>
677 <param name='show' doc='Show running system information' />
678 <param name='gsup-connections' doc='GSUP Connections from VLRs, SGSNs, EUSEs' />
679 </params>
680 </command>
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]681 <command id='subscriber (imsi|msisdn|id|imei) IDENT show'>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]682 <params>
683 <param name='subscriber' doc='Subscriber management commands' />
684 <param name='imsi' doc='Identify subscriber by IMSI' />
685 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
686 <param name='id' doc='Identify subscriber by database ID' />
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]687 <param name='imei' doc='Identify subscriber by IMEI' />
688 <param name='IDENT' doc='IMSI/MSISDN/ID/IMEI of the subscriber' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]689 <param name='show' doc='Show subscriber information' />
690 </params>
691 </command>
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]692 <command id='show subscriber (imsi|msisdn|id|imei) IDENT'>
693 <params>
694 <param name='show' doc='Show running system information' />
695 <param name='subscriber' doc='Subscriber management commands' />
696 <param name='imsi' doc='Identify subscriber by IMSI' />
697 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
698 <param name='id' doc='Identify subscriber by database ID' />
699 <param name='imei' doc='Identify subscriber by IMEI' />
700 <param name='IDENT' doc='IMSI/MSISDN/ID/IMEI of the subscriber' />
701 </params>
702 </command>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]703 <command id='subscriber imsi IDENT create'>
704 <params>
705 <param name='subscriber' doc='Subscriber management commands' />
Neels Hofmeyrbf6b4eb2018-11-05 03:18:46 +0100[diff] [blame]706 <param name='imsi' doc='Identify subscriber by IMSI' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]707 <param name='IDENT' doc='IMSI/MSISDN/ID of the subscriber' />
Neels Hofmeyrbf6b4eb2018-11-05 03:18:46 +0100[diff] [blame]708 <param name='create' doc='Create subscriber by IMSI' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]709 </params>
710 </command>
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]711 <command id='subscriber (imsi|msisdn|id|imei) IDENT delete'>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]712 <params>
713 <param name='subscriber' doc='Subscriber management commands' />
714 <param name='imsi' doc='Identify subscriber by IMSI' />
715 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
716 <param name='id' doc='Identify subscriber by database ID' />
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]717 <param name='imei' doc='Identify subscriber by IMEI' />
718 <param name='IDENT' doc='IMSI/MSISDN/ID/IMEI of the subscriber' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]719 <param name='delete' doc='Delete subscriber from database' />
720 </params>
721 </command>
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]722 <command id='subscriber (imsi|msisdn|id|imei) IDENT update msisdn (none|MSISDN)'>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]723 <params>
724 <param name='subscriber' doc='Subscriber management commands' />
725 <param name='imsi' doc='Identify subscriber by IMSI' />
726 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
727 <param name='id' doc='Identify subscriber by database ID' />
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]728 <param name='imei' doc='Identify subscriber by IMEI' />
729 <param name='IDENT' doc='IMSI/MSISDN/ID/IMEI of the subscriber' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]730 <param name='update' doc='Set or update subscriber data' />
731 <param name='msisdn' doc='Set MSISDN (phone number) of the subscriber' />
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]732 <param name='none' doc='Remove MSISDN (phone number)' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]733 <param name='MSISDN' doc='New MSISDN (phone number)' />
734 </params>
735 </command>
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]736 <command id='subscriber (imsi|msisdn|id|imei) IDENT update aud2g none'>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]737 <params>
738 <param name='subscriber' doc='Subscriber management commands' />
739 <param name='imsi' doc='Identify subscriber by IMSI' />
740 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
741 <param name='id' doc='Identify subscriber by database ID' />
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]742 <param name='imei' doc='Identify subscriber by IMEI' />
743 <param name='IDENT' doc='IMSI/MSISDN/ID/IMEI of the subscriber' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]744 <param name='update' doc='Set or update subscriber data' />
745 <param name='aud2g' doc='Set 2G authentication data' />
746 <param name='none' doc='Delete 2G authentication data' />
747 </params>
748 </command>
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]749 <command id='subscriber (imsi|msisdn|id|imei) IDENT update aud2g (comp128v1|comp128v2|comp128v3|xor) ki KI'>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]750 <params>
751 <param name='subscriber' doc='Subscriber management commands' />
752 <param name='imsi' doc='Identify subscriber by IMSI' />
753 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
754 <param name='id' doc='Identify subscriber by database ID' />
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]755 <param name='imei' doc='Identify subscriber by IMEI' />
756 <param name='IDENT' doc='IMSI/MSISDN/ID/IMEI of the subscriber' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]757 <param name='update' doc='Set or update subscriber data' />
758 <param name='aud2g' doc='Set 2G authentication data' />
759 <param name='comp128v1' doc='Use COMP128v1 algorithm' />
760 <param name='comp128v2' doc='Use COMP128v2 algorithm' />
761 <param name='comp128v3' doc='Use COMP128v3 algorithm' />
762 <param name='xor' doc='Use XOR algorithm' />
763 <param name='ki' doc='Set Ki Encryption Key' />
764 <param name='KI' doc='Ki as 32 hexadecimal characters' />
765 </params>
766 </command>
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]767 <command id='subscriber (imsi|msisdn|id|imei) IDENT update aud3g none'>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]768 <params>
769 <param name='subscriber' doc='Subscriber management commands' />
770 <param name='imsi' doc='Identify subscriber by IMSI' />
771 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
772 <param name='id' doc='Identify subscriber by database ID' />
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]773 <param name='imei' doc='Identify subscriber by IMEI' />
774 <param name='IDENT' doc='IMSI/MSISDN/ID/IMEI of the subscriber' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]775 <param name='update' doc='Set or update subscriber data' />
776 <param name='aud3g' doc='Set UMTS authentication data (3G, and 2G with UMTS AKA)' />
777 <param name='none' doc='Delete 3G authentication data' />
778 </params>
779 </command>
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]780 <command id='subscriber (imsi|msisdn|id|imei) IDENT update aud3g milenage k K (op|opc) OP_C [ind-bitlen] [&lt;0-28&gt;]'>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]781 <params>
782 <param name='subscriber' doc='Subscriber management commands' />
783 <param name='imsi' doc='Identify subscriber by IMSI' />
784 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
785 <param name='id' doc='Identify subscriber by database ID' />
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]786 <param name='imei' doc='Identify subscriber by IMEI' />
787 <param name='IDENT' doc='IMSI/MSISDN/ID/IMEI of the subscriber' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]788 <param name='update' doc='Set or update subscriber data' />
789 <param name='aud3g' doc='Set UMTS authentication data (3G, and 2G with UMTS AKA)' />
790 <param name='milenage' doc='Use Milenage algorithm' />
791 <param name='k' doc='Set Encryption Key K' />
792 <param name='K' doc='K as 32 hexadecimal characters' />
793 <param name='op' doc='Set OP key' />
794 <param name='opc' doc='Set OPC key' />
795 <param name='OP_C' doc='OP or OPC as 32 hexadecimal characters' />
796 <param name='[ind-bitlen]' doc='Set IND bit length' />
797 <param name='[&lt;0-28&gt;]' doc='IND bit length value (default: 5)' />
798 </params>
799 </command>
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]800 <command id='subscriber (imsi|msisdn|id|imei) IDENT update imei (none|IMEI)'>
801 <params>
802 <param name='subscriber' doc='Subscriber management commands' />
803 <param name='imsi' doc='Identify subscriber by IMSI' />
804 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
805 <param name='id' doc='Identify subscriber by database ID' />
806 <param name='imei' doc='Identify subscriber by IMEI' />
807 <param name='IDENT' doc='IMSI/MSISDN/ID/IMEI of the subscriber' />
808 <param name='update' doc='Set or update subscriber data' />
809 <param name='imei' doc='Set IMEI of the subscriber (normally populated from MSC, no need to set this manually)' />
810 <param name='none' doc='Forget IMEI' />
811 <param name='IMEI' doc='Set IMEI (use for debug only!)' />
812 </params>
813 </command>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]814 </node>
815 <node id='config'>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]816 <name>config</name>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]817 <command id='hostname WORD'>
818 <params>
819 <param name='hostname' doc='Set system&apos;s network name' />
820 <param name='WORD' doc='This system&apos;s network name' />
821 </params>
822 </command>
823 <command id='no hostname [HOSTNAME]'>
824 <params>
825 <param name='no' doc='Negate a command or set its defaults' />
826 <param name='hostname' doc='Reset system&apos;s network name' />
827 <param name='[HOSTNAME]' doc='Host name of this router' />
828 </params>
829 </command>
830 <command id='password (8|) WORD'>
831 <params>
832 <param name='password' doc='Assign the terminal connection password' />
833 <param name='8' doc='Specifies a HIDDEN password will follow' />
834 <param name='' doc='dummy string ' />
835 <param name='WORD' doc='The HIDDEN line password string' />
836 </params>
837 </command>
838 <command id='password LINE'>
839 <params>
840 <param name='password' doc='Assign the terminal connection password' />
841 <param name='LINE' doc='The UNENCRYPTED (cleartext) line password' />
842 </params>
843 </command>
844 <command id='enable password (8|) WORD'>
845 <params>
846 <param name='enable' doc='Modify enable password parameters' />
847 <param name='password' doc='Assign the privileged level password' />
848 <param name='8' doc='Specifies a HIDDEN password will follow' />
849 <param name='' doc='dummy string ' />
850 <param name='WORD' doc='The HIDDEN &apos;enable&apos; password string' />
851 </params>
852 </command>
853 <command id='enable password LINE'>
854 <params>
855 <param name='enable' doc='Modify enable password parameters' />
856 <param name='password' doc='Assign the privileged level password' />
857 <param name='LINE' doc='The UNENCRYPTED (cleartext) &apos;enable&apos; password' />
858 </params>
859 </command>
860 <command id='no enable password'>
861 <params>
862 <param name='no' doc='Negate a command or set its defaults' />
863 <param name='enable' doc='Modify enable password parameters' />
864 <param name='password' doc='Assign the privileged level password' />
865 </params>
866 </command>
867 <command id='banner motd default'>
868 <params>
869 <param name='banner' doc='Set banner string' />
870 <param name='motd' doc='Strings for motd' />
871 <param name='default' doc='Default string' />
872 </params>
873 </command>
874 <command id='banner motd file [FILE]'>
875 <params>
876 <param name='banner' doc='Set banner' />
877 <param name='motd' doc='Banner for motd' />
878 <param name='file' doc='Banner from a file' />
879 <param name='[FILE]' doc='Filename' />
880 </params>
881 </command>
882 <command id='no banner motd'>
883 <params>
884 <param name='no' doc='Negate a command or set its defaults' />
885 <param name='banner' doc='Set banner string' />
886 <param name='motd' doc='Strings for motd' />
887 </params>
888 </command>
889 <command id='service terminal-length &lt;0-512&gt;'>
890 <params>
891 <param name='service' doc='Set up miscellaneous service' />
892 <param name='terminal-length' doc='System wide terminal length configuration' />
893 <param name='&lt;0-512&gt;' doc='Number of lines of VTY (0 means no line control)' />
894 </params>
895 </command>
896 <command id='no service terminal-length [&lt;0-512&gt;]'>
897 <params>
898 <param name='no' doc='Negate a command or set its defaults' />
899 <param name='service' doc='Set up miscellaneous service' />
900 <param name='terminal-length' doc='System wide terminal length configuration' />
901 <param name='[&lt;0-512&gt;]' doc='Number of lines of VTY (0 means no line control)' />
902 </params>
903 </command>
904 <command id='line vty'>
905 <params>
906 <param name='line' doc='Configure a terminal line' />
907 <param name='vty' doc='Virtual terminal' />
908 </params>
909 </command>
910 <command id='service advanced-vty'>
911 <params>
912 <param name='service' doc='Set up miscellaneous service' />
913 <param name='advanced-vty' doc='Enable advanced mode vty interface' />
914 </params>
915 </command>
916 <command id='no service advanced-vty'>
917 <params>
918 <param name='no' doc='Negate a command or set its defaults' />
919 <param name='service' doc='Set up miscellaneous service' />
920 <param name='advanced-vty' doc='Enable advanced mode vty interface' />
921 </params>
922 </command>
923 <command id='show history'>
924 <params>
925 <param name='show' doc='Show running system information' />
926 <param name='history' doc='Display the session command history' />
927 </params>
928 </command>
929 <command id='ctrl'>
930 <params>
931 <param name='ctrl' doc='Configure the Control Interface' />
932 </params>
933 </command>
934 <command id='log stderr'>
935 <params>
936 <param name='log' doc='Configure logging sub-system' />
937 <param name='stderr' doc='Logging via STDERR of the process' />
938 </params>
939 </command>
940 <command id='no log stderr'>
941 <params>
942 <param name='no' doc='Negate a command or set its defaults' />
943 <param name='log' doc='Configure logging sub-system' />
944 <param name='stderr' doc='Logging via STDERR of the process' />
945 </params>
946 </command>
947 <command id='log file .FILENAME'>
948 <params>
949 <param name='log' doc='Configure logging sub-system' />
950 <param name='file' doc='Logging to text file' />
951 <param name='.FILENAME' doc='Filename' />
952 </params>
953 </command>
954 <command id='no log file .FILENAME'>
955 <params>
956 <param name='no' doc='Negate a command or set its defaults' />
957 <param name='log' doc='Configure logging sub-system' />
958 <param name='file' doc='Logging to text file' />
959 <param name='.FILENAME' doc='Filename' />
960 </params>
961 </command>
962 <command id='log alarms &lt;2-32700&gt;'>
963 <params>
964 <param name='log' doc='Configure logging sub-system' />
965 <param name='alarms' doc='Logging alarms to osmo_strrb' />
966 <param name='&lt;2-32700&gt;' doc='Maximum number of messages to log' />
967 </params>
968 </command>
969 <command id='no log alarms'>
970 <params>
971 <param name='no' doc='Negate a command or set its defaults' />
972 <param name='log' doc='Configure logging sub-system' />
973 <param name='alarms' doc='Logging alarms to osmo_strrb' />
974 </params>
975 </command>
976 <command id='log syslog (authpriv|cron|daemon|ftp|lpr|mail|news|user|uucp)'>
977 <params>
978 <param name='log' doc='Configure logging sub-system' />
979 <param name='syslog' doc='Logging via syslog' />
980 <param name='authpriv' doc='Security/authorization messages facility' />
981 <param name='cron' doc='Clock daemon (cron/at) facility' />
982 <param name='daemon' doc='General system daemon facility' />
983 <param name='ftp' doc='Ftp daemon facility' />
984 <param name='lpr' doc='Line printer facility' />
985 <param name='mail' doc='Mail facility' />
986 <param name='news' doc='News facility' />
987 <param name='user' doc='Generic facility' />
988 <param name='uucp' doc='UUCP facility' />
989 </params>
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]990 </command>
991 <command id='log syslog local &lt;0-7&gt;'>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]992 <params>
993 <param name='log' doc='Configure logging sub-system' />
994 <param name='syslog' doc='Logging via syslog' />
995 <param name='local' doc='Syslog LOCAL facility' />
996 <param name='&lt;0-7&gt;' doc='Local facility number' />
997 </params>
998 </command>
999 <command id='no log syslog'>
1000 <params>
1001 <param name='no' doc='Negate a command or set its defaults' />
1002 <param name='log' doc='Configure logging sub-system' />
1003 <param name='syslog' doc='Logging via syslog' />
1004 </params>
1005 </command>
1006 <command id='log gsmtap [HOSTNAME]'>
1007 <params>
1008 <param name='log' doc='Configure logging sub-system' />
1009 <param name='gsmtap' doc='Logging via GSMTAP' />
1010 <param name='[HOSTNAME]' doc='Host name to send the GSMTAP logging to (UDP port 4729)' />
1011 </params>
1012 </command>
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]1013 <command id='stats reporter statsd'>
1014 <params>
1015 <param name='stats' doc='Configure stats sub-system' />
1016 <param name='reporter' doc='Configure a stats reporter' />
1017 <param name='statsd' doc='Report to a STATSD server' />
1018 </params>
1019 </command>
1020 <command id='no stats reporter statsd'>
1021 <params>
1022 <param name='no' doc='Negate a command or set its defaults' />
1023 <param name='stats' doc='Configure stats sub-system' />
1024 <param name='reporter' doc='Configure a stats reporter' />
1025 <param name='statsd' doc='Report to a STATSD server' />
1026 </params>
1027 </command>
1028 <command id='stats reporter log'>
1029 <params>
1030 <param name='stats' doc='Configure stats sub-system' />
1031 <param name='reporter' doc='Configure a stats reporter' />
1032 <param name='log' doc='Report to the logger' />
1033 </params>
1034 </command>
1035 <command id='no stats reporter log'>
1036 <params>
1037 <param name='no' doc='Negate a command or set its defaults' />
1038 <param name='stats' doc='Configure stats sub-system' />
1039 <param name='reporter' doc='Configure a stats reporter' />
1040 <param name='log' doc='Report to the logger' />
1041 </params>
1042 </command>
1043 <command id='stats interval &lt;1-65535&gt;'>
1044 <params>
1045 <param name='stats' doc='Configure stats sub-system' />
1046 <param name='interval' doc='Set the reporting interval' />
1047 <param name='&lt;1-65535&gt;' doc='Interval in seconds' />
1048 </params>
1049 </command>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1050 <command id='hlr'>
1051 <params>
1052 <param name='hlr' doc='Configure the HLR' />
1053 </params>
1054 </command>
1055 </node>
1056 <node id='config-log'>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]1057 <name>config-log</name>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1058 <command id='logging filter all (0|1)'>
1059 <params>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]1060 <param name='logging' doc='Configure logging' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1061 <param name='filter' doc='Filter log messages' />
1062 <param name='all' doc='Do you want to log all messages?' />
1063 <param name='0' doc='Only print messages matched by other filters' />
1064 <param name='1' doc='Bypass filter and print all messages' />
1065 </params>
1066 </command>
1067 <command id='logging color (0|1)'>
1068 <params>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]1069 <param name='logging' doc='Configure logging' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1070 <param name='color' doc='Configure color-printing for log messages' />
1071 <param name='0' doc='Don&apos;t use color for printing messages' />
1072 <param name='1' doc='Use color for printing messages' />
1073 </params>
1074 </command>
1075 <command id='logging timestamp (0|1)'>
1076 <params>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]1077 <param name='logging' doc='Configure logging' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1078 <param name='timestamp' doc='Configure log message timestamping' />
1079 <param name='0' doc='Don&apos;t prefix each log message' />
1080 <param name='1' doc='Prefix each log message with current timestamp' />
1081 </params>
1082 </command>
1083 <command id='logging print extended-timestamp (0|1)'>
1084 <params>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]1085 <param name='logging' doc='Configure logging' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1086 <param name='print' doc='Log output settings' />
1087 <param name='extended-timestamp' doc='Configure log message timestamping' />
1088 <param name='0' doc='Don&apos;t prefix each log message' />
1089 <param name='1' doc='Prefix each log message with current timestamp with YYYYMMDDhhmmssnnn' />
1090 </params>
1091 </command>
1092 <command id='logging print category (0|1)'>
1093 <params>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]1094 <param name='logging' doc='Configure logging' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1095 <param name='print' doc='Log output settings' />
1096 <param name='category' doc='Configure log message' />
1097 <param name='0' doc='Don&apos;t prefix each log message' />
1098 <param name='1' doc='Prefix each log message with category/subsystem name' />
1099 </params>
1100 </command>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]1101 <command id='logging print category-hex (0|1)'>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1102 <params>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]1103 <param name='logging' doc='Configure logging' />
1104 <param name='print' doc='Log output settings' />
1105 <param name='category-hex' doc='Configure log message' />
1106 <param name='0' doc='Don&apos;t prefix each log message' />
1107 <param name='1' doc='Prefix each log message with category/subsystem nr in hex (&apos;&lt;000b&gt;&apos;)' />
1108 </params>
1109 </command>
1110 <command id='logging print level (0|1)'>
1111 <params>
1112 <param name='logging' doc='Configure logging' />
1113 <param name='print' doc='Log output settings' />
1114 <param name='level' doc='Configure log message' />
1115 <param name='0' doc='Don&apos;t prefix each log message' />
1116 <param name='1' doc='Prefix each log message with the log level name' />
1117 </params>
1118 </command>
Neels Hofmeyrbf6b4eb2018-11-05 03:18:46 +0100[diff] [blame]1119 <command id='logging print file (0|1|basename) [last]'>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]1120 <params>
1121 <param name='logging' doc='Configure logging' />
1122 <param name='print' doc='Log output settings' />
1123 <param name='file' doc='Configure log message' />
1124 <param name='0' doc='Don&apos;t prefix each log message' />
1125 <param name='1' doc='Prefix each log message with the source file and line' />
1126 <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]1127 <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]1128 </params>
1129 </command>
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]1130 <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|lrspro) (debug|info|notice|error|fatal)'>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]1131 <params>
1132 <param name='logging' doc='Configure logging' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1133 <param name='level' doc='Set the log level for a specified category' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1134 <param name='main' doc='Main Program' />
1135 <param name='db' doc='Database Layer' />
1136 <param name='auc' doc='Authentication Center' />
Neels Hofmeyrbf6b4eb2018-11-05 03:18:46 +0100[diff] [blame]1137 <param name='ss' doc='Supplementary Services' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1138 <param name='lglobal' doc='Library-internal global log family' />
1139 <param name='llapd' doc='LAPD in libosmogsm' />
1140 <param name='linp' doc='A-bis Intput Subsystem' />
1141 <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' />
1142 <param name='lmi' doc='A-bis Input Driver for Signalling' />
1143 <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' />
1144 <param name='lsms' doc='Layer3 Short Message Service (SMS)' />
1145 <param name='lctrl' doc='Control Interface' />
1146 <param name='lgtp' doc='GPRS GTP library' />
1147 <param name='lstats' doc='Statistics messages and logging' />
1148 <param name='lgsup' doc='Generic Subscriber Update Protocol' />
1149 <param name='loap' doc='Osmocom Authentication Protocol' />
1150 <param name='lss7' doc='libosmo-sigtran Signalling System 7' />
1151 <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' />
1152 <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' />
1153 <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' />
1154 <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' />
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]1155 <param name='ljibuf' doc='libosmo-netif Jitter Buffer' />
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]1156 <param name='lrspro' doc='Remote SIM protocol' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1157 <param name='debug' doc='Log debug messages and higher levels' />
1158 <param name='info' doc='Log informational messages and higher levels' />
1159 <param name='notice' doc='Log noticeable messages and higher levels' />
1160 <param name='error' doc='Log error messages and higher levels' />
1161 <param name='fatal' doc='Log only fatal messages' />
1162 </params>
1163 </command>
Neels Hofmeyrbf6b4eb2018-11-05 03:18:46 +0100[diff] [blame]1164 <command id='logging level set-all (debug|info|notice|error|fatal)'>
1165 <params>
1166 <param name='logging' doc='Configure logging' />
1167 <param name='level' doc='Set the log level for a specified category' />
1168 <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.' />
1169 <param name='debug' doc='Log debug messages and higher levels' />
1170 <param name='info' doc='Log informational messages and higher levels' />
1171 <param name='notice' doc='Log noticeable messages and higher levels' />
1172 <param name='error' doc='Log error messages and higher levels' />
1173 <param name='fatal' doc='Log only fatal messages' />
1174 </params>
1175 </command>
1176 <command id='logging level force-all (debug|info|notice|error|fatal)'>
1177 <params>
1178 <param name='logging' doc='Configure logging' />
1179 <param name='level' doc='Set the log level for a specified category' />
1180 <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.' />
1181 <param name='debug' doc='Log debug messages and higher levels' />
1182 <param name='info' doc='Log informational messages and higher levels' />
1183 <param name='notice' doc='Log noticeable messages and higher levels' />
1184 <param name='error' doc='Log error messages and higher levels' />
1185 <param name='fatal' doc='Log only fatal messages' />
1186 </params>
1187 </command>
1188 <command id='no logging level force-all'>
1189 <params>
1190 <param name='no' doc='Negate a command or set its defaults' />
1191 <param name='logging' doc='Configure logging' />
1192 <param name='level' doc='Set the log level for a specified category' />
1193 <param name='force-all' doc='Release any globally forced log level set with &apos;logging level force-all &lt;level&gt;&apos;' />
1194 </params>
1195 </command>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1196 </node>
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]1197 <node id='config-stats'>
1198 <name>config-stats</name>
1199 <command id='local-ip ADDR'>
1200 <params>
1201 <param name='local-ip' doc='Set the IP address to which we bind locally' />
1202 <param name='ADDR' doc='IP Address' />
1203 </params>
1204 </command>
1205 <command id='no local-ip'>
1206 <params>
1207 <param name='no' doc='Negate a command or set its defaults' />
1208 <param name='local-ip' doc='Set the IP address to which we bind locally' />
1209 </params>
1210 </command>
1211 <command id='remote-ip ADDR'>
1212 <params>
1213 <param name='remote-ip' doc='Set the remote IP address to which we connect' />
1214 <param name='ADDR' doc='IP Address' />
1215 </params>
1216 </command>
1217 <command id='remote-port &lt;1-65535&gt;'>
1218 <params>
1219 <param name='remote-port' doc='Set the remote port to which we connect' />
1220 <param name='&lt;1-65535&gt;' doc='Remote port number' />
1221 </params>
1222 </command>
1223 <command id='mtu &lt;100-65535&gt;'>
1224 <params>
1225 <param name='mtu' doc='Set the maximum packet size' />
1226 <param name='&lt;100-65535&gt;' doc='Size in byte' />
1227 </params>
1228 </command>
1229 <command id='no mtu'>
1230 <params>
1231 <param name='no' doc='Negate a command or set its defaults' />
1232 <param name='mtu' doc='Set the maximum packet size' />
1233 </params>
1234 </command>
1235 <command id='prefix PREFIX'>
1236 <params>
1237 <param name='prefix' doc='Set the item name prefix' />
1238 <param name='PREFIX' doc='The prefix string' />
1239 </params>
1240 </command>
1241 <command id='no prefix'>
1242 <params>
1243 <param name='no' doc='Negate a command or set its defaults' />
1244 <param name='prefix' doc='Set the item name prefix' />
1245 </params>
1246 </command>
1247 <command id='level (global|peer|subscriber)'>
1248 <params>
1249 <param name='level' doc='Set the maximum group level' />
1250 <param name='global' doc='Report global groups only' />
1251 <param name='peer' doc='Report global and network peer related groups' />
1252 <param name='subscriber' doc='Report global, peer, and subscriber groups' />
1253 </params>
1254 </command>
1255 <command id='enable'>
1256 <params>
1257 <param name='enable' doc='Enable the reporter' />
1258 </params>
1259 </command>
1260 <command id='disable'>
1261 <params>
1262 <param name='disable' doc='Disable the reporter' />
1263 </params>
1264 </command>
1265 </node>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1266 <node id='config-line'>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]1267 <name>config-line</name>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1268 <command id='login'>
1269 <params>
1270 <param name='login' doc='Enable password checking' />
1271 </params>
1272 </command>
1273 <command id='no login'>
1274 <params>
1275 <param name='no' doc='Negate a command or set its defaults' />
1276 <param name='login' doc='Enable password checking' />
1277 </params>
1278 </command>
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]1279 <command id='bind A.B.C.D [&lt;0-65535&gt;]'>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1280 <params>
1281 <param name='bind' doc='Accept VTY telnet connections on local interface' />
1282 <param name='A.B.C.D' doc='Local interface IP address (default: 127.0.0.1)' />
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]1283 <param name='[&lt;0-65535&gt;]' doc='Local TCP port number' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1284 </params>
1285 </command>
1286 </node>
1287 <node id='config-ctrl'>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]1288 <name>config-ctrl</name>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1289 <command id='bind A.B.C.D'>
1290 <params>
1291 <param name='bind' doc='Set bind address to listen for Control connections' />
1292 <param name='A.B.C.D' doc='Local IP address (default 127.0.0.1)' />
1293 </params>
1294 </command>
1295 </node>
1296 <node id='config-hlr'>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]1297 <name>config-hlr</name>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1298 <command id='gsup'>
1299 <params>
1300 <param name='gsup' doc='Configure GSUP options' />
1301 </params>
1302 </command>
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]1303 <command id='database PATH'>
1304 <params>
1305 <param name='database' doc='Set the path to the HLR database file' />
1306 <param name='PATH' doc='Relative or absolute file system path to the database file (default is &apos;hlr.db&apos;)' />
1307 </params>
1308 </command>
Neels Hofmeyrbf6b4eb2018-11-05 03:18:46 +0100[diff] [blame]1309 <command id='euse NAME'>
1310 <params>
1311 <param name='euse' doc='Configure a particular External USSD Entity' />
1312 <param name='NAME' doc='Alphanumeric name of the External USSD Entity' />
1313 </params>
1314 </command>
1315 <command id='no euse NAME'>
1316 <params>
1317 <param name='no' doc='Negate a command or set its defaults' />
1318 <param name='euse' doc='Remove a particular External USSD Entity' />
1319 <param name='NAME' doc='Alphanumeric name of the External USSD Entity' />
1320 </params>
1321 </command>
1322 <command id='ussd route prefix PREFIX internal (own-msisdn|own-imsi)'>
1323 <params>
1324 <param name='ussd' doc='USSD Configuration' />
1325 <param name='route' doc='Routing Configuration' />
1326 <param name='prefix' doc='Prefix-Matching Route' />
1327 <param name='PREFIX' doc='USSD Prefix' />
1328 <param name='internal' doc='Internal USSD Handler' />
1329 <param name='own-msisdn' doc='Respond with subscribers&apos; own MSISDN' />
1330 <param name='own-imsi' doc='Respond with subscribers&apos; own IMSI' />
1331 </params>
1332 </command>
1333 <command id='ussd route prefix PREFIX external EUSE'>
1334 <params>
1335 <param name='ussd' doc='USSD Configuration' />
1336 <param name='route' doc='Routing Configuration' />
1337 <param name='prefix' doc='Prefix-Matching Route' />
1338 <param name='PREFIX' doc='USSD Prefix' />
1339 <param name='external' doc='External USSD Handler' />
1340 <param name='EUSE' doc='Name of External USSD Handler (IPA CCM ID)' />
1341 </params>
1342 </command>
1343 <command id='no ussd route prefix PREFIX'>
1344 <params>
1345 <param name='no' doc='Negate a command or set its defaults' />
1346 <param name='ussd' doc='USSD Configuration' />
1347 <param name='route' doc='Routing Configuration' />
1348 <param name='prefix' doc='Prefix-Matching Route' />
1349 <param name='PREFIX' doc='USSD Prefix' />
1350 </params>
1351 </command>
1352 <command id='ussd default-route external EUSE'>
1353 <params>
1354 <param name='ussd' doc='USSD Configuration' />
1355 <param name='default-route' doc='Configure default-route for all USSD to unknown destinations' />
1356 <param name='external' doc='External USSD Handler' />
1357 <param name='EUSE' doc='Name of External USSD Handler (IPA CCM ID)' />
1358 </params>
1359 </command>
1360 <command id='no ussd default-route'>
1361 <params>
1362 <param name='no' doc='Negate a command or set its defaults' />
1363 <param name='ussd' doc='USSD Configuration' />
1364 <param name='default-route' doc='Remove the default-route for all USSD to unknown destinations' />
1365 </params>
1366 </command>
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]1367 <command id='ncss-guard-timeout &lt;0-255&gt;'>
1368 <params>
1369 <param name='ncss-guard-timeout' doc='Set guard timer for NCSS (call independent SS) session activity' />
1370 <param name='&lt;0-255&gt;' doc='Guard timer value (sec.), or 0 to disable' />
1371 </params>
1372 </command>
1373 <command id='store-imei'>
1374 <params>
1375 <param name='store-imei' doc='Save the IMEI in the database when receiving Check IMEI requests. Note that an MSC does not necessarily send Check IMEI requests (for OsmoMSC, you may want to set &apos;check-imei-rqd 1&apos;).' />
1376 </params>
1377 </command>
1378 <command id='no store-imei'>
1379 <params>
1380 <param name='no' doc='Do not save the IMEI in the database, when receiving Check IMEI requests.' />
1381 <param name='store-imei' doc='(null)' />
1382 </params>
1383 </command>
1384 <command id='subscriber-create-on-demand (no-msisdn|&lt;3-15&gt;) (none|cs|ps|cs+ps)'>
1385 <params>
1386 <param name='subscriber-create-on-demand' doc='Make a new record when a subscriber is first seen.' />
1387 <param name='no-msisdn' doc='Do not automatically assign MSISDN.' />
1388 <param name='&lt;3-15&gt;' doc='Length of an automatically assigned MSISDN.' />
1389 <param name='none' doc='Do not allow any NAM (Network Access Mode) by default.' />
1390 <param name='cs' doc='Allow access to circuit switched NAM by default.' />
1391 <param name='ps' doc='Allow access to packet switched NAM by default.' />
1392 <param name='cs+ps' doc='Allow access to circuit and packet switched NAM by default.' />
1393 </params>
1394 </command>
1395 <command id='no subscriber-create-on-demand'>
1396 <params>
1397 <param name='no' doc='Do not make a new record when a subscriber is first seen.' />
1398 <param name='subscriber-create-on-demand' doc='(null)' />
1399 </params>
1400 </command>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1401 </node>
1402 <node id='config-hlr-gsup'>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]1403 <name>config-hlr-gsup</name>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1404 <command id='bind ip A.B.C.D'>
1405 <params>
1406 <param name='bind' doc='Listen/Bind related socket option' />
1407 <param name='ip' doc='IP information' />
1408 <param name='A.B.C.D' doc='IPv4 Address to bind the GSUP interface to' />
1409 </params>
1410 </command>
1411 </node>
Neels Hofmeyrbf6b4eb2018-11-05 03:18:46 +0100[diff] [blame]1412 <node id='config-hlr-euse'>
1413 <name>config-hlr-euse</name>
1414 </node>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1415</vtydoc>