Gitiles
Code Review Sign In
gerrit.osmocom.org / osmo-sgsn / 5783c0fc32a111157fb0c085e4de923b1052a0f9 / . / doc / manuals / vty / sgsn_vty_reference.xml
blob: 5ec0121d8fc0a15734f39521664a9035262a40e2 [file] [log] [blame]
Harald Welte9f1331b2016-02-20 10:56:10 +0100[diff] [blame]1<vtydoc xmlns='urn:osmocom:xml:libosmocore:vty:doc:1.0'>
2 <node id='0'>
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>
Philipp Maier5783c0f2017-03-08 15:25:44 +0100[diff] [blame^]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>
Harald Welte9f1331b2016-02-20 10:56:10 +0100[diff] [blame]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>
Philipp Maier5783c0f2017-03-08 15:25:44 +0100[diff] [blame^]139 <command id='logging level (all|mm|pag|meas|ref|gprs|ns|bssgp|llc|sndcp|slhc|ranap|sua|v42bis|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats) (everything|debug|info|notice|error|fatal)'>
Harald Welte9f1331b2016-02-20 10:56:10 +0100[diff] [blame]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='mm' doc='Layer3 Mobility Management (MM)' />
145 <param name='pag' doc='Paging Subsystem' />
146 <param name='meas' doc='Radio Measurement Processing' />
147 <param name='ref' doc='Reference Counting' />
148 <param name='gprs' doc='GPRS Packet Service' />
149 <param name='ns' doc='GPRS Network Service (NS)' />
150 <param name='bssgp' doc='GPRS BSS Gateway Protocol (BSSGP)' />
151 <param name='llc' doc='GPRS Logical Link Control Protocol (LLC)' />
152 <param name='sndcp' doc='GPRS Sub-Network Dependent Control Protocol (SNDCP)' />
Philipp Maier5783c0f2017-03-08 15:25:44 +0100[diff] [blame^]153 <param name='slhc' doc='RFC1144 TCP/IP Header compression (SLHC)' />
154 <param name='ranap' doc='RAN Application Part (RANAP)' />
155 <param name='sua' doc='SCCP User Adaptation (SUA)' />
156 <param name='v42bis' doc='V.42bis data compression (SNDCP)' />
Harald Welte9f1331b2016-02-20 10:56:10 +0100[diff] [blame]157 <param name='lglobal' doc='Library-internal global log family' />
158 <param name='llapd' doc='LAPD in libosmogsm' />
159 <param name='linp' doc='A-bis Intput Subsystem' />
160 <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' />
161 <param name='lmi' doc='A-bis Input Driver for Signalling' />
162 <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' />
163 <param name='lsms' doc='Layer3 Short Message Service (SMS)' />
Philipp Maier5783c0f2017-03-08 15:25:44 +0100[diff] [blame^]164 <param name='lctrl' doc='Control Interface' />
165 <param name='lgtp' doc='GPRS GTP library' />
166 <param name='lstats' doc='Statistics messages and logging' />
167 <param name='everything' doc='Don&apos;t use. It doesn&apos;t log anything' />
Harald Welte9f1331b2016-02-20 10:56:10 +0100[diff] [blame]168 <param name='debug' doc='Log debug messages and higher levels' />
169 <param name='info' doc='Log informational messages and higher levels' />
Philipp Maier5783c0f2017-03-08 15:25:44 +0100[diff] [blame^]170 <param name='notice' doc='Log noticeable messages and higher levels' />
Harald Welte9f1331b2016-02-20 10:56:10 +0100[diff] [blame]171 <param name='error' doc='Log error messages and higher levels' />
172 <param name='fatal' doc='Log only fatal messages' />
173 </params>
174 </command>
175 <command id='show logging vty'>
176 <params>
177 <param name='show' doc='Show running system information' />
178 <param name='logging' doc='Show current logging configuration' />
179 <param name='vty' doc='Show current logging configuration for this vty' />
180 </params>
181 </command>
182 <command id='show alarms'>
183 <params>
184 <param name='show' doc='Show running system information' />
185 <param name='alarms' doc='Show current logging configuration' />
186 </params>
187 </command>
Philipp Maier5783c0f2017-03-08 15:25:44 +0100[diff] [blame^]188 <command id='show stats'>
189 <params>
190 <param name='show' doc='Show running system information' />
191 <param name='stats' doc='Show statistical values' />
192 </params>
193 </command>
194 <command id='show stats level (global|peer|subscriber)'>
195 <params>
196 <param name='show' doc='Show running system information' />
197 <param name='stats' doc='Show statistical values' />
198 <param name='level' doc='Set the maximum group level' />
199 <param name='global' doc='Show global groups only' />
200 <param name='peer' doc='Show global and network peer related groups' />
201 <param name='subscriber' doc='Show global, peer, and subscriber groups' />
202 </params>
203 </command>
204 <command id='show asciidoc counters'>
205 <params>
206 <param name='show' doc='Show running system information' />
207 <param name='asciidoc' doc='Asciidoc generation' />
208 <param name='counters' doc='Generate table of all registered counters' />
209 </params>
210 </command>
Harald Welte9f1331b2016-02-20 10:56:10 +0100[diff] [blame]211 <command id='show sgsn'>
212 <params>
213 <param name='show' doc='Show running system information' />
214 <param name='sgsn' doc='Display information about the SGSN' />
215 </params>
216 </command>
217 <command id='show mm-context imsi IMSI [pdp]'>
218 <params>
219 <param name='show' doc='Show running system information' />
220 <param name='mm-context' doc='MM Context' />
221 <param name='imsi' doc='Identify by IMSI' />
222 <param name='IMSI' doc='IMSI of the MM Context' />
223 <param name='[pdp]' doc='Include PDP Context Information' />
224 </params>
225 </command>
226 <command id='show mm-context all [pdp]'>
227 <params>
228 <param name='show' doc='Show running system information' />
229 <param name='mm-context' doc='MM Context' />
230 <param name='all' doc='All MM Contexts' />
231 <param name='[pdp]' doc='Include PDP Context Information' />
232 </params>
233 </command>
234 <command id='show pdp-context all'>
235 <params>
236 <param name='show' doc='Show running system information' />
237 <param name='pdp-context' doc='Display information on PDP Context' />
238 <param name='all' doc='Show everything' />
239 </params>
240 </command>
Philipp Maier5783c0f2017-03-08 15:25:44 +0100[diff] [blame^]241 <command id='show subscriber cache'>
242 <params>
243 <param name='show' doc='Show running system information' />
244 <param name='subscriber' doc='Show information about subscribers' />
245 <param name='cache' doc='Display contents of subscriber cache' />
246 </params>
247 </command>
Harald Welte9f1331b2016-02-20 10:56:10 +0100[diff] [blame]248 <command id='show ns'>
249 <params>
250 <param name='show' doc='Show running system information' />
251 <param name='ns' doc='Display information about the NS protocol' />
252 </params>
253 </command>
254 <command id='show ns stats'>
255 <params>
256 <param name='show' doc='Show running system information' />
257 <param name='ns' doc='Display information about the NS protocol' />
258 <param name='stats' doc='Include statistics' />
259 </params>
260 </command>
261 <command id='show ns (nsei|nsvc) &lt;0-65535&gt; [stats]'>
262 <params>
263 <param name='show' doc='Show running system information' />
264 <param name='ns' doc='Display information about the NS protocol' />
265 <param name='nsei' doc='Select one NSE by its NSE Identifier' />
266 <param name='nsvc' doc='Select one NSE by its NS-VC Identifier' />
267 <param name='&lt;0-65535&gt;' doc='The Identifier of selected type' />
268 <param name='[stats]' doc='Include Statistics' />
269 </params>
270 </command>
271 <command id='logging filter nsvc (nsei|nsvci) &lt;0-65535&gt;'>
272 <params>
273 <param name='logging' doc='Configure log message to this terminal' />
274 <param name='filter' doc='Filter log messages' />
275 <param name='nsvc' doc='Filter based on NS Virtual Connection' />
276 <param name='nsei' doc='Identify NS-VC by NSEI' />
277 <param name='nsvci' doc='Identify NS-VC by NSVCI' />
278 <param name='&lt;0-65535&gt;' doc='Numeric identifier' />
279 </params>
280 </command>
281 <command id='show bssgp'>
282 <params>
283 <param name='show' doc='Show running system information' />
284 <param name='bssgp' doc='Show information about the BSSGP protocol' />
285 </params>
286 </command>
287 <command id='show bssgp stats'>
288 <params>
289 <param name='show' doc='Show running system information' />
290 <param name='bssgp' doc='Show information about the BSSGP protocol' />
291 <param name='stats' doc='Include statistics' />
292 </params>
293 </command>
294 <command id='show bssgp nsei &lt;0-65535&gt; [stats]'>
295 <params>
296 <param name='show' doc='Show running system information' />
297 <param name='bssgp' doc='Show information about the BSSGP protocol' />
298 <param name='nsei' doc='Show all BVCs on one NSE' />
299 <param name='&lt;0-65535&gt;' doc='The NSEI' />
300 <param name='[stats]' doc='Include Statistics' />
301 </params>
302 </command>
303 <command id='logging filter bvc nsei &lt;0-65535&gt; bvci &lt;0-65535&gt;'>
304 <params>
305 <param name='logging' doc='Configure log message to this terminal' />
306 <param name='filter' doc='Filter log messages' />
307 <param name='bvc' doc='Filter based on BSSGP Virtual Connection' />
308 <param name='nsei' doc='NSEI of the BVC to be filtered' />
309 <param name='&lt;0-65535&gt;' doc='Network Service Entity Identifier (NSEI)' />
310 <param name='bvci' doc='BVCI of the BVC to be filtered' />
311 <param name='&lt;0-65535&gt;' doc='BSSGP Virtual Connection Identifier (BVCI)' />
312 </params>
313 </command>
Philipp Maier5783c0f2017-03-08 15:25:44 +0100[diff] [blame^]314 <command id='bssgp bvc nsei &lt;0-65535&gt; bvci &lt;0-65535&gt; reset'>
315 <params>
316 <param name='bssgp' doc='Initiate BVC RESET procedure for a given NSEI and BVCI' />
317 <param name='bvc' doc='Filter based on BSSGP Virtual Connection' />
318 <param name='nsei' doc='NSEI of the BVC to be filtered' />
319 <param name='&lt;0-65535&gt;' doc='Network Service Entity Identifier (NSEI)' />
320 <param name='bvci' doc='BVCI of the BVC to be filtered' />
321 <param name='&lt;0-65535&gt;' doc='BSSGP Virtual Connection Identifier (BVCI)' />
322 <param name='reset' doc='Perform reset procedure' />
323 </params>
324 </command>
Harald Welte9f1331b2016-02-20 10:56:10 +0100[diff] [blame]325 <command id='show llc'>
326 <params>
327 <param name='show' doc='Show running system information' />
328 <param name='llc' doc='Display information about the LLC protocol' />
329 </params>
330 </command>
331 <command id='show sndcp'>
332 <params>
333 <param name='show' doc='Show running system information' />
334 <param name='sndcp' doc='Display information about the SNDCP protocol' />
335 </params>
336 </command>
337 </node>
338 <node id='2'>
339 </node>
340 <node id='3'>
341 <command id='help'>
342 <params>
343 <param name='help' doc='Description of the interactive help system' />
344 </params>
345 </command>
346 <command id='list'>
347 <params>
348 <param name='list' doc='Print command list' />
349 </params>
350 </command>
351 <command id='write terminal'>
352 <params>
353 <param name='write' doc='Write running configuration to memory, network, or terminal' />
354 <param name='terminal' doc='Write to terminal' />
355 </params>
356 </command>
357 <command id='write file'>
358 <params>
359 <param name='write' doc='Write running configuration to memory, network, or terminal' />
360 <param name='file' doc='Write to configuration file' />
361 </params>
362 </command>
363 <command id='write memory'>
364 <params>
365 <param name='write' doc='Write running configuration to memory, network, or terminal' />
366 <param name='memory' doc='Write configuration to the file (same as write file)' />
367 </params>
368 </command>
369 <command id='write'>
370 <params>
371 <param name='write' doc='Write running configuration to memory, network, or terminal' />
372 </params>
373 </command>
374 <command id='show running-config'>
375 <params>
376 <param name='show' doc='Show running system information' />
377 <param name='running-config' doc='running configuration' />
378 </params>
379 </command>
380 <command id='exit'>
381 <params>
382 <param name='exit' doc='Exit current mode and down to previous mode' />
383 </params>
384 </command>
385 <command id='disable'>
386 <params>
387 <param name='disable' doc='Turn off privileged mode command' />
388 </params>
389 </command>
390 <command id='configure terminal'>
391 <params>
392 <param name='configure' doc='Configuration from vty interface' />
393 <param name='terminal' doc='Configuration terminal' />
394 </params>
395 </command>
396 <command id='copy running-config startup-config'>
397 <params>
398 <param name='copy' doc='Copy configuration' />
399 <param name='running-config' doc='Copy running config to... ' />
400 <param name='startup-config' doc='Copy running config to startup config (same as write file)' />
401 </params>
402 </command>
403 <command id='show startup-config'>
404 <params>
405 <param name='show' doc='Show running system information' />
406 <param name='startup-config' doc='Contentes of startup configuration' />
407 </params>
408 </command>
409 <command id='show version'>
410 <params>
411 <param name='show' doc='Show running system information' />
412 <param name='version' doc='Displays program version' />
413 </params>
414 </command>
415 <command id='show online-help'>
416 <params>
417 <param name='show' doc='Show running system information' />
418 <param name='online-help' doc='Online help' />
419 </params>
420 </command>
421 <command id='terminal length &lt;0-512&gt;'>
422 <params>
423 <param name='terminal' doc='Set terminal line parameters' />
424 <param name='length' doc='Set number of lines on a screen' />
425 <param name='&lt;0-512&gt;' doc='Number of lines on screen (0 for no pausing)' />
426 </params>
427 </command>
428 <command id='terminal no length'>
429 <params>
430 <param name='terminal' doc='Set terminal line parameters' />
431 <param name='no' doc='Negate a command or set its defaults' />
432 <param name='length' doc='Set number of lines on a screen' />
433 </params>
434 </command>
435 <command id='echo .MESSAGE'>
436 <params>
437 <param name='echo' doc='Echo a message back to the vty' />
438 <param name='.MESSAGE' doc='The message to echo' />
439 </params>
440 </command>
441 <command id='who'>
442 <params>
443 <param name='who' doc='Display who is on vty' />
444 </params>
445 </command>
446 <command id='show history'>
447 <params>
448 <param name='show' doc='Show running system information' />
449 <param name='history' doc='Display the session command history' />
450 </params>
451 </command>
452 <command id='terminal monitor'>
453 <params>
454 <param name='terminal' doc='Set terminal line parameters' />
455 <param name='monitor' doc='Copy debug output to the current terminal line' />
456 </params>
457 </command>
458 <command id='terminal no monitor'>
459 <params>
460 <param name='terminal' doc='Set terminal line parameters' />
461 <param name='no' doc='Negate a command or set its defaults' />
462 <param name='monitor' doc='Copy debug output to the current terminal line' />
463 </params>
464 </command>
465 <command id='logging enable'>
466 <params>
467 <param name='logging' doc='Configure log message to this terminal' />
468 <param name='enable' doc='Enables logging to this vty' />
469 </params>
470 </command>
471 <command id='logging disable'>
472 <params>
473 <param name='logging' doc='Configure log message to this terminal' />
474 <param name='disable' doc='Disables logging to this vty' />
475 </params>
476 </command>
477 <command id='logging filter all (0|1)'>
478 <params>
479 <param name='logging' doc='Configure log message to this terminal' />
480 <param name='filter' doc='Filter log messages' />
481 <param name='all' doc='Do you want to log all messages?' />
482 <param name='0' doc='Only print messages matched by other filters' />
483 <param name='1' doc='Bypass filter and print all messages' />
484 </params>
485 </command>
486 <command id='logging color (0|1)'>
487 <params>
488 <param name='logging' doc='Configure log message to this terminal' />
489 <param name='color' doc='Configure color-printing for log messages' />
490 <param name='0' doc='Don&apos;t use color for printing messages' />
491 <param name='1' doc='Use color for printing messages' />
492 </params>
493 </command>
494 <command id='logging timestamp (0|1)'>
495 <params>
496 <param name='logging' doc='Configure log message to this terminal' />
497 <param name='timestamp' doc='Configure log message timestamping' />
498 <param name='0' doc='Don&apos;t prefix each log message' />
499 <param name='1' doc='Prefix each log message with current timestamp' />
500 </params>
501 </command>
Philipp Maier5783c0f2017-03-08 15:25:44 +0100[diff] [blame^]502 <command id='logging print extended-timestamp (0|1)'>
503 <params>
504 <param name='logging' doc='Configure log message to this terminal' />
505 <param name='print' doc='Log output settings' />
506 <param name='extended-timestamp' doc='Configure log message timestamping' />
507 <param name='0' doc='Don&apos;t prefix each log message' />
508 <param name='1' doc='Prefix each log message with current timestamp with YYYYMMDDhhmmssnnn' />
509 </params>
510 </command>
511 <command id='logging print category (0|1)'>
512 <params>
513 <param name='logging' doc='Configure log message to this terminal' />
514 <param name='print' doc='Log output settings' />
515 <param name='category' doc='Configure log message' />
516 <param name='0' doc='Don&apos;t prefix each log message' />
517 <param name='1' doc='Prefix each log message with category/subsystem name' />
518 </params>
519 </command>
Harald Welte9f1331b2016-02-20 10:56:10 +0100[diff] [blame]520 <command id='logging set-log-mask MASK'>
521 <params>
522 <param name='logging' doc='Configure log message to this terminal' />
523 <param name='set-log-mask' doc='Set the logmask of this logging target' />
524 <param name='MASK' doc='The logmask to use' />
525 </params>
526 </command>
527 <command id='logging set log mask MASK'>
528 <params>
529 <param name='logging' doc='Configure log message to this terminal' />
530 <param name='set' doc='Decide which categories to output.' />
531 <param name='log' doc='Log commands' />
532 <param name='mask' doc='Mask commands' />
533 <param name='MASK' doc='The logmask to use' />
534 </params>
535 </command>
Philipp Maier5783c0f2017-03-08 15:25:44 +0100[diff] [blame^]536 <command id='logging level (all|mm|pag|meas|ref|gprs|ns|bssgp|llc|sndcp|slhc|ranap|sua|v42bis|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats) (everything|debug|info|notice|error|fatal)'>
Harald Welte9f1331b2016-02-20 10:56:10 +0100[diff] [blame]537 <params>
538 <param name='logging' doc='Configure log message to this terminal' />
539 <param name='level' doc='Set the log level for a specified category' />
540 <param name='all' doc='Global setting for all subsystems' />
541 <param name='mm' doc='Layer3 Mobility Management (MM)' />
542 <param name='pag' doc='Paging Subsystem' />
543 <param name='meas' doc='Radio Measurement Processing' />
544 <param name='ref' doc='Reference Counting' />
545 <param name='gprs' doc='GPRS Packet Service' />
546 <param name='ns' doc='GPRS Network Service (NS)' />
547 <param name='bssgp' doc='GPRS BSS Gateway Protocol (BSSGP)' />
548 <param name='llc' doc='GPRS Logical Link Control Protocol (LLC)' />
549 <param name='sndcp' doc='GPRS Sub-Network Dependent Control Protocol (SNDCP)' />
Philipp Maier5783c0f2017-03-08 15:25:44 +0100[diff] [blame^]550 <param name='slhc' doc='RFC1144 TCP/IP Header compression (SLHC)' />
551 <param name='ranap' doc='RAN Application Part (RANAP)' />
552 <param name='sua' doc='SCCP User Adaptation (SUA)' />
553 <param name='v42bis' doc='V.42bis data compression (SNDCP)' />
Harald Welte9f1331b2016-02-20 10:56:10 +0100[diff] [blame]554 <param name='lglobal' doc='Library-internal global log family' />
555 <param name='llapd' doc='LAPD in libosmogsm' />
556 <param name='linp' doc='A-bis Intput Subsystem' />
557 <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' />
558 <param name='lmi' doc='A-bis Input Driver for Signalling' />
559 <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' />
560 <param name='lsms' doc='Layer3 Short Message Service (SMS)' />
Philipp Maier5783c0f2017-03-08 15:25:44 +0100[diff] [blame^]561 <param name='lctrl' doc='Control Interface' />
562 <param name='lgtp' doc='GPRS GTP library' />
563 <param name='lstats' doc='Statistics messages and logging' />
564 <param name='everything' doc='Don&apos;t use. It doesn&apos;t log anything' />
Harald Welte9f1331b2016-02-20 10:56:10 +0100[diff] [blame]565 <param name='debug' doc='Log debug messages and higher levels' />
566 <param name='info' doc='Log informational messages and higher levels' />
Philipp Maier5783c0f2017-03-08 15:25:44 +0100[diff] [blame^]567 <param name='notice' doc='Log noticeable messages and higher levels' />
Harald Welte9f1331b2016-02-20 10:56:10 +0100[diff] [blame]568 <param name='error' doc='Log error messages and higher levels' />
569 <param name='fatal' doc='Log only fatal messages' />
570 </params>
571 </command>
572 <command id='show logging vty'>
573 <params>
574 <param name='show' doc='Show running system information' />
575 <param name='logging' doc='Show current logging configuration' />
576 <param name='vty' doc='Show current logging configuration for this vty' />
577 </params>
578 </command>
579 <command id='show alarms'>
580 <params>
581 <param name='show' doc='Show running system information' />
582 <param name='alarms' doc='Show current logging configuration' />
583 </params>
584 </command>
Philipp Maier5783c0f2017-03-08 15:25:44 +0100[diff] [blame^]585 <command id='show stats'>
586 <params>
587 <param name='show' doc='Show running system information' />
588 <param name='stats' doc='Show statistical values' />
589 </params>
590 </command>
591 <command id='show stats level (global|peer|subscriber)'>
592 <params>
593 <param name='show' doc='Show running system information' />
594 <param name='stats' doc='Show statistical values' />
595 <param name='level' doc='Set the maximum group level' />
596 <param name='global' doc='Show global groups only' />
597 <param name='peer' doc='Show global and network peer related groups' />
598 <param name='subscriber' doc='Show global, peer, and subscriber groups' />
599 </params>
600 </command>
601 <command id='show asciidoc counters'>
602 <params>
603 <param name='show' doc='Show running system information' />
604 <param name='asciidoc' doc='Asciidoc generation' />
605 <param name='counters' doc='Generate table of all registered counters' />
606 </params>
607 </command>
Harald Welte9f1331b2016-02-20 10:56:10 +0100[diff] [blame]608 <command id='show sgsn'>
609 <params>
610 <param name='show' doc='Show running system information' />
611 <param name='sgsn' doc='Display information about the SGSN' />
612 </params>
613 </command>
614 <command id='show mm-context imsi IMSI [pdp]'>
615 <params>
616 <param name='show' doc='Show running system information' />
617 <param name='mm-context' doc='MM Context' />
618 <param name='imsi' doc='Identify by IMSI' />
619 <param name='IMSI' doc='IMSI of the MM Context' />
620 <param name='[pdp]' doc='Include PDP Context Information' />
621 </params>
622 </command>
623 <command id='show mm-context all [pdp]'>
624 <params>
625 <param name='show' doc='Show running system information' />
626 <param name='mm-context' doc='MM Context' />
627 <param name='all' doc='All MM Contexts' />
628 <param name='[pdp]' doc='Include PDP Context Information' />
629 </params>
630 </command>
631 <command id='show pdp-context all'>
632 <params>
633 <param name='show' doc='Show running system information' />
634 <param name='pdp-context' doc='Display information on PDP Context' />
635 <param name='all' doc='Show everything' />
636 </params>
637 </command>
Philipp Maier5783c0f2017-03-08 15:25:44 +0100[diff] [blame^]638 <command id='show subscriber cache'>
639 <params>
640 <param name='show' doc='Show running system information' />
641 <param name='subscriber' doc='Show information about subscribers' />
642 <param name='cache' doc='Display contents of subscriber cache' />
643 </params>
644 </command>
645 <command id='update-subscriber imsi IMSI insert auth-triplet &lt;1-5&gt; sres SRES rand RAND kc KC'>
646 <params>
647 <param name='update-subscriber' doc='Update subscriber list' />
648 <param name='imsi' doc='Use the IMSI to select the subscriber' />
649 <param name='IMSI' doc='The IMSI' />
650 <param name='insert' doc='Insert data into the subscriber record' />
651 <param name='auth-triplet' doc='Update authentication triplet' />
652 <param name='&lt;1-5&gt;' doc='Triplet index' />
653 <param name='sres' doc='Set SRES value' />
654 <param name='SRES' doc='SRES value (4 byte) in hex' />
655 <param name='rand' doc='Set RAND value' />
656 <param name='RAND' doc='RAND value (16 byte) in hex' />
657 <param name='kc' doc='Set Kc value' />
658 <param name='KC' doc='Kc value (8 byte) in hex' />
659 </params>
660 </command>
661 <command id='update-subscriber imsi IMSI create'>
662 <params>
663 <param name='update-subscriber' doc='Update subscriber list' />
664 <param name='imsi' doc='Use the IMSI to select the subscriber' />
665 <param name='IMSI' doc='The IMSI' />
666 <param name='create' doc='Create a subscriber entry' />
667 </params>
668 </command>
669 <command id='update-subscriber imsi IMSI destroy'>
670 <params>
671 <param name='update-subscriber' doc='Update subscriber list' />
672 <param name='imsi' doc='Use the IMSI to select the subscriber' />
673 <param name='IMSI' doc='The IMSI' />
674 <param name='destroy' doc='Destroy a subscriber entry' />
675 </params>
676 </command>
677 <command id='update-subscriber imsi IMSI cancel (update-procedure|subscription-withdraw)'>
678 <params>
679 <param name='update-subscriber' doc='Update subscriber list' />
680 <param name='imsi' doc='Use the IMSI to select the subscriber' />
681 <param name='IMSI' doc='The IMSI' />
682 <param name='cancel' doc='Cancel (remove) subscriber record' />
683 <param name='update-procedure' doc='The MS moved to another SGSN' />
684 <param name='subscription-withdraw' doc='The subscription is no longer valid' />
685 </params>
686 </command>
687 <command id='update-subscriber imsi IMSI update-location-result (ok|system-failure|data-missing|unexpected-data-value|unknown-subscriber|roaming-not-allowed)'>
688 <params>
689 <param name='update-subscriber' doc='Update subscriber list' />
690 <param name='imsi' doc='Use the IMSI to select the subscriber' />
691 <param name='IMSI' doc='The IMSI' />
692 <param name='update-location-result' doc='Complete the update location procedure' />
693 <param name='ok' doc='The update location request succeeded' />
694 <param name='system-failure' doc='Force error code SystemFailure' />
695 <param name='data-missing' doc='Force error code DataMissing' />
696 <param name='unexpected-data-value' doc='Force error code UnexpectedDataValue' />
697 <param name='unknown-subscriber' doc='Force error code UnknownSubscriber' />
698 <param name='roaming-not-allowed' doc='Force error code RoamingNotAllowed' />
699 </params>
700 </command>
701 <command id='update-subscriber imsi IMSI update-auth-info'>
702 <params>
703 <param name='update-subscriber' doc='Update subscriber list' />
704 <param name='imsi' doc='Use the IMSI to select the subscriber' />
705 <param name='IMSI' doc='The IMSI' />
706 <param name='update-auth-info' doc='Complete the send authentication info procedure' />
707 </params>
708 </command>
Harald Welte9f1331b2016-02-20 10:56:10 +0100[diff] [blame]709 <command id='show ns'>
710 <params>
711 <param name='show' doc='Show running system information' />
712 <param name='ns' doc='Display information about the NS protocol' />
713 </params>
714 </command>
715 <command id='show ns stats'>
716 <params>
717 <param name='show' doc='Show running system information' />
718 <param name='ns' doc='Display information about the NS protocol' />
719 <param name='stats' doc='Include statistics' />
720 </params>
721 </command>
722 <command id='show ns (nsei|nsvc) &lt;0-65535&gt; [stats]'>
723 <params>
724 <param name='show' doc='Show running system information' />
725 <param name='ns' doc='Display information about the NS protocol' />
726 <param name='nsei' doc='Select one NSE by its NSE Identifier' />
727 <param name='nsvc' doc='Select one NSE by its NS-VC Identifier' />
728 <param name='&lt;0-65535&gt;' doc='The Identifier of selected type' />
729 <param name='[stats]' doc='Include Statistics' />
730 </params>
731 </command>
732 <command id='logging filter nsvc (nsei|nsvci) &lt;0-65535&gt;'>
733 <params>
734 <param name='logging' doc='Configure log message to this terminal' />
735 <param name='filter' doc='Filter log messages' />
736 <param name='nsvc' doc='Filter based on NS Virtual Connection' />
737 <param name='nsei' doc='Identify NS-VC by NSEI' />
738 <param name='nsvci' doc='Identify NS-VC by NSVCI' />
739 <param name='&lt;0-65535&gt;' doc='Numeric identifier' />
740 </params>
741 </command>
742 <command id='nsvc (nsei|nsvci) &lt;0-65535&gt; (block|unblock|reset)'>
743 <params>
744 <param name='nsvc' doc='Perform an operation on a NSVC' />
745 <param name='nsei' doc='NSEI to identify NS-VC Identifier (NS-VCI)' />
746 <param name='nsvci' doc='NS-VC Identifier (NS-VCI)' />
747 <param name='&lt;0-65535&gt;' doc='The NSEI' />
748 <param name='block' doc='Initiate BLOCK procedure' />
749 <param name='unblock' doc='Initiate UNBLOCK procedure' />
750 <param name='reset' doc='Initiate RESET procedure' />
751 </params>
752 </command>
753 <command id='show bssgp'>
754 <params>
755 <param name='show' doc='Show running system information' />
756 <param name='bssgp' doc='Show information about the BSSGP protocol' />
757 </params>
758 </command>
759 <command id='show bssgp stats'>
760 <params>
761 <param name='show' doc='Show running system information' />
762 <param name='bssgp' doc='Show information about the BSSGP protocol' />
763 <param name='stats' doc='Include statistics' />
764 </params>
765 </command>
766 <command id='show bssgp nsei &lt;0-65535&gt; [stats]'>
767 <params>
768 <param name='show' doc='Show running system information' />
769 <param name='bssgp' doc='Show information about the BSSGP protocol' />
770 <param name='nsei' doc='Show all BVCs on one NSE' />
771 <param name='&lt;0-65535&gt;' doc='The NSEI' />
772 <param name='[stats]' doc='Include Statistics' />
773 </params>
774 </command>
775 <command id='logging filter bvc nsei &lt;0-65535&gt; bvci &lt;0-65535&gt;'>
776 <params>
777 <param name='logging' doc='Configure log message to this terminal' />
778 <param name='filter' doc='Filter log messages' />
779 <param name='bvc' doc='Filter based on BSSGP Virtual Connection' />
780 <param name='nsei' doc='NSEI of the BVC to be filtered' />
781 <param name='&lt;0-65535&gt;' doc='Network Service Entity Identifier (NSEI)' />
782 <param name='bvci' doc='BVCI of the BVC to be filtered' />
783 <param name='&lt;0-65535&gt;' doc='BSSGP Virtual Connection Identifier (BVCI)' />
784 </params>
785 </command>
Philipp Maier5783c0f2017-03-08 15:25:44 +0100[diff] [blame^]786 <command id='bssgp bvc nsei &lt;0-65535&gt; bvci &lt;0-65535&gt; reset'>
787 <params>
788 <param name='bssgp' doc='Initiate BVC RESET procedure for a given NSEI and BVCI' />
789 <param name='bvc' doc='Filter based on BSSGP Virtual Connection' />
790 <param name='nsei' doc='NSEI of the BVC to be filtered' />
791 <param name='&lt;0-65535&gt;' doc='Network Service Entity Identifier (NSEI)' />
792 <param name='bvci' doc='BVCI of the BVC to be filtered' />
793 <param name='&lt;0-65535&gt;' doc='BSSGP Virtual Connection Identifier (BVCI)' />
794 <param name='reset' doc='Perform reset procedure' />
795 </params>
796 </command>
Harald Welte9f1331b2016-02-20 10:56:10 +0100[diff] [blame]797 <command id='show llc'>
798 <params>
799 <param name='show' doc='Show running system information' />
800 <param name='llc' doc='Display information about the LLC protocol' />
801 </params>
802 </command>
803 <command id='show sndcp'>
804 <params>
805 <param name='show' doc='Show running system information' />
806 <param name='sndcp' doc='Display information about the SNDCP protocol' />
807 </params>
808 </command>
809 </node>
810 <node id='4'>
811 <command id='help'>
812 <params>
813 <param name='help' doc='Description of the interactive help system' />
814 </params>
815 </command>
816 <command id='list'>
817 <params>
818 <param name='list' doc='Print command list' />
819 </params>
820 </command>
821 <command id='write terminal'>
822 <params>
823 <param name='write' doc='Write running configuration to memory, network, or terminal' />
824 <param name='terminal' doc='Write to terminal' />
825 </params>
826 </command>
827 <command id='write file'>
828 <params>
829 <param name='write' doc='Write running configuration to memory, network, or terminal' />
830 <param name='file' doc='Write to configuration file' />
831 </params>
832 </command>
833 <command id='write memory'>
834 <params>
835 <param name='write' doc='Write running configuration to memory, network, or terminal' />
836 <param name='memory' doc='Write configuration to the file (same as write file)' />
837 </params>
838 </command>
839 <command id='write'>
840 <params>
841 <param name='write' doc='Write running configuration to memory, network, or terminal' />
842 </params>
843 </command>
844 <command id='show running-config'>
845 <params>
846 <param name='show' doc='Show running system information' />
847 <param name='running-config' doc='running configuration' />
848 </params>
849 </command>
850 <command id='exit'>
851 <params>
852 <param name='exit' doc='Exit current mode and down to previous mode' />
853 </params>
854 </command>
855 <command id='end'>
856 <params>
857 <param name='end' doc='End current mode and change to enable mode.' />
858 </params>
859 </command>
860 <command id='hostname WORD'>
861 <params>
862 <param name='hostname' doc='Set system&apos;s network name' />
863 <param name='WORD' doc='This system&apos;s network name' />
864 </params>
865 </command>
866 <command id='no hostname [HOSTNAME]'>
867 <params>
868 <param name='no' doc='Negate a command or set its defaults' />
869 <param name='hostname' doc='Reset system&apos;s network name' />
870 <param name='[HOSTNAME]' doc='Host name of this router' />
871 </params>
872 </command>
873 <command id='password (8|) WORD'>
874 <params>
875 <param name='password' doc='Assign the terminal connection password' />
876 <param name='8' doc='Specifies a HIDDEN password will follow' />
877 <param name='' doc='dummy string ' />
878 <param name='WORD' doc='The HIDDEN line password string' />
879 </params>
880 </command>
881 <command id='password LINE'>
882 <params>
883 <param name='password' doc='Assign the terminal connection password' />
884 <param name='LINE' doc='The UNENCRYPTED (cleartext) line password' />
885 </params>
886 </command>
887 <command id='enable password (8|) WORD'>
888 <params>
889 <param name='enable' doc='Modify enable password parameters' />
890 <param name='password' doc='Assign the privileged level password' />
891 <param name='8' doc='Specifies a HIDDEN password will follow' />
892 <param name='' doc='dummy string ' />
893 <param name='WORD' doc='The HIDDEN &apos;enable&apos; password string' />
894 </params>
895 </command>
896 <command id='enable password LINE'>
897 <params>
898 <param name='enable' doc='Modify enable password parameters' />
899 <param name='password' doc='Assign the privileged level password' />
900 <param name='LINE' doc='The UNENCRYPTED (cleartext) &apos;enable&apos; password' />
901 </params>
902 </command>
903 <command id='no enable password'>
904 <params>
905 <param name='no' doc='Negate a command or set its defaults' />
906 <param name='enable' doc='Modify enable password parameters' />
907 <param name='password' doc='Assign the privileged level password' />
908 </params>
909 </command>
910 <command id='banner motd default'>
911 <params>
912 <param name='banner' doc='Set banner string' />
913 <param name='motd' doc='Strings for motd' />
914 <param name='default' doc='Default string' />
915 </params>
916 </command>
917 <command id='banner motd file [FILE]'>
918 <params>
919 <param name='banner' doc='Set banner' />
920 <param name='motd' doc='Banner for motd' />
921 <param name='file' doc='Banner from a file' />
922 <param name='[FILE]' doc='Filename' />
923 </params>
924 </command>
925 <command id='no banner motd'>
926 <params>
927 <param name='no' doc='Negate a command or set its defaults' />
928 <param name='banner' doc='Set banner string' />
929 <param name='motd' doc='Strings for motd' />
930 </params>
931 </command>
932 <command id='service terminal-length &lt;0-512&gt;'>
933 <params>
934 <param name='service' doc='Set up miscellaneous service' />
935 <param name='terminal-length' doc='System wide terminal length configuration' />
936 <param name='&lt;0-512&gt;' doc='Number of lines of VTY (0 means no line control)' />
937 </params>
938 </command>
939 <command id='no service terminal-length [&lt;0-512&gt;]'>
940 <params>
941 <param name='no' doc='Negate a command or set its defaults' />
942 <param name='service' doc='Set up miscellaneous service' />
943 <param name='terminal-length' doc='System wide terminal length configuration' />
944 <param name='[&lt;0-512&gt;]' doc='Number of lines of VTY (0 means no line control)' />
945 </params>
946 </command>
947 <command id='line vty'>
948 <params>
949 <param name='line' doc='Configure a terminal line' />
950 <param name='vty' doc='Virtual terminal' />
951 </params>
952 </command>
953 <command id='service advanced-vty'>
954 <params>
955 <param name='service' doc='Set up miscellaneous service' />
956 <param name='advanced-vty' doc='Enable advanced mode vty interface' />
957 </params>
958 </command>
959 <command id='no service advanced-vty'>
960 <params>
961 <param name='no' doc='Negate a command or set its defaults' />
962 <param name='service' doc='Set up miscellaneous service' />
963 <param name='advanced-vty' doc='Enable advanced mode vty interface' />
964 </params>
965 </command>
966 <command id='show history'>
967 <params>
968 <param name='show' doc='Show running system information' />
969 <param name='history' doc='Display the session command history' />
970 </params>
971 </command>
972 <command id='log stderr'>
973 <params>
974 <param name='log' doc='Configure logging sub-system' />
975 <param name='stderr' doc='Logging via STDERR of the process' />
976 </params>
977 </command>
978 <command id='no log stderr'>
979 <params>
980 <param name='no' doc='Negate a command or set its defaults' />
981 <param name='log' doc='Configure logging sub-system' />
982 <param name='stderr' doc='Logging via STDERR of the process' />
983 </params>
984 </command>
985 <command id='log file .FILENAME'>
986 <params>
987 <param name='log' doc='Configure logging sub-system' />
988 <param name='file' doc='Logging to text file' />
989 <param name='.FILENAME' doc='Filename' />
990 </params>
991 </command>
992 <command id='no log file .FILENAME'>
993 <params>
994 <param name='no' doc='Negate a command or set its defaults' />
995 <param name='log' doc='Configure logging sub-system' />
996 <param name='file' doc='Logging to text file' />
997 <param name='.FILENAME' doc='Filename' />
998 </params>
999 </command>
1000 <command id='log alarms &lt;2-32700&gt;'>
1001 <params>
1002 <param name='log' doc='Configure logging sub-system' />
1003 <param name='alarms' doc='Logging alarms to osmo_strrb' />
1004 <param name='&lt;2-32700&gt;' doc='Maximum number of messages to log' />
1005 </params>
1006 </command>
1007 <command id='no log alarms'>
1008 <params>
1009 <param name='no' doc='Negate a command or set its defaults' />
1010 <param name='log' doc='Configure logging sub-system' />
1011 <param name='alarms' doc='Logging alarms to osmo_strrb' />
1012 </params>
1013 </command>
1014 <command id='log syslog (authpriv|cron|daemon|ftp|lpr|mail|news|user|uucp)'>
1015 <params>
1016 <param name='log' doc='Configure logging sub-system' />
1017 <param name='syslog' doc='Logging via syslog' />
1018 <param name='authpriv' doc='Security/authorization messages facility' />
1019 <param name='cron' doc='Clock daemon (cron/at) facility' />
1020 <param name='daemon' doc='General system daemon facility' />
1021 <param name='ftp' doc='Ftp daemon facility' />
1022 <param name='lpr' doc='Line printer facility' />
1023 <param name='mail' doc='Mail facility' />
1024 <param name='news' doc='News facility' />
1025 <param name='user' doc='Generic facility' />
1026 <param name='uucp' doc='UUCP facility' />
1027 </params>
1028 </command>
1029 <command id='log syslog local &lt;0-7&gt;'>
1030 <params>
1031 <param name='log' doc='Configure logging sub-system' />
1032 <param name='syslog' doc='Logging via syslog' />
1033 <param name='local' doc='Syslog LOCAL facility' />
1034 <param name='&lt;0-7&gt;' doc='Local facility number' />
1035 </params>
1036 </command>
1037 <command id='no log syslog'>
1038 <params>
1039 <param name='no' doc='Negate a command or set its defaults' />
1040 <param name='log' doc='Configure logging sub-system' />
1041 <param name='syslog' doc='Logging via syslog' />
1042 </params>
1043 </command>
Philipp Maier5783c0f2017-03-08 15:25:44 +0100[diff] [blame^]1044 <command id='log gsmtap [HOSTNAME]'>
1045 <params>
1046 <param name='log' doc='Configure logging sub-system' />
1047 <param name='gsmtap' doc='Logging via GSMTAP' />
1048 <param name='[HOSTNAME]' doc='Host name to send the GSMTAP logging to (UDP port 4729)' />
1049 </params>
1050 </command>
1051 <command id='stats reporter statsd'>
1052 <params>
1053 <param name='stats' doc='Configure stats sub-system' />
1054 <param name='reporter' doc='Configure a stats reporter' />
1055 <param name='statsd' doc='Report to a STATSD server' />
1056 </params>
1057 </command>
1058 <command id='no stats reporter statsd'>
1059 <params>
1060 <param name='no' doc='Negate a command or set its defaults' />
1061 <param name='stats' doc='Configure stats sub-system' />
1062 <param name='reporter' doc='Configure a stats reporter' />
1063 <param name='statsd' doc='Report to a STATSD server' />
1064 </params>
1065 </command>
1066 <command id='stats reporter log'>
1067 <params>
1068 <param name='stats' doc='Configure stats sub-system' />
1069 <param name='reporter' doc='Configure a stats reporter' />
1070 <param name='log' doc='Report to the logger' />
1071 </params>
1072 </command>
1073 <command id='no stats reporter log'>
1074 <params>
1075 <param name='no' doc='Negate a command or set its defaults' />
1076 <param name='stats' doc='Configure stats sub-system' />
1077 <param name='reporter' doc='Configure a stats reporter' />
1078 <param name='log' doc='Report to the logger' />
1079 </params>
1080 </command>
1081 <command id='stats interval &lt;1-65535&gt;'>
1082 <params>
1083 <param name='stats' doc='Configure stats sub-system' />
1084 <param name='interval' doc='Set the reporting interval' />
1085 <param name='&lt;1-65535&gt;' doc='Interval in seconds' />
1086 </params>
1087 </command>
Harald Welte9f1331b2016-02-20 10:56:10 +0100[diff] [blame]1088 <command id='sgsn'>
1089 <params>
1090 <param name='sgsn' doc='Configure the SGSN' />
1091 </params>
1092 </command>
Philipp Maier5783c0f2017-03-08 15:25:44 +0100[diff] [blame^]1093 <command id='ctrl'>
1094 <params>
1095 <param name='ctrl' doc='Configure the Control Interface' />
1096 </params>
1097 </command>
Harald Welte9f1331b2016-02-20 10:56:10 +0100[diff] [blame]1098 <command id='ns'>
1099 <params>
1100 <param name='ns' doc='Configure the GPRS Network Service' />
1101 </params>
1102 </command>
1103 <command id='bssgp'>
1104 <params>
1105 <param name='bssgp' doc='Configure the GPRS BSS Gateway Protocol' />
1106 </params>
1107 </command>
1108 </node>
1109 <node id='7'>
1110 <command id='help'>
1111 <params>
1112 <param name='help' doc='Description of the interactive help system' />
1113 </params>
1114 </command>
1115 <command id='list'>
1116 <params>
1117 <param name='list' doc='Print command list' />
1118 </params>
1119 </command>
1120 <command id='write terminal'>
1121 <params>
1122 <param name='write' doc='Write running configuration to memory, network, or terminal' />
1123 <param name='terminal' doc='Write to terminal' />
1124 </params>
1125 </command>
1126 <command id='write file'>
1127 <params>
1128 <param name='write' doc='Write running configuration to memory, network, or terminal' />
1129 <param name='file' doc='Write to configuration file' />
1130 </params>
1131 </command>
1132 <command id='write memory'>
1133 <params>
1134 <param name='write' doc='Write running configuration to memory, network, or terminal' />
1135 <param name='memory' doc='Write configuration to the file (same as write file)' />
1136 </params>
1137 </command>
1138 <command id='write'>
1139 <params>
1140 <param name='write' doc='Write running configuration to memory, network, or terminal' />
1141 </params>
1142 </command>
1143 <command id='show running-config'>
1144 <params>
1145 <param name='show' doc='Show running system information' />
1146 <param name='running-config' doc='running configuration' />
1147 </params>
1148 </command>
1149 <command id='exit'>
1150 <params>
1151 <param name='exit' doc='Exit current mode and down to previous mode' />
1152 </params>
1153 </command>
1154 <command id='end'>
1155 <params>
1156 <param name='end' doc='End current mode and change to enable mode.' />
1157 </params>
1158 </command>
1159 <command id='logging filter all (0|1)'>
1160 <params>
1161 <param name='logging' doc='Configure log message to this terminal' />
1162 <param name='filter' doc='Filter log messages' />
1163 <param name='all' doc='Do you want to log all messages?' />
1164 <param name='0' doc='Only print messages matched by other filters' />
1165 <param name='1' doc='Bypass filter and print all messages' />
1166 </params>
1167 </command>
1168 <command id='logging color (0|1)'>
1169 <params>
1170 <param name='logging' doc='Configure log message to this terminal' />
1171 <param name='color' doc='Configure color-printing for log messages' />
1172 <param name='0' doc='Don&apos;t use color for printing messages' />
1173 <param name='1' doc='Use color for printing messages' />
1174 </params>
1175 </command>
1176 <command id='logging timestamp (0|1)'>
1177 <params>
1178 <param name='logging' doc='Configure log message to this terminal' />
1179 <param name='timestamp' doc='Configure log message timestamping' />
1180 <param name='0' doc='Don&apos;t prefix each log message' />
1181 <param name='1' doc='Prefix each log message with current timestamp' />
1182 </params>
1183 </command>
Philipp Maier5783c0f2017-03-08 15:25:44 +0100[diff] [blame^]1184 <command id='logging print extended-timestamp (0|1)'>
1185 <params>
1186 <param name='logging' doc='Configure log message to this terminal' />
1187 <param name='print' doc='Log output settings' />
1188 <param name='extended-timestamp' doc='Configure log message timestamping' />
1189 <param name='0' doc='Don&apos;t prefix each log message' />
1190 <param name='1' doc='Prefix each log message with current timestamp with YYYYMMDDhhmmssnnn' />
1191 </params>
1192 </command>
1193 <command id='logging print category (0|1)'>
1194 <params>
1195 <param name='logging' doc='Configure log message to this terminal' />
1196 <param name='print' doc='Log output settings' />
1197 <param name='category' doc='Configure log message' />
1198 <param name='0' doc='Don&apos;t prefix each log message' />
1199 <param name='1' doc='Prefix each log message with category/subsystem name' />
1200 </params>
1201 </command>
1202 <command id='logging level (all|mm|pag|meas|ref|gprs|ns|bssgp|llc|sndcp|slhc|ranap|sua|v42bis|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats) (everything|debug|info|notice|error|fatal)'>
Harald Welte9f1331b2016-02-20 10:56:10 +0100[diff] [blame]1203 <params>
1204 <param name='logging' doc='Configure log message to this terminal' />
1205 <param name='level' doc='Set the log level for a specified category' />
1206 <param name='all' doc='Global setting for all subsystems' />
1207 <param name='mm' doc='Layer3 Mobility Management (MM)' />
1208 <param name='pag' doc='Paging Subsystem' />
1209 <param name='meas' doc='Radio Measurement Processing' />
1210 <param name='ref' doc='Reference Counting' />
1211 <param name='gprs' doc='GPRS Packet Service' />
1212 <param name='ns' doc='GPRS Network Service (NS)' />
1213 <param name='bssgp' doc='GPRS BSS Gateway Protocol (BSSGP)' />
1214 <param name='llc' doc='GPRS Logical Link Control Protocol (LLC)' />
1215 <param name='sndcp' doc='GPRS Sub-Network Dependent Control Protocol (SNDCP)' />
Philipp Maier5783c0f2017-03-08 15:25:44 +0100[diff] [blame^]1216 <param name='slhc' doc='RFC1144 TCP/IP Header compression (SLHC)' />
1217 <param name='ranap' doc='RAN Application Part (RANAP)' />
1218 <param name='sua' doc='SCCP User Adaptation (SUA)' />
1219 <param name='v42bis' doc='V.42bis data compression (SNDCP)' />
Harald Welte9f1331b2016-02-20 10:56:10 +0100[diff] [blame]1220 <param name='lglobal' doc='Library-internal global log family' />
1221 <param name='llapd' doc='LAPD in libosmogsm' />
1222 <param name='linp' doc='A-bis Intput Subsystem' />
1223 <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' />
1224 <param name='lmi' doc='A-bis Input Driver for Signalling' />
1225 <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' />
1226 <param name='lsms' doc='Layer3 Short Message Service (SMS)' />
Philipp Maier5783c0f2017-03-08 15:25:44 +0100[diff] [blame^]1227 <param name='lctrl' doc='Control Interface' />
1228 <param name='lgtp' doc='GPRS GTP library' />
1229 <param name='lstats' doc='Statistics messages and logging' />
1230 <param name='everything' doc='Don&apos;t use. It doesn&apos;t log anything' />
Harald Welte9f1331b2016-02-20 10:56:10 +0100[diff] [blame]1231 <param name='debug' doc='Log debug messages and higher levels' />
1232 <param name='info' doc='Log informational messages and higher levels' />
Philipp Maier5783c0f2017-03-08 15:25:44 +0100[diff] [blame^]1233 <param name='notice' doc='Log noticeable messages and higher levels' />
Harald Welte9f1331b2016-02-20 10:56:10 +0100[diff] [blame]1234 <param name='error' doc='Log error messages and higher levels' />
1235 <param name='fatal' doc='Log only fatal messages' />
1236 </params>
1237 </command>
1238 <command id='logging filter nsvc (nsei|nsvci) &lt;0-65535&gt;'>
1239 <params>
1240 <param name='logging' doc='Configure log message to this terminal' />
1241 <param name='filter' doc='Filter log messages' />
1242 <param name='nsvc' doc='Filter based on NS Virtual Connection' />
1243 <param name='nsei' doc='Identify NS-VC by NSEI' />
1244 <param name='nsvci' doc='Identify NS-VC by NSVCI' />
1245 <param name='&lt;0-65535&gt;' doc='Numeric identifier' />
1246 </params>
1247 </command>
1248 <command id='logging filter bvc nsei &lt;0-65535&gt; bvci &lt;0-65535&gt;'>
1249 <params>
1250 <param name='logging' doc='Configure log message to this terminal' />
1251 <param name='filter' doc='Filter log messages' />
1252 <param name='bvc' doc='Filter based on BSSGP Virtual Connection' />
1253 <param name='nsei' doc='NSEI of the BVC to be filtered' />
1254 <param name='&lt;0-65535&gt;' doc='Network Service Entity Identifier (NSEI)' />
1255 <param name='bvci' doc='BVCI of the BVC to be filtered' />
1256 <param name='&lt;0-65535&gt;' doc='BSSGP Virtual Connection Identifier (BVCI)' />
1257 </params>
1258 </command>
1259 </node>
1260 <node id='8'>
1261 <command id='help'>
1262 <params>
1263 <param name='help' doc='Description of the interactive help system' />
1264 </params>
1265 </command>
1266 <command id='list'>
1267 <params>
1268 <param name='list' doc='Print command list' />
1269 </params>
1270 </command>
1271 <command id='write terminal'>
1272 <params>
1273 <param name='write' doc='Write running configuration to memory, network, or terminal' />
1274 <param name='terminal' doc='Write to terminal' />
1275 </params>
1276 </command>
1277 <command id='write file'>
1278 <params>
1279 <param name='write' doc='Write running configuration to memory, network, or terminal' />
1280 <param name='file' doc='Write to configuration file' />
1281 </params>
1282 </command>
1283 <command id='write memory'>
1284 <params>
1285 <param name='write' doc='Write running configuration to memory, network, or terminal' />
1286 <param name='memory' doc='Write configuration to the file (same as write file)' />
1287 </params>
1288 </command>
1289 <command id='write'>
1290 <params>
1291 <param name='write' doc='Write running configuration to memory, network, or terminal' />
1292 </params>
1293 </command>
1294 <command id='show running-config'>
1295 <params>
1296 <param name='show' doc='Show running system information' />
1297 <param name='running-config' doc='running configuration' />
1298 </params>
1299 </command>
1300 <command id='exit'>
1301 <params>
1302 <param name='exit' doc='Exit current mode and down to previous mode' />
1303 </params>
1304 </command>
1305 <command id='end'>
1306 <params>
1307 <param name='end' doc='End current mode and change to enable mode.' />
1308 </params>
1309 </command>
Philipp Maier5783c0f2017-03-08 15:25:44 +0100[diff] [blame^]1310 <command id='local-ip ADDR'>
1311 <params>
1312 <param name='local-ip' doc='Set the IP address to which we bind locally' />
1313 <param name='ADDR' doc='IP Address' />
1314 </params>
1315 </command>
1316 <command id='no local-ip'>
1317 <params>
1318 <param name='no' doc='Negate a command or set its defaults' />
1319 <param name='local-ip' doc='Set the IP address to which we bind locally' />
1320 </params>
1321 </command>
1322 <command id='remote-ip ADDR'>
1323 <params>
1324 <param name='remote-ip' doc='Set the remote IP address to which we connect' />
1325 <param name='ADDR' doc='IP Address' />
1326 </params>
1327 </command>
1328 <command id='remote-port &lt;1-65535&gt;'>
1329 <params>
1330 <param name='remote-port' doc='Set the remote port to which we connect' />
1331 <param name='&lt;1-65535&gt;' doc='Remote port number' />
1332 </params>
1333 </command>
1334 <command id='mtu &lt;100-65535&gt;'>
1335 <params>
1336 <param name='mtu' doc='Set the maximum packet size' />
1337 <param name='&lt;100-65535&gt;' doc='Size in byte' />
1338 </params>
1339 </command>
1340 <command id='no mtu'>
1341 <params>
1342 <param name='no' doc='Negate a command or set its defaults' />
1343 <param name='mtu' doc='Set the maximum packet size' />
1344 </params>
1345 </command>
1346 <command id='prefix PREFIX'>
1347 <params>
1348 <param name='prefix' doc='Set the item name prefix' />
1349 <param name='PREFIX' doc='The prefix string' />
1350 </params>
1351 </command>
1352 <command id='no prefix'>
1353 <params>
1354 <param name='no' doc='Negate a command or set its defaults' />
1355 <param name='prefix' doc='Set the item name prefix' />
1356 </params>
1357 </command>
1358 <command id='level (global|peer|subscriber)'>
1359 <params>
1360 <param name='level' doc='Set the maximum group level' />
1361 <param name='global' doc='Report global groups only' />
1362 <param name='peer' doc='Report global and network peer related groups' />
1363 <param name='subscriber' doc='Report global, peer, and subscriber groups' />
1364 </params>
1365 </command>
1366 <command id='enable'>
1367 <params>
1368 <param name='enable' doc='Enable the reporter' />
1369 </params>
1370 </command>
1371 <command id='disable'>
1372 <params>
1373 <param name='disable' doc='Disable the reporter' />
1374 </params>
1375 </command>
1376 </node>
1377 <node id='9'>
1378 <command id='help'>
1379 <params>
1380 <param name='help' doc='Description of the interactive help system' />
1381 </params>
1382 </command>
1383 <command id='list'>
1384 <params>
1385 <param name='list' doc='Print command list' />
1386 </params>
1387 </command>
1388 <command id='write terminal'>
1389 <params>
1390 <param name='write' doc='Write running configuration to memory, network, or terminal' />
1391 <param name='terminal' doc='Write to terminal' />
1392 </params>
1393 </command>
1394 <command id='write file'>
1395 <params>
1396 <param name='write' doc='Write running configuration to memory, network, or terminal' />
1397 <param name='file' doc='Write to configuration file' />
1398 </params>
1399 </command>
1400 <command id='write memory'>
1401 <params>
1402 <param name='write' doc='Write running configuration to memory, network, or terminal' />
1403 <param name='memory' doc='Write configuration to the file (same as write file)' />
1404 </params>
1405 </command>
1406 <command id='write'>
1407 <params>
1408 <param name='write' doc='Write running configuration to memory, network, or terminal' />
1409 </params>
1410 </command>
1411 <command id='show running-config'>
1412 <params>
1413 <param name='show' doc='Show running system information' />
1414 <param name='running-config' doc='running configuration' />
1415 </params>
1416 </command>
1417 <command id='exit'>
1418 <params>
1419 <param name='exit' doc='Exit current mode and down to previous mode' />
1420 </params>
1421 </command>
1422 <command id='end'>
1423 <params>
1424 <param name='end' doc='End current mode and change to enable mode.' />
1425 </params>
1426 </command>
Harald Welte9f1331b2016-02-20 10:56:10 +0100[diff] [blame]1427 <command id='login'>
1428 <params>
1429 <param name='login' doc='Enable password checking' />
1430 </params>
1431 </command>
1432 <command id='no login'>
1433 <params>
1434 <param name='no' doc='Negate a command or set its defaults' />
1435 <param name='login' doc='Enable password checking' />
1436 </params>
1437 </command>
Philipp Maier5783c0f2017-03-08 15:25:44 +0100[diff] [blame^]1438 <command id='bind A.B.C.D'>
1439 <params>
1440 <param name='bind' doc='Accept VTY telnet connections on local interface' />
1441 <param name='A.B.C.D' doc='Local interface IP address (default: 127.0.0.1)' />
1442 </params>
1443 </command>
Harald Welte9f1331b2016-02-20 10:56:10 +0100[diff] [blame]1444 </node>
Philipp Maier5783c0f2017-03-08 15:25:44 +0100[diff] [blame^]1445 <node id='12'>
Harald Welte9f1331b2016-02-20 10:56:10 +0100[diff] [blame]1446 <command id='help'>
1447 <params>
1448 <param name='help' doc='Description of the interactive help system' />
1449 </params>
1450 </command>
1451 <command id='list'>
1452 <params>
1453 <param name='list' doc='Print command list' />
1454 </params>
1455 </command>
1456 <command id='write terminal'>
1457 <params>
1458 <param name='write' doc='Write running configuration to memory, network, or terminal' />
1459 <param name='terminal' doc='Write to terminal' />
1460 </params>
1461 </command>
1462 <command id='write file'>
1463 <params>
1464 <param name='write' doc='Write running configuration to memory, network, or terminal' />
1465 <param name='file' doc='Write to configuration file' />
1466 </params>
1467 </command>
1468 <command id='write memory'>
1469 <params>
1470 <param name='write' doc='Write running configuration to memory, network, or terminal' />
1471 <param name='memory' doc='Write configuration to the file (same as write file)' />
1472 </params>
1473 </command>
1474 <command id='write'>
1475 <params>
1476 <param name='write' doc='Write running configuration to memory, network, or terminal' />
1477 </params>
1478 </command>
1479 <command id='show running-config'>
1480 <params>
1481 <param name='show' doc='Show running system information' />
1482 <param name='running-config' doc='running configuration' />
1483 </params>
1484 </command>
1485 <command id='exit'>
1486 <params>
1487 <param name='exit' doc='Exit current mode and down to previous mode' />
1488 </params>
1489 </command>
1490 <command id='end'>
1491 <params>
1492 <param name='end' doc='End current mode and change to enable mode.' />
1493 </params>
1494 </command>
1495 <command id='nse &lt;0-65535&gt; nsvci &lt;0-65534&gt;'>
1496 <params>
1497 <param name='nse' doc='Persistent NS Entity' />
1498 <param name='&lt;0-65535&gt;' doc='NS Entity ID (NSEI)' />
1499 <param name='nsvci' doc='NS Virtual Connection' />
1500 <param name='&lt;0-65534&gt;' doc='NS Virtual Connection ID (NSVCI)' />
1501 </params>
1502 </command>
1503 <command id='nse &lt;0-65535&gt; remote-ip A.B.C.D'>
1504 <params>
1505 <param name='nse' doc='Persistent NS Entity' />
1506 <param name='&lt;0-65535&gt;' doc='NS Entity ID (NSEI)' />
1507 <param name='remote-ip' doc='Remote IP Address' />
1508 <param name='A.B.C.D' doc='Remote IP Address' />
1509 </params>
1510 </command>
1511 <command id='nse &lt;0-65535&gt; remote-port &lt;0-65535&gt;'>
1512 <params>
1513 <param name='nse' doc='Persistent NS Entity' />
1514 <param name='&lt;0-65535&gt;' doc='NS Entity ID (NSEI)' />
1515 <param name='remote-port' doc='Remote UDP Port' />
1516 <param name='&lt;0-65535&gt;' doc='Remote UDP Port Number' />
1517 </params>
1518 </command>
1519 <command id='nse &lt;0-65535&gt; fr-dlci &lt;16-1007&gt;'>
1520 <params>
1521 <param name='nse' doc='Persistent NS Entity' />
1522 <param name='&lt;0-65535&gt;' doc='NS Entity ID (NSEI)' />
1523 <param name='fr-dlci' doc='Frame Relay DLCI' />
1524 <param name='&lt;16-1007&gt;' doc='Frame Relay DLCI Number' />
1525 </params>
1526 </command>
1527 <command id='nse &lt;0-65535&gt; encapsulation (udp|framerelay-gre)'>
1528 <params>
1529 <param name='nse' doc='Persistent NS Entity' />
1530 <param name='&lt;0-65535&gt;' doc='NS Entity ID (NSEI)' />
1531 <param name='encapsulation' doc='Encapsulation for NS' />
1532 <param name='udp' doc='UDP/IP Encapsulation' />
1533 <param name='framerelay-gre' doc='Frame-Relay/GRE/IP Encapsulation' />
1534 </params>
1535 </command>
1536 <command id='nse &lt;0-65535&gt; remote-role (sgsn|bss)'>
1537 <params>
1538 <param name='nse' doc='Persistent NS Entity' />
1539 <param name='&lt;0-65535&gt;' doc='NS Entity ID (NSEI)' />
1540 <param name='remote-role' doc='Remote NSE Role' />
1541 <param name='sgsn' doc='Remote Peer is SGSN' />
1542 <param name='bss' doc='Remote Peer is BSS' />
1543 </params>
1544 </command>
1545 <command id='no nse &lt;0-65535&gt;'>
1546 <params>
1547 <param name='no' doc='Delete Persistent NS Entity' />
1548 <param name='nse' doc='Delete Persistent NS Entity' />
1549 <param name='&lt;0-65535&gt;' doc='NS Entity ID (NSEI)' />
1550 </params>
1551 </command>
1552 <command id='timer (tns-block|tns-block-retries|tns-reset|tns-reset-retries|tns-test|tns-alive|tns-alive-retries) &lt;0-65535&gt;'>
1553 <params>
1554 <param name='timer' doc='Network Service Timer' />
1555 <param name='tns-block' doc='(un)blocking Timer (Tns-block) timeout' />
1556 <param name='tns-block-retries' doc='(un)blocking Timer (Tns-block) number of retries' />
1557 <param name='tns-reset' doc='Reset Timer (Tns-reset) timeout' />
1558 <param name='tns-reset-retries' doc='Reset Timer (Tns-reset) number of retries' />
1559 <param name='tns-test' doc='Test Timer (Tns-test) timeout' />
1560 <param name='tns-alive' doc='Alive Timer (Tns-alive) timeout' />
1561 <param name='tns-alive-retries' doc='Alive Timer (Tns-alive) number of retries' />
1562 <param name='&lt;0-65535&gt;' doc='Timer Value' />
1563 </params>
1564 </command>
1565 <command id='encapsulation udp local-ip A.B.C.D'>
1566 <params>
1567 <param name='encapsulation' doc='NS encapsulation options' />
1568 <param name='udp' doc='NS over UDP Encapsulation' />
1569 <param name='local-ip' doc='Set the IP address on which we listen for NS/UDP' />
1570 <param name='A.B.C.D' doc='IP Address' />
1571 </params>
1572 </command>
1573 <command id='encapsulation udp local-port &lt;0-65535&gt;'>
1574 <params>
1575 <param name='encapsulation' doc='NS encapsulation options' />
1576 <param name='udp' doc='NS over UDP Encapsulation' />
1577 <param name='local-port' doc='Set the UDP port on which we listen for NS/UDP' />
1578 <param name='&lt;0-65535&gt;' doc='UDP port number' />
1579 </params>
1580 </command>
1581 <command id='encapsulation udp dscp &lt;0-255&gt;'>
1582 <params>
1583 <param name='encapsulation' doc='NS encapsulation options' />
1584 <param name='udp' doc='NS over UDP Encapsulation' />
1585 <param name='dscp' doc='Set DSCP/TOS on the UDP socket' />
1586 <param name='&lt;0-255&gt;' doc='DSCP Value' />
1587 </params>
1588 </command>
1589 <command id='encapsulation framerelay-gre enabled (1|0)'>
1590 <params>
1591 <param name='encapsulation' doc='NS encapsulation options' />
1592 <param name='framerelay-gre' doc='NS over Frame Relay over GRE Encapsulation' />
1593 <param name='enabled' doc='Enable or disable Frame Relay over GRE' />
1594 <param name='1' doc='Enable' />
1595 <param name='0' doc='Disable' />
1596 </params>
1597 </command>
1598 <command id='encapsulation framerelay-gre local-ip A.B.C.D'>
1599 <params>
1600 <param name='encapsulation' doc='NS encapsulation options' />
1601 <param name='framerelay-gre' doc='NS over Frame Relay over GRE Encapsulation' />
1602 <param name='local-ip' doc='Set the IP address on which we listen for NS/FR/GRE' />
1603 <param name='A.B.C.D' doc='IP Address' />
1604 </params>
1605 </command>
1606 </node>
Philipp Maier5783c0f2017-03-08 15:25:44 +0100[diff] [blame^]1607 <node id='13'>
Harald Welte9f1331b2016-02-20 10:56:10 +0100[diff] [blame]1608 <command id='help'>
1609 <params>
1610 <param name='help' doc='Description of the interactive help system' />
1611 </params>
1612 </command>
1613 <command id='list'>
1614 <params>
1615 <param name='list' doc='Print command list' />
1616 </params>
1617 </command>
1618 <command id='write terminal'>
1619 <params>
1620 <param name='write' doc='Write running configuration to memory, network, or terminal' />
1621 <param name='terminal' doc='Write to terminal' />
1622 </params>
1623 </command>
1624 <command id='write file'>
1625 <params>
1626 <param name='write' doc='Write running configuration to memory, network, or terminal' />
1627 <param name='file' doc='Write to configuration file' />
1628 </params>
1629 </command>
1630 <command id='write memory'>
1631 <params>
1632 <param name='write' doc='Write running configuration to memory, network, or terminal' />
1633 <param name='memory' doc='Write configuration to the file (same as write file)' />
1634 </params>
1635 </command>
1636 <command id='write'>
1637 <params>
1638 <param name='write' doc='Write running configuration to memory, network, or terminal' />
1639 </params>
1640 </command>
1641 <command id='show running-config'>
1642 <params>
1643 <param name='show' doc='Show running system information' />
1644 <param name='running-config' doc='running configuration' />
1645 </params>
1646 </command>
1647 <command id='exit'>
1648 <params>
1649 <param name='exit' doc='Exit current mode and down to previous mode' />
1650 </params>
1651 </command>
1652 <command id='end'>
1653 <params>
1654 <param name='end' doc='End current mode and change to enable mode.' />
1655 </params>
1656 </command>
1657 </node>
Philipp Maier5783c0f2017-03-08 15:25:44 +0100[diff] [blame^]1658 <node id='14'>
1659 <command id='bind A.B.C.D'>
1660 <params>
1661 <param name='bind' doc='Set bind address to listen for Control connections' />
1662 <param name='A.B.C.D' doc='Local IP address (default 127.0.0.1)' />
1663 </params>
1664 </command>
1665 </node>
1666 <node id='26'>
Harald Welte9f1331b2016-02-20 10:56:10 +0100[diff] [blame]1667 <command id='help'>
1668 <params>
1669 <param name='help' doc='Description of the interactive help system' />
1670 </params>
1671 </command>
1672 <command id='list'>
1673 <params>
1674 <param name='list' doc='Print command list' />
1675 </params>
1676 </command>
1677 <command id='write terminal'>
1678 <params>
1679 <param name='write' doc='Write running configuration to memory, network, or terminal' />
1680 <param name='terminal' doc='Write to terminal' />
1681 </params>
1682 </command>
1683 <command id='write file'>
1684 <params>
1685 <param name='write' doc='Write running configuration to memory, network, or terminal' />
1686 <param name='file' doc='Write to configuration file' />
1687 </params>
1688 </command>
1689 <command id='write memory'>
1690 <params>
1691 <param name='write' doc='Write running configuration to memory, network, or terminal' />
1692 <param name='memory' doc='Write configuration to the file (same as write file)' />
1693 </params>
1694 </command>
1695 <command id='write'>
1696 <params>
1697 <param name='write' doc='Write running configuration to memory, network, or terminal' />
1698 </params>
1699 </command>
1700 <command id='show running-config'>
1701 <params>
1702 <param name='show' doc='Show running system information' />
1703 <param name='running-config' doc='running configuration' />
1704 </params>
1705 </command>
1706 <command id='exit'>
1707 <params>
1708 <param name='exit' doc='Exit current mode and down to previous mode' />
1709 </params>
1710 </command>
1711 <command id='end'>
1712 <params>
1713 <param name='end' doc='End current mode and change to enable mode.' />
1714 </params>
1715 </command>
1716 <command id='gtp local-ip A.B.C.D'>
1717 <params>
1718 <param name='gtp' doc='GTP Parameters' />
1719 <param name='local-ip' doc='Set the IP address for the local GTP bind' />
1720 <param name='A.B.C.D' doc='IPv4 Address' />
1721 </params>
1722 </command>
1723 <command id='ggsn &lt;0-255&gt; remote-ip A.B.C.D'>
1724 <params>
1725 <param name='ggsn' doc='Configure the GGSN information' />
1726 <param name='&lt;0-255&gt;' doc='GGSN Number' />
1727 <param name='remote-ip' doc='IP information' />
1728 <param name='A.B.C.D' doc='IPv4 Address' />
1729 </params>
1730 </command>
1731 <command id='ggsn &lt;0-255&gt; gtp-version (0|1)'>
1732 <params>
1733 <param name='ggsn' doc='Configure the GGSN information' />
1734 <param name='&lt;0-255&gt;' doc='GGSN Number' />
1735 <param name='gtp-version' doc='GTP Version' />
1736 <param name='0' doc='Version 0' />
1737 <param name='1' doc='Version 1' />
1738 </params>
1739 </command>
1740 <command id='imsi-acl (add|del) IMSI'>
1741 <params>
1742 <param name='imsi-acl' doc='Access Control List of foreign IMSIs' />
1743 <param name='add' doc='Add IMSI to ACL' />
1744 <param name='del' doc='Remove IMSI from ACL' />
1745 <param name='IMSI' doc='IMSI of subscriber' />
1746 </params>
1747 </command>
Philipp Maier5783c0f2017-03-08 15:25:44 +0100[diff] [blame^]1748 <command id='auth-policy (accept-all|closed|acl-only|remote)'>
Harald Welte9f1331b2016-02-20 10:56:10 +0100[diff] [blame]1749 <params>
1750 <param name='auth-policy' doc='Autorization Policy of SGSN' />
Philipp Maier5783c0f2017-03-08 15:25:44 +0100[diff] [blame^]1751 <param name='accept-all' doc='Accept all IMSIs (DANGEROUS)' />
1752 <param name='closed' doc='Accept only home network subscribers or those in the ACL' />
1753 <param name='acl-only' doc='Accept only subscribers in the ACL' />
1754 <param name='remote' doc='Use remote subscription data only (HLR)' />
1755 </params>
1756 </command>
1757 <command id='encryption (GEA0|GEA1|GEA2|GEA3|GEA4)'>
1758 <params>
1759 <param name='encryption' doc='Set encryption algorithm for SGSN' />
1760 <param name='GEA0' doc='Use GEA0 (no encryption)' />
1761 <param name='GEA1' doc='Use GEA1' />
1762 <param name='GEA2' doc='Use GEA2' />
1763 <param name='GEA3' doc='Use GEA3' />
1764 <param name='GEA4' doc='Use GEA4' />
1765 </params>
1766 </command>
1767 <command id='gsup remote-ip A.B.C.D'>
1768 <params>
1769 <param name='gsup' doc='GSUP Parameters' />
1770 <param name='remote-ip' doc='Set the IP address of the remote GSUP server' />
1771 <param name='A.B.C.D' doc='IPv4 Address' />
1772 </params>
1773 </command>
1774 <command id='gsup remote-port &lt;0-65535&gt;'>
1775 <params>
1776 <param name='gsup' doc='GSUP Parameters' />
1777 <param name='remote-port' doc='Set the TCP port of the remote GSUP server' />
1778 <param name='&lt;0-65535&gt;' doc='Remote TCP port' />
1779 </params>
1780 </command>
1781 <command id='gsup oap-id &lt;0-65535&gt;'>
1782 <params>
1783 <param name='gsup' doc='GSUP Parameters' />
1784 <param name='oap-id' doc='Set the SGSN&apos;s OAP client ID' />
1785 <param name='&lt;0-65535&gt;' doc='OAP client ID (0 == disabled)' />
1786 </params>
1787 </command>
1788 <command id='gsup oap-k K'>
1789 <params>
1790 <param name='gsup' doc='GSUP Parameters' />
1791 <param name='oap-k' doc='Set the OAP shared secret K' />
1792 <param name='K' doc='K value (16 byte) hex' />
1793 </params>
1794 </command>
1795 <command id='gsup oap-opc OPC'>
1796 <params>
1797 <param name='gsup' doc='GSUP Parameters' />
1798 <param name='oap-opc' doc='Set the OAP shared secret OPC' />
1799 <param name='OPC' doc='OPC value (16 byte) hex' />
1800 </params>
1801 </command>
1802 <command id='apn APNAME ggsn &lt;0-255&gt;'>
1803 <params>
1804 <param name='apn' doc='Configure the information per APN' />
1805 <param name='APNAME' doc='The APN gateway name optionally prefixed by &apos;*&apos; (wildcard)' />
1806 <param name='ggsn' doc='Select the GGSN to use when the APN gateway prefix matches' />
1807 <param name='&lt;0-255&gt;' doc='The GGSN id' />
1808 </params>
1809 </command>
1810 <command id='apn APNAME imsi-prefix IMSIPRE ggsn &lt;0-255&gt;'>
1811 <params>
1812 <param name='apn' doc='Configure the information per APN' />
1813 <param name='APNAME' doc='The APN gateway name optionally prefixed by &apos;*&apos; (wildcard)' />
1814 <param name='imsi-prefix' doc='Restrict rule to a certain IMSI prefix' />
1815 <param name='IMSIPRE' doc='An IMSI prefix' />
1816 <param name='ggsn' doc='Select the GGSN to use when APN gateway and IMSI prefix match' />
1817 <param name='&lt;0-255&gt;' doc='The GGSN id' />
1818 </params>
1819 </command>
1820 <command id='access-point-name NAME'>
1821 <params>
1822 <param name='access-point-name' doc='Configure a global list of allowed APNs' />
1823 <param name='NAME' doc='Add this NAME to the list' />
1824 </params>
1825 </command>
1826 <command id='no access-point-name NAME'>
1827 <params>
1828 <param name='no' doc='Negate a command or set its defaults' />
1829 <param name='access-point-name' doc='Configure a global list of allowed APNs' />
1830 <param name='NAME' doc='Remove entry with NAME' />
1831 </params>
1832 </command>
1833 <command id='cdr filename NAME'>
1834 <params>
1835 <param name='cdr' doc='CDR' />
1836 <param name='filename' doc='Set filename' />
1837 <param name='NAME' doc='name' />
1838 </params>
1839 </command>
1840 <command id='no cdr filename'>
1841 <params>
1842 <param name='no' doc='Negate a command or set its defaults' />
1843 <param name='cdr' doc='CDR' />
1844 <param name='filename' doc='Disable CDR generation' />
1845 </params>
1846 </command>
1847 <command id='cdr interval &lt;1-2147483647&gt;'>
1848 <params>
1849 <param name='cdr' doc='CDR' />
1850 <param name='interval' doc='PDP periodic log interval' />
1851 <param name='&lt;1-2147483647&gt;' doc='Seconds' />
1852 </params>
1853 </command>
1854 <command id='ggsn dynamic'>
1855 <params>
1856 <param name='ggsn' doc='Configure the GGSN information' />
1857 <param name='dynamic' doc='Enable dynamic GRX based look-up (requires restart)' />
1858 </params>
1859 </command>
1860 <command id='grx-dns-add A.B.C.D'>
1861 <params>
1862 <param name='grx-dns-add' doc='Add DNS server' />
1863 <param name='A.B.C.D' doc='IPv4 address' />
1864 </params>
1865 </command>
1866 <command id='timer t3312 &lt;0-65535&gt;'>
1867 <params>
1868 <param name='timer' doc='Configure GPRS Timers' />
1869 <param name='t3312' doc='Periodic RA Update timer (s)' />
1870 <param name='&lt;0-65535&gt;' doc='Timer Value in seconds' />
1871 </params>
1872 </command>
1873 <command id='timer t3322 &lt;0-65535&gt;'>
1874 <params>
1875 <param name='timer' doc='Configure GPRS Timers' />
1876 <param name='t3322' doc='Detach request -&gt; accept timer (s)' />
1877 <param name='&lt;0-65535&gt;' doc='Timer Value in seconds' />
1878 </params>
1879 </command>
1880 <command id='timer t3350 &lt;0-65535&gt;'>
1881 <params>
1882 <param name='timer' doc='Configure GPRS Timers' />
1883 <param name='t3350' doc='Waiting for ATT/RAU/TMSI_COMPL timer (s)' />
1884 <param name='&lt;0-65535&gt;' doc='Timer Value in seconds' />
1885 </params>
1886 </command>
1887 <command id='timer t3360 &lt;0-65535&gt;'>
1888 <params>
1889 <param name='timer' doc='Configure GPRS Timers' />
1890 <param name='t3360' doc='Waiting for AUTH/CIPH response timer (s)' />
1891 <param name='&lt;0-65535&gt;' doc='Timer Value in seconds' />
1892 </params>
1893 </command>
1894 <command id='timer t3370 &lt;0-65535&gt;'>
1895 <params>
1896 <param name='timer' doc='Configure GPRS Timers' />
1897 <param name='t3370' doc='Waiting for IDENTITY response timer (s)' />
1898 <param name='&lt;0-65535&gt;' doc='Timer Value in seconds' />
1899 </params>
1900 </command>
1901 <command id='timer t3313 &lt;0-65535&gt;'>
1902 <params>
1903 <param name='timer' doc='Configure GPRS Timers' />
1904 <param name='t3313' doc='Waiting for paging response timer (s)' />
1905 <param name='&lt;0-65535&gt;' doc='Timer Value in seconds' />
1906 </params>
1907 </command>
1908 <command id='timer t3314 &lt;0-65535&gt;'>
1909 <params>
1910 <param name='timer' doc='Configure GPRS Timers' />
1911 <param name='t3314' doc='Force to STANDBY on expiry timer (s)' />
1912 <param name='&lt;0-65535&gt;' doc='Timer Value in seconds' />
1913 </params>
1914 </command>
1915 <command id='timer t3316 &lt;0-65535&gt;'>
1916 <params>
1917 <param name='timer' doc='Configure GPRS Timers' />
1918 <param name='t3316' doc='AA-Ready timer (s)' />
1919 <param name='&lt;0-65535&gt;' doc='Timer Value in seconds' />
1920 </params>
1921 </command>
1922 <command id='timer t3385 &lt;0-65535&gt;'>
1923 <params>
1924 <param name='timer' doc='Configure GPRS Timers' />
1925 <param name='t3385' doc='Wait for ACT PDP CTX REQ timer (s)' />
1926 <param name='&lt;0-65535&gt;' doc='Timer Value in seconds' />
1927 </params>
1928 </command>
1929 <command id='timer t3386 &lt;0-65535&gt;'>
1930 <params>
1931 <param name='timer' doc='Configure GPRS Timers' />
1932 <param name='t3386' doc='Wait for MODIFY PDP CTX ACK timer (s)' />
1933 <param name='&lt;0-65535&gt;' doc='Timer Value in seconds' />
1934 </params>
1935 </command>
1936 <command id='timer t3395 &lt;0-65535&gt;'>
1937 <params>
1938 <param name='timer' doc='Configure GPRS Timers' />
1939 <param name='t3395' doc='Wait for DEACT PDP CTX ACK timer (s)' />
1940 <param name='&lt;0-65535&gt;' doc='Timer Value in seconds' />
1941 </params>
1942 </command>
1943 <command id='timer t3397 &lt;0-65535&gt;'>
1944 <params>
1945 <param name='timer' doc='Configure GPRS Timers' />
1946 <param name='t3397' doc='Wait for DEACT AA PDP CTX ACK timer (s)' />
1947 <param name='&lt;0-65535&gt;' doc='Timer Value in seconds' />
1948 </params>
1949 </command>
1950 <command id='no compression rfc1144'>
1951 <params>
1952 <param name='no' doc='Negate a command or set its defaults' />
1953 <param name='compression' doc='Configure compression' />
1954 <param name='rfc1144' doc='disable rfc1144 TCP/IP header compression' />
1955 </params>
1956 </command>
1957 <command id='compression rfc1144 active slots &lt;1-256&gt;'>
1958 <params>
1959 <param name='compression' doc='Configure compression' />
1960 <param name='rfc1144' doc='RFC1144 Header compresion scheme' />
1961 <param name='active' doc='Compression is actively proposed' />
1962 <param name='slots' doc='Number of compression state slots' />
1963 <param name='&lt;1-256&gt;' doc='Number of compression state slots' />
1964 </params>
1965 </command>
1966 <command id='compression rfc1144 passive'>
1967 <params>
1968 <param name='compression' doc='Configure compression' />
1969 <param name='rfc1144' doc='RFC1144 Header compresion scheme' />
1970 <param name='passive' doc='Compression is available on request' />
1971 </params>
1972 </command>
1973 <command id='no compression v42bis'>
1974 <params>
1975 <param name='no' doc='Negate a command or set its defaults' />
1976 <param name='compression' doc='Configure compression' />
1977 <param name='v42bis' doc='disable V.42bis data compression' />
1978 </params>
1979 </command>
1980 <command id='compression v42bis active direction (ms|sgsn|both) codewords &lt;512-65535&gt; strlen &lt;6-250&gt;'>
1981 <params>
1982 <param name='compression' doc='Configure compression' />
1983 <param name='v42bis' doc='V.42bis data compresion scheme' />
1984 <param name='active' doc='Compression is actively proposed' />
1985 <param name='direction' doc='Direction in which the compression shall be active (p0)' />
1986 <param name='ms' doc='Compress ms-&gt;sgsn direction only' />
1987 <param name='sgsn' doc='Compress sgsn-&gt;ms direction only' />
1988 <param name='both' doc='Both directions' />
1989 <param name='codewords' doc='Number of codewords (p1)' />
1990 <param name='&lt;512-65535&gt;' doc='Number of codewords' />
1991 <param name='strlen' doc='Maximum string length (p2)' />
1992 <param name='&lt;6-250&gt;' doc='Maximum string length' />
1993 </params>
1994 </command>
1995 <command id='compression v42bis passive'>
1996 <params>
1997 <param name='compression' doc='Configure compression' />
1998 <param name='v42bis' doc='V.42bis data compresion scheme' />
1999 <param name='passive' doc='Compression is available on request' />
Harald Welte9f1331b2016-02-20 10:56:10 +0100[diff] [blame]2000 </params>
2001 </command>
2002 </node>
Philipp Maier5783c0f2017-03-08 15:25:44 +0100[diff] [blame^]2003</vtydoc>