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