Gitiles
Code Review Sign In
gerrit.osmocom.org / osmo-hlr / f464fff1736f7de6064047e52e8956088ba478e9 / . / doc / manuals / vty / hlr_vty_reference.xml
blob: 8e56f4b8edcff5bf173a9068e386d92d2e62cb6f [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>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]411 </node>
412 <node id='enable'>
413 <name>enable</name>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]414 <command id='disable'>
415 <params>
416 <param name='disable' doc='Turn off privileged mode command' />
417 </params>
418 </command>
419 <command id='configure terminal'>
420 <params>
421 <param name='configure' doc='Configuration from vty interface' />
422 <param name='terminal' doc='Configuration terminal' />
423 </params>
424 </command>
425 <command id='copy running-config startup-config'>
426 <params>
427 <param name='copy' doc='Copy configuration' />
428 <param name='running-config' doc='Copy running config to... ' />
429 <param name='startup-config' doc='Copy running config to startup config (same as write file)' />
430 </params>
431 </command>
432 <command id='show startup-config'>
433 <params>
434 <param name='show' doc='Show running system information' />
435 <param name='startup-config' doc='Contentes of startup configuration' />
436 </params>
437 </command>
438 <command id='show version'>
439 <params>
440 <param name='show' doc='Show running system information' />
441 <param name='version' doc='Displays program version' />
442 </params>
443 </command>
444 <command id='show online-help'>
445 <params>
446 <param name='show' doc='Show running system information' />
447 <param name='online-help' doc='Online help' />
448 </params>
449 </command>
450 <command id='terminal length &lt;0-512&gt;'>
451 <params>
452 <param name='terminal' doc='Set terminal line parameters' />
453 <param name='length' doc='Set number of lines on a screen' />
454 <param name='&lt;0-512&gt;' doc='Number of lines on screen (0 for no pausing)' />
455 </params>
456 </command>
457 <command id='terminal no length'>
458 <params>
459 <param name='terminal' doc='Set terminal line parameters' />
460 <param name='no' doc='Negate a command or set its defaults' />
461 <param name='length' doc='Set number of lines on a screen' />
462 </params>
463 </command>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]464 <command id='who'>
465 <params>
466 <param name='who' doc='Display who is on vty' />
467 </params>
468 </command>
469 <command id='show history'>
470 <params>
471 <param name='show' doc='Show running system information' />
472 <param name='history' doc='Display the session command history' />
473 </params>
474 </command>
475 <command id='terminal monitor'>
476 <params>
477 <param name='terminal' doc='Set terminal line parameters' />
478 <param name='monitor' doc='Copy debug output to the current terminal line' />
479 </params>
480 </command>
481 <command id='terminal no monitor'>
482 <params>
483 <param name='terminal' doc='Set terminal line parameters' />
484 <param name='no' doc='Negate a command or set its defaults' />
485 <param name='monitor' doc='Copy debug output to the current terminal line' />
486 </params>
487 </command>
488 <command id='logging enable'>
489 <params>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]490 <param name='logging' doc='Configure logging' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]491 <param name='enable' doc='Enables logging to this vty' />
492 </params>
493 </command>
494 <command id='logging disable'>
495 <params>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]496 <param name='logging' doc='Configure logging' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]497 <param name='disable' doc='Disables logging to this vty' />
498 </params>
499 </command>
500 <command id='logging filter all (0|1)'>
501 <params>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]502 <param name='logging' doc='Configure logging' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]503 <param name='filter' doc='Filter log messages' />
504 <param name='all' doc='Do you want to log all messages?' />
505 <param name='0' doc='Only print messages matched by other filters' />
506 <param name='1' doc='Bypass filter and print all messages' />
507 </params>
508 </command>
509 <command id='logging color (0|1)'>
510 <params>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]511 <param name='logging' doc='Configure logging' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]512 <param name='color' doc='Configure color-printing for log messages' />
513 <param name='0' doc='Don&apos;t use color for printing messages' />
514 <param name='1' doc='Use color for printing messages' />
515 </params>
516 </command>
517 <command id='logging timestamp (0|1)'>
518 <params>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]519 <param name='logging' doc='Configure logging' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]520 <param name='timestamp' doc='Configure log message timestamping' />
521 <param name='0' doc='Don&apos;t prefix each log message' />
522 <param name='1' doc='Prefix each log message with current timestamp' />
523 </params>
524 </command>
525 <command id='logging print extended-timestamp (0|1)'>
526 <params>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]527 <param name='logging' doc='Configure logging' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]528 <param name='print' doc='Log output settings' />
529 <param name='extended-timestamp' doc='Configure log message timestamping' />
530 <param name='0' doc='Don&apos;t prefix each log message' />
531 <param name='1' doc='Prefix each log message with current timestamp with YYYYMMDDhhmmssnnn' />
532 </params>
533 </command>
534 <command id='logging print category (0|1)'>
535 <params>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]536 <param name='logging' doc='Configure logging' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]537 <param name='print' doc='Log output settings' />
538 <param name='category' doc='Configure log message' />
539 <param name='0' doc='Don&apos;t prefix each log message' />
540 <param name='1' doc='Prefix each log message with category/subsystem name' />
541 </params>
542 </command>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]543 <command id='logging print category-hex (0|1)'>
544 <params>
545 <param name='logging' doc='Configure logging' />
546 <param name='print' doc='Log output settings' />
547 <param name='category-hex' doc='Configure log message' />
548 <param name='0' doc='Don&apos;t prefix each log message' />
549 <param name='1' doc='Prefix each log message with category/subsystem nr in hex (&apos;&lt;000b&gt;&apos;)' />
550 </params>
551 </command>
552 <command id='logging print level (0|1)'>
553 <params>
554 <param name='logging' doc='Configure logging' />
555 <param name='print' doc='Log output settings' />
556 <param name='level' doc='Configure log message' />
557 <param name='0' doc='Don&apos;t prefix each log message' />
558 <param name='1' doc='Prefix each log message with the log level name' />
559 </params>
560 </command>
Neels Hofmeyrbf6b4eb2018-11-05 03:18:46 +0100[diff] [blame]561 <command id='logging print file (0|1|basename) [last]'>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]562 <params>
563 <param name='logging' doc='Configure logging' />
564 <param name='print' doc='Log output settings' />
565 <param name='file' doc='Configure log message' />
566 <param name='0' doc='Don&apos;t prefix each log message' />
567 <param name='1' doc='Prefix each log message with the source file and line' />
568 <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]569 <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]570 </params>
571 </command>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]572 <command id='logging set-log-mask MASK'>
573 <params>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]574 <param name='logging' doc='Configure logging' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]575 <param name='set-log-mask' doc='Set the logmask of this logging target' />
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]576 <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]577 </params>
578 </command>
Pau Espin Pedrolf464fff2020-08-18 12:50:21 +0200[diff] [blame^]579 <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]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='level' doc='Set the log level for a specified category' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]583 <param name='main' doc='Main Program' />
584 <param name='db' doc='Database Layer' />
585 <param name='auc' doc='Authentication Center' />
Neels Hofmeyrbf6b4eb2018-11-05 03:18:46 +0100[diff] [blame]586 <param name='ss' doc='Supplementary Services' />
Pau Espin Pedrolf464fff2020-08-18 12:50:21 +0200[diff] [blame^]587 <param name='mslookup' doc='Mobile Subscriber Lookup' />
588 <param name='lu' doc='Location Updating' />
589 <param name='dgsm' doc='Distributed GSM: MS lookup and proxy' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]590 <param name='lglobal' doc='Library-internal global log family' />
591 <param name='llapd' doc='LAPD in libosmogsm' />
592 <param name='linp' doc='A-bis Intput Subsystem' />
593 <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' />
594 <param name='lmi' doc='A-bis Input Driver for Signalling' />
595 <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' />
596 <param name='lsms' doc='Layer3 Short Message Service (SMS)' />
597 <param name='lctrl' doc='Control Interface' />
598 <param name='lgtp' doc='GPRS GTP library' />
599 <param name='lstats' doc='Statistics messages and logging' />
600 <param name='lgsup' doc='Generic Subscriber Update Protocol' />
601 <param name='loap' doc='Osmocom Authentication Protocol' />
602 <param name='lss7' doc='libosmo-sigtran Signalling System 7' />
603 <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' />
604 <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' />
605 <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' />
606 <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' />
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]607 <param name='ljibuf' doc='libosmo-netif Jitter Buffer' />
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]608 <param name='lrspro' doc='Remote SIM protocol' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]609 <param name='debug' doc='Log debug messages and higher levels' />
610 <param name='info' doc='Log informational messages and higher levels' />
611 <param name='notice' doc='Log noticeable messages and higher levels' />
612 <param name='error' doc='Log error messages and higher levels' />
613 <param name='fatal' doc='Log only fatal messages' />
614 </params>
615 </command>
Neels Hofmeyrbf6b4eb2018-11-05 03:18:46 +0100[diff] [blame]616 <command id='logging level set-all (debug|info|notice|error|fatal)'>
617 <params>
Pau Espin Pedrolf464fff2020-08-18 12:50:21 +0200[diff] [blame^]618 <param name='logging' doc='Configure logging' />
619 <param name='level' doc='Set the log level for a specified category' />
Neels Hofmeyrbf6b4eb2018-11-05 03:18:46 +0100[diff] [blame]620 <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.' />
621 <param name='debug' doc='Log debug messages and higher levels' />
622 <param name='info' doc='Log informational messages and higher levels' />
623 <param name='notice' doc='Log noticeable messages and higher levels' />
624 <param name='error' doc='Log error messages and higher levels' />
625 <param name='fatal' doc='Log only fatal messages' />
626 </params>
627 </command>
628 <command id='logging level force-all (debug|info|notice|error|fatal)'>
629 <params>
630 <param name='logging' doc='Configure logging' />
631 <param name='level' doc='Set the log level for a specified category' />
632 <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.' />
633 <param name='debug' doc='Log debug messages and higher levels' />
634 <param name='info' doc='Log informational messages and higher levels' />
635 <param name='notice' doc='Log noticeable messages and higher levels' />
636 <param name='error' doc='Log error messages and higher levels' />
637 <param name='fatal' doc='Log only fatal messages' />
638 </params>
639 </command>
640 <command id='no logging level force-all'>
641 <params>
642 <param name='no' doc='Negate a command or set its defaults' />
643 <param name='logging' doc='Configure logging' />
644 <param name='level' doc='Set the log level for a specified category' />
645 <param name='force-all' doc='Release any globally forced log level set with &apos;logging level force-all &lt;level&gt;&apos;' />
646 </params>
647 </command>
Pau Espin Pedrolf464fff2020-08-18 12:50:21 +0200[diff] [blame^]648 <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'>
649 <params>
650 <param name='logp' doc='Print a message on all log outputs; useful for placing markers in test logs' />
651 <param name='main' doc='Main Program' />
652 <param name='db' doc='Database Layer' />
653 <param name='auc' doc='Authentication Center' />
654 <param name='ss' doc='Supplementary Services' />
655 <param name='mslookup' doc='Mobile Subscriber Lookup' />
656 <param name='lu' doc='Location Updating' />
657 <param name='dgsm' doc='Distributed GSM: MS lookup and proxy' />
658 <param name='lglobal' doc='Library-internal global log family' />
659 <param name='llapd' doc='LAPD in libosmogsm' />
660 <param name='linp' doc='A-bis Intput Subsystem' />
661 <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' />
662 <param name='lmi' doc='A-bis Input Driver for Signalling' />
663 <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' />
664 <param name='lsms' doc='Layer3 Short Message Service (SMS)' />
665 <param name='lctrl' doc='Control Interface' />
666 <param name='lgtp' doc='GPRS GTP library' />
667 <param name='lstats' doc='Statistics messages and logging' />
668 <param name='lgsup' doc='Generic Subscriber Update Protocol' />
669 <param name='loap' doc='Osmocom Authentication Protocol' />
670 <param name='lss7' doc='libosmo-sigtran Signalling System 7' />
671 <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' />
672 <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' />
673 <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' />
674 <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' />
675 <param name='ljibuf' doc='libosmo-netif Jitter Buffer' />
676 <param name='lrspro' doc='Remote SIM protocol' />
677 <param name='debug' doc='Log debug messages and higher levels' />
678 <param name='info' doc='Log informational messages and higher levels' />
679 <param name='notice' doc='Log noticeable messages and higher levels' />
680 <param name='error' doc='Log error messages and higher levels' />
681 <param name='fatal' doc='Log only fatal messages' />
682 <param name='.LOGMESSAGE' doc='Arbitrary message to log on given category and log level' />
683 </params>
684 </command>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]685 <command id='show logging vty'>
686 <params>
687 <param name='show' doc='Show running system information' />
688 <param name='logging' doc='Show current logging configuration' />
689 <param name='vty' doc='Show current logging configuration for this vty' />
690 </params>
691 </command>
692 <command id='show alarms'>
693 <params>
694 <param name='show' doc='Show running system information' />
695 <param name='alarms' doc='Show current logging configuration' />
696 </params>
697 </command>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]698 <command id='show talloc-context (application|all) (full|brief|DEPTH)'>
699 <params>
700 <param name='show' doc='Show running system information' />
701 <param name='talloc-context' doc='Show talloc memory hierarchy' />
702 <param name='application' doc='Application&apos;s context' />
703 <param name='all' doc='All contexts, if NULL-context tracking is enabled' />
704 <param name='full' doc='Display a full talloc memory hierarchy' />
705 <param name='brief' doc='Display a brief talloc memory hierarchy' />
706 <param name='DEPTH' doc='Specify required maximal depth value' />
707 </params>
708 </command>
709 <command id='show talloc-context (application|all) (full|brief|DEPTH) tree ADDRESS'>
710 <params>
711 <param name='show' doc='Show running system information' />
712 <param name='talloc-context' doc='Show talloc memory hierarchy' />
713 <param name='application' doc='Application&apos;s context' />
714 <param name='all' doc='All contexts, if NULL-context tracking is enabled' />
715 <param name='full' doc='Display a full talloc memory hierarchy' />
716 <param name='brief' doc='Display a brief talloc memory hierarchy' />
717 <param name='DEPTH' doc='Specify required maximal depth value' />
718 <param name='tree' doc='Display only a specific memory chunk' />
719 <param name='ADDRESS' doc='Chunk address (e.g. 0xdeadbeef)' />
720 </params>
721 </command>
722 <command id='show talloc-context (application|all) (full|brief|DEPTH) filter REGEXP'>
723 <params>
724 <param name='show' doc='Show running system information' />
725 <param name='talloc-context' doc='Show talloc memory hierarchy' />
726 <param name='application' doc='Application&apos;s context' />
727 <param name='all' doc='All contexts, if NULL-context tracking is enabled' />
728 <param name='full' doc='Display a full talloc memory hierarchy' />
729 <param name='brief' doc='Display a brief talloc memory hierarchy' />
730 <param name='DEPTH' doc='Specify required maximal depth value' />
731 <param name='filter' doc='Filter chunks using regular expression' />
732 <param name='REGEXP' doc='Regular expression' />
733 </params>
734 </command>
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]735 <command id='show stats'>
736 <params>
737 <param name='show' doc='Show running system information' />
738 <param name='stats' doc='Show statistical values' />
739 </params>
740 </command>
741 <command id='show stats level (global|peer|subscriber)'>
742 <params>
743 <param name='show' doc='Show running system information' />
744 <param name='stats' doc='Show statistical values' />
745 <param name='level' doc='Set the maximum group level' />
746 <param name='global' doc='Show global groups only' />
747 <param name='peer' doc='Show global and network peer related groups' />
748 <param name='subscriber' doc='Show global, peer, and subscriber groups' />
749 </params>
750 </command>
751 <command id='show asciidoc counters'>
752 <params>
753 <param name='show' doc='Show running system information' />
754 <param name='asciidoc' doc='Asciidoc generation' />
755 <param name='counters' doc='Generate table of all registered counters' />
756 </params>
757 </command>
758 <command id='show rate-counters'>
759 <params>
760 <param name='show' doc='Show running system information' />
761 <param name='rate-counters' doc='Show all rate counters' />
762 </params>
763 </command>
Pau Espin Pedrolf464fff2020-08-18 12:50:21 +0200[diff] [blame^]764 <command id='stats report'>
765 <params>
766 <param name='stats' doc='Stats related commands' />
767 <param name='report' doc='Manurally trigger reporting of stats' />
768 </params>
769 </command>
770 <command id='stats reset'>
771 <params>
772 <param name='stats' doc='Stats related commands' />
773 <param name='reset' doc='Reset all stats' />
774 </params>
775 </command>
Neels Hofmeyrbf6b4eb2018-11-05 03:18:46 +0100[diff] [blame]776 <command id='show gsup-connections'>
777 <params>
778 <param name='show' doc='Show running system information' />
779 <param name='gsup-connections' doc='GSUP Connections from VLRs, SGSNs, EUSEs' />
780 </params>
781 </command>
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]782 <command id='subscriber (imsi|msisdn|id|imei) IDENT show'>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]783 <params>
784 <param name='subscriber' doc='Subscriber management commands' />
785 <param name='imsi' doc='Identify subscriber by IMSI' />
786 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
787 <param name='id' doc='Identify subscriber by database ID' />
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]788 <param name='imei' doc='Identify subscriber by IMEI' />
789 <param name='IDENT' doc='IMSI/MSISDN/ID/IMEI of the subscriber' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]790 <param name='show' doc='Show subscriber information' />
791 </params>
792 </command>
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]793 <command id='show subscriber (imsi|msisdn|id|imei) IDENT'>
794 <params>
795 <param name='show' doc='Show running system information' />
796 <param name='subscriber' doc='Subscriber management commands' />
797 <param name='imsi' doc='Identify subscriber by IMSI' />
798 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
799 <param name='id' doc='Identify subscriber by database ID' />
800 <param name='imei' doc='Identify subscriber by IMEI' />
801 <param name='IDENT' doc='IMSI/MSISDN/ID/IMEI of the subscriber' />
802 </params>
803 </command>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]804 <command id='subscriber imsi IDENT create'>
805 <params>
806 <param name='subscriber' doc='Subscriber management commands' />
Neels Hofmeyrbf6b4eb2018-11-05 03:18:46 +0100[diff] [blame]807 <param name='imsi' doc='Identify subscriber by IMSI' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]808 <param name='IDENT' doc='IMSI/MSISDN/ID of the subscriber' />
Neels Hofmeyrbf6b4eb2018-11-05 03:18:46 +0100[diff] [blame]809 <param name='create' doc='Create subscriber by IMSI' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]810 </params>
811 </command>
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]812 <command id='subscriber (imsi|msisdn|id|imei) IDENT delete'>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]813 <params>
814 <param name='subscriber' doc='Subscriber management commands' />
815 <param name='imsi' doc='Identify subscriber by IMSI' />
816 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
817 <param name='id' doc='Identify subscriber by database ID' />
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]818 <param name='imei' doc='Identify subscriber by IMEI' />
819 <param name='IDENT' doc='IMSI/MSISDN/ID/IMEI of the subscriber' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]820 <param name='delete' doc='Delete subscriber from database' />
821 </params>
822 </command>
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]823 <command id='subscriber (imsi|msisdn|id|imei) IDENT update msisdn (none|MSISDN)'>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]824 <params>
825 <param name='subscriber' doc='Subscriber management commands' />
826 <param name='imsi' doc='Identify subscriber by IMSI' />
827 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
828 <param name='id' doc='Identify subscriber by database ID' />
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]829 <param name='imei' doc='Identify subscriber by IMEI' />
830 <param name='IDENT' doc='IMSI/MSISDN/ID/IMEI of the subscriber' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]831 <param name='update' doc='Set or update subscriber data' />
832 <param name='msisdn' doc='Set MSISDN (phone number) of the subscriber' />
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]833 <param name='none' doc='Remove MSISDN (phone number)' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]834 <param name='MSISDN' doc='New MSISDN (phone number)' />
835 </params>
836 </command>
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]837 <command id='subscriber (imsi|msisdn|id|imei) IDENT update aud2g none'>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]838 <params>
839 <param name='subscriber' doc='Subscriber management commands' />
840 <param name='imsi' doc='Identify subscriber by IMSI' />
841 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
842 <param name='id' doc='Identify subscriber by database ID' />
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]843 <param name='imei' doc='Identify subscriber by IMEI' />
844 <param name='IDENT' doc='IMSI/MSISDN/ID/IMEI of the subscriber' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]845 <param name='update' doc='Set or update subscriber data' />
846 <param name='aud2g' doc='Set 2G authentication data' />
847 <param name='none' doc='Delete 2G authentication data' />
848 </params>
849 </command>
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]850 <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]851 <params>
852 <param name='subscriber' doc='Subscriber management commands' />
853 <param name='imsi' doc='Identify subscriber by IMSI' />
854 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
855 <param name='id' doc='Identify subscriber by database ID' />
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]856 <param name='imei' doc='Identify subscriber by IMEI' />
857 <param name='IDENT' doc='IMSI/MSISDN/ID/IMEI of the subscriber' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]858 <param name='update' doc='Set or update subscriber data' />
859 <param name='aud2g' doc='Set 2G authentication data' />
860 <param name='comp128v1' doc='Use COMP128v1 algorithm' />
861 <param name='comp128v2' doc='Use COMP128v2 algorithm' />
862 <param name='comp128v3' doc='Use COMP128v3 algorithm' />
863 <param name='xor' doc='Use XOR algorithm' />
864 <param name='ki' doc='Set Ki Encryption Key' />
865 <param name='KI' doc='Ki as 32 hexadecimal characters' />
866 </params>
867 </command>
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]868 <command id='subscriber (imsi|msisdn|id|imei) IDENT update aud3g none'>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]869 <params>
870 <param name='subscriber' doc='Subscriber management commands' />
871 <param name='imsi' doc='Identify subscriber by IMSI' />
872 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
873 <param name='id' doc='Identify subscriber by database ID' />
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]874 <param name='imei' doc='Identify subscriber by IMEI' />
875 <param name='IDENT' doc='IMSI/MSISDN/ID/IMEI of the subscriber' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]876 <param name='update' doc='Set or update subscriber data' />
877 <param name='aud3g' doc='Set UMTS authentication data (3G, and 2G with UMTS AKA)' />
878 <param name='none' doc='Delete 3G authentication data' />
879 </params>
880 </command>
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]881 <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]882 <params>
883 <param name='subscriber' doc='Subscriber management commands' />
884 <param name='imsi' doc='Identify subscriber by IMSI' />
885 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
886 <param name='id' doc='Identify subscriber by database ID' />
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]887 <param name='imei' doc='Identify subscriber by IMEI' />
888 <param name='IDENT' doc='IMSI/MSISDN/ID/IMEI of the subscriber' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]889 <param name='update' doc='Set or update subscriber data' />
890 <param name='aud3g' doc='Set UMTS authentication data (3G, and 2G with UMTS AKA)' />
891 <param name='milenage' doc='Use Milenage algorithm' />
892 <param name='k' doc='Set Encryption Key K' />
893 <param name='K' doc='K as 32 hexadecimal characters' />
894 <param name='op' doc='Set OP key' />
895 <param name='opc' doc='Set OPC key' />
896 <param name='OP_C' doc='OP or OPC as 32 hexadecimal characters' />
897 <param name='[ind-bitlen]' doc='Set IND bit length' />
898 <param name='[&lt;0-28&gt;]' doc='IND bit length value (default: 5)' />
899 </params>
900 </command>
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]901 <command id='subscriber (imsi|msisdn|id|imei) IDENT update imei (none|IMEI)'>
902 <params>
903 <param name='subscriber' doc='Subscriber management commands' />
904 <param name='imsi' doc='Identify subscriber by IMSI' />
905 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
906 <param name='id' doc='Identify subscriber by database ID' />
907 <param name='imei' doc='Identify subscriber by IMEI' />
908 <param name='IDENT' doc='IMSI/MSISDN/ID/IMEI of the subscriber' />
909 <param name='update' doc='Set or update subscriber data' />
910 <param name='imei' doc='Set IMEI of the subscriber (normally populated from MSC, no need to set this manually)' />
911 <param name='none' doc='Forget IMEI' />
912 <param name='IMEI' doc='Set IMEI (use for debug only!)' />
913 </params>
914 </command>
Oliver Smith3b33b012019-07-15 10:35:22 +0200[diff] [blame]915 <command id='subscriber (imsi|msisdn|id|imei) IDENT update network-access-mode (none|cs|ps|cs+ps)'>
916 <params>
917 <param name='subscriber' doc='Subscriber management commands' />
918 <param name='imsi' doc='Identify subscriber by IMSI' />
919 <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' />
920 <param name='id' doc='Identify subscriber by database ID' />
921 <param name='imei' doc='Identify subscriber by IMEI' />
922 <param name='IDENT' doc='IMSI/MSISDN/ID/IMEI of the subscriber' />
923 <param name='update' doc='Set or update subscriber data' />
924 <param name='network-access-mode' doc='Set Network Access Mode (NAM) of the subscriber' />
925 <param name='none' doc='Do not allow access to circuit switched or packet switched services' />
926 <param name='cs' doc='Allow access to circuit switched services only' />
927 <param name='ps' doc='Allow access to packet switched services only' />
928 <param name='cs+ps' doc='Allow access to both circuit and packet switched services' />
929 </params>
930 </command>
Pau Espin Pedrolf464fff2020-08-18 12:50:21 +0200[diff] [blame^]931 <command id='show mslookup services'>
932 <params>
933 <param name='show' doc='Show running system information' />
934 <param name='mslookup' doc='Distributed GSM / mslookup related information' />
935 <param name='services' doc='List configured service addresses as sent to remote mslookup requests' />
936 </params>
937 </command>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]938 </node>
939 <node id='config'>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]940 <name>config</name>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]941 <command id='hostname WORD'>
942 <params>
943 <param name='hostname' doc='Set system&apos;s network name' />
944 <param name='WORD' doc='This system&apos;s network name' />
945 </params>
946 </command>
947 <command id='no hostname [HOSTNAME]'>
948 <params>
949 <param name='no' doc='Negate a command or set its defaults' />
950 <param name='hostname' doc='Reset system&apos;s network name' />
951 <param name='[HOSTNAME]' doc='Host name of this router' />
952 </params>
953 </command>
954 <command id='password (8|) WORD'>
955 <params>
956 <param name='password' doc='Assign the terminal connection password' />
957 <param name='8' doc='Specifies a HIDDEN password will follow' />
958 <param name='' doc='dummy string ' />
959 <param name='WORD' doc='The HIDDEN line password string' />
960 </params>
961 </command>
962 <command id='password LINE'>
963 <params>
964 <param name='password' doc='Assign the terminal connection password' />
965 <param name='LINE' doc='The UNENCRYPTED (cleartext) line password' />
966 </params>
967 </command>
968 <command id='enable password (8|) WORD'>
969 <params>
970 <param name='enable' doc='Modify enable password parameters' />
971 <param name='password' doc='Assign the privileged level password' />
972 <param name='8' doc='Specifies a HIDDEN password will follow' />
973 <param name='' doc='dummy string ' />
974 <param name='WORD' doc='The HIDDEN &apos;enable&apos; password string' />
975 </params>
976 </command>
977 <command id='enable password LINE'>
978 <params>
979 <param name='enable' doc='Modify enable password parameters' />
980 <param name='password' doc='Assign the privileged level password' />
981 <param name='LINE' doc='The UNENCRYPTED (cleartext) &apos;enable&apos; password' />
982 </params>
983 </command>
984 <command id='no enable password'>
985 <params>
986 <param name='no' doc='Negate a command or set its defaults' />
987 <param name='enable' doc='Modify enable password parameters' />
988 <param name='password' doc='Assign the privileged level password' />
989 </params>
990 </command>
991 <command id='banner motd default'>
992 <params>
993 <param name='banner' doc='Set banner string' />
994 <param name='motd' doc='Strings for motd' />
995 <param name='default' doc='Default string' />
996 </params>
997 </command>
998 <command id='banner motd file [FILE]'>
999 <params>
1000 <param name='banner' doc='Set banner' />
1001 <param name='motd' doc='Banner for motd' />
1002 <param name='file' doc='Banner from a file' />
1003 <param name='[FILE]' doc='Filename' />
1004 </params>
1005 </command>
1006 <command id='no banner motd'>
1007 <params>
1008 <param name='no' doc='Negate a command or set its defaults' />
1009 <param name='banner' doc='Set banner string' />
1010 <param name='motd' doc='Strings for motd' />
1011 </params>
1012 </command>
1013 <command id='service terminal-length &lt;0-512&gt;'>
1014 <params>
1015 <param name='service' doc='Set up miscellaneous service' />
1016 <param name='terminal-length' doc='System wide terminal length configuration' />
1017 <param name='&lt;0-512&gt;' doc='Number of lines of VTY (0 means no line control)' />
1018 </params>
1019 </command>
1020 <command id='no service terminal-length [&lt;0-512&gt;]'>
1021 <params>
1022 <param name='no' doc='Negate a command or set its defaults' />
1023 <param name='service' doc='Set up miscellaneous service' />
1024 <param name='terminal-length' doc='System wide terminal length configuration' />
1025 <param name='[&lt;0-512&gt;]' doc='Number of lines of VTY (0 means no line control)' />
1026 </params>
1027 </command>
1028 <command id='line vty'>
1029 <params>
1030 <param name='line' doc='Configure a terminal line' />
1031 <param name='vty' doc='Virtual terminal' />
1032 </params>
1033 </command>
1034 <command id='service advanced-vty'>
1035 <params>
1036 <param name='service' doc='Set up miscellaneous service' />
1037 <param name='advanced-vty' doc='Enable advanced mode vty interface' />
1038 </params>
1039 </command>
1040 <command id='no service advanced-vty'>
1041 <params>
1042 <param name='no' doc='Negate a command or set its defaults' />
1043 <param name='service' doc='Set up miscellaneous service' />
1044 <param name='advanced-vty' doc='Enable advanced mode vty interface' />
1045 </params>
1046 </command>
1047 <command id='show history'>
1048 <params>
1049 <param name='show' doc='Show running system information' />
1050 <param name='history' doc='Display the session command history' />
1051 </params>
1052 </command>
1053 <command id='ctrl'>
1054 <params>
1055 <param name='ctrl' doc='Configure the Control Interface' />
1056 </params>
1057 </command>
1058 <command id='log stderr'>
1059 <params>
1060 <param name='log' doc='Configure logging sub-system' />
1061 <param name='stderr' doc='Logging via STDERR of the process' />
1062 </params>
1063 </command>
1064 <command id='no log stderr'>
1065 <params>
1066 <param name='no' doc='Negate a command or set its defaults' />
1067 <param name='log' doc='Configure logging sub-system' />
1068 <param name='stderr' doc='Logging via STDERR of the process' />
1069 </params>
1070 </command>
1071 <command id='log file .FILENAME'>
1072 <params>
1073 <param name='log' doc='Configure logging sub-system' />
1074 <param name='file' doc='Logging to text file' />
1075 <param name='.FILENAME' doc='Filename' />
1076 </params>
1077 </command>
1078 <command id='no log file .FILENAME'>
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='file' doc='Logging to text file' />
1083 <param name='.FILENAME' doc='Filename' />
1084 </params>
1085 </command>
1086 <command id='log alarms &lt;2-32700&gt;'>
1087 <params>
1088 <param name='log' doc='Configure logging sub-system' />
1089 <param name='alarms' doc='Logging alarms to osmo_strrb' />
1090 <param name='&lt;2-32700&gt;' doc='Maximum number of messages to log' />
1091 </params>
1092 </command>
1093 <command id='no log alarms'>
1094 <params>
1095 <param name='no' doc='Negate a command or set its defaults' />
1096 <param name='log' doc='Configure logging sub-system' />
1097 <param name='alarms' doc='Logging alarms to osmo_strrb' />
1098 </params>
1099 </command>
1100 <command id='log syslog (authpriv|cron|daemon|ftp|lpr|mail|news|user|uucp)'>
1101 <params>
1102 <param name='log' doc='Configure logging sub-system' />
1103 <param name='syslog' doc='Logging via syslog' />
1104 <param name='authpriv' doc='Security/authorization messages facility' />
1105 <param name='cron' doc='Clock daemon (cron/at) facility' />
1106 <param name='daemon' doc='General system daemon facility' />
1107 <param name='ftp' doc='Ftp daemon facility' />
1108 <param name='lpr' doc='Line printer facility' />
1109 <param name='mail' doc='Mail facility' />
1110 <param name='news' doc='News facility' />
1111 <param name='user' doc='Generic facility' />
1112 <param name='uucp' doc='UUCP facility' />
1113 </params>
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]1114 </command>
1115 <command id='log syslog local &lt;0-7&gt;'>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1116 <params>
1117 <param name='log' doc='Configure logging sub-system' />
1118 <param name='syslog' doc='Logging via syslog' />
1119 <param name='local' doc='Syslog LOCAL facility' />
1120 <param name='&lt;0-7&gt;' doc='Local facility number' />
1121 </params>
1122 </command>
1123 <command id='no log syslog'>
1124 <params>
1125 <param name='no' doc='Negate a command or set its defaults' />
1126 <param name='log' doc='Configure logging sub-system' />
1127 <param name='syslog' doc='Logging via syslog' />
1128 </params>
1129 </command>
1130 <command id='log gsmtap [HOSTNAME]'>
1131 <params>
1132 <param name='log' doc='Configure logging sub-system' />
1133 <param name='gsmtap' doc='Logging via GSMTAP' />
1134 <param name='[HOSTNAME]' doc='Host name to send the GSMTAP logging to (UDP port 4729)' />
1135 </params>
1136 </command>
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]1137 <command id='stats reporter statsd'>
1138 <params>
1139 <param name='stats' doc='Configure stats sub-system' />
1140 <param name='reporter' doc='Configure a stats reporter' />
1141 <param name='statsd' doc='Report to a STATSD server' />
1142 </params>
1143 </command>
1144 <command id='no stats reporter statsd'>
1145 <params>
1146 <param name='no' doc='Negate a command or set its defaults' />
1147 <param name='stats' doc='Configure stats sub-system' />
1148 <param name='reporter' doc='Configure a stats reporter' />
1149 <param name='statsd' doc='Report to a STATSD server' />
1150 </params>
1151 </command>
1152 <command id='stats reporter log'>
1153 <params>
1154 <param name='stats' doc='Configure stats sub-system' />
1155 <param name='reporter' doc='Configure a stats reporter' />
1156 <param name='log' doc='Report to the logger' />
1157 </params>
1158 </command>
1159 <command id='no stats reporter log'>
1160 <params>
1161 <param name='no' doc='Negate a command or set its defaults' />
1162 <param name='stats' doc='Configure stats sub-system' />
1163 <param name='reporter' doc='Configure a stats reporter' />
1164 <param name='log' doc='Report to the logger' />
1165 </params>
1166 </command>
Pau Espin Pedrolf464fff2020-08-18 12:50:21 +0200[diff] [blame^]1167 <command id='stats interval &lt;0-65535&gt;'>
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]1168 <params>
1169 <param name='stats' doc='Configure stats sub-system' />
1170 <param name='interval' doc='Set the reporting interval' />
Pau Espin Pedrolf464fff2020-08-18 12:50:21 +0200[diff] [blame^]1171 <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]1172 </params>
1173 </command>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1174 <command id='hlr'>
1175 <params>
1176 <param name='hlr' doc='Configure the HLR' />
1177 </params>
1178 </command>
Pau Espin Pedrolf464fff2020-08-18 12:50:21 +0200[diff] [blame^]1179 <command id='mslookup'>
1180 <params>
1181 <param name='mslookup' doc='Configure Distributed GSM mslookup' />
1182 </params>
1183 </command>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1184 </node>
1185 <node id='config-log'>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]1186 <name>config-log</name>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1187 <command id='logging filter all (0|1)'>
1188 <params>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]1189 <param name='logging' doc='Configure logging' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1190 <param name='filter' doc='Filter log messages' />
1191 <param name='all' doc='Do you want to log all messages?' />
1192 <param name='0' doc='Only print messages matched by other filters' />
1193 <param name='1' doc='Bypass filter and print all messages' />
1194 </params>
1195 </command>
1196 <command id='logging color (0|1)'>
1197 <params>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]1198 <param name='logging' doc='Configure logging' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1199 <param name='color' doc='Configure color-printing for log messages' />
1200 <param name='0' doc='Don&apos;t use color for printing messages' />
1201 <param name='1' doc='Use color for printing messages' />
1202 </params>
1203 </command>
1204 <command id='logging timestamp (0|1)'>
1205 <params>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]1206 <param name='logging' doc='Configure logging' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1207 <param name='timestamp' doc='Configure log message timestamping' />
1208 <param name='0' doc='Don&apos;t prefix each log message' />
1209 <param name='1' doc='Prefix each log message with current timestamp' />
1210 </params>
1211 </command>
1212 <command id='logging print extended-timestamp (0|1)'>
1213 <params>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]1214 <param name='logging' doc='Configure logging' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1215 <param name='print' doc='Log output settings' />
1216 <param name='extended-timestamp' doc='Configure log message timestamping' />
1217 <param name='0' doc='Don&apos;t prefix each log message' />
1218 <param name='1' doc='Prefix each log message with current timestamp with YYYYMMDDhhmmssnnn' />
1219 </params>
1220 </command>
1221 <command id='logging print category (0|1)'>
1222 <params>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]1223 <param name='logging' doc='Configure logging' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1224 <param name='print' doc='Log output settings' />
1225 <param name='category' doc='Configure log message' />
1226 <param name='0' doc='Don&apos;t prefix each log message' />
1227 <param name='1' doc='Prefix each log message with category/subsystem name' />
1228 </params>
1229 </command>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]1230 <command id='logging print category-hex (0|1)'>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1231 <params>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]1232 <param name='logging' doc='Configure logging' />
1233 <param name='print' doc='Log output settings' />
1234 <param name='category-hex' doc='Configure log message' />
1235 <param name='0' doc='Don&apos;t prefix each log message' />
1236 <param name='1' doc='Prefix each log message with category/subsystem nr in hex (&apos;&lt;000b&gt;&apos;)' />
1237 </params>
1238 </command>
1239 <command id='logging print level (0|1)'>
1240 <params>
1241 <param name='logging' doc='Configure logging' />
1242 <param name='print' doc='Log output settings' />
1243 <param name='level' doc='Configure log message' />
1244 <param name='0' doc='Don&apos;t prefix each log message' />
1245 <param name='1' doc='Prefix each log message with the log level name' />
1246 </params>
1247 </command>
Neels Hofmeyrbf6b4eb2018-11-05 03:18:46 +0100[diff] [blame]1248 <command id='logging print file (0|1|basename) [last]'>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]1249 <params>
1250 <param name='logging' doc='Configure logging' />
1251 <param name='print' doc='Log output settings' />
1252 <param name='file' doc='Configure log message' />
1253 <param name='0' doc='Don&apos;t prefix each log message' />
1254 <param name='1' doc='Prefix each log message with the source file and line' />
1255 <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]1256 <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]1257 </params>
1258 </command>
Pau Espin Pedrolf464fff2020-08-18 12:50:21 +0200[diff] [blame^]1259 <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]1260 <params>
1261 <param name='logging' doc='Configure logging' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1262 <param name='level' doc='Set the log level for a specified category' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1263 <param name='main' doc='Main Program' />
1264 <param name='db' doc='Database Layer' />
1265 <param name='auc' doc='Authentication Center' />
Neels Hofmeyrbf6b4eb2018-11-05 03:18:46 +0100[diff] [blame]1266 <param name='ss' doc='Supplementary Services' />
Pau Espin Pedrolf464fff2020-08-18 12:50:21 +0200[diff] [blame^]1267 <param name='mslookup' doc='Mobile Subscriber Lookup' />
1268 <param name='lu' doc='Location Updating' />
1269 <param name='dgsm' doc='Distributed GSM: MS lookup and proxy' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1270 <param name='lglobal' doc='Library-internal global log family' />
1271 <param name='llapd' doc='LAPD in libosmogsm' />
1272 <param name='linp' doc='A-bis Intput Subsystem' />
1273 <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' />
1274 <param name='lmi' doc='A-bis Input Driver for Signalling' />
1275 <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' />
1276 <param name='lsms' doc='Layer3 Short Message Service (SMS)' />
1277 <param name='lctrl' doc='Control Interface' />
1278 <param name='lgtp' doc='GPRS GTP library' />
1279 <param name='lstats' doc='Statistics messages and logging' />
1280 <param name='lgsup' doc='Generic Subscriber Update Protocol' />
1281 <param name='loap' doc='Osmocom Authentication Protocol' />
1282 <param name='lss7' doc='libosmo-sigtran Signalling System 7' />
1283 <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' />
1284 <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' />
1285 <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' />
1286 <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' />
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]1287 <param name='ljibuf' doc='libosmo-netif Jitter Buffer' />
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]1288 <param name='lrspro' doc='Remote SIM protocol' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1289 <param name='debug' doc='Log debug messages and higher levels' />
1290 <param name='info' doc='Log informational messages and higher levels' />
1291 <param name='notice' doc='Log noticeable messages and higher levels' />
1292 <param name='error' doc='Log error messages and higher levels' />
1293 <param name='fatal' doc='Log only fatal messages' />
1294 </params>
1295 </command>
Neels Hofmeyrbf6b4eb2018-11-05 03:18:46 +0100[diff] [blame]1296 <command id='logging level set-all (debug|info|notice|error|fatal)'>
1297 <params>
1298 <param name='logging' doc='Configure logging' />
1299 <param name='level' doc='Set the log level for a specified category' />
1300 <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.' />
1301 <param name='debug' doc='Log debug messages and higher levels' />
1302 <param name='info' doc='Log informational messages and higher levels' />
1303 <param name='notice' doc='Log noticeable messages and higher levels' />
1304 <param name='error' doc='Log error messages and higher levels' />
1305 <param name='fatal' doc='Log only fatal messages' />
1306 </params>
1307 </command>
1308 <command id='logging level force-all (debug|info|notice|error|fatal)'>
1309 <params>
1310 <param name='logging' doc='Configure logging' />
1311 <param name='level' doc='Set the log level for a specified category' />
1312 <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.' />
1313 <param name='debug' doc='Log debug messages and higher levels' />
1314 <param name='info' doc='Log informational messages and higher levels' />
1315 <param name='notice' doc='Log noticeable messages and higher levels' />
1316 <param name='error' doc='Log error messages and higher levels' />
1317 <param name='fatal' doc='Log only fatal messages' />
1318 </params>
1319 </command>
1320 <command id='no logging level force-all'>
1321 <params>
1322 <param name='no' doc='Negate a command or set its defaults' />
1323 <param name='logging' doc='Configure logging' />
1324 <param name='level' doc='Set the log level for a specified category' />
1325 <param name='force-all' doc='Release any globally forced log level set with &apos;logging level force-all &lt;level&gt;&apos;' />
1326 </params>
1327 </command>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1328 </node>
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]1329 <node id='config-stats'>
1330 <name>config-stats</name>
1331 <command id='local-ip ADDR'>
1332 <params>
1333 <param name='local-ip' doc='Set the IP address to which we bind locally' />
1334 <param name='ADDR' doc='IP Address' />
1335 </params>
1336 </command>
1337 <command id='no local-ip'>
1338 <params>
1339 <param name='no' doc='Negate a command or set its defaults' />
1340 <param name='local-ip' doc='Set the IP address to which we bind locally' />
1341 </params>
1342 </command>
1343 <command id='remote-ip ADDR'>
1344 <params>
1345 <param name='remote-ip' doc='Set the remote IP address to which we connect' />
1346 <param name='ADDR' doc='IP Address' />
1347 </params>
1348 </command>
1349 <command id='remote-port &lt;1-65535&gt;'>
1350 <params>
1351 <param name='remote-port' doc='Set the remote port to which we connect' />
1352 <param name='&lt;1-65535&gt;' doc='Remote port number' />
1353 </params>
1354 </command>
1355 <command id='mtu &lt;100-65535&gt;'>
1356 <params>
1357 <param name='mtu' doc='Set the maximum packet size' />
1358 <param name='&lt;100-65535&gt;' doc='Size in byte' />
1359 </params>
1360 </command>
1361 <command id='no mtu'>
1362 <params>
1363 <param name='no' doc='Negate a command or set its defaults' />
1364 <param name='mtu' doc='Set the maximum packet size' />
1365 </params>
1366 </command>
1367 <command id='prefix PREFIX'>
1368 <params>
1369 <param name='prefix' doc='Set the item name prefix' />
1370 <param name='PREFIX' doc='The prefix string' />
1371 </params>
1372 </command>
1373 <command id='no prefix'>
1374 <params>
1375 <param name='no' doc='Negate a command or set its defaults' />
1376 <param name='prefix' doc='Set the item name prefix' />
1377 </params>
1378 </command>
1379 <command id='level (global|peer|subscriber)'>
1380 <params>
1381 <param name='level' doc='Set the maximum group level' />
1382 <param name='global' doc='Report global groups only' />
1383 <param name='peer' doc='Report global and network peer related groups' />
1384 <param name='subscriber' doc='Report global, peer, and subscriber groups' />
1385 </params>
1386 </command>
1387 <command id='enable'>
1388 <params>
1389 <param name='enable' doc='Enable the reporter' />
1390 </params>
1391 </command>
1392 <command id='disable'>
1393 <params>
1394 <param name='disable' doc='Disable the reporter' />
1395 </params>
1396 </command>
Pau Espin Pedrolf464fff2020-08-18 12:50:21 +0200[diff] [blame^]1397 <command id='flush-period &lt;0-65535&gt;'>
1398 <params>
1399 <param name='flush-period' doc='Configure stats sub-system' />
1400 <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).' />
1401 </params>
1402 </command>
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]1403 </node>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1404 <node id='config-line'>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]1405 <name>config-line</name>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1406 <command id='login'>
1407 <params>
1408 <param name='login' doc='Enable password checking' />
1409 </params>
1410 </command>
1411 <command id='no login'>
1412 <params>
1413 <param name='no' doc='Negate a command or set its defaults' />
1414 <param name='login' doc='Enable password checking' />
1415 </params>
1416 </command>
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]1417 <command id='bind A.B.C.D [&lt;0-65535&gt;]'>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1418 <params>
1419 <param name='bind' doc='Accept VTY telnet connections on local interface' />
1420 <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]1421 <param name='[&lt;0-65535&gt;]' doc='Local TCP port number' />
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1422 </params>
1423 </command>
1424 </node>
1425 <node id='config-ctrl'>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]1426 <name>config-ctrl</name>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1427 <command id='bind A.B.C.D'>
1428 <params>
1429 <param name='bind' doc='Set bind address to listen for Control connections' />
1430 <param name='A.B.C.D' doc='Local IP address (default 127.0.0.1)' />
1431 </params>
1432 </command>
1433 </node>
1434 <node id='config-hlr'>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]1435 <name>config-hlr</name>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1436 <command id='gsup'>
1437 <params>
1438 <param name='gsup' doc='Configure GSUP options' />
1439 </params>
1440 </command>
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]1441 <command id='database PATH'>
1442 <params>
1443 <param name='database' doc='Set the path to the HLR database file' />
1444 <param name='PATH' doc='Relative or absolute file system path to the database file (default is &apos;hlr.db&apos;)' />
1445 </params>
1446 </command>
Neels Hofmeyrbf6b4eb2018-11-05 03:18:46 +0100[diff] [blame]1447 <command id='euse NAME'>
1448 <params>
1449 <param name='euse' doc='Configure a particular External USSD Entity' />
1450 <param name='NAME' doc='Alphanumeric name of the External USSD Entity' />
1451 </params>
1452 </command>
1453 <command id='no euse NAME'>
1454 <params>
1455 <param name='no' doc='Negate a command or set its defaults' />
1456 <param name='euse' doc='Remove a particular External USSD Entity' />
1457 <param name='NAME' doc='Alphanumeric name of the External USSD Entity' />
1458 </params>
1459 </command>
1460 <command id='ussd route prefix PREFIX internal (own-msisdn|own-imsi)'>
1461 <params>
1462 <param name='ussd' doc='USSD Configuration' />
1463 <param name='route' doc='Routing Configuration' />
1464 <param name='prefix' doc='Prefix-Matching Route' />
1465 <param name='PREFIX' doc='USSD Prefix' />
1466 <param name='internal' doc='Internal USSD Handler' />
1467 <param name='own-msisdn' doc='Respond with subscribers&apos; own MSISDN' />
1468 <param name='own-imsi' doc='Respond with subscribers&apos; own IMSI' />
1469 </params>
1470 </command>
1471 <command id='ussd route prefix PREFIX external EUSE'>
1472 <params>
1473 <param name='ussd' doc='USSD Configuration' />
1474 <param name='route' doc='Routing Configuration' />
1475 <param name='prefix' doc='Prefix-Matching Route' />
1476 <param name='PREFIX' doc='USSD Prefix' />
1477 <param name='external' doc='External USSD Handler' />
1478 <param name='EUSE' doc='Name of External USSD Handler (IPA CCM ID)' />
1479 </params>
1480 </command>
1481 <command id='no ussd route prefix PREFIX'>
1482 <params>
1483 <param name='no' doc='Negate a command or set its defaults' />
1484 <param name='ussd' doc='USSD Configuration' />
1485 <param name='route' doc='Routing Configuration' />
1486 <param name='prefix' doc='Prefix-Matching Route' />
1487 <param name='PREFIX' doc='USSD Prefix' />
1488 </params>
1489 </command>
1490 <command id='ussd default-route external EUSE'>
1491 <params>
1492 <param name='ussd' doc='USSD Configuration' />
1493 <param name='default-route' doc='Configure default-route for all USSD to unknown destinations' />
1494 <param name='external' doc='External USSD Handler' />
1495 <param name='EUSE' doc='Name of External USSD Handler (IPA CCM ID)' />
1496 </params>
1497 </command>
1498 <command id='no ussd default-route'>
1499 <params>
1500 <param name='no' doc='Negate a command or set its defaults' />
1501 <param name='ussd' doc='USSD Configuration' />
1502 <param name='default-route' doc='Remove the default-route for all USSD to unknown destinations' />
1503 </params>
1504 </command>
Daniel Willmann9ac494f2019-06-17 16:53:47 +0200[diff] [blame]1505 <command id='ncss-guard-timeout &lt;0-255&gt;'>
1506 <params>
1507 <param name='ncss-guard-timeout' doc='Set guard timer for NCSS (call independent SS) session activity' />
1508 <param name='&lt;0-255&gt;' doc='Guard timer value (sec.), or 0 to disable' />
1509 </params>
1510 </command>
1511 <command id='store-imei'>
1512 <params>
1513 <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;).' />
1514 </params>
1515 </command>
1516 <command id='no store-imei'>
1517 <params>
1518 <param name='no' doc='Do not save the IMEI in the database, when receiving Check IMEI requests.' />
1519 <param name='store-imei' doc='(null)' />
1520 </params>
1521 </command>
1522 <command id='subscriber-create-on-demand (no-msisdn|&lt;3-15&gt;) (none|cs|ps|cs+ps)'>
1523 <params>
1524 <param name='subscriber-create-on-demand' doc='Make a new record when a subscriber is first seen.' />
1525 <param name='no-msisdn' doc='Do not automatically assign MSISDN.' />
1526 <param name='&lt;3-15&gt;' doc='Length of an automatically assigned MSISDN.' />
1527 <param name='none' doc='Do not allow any NAM (Network Access Mode) by default.' />
1528 <param name='cs' doc='Allow access to circuit switched NAM by default.' />
1529 <param name='ps' doc='Allow access to packet switched NAM by default.' />
1530 <param name='cs+ps' doc='Allow access to circuit and packet switched NAM by default.' />
1531 </params>
1532 </command>
1533 <command id='no subscriber-create-on-demand'>
1534 <params>
1535 <param name='no' doc='Do not make a new record when a subscriber is first seen.' />
1536 <param name='subscriber-create-on-demand' doc='(null)' />
1537 </params>
1538 </command>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1539 </node>
1540 <node id='config-hlr-gsup'>
Neels Hofmeyr92e49ef2018-03-06 15:13:25 +0100[diff] [blame]1541 <name>config-hlr-gsup</name>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1542 <command id='bind ip A.B.C.D'>
1543 <params>
1544 <param name='bind' doc='Listen/Bind related socket option' />
1545 <param name='ip' doc='IP information' />
1546 <param name='A.B.C.D' doc='IPv4 Address to bind the GSUP interface to' />
1547 </params>
1548 </command>
Pau Espin Pedrolf464fff2020-08-18 12:50:21 +0200[diff] [blame^]1549 <command id='ipa-name NAME'>
1550 <params>
1551 <param name='ipa-name' doc='Set the IPA name of this HLR, for proxying to remote HLRs' />
1552 <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).' />
1553 </params>
1554 </command>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1555 </node>
Neels Hofmeyrbf6b4eb2018-11-05 03:18:46 +0100[diff] [blame]1556 <node id='config-hlr-euse'>
1557 <name>config-hlr-euse</name>
1558 </node>
Pau Espin Pedrolf464fff2020-08-18 12:50:21 +0200[diff] [blame^]1559 <node id='config-mslookup'>
1560 <name>config-mslookup</name>
1561 <command id='mdns bind [IP] [&lt;1-65535&gt;]'>
1562 <params>
1563 <param name='mdns' doc='Multicast DNS related configuration' />
1564 <param name='bind' doc='Convenience shortcut: enable and configure both server and client for mDNS mslookup' />
1565 <param name='[IP]' doc='multicast IPv4 address like 239.192.23.42 or IPv6 address like ff08::23:42' />
1566 <param name='[&lt;1-65535&gt;]' doc='mDNS UDP Port number' />
1567 </params>
1568 </command>
1569 <command id='mdns domain-suffix DOMAIN_SUFFIX'>
1570 <params>
1571 <param name='mdns' doc='Multicast DNS related configuration' />
1572 <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' />
1573 <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' />
1574 </params>
1575 </command>
1576 <command id='no mdns bind'>
1577 <params>
1578 <param name='no' doc='Negate a command or set its defaults' />
1579 <param name='mdns' doc='Disable both server and client for mDNS mslookup' />
1580 <param name='bind' doc='(null)' />
1581 </params>
1582 </command>
1583 <command id='server'>
1584 <params>
1585 <param name='server' doc='Enable and configure Distributed GSM mslookup server' />
1586 </params>
1587 </command>
1588 <command id='no server'>
1589 <params>
1590 <param name='no' doc='Negate a command or set its defaults' />
1591 <param name='server' doc='Disable Distributed GSM mslookup server' />
1592 </params>
1593 </command>
1594 <command id='client'>
1595 <params>
1596 <param name='client' doc='Enable and configure Distributed GSM mslookup client' />
1597 </params>
1598 </command>
1599 <command id='no client'>
1600 <params>
1601 <param name='no' doc='Negate a command or set its defaults' />
1602 <param name='client' doc='Disable Distributed GSM mslookup client' />
1603 </params>
1604 </command>
1605 </node>
1606 <node id='config-mslookup-server'>
1607 <name>config-mslookup-server</name>
1608 <command id='mdns bind [IP] [&lt;1-65535&gt;]'>
1609 <params>
1610 <param name='mdns' doc='Multicast DNS related configuration' />
1611 <param name='bind' doc='Configure where the mDNS server listens for mslookup requests' />
1612 <param name='[IP]' doc='multicast IPv4 address like 239.192.23.42 or IPv6 address like ff08::23:42' />
1613 <param name='[&lt;1-65535&gt;]' doc='mDNS UDP Port number' />
1614 </params>
1615 </command>
1616 <command id='mdns domain-suffix DOMAIN_SUFFIX'>
1617 <params>
1618 <param name='mdns' doc='Multicast DNS related configuration' />
1619 <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' />
1620 <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' />
1621 </params>
1622 </command>
1623 <command id='no mdns bind'>
1624 <params>
1625 <param name='no' doc='Negate a command or set its defaults' />
1626 <param name='mdns' doc='Disable server for mDNS mslookup (do not answer remote requests)' />
1627 <param name='bind' doc='(null)' />
1628 </params>
1629 </command>
1630 <command id='service NAME at IP &lt;1-65535&gt;'>
1631 <params>
1632 <param name='service' doc='Configure addresses of local services, as sent in replies to remote mslookup requests.' />
1633 <param name='NAME' doc='mslookup service name, e.g. sip.voice or smpp.sms' />
1634 <param name='at' doc='at' />
1635 <param name='IP' doc='IPv4 address like 1.2.3.4 or IPv6 address like a:b:c:d::1' />
1636 <param name='&lt;1-65535&gt;' doc='Service-specific port number' />
1637 </params>
1638 </command>
1639 <command id='no service NAME'>
1640 <params>
1641 <param name='no' doc='Negate a command or set its defaults' />
1642 <param name='service' doc='Remove one or more service address entries' />
1643 <param name='NAME' doc='mslookup service name, e.g. sip.voice or smpp.sms' />
1644 </params>
1645 </command>
1646 <command id='no service NAME at IP &lt;1-65535&gt;'>
1647 <params>
1648 <param name='no' doc='Negate a command or set its defaults' />
1649 <param name='service' doc='Remove one or more service address entries' />
1650 <param name='NAME' doc='mslookup service name, e.g. sip.voice or smpp.sms' />
1651 <param name='at' doc='at' />
1652 <param name='IP' doc='IPv4 address like 1.2.3.4 or IPv6 address like a:b:c:d::1' />
1653 <param name='&lt;1-65535&gt;' doc='Service-specific port number' />
1654 </params>
1655 </command>
1656 <command id='msc ipa-name .IPA_NAME'>
1657 <params>
1658 <param name='msc' doc='Configure services for individual local MSCs' />
1659 <param name='ipa-name' doc='Identify locally connected MSC by IPA Unit Name' />
1660 <param name='.IPA_NAME' doc='IPA Unit Name of the local MSC to configure' />
1661 </params>
1662 </command>
1663 </node>
1664 <node id='config-mslookup-server-msc'>
1665 <name>config-mslookup-server-msc</name>
1666 <command id='service NAME at IP &lt;1-65535&gt;'>
1667 <params>
1668 <param name='service' doc='Configure addresses of local services, as sent in replies to remote mslookup requests.' />
1669 <param name='NAME' doc='mslookup service name, e.g. sip.voice or smpp.sms' />
1670 <param name='at' doc='at' />
1671 <param name='IP' doc='IPv4 address like 1.2.3.4 or IPv6 address like a:b:c:d::1' />
1672 <param name='&lt;1-65535&gt;' doc='Service-specific port number' />
1673 </params>
1674 </command>
1675 <command id='no service NAME'>
1676 <params>
1677 <param name='no' doc='Negate a command or set its defaults' />
1678 <param name='service' doc='Remove one or more service address entries' />
1679 <param name='NAME' doc='mslookup service name, e.g. sip.voice or smpp.sms' />
1680 </params>
1681 </command>
1682 <command id='no service NAME at IP &lt;1-65535&gt;'>
1683 <params>
1684 <param name='no' doc='Negate a command or set its defaults' />
1685 <param name='service' doc='Remove one or more service address entries' />
1686 <param name='NAME' doc='mslookup service name, e.g. sip.voice or smpp.sms' />
1687 <param name='at' doc='at' />
1688 <param name='IP' doc='IPv4 address like 1.2.3.4 or IPv6 address like a:b:c:d::1' />
1689 <param name='&lt;1-65535&gt;' doc='Service-specific port number' />
1690 </params>
1691 </command>
1692 </node>
1693 <node id='config-mslookup-client'>
1694 <name>config-mslookup-client</name>
1695 <command id='timeout &lt;1-100000&gt;'>
1696 <params>
1697 <param name='timeout' doc='How long should the mslookup client wait for remote responses before evaluating received results' />
1698 <param name='&lt;1-100000&gt;' doc='timeout in milliseconds' />
1699 </params>
1700 </command>
1701 <command id='mdns bind [IP] [&lt;1-65535&gt;]'>
1702 <params>
1703 <param name='mdns' doc='Multicast DNS related configuration' />
1704 <param name='bind' doc='Enable mDNS client, and configure multicast address to send mDNS mslookup requests to' />
1705 <param name='[IP]' doc='multicast IPv4 address like 239.192.23.42 or IPv6 address like ff08::23:42' />
1706 <param name='[&lt;1-65535&gt;]' doc='mDNS UDP Port number' />
1707 </params>
1708 </command>
1709 <command id='mdns domain-suffix DOMAIN_SUFFIX'>
1710 <params>
1711 <param name='mdns' doc='Multicast DNS related configuration' />
1712 <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' />
1713 <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' />
1714 </params>
1715 </command>
1716 <command id='no mdns bind'>
1717 <params>
1718 <param name='no' doc='Negate a command or set its defaults' />
1719 <param name='mdns' doc='Disable mDNS client, do not query remote services by mDNS' />
1720 <param name='bind' doc='(null)' />
1721 </params>
1722 </command>
1723 <command id='gateway-proxy IP [&lt;1-65535&gt;]'>
1724 <params>
1725 <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' />
1726 <param name='IP' doc='IP address of the remote HLR' />
1727 <param name='[&lt;1-65535&gt;]' doc='GSUP port number (omit for default 4222)' />
1728 </params>
1729 </command>
1730 <command id='no gateway-proxy'>
1731 <params>
1732 <param name='no' doc='Negate a command or set its defaults' />
1733 <param name='gateway-proxy' doc='Disable gateway proxy for GSUP with unknown IMSIs' />
1734 </params>
1735 </command>
1736 </node>
Neels Hofmeyr25dd7852017-09-25 16:37:34 +0200[diff] [blame]1737</vtydoc>