Gitiles
Code Review Sign In
gerrit.osmocom.org / osmo-hlr / 2bd1a4555323116faf75039351e37e46d5b18611 / . / doc / manuals / vty / hlr_vty_reference.xml
blob: 7a9eb03ad825288d3c399f1aa5c988c6e8471ae9 [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>
Pau Espin Pedrolf464fff2020-08-18 12:50:21 +0200[diff] [blame]21 <command id='write file [PATH]'>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]22 <params>
23 <param name='write' doc='Write running configuration to memory, network, or terminal' />
24 <param name='file' doc='Write to configuration file' />
Pau Espin Pedrolf464fff2020-08-18 12:50:21 +0200[diff] [blame]25 <param name='[PATH]' doc='Set file path to store the config, or replace if already exists' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]26 </params>
27 </command>
28 <command id='write memory'>
29 <params>
30 <param name='write' doc='Write running configuration to memory, network, or terminal' />
31 <param name='memory' doc='Write configuration to the file (same as write file)' />
32 </params>
33 </command>
34 <command id='write'>
35 <params>
36 <param name='write' doc='Write running configuration to memory, network, or terminal' />
37 </params>
38 </command>
39 <command id='show running-config'>
40 <params>
41 <param name='show' doc='Show running system information' />
42 <param name='running-config' doc='running configuration' />
43 </params>
44 </command>
45 <command id='exit'>
46 <params>
47 <param name='exit' doc='Exit current mode and down to previous mode' />
48 </params>
49 </command>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]50 <command id='end'>
51 <params>
52 <param name='end' doc='End current mode and change to enable mode.' />
53 </params>
54 </command>
55 </node>
56 <node id='view'>
57 <name>view</name>
58 <command id='show version'>
59 <params>
60 <param name='show' doc='Show running system information' />
61 <param name='version' doc='Displays program version' />
62 </params>
63 </command>
64 <command id='show online-help'>
65 <params>
66 <param name='show' doc='Show running system information' />
67 <param name='online-help' doc='Online help' />
68 </params>
69 </command>
70 <command id='enable'>
71 <params>
72 <param name='enable' doc='Turn on privileged mode command' />
73 </params>
74 </command>
75 <command id='terminal length &lt;0-512&gt;'>
76 <params>
77 <param name='terminal' doc='Set terminal line parameters' />
78 <param name='length' doc='Set number of lines on a screen' />
79 <param name='&lt;0-512&gt;' doc='Number of lines on screen (0 for no pausing)' />
80 </params>
81 </command>
82 <command id='terminal no length'>
83 <params>
84 <param name='terminal' doc='Set terminal line parameters' />
85 <param name='no' doc='Negate a command or set its defaults' />
86 <param name='length' doc='Set number of lines on a screen' />
87 </params>
88 </command>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]89 <command id='who'>
90 <params>
91 <param name='who' doc='Display who is on vty' />
92 </params>
93 </command>
94 <command id='show history'>
95 <params>
96 <param name='show' doc='Show running system information' />
97 <param name='history' doc='Display the session command history' />
98 </params>
99 </command>
100 <command id='logging enable'>
101 <params>
102 <param name='logging' doc='Configure logging' />
103 <param name='enable' doc='Enables logging to this vty' />
104 </params>
105 </command>
106 <command id='logging disable'>
107 <params>
108 <param name='logging' doc='Configure logging' />
109 <param name='disable' doc='Disables logging to this vty' />
110 </params>
111 </command>
112 <command id='logging filter all (0|1)'>
113 <params>
114 <param name='logging' doc='Configure logging' />
115 <param name='filter' doc='Filter log messages' />
116 <param name='all' doc='Do you want to log all messages?' />
117 <param name='0' doc='Only print messages matched by other filters' />
118 <param name='1' doc='Bypass filter and print all messages' />
119 </params>
120 </command>
121 <command id='logging color (0|1)'>
122 <params>
123 <param name='logging' doc='Configure logging' />
124 <param name='color' doc='Configure color-printing for log messages' />
125 <param name='0' doc='Don&apos;t use color for printing messages' />
126 <param name='1' doc='Use color for printing messages' />
127 </params>
128 </command>
129 <command id='logging timestamp (0|1)'>
130 <params>
131 <param name='logging' doc='Configure logging' />
132 <param name='timestamp' doc='Configure log message timestamping' />
133 <param name='0' doc='Don&apos;t prefix each log message' />
134 <param name='1' doc='Prefix each log message with current timestamp' />
135 </params>
136 </command>
137 <command id='logging print extended-timestamp (0|1)'>
138 <params>
139 <param name='logging' doc='Configure logging' />
140 <param name='print' doc='Log output settings' />
141 <param name='extended-timestamp' doc='Configure log message timestamping' />
142 <param name='0' doc='Don&apos;t prefix each log message' />
143 <param name='1' doc='Prefix each log message with current timestamp with YYYYMMDDhhmmssnnn' />
144 </params>
145 </command>
146 <command id='logging print category (0|1)'>
147 <params>
148 <param name='logging' doc='Configure logging' />
149 <param name='print' doc='Log output settings' />
150 <param name='category' doc='Configure log message' />
151 <param name='0' doc='Don&apos;t prefix each log message' />
152 <param name='1' doc='Prefix each log message with category/subsystem name' />
153 </params>
154 </command>
155 <command id='logging print category-hex (0|1)'>
156 <params>
157 <param name='logging' doc='Configure logging' />
158 <param name='print' doc='Log output settings' />
159 <param name='category-hex' doc='Configure log message' />
160 <param name='0' doc='Don&apos;t prefix each log message' />
161 <param name='1' doc='Prefix each log message with category/subsystem nr in hex (&apos;&lt;000b&gt;&apos;)' />
162 </params>
163 </command>
164 <command id='logging print level (0|1)'>
165 <params>
166 <param name='logging' doc='Configure logging' />
167 <param name='print' doc='Log output settings' />
168 <param name='level' doc='Configure log message' />
169 <param name='0' doc='Don&apos;t prefix each log message' />
170 <param name='1' doc='Prefix each log message with the log level name' />
171 </params>
172 </command>
Neels Hofmeyrbf6b4eb2018-11-05 03:18:46 +0100[diff] [blame]173 <command id='logging print file (0|1|basename) [last]'>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]174 <params>
175 <param name='logging' doc='Configure logging' />
176 <param name='print' doc='Log output settings' />
177 <param name='file' doc='Configure log message' />
178 <param name='0' doc='Don&apos;t prefix each log message' />
179 <param name='1' doc='Prefix each log message with the source file and line' />
180 <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]181 <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]182 </params>
183 </command>
184 <command id='logging set-log-mask MASK'>
185 <params>
186 <param name='logging' doc='Configure logging' />
187 <param name='set-log-mask' doc='Set the logmask of this logging target' />
188 <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' />
189 </params>
190 </command>
Pau Espin Pedrolf464fff2020-08-18 12:50:21 +0200[diff] [blame]191 <command id='logging level (main|db|auc|ss|mslookup|lu|dgsm|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]192 <params>
193 <param name='logging' doc='Configure logging' />
194 <param name='level' doc='Set the log level for a specified category' />
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]195 <param name='main' doc='Main Program' />
196 <param name='db' doc='Database Layer' />
197 <param name='auc' doc='Authentication Center' />
Neels Hofmeyrbf6b4eb2018-11-05 03:18:46 +0100[diff] [blame]198 <param name='ss' doc='Supplementary Services' />
Pau Espin Pedrolf464fff2020-08-18 12:50:21 +0200[diff] [blame]199 <param name='mslookup' doc='Mobile Subscriber Lookup' />
200 <param name='lu' doc='Location Updating' />
201 <param name='dgsm' doc='Distributed GSM: MS lookup and proxy' />
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]202 <param name='lglobal' doc='Library-internal global log family' />
203 <param name='llapd' doc='LAPD in libosmogsm' />
204 <param name='linp' doc='A-bis Intput Subsystem' />
205 <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' />
206 <param name='lmi' doc='A-bis Input Driver for Signalling' />
207 <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' />
208 <param name='lsms' doc='Layer3 Short Message Service (SMS)' />
209 <param name='lctrl' doc='Control Interface' />
210 <param name='lgtp' doc='GPRS GTP library' />
211 <param name='lstats' doc='Statistics messages and logging' />
212 <param name='lgsup' doc='Generic Subscriber Update Protocol' />
213 <param name='loap' doc='Osmocom Authentication Protocol' />
214 <param name='lss7' doc='libosmo-sigtran Signalling System 7' />
215 <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' />
216 <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' />
217 <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' />
218 <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' />
219 <param name='ljibuf' doc='libosmo-netif Jitter Buffer' />
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]220 <param name='lrspro' doc='Remote SIM protocol' />
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]221 <param name='debug' doc='Log debug messages and higher levels' />
222 <param name='info' doc='Log informational messages and higher levels' />
223 <param name='notice' doc='Log noticeable messages and higher levels' />
224 <param name='error' doc='Log error messages and higher levels' />
225 <param name='fatal' doc='Log only fatal messages' />
226 </params>
227 </command>
Neels Hofmeyrbf6b4eb2018-11-05 03:18:46 +0100[diff] [blame]228 <command id='logging level set-all (debug|info|notice|error|fatal)'>
229 <params>
230 <param name='logging' doc='Configure logging' />
231 <param name='level' doc='Set the log level for a specified category' />
232 <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.' />
233 <param name='debug' doc='Log debug messages and higher levels' />
234 <param name='info' doc='Log informational messages and higher levels' />
235 <param name='notice' doc='Log noticeable messages and higher levels' />
236 <param name='error' doc='Log error messages and higher levels' />
237 <param name='fatal' doc='Log only fatal messages' />
238 </params>
239 </command>
240 <command id='logging level force-all (debug|info|notice|error|fatal)'>
241 <params>
242 <param name='logging' doc='Configure logging' />
243 <param name='level' doc='Set the log level for a specified category' />
244 <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.' />
245 <param name='debug' doc='Log debug messages and higher levels' />
246 <param name='info' doc='Log informational messages and higher levels' />
247 <param name='notice' doc='Log noticeable messages and higher levels' />
248 <param name='error' doc='Log error messages and higher levels' />
249 <param name='fatal' doc='Log only fatal messages' />
250 </params>
251 </command>
252 <command id='no logging level force-all'>
253 <params>
254 <param name='no' doc='Negate a command or set its defaults' />
255 <param name='logging' doc='Configure logging' />
256 <param name='level' doc='Set the log level for a specified category' />
257 <param name='force-all' doc='Release any globally forced log level set with &apos;logging level force-all &lt;level&gt;&apos;' />
258 </params>
259 </command>
Pau Espin Pedrolf464fff2020-08-18 12:50:21 +0200[diff] [blame]260 <command id='logp (main|db|auc|ss|mslookup|lu|dgsm|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro) (debug|info|notice|error|fatal) .LOGMESSAGE'>
261 <params>
262 <param name='logp' doc='Print a message on all log outputs; useful for placing markers in test logs' />
263 <param name='main' doc='Main Program' />
264 <param name='db' doc='Database Layer' />
265 <param name='auc' doc='Authentication Center' />
266 <param name='ss' doc='Supplementary Services' />
267 <param name='mslookup' doc='Mobile Subscriber Lookup' />
268 <param name='lu' doc='Location Updating' />
269 <param name='dgsm' doc='Distributed GSM: MS lookup and proxy' />
270 <param name='lglobal' doc='Library-internal global log family' />
271 <param name='llapd' doc='LAPD in libosmogsm' />
272 <param name='linp' doc='A-bis Intput Subsystem' />
273 <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' />
274 <param name='lmi' doc='A-bis Input Driver for Signalling' />
275 <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' />
276 <param name='lsms' doc='Layer3 Short Message Service (SMS)' />
277 <param name='lctrl' doc='Control Interface' />
278 <param name='lgtp' doc='GPRS GTP library' />
279 <param name='lstats' doc='Statistics messages and logging' />
280 <param name='lgsup' doc='Generic Subscriber Update Protocol' />
281 <param name='loap' doc='Osmocom Authentication Protocol' />
282 <param name='lss7' doc='libosmo-sigtran Signalling System 7' />
283 <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' />
284 <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' />
285 <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' />
286 <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' />
287 <param name='ljibuf' doc='libosmo-netif Jitter Buffer' />
288 <param name='lrspro' doc='Remote SIM protocol' />
289 <param name='debug' doc='Log debug messages and higher levels' />
290 <param name='info' doc='Log informational messages and higher levels' />
291 <param name='notice' doc='Log noticeable messages and higher levels' />
292 <param name='error' doc='Log error messages and higher levels' />
293 <param name='fatal' doc='Log only fatal messages' />
294 <param name='.LOGMESSAGE' doc='Arbitrary message to log on given category and log level' />
295 </params>
296 </command>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]297 <command id='show logging vty'>
298 <params>
299 <param name='show' doc='Show running system information' />
300 <param name='logging' doc='Show current logging configuration' />
301 <param name='vty' doc='Show current logging configuration for this vty' />
302 </params>
303 </command>
304 <command id='show alarms'>
305 <params>
306 <param name='show' doc='Show running system information' />
307 <param name='alarms' doc='Show current logging configuration' />
308 </params>
309 </command>
310 <command id='show talloc-context (application|all) (full|brief|DEPTH)'>
311 <params>
312 <param name='show' doc='Show running system information' />
313 <param name='talloc-context' doc='Show talloc memory hierarchy' />
314 <param name='application' doc='Application&apos;s context' />
315 <param name='all' doc='All contexts, if NULL-context tracking is enabled' />
316 <param name='full' doc='Display a full talloc memory hierarchy' />
317 <param name='brief' doc='Display a brief talloc memory hierarchy' />
318 <param name='DEPTH' doc='Specify required maximal depth value' />
319 </params>
320 </command>
321 <command id='show talloc-context (application|all) (full|brief|DEPTH) tree ADDRESS'>
322 <params>
323 <param name='show' doc='Show running system information' />
324 <param name='talloc-context' doc='Show talloc memory hierarchy' />
325 <param name='application' doc='Application&apos;s context' />
326 <param name='all' doc='All contexts, if NULL-context tracking is enabled' />
327 <param name='full' doc='Display a full talloc memory hierarchy' />
328 <param name='brief' doc='Display a brief talloc memory hierarchy' />
329 <param name='DEPTH' doc='Specify required maximal depth value' />
330 <param name='tree' doc='Display only a specific memory chunk' />
331 <param name='ADDRESS' doc='Chunk address (e.g. 0xdeadbeef)' />
332 </params>
333 </command>
334 <command id='show talloc-context (application|all) (full|brief|DEPTH) filter REGEXP'>
335 <params>
336 <param name='show' doc='Show running system information' />
337 <param name='talloc-context' doc='Show talloc memory hierarchy' />
338 <param name='application' doc='Application&apos;s context' />
339 <param name='all' doc='All contexts, if NULL-context tracking is enabled' />
340 <param name='full' doc='Display a full talloc memory hierarchy' />
341 <param name='brief' doc='Display a brief talloc memory hierarchy' />
342 <param name='DEPTH' doc='Specify required maximal depth value' />
343 <param name='filter' doc='Filter chunks using regular expression' />
344 <param name='REGEXP' doc='Regular expression' />
345 </params>
346 </command>
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]347 <command id='show stats'>
348 <params>
349 <param name='show' doc='Show running system information' />
350 <param name='stats' doc='Show statistical values' />
351 </params>
352 </command>
353 <command id='show stats level (global|peer|subscriber)'>
354 <params>
355 <param name='show' doc='Show running system information' />
356 <param name='stats' doc='Show statistical values' />
357 <param name='level' doc='Set the maximum group level' />
358 <param name='global' doc='Show global groups only' />
359 <param name='peer' doc='Show global and network peer related groups' />
360 <param name='subscriber' doc='Show global, peer, and subscriber groups' />
361 </params>
362 </command>
363 <command id='show asciidoc counters'>
364 <params>
365 <param name='show' doc='Show running system information' />
366 <param name='asciidoc' doc='Asciidoc generation' />
367 <param name='counters' doc='Generate table of all registered counters' />
368 </params>
369 </command>
370 <command id='show rate-counters'>
371 <params>
372 <param name='show' doc='Show running system information' />
373 <param name='rate-counters' doc='Show all rate counters' />
374 </params>
375 </command>
Neels Hofmeyrbf6b4eb2018-11-05 03:18:46 +0100[diff] [blame]376 <command id='show gsup-connections'>
377 <params>
378 <param name='show' doc='Show running system information' />
379 <param name='gsup-connections' doc='GSUP Connections from VLRs, SGSNs, EUSEs' />
380 </params>
381 </command>
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]382 <command id='subscriber (imsi|msisdn|id|imei) IDENT show'>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]383 <params>
384 <param name='subscriber' doc='Subscriber management commands' />
385 <param name='imsi' doc='Identify subscriber by IMSI' />
386 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
387 <param name='id' doc='Identify subscriber by database ID' />
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]388 <param name='imei' doc='Identify subscriber by IMEI' />
389 <param name='IDENT' doc='IMSI/MSISDN/ID/IMEI of the subscriber' />
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]390 <param name='show' doc='Show subscriber information' />
391 </params>
392 </command>
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]393 <command id='show subscriber (imsi|msisdn|id|imei) IDENT'>
394 <params>
395 <param name='show' doc='Show running system information' />
396 <param name='subscriber' doc='Subscriber management commands' />
397 <param name='imsi' doc='Identify subscriber by IMSI' />
398 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
399 <param name='id' doc='Identify subscriber by database ID' />
400 <param name='imei' doc='Identify subscriber by IMEI' />
401 <param name='IDENT' doc='IMSI/MSISDN/ID/IMEI of the subscriber' />
402 </params>
403 </command>
Pau Espin Pedrolf464fff2020-08-18 12:50:21 +0200[diff] [blame]404 <command id='show mslookup services'>
405 <params>
406 <param name='show' doc='Show running system information' />
407 <param name='mslookup' doc='Distributed GSM / mslookup related information' />
408 <param name='services' doc='List configured service addresses as sent to remote mslookup requests' />
409 </params>
410 </command>
Pau Espin Pedroled18fa92020-08-18 12:58:36 +0200[diff] [blame]411 <command id='show cpu-sched threads'>
412 <params>
413 <param name='show' doc='Show running system information' />
414 <param name='cpu-sched' doc='Show Sched section information' />
415 <param name='threads' doc='Show information about running threads)' />
416 </params>
417 </command>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]418 </node>
419 <node id='enable'>
420 <name>enable</name>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]421 <command id='disable'>
422 <params>
423 <param name='disable' doc='Turn off privileged mode command' />
424 </params>
425 </command>
426 <command id='configure terminal'>
427 <params>
428 <param name='configure' doc='Configuration from vty interface' />
429 <param name='terminal' doc='Configuration terminal' />
430 </params>
431 </command>
432 <command id='copy running-config startup-config'>
433 <params>
434 <param name='copy' doc='Copy configuration' />
435 <param name='running-config' doc='Copy running config to... ' />
436 <param name='startup-config' doc='Copy running config to startup config (same as write file)' />
437 </params>
438 </command>
439 <command id='show startup-config'>
440 <params>
441 <param name='show' doc='Show running system information' />
442 <param name='startup-config' doc='Contentes of startup configuration' />
443 </params>
444 </command>
445 <command id='show version'>
446 <params>
447 <param name='show' doc='Show running system information' />
448 <param name='version' doc='Displays program version' />
449 </params>
450 </command>
451 <command id='show online-help'>
452 <params>
453 <param name='show' doc='Show running system information' />
454 <param name='online-help' doc='Online help' />
455 </params>
456 </command>
457 <command id='terminal length &lt;0-512&gt;'>
458 <params>
459 <param name='terminal' doc='Set terminal line parameters' />
460 <param name='length' doc='Set number of lines on a screen' />
461 <param name='&lt;0-512&gt;' doc='Number of lines on screen (0 for no pausing)' />
462 </params>
463 </command>
464 <command id='terminal no length'>
465 <params>
466 <param name='terminal' doc='Set terminal line parameters' />
467 <param name='no' doc='Negate a command or set its defaults' />
468 <param name='length' doc='Set number of lines on a screen' />
469 </params>
470 </command>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]471 <command id='who'>
472 <params>
473 <param name='who' doc='Display who is on vty' />
474 </params>
475 </command>
476 <command id='show history'>
477 <params>
478 <param name='show' doc='Show running system information' />
479 <param name='history' doc='Display the session command history' />
480 </params>
481 </command>
482 <command id='terminal monitor'>
483 <params>
484 <param name='terminal' doc='Set terminal line parameters' />
485 <param name='monitor' doc='Copy debug output to the current terminal line' />
486 </params>
487 </command>
488 <command id='terminal no monitor'>
489 <params>
490 <param name='terminal' doc='Set terminal line parameters' />
491 <param name='no' doc='Negate a command or set its defaults' />
492 <param name='monitor' doc='Copy debug output to the current terminal line' />
493 </params>
494 </command>
495 <command id='logging enable'>
496 <params>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]497 <param name='logging' doc='Configure logging' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]498 <param name='enable' doc='Enables logging to this vty' />
499 </params>
500 </command>
501 <command id='logging disable'>
502 <params>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]503 <param name='logging' doc='Configure logging' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]504 <param name='disable' doc='Disables logging to this vty' />
505 </params>
506 </command>
507 <command id='logging filter all (0|1)'>
508 <params>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]509 <param name='logging' doc='Configure logging' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]510 <param name='filter' doc='Filter log messages' />
511 <param name='all' doc='Do you want to log all messages?' />
512 <param name='0' doc='Only print messages matched by other filters' />
513 <param name='1' doc='Bypass filter and print all messages' />
514 </params>
515 </command>
516 <command id='logging color (0|1)'>
517 <params>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]518 <param name='logging' doc='Configure logging' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]519 <param name='color' doc='Configure color-printing for log messages' />
520 <param name='0' doc='Don&apos;t use color for printing messages' />
521 <param name='1' doc='Use color for printing messages' />
522 </params>
523 </command>
524 <command id='logging timestamp (0|1)'>
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='timestamp' doc='Configure log message timestamping' />
528 <param name='0' doc='Don&apos;t prefix each log message' />
529 <param name='1' doc='Prefix each log message with current timestamp' />
530 </params>
531 </command>
532 <command id='logging print extended-timestamp (0|1)'>
533 <params>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]534 <param name='logging' doc='Configure logging' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]535 <param name='print' doc='Log output settings' />
536 <param name='extended-timestamp' doc='Configure log message timestamping' />
537 <param name='0' doc='Don&apos;t prefix each log message' />
538 <param name='1' doc='Prefix each log message with current timestamp with YYYYMMDDhhmmssnnn' />
539 </params>
540 </command>
541 <command id='logging print category (0|1)'>
542 <params>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]543 <param name='logging' doc='Configure logging' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]544 <param name='print' doc='Log output settings' />
545 <param name='category' doc='Configure log message' />
546 <param name='0' doc='Don&apos;t prefix each log message' />
547 <param name='1' doc='Prefix each log message with category/subsystem name' />
548 </params>
549 </command>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]550 <command id='logging print category-hex (0|1)'>
551 <params>
552 <param name='logging' doc='Configure logging' />
553 <param name='print' doc='Log output settings' />
554 <param name='category-hex' doc='Configure log message' />
555 <param name='0' doc='Don&apos;t prefix each log message' />
556 <param name='1' doc='Prefix each log message with category/subsystem nr in hex (&apos;&lt;000b&gt;&apos;)' />
557 </params>
558 </command>
559 <command id='logging print level (0|1)'>
560 <params>
561 <param name='logging' doc='Configure logging' />
562 <param name='print' doc='Log output settings' />
563 <param name='level' doc='Configure log message' />
564 <param name='0' doc='Don&apos;t prefix each log message' />
565 <param name='1' doc='Prefix each log message with the log level name' />
566 </params>
567 </command>
Neels Hofmeyrbf6b4eb2018-11-05 03:18:46 +0100[diff] [blame]568 <command id='logging print file (0|1|basename) [last]'>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]569 <params>
570 <param name='logging' doc='Configure logging' />
571 <param name='print' doc='Log output settings' />
572 <param name='file' doc='Configure log message' />
573 <param name='0' doc='Don&apos;t prefix each log message' />
574 <param name='1' doc='Prefix each log message with the source file and line' />
575 <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]576 <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]577 </params>
578 </command>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]579 <command id='logging set-log-mask MASK'>
580 <params>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]581 <param name='logging' doc='Configure logging' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]582 <param name='set-log-mask' doc='Set the logmask of this logging target' />
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]583 <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]584 </params>
585 </command>
Pau Espin Pedrolf464fff2020-08-18 12:50:21 +0200[diff] [blame]586 <command id='logging level (main|db|auc|ss|mslookup|lu|dgsm|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]587 <params>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]588 <param name='logging' doc='Configure logging' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]589 <param name='level' doc='Set the log level for a specified category' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]590 <param name='main' doc='Main Program' />
591 <param name='db' doc='Database Layer' />
592 <param name='auc' doc='Authentication Center' />
Neels Hofmeyrbf6b4eb2018-11-05 03:18:46 +0100[diff] [blame]593 <param name='ss' doc='Supplementary Services' />
Pau Espin Pedrolf464fff2020-08-18 12:50:21 +0200[diff] [blame]594 <param name='mslookup' doc='Mobile Subscriber Lookup' />
595 <param name='lu' doc='Location Updating' />
596 <param name='dgsm' doc='Distributed GSM: MS lookup and proxy' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]597 <param name='lglobal' doc='Library-internal global log family' />
598 <param name='llapd' doc='LAPD in libosmogsm' />
599 <param name='linp' doc='A-bis Intput Subsystem' />
600 <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' />
601 <param name='lmi' doc='A-bis Input Driver for Signalling' />
602 <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' />
603 <param name='lsms' doc='Layer3 Short Message Service (SMS)' />
604 <param name='lctrl' doc='Control Interface' />
605 <param name='lgtp' doc='GPRS GTP library' />
606 <param name='lstats' doc='Statistics messages and logging' />
607 <param name='lgsup' doc='Generic Subscriber Update Protocol' />
608 <param name='loap' doc='Osmocom Authentication Protocol' />
609 <param name='lss7' doc='libosmo-sigtran Signalling System 7' />
610 <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' />
611 <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' />
612 <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' />
613 <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' />
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]614 <param name='ljibuf' doc='libosmo-netif Jitter Buffer' />
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]615 <param name='lrspro' doc='Remote SIM protocol' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]616 <param name='debug' doc='Log debug messages and higher levels' />
617 <param name='info' doc='Log informational messages and higher levels' />
618 <param name='notice' doc='Log noticeable messages and higher levels' />
619 <param name='error' doc='Log error messages and higher levels' />
620 <param name='fatal' doc='Log only fatal messages' />
621 </params>
622 </command>
Neels Hofmeyrbf6b4eb2018-11-05 03:18:46 +0100[diff] [blame]623 <command id='logging level set-all (debug|info|notice|error|fatal)'>
624 <params>
Pau Espin Pedrolf464fff2020-08-18 12:50:21 +0200[diff] [blame]625 <param name='logging' doc='Configure logging' />
626 <param name='level' doc='Set the log level for a specified category' />
Neels Hofmeyrbf6b4eb2018-11-05 03:18:46 +0100[diff] [blame]627 <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.' />
628 <param name='debug' doc='Log debug messages and higher levels' />
629 <param name='info' doc='Log informational messages and higher levels' />
630 <param name='notice' doc='Log noticeable messages and higher levels' />
631 <param name='error' doc='Log error messages and higher levels' />
632 <param name='fatal' doc='Log only fatal messages' />
633 </params>
634 </command>
635 <command id='logging level force-all (debug|info|notice|error|fatal)'>
636 <params>
637 <param name='logging' doc='Configure logging' />
638 <param name='level' doc='Set the log level for a specified category' />
639 <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.' />
640 <param name='debug' doc='Log debug messages and higher levels' />
641 <param name='info' doc='Log informational messages and higher levels' />
642 <param name='notice' doc='Log noticeable messages and higher levels' />
643 <param name='error' doc='Log error messages and higher levels' />
644 <param name='fatal' doc='Log only fatal messages' />
645 </params>
646 </command>
647 <command id='no logging level force-all'>
648 <params>
649 <param name='no' doc='Negate a command or set its defaults' />
650 <param name='logging' doc='Configure logging' />
651 <param name='level' doc='Set the log level for a specified category' />
652 <param name='force-all' doc='Release any globally forced log level set with &apos;logging level force-all &lt;level&gt;&apos;' />
653 </params>
654 </command>
Pau Espin Pedrolf464fff2020-08-18 12:50:21 +0200[diff] [blame]655 <command id='logp (main|db|auc|ss|mslookup|lu|dgsm|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro) (debug|info|notice|error|fatal) .LOGMESSAGE'>
656 <params>
657 <param name='logp' doc='Print a message on all log outputs; useful for placing markers in test logs' />
658 <param name='main' doc='Main Program' />
659 <param name='db' doc='Database Layer' />
660 <param name='auc' doc='Authentication Center' />
661 <param name='ss' doc='Supplementary Services' />
662 <param name='mslookup' doc='Mobile Subscriber Lookup' />
663 <param name='lu' doc='Location Updating' />
664 <param name='dgsm' doc='Distributed GSM: MS lookup and proxy' />
665 <param name='lglobal' doc='Library-internal global log family' />
666 <param name='llapd' doc='LAPD in libosmogsm' />
667 <param name='linp' doc='A-bis Intput Subsystem' />
668 <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' />
669 <param name='lmi' doc='A-bis Input Driver for Signalling' />
670 <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' />
671 <param name='lsms' doc='Layer3 Short Message Service (SMS)' />
672 <param name='lctrl' doc='Control Interface' />
673 <param name='lgtp' doc='GPRS GTP library' />
674 <param name='lstats' doc='Statistics messages and logging' />
675 <param name='lgsup' doc='Generic Subscriber Update Protocol' />
676 <param name='loap' doc='Osmocom Authentication Protocol' />
677 <param name='lss7' doc='libosmo-sigtran Signalling System 7' />
678 <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' />
679 <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' />
680 <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' />
681 <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' />
682 <param name='ljibuf' doc='libosmo-netif Jitter Buffer' />
683 <param name='lrspro' doc='Remote SIM protocol' />
684 <param name='debug' doc='Log debug messages and higher levels' />
685 <param name='info' doc='Log informational messages and higher levels' />
686 <param name='notice' doc='Log noticeable messages and higher levels' />
687 <param name='error' doc='Log error messages and higher levels' />
688 <param name='fatal' doc='Log only fatal messages' />
689 <param name='.LOGMESSAGE' doc='Arbitrary message to log on given category and log level' />
690 </params>
691 </command>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]692 <command id='show logging vty'>
693 <params>
694 <param name='show' doc='Show running system information' />
695 <param name='logging' doc='Show current logging configuration' />
696 <param name='vty' doc='Show current logging configuration for this vty' />
697 </params>
698 </command>
699 <command id='show alarms'>
700 <params>
701 <param name='show' doc='Show running system information' />
702 <param name='alarms' doc='Show current logging configuration' />
703 </params>
704 </command>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]705 <command id='show talloc-context (application|all) (full|brief|DEPTH)'>
706 <params>
707 <param name='show' doc='Show running system information' />
708 <param name='talloc-context' doc='Show talloc memory hierarchy' />
709 <param name='application' doc='Application&apos;s context' />
710 <param name='all' doc='All contexts, if NULL-context tracking is enabled' />
711 <param name='full' doc='Display a full talloc memory hierarchy' />
712 <param name='brief' doc='Display a brief talloc memory hierarchy' />
713 <param name='DEPTH' doc='Specify required maximal depth value' />
714 </params>
715 </command>
716 <command id='show talloc-context (application|all) (full|brief|DEPTH) tree ADDRESS'>
717 <params>
718 <param name='show' doc='Show running system information' />
719 <param name='talloc-context' doc='Show talloc memory hierarchy' />
720 <param name='application' doc='Application&apos;s context' />
721 <param name='all' doc='All contexts, if NULL-context tracking is enabled' />
722 <param name='full' doc='Display a full talloc memory hierarchy' />
723 <param name='brief' doc='Display a brief talloc memory hierarchy' />
724 <param name='DEPTH' doc='Specify required maximal depth value' />
725 <param name='tree' doc='Display only a specific memory chunk' />
726 <param name='ADDRESS' doc='Chunk address (e.g. 0xdeadbeef)' />
727 </params>
728 </command>
729 <command id='show talloc-context (application|all) (full|brief|DEPTH) filter REGEXP'>
730 <params>
731 <param name='show' doc='Show running system information' />
732 <param name='talloc-context' doc='Show talloc memory hierarchy' />
733 <param name='application' doc='Application&apos;s context' />
734 <param name='all' doc='All contexts, if NULL-context tracking is enabled' />
735 <param name='full' doc='Display a full talloc memory hierarchy' />
736 <param name='brief' doc='Display a brief talloc memory hierarchy' />
737 <param name='DEPTH' doc='Specify required maximal depth value' />
738 <param name='filter' doc='Filter chunks using regular expression' />
739 <param name='REGEXP' doc='Regular expression' />
740 </params>
741 </command>
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]742 <command id='show stats'>
743 <params>
744 <param name='show' doc='Show running system information' />
745 <param name='stats' doc='Show statistical values' />
746 </params>
747 </command>
748 <command id='show stats level (global|peer|subscriber)'>
749 <params>
750 <param name='show' doc='Show running system information' />
751 <param name='stats' doc='Show statistical values' />
752 <param name='level' doc='Set the maximum group level' />
753 <param name='global' doc='Show global groups only' />
754 <param name='peer' doc='Show global and network peer related groups' />
755 <param name='subscriber' doc='Show global, peer, and subscriber groups' />
756 </params>
757 </command>
758 <command id='show asciidoc counters'>
759 <params>
760 <param name='show' doc='Show running system information' />
761 <param name='asciidoc' doc='Asciidoc generation' />
762 <param name='counters' doc='Generate table of all registered counters' />
763 </params>
764 </command>
765 <command id='show rate-counters'>
766 <params>
767 <param name='show' doc='Show running system information' />
768 <param name='rate-counters' doc='Show all rate counters' />
769 </params>
770 </command>
Pau Espin Pedrolf464fff2020-08-18 12:50:21 +0200[diff] [blame]771 <command id='stats report'>
772 <params>
773 <param name='stats' doc='Stats related commands' />
774 <param name='report' doc='Manurally trigger reporting of stats' />
775 </params>
776 </command>
777 <command id='stats reset'>
778 <params>
779 <param name='stats' doc='Stats related commands' />
780 <param name='reset' doc='Reset all stats' />
781 </params>
782 </command>
Neels Hofmeyrbf6b4eb2018-11-05 03:18:46 +0100[diff] [blame]783 <command id='show gsup-connections'>
784 <params>
785 <param name='show' doc='Show running system information' />
786 <param name='gsup-connections' doc='GSUP Connections from VLRs, SGSNs, EUSEs' />
787 </params>
788 </command>
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]789 <command id='subscriber (imsi|msisdn|id|imei) IDENT show'>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]790 <params>
791 <param name='subscriber' doc='Subscriber management commands' />
792 <param name='imsi' doc='Identify subscriber by IMSI' />
793 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
794 <param name='id' doc='Identify subscriber by database ID' />
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]795 <param name='imei' doc='Identify subscriber by IMEI' />
796 <param name='IDENT' doc='IMSI/MSISDN/ID/IMEI of the subscriber' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]797 <param name='show' doc='Show subscriber information' />
798 </params>
799 </command>
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]800 <command id='show subscriber (imsi|msisdn|id|imei) IDENT'>
801 <params>
802 <param name='show' doc='Show running system information' />
803 <param name='subscriber' doc='Subscriber management commands' />
804 <param name='imsi' doc='Identify subscriber by IMSI' />
805 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
806 <param name='id' doc='Identify subscriber by database ID' />
807 <param name='imei' doc='Identify subscriber by IMEI' />
808 <param name='IDENT' doc='IMSI/MSISDN/ID/IMEI of the subscriber' />
809 </params>
810 </command>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]811 <command id='subscriber imsi IDENT create'>
812 <params>
813 <param name='subscriber' doc='Subscriber management commands' />
Neels Hofmeyrbf6b4eb2018-11-05 03:18:46 +0100[diff] [blame]814 <param name='imsi' doc='Identify subscriber by IMSI' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]815 <param name='IDENT' doc='IMSI/MSISDN/ID of the subscriber' />
Neels Hofmeyrbf6b4eb2018-11-05 03:18:46 +0100[diff] [blame]816 <param name='create' doc='Create subscriber by IMSI' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]817 </params>
818 </command>
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]819 <command id='subscriber (imsi|msisdn|id|imei) IDENT delete'>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]820 <params>
821 <param name='subscriber' doc='Subscriber management commands' />
822 <param name='imsi' doc='Identify subscriber by IMSI' />
823 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
824 <param name='id' doc='Identify subscriber by database ID' />
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]825 <param name='imei' doc='Identify subscriber by IMEI' />
826 <param name='IDENT' doc='IMSI/MSISDN/ID/IMEI of the subscriber' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]827 <param name='delete' doc='Delete subscriber from database' />
828 </params>
829 </command>
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]830 <command id='subscriber (imsi|msisdn|id|imei) IDENT update msisdn (none|MSISDN)'>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]831 <params>
832 <param name='subscriber' doc='Subscriber management commands' />
833 <param name='imsi' doc='Identify subscriber by IMSI' />
834 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
835 <param name='id' doc='Identify subscriber by database ID' />
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]836 <param name='imei' doc='Identify subscriber by IMEI' />
837 <param name='IDENT' doc='IMSI/MSISDN/ID/IMEI of the subscriber' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]838 <param name='update' doc='Set or update subscriber data' />
839 <param name='msisdn' doc='Set MSISDN (phone number) of the subscriber' />
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]840 <param name='none' doc='Remove MSISDN (phone number)' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]841 <param name='MSISDN' doc='New MSISDN (phone number)' />
842 </params>
843 </command>
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]844 <command id='subscriber (imsi|msisdn|id|imei) IDENT update aud2g none'>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]845 <params>
846 <param name='subscriber' doc='Subscriber management commands' />
847 <param name='imsi' doc='Identify subscriber by IMSI' />
848 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
849 <param name='id' doc='Identify subscriber by database ID' />
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]850 <param name='imei' doc='Identify subscriber by IMEI' />
851 <param name='IDENT' doc='IMSI/MSISDN/ID/IMEI of the subscriber' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]852 <param name='update' doc='Set or update subscriber data' />
853 <param name='aud2g' doc='Set 2G authentication data' />
854 <param name='none' doc='Delete 2G authentication data' />
855 </params>
856 </command>
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]857 <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]858 <params>
859 <param name='subscriber' doc='Subscriber management commands' />
860 <param name='imsi' doc='Identify subscriber by IMSI' />
861 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
862 <param name='id' doc='Identify subscriber by database ID' />
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]863 <param name='imei' doc='Identify subscriber by IMEI' />
864 <param name='IDENT' doc='IMSI/MSISDN/ID/IMEI of the subscriber' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]865 <param name='update' doc='Set or update subscriber data' />
866 <param name='aud2g' doc='Set 2G authentication data' />
867 <param name='comp128v1' doc='Use COMP128v1 algorithm' />
868 <param name='comp128v2' doc='Use COMP128v2 algorithm' />
869 <param name='comp128v3' doc='Use COMP128v3 algorithm' />
870 <param name='xor' doc='Use XOR algorithm' />
871 <param name='ki' doc='Set Ki Encryption Key' />
872 <param name='KI' doc='Ki as 32 hexadecimal characters' />
873 </params>
874 </command>
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]875 <command id='subscriber (imsi|msisdn|id|imei) IDENT update aud3g none'>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]876 <params>
877 <param name='subscriber' doc='Subscriber management commands' />
878 <param name='imsi' doc='Identify subscriber by IMSI' />
879 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
880 <param name='id' doc='Identify subscriber by database ID' />
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]881 <param name='imei' doc='Identify subscriber by IMEI' />
882 <param name='IDENT' doc='IMSI/MSISDN/ID/IMEI of the subscriber' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]883 <param name='update' doc='Set or update subscriber data' />
884 <param name='aud3g' doc='Set UMTS authentication data (3G, and 2G with UMTS AKA)' />
885 <param name='none' doc='Delete 3G authentication data' />
886 </params>
887 </command>
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]888 <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]889 <params>
890 <param name='subscriber' doc='Subscriber management commands' />
891 <param name='imsi' doc='Identify subscriber by IMSI' />
892 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
893 <param name='id' doc='Identify subscriber by database ID' />
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]894 <param name='imei' doc='Identify subscriber by IMEI' />
895 <param name='IDENT' doc='IMSI/MSISDN/ID/IMEI of the subscriber' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]896 <param name='update' doc='Set or update subscriber data' />
897 <param name='aud3g' doc='Set UMTS authentication data (3G, and 2G with UMTS AKA)' />
898 <param name='milenage' doc='Use Milenage algorithm' />
899 <param name='k' doc='Set Encryption Key K' />
900 <param name='K' doc='K as 32 hexadecimal characters' />
901 <param name='op' doc='Set OP key' />
902 <param name='opc' doc='Set OPC key' />
903 <param name='OP_C' doc='OP or OPC as 32 hexadecimal characters' />
904 <param name='[ind-bitlen]' doc='Set IND bit length' />
905 <param name='[&lt;0-28&gt;]' doc='IND bit length value (default: 5)' />
906 </params>
907 </command>
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]908 <command id='subscriber (imsi|msisdn|id|imei) IDENT update imei (none|IMEI)'>
909 <params>
910 <param name='subscriber' doc='Subscriber management commands' />
911 <param name='imsi' doc='Identify subscriber by IMSI' />
912 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
913 <param name='id' doc='Identify subscriber by database ID' />
914 <param name='imei' doc='Identify subscriber by IMEI' />
915 <param name='IDENT' doc='IMSI/MSISDN/ID/IMEI of the subscriber' />
916 <param name='update' doc='Set or update subscriber data' />
917 <param name='imei' doc='Set IMEI of the subscriber (normally populated from MSC, no need to set this manually)' />
918 <param name='none' doc='Forget IMEI' />
919 <param name='IMEI' doc='Set IMEI (use for debug only!)' />
920 </params>
921 </command>
Oliver Smith3b33b012019-07-15 10:35:22 +0200[diff] [blame]922 <command id='subscriber (imsi|msisdn|id|imei) IDENT update network-access-mode (none|cs|ps|cs+ps)'>
923 <params>
924 <param name='subscriber' doc='Subscriber management commands' />
925 <param name='imsi' doc='Identify subscriber by IMSI' />
926 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
927 <param name='id' doc='Identify subscriber by database ID' />
928 <param name='imei' doc='Identify subscriber by IMEI' />
929 <param name='IDENT' doc='IMSI/MSISDN/ID/IMEI of the subscriber' />
930 <param name='update' doc='Set or update subscriber data' />
931 <param name='network-access-mode' doc='Set Network Access Mode (NAM) of the subscriber' />
932 <param name='none' doc='Do not allow access to circuit switched or packet switched services' />
933 <param name='cs' doc='Allow access to circuit switched services only' />
934 <param name='ps' doc='Allow access to packet switched services only' />
935 <param name='cs+ps' doc='Allow access to both circuit and packet switched services' />
936 </params>
937 </command>
Pau Espin Pedrolf464fff2020-08-18 12:50:21 +0200[diff] [blame]938 <command id='show mslookup services'>
939 <params>
940 <param name='show' doc='Show running system information' />
941 <param name='mslookup' doc='Distributed GSM / mslookup related information' />
942 <param name='services' doc='List configured service addresses as sent to remote mslookup requests' />
943 </params>
944 </command>
Pau Espin Pedroled18fa92020-08-18 12:58:36 +0200[diff] [blame]945 <command id='show cpu-sched threads'>
946 <params>
947 <param name='show' doc='Show running system information' />
948 <param name='cpu-sched' doc='Show Sched section information' />
949 <param name='threads' doc='Show information about running threads)' />
950 </params>
951 </command>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]952 </node>
953 <node id='config'>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]954 <name>config</name>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]955 <command id='hostname WORD'>
956 <params>
957 <param name='hostname' doc='Set system&apos;s network name' />
958 <param name='WORD' doc='This system&apos;s network name' />
959 </params>
960 </command>
961 <command id='no hostname [HOSTNAME]'>
962 <params>
963 <param name='no' doc='Negate a command or set its defaults' />
964 <param name='hostname' doc='Reset system&apos;s network name' />
965 <param name='[HOSTNAME]' doc='Host name of this router' />
966 </params>
967 </command>
968 <command id='password (8|) WORD'>
969 <params>
970 <param name='password' doc='Assign the terminal connection password' />
971 <param name='8' doc='Specifies a HIDDEN password will follow' />
972 <param name='' doc='dummy string ' />
973 <param name='WORD' doc='The HIDDEN line password string' />
974 </params>
975 </command>
976 <command id='password LINE'>
977 <params>
978 <param name='password' doc='Assign the terminal connection password' />
979 <param name='LINE' doc='The UNENCRYPTED (cleartext) line password' />
980 </params>
981 </command>
982 <command id='enable password (8|) WORD'>
983 <params>
984 <param name='enable' doc='Modify enable password parameters' />
985 <param name='password' doc='Assign the privileged level password' />
986 <param name='8' doc='Specifies a HIDDEN password will follow' />
987 <param name='' doc='dummy string ' />
988 <param name='WORD' doc='The HIDDEN &apos;enable&apos; password string' />
989 </params>
990 </command>
991 <command id='enable password LINE'>
992 <params>
993 <param name='enable' doc='Modify enable password parameters' />
994 <param name='password' doc='Assign the privileged level password' />
995 <param name='LINE' doc='The UNENCRYPTED (cleartext) &apos;enable&apos; password' />
996 </params>
997 </command>
998 <command id='no enable password'>
999 <params>
1000 <param name='no' doc='Negate a command or set its defaults' />
1001 <param name='enable' doc='Modify enable password parameters' />
1002 <param name='password' doc='Assign the privileged level password' />
1003 </params>
1004 </command>
1005 <command id='banner motd default'>
1006 <params>
1007 <param name='banner' doc='Set banner string' />
1008 <param name='motd' doc='Strings for motd' />
1009 <param name='default' doc='Default string' />
1010 </params>
1011 </command>
1012 <command id='banner motd file [FILE]'>
1013 <params>
1014 <param name='banner' doc='Set banner' />
1015 <param name='motd' doc='Banner for motd' />
1016 <param name='file' doc='Banner from a file' />
1017 <param name='[FILE]' doc='Filename' />
1018 </params>
1019 </command>
1020 <command id='no banner motd'>
1021 <params>
1022 <param name='no' doc='Negate a command or set its defaults' />
1023 <param name='banner' doc='Set banner string' />
1024 <param name='motd' doc='Strings for motd' />
1025 </params>
1026 </command>
1027 <command id='service terminal-length &lt;0-512&gt;'>
1028 <params>
1029 <param name='service' doc='Set up miscellaneous service' />
1030 <param name='terminal-length' doc='System wide terminal length configuration' />
1031 <param name='&lt;0-512&gt;' doc='Number of lines of VTY (0 means no line control)' />
1032 </params>
1033 </command>
1034 <command id='no service terminal-length [&lt;0-512&gt;]'>
1035 <params>
1036 <param name='no' doc='Negate a command or set its defaults' />
1037 <param name='service' doc='Set up miscellaneous service' />
1038 <param name='terminal-length' doc='System wide terminal length configuration' />
1039 <param name='[&lt;0-512&gt;]' doc='Number of lines of VTY (0 means no line control)' />
1040 </params>
1041 </command>
1042 <command id='line vty'>
1043 <params>
1044 <param name='line' doc='Configure a terminal line' />
1045 <param name='vty' doc='Virtual terminal' />
1046 </params>
1047 </command>
1048 <command id='service advanced-vty'>
1049 <params>
1050 <param name='service' doc='Set up miscellaneous service' />
1051 <param name='advanced-vty' doc='Enable advanced mode vty interface' />
1052 </params>
1053 </command>
1054 <command id='no service advanced-vty'>
1055 <params>
1056 <param name='no' doc='Negate a command or set its defaults' />
1057 <param name='service' doc='Set up miscellaneous service' />
1058 <param name='advanced-vty' doc='Enable advanced mode vty interface' />
1059 </params>
1060 </command>
1061 <command id='show history'>
1062 <params>
1063 <param name='show' doc='Show running system information' />
1064 <param name='history' doc='Display the session command history' />
1065 </params>
1066 </command>
1067 <command id='ctrl'>
1068 <params>
1069 <param name='ctrl' doc='Configure the Control Interface' />
1070 </params>
1071 </command>
1072 <command id='log stderr'>
1073 <params>
1074 <param name='log' doc='Configure logging sub-system' />
1075 <param name='stderr' doc='Logging via STDERR of the process' />
1076 </params>
1077 </command>
1078 <command id='no log stderr'>
1079 <params>
1080 <param name='no' doc='Negate a command or set its defaults' />
1081 <param name='log' doc='Configure logging sub-system' />
1082 <param name='stderr' doc='Logging via STDERR of the process' />
1083 </params>
1084 </command>
1085 <command id='log file .FILENAME'>
1086 <params>
1087 <param name='log' doc='Configure logging sub-system' />
1088 <param name='file' doc='Logging to text file' />
1089 <param name='.FILENAME' doc='Filename' />
1090 </params>
1091 </command>
1092 <command id='no log file .FILENAME'>
1093 <params>
1094 <param name='no' doc='Negate a command or set its defaults' />
1095 <param name='log' doc='Configure logging sub-system' />
1096 <param name='file' doc='Logging to text file' />
1097 <param name='.FILENAME' doc='Filename' />
1098 </params>
1099 </command>
1100 <command id='log alarms &lt;2-32700&gt;'>
1101 <params>
1102 <param name='log' doc='Configure logging sub-system' />
1103 <param name='alarms' doc='Logging alarms to osmo_strrb' />
1104 <param name='&lt;2-32700&gt;' doc='Maximum number of messages to log' />
1105 </params>
1106 </command>
1107 <command id='no log alarms'>
1108 <params>
1109 <param name='no' doc='Negate a command or set its defaults' />
1110 <param name='log' doc='Configure logging sub-system' />
1111 <param name='alarms' doc='Logging alarms to osmo_strrb' />
1112 </params>
1113 </command>
1114 <command id='log syslog (authpriv|cron|daemon|ftp|lpr|mail|news|user|uucp)'>
1115 <params>
1116 <param name='log' doc='Configure logging sub-system' />
1117 <param name='syslog' doc='Logging via syslog' />
1118 <param name='authpriv' doc='Security/authorization messages facility' />
1119 <param name='cron' doc='Clock daemon (cron/at) facility' />
1120 <param name='daemon' doc='General system daemon facility' />
1121 <param name='ftp' doc='Ftp daemon facility' />
1122 <param name='lpr' doc='Line printer facility' />
1123 <param name='mail' doc='Mail facility' />
1124 <param name='news' doc='News facility' />
1125 <param name='user' doc='Generic facility' />
1126 <param name='uucp' doc='UUCP facility' />
1127 </params>
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]1128 </command>
1129 <command id='log syslog local &lt;0-7&gt;'>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1130 <params>
1131 <param name='log' doc='Configure logging sub-system' />
1132 <param name='syslog' doc='Logging via syslog' />
1133 <param name='local' doc='Syslog LOCAL facility' />
1134 <param name='&lt;0-7&gt;' doc='Local facility number' />
1135 </params>
1136 </command>
1137 <command id='no log syslog'>
1138 <params>
1139 <param name='no' doc='Negate a command or set its defaults' />
1140 <param name='log' doc='Configure logging sub-system' />
1141 <param name='syslog' doc='Logging via syslog' />
1142 </params>
1143 </command>
1144 <command id='log gsmtap [HOSTNAME]'>
1145 <params>
1146 <param name='log' doc='Configure logging sub-system' />
1147 <param name='gsmtap' doc='Logging via GSMTAP' />
1148 <param name='[HOSTNAME]' doc='Host name to send the GSMTAP logging to (UDP port 4729)' />
1149 </params>
1150 </command>
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]1151 <command id='stats reporter statsd'>
1152 <params>
1153 <param name='stats' doc='Configure stats sub-system' />
1154 <param name='reporter' doc='Configure a stats reporter' />
1155 <param name='statsd' doc='Report to a STATSD server' />
1156 </params>
1157 </command>
1158 <command id='no stats reporter statsd'>
1159 <params>
1160 <param name='no' doc='Negate a command or set its defaults' />
1161 <param name='stats' doc='Configure stats sub-system' />
1162 <param name='reporter' doc='Configure a stats reporter' />
1163 <param name='statsd' doc='Report to a STATSD server' />
1164 </params>
1165 </command>
1166 <command id='stats reporter log'>
1167 <params>
1168 <param name='stats' doc='Configure stats sub-system' />
1169 <param name='reporter' doc='Configure a stats reporter' />
1170 <param name='log' doc='Report to the logger' />
1171 </params>
1172 </command>
1173 <command id='no stats reporter log'>
1174 <params>
1175 <param name='no' doc='Negate a command or set its defaults' />
1176 <param name='stats' doc='Configure stats sub-system' />
1177 <param name='reporter' doc='Configure a stats reporter' />
1178 <param name='log' doc='Report to the logger' />
1179 </params>
1180 </command>
Pau Espin Pedrolf464fff2020-08-18 12:50:21 +0200[diff] [blame]1181 <command id='stats interval &lt;0-65535&gt;'>
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]1182 <params>
1183 <param name='stats' doc='Configure stats sub-system' />
1184 <param name='interval' doc='Set the reporting interval' />
Pau Espin Pedrolf464fff2020-08-18 12:50:21 +0200[diff] [blame]1185 <param name='&lt;0-65535&gt;' doc='Interval in seconds (0 disables the reporting interval)' />
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]1186 </params>
1187 </command>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1188 <command id='hlr'>
1189 <params>
1190 <param name='hlr' doc='Configure the HLR' />
1191 </params>
1192 </command>
Pau Espin Pedrolf464fff2020-08-18 12:50:21 +0200[diff] [blame]1193 <command id='mslookup'>
1194 <params>
1195 <param name='mslookup' doc='Configure Distributed GSM mslookup' />
1196 </params>
1197 </command>
Pau Espin Pedroled18fa92020-08-18 12:58:36 +0200[diff] [blame]1198 <command id='cpu-sched'>
1199 <params>
1200 <param name='cpu-sched' doc='Configure CPU Scheduler related settings' />
1201 </params>
1202 </command>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1203 </node>
1204 <node id='config-log'>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]1205 <name>config-log</name>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1206 <command id='logging filter all (0|1)'>
1207 <params>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]1208 <param name='logging' doc='Configure logging' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1209 <param name='filter' doc='Filter log messages' />
1210 <param name='all' doc='Do you want to log all messages?' />
1211 <param name='0' doc='Only print messages matched by other filters' />
1212 <param name='1' doc='Bypass filter and print all messages' />
1213 </params>
1214 </command>
1215 <command id='logging color (0|1)'>
1216 <params>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]1217 <param name='logging' doc='Configure logging' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1218 <param name='color' doc='Configure color-printing for log messages' />
1219 <param name='0' doc='Don&apos;t use color for printing messages' />
1220 <param name='1' doc='Use color for printing messages' />
1221 </params>
1222 </command>
1223 <command id='logging timestamp (0|1)'>
1224 <params>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]1225 <param name='logging' doc='Configure logging' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1226 <param name='timestamp' doc='Configure log message timestamping' />
1227 <param name='0' doc='Don&apos;t prefix each log message' />
1228 <param name='1' doc='Prefix each log message with current timestamp' />
1229 </params>
1230 </command>
1231 <command id='logging print extended-timestamp (0|1)'>
1232 <params>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]1233 <param name='logging' doc='Configure logging' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1234 <param name='print' doc='Log output settings' />
1235 <param name='extended-timestamp' doc='Configure log message timestamping' />
1236 <param name='0' doc='Don&apos;t prefix each log message' />
1237 <param name='1' doc='Prefix each log message with current timestamp with YYYYMMDDhhmmssnnn' />
1238 </params>
1239 </command>
1240 <command id='logging print category (0|1)'>
1241 <params>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]1242 <param name='logging' doc='Configure logging' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1243 <param name='print' doc='Log output settings' />
1244 <param name='category' doc='Configure log message' />
1245 <param name='0' doc='Don&apos;t prefix each log message' />
1246 <param name='1' doc='Prefix each log message with category/subsystem name' />
1247 </params>
1248 </command>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]1249 <command id='logging print category-hex (0|1)'>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1250 <params>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]1251 <param name='logging' doc='Configure logging' />
1252 <param name='print' doc='Log output settings' />
1253 <param name='category-hex' doc='Configure log message' />
1254 <param name='0' doc='Don&apos;t prefix each log message' />
1255 <param name='1' doc='Prefix each log message with category/subsystem nr in hex (&apos;&lt;000b&gt;&apos;)' />
1256 </params>
1257 </command>
1258 <command id='logging print level (0|1)'>
1259 <params>
1260 <param name='logging' doc='Configure logging' />
1261 <param name='print' doc='Log output settings' />
1262 <param name='level' doc='Configure log message' />
1263 <param name='0' doc='Don&apos;t prefix each log message' />
1264 <param name='1' doc='Prefix each log message with the log level name' />
1265 </params>
1266 </command>
Neels Hofmeyrbf6b4eb2018-11-05 03:18:46 +0100[diff] [blame]1267 <command id='logging print file (0|1|basename) [last]'>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]1268 <params>
1269 <param name='logging' doc='Configure logging' />
1270 <param name='print' doc='Log output settings' />
1271 <param name='file' doc='Configure log message' />
1272 <param name='0' doc='Don&apos;t prefix each log message' />
1273 <param name='1' doc='Prefix each log message with the source file and line' />
1274 <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]1275 <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]1276 </params>
1277 </command>
Pau Espin Pedrolf464fff2020-08-18 12:50:21 +0200[diff] [blame]1278 <command id='logging level (main|db|auc|ss|mslookup|lu|dgsm|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]1279 <params>
1280 <param name='logging' doc='Configure logging' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1281 <param name='level' doc='Set the log level for a specified category' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1282 <param name='main' doc='Main Program' />
1283 <param name='db' doc='Database Layer' />
1284 <param name='auc' doc='Authentication Center' />
Neels Hofmeyrbf6b4eb2018-11-05 03:18:46 +0100[diff] [blame]1285 <param name='ss' doc='Supplementary Services' />
Pau Espin Pedrolf464fff2020-08-18 12:50:21 +0200[diff] [blame]1286 <param name='mslookup' doc='Mobile Subscriber Lookup' />
1287 <param name='lu' doc='Location Updating' />
1288 <param name='dgsm' doc='Distributed GSM: MS lookup and proxy' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1289 <param name='lglobal' doc='Library-internal global log family' />
1290 <param name='llapd' doc='LAPD in libosmogsm' />
1291 <param name='linp' doc='A-bis Intput Subsystem' />
1292 <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' />
1293 <param name='lmi' doc='A-bis Input Driver for Signalling' />
1294 <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' />
1295 <param name='lsms' doc='Layer3 Short Message Service (SMS)' />
1296 <param name='lctrl' doc='Control Interface' />
1297 <param name='lgtp' doc='GPRS GTP library' />
1298 <param name='lstats' doc='Statistics messages and logging' />
1299 <param name='lgsup' doc='Generic Subscriber Update Protocol' />
1300 <param name='loap' doc='Osmocom Authentication Protocol' />
1301 <param name='lss7' doc='libosmo-sigtran Signalling System 7' />
1302 <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' />
1303 <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' />
1304 <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' />
1305 <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' />
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]1306 <param name='ljibuf' doc='libosmo-netif Jitter Buffer' />
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]1307 <param name='lrspro' doc='Remote SIM protocol' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1308 <param name='debug' doc='Log debug messages and higher levels' />
1309 <param name='info' doc='Log informational messages and higher levels' />
1310 <param name='notice' doc='Log noticeable messages and higher levels' />
1311 <param name='error' doc='Log error messages and higher levels' />
1312 <param name='fatal' doc='Log only fatal messages' />
1313 </params>
1314 </command>
Neels Hofmeyrbf6b4eb2018-11-05 03:18:46 +0100[diff] [blame]1315 <command id='logging level set-all (debug|info|notice|error|fatal)'>
1316 <params>
1317 <param name='logging' doc='Configure logging' />
1318 <param name='level' doc='Set the log level for a specified category' />
1319 <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.' />
1320 <param name='debug' doc='Log debug messages and higher levels' />
1321 <param name='info' doc='Log informational messages and higher levels' />
1322 <param name='notice' doc='Log noticeable messages and higher levels' />
1323 <param name='error' doc='Log error messages and higher levels' />
1324 <param name='fatal' doc='Log only fatal messages' />
1325 </params>
1326 </command>
1327 <command id='logging level force-all (debug|info|notice|error|fatal)'>
1328 <params>
1329 <param name='logging' doc='Configure logging' />
1330 <param name='level' doc='Set the log level for a specified category' />
1331 <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.' />
1332 <param name='debug' doc='Log debug messages and higher levels' />
1333 <param name='info' doc='Log informational messages and higher levels' />
1334 <param name='notice' doc='Log noticeable messages and higher levels' />
1335 <param name='error' doc='Log error messages and higher levels' />
1336 <param name='fatal' doc='Log only fatal messages' />
1337 </params>
1338 </command>
1339 <command id='no logging level force-all'>
1340 <params>
1341 <param name='no' doc='Negate a command or set its defaults' />
1342 <param name='logging' doc='Configure logging' />
1343 <param name='level' doc='Set the log level for a specified category' />
1344 <param name='force-all' doc='Release any globally forced log level set with &apos;logging level force-all &lt;level&gt;&apos;' />
1345 </params>
1346 </command>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1347 </node>
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]1348 <node id='config-stats'>
1349 <name>config-stats</name>
1350 <command id='local-ip ADDR'>
1351 <params>
1352 <param name='local-ip' doc='Set the IP address to which we bind locally' />
1353 <param name='ADDR' doc='IP Address' />
1354 </params>
1355 </command>
1356 <command id='no local-ip'>
1357 <params>
1358 <param name='no' doc='Negate a command or set its defaults' />
1359 <param name='local-ip' doc='Set the IP address to which we bind locally' />
1360 </params>
1361 </command>
1362 <command id='remote-ip ADDR'>
1363 <params>
1364 <param name='remote-ip' doc='Set the remote IP address to which we connect' />
1365 <param name='ADDR' doc='IP Address' />
1366 </params>
1367 </command>
1368 <command id='remote-port &lt;1-65535&gt;'>
1369 <params>
1370 <param name='remote-port' doc='Set the remote port to which we connect' />
1371 <param name='&lt;1-65535&gt;' doc='Remote port number' />
1372 </params>
1373 </command>
1374 <command id='mtu &lt;100-65535&gt;'>
1375 <params>
1376 <param name='mtu' doc='Set the maximum packet size' />
1377 <param name='&lt;100-65535&gt;' doc='Size in byte' />
1378 </params>
1379 </command>
1380 <command id='no mtu'>
1381 <params>
1382 <param name='no' doc='Negate a command or set its defaults' />
1383 <param name='mtu' doc='Set the maximum packet size' />
1384 </params>
1385 </command>
1386 <command id='prefix PREFIX'>
1387 <params>
1388 <param name='prefix' doc='Set the item name prefix' />
1389 <param name='PREFIX' doc='The prefix string' />
1390 </params>
1391 </command>
1392 <command id='no prefix'>
1393 <params>
1394 <param name='no' doc='Negate a command or set its defaults' />
1395 <param name='prefix' doc='Set the item name prefix' />
1396 </params>
1397 </command>
1398 <command id='level (global|peer|subscriber)'>
1399 <params>
1400 <param name='level' doc='Set the maximum group level' />
1401 <param name='global' doc='Report global groups only' />
1402 <param name='peer' doc='Report global and network peer related groups' />
1403 <param name='subscriber' doc='Report global, peer, and subscriber groups' />
1404 </params>
1405 </command>
1406 <command id='enable'>
1407 <params>
1408 <param name='enable' doc='Enable the reporter' />
1409 </params>
1410 </command>
1411 <command id='disable'>
1412 <params>
1413 <param name='disable' doc='Disable the reporter' />
1414 </params>
1415 </command>
Pau Espin Pedrolf464fff2020-08-18 12:50:21 +0200[diff] [blame]1416 <command id='flush-period &lt;0-65535&gt;'>
1417 <params>
1418 <param name='flush-period' doc='Configure stats sub-system' />
1419 <param name='&lt;0-65535&gt;' doc='Send all stats even if they have not changed (i.e. force the flush)every N-th reporting interval. Set to 0 to disable regular flush (default).' />
1420 </params>
1421 </command>
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]1422 </node>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1423 <node id='config-line'>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]1424 <name>config-line</name>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1425 <command id='login'>
1426 <params>
1427 <param name='login' doc='Enable password checking' />
1428 </params>
1429 </command>
1430 <command id='no login'>
1431 <params>
1432 <param name='no' doc='Negate a command or set its defaults' />
1433 <param name='login' doc='Enable password checking' />
1434 </params>
1435 </command>
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]1436 <command id='bind A.B.C.D [&lt;0-65535&gt;]'>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1437 <params>
1438 <param name='bind' doc='Accept VTY telnet connections on local interface' />
1439 <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]1440 <param name='[&lt;0-65535&gt;]' doc='Local TCP port number' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1441 </params>
1442 </command>
1443 </node>
1444 <node id='config-ctrl'>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]1445 <name>config-ctrl</name>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1446 <command id='bind A.B.C.D'>
1447 <params>
1448 <param name='bind' doc='Set bind address to listen for Control connections' />
1449 <param name='A.B.C.D' doc='Local IP address (default 127.0.0.1)' />
1450 </params>
1451 </command>
1452 </node>
Pau Espin Pedroled18fa92020-08-18 12:58:36 +0200[diff] [blame]1453 <node id='config-cpu-sched'>
1454 <name>config-cpu-sched</name>
1455 <command id='policy rr &lt;1-32&gt;'>
1456 <params>
1457 <param name='policy' doc='Set the scheduling policy to use for the process' />
1458 <param name='rr' doc='Use the SCHED_RR real-time scheduling algorithm' />
1459 <param name='&lt;1-32&gt;' doc='Set the SCHED_RR real-time priority' />
1460 </params>
1461 </command>
1462 <command id='cpu-affinity (self|all|&lt;0-4294967295&gt;|THREADNAME) CPUHEXMASK [delay]'>
1463 <params>
1464 <param name='cpu-affinity' doc='Set CPU affinity mask on a (group of) thread(s)' />
1465 <param name='self' doc='Set CPU affinity mask on thread running the VTY' />
1466 <param name='all' doc='Set CPU affinity mask on all process&apos; threads' />
1467 <param name='&lt;0-4294967295&gt;' doc='Set CPU affinity mask on a thread with specified PID' />
1468 <param name='THREADNAME' doc='Set CPU affinity mask on a thread with specified thread name' />
1469 <param name='CPUHEXMASK' doc='CPU affinity mask' />
1470 <param name='[delay]' doc='If set, delay applying the affinity mask now and let the app handle it at a later point' />
1471 </params>
1472 </command>
1473 </node>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1474 <node id='config-hlr'>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]1475 <name>config-hlr</name>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1476 <command id='gsup'>
1477 <params>
1478 <param name='gsup' doc='Configure GSUP options' />
1479 </params>
1480 </command>
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]1481 <command id='database PATH'>
1482 <params>
1483 <param name='database' doc='Set the path to the HLR database file' />
1484 <param name='PATH' doc='Relative or absolute file system path to the database file (default is &apos;hlr.db&apos;)' />
1485 </params>
1486 </command>
Neels Hofmeyrbf6b4eb2018-11-05 03:18:46 +0100[diff] [blame]1487 <command id='euse NAME'>
1488 <params>
1489 <param name='euse' doc='Configure a particular External USSD Entity' />
1490 <param name='NAME' doc='Alphanumeric name of the External USSD Entity' />
1491 </params>
1492 </command>
1493 <command id='no euse NAME'>
1494 <params>
1495 <param name='no' doc='Negate a command or set its defaults' />
1496 <param name='euse' doc='Remove a particular External USSD Entity' />
1497 <param name='NAME' doc='Alphanumeric name of the External USSD Entity' />
1498 </params>
1499 </command>
1500 <command id='ussd route prefix PREFIX internal (own-msisdn|own-imsi)'>
1501 <params>
1502 <param name='ussd' doc='USSD Configuration' />
1503 <param name='route' doc='Routing Configuration' />
1504 <param name='prefix' doc='Prefix-Matching Route' />
1505 <param name='PREFIX' doc='USSD Prefix' />
1506 <param name='internal' doc='Internal USSD Handler' />
1507 <param name='own-msisdn' doc='Respond with subscribers&apos; own MSISDN' />
1508 <param name='own-imsi' doc='Respond with subscribers&apos; own IMSI' />
1509 </params>
1510 </command>
1511 <command id='ussd route prefix PREFIX external EUSE'>
1512 <params>
1513 <param name='ussd' doc='USSD Configuration' />
1514 <param name='route' doc='Routing Configuration' />
1515 <param name='prefix' doc='Prefix-Matching Route' />
1516 <param name='PREFIX' doc='USSD Prefix' />
1517 <param name='external' doc='External USSD Handler' />
1518 <param name='EUSE' doc='Name of External USSD Handler (IPA CCM ID)' />
1519 </params>
1520 </command>
1521 <command id='no ussd route prefix PREFIX'>
1522 <params>
1523 <param name='no' doc='Negate a command or set its defaults' />
1524 <param name='ussd' doc='USSD Configuration' />
1525 <param name='route' doc='Routing Configuration' />
1526 <param name='prefix' doc='Prefix-Matching Route' />
1527 <param name='PREFIX' doc='USSD Prefix' />
1528 </params>
1529 </command>
1530 <command id='ussd default-route external EUSE'>
1531 <params>
1532 <param name='ussd' doc='USSD Configuration' />
1533 <param name='default-route' doc='Configure default-route for all USSD to unknown destinations' />
1534 <param name='external' doc='External USSD Handler' />
1535 <param name='EUSE' doc='Name of External USSD Handler (IPA CCM ID)' />
1536 </params>
1537 </command>
1538 <command id='no ussd default-route'>
1539 <params>
1540 <param name='no' doc='Negate a command or set its defaults' />
1541 <param name='ussd' doc='USSD Configuration' />
1542 <param name='default-route' doc='Remove the default-route for all USSD to unknown destinations' />
1543 </params>
1544 </command>
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]1545 <command id='ncss-guard-timeout &lt;0-255&gt;'>
1546 <params>
1547 <param name='ncss-guard-timeout' doc='Set guard timer for NCSS (call independent SS) session activity' />
1548 <param name='&lt;0-255&gt;' doc='Guard timer value (sec.), or 0 to disable' />
1549 </params>
1550 </command>
1551 <command id='store-imei'>
1552 <params>
1553 <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;).' />
1554 </params>
1555 </command>
1556 <command id='no store-imei'>
1557 <params>
1558 <param name='no' doc='Do not save the IMEI in the database, when receiving Check IMEI requests.' />
1559 <param name='store-imei' doc='(null)' />
1560 </params>
1561 </command>
1562 <command id='subscriber-create-on-demand (no-msisdn|&lt;3-15&gt;) (none|cs|ps|cs+ps)'>
1563 <params>
1564 <param name='subscriber-create-on-demand' doc='Make a new record when a subscriber is first seen.' />
1565 <param name='no-msisdn' doc='Do not automatically assign MSISDN.' />
1566 <param name='&lt;3-15&gt;' doc='Length of an automatically assigned MSISDN.' />
1567 <param name='none' doc='Do not allow any NAM (Network Access Mode) by default.' />
1568 <param name='cs' doc='Allow access to circuit switched NAM by default.' />
1569 <param name='ps' doc='Allow access to packet switched NAM by default.' />
1570 <param name='cs+ps' doc='Allow access to circuit and packet switched NAM by default.' />
1571 </params>
1572 </command>
1573 <command id='no subscriber-create-on-demand'>
1574 <params>
1575 <param name='no' doc='Do not make a new record when a subscriber is first seen.' />
1576 <param name='subscriber-create-on-demand' doc='(null)' />
1577 </params>
1578 </command>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1579 </node>
1580 <node id='config-hlr-gsup'>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]1581 <name>config-hlr-gsup</name>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1582 <command id='bind ip A.B.C.D'>
1583 <params>
1584 <param name='bind' doc='Listen/Bind related socket option' />
1585 <param name='ip' doc='IP information' />
1586 <param name='A.B.C.D' doc='IPv4 Address to bind the GSUP interface to' />
1587 </params>
1588 </command>
Pau Espin Pedrolf464fff2020-08-18 12:50:21 +0200[diff] [blame]1589 <command id='ipa-name NAME'>
1590 <params>
1591 <param name='ipa-name' doc='Set the IPA name of this HLR, for proxying to remote HLRs' />
1592 <param name='NAME' doc='A globally unique name for this HLR. For example: PLMN + redundancy server number: HLR-901-70-0. This name is used for GSUP routing and must be set if multiple HLRs interconnect (e.g. mslookup for Distributed GSM).' />
1593 </params>
1594 </command>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1595 </node>
Neels Hofmeyrbf6b4eb2018-11-05 03:18:46 +0100[diff] [blame]1596 <node id='config-hlr-euse'>
1597 <name>config-hlr-euse</name>
1598 </node>
Pau Espin Pedrolf464fff2020-08-18 12:50:21 +0200[diff] [blame]1599 <node id='config-mslookup'>
1600 <name>config-mslookup</name>
1601 <command id='mdns bind [IP] [&lt;1-65535&gt;]'>
1602 <params>
1603 <param name='mdns' doc='Multicast DNS related configuration' />
1604 <param name='bind' doc='Convenience shortcut: enable and configure both server and client for mDNS mslookup' />
1605 <param name='[IP]' doc='multicast IPv4 address like 239.192.23.42 or IPv6 address like ff08::23:42' />
1606 <param name='[&lt;1-65535&gt;]' doc='mDNS UDP Port number' />
1607 </params>
1608 </command>
1609 <command id='mdns domain-suffix DOMAIN_SUFFIX'>
1610 <params>
1611 <param name='mdns' doc='Multicast DNS related configuration' />
1612 <param name='domain-suffix' doc='mDNS domain suffix (default: mdns.osmocom.org). This is appended and stripped from mDNS packets during encoding/decoding, so we don&apos;t collide with top-level domains administrated by IANA' />
1613 <param name='DOMAIN_SUFFIX' doc='mDNS domain suffix (default: mdns.osmocom.org). This is appended and stripped from mDNS packets during encoding/decoding, so we don&apos;t collide with top-level domains administrated by IANA' />
1614 </params>
1615 </command>
1616 <command id='no mdns bind'>
1617 <params>
1618 <param name='no' doc='Negate a command or set its defaults' />
1619 <param name='mdns' doc='Disable both server and client for mDNS mslookup' />
1620 <param name='bind' doc='(null)' />
1621 </params>
1622 </command>
1623 <command id='server'>
1624 <params>
1625 <param name='server' doc='Enable and configure Distributed GSM mslookup server' />
1626 </params>
1627 </command>
1628 <command id='no server'>
1629 <params>
1630 <param name='no' doc='Negate a command or set its defaults' />
1631 <param name='server' doc='Disable Distributed GSM mslookup server' />
1632 </params>
1633 </command>
1634 <command id='client'>
1635 <params>
1636 <param name='client' doc='Enable and configure Distributed GSM mslookup client' />
1637 </params>
1638 </command>
1639 <command id='no client'>
1640 <params>
1641 <param name='no' doc='Negate a command or set its defaults' />
1642 <param name='client' doc='Disable Distributed GSM mslookup client' />
1643 </params>
1644 </command>
1645 </node>
1646 <node id='config-mslookup-server'>
1647 <name>config-mslookup-server</name>
1648 <command id='mdns bind [IP] [&lt;1-65535&gt;]'>
1649 <params>
1650 <param name='mdns' doc='Multicast DNS related configuration' />
1651 <param name='bind' doc='Configure where the mDNS server listens for mslookup requests' />
1652 <param name='[IP]' doc='multicast IPv4 address like 239.192.23.42 or IPv6 address like ff08::23:42' />
1653 <param name='[&lt;1-65535&gt;]' doc='mDNS UDP Port number' />
1654 </params>
1655 </command>
1656 <command id='mdns domain-suffix DOMAIN_SUFFIX'>
1657 <params>
1658 <param name='mdns' doc='Multicast DNS related configuration' />
1659 <param name='domain-suffix' doc='mDNS domain suffix (default: mdns.osmocom.org). This is appended and stripped from mDNS packets during encoding/decoding, so we don&apos;t collide with top-level domains administrated by IANA' />
1660 <param name='DOMAIN_SUFFIX' doc='mDNS domain suffix (default: mdns.osmocom.org). This is appended and stripped from mDNS packets during encoding/decoding, so we don&apos;t collide with top-level domains administrated by IANA' />
1661 </params>
1662 </command>
1663 <command id='no mdns bind'>
1664 <params>
1665 <param name='no' doc='Negate a command or set its defaults' />
1666 <param name='mdns' doc='Disable server for mDNS mslookup (do not answer remote requests)' />
1667 <param name='bind' doc='(null)' />
1668 </params>
1669 </command>
1670 <command id='service NAME at IP &lt;1-65535&gt;'>
1671 <params>
1672 <param name='service' doc='Configure addresses of local services, as sent in replies to remote mslookup requests.' />
1673 <param name='NAME' doc='mslookup service name, e.g. sip.voice or smpp.sms' />
1674 <param name='at' doc='at' />
1675 <param name='IP' doc='IPv4 address like 1.2.3.4 or IPv6 address like a:b:c:d::1' />
1676 <param name='&lt;1-65535&gt;' doc='Service-specific port number' />
1677 </params>
1678 </command>
1679 <command id='no service NAME'>
1680 <params>
1681 <param name='no' doc='Negate a command or set its defaults' />
1682 <param name='service' doc='Remove one or more service address entries' />
1683 <param name='NAME' doc='mslookup service name, e.g. sip.voice or smpp.sms' />
1684 </params>
1685 </command>
1686 <command id='no service NAME at IP &lt;1-65535&gt;'>
1687 <params>
1688 <param name='no' doc='Negate a command or set its defaults' />
1689 <param name='service' doc='Remove one or more service address entries' />
1690 <param name='NAME' doc='mslookup service name, e.g. sip.voice or smpp.sms' />
1691 <param name='at' doc='at' />
1692 <param name='IP' doc='IPv4 address like 1.2.3.4 or IPv6 address like a:b:c:d::1' />
1693 <param name='&lt;1-65535&gt;' doc='Service-specific port number' />
1694 </params>
1695 </command>
1696 <command id='msc ipa-name .IPA_NAME'>
1697 <params>
1698 <param name='msc' doc='Configure services for individual local MSCs' />
1699 <param name='ipa-name' doc='Identify locally connected MSC by IPA Unit Name' />
1700 <param name='.IPA_NAME' doc='IPA Unit Name of the local MSC to configure' />
1701 </params>
1702 </command>
1703 </node>
1704 <node id='config-mslookup-server-msc'>
1705 <name>config-mslookup-server-msc</name>
1706 <command id='service NAME at IP &lt;1-65535&gt;'>
1707 <params>
1708 <param name='service' doc='Configure addresses of local services, as sent in replies to remote mslookup requests.' />
1709 <param name='NAME' doc='mslookup service name, e.g. sip.voice or smpp.sms' />
1710 <param name='at' doc='at' />
1711 <param name='IP' doc='IPv4 address like 1.2.3.4 or IPv6 address like a:b:c:d::1' />
1712 <param name='&lt;1-65535&gt;' doc='Service-specific port number' />
1713 </params>
1714 </command>
1715 <command id='no service NAME'>
1716 <params>
1717 <param name='no' doc='Negate a command or set its defaults' />
1718 <param name='service' doc='Remove one or more service address entries' />
1719 <param name='NAME' doc='mslookup service name, e.g. sip.voice or smpp.sms' />
1720 </params>
1721 </command>
1722 <command id='no service NAME at IP &lt;1-65535&gt;'>
1723 <params>
1724 <param name='no' doc='Negate a command or set its defaults' />
1725 <param name='service' doc='Remove one or more service address entries' />
1726 <param name='NAME' doc='mslookup service name, e.g. sip.voice or smpp.sms' />
1727 <param name='at' doc='at' />
1728 <param name='IP' doc='IPv4 address like 1.2.3.4 or IPv6 address like a:b:c:d::1' />
1729 <param name='&lt;1-65535&gt;' doc='Service-specific port number' />
1730 </params>
1731 </command>
1732 </node>
1733 <node id='config-mslookup-client'>
1734 <name>config-mslookup-client</name>
1735 <command id='timeout &lt;1-100000&gt;'>
1736 <params>
1737 <param name='timeout' doc='How long should the mslookup client wait for remote responses before evaluating received results' />
1738 <param name='&lt;1-100000&gt;' doc='timeout in milliseconds' />
1739 </params>
1740 </command>
1741 <command id='mdns bind [IP] [&lt;1-65535&gt;]'>
1742 <params>
1743 <param name='mdns' doc='Multicast DNS related configuration' />
1744 <param name='bind' doc='Enable mDNS client, and configure multicast address to send mDNS mslookup requests to' />
1745 <param name='[IP]' doc='multicast IPv4 address like 239.192.23.42 or IPv6 address like ff08::23:42' />
1746 <param name='[&lt;1-65535&gt;]' doc='mDNS UDP Port number' />
1747 </params>
1748 </command>
1749 <command id='mdns domain-suffix DOMAIN_SUFFIX'>
1750 <params>
1751 <param name='mdns' doc='Multicast DNS related configuration' />
1752 <param name='domain-suffix' doc='mDNS domain suffix (default: mdns.osmocom.org). This is appended and stripped from mDNS packets during encoding/decoding, so we don&apos;t collide with top-level domains administrated by IANA' />
1753 <param name='DOMAIN_SUFFIX' doc='mDNS domain suffix (default: mdns.osmocom.org). This is appended and stripped from mDNS packets during encoding/decoding, so we don&apos;t collide with top-level domains administrated by IANA' />
1754 </params>
1755 </command>
1756 <command id='no mdns bind'>
1757 <params>
1758 <param name='no' doc='Negate a command or set its defaults' />
1759 <param name='mdns' doc='Disable mDNS client, do not query remote services by mDNS' />
1760 <param name='bind' doc='(null)' />
1761 </params>
1762 </command>
1763 <command id='gateway-proxy IP [&lt;1-65535&gt;]'>
1764 <params>
1765 <param name='gateway-proxy' doc='Configure a fixed IP address to send all GSUP requests for unknown IMSIs to, without invoking a lookup for IMSI' />
1766 <param name='IP' doc='IP address of the remote HLR' />
1767 <param name='[&lt;1-65535&gt;]' doc='GSUP port number (omit for default 4222)' />
1768 </params>
1769 </command>
1770 <command id='no gateway-proxy'>
1771 <params>
1772 <param name='no' doc='Negate a command or set its defaults' />
1773 <param name='gateway-proxy' doc='Disable gateway proxy for GSUP with unknown IMSIs' />
1774 </params>
1775 </command>
1776 </node>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1777</vtydoc>