blob: cc8fffaec628a4688186944fc2d87f24ae2ac4bd [file] [log] [blame]
Daniel Willmann79c6c4d2019-06-19 12:05:05 +02001<vtydoc xmlns='urn:osmocom:xml:libosmocore:vty:doc:1.0'>
2 <node id='_common_cmds_'>
3 <name>Common Commands</name>
4 <description>These commands are available on all VTY nodes. They are listed here only once, to unclutter the VTY reference.</description>
5 <command id='help'>
6 <params>
7 <param name='help' doc='Description of the interactive help system' />
8 </params>
9 </command>
10 <command id='list'>
11 <params>
12 <param name='list' doc='Print command list' />
13 </params>
14 </command>
15 <command id='write terminal'>
16 <params>
17 <param name='write' doc='Write running configuration to memory, network, or terminal' />
18 <param name='terminal' doc='Write to terminal' />
19 </params>
20 </command>
21 <command id='write file'>
22 <params>
23 <param name='write' doc='Write running configuration to memory, network, or terminal' />
24 <param name='file' doc='Write to configuration file' />
25 </params>
26 </command>
27 <command id='write memory'>
28 <params>
29 <param name='write' doc='Write running configuration to memory, network, or terminal' />
30 <param name='memory' doc='Write configuration to the file (same as write file)' />
31 </params>
32 </command>
33 <command id='write'>
34 <params>
35 <param name='write' doc='Write running configuration to memory, network, or terminal' />
36 </params>
37 </command>
38 <command id='show running-config'>
39 <params>
40 <param name='show' doc='Show running system information' />
41 <param name='running-config' doc='running configuration' />
42 </params>
43 </command>
44 <command id='exit'>
45 <params>
46 <param name='exit' doc='Exit current mode and down to previous mode' />
47 </params>
48 </command>
49 <command id='end'>
50 <params>
51 <param name='end' doc='End current mode and change to enable mode.' />
52 </params>
53 </command>
54 </node>
55 <node id='view'>
56 <name>view</name>
57 <command id='show version'>
58 <params>
59 <param name='show' doc='Show running system information' />
60 <param name='version' doc='Displays program version' />
61 </params>
62 </command>
63 <command id='show online-help'>
64 <params>
65 <param name='show' doc='Show running system information' />
66 <param name='online-help' doc='Online help' />
67 </params>
68 </command>
69 <command id='enable'>
70 <params>
71 <param name='enable' doc='Turn on privileged mode command' />
72 </params>
73 </command>
74 <command id='terminal length &lt;0-512&gt;'>
75 <params>
76 <param name='terminal' doc='Set terminal line parameters' />
77 <param name='length' doc='Set number of lines on a screen' />
78 <param name='&lt;0-512&gt;' doc='Number of lines on screen (0 for no pausing)' />
79 </params>
80 </command>
81 <command id='terminal no length'>
82 <params>
83 <param name='terminal' doc='Set terminal line parameters' />
84 <param name='no' doc='Negate a command or set its defaults' />
85 <param name='length' doc='Set number of lines on a screen' />
86 </params>
87 </command>
88 <command id='who'>
89 <params>
90 <param name='who' doc='Display who is on vty' />
91 </params>
92 </command>
93 <command id='show history'>
94 <params>
95 <param name='show' doc='Show running system information' />
96 <param name='history' doc='Display the session command history' />
97 </params>
98 </command>
99 <command id='logging enable'>
100 <params>
101 <param name='logging' doc='Configure logging' />
102 <param name='enable' doc='Enables logging to this vty' />
103 </params>
104 </command>
105 <command id='logging disable'>
106 <params>
107 <param name='logging' doc='Configure logging' />
108 <param name='disable' doc='Disables logging to this vty' />
109 </params>
110 </command>
111 <command id='logging filter all (0|1)'>
112 <params>
113 <param name='logging' doc='Configure logging' />
114 <param name='filter' doc='Filter log messages' />
115 <param name='all' doc='Do you want to log all messages?' />
116 <param name='0' doc='Only print messages matched by other filters' />
117 <param name='1' doc='Bypass filter and print all messages' />
118 </params>
119 </command>
120 <command id='logging color (0|1)'>
121 <params>
122 <param name='logging' doc='Configure logging' />
123 <param name='color' doc='Configure color-printing for log messages' />
124 <param name='0' doc='Don&apos;t use color for printing messages' />
125 <param name='1' doc='Use color for printing messages' />
126 </params>
127 </command>
128 <command id='logging timestamp (0|1)'>
129 <params>
130 <param name='logging' doc='Configure logging' />
131 <param name='timestamp' doc='Configure log message timestamping' />
132 <param name='0' doc='Don&apos;t prefix each log message' />
133 <param name='1' doc='Prefix each log message with current timestamp' />
134 </params>
135 </command>
136 <command id='logging print extended-timestamp (0|1)'>
137 <params>
138 <param name='logging' doc='Configure logging' />
139 <param name='print' doc='Log output settings' />
140 <param name='extended-timestamp' doc='Configure log message timestamping' />
141 <param name='0' doc='Don&apos;t prefix each log message' />
142 <param name='1' doc='Prefix each log message with current timestamp with YYYYMMDDhhmmssnnn' />
143 </params>
144 </command>
145 <command id='logging print category (0|1)'>
146 <params>
147 <param name='logging' doc='Configure logging' />
148 <param name='print' doc='Log output settings' />
149 <param name='category' doc='Configure log message' />
150 <param name='0' doc='Don&apos;t prefix each log message' />
151 <param name='1' doc='Prefix each log message with category/subsystem name' />
152 </params>
153 </command>
154 <command id='logging print category-hex (0|1)'>
155 <params>
156 <param name='logging' doc='Configure logging' />
157 <param name='print' doc='Log output settings' />
158 <param name='category-hex' doc='Configure log message' />
159 <param name='0' doc='Don&apos;t prefix each log message' />
160 <param name='1' doc='Prefix each log message with category/subsystem nr in hex (&apos;&lt;000b&gt;&apos;)' />
161 </params>
162 </command>
163 <command id='logging print level (0|1)'>
164 <params>
165 <param name='logging' doc='Configure logging' />
166 <param name='print' doc='Log output settings' />
167 <param name='level' doc='Configure log message' />
168 <param name='0' doc='Don&apos;t prefix each log message' />
169 <param name='1' doc='Prefix each log message with the log level name' />
170 </params>
171 </command>
172 <command id='logging print file (0|1|basename) [last]'>
173 <params>
174 <param name='logging' doc='Configure logging' />
175 <param name='print' doc='Log output settings' />
176 <param name='file' doc='Configure log message' />
177 <param name='0' doc='Don&apos;t prefix each log message' />
178 <param name='1' doc='Prefix each log message with the source file and line' />
179 <param name='basename' doc='Prefix each log message with the source file&apos;s basename (strip leading paths) and line' />
180 <param name='[last]' doc='Log source file info at the end of a log line. If omitted, log source file info just before the log text.' />
181 </params>
182 </command>
183 <command id='logging set-log-mask MASK'>
184 <params>
185 <param name='logging' doc='Configure logging' />
186 <param name='set-log-mask' doc='Set the logmask of this logging target' />
187 <param name='MASK' doc='List of logging categories to log, e.g. &apos;abc:mno:xyz&apos;. Available log categories depend on the specific application, refer to the &apos;logging level&apos; command. Optionally add individual log levels like &apos;abc,1:mno,3:xyz,5&apos;, where the level numbers are LOGL_DEBUG=1 LOGL_INFO=3 LOGL_NOTICE=5 LOGL_ERROR=7 LOGL_FATAL=8' />
188 </params>
189 </command>
190 <command id='logging level (csn1|l1if|rlcmac|rlcmacdata|rlcmacdl|rlcmacul|rlcmacsched|rlcmacmeas|tbf|tbfdl|tbful|ns|bssgp|pcu|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro) (debug|info|notice|error|fatal)'>
191 <params>
192 <param name='logging' doc='Configure logging' />
193 <param name='level' doc='Set the log level for a specified category' />
194 <param name='csn1' doc='Concrete Syntax Notation One (CSN1)' />
195 <param name='l1if' doc='GPRS PCU L1 interface (L1IF)' />
196 <param name='rlcmac' doc='GPRS RLC/MAC layer (RLCMAC)' />
197 <param name='rlcmacdata' doc='GPRS RLC/MAC layer Data (RLCMAC)' />
198 <param name='rlcmacdl' doc='GPRS RLC/MAC layer Downlink (RLCMAC)' />
199 <param name='rlcmacul' doc='GPRS RLC/MAC layer Uplink (RLCMAC)' />
200 <param name='rlcmacsched' doc='GPRS RLC/MAC layer Scheduling (RLCMAC)' />
201 <param name='rlcmacmeas' doc='GPRS RLC/MAC layer Measurements (RLCMAC)' />
202 <param name='tbf' doc='Temporary Block Flow (TBF)' />
203 <param name='tbfdl' doc='Temporary Block Flow (TBF) Downlink' />
204 <param name='tbful' doc='Temporary Block Flow (TBF) Uplink' />
205 <param name='ns' doc='GPRS Network Service Protocol (NS)' />
206 <param name='bssgp' doc='GPRS BSS Gateway Protocol (BSSGP)' />
207 <param name='pcu' doc='GPRS Packet Control Unit (PCU)' />
208 <param name='lglobal' doc='Library-internal global log family' />
209 <param name='llapd' doc='LAPD in libosmogsm' />
210 <param name='linp' doc='A-bis Intput Subsystem' />
211 <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' />
212 <param name='lmi' doc='A-bis Input Driver for Signalling' />
213 <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' />
214 <param name='lsms' doc='Layer3 Short Message Service (SMS)' />
215 <param name='lctrl' doc='Control Interface' />
216 <param name='lgtp' doc='GPRS GTP library' />
217 <param name='lstats' doc='Statistics messages and logging' />
218 <param name='lgsup' doc='Generic Subscriber Update Protocol' />
219 <param name='loap' doc='Osmocom Authentication Protocol' />
220 <param name='lss7' doc='libosmo-sigtran Signalling System 7' />
221 <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' />
222 <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' />
223 <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' />
224 <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' />
225 <param name='ljibuf' doc='libosmo-netif Jitter Buffer' />
226 <param name='lrspro' doc='Remote SIM protocol' />
227 <param name='debug' doc='Log debug messages and higher levels' />
228 <param name='info' doc='Log informational messages and higher levels' />
229 <param name='notice' doc='Log noticeable messages and higher levels' />
230 <param name='error' doc='Log error messages and higher levels' />
231 <param name='fatal' doc='Log only fatal messages' />
232 </params>
233 </command>
234 <command id='logging level set-all (debug|info|notice|error|fatal)'>
235 <params>
236 <param name='logging' doc='Configure logging' />
237 <param name='level' doc='Set the log level for a specified category' />
238 <param name='set-all' doc='Once-off set all categories to the given log level. There is no single command to take back these changes -- each category is set to the given level, period.' />
239 <param name='debug' doc='Log debug messages and higher levels' />
240 <param name='info' doc='Log informational messages and higher levels' />
241 <param name='notice' doc='Log noticeable messages and higher levels' />
242 <param name='error' doc='Log error messages and higher levels' />
243 <param name='fatal' doc='Log only fatal messages' />
244 </params>
245 </command>
246 <command id='logging level force-all (debug|info|notice|error|fatal)'>
247 <params>
248 <param name='logging' doc='Configure logging' />
249 <param name='level' doc='Set the log level for a specified category' />
250 <param name='force-all' doc='Globally force all logging categories to a specific level. This is released by the &apos;no logging level force-all&apos; command. Note: any &apos;logging level &lt;category&gt; &lt;level&gt;&apos; commands will have no visible effect after this, until the forced level is released.' />
251 <param name='debug' doc='Log debug messages and higher levels' />
252 <param name='info' doc='Log informational messages and higher levels' />
253 <param name='notice' doc='Log noticeable messages and higher levels' />
254 <param name='error' doc='Log error messages and higher levels' />
255 <param name='fatal' doc='Log only fatal messages' />
256 </params>
257 </command>
258 <command id='no logging level force-all'>
259 <params>
260 <param name='no' doc='Negate a command or set its defaults' />
261 <param name='logging' doc='Configure logging' />
262 <param name='level' doc='Set the log level for a specified category' />
263 <param name='force-all' doc='Release any globally forced log level set with &apos;logging level force-all &lt;level&gt;&apos;' />
264 </params>
265 </command>
Oliver Smith37ae22a2019-09-05 15:35:43 +0200266 <command id='logp (csn1|l1if|rlcmac|rlcmacdata|rlcmacdl|rlcmacul|rlcmacsched|rlcmacmeas|tbf|tbfdl|tbful|ns|bssgp|pcu|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro) (debug|info|notice|error|fatal) .LOGMESSAGE'>
267 <params>
268 <param name='logp' doc='Print a message on all log outputs; useful for placing markers in test logs' />
269 <param name='csn1' doc='Concrete Syntax Notation One (CSN1)' />
270 <param name='l1if' doc='GPRS PCU L1 interface (L1IF)' />
271 <param name='rlcmac' doc='GPRS RLC/MAC layer (RLCMAC)' />
272 <param name='rlcmacdata' doc='GPRS RLC/MAC layer Data (RLCMAC)' />
273 <param name='rlcmacdl' doc='GPRS RLC/MAC layer Downlink (RLCMAC)' />
274 <param name='rlcmacul' doc='GPRS RLC/MAC layer Uplink (RLCMAC)' />
275 <param name='rlcmacsched' doc='GPRS RLC/MAC layer Scheduling (RLCMAC)' />
276 <param name='rlcmacmeas' doc='GPRS RLC/MAC layer Measurements (RLCMAC)' />
277 <param name='tbf' doc='Temporary Block Flow (TBF)' />
278 <param name='tbfdl' doc='Temporary Block Flow (TBF) Downlink' />
279 <param name='tbful' doc='Temporary Block Flow (TBF) Uplink' />
280 <param name='ns' doc='GPRS Network Service Protocol (NS)' />
281 <param name='bssgp' doc='GPRS BSS Gateway Protocol (BSSGP)' />
282 <param name='pcu' doc='GPRS Packet Control Unit (PCU)' />
283 <param name='lglobal' doc='Library-internal global log family' />
284 <param name='llapd' doc='LAPD in libosmogsm' />
285 <param name='linp' doc='A-bis Intput Subsystem' />
286 <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' />
287 <param name='lmi' doc='A-bis Input Driver for Signalling' />
288 <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' />
289 <param name='lsms' doc='Layer3 Short Message Service (SMS)' />
290 <param name='lctrl' doc='Control Interface' />
291 <param name='lgtp' doc='GPRS GTP library' />
292 <param name='lstats' doc='Statistics messages and logging' />
293 <param name='lgsup' doc='Generic Subscriber Update Protocol' />
294 <param name='loap' doc='Osmocom Authentication Protocol' />
295 <param name='lss7' doc='libosmo-sigtran Signalling System 7' />
296 <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' />
297 <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' />
298 <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' />
299 <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' />
300 <param name='ljibuf' doc='libosmo-netif Jitter Buffer' />
301 <param name='lrspro' doc='Remote SIM protocol' />
302 <param name='debug' doc='Log debug messages and higher levels' />
303 <param name='info' doc='Log informational messages and higher levels' />
304 <param name='notice' doc='Log noticeable messages and higher levels' />
305 <param name='error' doc='Log error messages and higher levels' />
306 <param name='fatal' doc='Log only fatal messages' />
307 <param name='.LOGMESSAGE' doc='Arbitrary message to log on given category and log level' />
308 </params>
309 </command>
Daniel Willmann79c6c4d2019-06-19 12:05:05 +0200310 <command id='show logging vty'>
311 <params>
312 <param name='show' doc='Show running system information' />
313 <param name='logging' doc='Show current logging configuration' />
314 <param name='vty' doc='Show current logging configuration for this vty' />
315 </params>
316 </command>
317 <command id='show alarms'>
318 <params>
319 <param name='show' doc='Show running system information' />
320 <param name='alarms' doc='Show current logging configuration' />
321 </params>
322 </command>
323 <command id='show stats'>
324 <params>
325 <param name='show' doc='Show running system information' />
326 <param name='stats' doc='Show statistical values' />
327 </params>
328 </command>
329 <command id='show stats level (global|peer|subscriber)'>
330 <params>
331 <param name='show' doc='Show running system information' />
332 <param name='stats' doc='Show statistical values' />
333 <param name='level' doc='Set the maximum group level' />
334 <param name='global' doc='Show global groups only' />
335 <param name='peer' doc='Show global and network peer related groups' />
336 <param name='subscriber' doc='Show global, peer, and subscriber groups' />
337 </params>
338 </command>
339 <command id='show asciidoc counters'>
340 <params>
341 <param name='show' doc='Show running system information' />
342 <param name='asciidoc' doc='Asciidoc generation' />
343 <param name='counters' doc='Generate table of all registered counters' />
344 </params>
345 </command>
346 <command id='show rate-counters'>
347 <params>
348 <param name='show' doc='Show running system information' />
349 <param name='rate-counters' doc='Show all rate counters' />
350 </params>
351 </command>
352 <command id='show bts statistics'>
353 <params>
354 <param name='show' doc='Show running system information' />
355 <param name='bts' doc='BTS related functionality' />
356 <param name='statistics' doc='Statistics' />
357 </params>
358 </command>
359 <command id='show tbf (all|ccch|pacch)'>
360 <params>
361 <param name='show' doc='Show running system information' />
362 <param name='tbf' doc='information about TBFs' />
363 <param name='all' doc='All TBFs' />
364 <param name='ccch' doc='TBFs allocated via CCCH' />
365 <param name='pacch' doc='TBFs allocated via PACCH' />
366 </params>
367 </command>
368 <command id='show ms all'>
369 <params>
370 <param name='show' doc='Show running system information' />
371 <param name='ms' doc='information about MSs' />
372 <param name='all' doc='All TBFs' />
373 </params>
374 </command>
375 <command id='show ms tlli TLLI'>
376 <params>
377 <param name='show' doc='Show running system information' />
378 <param name='ms' doc='information about MSs' />
379 <param name='tlli' doc='Select MS by TLLI' />
380 <param name='TLLI' doc='TLLI as hex' />
381 </params>
382 </command>
383 <command id='show ms imsi IMSI'>
384 <params>
385 <param name='show' doc='Show running system information' />
386 <param name='ms' doc='information about MSs' />
387 <param name='imsi' doc='Select MS by IMSI' />
388 <param name='IMSI' doc='IMSI' />
389 </params>
390 </command>
391 <command id='show ns'>
392 <params>
393 <param name='show' doc='Show running system information' />
394 <param name='ns' doc='Display information about the NS protocol' />
395 </params>
396 </command>
397 <command id='show ns stats'>
398 <params>
399 <param name='show' doc='Show running system information' />
400 <param name='ns' doc='Display information about the NS protocol' />
401 <param name='stats' doc='Include statistics' />
402 </params>
403 </command>
404 <command id='show ns persistent'>
405 <params>
406 <param name='show' doc='Show running system information' />
407 <param name='ns' doc='Display information about the NS protocol' />
408 <param name='persistent' doc='Show only persistent NS' />
409 </params>
410 </command>
411 <command id='show ns (nsei|nsvc) &lt;0-65535&gt; [stats]'>
412 <params>
413 <param name='show' doc='Show running system information' />
414 <param name='ns' doc='Display information about the NS protocol' />
415 <param name='nsei' doc='Select one NSE by its NSE Identifier' />
416 <param name='nsvc' doc='Select one NSE by its NS-VC Identifier' />
417 <param name='&lt;0-65535&gt;' doc='The Identifier of selected type' />
418 <param name='[stats]' doc='Include Statistics' />
419 </params>
420 </command>
421 <command id='logging filter nsvc (nsei|nsvci) &lt;0-65535&gt;'>
422 <params>
423 <param name='logging' doc='Configure logging' />
424 <param name='filter' doc='Filter log messages' />
425 <param name='nsvc' doc='Filter based on NS Virtual Connection' />
426 <param name='nsei' doc='Identify NS-VC by NSEI' />
427 <param name='nsvci' doc='Identify NS-VC by NSVCI' />
428 <param name='&lt;0-65535&gt;' doc='Numeric identifier' />
429 </params>
430 </command>
431 </node>
432 <node id='enable'>
433 <name>enable</name>
434 <command id='disable'>
435 <params>
436 <param name='disable' doc='Turn off privileged mode command' />
437 </params>
438 </command>
439 <command id='configure terminal'>
440 <params>
441 <param name='configure' doc='Configuration from vty interface' />
442 <param name='terminal' doc='Configuration terminal' />
443 </params>
444 </command>
445 <command id='copy running-config startup-config'>
446 <params>
447 <param name='copy' doc='Copy configuration' />
448 <param name='running-config' doc='Copy running config to... ' />
449 <param name='startup-config' doc='Copy running config to startup config (same as write file)' />
450 </params>
451 </command>
452 <command id='show startup-config'>
453 <params>
454 <param name='show' doc='Show running system information' />
455 <param name='startup-config' doc='Contentes of startup configuration' />
456 </params>
457 </command>
458 <command id='show version'>
459 <params>
460 <param name='show' doc='Show running system information' />
461 <param name='version' doc='Displays program version' />
462 </params>
463 </command>
464 <command id='show online-help'>
465 <params>
466 <param name='show' doc='Show running system information' />
467 <param name='online-help' doc='Online help' />
468 </params>
469 </command>
470 <command id='terminal length &lt;0-512&gt;'>
471 <params>
472 <param name='terminal' doc='Set terminal line parameters' />
473 <param name='length' doc='Set number of lines on a screen' />
474 <param name='&lt;0-512&gt;' doc='Number of lines on screen (0 for no pausing)' />
475 </params>
476 </command>
477 <command id='terminal no length'>
478 <params>
479 <param name='terminal' doc='Set terminal line parameters' />
480 <param name='no' doc='Negate a command or set its defaults' />
481 <param name='length' doc='Set number of lines on a screen' />
482 </params>
483 </command>
484 <command id='who'>
485 <params>
486 <param name='who' doc='Display who is on vty' />
487 </params>
488 </command>
489 <command id='show history'>
490 <params>
491 <param name='show' doc='Show running system information' />
492 <param name='history' doc='Display the session command history' />
493 </params>
494 </command>
495 <command id='terminal monitor'>
496 <params>
497 <param name='terminal' doc='Set terminal line parameters' />
498 <param name='monitor' doc='Copy debug output to the current terminal line' />
499 </params>
500 </command>
501 <command id='terminal no monitor'>
502 <params>
503 <param name='terminal' doc='Set terminal line parameters' />
504 <param name='no' doc='Negate a command or set its defaults' />
505 <param name='monitor' doc='Copy debug output to the current terminal line' />
506 </params>
507 </command>
508 <command id='logging enable'>
509 <params>
510 <param name='logging' doc='Configure logging' />
511 <param name='enable' doc='Enables logging to this vty' />
512 </params>
513 </command>
514 <command id='logging disable'>
515 <params>
516 <param name='logging' doc='Configure logging' />
517 <param name='disable' doc='Disables logging to this vty' />
518 </params>
519 </command>
520 <command id='logging filter all (0|1)'>
521 <params>
522 <param name='logging' doc='Configure logging' />
523 <param name='filter' doc='Filter log messages' />
524 <param name='all' doc='Do you want to log all messages?' />
525 <param name='0' doc='Only print messages matched by other filters' />
526 <param name='1' doc='Bypass filter and print all messages' />
527 </params>
528 </command>
529 <command id='logging color (0|1)'>
530 <params>
531 <param name='logging' doc='Configure logging' />
532 <param name='color' doc='Configure color-printing for log messages' />
533 <param name='0' doc='Don&apos;t use color for printing messages' />
534 <param name='1' doc='Use color for printing messages' />
535 </params>
536 </command>
537 <command id='logging timestamp (0|1)'>
538 <params>
539 <param name='logging' doc='Configure logging' />
540 <param name='timestamp' doc='Configure log message timestamping' />
541 <param name='0' doc='Don&apos;t prefix each log message' />
542 <param name='1' doc='Prefix each log message with current timestamp' />
543 </params>
544 </command>
545 <command id='logging print extended-timestamp (0|1)'>
546 <params>
547 <param name='logging' doc='Configure logging' />
548 <param name='print' doc='Log output settings' />
549 <param name='extended-timestamp' doc='Configure log message timestamping' />
550 <param name='0' doc='Don&apos;t prefix each log message' />
551 <param name='1' doc='Prefix each log message with current timestamp with YYYYMMDDhhmmssnnn' />
552 </params>
553 </command>
554 <command id='logging print category (0|1)'>
555 <params>
556 <param name='logging' doc='Configure logging' />
557 <param name='print' doc='Log output settings' />
558 <param name='category' doc='Configure log message' />
559 <param name='0' doc='Don&apos;t prefix each log message' />
560 <param name='1' doc='Prefix each log message with category/subsystem name' />
561 </params>
562 </command>
563 <command id='logging print category-hex (0|1)'>
564 <params>
565 <param name='logging' doc='Configure logging' />
566 <param name='print' doc='Log output settings' />
567 <param name='category-hex' doc='Configure log message' />
568 <param name='0' doc='Don&apos;t prefix each log message' />
569 <param name='1' doc='Prefix each log message with category/subsystem nr in hex (&apos;&lt;000b&gt;&apos;)' />
570 </params>
571 </command>
572 <command id='logging print level (0|1)'>
573 <params>
574 <param name='logging' doc='Configure logging' />
575 <param name='print' doc='Log output settings' />
576 <param name='level' doc='Configure log message' />
577 <param name='0' doc='Don&apos;t prefix each log message' />
578 <param name='1' doc='Prefix each log message with the log level name' />
579 </params>
580 </command>
581 <command id='logging print file (0|1|basename) [last]'>
582 <params>
583 <param name='logging' doc='Configure logging' />
584 <param name='print' doc='Log output settings' />
585 <param name='file' doc='Configure log message' />
586 <param name='0' doc='Don&apos;t prefix each log message' />
587 <param name='1' doc='Prefix each log message with the source file and line' />
588 <param name='basename' doc='Prefix each log message with the source file&apos;s basename (strip leading paths) and line' />
589 <param name='[last]' doc='Log source file info at the end of a log line. If omitted, log source file info just before the log text.' />
590 </params>
591 </command>
592 <command id='logging set-log-mask MASK'>
593 <params>
594 <param name='logging' doc='Configure logging' />
595 <param name='set-log-mask' doc='Set the logmask of this logging target' />
596 <param name='MASK' doc='List of logging categories to log, e.g. &apos;abc:mno:xyz&apos;. Available log categories depend on the specific application, refer to the &apos;logging level&apos; command. Optionally add individual log levels like &apos;abc,1:mno,3:xyz,5&apos;, where the level numbers are LOGL_DEBUG=1 LOGL_INFO=3 LOGL_NOTICE=5 LOGL_ERROR=7 LOGL_FATAL=8' />
597 </params>
598 </command>
599 <command id='logging level (csn1|l1if|rlcmac|rlcmacdata|rlcmacdl|rlcmacul|rlcmacsched|rlcmacmeas|tbf|tbfdl|tbful|ns|bssgp|pcu|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro) (debug|info|notice|error|fatal)'>
600 <params>
601 <param name='logging' doc='Configure logging' />
602 <param name='level' doc='Set the log level for a specified category' />
603 <param name='csn1' doc='Concrete Syntax Notation One (CSN1)' />
604 <param name='l1if' doc='GPRS PCU L1 interface (L1IF)' />
605 <param name='rlcmac' doc='GPRS RLC/MAC layer (RLCMAC)' />
606 <param name='rlcmacdata' doc='GPRS RLC/MAC layer Data (RLCMAC)' />
607 <param name='rlcmacdl' doc='GPRS RLC/MAC layer Downlink (RLCMAC)' />
608 <param name='rlcmacul' doc='GPRS RLC/MAC layer Uplink (RLCMAC)' />
609 <param name='rlcmacsched' doc='GPRS RLC/MAC layer Scheduling (RLCMAC)' />
610 <param name='rlcmacmeas' doc='GPRS RLC/MAC layer Measurements (RLCMAC)' />
611 <param name='tbf' doc='Temporary Block Flow (TBF)' />
612 <param name='tbfdl' doc='Temporary Block Flow (TBF) Downlink' />
613 <param name='tbful' doc='Temporary Block Flow (TBF) Uplink' />
614 <param name='ns' doc='GPRS Network Service Protocol (NS)' />
615 <param name='bssgp' doc='GPRS BSS Gateway Protocol (BSSGP)' />
616 <param name='pcu' doc='GPRS Packet Control Unit (PCU)' />
617 <param name='lglobal' doc='Library-internal global log family' />
618 <param name='llapd' doc='LAPD in libosmogsm' />
619 <param name='linp' doc='A-bis Intput Subsystem' />
620 <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' />
621 <param name='lmi' doc='A-bis Input Driver for Signalling' />
622 <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' />
623 <param name='lsms' doc='Layer3 Short Message Service (SMS)' />
624 <param name='lctrl' doc='Control Interface' />
625 <param name='lgtp' doc='GPRS GTP library' />
626 <param name='lstats' doc='Statistics messages and logging' />
627 <param name='lgsup' doc='Generic Subscriber Update Protocol' />
628 <param name='loap' doc='Osmocom Authentication Protocol' />
629 <param name='lss7' doc='libosmo-sigtran Signalling System 7' />
630 <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' />
631 <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' />
632 <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' />
633 <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' />
634 <param name='ljibuf' doc='libosmo-netif Jitter Buffer' />
635 <param name='lrspro' doc='Remote SIM protocol' />
636 <param name='debug' doc='Log debug messages and higher levels' />
637 <param name='info' doc='Log informational messages and higher levels' />
638 <param name='notice' doc='Log noticeable messages and higher levels' />
639 <param name='error' doc='Log error messages and higher levels' />
640 <param name='fatal' doc='Log only fatal messages' />
641 </params>
642 </command>
643 <command id='logging level set-all (debug|info|notice|error|fatal)'>
644 <params>
645 <param name='logging' doc='Configure logging' />
646 <param name='level' doc='Set the log level for a specified category' />
647 <param name='set-all' doc='Once-off set all categories to the given log level. There is no single command to take back these changes -- each category is set to the given level, period.' />
648 <param name='debug' doc='Log debug messages and higher levels' />
649 <param name='info' doc='Log informational messages and higher levels' />
650 <param name='notice' doc='Log noticeable messages and higher levels' />
651 <param name='error' doc='Log error messages and higher levels' />
652 <param name='fatal' doc='Log only fatal messages' />
653 </params>
654 </command>
655 <command id='logging level force-all (debug|info|notice|error|fatal)'>
656 <params>
657 <param name='logging' doc='Configure logging' />
658 <param name='level' doc='Set the log level for a specified category' />
659 <param name='force-all' doc='Globally force all logging categories to a specific level. This is released by the &apos;no logging level force-all&apos; command. Note: any &apos;logging level &lt;category&gt; &lt;level&gt;&apos; commands will have no visible effect after this, until the forced level is released.' />
660 <param name='debug' doc='Log debug messages and higher levels' />
661 <param name='info' doc='Log informational messages and higher levels' />
662 <param name='notice' doc='Log noticeable messages and higher levels' />
663 <param name='error' doc='Log error messages and higher levels' />
664 <param name='fatal' doc='Log only fatal messages' />
665 </params>
666 </command>
667 <command id='no logging level force-all'>
668 <params>
669 <param name='no' doc='Negate a command or set its defaults' />
670 <param name='logging' doc='Configure logging' />
671 <param name='level' doc='Set the log level for a specified category' />
672 <param name='force-all' doc='Release any globally forced log level set with &apos;logging level force-all &lt;level&gt;&apos;' />
673 </params>
674 </command>
Oliver Smith37ae22a2019-09-05 15:35:43 +0200675 <command id='logp (csn1|l1if|rlcmac|rlcmacdata|rlcmacdl|rlcmacul|rlcmacsched|rlcmacmeas|tbf|tbfdl|tbful|ns|bssgp|pcu|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro) (debug|info|notice|error|fatal) .LOGMESSAGE'>
676 <params>
677 <param name='logp' doc='Print a message on all log outputs; useful for placing markers in test logs' />
678 <param name='csn1' doc='Concrete Syntax Notation One (CSN1)' />
679 <param name='l1if' doc='GPRS PCU L1 interface (L1IF)' />
680 <param name='rlcmac' doc='GPRS RLC/MAC layer (RLCMAC)' />
681 <param name='rlcmacdata' doc='GPRS RLC/MAC layer Data (RLCMAC)' />
682 <param name='rlcmacdl' doc='GPRS RLC/MAC layer Downlink (RLCMAC)' />
683 <param name='rlcmacul' doc='GPRS RLC/MAC layer Uplink (RLCMAC)' />
684 <param name='rlcmacsched' doc='GPRS RLC/MAC layer Scheduling (RLCMAC)' />
685 <param name='rlcmacmeas' doc='GPRS RLC/MAC layer Measurements (RLCMAC)' />
686 <param name='tbf' doc='Temporary Block Flow (TBF)' />
687 <param name='tbfdl' doc='Temporary Block Flow (TBF) Downlink' />
688 <param name='tbful' doc='Temporary Block Flow (TBF) Uplink' />
689 <param name='ns' doc='GPRS Network Service Protocol (NS)' />
690 <param name='bssgp' doc='GPRS BSS Gateway Protocol (BSSGP)' />
691 <param name='pcu' doc='GPRS Packet Control Unit (PCU)' />
692 <param name='lglobal' doc='Library-internal global log family' />
693 <param name='llapd' doc='LAPD in libosmogsm' />
694 <param name='linp' doc='A-bis Intput Subsystem' />
695 <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' />
696 <param name='lmi' doc='A-bis Input Driver for Signalling' />
697 <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' />
698 <param name='lsms' doc='Layer3 Short Message Service (SMS)' />
699 <param name='lctrl' doc='Control Interface' />
700 <param name='lgtp' doc='GPRS GTP library' />
701 <param name='lstats' doc='Statistics messages and logging' />
702 <param name='lgsup' doc='Generic Subscriber Update Protocol' />
703 <param name='loap' doc='Osmocom Authentication Protocol' />
704 <param name='lss7' doc='libosmo-sigtran Signalling System 7' />
705 <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' />
706 <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' />
707 <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' />
708 <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' />
709 <param name='ljibuf' doc='libosmo-netif Jitter Buffer' />
710 <param name='lrspro' doc='Remote SIM protocol' />
711 <param name='debug' doc='Log debug messages and higher levels' />
712 <param name='info' doc='Log informational messages and higher levels' />
713 <param name='notice' doc='Log noticeable messages and higher levels' />
714 <param name='error' doc='Log error messages and higher levels' />
715 <param name='fatal' doc='Log only fatal messages' />
716 <param name='.LOGMESSAGE' doc='Arbitrary message to log on given category and log level' />
717 </params>
718 </command>
Daniel Willmann79c6c4d2019-06-19 12:05:05 +0200719 <command id='show logging vty'>
720 <params>
721 <param name='show' doc='Show running system information' />
722 <param name='logging' doc='Show current logging configuration' />
723 <param name='vty' doc='Show current logging configuration for this vty' />
724 </params>
725 </command>
726 <command id='show alarms'>
727 <params>
728 <param name='show' doc='Show running system information' />
729 <param name='alarms' doc='Show current logging configuration' />
730 </params>
731 </command>
732 <command id='show stats'>
733 <params>
734 <param name='show' doc='Show running system information' />
735 <param name='stats' doc='Show statistical values' />
736 </params>
737 </command>
738 <command id='show stats level (global|peer|subscriber)'>
739 <params>
740 <param name='show' doc='Show running system information' />
741 <param name='stats' doc='Show statistical values' />
742 <param name='level' doc='Set the maximum group level' />
743 <param name='global' doc='Show global groups only' />
744 <param name='peer' doc='Show global and network peer related groups' />
745 <param name='subscriber' doc='Show global, peer, and subscriber groups' />
746 </params>
747 </command>
748 <command id='show asciidoc counters'>
749 <params>
750 <param name='show' doc='Show running system information' />
751 <param name='asciidoc' doc='Asciidoc generation' />
752 <param name='counters' doc='Generate table of all registered counters' />
753 </params>
754 </command>
755 <command id='show rate-counters'>
756 <params>
757 <param name='show' doc='Show running system information' />
758 <param name='rate-counters' doc='Show all rate counters' />
759 </params>
760 </command>
761 <command id='show bts statistics'>
762 <params>
763 <param name='show' doc='Show running system information' />
764 <param name='bts' doc='BTS related functionality' />
765 <param name='statistics' doc='Statistics' />
766 </params>
767 </command>
768 <command id='show tbf (all|ccch|pacch)'>
769 <params>
770 <param name='show' doc='Show running system information' />
771 <param name='tbf' doc='information about TBFs' />
772 <param name='all' doc='All TBFs' />
773 <param name='ccch' doc='TBFs allocated via CCCH' />
774 <param name='pacch' doc='TBFs allocated via PACCH' />
775 </params>
776 </command>
777 <command id='show ms all'>
778 <params>
779 <param name='show' doc='Show running system information' />
780 <param name='ms' doc='information about MSs' />
781 <param name='all' doc='All TBFs' />
782 </params>
783 </command>
784 <command id='show ms tlli TLLI'>
785 <params>
786 <param name='show' doc='Show running system information' />
787 <param name='ms' doc='information about MSs' />
788 <param name='tlli' doc='Select MS by TLLI' />
789 <param name='TLLI' doc='TLLI as hex' />
790 </params>
791 </command>
792 <command id='show ms imsi IMSI'>
793 <params>
794 <param name='show' doc='Show running system information' />
795 <param name='ms' doc='information about MSs' />
796 <param name='imsi' doc='Select MS by IMSI' />
797 <param name='IMSI' doc='IMSI' />
798 </params>
799 </command>
800 <command id='show ns'>
801 <params>
802 <param name='show' doc='Show running system information' />
803 <param name='ns' doc='Display information about the NS protocol' />
804 </params>
805 </command>
806 <command id='show ns stats'>
807 <params>
808 <param name='show' doc='Show running system information' />
809 <param name='ns' doc='Display information about the NS protocol' />
810 <param name='stats' doc='Include statistics' />
811 </params>
812 </command>
813 <command id='show ns persistent'>
814 <params>
815 <param name='show' doc='Show running system information' />
816 <param name='ns' doc='Display information about the NS protocol' />
817 <param name='persistent' doc='Show only persistent NS' />
818 </params>
819 </command>
820 <command id='show ns (nsei|nsvc) &lt;0-65535&gt; [stats]'>
821 <params>
822 <param name='show' doc='Show running system information' />
823 <param name='ns' doc='Display information about the NS protocol' />
824 <param name='nsei' doc='Select one NSE by its NSE Identifier' />
825 <param name='nsvc' doc='Select one NSE by its NS-VC Identifier' />
826 <param name='&lt;0-65535&gt;' doc='The Identifier of selected type' />
827 <param name='[stats]' doc='Include Statistics' />
828 </params>
829 </command>
830 <command id='logging filter nsvc (nsei|nsvci) &lt;0-65535&gt;'>
831 <params>
832 <param name='logging' doc='Configure logging' />
833 <param name='filter' doc='Filter log messages' />
834 <param name='nsvc' doc='Filter based on NS Virtual Connection' />
835 <param name='nsei' doc='Identify NS-VC by NSEI' />
836 <param name='nsvci' doc='Identify NS-VC by NSVCI' />
837 <param name='&lt;0-65535&gt;' doc='Numeric identifier' />
838 </params>
839 </command>
840 <command id='nsvc (nsei|nsvci) &lt;0-65535&gt; (block|unblock|reset)'>
841 <params>
842 <param name='nsvc' doc='Perform an operation on a NSVC' />
843 <param name='nsei' doc='NSEI to identify NS-VC Identifier (NS-VCI)' />
844 <param name='nsvci' doc='NS-VC Identifier (NS-VCI)' />
845 <param name='&lt;0-65535&gt;' doc='The NSEI' />
846 <param name='block' doc='Initiate BLOCK procedure' />
847 <param name='unblock' doc='Initiate UNBLOCK procedure' />
848 <param name='reset' doc='Initiate RESET procedure' />
849 </params>
850 </command>
851 </node>
852 <node id='config'>
853 <name>config</name>
854 <command id='hostname WORD'>
855 <params>
856 <param name='hostname' doc='Set system&apos;s network name' />
857 <param name='WORD' doc='This system&apos;s network name' />
858 </params>
859 </command>
860 <command id='no hostname [HOSTNAME]'>
861 <params>
862 <param name='no' doc='Negate a command or set its defaults' />
863 <param name='hostname' doc='Reset system&apos;s network name' />
864 <param name='[HOSTNAME]' doc='Host name of this router' />
865 </params>
866 </command>
867 <command id='password (8|) WORD'>
868 <params>
869 <param name='password' doc='Assign the terminal connection password' />
870 <param name='8' doc='Specifies a HIDDEN password will follow' />
871 <param name='' doc='dummy string ' />
872 <param name='WORD' doc='The HIDDEN line password string' />
873 </params>
874 </command>
875 <command id='password LINE'>
876 <params>
877 <param name='password' doc='Assign the terminal connection password' />
878 <param name='LINE' doc='The UNENCRYPTED (cleartext) line password' />
879 </params>
880 </command>
881 <command id='enable password (8|) WORD'>
882 <params>
883 <param name='enable' doc='Modify enable password parameters' />
884 <param name='password' doc='Assign the privileged level password' />
885 <param name='8' doc='Specifies a HIDDEN password will follow' />
886 <param name='' doc='dummy string ' />
887 <param name='WORD' doc='The HIDDEN &apos;enable&apos; password string' />
888 </params>
889 </command>
890 <command id='enable password LINE'>
891 <params>
892 <param name='enable' doc='Modify enable password parameters' />
893 <param name='password' doc='Assign the privileged level password' />
894 <param name='LINE' doc='The UNENCRYPTED (cleartext) &apos;enable&apos; password' />
895 </params>
896 </command>
897 <command id='no enable password'>
898 <params>
899 <param name='no' doc='Negate a command or set its defaults' />
900 <param name='enable' doc='Modify enable password parameters' />
901 <param name='password' doc='Assign the privileged level password' />
902 </params>
903 </command>
904 <command id='banner motd default'>
905 <params>
906 <param name='banner' doc='Set banner string' />
907 <param name='motd' doc='Strings for motd' />
908 <param name='default' doc='Default string' />
909 </params>
910 </command>
911 <command id='banner motd file [FILE]'>
912 <params>
913 <param name='banner' doc='Set banner' />
914 <param name='motd' doc='Banner for motd' />
915 <param name='file' doc='Banner from a file' />
916 <param name='[FILE]' doc='Filename' />
917 </params>
918 </command>
919 <command id='no banner motd'>
920 <params>
921 <param name='no' doc='Negate a command or set its defaults' />
922 <param name='banner' doc='Set banner string' />
923 <param name='motd' doc='Strings for motd' />
924 </params>
925 </command>
926 <command id='service terminal-length &lt;0-512&gt;'>
927 <params>
928 <param name='service' doc='Set up miscellaneous service' />
929 <param name='terminal-length' doc='System wide terminal length configuration' />
930 <param name='&lt;0-512&gt;' doc='Number of lines of VTY (0 means no line control)' />
931 </params>
932 </command>
933 <command id='no service terminal-length [&lt;0-512&gt;]'>
934 <params>
935 <param name='no' doc='Negate a command or set its defaults' />
936 <param name='service' doc='Set up miscellaneous service' />
937 <param name='terminal-length' doc='System wide terminal length configuration' />
938 <param name='[&lt;0-512&gt;]' doc='Number of lines of VTY (0 means no line control)' />
939 </params>
940 </command>
941 <command id='line vty'>
942 <params>
943 <param name='line' doc='Configure a terminal line' />
944 <param name='vty' doc='Virtual terminal' />
945 </params>
946 </command>
947 <command id='service advanced-vty'>
948 <params>
949 <param name='service' doc='Set up miscellaneous service' />
950 <param name='advanced-vty' doc='Enable advanced mode vty interface' />
951 </params>
952 </command>
953 <command id='no service advanced-vty'>
954 <params>
955 <param name='no' doc='Negate a command or set its defaults' />
956 <param name='service' doc='Set up miscellaneous service' />
957 <param name='advanced-vty' doc='Enable advanced mode vty interface' />
958 </params>
959 </command>
960 <command id='show history'>
961 <params>
962 <param name='show' doc='Show running system information' />
963 <param name='history' doc='Display the session command history' />
964 </params>
965 </command>
966 <command id='log stderr'>
967 <params>
968 <param name='log' doc='Configure logging sub-system' />
969 <param name='stderr' doc='Logging via STDERR of the process' />
970 </params>
971 </command>
972 <command id='no log stderr'>
973 <params>
974 <param name='no' doc='Negate a command or set its defaults' />
975 <param name='log' doc='Configure logging sub-system' />
976 <param name='stderr' doc='Logging via STDERR of the process' />
977 </params>
978 </command>
979 <command id='log file .FILENAME'>
980 <params>
981 <param name='log' doc='Configure logging sub-system' />
982 <param name='file' doc='Logging to text file' />
983 <param name='.FILENAME' doc='Filename' />
984 </params>
985 </command>
986 <command id='no log file .FILENAME'>
987 <params>
988 <param name='no' doc='Negate a command or set its defaults' />
989 <param name='log' doc='Configure logging sub-system' />
990 <param name='file' doc='Logging to text file' />
991 <param name='.FILENAME' doc='Filename' />
992 </params>
993 </command>
994 <command id='log alarms &lt;2-32700&gt;'>
995 <params>
996 <param name='log' doc='Configure logging sub-system' />
997 <param name='alarms' doc='Logging alarms to osmo_strrb' />
998 <param name='&lt;2-32700&gt;' doc='Maximum number of messages to log' />
999 </params>
1000 </command>
1001 <command id='no log alarms'>
1002 <params>
1003 <param name='no' doc='Negate a command or set its defaults' />
1004 <param name='log' doc='Configure logging sub-system' />
1005 <param name='alarms' doc='Logging alarms to osmo_strrb' />
1006 </params>
1007 </command>
1008 <command id='log syslog (authpriv|cron|daemon|ftp|lpr|mail|news|user|uucp)'>
1009 <params>
1010 <param name='log' doc='Configure logging sub-system' />
1011 <param name='syslog' doc='Logging via syslog' />
1012 <param name='authpriv' doc='Security/authorization messages facility' />
1013 <param name='cron' doc='Clock daemon (cron/at) facility' />
1014 <param name='daemon' doc='General system daemon facility' />
1015 <param name='ftp' doc='Ftp daemon facility' />
1016 <param name='lpr' doc='Line printer facility' />
1017 <param name='mail' doc='Mail facility' />
1018 <param name='news' doc='News facility' />
1019 <param name='user' doc='Generic facility' />
1020 <param name='uucp' doc='UUCP facility' />
1021 </params>
1022 </command>
1023 <command id='log syslog local &lt;0-7&gt;'>
1024 <params>
1025 <param name='log' doc='Configure logging sub-system' />
1026 <param name='syslog' doc='Logging via syslog' />
1027 <param name='local' doc='Syslog LOCAL facility' />
1028 <param name='&lt;0-7&gt;' doc='Local facility number' />
1029 </params>
1030 </command>
1031 <command id='no log syslog'>
1032 <params>
1033 <param name='no' doc='Negate a command or set its defaults' />
1034 <param name='log' doc='Configure logging sub-system' />
1035 <param name='syslog' doc='Logging via syslog' />
1036 </params>
1037 </command>
1038 <command id='log gsmtap [HOSTNAME]'>
1039 <params>
1040 <param name='log' doc='Configure logging sub-system' />
1041 <param name='gsmtap' doc='Logging via GSMTAP' />
1042 <param name='[HOSTNAME]' doc='Host name to send the GSMTAP logging to (UDP port 4729)' />
1043 </params>
1044 </command>
1045 <command id='stats reporter statsd'>
1046 <params>
1047 <param name='stats' doc='Configure stats sub-system' />
1048 <param name='reporter' doc='Configure a stats reporter' />
1049 <param name='statsd' doc='Report to a STATSD server' />
1050 </params>
1051 </command>
1052 <command id='no stats reporter statsd'>
1053 <params>
1054 <param name='no' doc='Negate a command or set its defaults' />
1055 <param name='stats' doc='Configure stats sub-system' />
1056 <param name='reporter' doc='Configure a stats reporter' />
1057 <param name='statsd' doc='Report to a STATSD server' />
1058 </params>
1059 </command>
1060 <command id='stats reporter log'>
1061 <params>
1062 <param name='stats' doc='Configure stats sub-system' />
1063 <param name='reporter' doc='Configure a stats reporter' />
1064 <param name='log' doc='Report to the logger' />
1065 </params>
1066 </command>
1067 <command id='no stats reporter log'>
1068 <params>
1069 <param name='no' doc='Negate a command or set its defaults' />
1070 <param name='stats' doc='Configure stats sub-system' />
1071 <param name='reporter' doc='Configure a stats reporter' />
1072 <param name='log' doc='Report to the logger' />
1073 </params>
1074 </command>
1075 <command id='stats interval &lt;1-65535&gt;'>
1076 <params>
1077 <param name='stats' doc='Configure stats sub-system' />
1078 <param name='interval' doc='Set the reporting interval' />
1079 <param name='&lt;1-65535&gt;' doc='Interval in seconds' />
1080 </params>
1081 </command>
1082 <command id='pcu'>
1083 <params>
1084 <param name='pcu' doc='BTS specific configure' />
1085 </params>
1086 </command>
1087 <command id='ns'>
1088 <params>
1089 <param name='ns' doc='Configure the GPRS Network Service' />
1090 </params>
1091 </command>
1092 </node>
1093 <node id='config-log'>
1094 <name>config-log</name>
1095 <command id='logging filter all (0|1)'>
1096 <params>
1097 <param name='logging' doc='Configure logging' />
1098 <param name='filter' doc='Filter log messages' />
1099 <param name='all' doc='Do you want to log all messages?' />
1100 <param name='0' doc='Only print messages matched by other filters' />
1101 <param name='1' doc='Bypass filter and print all messages' />
1102 </params>
1103 </command>
1104 <command id='logging color (0|1)'>
1105 <params>
1106 <param name='logging' doc='Configure logging' />
1107 <param name='color' doc='Configure color-printing for log messages' />
1108 <param name='0' doc='Don&apos;t use color for printing messages' />
1109 <param name='1' doc='Use color for printing messages' />
1110 </params>
1111 </command>
1112 <command id='logging timestamp (0|1)'>
1113 <params>
1114 <param name='logging' doc='Configure logging' />
1115 <param name='timestamp' doc='Configure log message timestamping' />
1116 <param name='0' doc='Don&apos;t prefix each log message' />
1117 <param name='1' doc='Prefix each log message with current timestamp' />
1118 </params>
1119 </command>
1120 <command id='logging print extended-timestamp (0|1)'>
1121 <params>
1122 <param name='logging' doc='Configure logging' />
1123 <param name='print' doc='Log output settings' />
1124 <param name='extended-timestamp' doc='Configure log message timestamping' />
1125 <param name='0' doc='Don&apos;t prefix each log message' />
1126 <param name='1' doc='Prefix each log message with current timestamp with YYYYMMDDhhmmssnnn' />
1127 </params>
1128 </command>
1129 <command id='logging print category (0|1)'>
1130 <params>
1131 <param name='logging' doc='Configure logging' />
1132 <param name='print' doc='Log output settings' />
1133 <param name='category' doc='Configure log message' />
1134 <param name='0' doc='Don&apos;t prefix each log message' />
1135 <param name='1' doc='Prefix each log message with category/subsystem name' />
1136 </params>
1137 </command>
1138 <command id='logging print category-hex (0|1)'>
1139 <params>
1140 <param name='logging' doc='Configure logging' />
1141 <param name='print' doc='Log output settings' />
1142 <param name='category-hex' doc='Configure log message' />
1143 <param name='0' doc='Don&apos;t prefix each log message' />
1144 <param name='1' doc='Prefix each log message with category/subsystem nr in hex (&apos;&lt;000b&gt;&apos;)' />
1145 </params>
1146 </command>
1147 <command id='logging print level (0|1)'>
1148 <params>
1149 <param name='logging' doc='Configure logging' />
1150 <param name='print' doc='Log output settings' />
1151 <param name='level' doc='Configure log message' />
1152 <param name='0' doc='Don&apos;t prefix each log message' />
1153 <param name='1' doc='Prefix each log message with the log level name' />
1154 </params>
1155 </command>
1156 <command id='logging print file (0|1|basename) [last]'>
1157 <params>
1158 <param name='logging' doc='Configure logging' />
1159 <param name='print' doc='Log output settings' />
1160 <param name='file' doc='Configure log message' />
1161 <param name='0' doc='Don&apos;t prefix each log message' />
1162 <param name='1' doc='Prefix each log message with the source file and line' />
1163 <param name='basename' doc='Prefix each log message with the source file&apos;s basename (strip leading paths) and line' />
1164 <param name='[last]' doc='Log source file info at the end of a log line. If omitted, log source file info just before the log text.' />
1165 </params>
1166 </command>
1167 <command id='logging level (csn1|l1if|rlcmac|rlcmacdata|rlcmacdl|rlcmacul|rlcmacsched|rlcmacmeas|tbf|tbfdl|tbful|ns|bssgp|pcu|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro) (debug|info|notice|error|fatal)'>
1168 <params>
1169 <param name='logging' doc='Configure logging' />
1170 <param name='level' doc='Set the log level for a specified category' />
1171 <param name='csn1' doc='Concrete Syntax Notation One (CSN1)' />
1172 <param name='l1if' doc='GPRS PCU L1 interface (L1IF)' />
1173 <param name='rlcmac' doc='GPRS RLC/MAC layer (RLCMAC)' />
1174 <param name='rlcmacdata' doc='GPRS RLC/MAC layer Data (RLCMAC)' />
1175 <param name='rlcmacdl' doc='GPRS RLC/MAC layer Downlink (RLCMAC)' />
1176 <param name='rlcmacul' doc='GPRS RLC/MAC layer Uplink (RLCMAC)' />
1177 <param name='rlcmacsched' doc='GPRS RLC/MAC layer Scheduling (RLCMAC)' />
1178 <param name='rlcmacmeas' doc='GPRS RLC/MAC layer Measurements (RLCMAC)' />
1179 <param name='tbf' doc='Temporary Block Flow (TBF)' />
1180 <param name='tbfdl' doc='Temporary Block Flow (TBF) Downlink' />
1181 <param name='tbful' doc='Temporary Block Flow (TBF) Uplink' />
1182 <param name='ns' doc='GPRS Network Service Protocol (NS)' />
1183 <param name='bssgp' doc='GPRS BSS Gateway Protocol (BSSGP)' />
1184 <param name='pcu' doc='GPRS Packet Control Unit (PCU)' />
1185 <param name='lglobal' doc='Library-internal global log family' />
1186 <param name='llapd' doc='LAPD in libosmogsm' />
1187 <param name='linp' doc='A-bis Intput Subsystem' />
1188 <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' />
1189 <param name='lmi' doc='A-bis Input Driver for Signalling' />
1190 <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' />
1191 <param name='lsms' doc='Layer3 Short Message Service (SMS)' />
1192 <param name='lctrl' doc='Control Interface' />
1193 <param name='lgtp' doc='GPRS GTP library' />
1194 <param name='lstats' doc='Statistics messages and logging' />
1195 <param name='lgsup' doc='Generic Subscriber Update Protocol' />
1196 <param name='loap' doc='Osmocom Authentication Protocol' />
1197 <param name='lss7' doc='libosmo-sigtran Signalling System 7' />
1198 <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' />
1199 <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' />
1200 <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' />
1201 <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' />
1202 <param name='ljibuf' doc='libosmo-netif Jitter Buffer' />
1203 <param name='lrspro' doc='Remote SIM protocol' />
1204 <param name='debug' doc='Log debug messages and higher levels' />
1205 <param name='info' doc='Log informational messages and higher levels' />
1206 <param name='notice' doc='Log noticeable messages and higher levels' />
1207 <param name='error' doc='Log error messages and higher levels' />
1208 <param name='fatal' doc='Log only fatal messages' />
1209 </params>
1210 </command>
1211 <command id='logging level set-all (debug|info|notice|error|fatal)'>
1212 <params>
1213 <param name='logging' doc='Configure logging' />
1214 <param name='level' doc='Set the log level for a specified category' />
1215 <param name='set-all' doc='Once-off set all categories to the given log level. There is no single command to take back these changes -- each category is set to the given level, period.' />
1216 <param name='debug' doc='Log debug messages and higher levels' />
1217 <param name='info' doc='Log informational messages and higher levels' />
1218 <param name='notice' doc='Log noticeable messages and higher levels' />
1219 <param name='error' doc='Log error messages and higher levels' />
1220 <param name='fatal' doc='Log only fatal messages' />
1221 </params>
1222 </command>
1223 <command id='logging level force-all (debug|info|notice|error|fatal)'>
1224 <params>
1225 <param name='logging' doc='Configure logging' />
1226 <param name='level' doc='Set the log level for a specified category' />
1227 <param name='force-all' doc='Globally force all logging categories to a specific level. This is released by the &apos;no logging level force-all&apos; command. Note: any &apos;logging level &lt;category&gt; &lt;level&gt;&apos; commands will have no visible effect after this, until the forced level is released.' />
1228 <param name='debug' doc='Log debug messages and higher levels' />
1229 <param name='info' doc='Log informational messages and higher levels' />
1230 <param name='notice' doc='Log noticeable messages and higher levels' />
1231 <param name='error' doc='Log error messages and higher levels' />
1232 <param name='fatal' doc='Log only fatal messages' />
1233 </params>
1234 </command>
1235 <command id='no logging level force-all'>
1236 <params>
1237 <param name='no' doc='Negate a command or set its defaults' />
1238 <param name='logging' doc='Configure logging' />
1239 <param name='level' doc='Set the log level for a specified category' />
1240 <param name='force-all' doc='Release any globally forced log level set with &apos;logging level force-all &lt;level&gt;&apos;' />
1241 </params>
1242 </command>
1243 <command id='logging filter nsvc (nsei|nsvci) &lt;0-65535&gt;'>
1244 <params>
1245 <param name='logging' doc='Configure logging' />
1246 <param name='filter' doc='Filter log messages' />
1247 <param name='nsvc' doc='Filter based on NS Virtual Connection' />
1248 <param name='nsei' doc='Identify NS-VC by NSEI' />
1249 <param name='nsvci' doc='Identify NS-VC by NSVCI' />
1250 <param name='&lt;0-65535&gt;' doc='Numeric identifier' />
1251 </params>
1252 </command>
1253 </node>
1254 <node id='config-stats'>
1255 <name>config-stats</name>
1256 <command id='local-ip ADDR'>
1257 <params>
1258 <param name='local-ip' doc='Set the IP address to which we bind locally' />
1259 <param name='ADDR' doc='IP Address' />
1260 </params>
1261 </command>
1262 <command id='no local-ip'>
1263 <params>
1264 <param name='no' doc='Negate a command or set its defaults' />
1265 <param name='local-ip' doc='Set the IP address to which we bind locally' />
1266 </params>
1267 </command>
1268 <command id='remote-ip ADDR'>
1269 <params>
1270 <param name='remote-ip' doc='Set the remote IP address to which we connect' />
1271 <param name='ADDR' doc='IP Address' />
1272 </params>
1273 </command>
1274 <command id='remote-port &lt;1-65535&gt;'>
1275 <params>
1276 <param name='remote-port' doc='Set the remote port to which we connect' />
1277 <param name='&lt;1-65535&gt;' doc='Remote port number' />
1278 </params>
1279 </command>
1280 <command id='mtu &lt;100-65535&gt;'>
1281 <params>
1282 <param name='mtu' doc='Set the maximum packet size' />
1283 <param name='&lt;100-65535&gt;' doc='Size in byte' />
1284 </params>
1285 </command>
1286 <command id='no mtu'>
1287 <params>
1288 <param name='no' doc='Negate a command or set its defaults' />
1289 <param name='mtu' doc='Set the maximum packet size' />
1290 </params>
1291 </command>
1292 <command id='prefix PREFIX'>
1293 <params>
1294 <param name='prefix' doc='Set the item name prefix' />
1295 <param name='PREFIX' doc='The prefix string' />
1296 </params>
1297 </command>
1298 <command id='no prefix'>
1299 <params>
1300 <param name='no' doc='Negate a command or set its defaults' />
1301 <param name='prefix' doc='Set the item name prefix' />
1302 </params>
1303 </command>
1304 <command id='level (global|peer|subscriber)'>
1305 <params>
1306 <param name='level' doc='Set the maximum group level' />
1307 <param name='global' doc='Report global groups only' />
1308 <param name='peer' doc='Report global and network peer related groups' />
1309 <param name='subscriber' doc='Report global, peer, and subscriber groups' />
1310 </params>
1311 </command>
1312 <command id='enable'>
1313 <params>
1314 <param name='enable' doc='Enable the reporter' />
1315 </params>
1316 </command>
1317 <command id='disable'>
1318 <params>
1319 <param name='disable' doc='Disable the reporter' />
1320 </params>
1321 </command>
1322 </node>
1323 <node id='config-line'>
1324 <name>config-line</name>
1325 <command id='login'>
1326 <params>
1327 <param name='login' doc='Enable password checking' />
1328 </params>
1329 </command>
1330 <command id='no login'>
1331 <params>
1332 <param name='no' doc='Negate a command or set its defaults' />
1333 <param name='login' doc='Enable password checking' />
1334 </params>
1335 </command>
1336 <command id='bind A.B.C.D [&lt;0-65535&gt;]'>
1337 <params>
1338 <param name='bind' doc='Accept VTY telnet connections on local interface' />
1339 <param name='A.B.C.D' doc='Local interface IP address (default: 127.0.0.1)' />
1340 <param name='[&lt;0-65535&gt;]' doc='Local TCP port number' />
1341 </params>
1342 </command>
1343 </node>
1344 <node id='config-ns'>
1345 <name>config-ns</name>
1346 <command id='nse &lt;0-65535&gt; nsvci &lt;0-65534&gt;'>
1347 <params>
1348 <param name='nse' doc='Persistent NS Entity' />
1349 <param name='&lt;0-65535&gt;' doc='NS Entity ID (NSEI)' />
1350 <param name='nsvci' doc='NS Virtual Connection' />
1351 <param name='&lt;0-65534&gt;' doc='NS Virtual Connection ID (NSVCI)' />
1352 </params>
1353 </command>
1354 <command id='nse &lt;0-65535&gt; remote-ip A.B.C.D'>
1355 <params>
1356 <param name='nse' doc='Persistent NS Entity' />
1357 <param name='&lt;0-65535&gt;' doc='NS Entity ID (NSEI)' />
1358 <param name='remote-ip' doc='Remote IP Address' />
1359 <param name='A.B.C.D' doc='Remote IP Address' />
1360 </params>
1361 </command>
1362 <command id='nse &lt;0-65535&gt; remote-port &lt;0-65535&gt;'>
1363 <params>
1364 <param name='nse' doc='Persistent NS Entity' />
1365 <param name='&lt;0-65535&gt;' doc='NS Entity ID (NSEI)' />
1366 <param name='remote-port' doc='Remote UDP Port' />
1367 <param name='&lt;0-65535&gt;' doc='Remote UDP Port Number' />
1368 </params>
1369 </command>
1370 <command id='nse &lt;0-65535&gt; fr-dlci &lt;16-1007&gt;'>
1371 <params>
1372 <param name='nse' doc='Persistent NS Entity' />
1373 <param name='&lt;0-65535&gt;' doc='NS Entity ID (NSEI)' />
1374 <param name='fr-dlci' doc='Frame Relay DLCI' />
1375 <param name='&lt;16-1007&gt;' doc='Frame Relay DLCI Number' />
1376 </params>
1377 </command>
1378 <command id='nse &lt;0-65535&gt; encapsulation (udp|framerelay-gre)'>
1379 <params>
1380 <param name='nse' doc='Persistent NS Entity' />
1381 <param name='&lt;0-65535&gt;' doc='NS Entity ID (NSEI)' />
1382 <param name='encapsulation' doc='Encapsulation for NS' />
1383 <param name='udp' doc='UDP/IP Encapsulation' />
1384 <param name='framerelay-gre' doc='Frame-Relay/GRE/IP Encapsulation' />
1385 </params>
1386 </command>
1387 <command id='nse &lt;0-65535&gt; remote-role (sgsn|bss)'>
1388 <params>
1389 <param name='nse' doc='Persistent NS Entity' />
1390 <param name='&lt;0-65535&gt;' doc='NS Entity ID (NSEI)' />
1391 <param name='remote-role' doc='Remote NSE Role' />
1392 <param name='sgsn' doc='Remote Peer is SGSN' />
1393 <param name='bss' doc='Remote Peer is BSS' />
1394 </params>
1395 </command>
1396 <command id='no nse &lt;0-65535&gt;'>
1397 <params>
1398 <param name='no' doc='Delete Persistent NS Entity' />
1399 <param name='nse' doc='Delete Persistent NS Entity' />
1400 <param name='&lt;0-65535&gt;' doc='NS Entity ID (NSEI)' />
1401 </params>
1402 </command>
1403 <command id='timer (tns-block|tns-block-retries|tns-reset|tns-reset-retries|tns-test|tns-alive|tns-alive-retries|tsns-prov) &lt;0-65535&gt;'>
1404 <params>
1405 <param name='timer' doc='Network Service Timer' />
1406 <param name='tns-block' doc='(un)blocking Timer (Tns-block) timeout' />
1407 <param name='tns-block-retries' doc='(un)blocking Timer (Tns-block) number of retries' />
1408 <param name='tns-reset' doc='Reset Timer (Tns-reset) timeout' />
1409 <param name='tns-reset-retries' doc='Reset Timer (Tns-reset) number of retries' />
1410 <param name='tns-test' doc='Test Timer (Tns-test) timeout' />
1411 <param name='tns-alive' doc='Alive Timer (Tns-alive) timeout' />
1412 <param name='tns-alive-retries' doc='Alive Timer (Tns-alive) number of retries' />
1413 <param name='tsns-prov' doc='SNS Provision Timer (Tsns-prov) timeout' />
1414 <param name='&lt;0-65535&gt;' doc='Timer Value' />
1415 </params>
1416 </command>
1417 <command id='encapsulation udp local-ip A.B.C.D'>
1418 <params>
1419 <param name='encapsulation' doc='NS encapsulation options' />
1420 <param name='udp' doc='NS over UDP Encapsulation' />
1421 <param name='local-ip' doc='Set the IP address on which we listen for NS/UDP' />
1422 <param name='A.B.C.D' doc='IP Address' />
1423 </params>
1424 </command>
1425 <command id='encapsulation udp local-port &lt;0-65535&gt;'>
1426 <params>
1427 <param name='encapsulation' doc='NS encapsulation options' />
1428 <param name='udp' doc='NS over UDP Encapsulation' />
1429 <param name='local-port' doc='Set the UDP port on which we listen for NS/UDP' />
1430 <param name='&lt;0-65535&gt;' doc='UDP port number' />
1431 </params>
1432 </command>
1433 <command id='encapsulation udp dscp &lt;0-255&gt;'>
1434 <params>
1435 <param name='encapsulation' doc='NS encapsulation options' />
1436 <param name='udp' doc='NS over UDP Encapsulation' />
1437 <param name='dscp' doc='Set DSCP/TOS on the UDP socket' />
1438 <param name='&lt;0-255&gt;' doc='DSCP Value' />
1439 </params>
1440 </command>
1441 <command id='encapsulation framerelay-gre enabled (1|0)'>
1442 <params>
1443 <param name='encapsulation' doc='NS encapsulation options' />
1444 <param name='framerelay-gre' doc='NS over Frame Relay over GRE Encapsulation' />
1445 <param name='enabled' doc='Enable or disable Frame Relay over GRE' />
1446 <param name='1' doc='Enable' />
1447 <param name='0' doc='Disable' />
1448 </params>
1449 </command>
1450 <command id='encapsulation framerelay-gre local-ip A.B.C.D'>
1451 <params>
1452 <param name='encapsulation' doc='NS encapsulation options' />
1453 <param name='framerelay-gre' doc='NS over Frame Relay over GRE Encapsulation' />
1454 <param name='local-ip' doc='Set the IP address on which we listen for NS/FR/GRE' />
1455 <param name='A.B.C.D' doc='IP Address' />
1456 </params>
1457 </command>
1458 </node>
1459 <node id='config-pcu'>
1460 <name>config-pcu</name>
1461 <command id='egprs only'>
1462 <params>
1463 <param name='egprs' doc='EGPRS configuration' />
1464 <param name='only' doc='Use EGPRS and disable plain GPRS' />
1465 </params>
1466 </command>
1467 <command id='no egprs'>
1468 <params>
1469 <param name='no' doc='Negate a command or set its defaults' />
1470 <param name='egprs' doc='EGPRS configuration' />
1471 </params>
1472 </command>
1473 <command id='no two-phase-access'>
1474 <params>
1475 <param name='no' doc='Negate a command or set its defaults' />
1476 <param name='two-phase-access' doc='Only use two phase access when requested my MS' />
1477 </params>
1478 </command>
1479 <command id='cs &lt;1-4&gt; [&lt;1-4&gt;]'>
1480 <params>
1481 <param name='cs' doc='Coding Scheme configuration' />
1482 <param name='&lt;1-4&gt;' doc='Initial CS value to be used (overrides BTS config)' />
1483 <param name='[&lt;1-4&gt;]' doc='Use a different initial CS value for the uplink' />
1484 </params>
1485 </command>
1486 <command id='no cs'>
1487 <params>
1488 <param name='no' doc='Negate a command or set its defaults' />
1489 <param name='cs' doc='Coding Scheme configuration' />
1490 </params>
1491 </command>
1492 <command id='cs max &lt;1-4&gt; [&lt;1-4&gt;]'>
1493 <params>
1494 <param name='cs' doc='Coding Scheme configuration' />
1495 <param name='max' doc='Set maximum values for adaptive CS selection (overrides BTS config)' />
1496 <param name='&lt;1-4&gt;' doc='Maximum CS value to be used' />
1497 <param name='[&lt;1-4&gt;]' doc='Use a different maximum CS value for the uplink' />
1498 </params>
1499 </command>
1500 <command id='no cs max'>
1501 <params>
1502 <param name='no' doc='Negate a command or set its defaults' />
1503 <param name='cs' doc='Coding Scheme configuration' />
1504 <param name='max' doc='Set maximum values for adaptive CS selection (overrides BTS config)' />
1505 </params>
1506 </command>
1507 <command id='cs threshold &lt;0-100&gt; &lt;0-100&gt;'>
1508 <params>
1509 <param name='cs' doc='Coding Scheme configuration' />
1510 <param name='threshold' doc='set thresholds for error rate based CS adjustment' />
1511 <param name='&lt;0-100&gt;' doc='lower limit in %' />
1512 <param name='&lt;0-100&gt;' doc='upper limit in %' />
1513 </params>
1514 </command>
1515 <command id='no cs threshold'>
1516 <params>
1517 <param name='no' doc='Negate a command or set its defaults' />
1518 <param name='cs' doc='Coding Scheme configuration' />
1519 <param name='threshold' doc='set thresholds for error rate based CS adjustment' />
1520 </params>
1521 </command>
1522 <command id='cs downgrade-threshold &lt;1-10000&gt;'>
1523 <params>
1524 <param name='cs' doc='Coding Scheme configuration' />
1525 <param name='downgrade-threshold' doc='set threshold for data size based CS downgrade' />
1526 <param name='&lt;1-10000&gt;' doc='downgrade if less octets left' />
1527 </params>
1528 </command>
1529 <command id='no cs downgrade-threshold'>
1530 <params>
1531 <param name='no' doc='Negate a command or set its defaults' />
1532 <param name='cs' doc='Coding Scheme configuration' />
1533 <param name='downgrade-threshold' doc='set threshold for data size based CS downgrade' />
1534 </params>
1535 </command>
1536 <command id='cs link-quality-ranges cs1 &lt;0-35&gt; cs2 &lt;0-35&gt; &lt;0-35&gt; cs3 &lt;0-35&gt; &lt;0-35&gt; cs4 &lt;0-35&gt;'>
1537 <params>
1538 <param name='cs' doc='Coding Scheme configuration' />
1539 <param name='link-quality-ranges' doc='Set link quality ranges' />
1540 <param name='cs1' doc='Set quality range for CS-1 (high value only)' />
1541 <param name='&lt;0-35&gt;' doc='CS-1 high (dB)' />
1542 <param name='cs2' doc='Set quality range for CS-2' />
1543 <param name='&lt;0-35&gt;' doc='CS-2 low (dB)' />
1544 <param name='&lt;0-35&gt;' doc='CS-2 high (dB)' />
1545 <param name='cs3' doc='Set quality range for CS-3' />
1546 <param name='&lt;0-35&gt;' doc='CS-3 low (dB)' />
1547 <param name='&lt;0-35&gt;' doc='CS-3 high (dB)' />
1548 <param name='cs4' doc='Set quality range for CS-4 (low value only)' />
1549 <param name='&lt;0-35&gt;' doc='CS-4 low (dB)' />
1550 </params>
1551 </command>
1552 <command id='mcs link-quality-ranges mcs1 &lt;0-35&gt; mcs2 &lt;0-35&gt; &lt;0-35&gt; mcs3 &lt;0-35&gt; &lt;0-35&gt; mcs4 &lt;0-35&gt; &lt;0-35&gt; mcs5 &lt;0-35&gt; &lt;0-35&gt; mcs6 &lt;0-35&gt; &lt;0-35&gt; mcs7 &lt;0-35&gt; &lt;0-35&gt; mcs8 &lt;0-35&gt; &lt;0-35&gt; mcs9 &lt;0-35&gt;'>
1553 <params>
1554 <param name='mcs' doc='Coding Scheme configuration' />
1555 <param name='link-quality-ranges' doc='Set link quality ranges' />
1556 <param name='mcs1' doc='Set quality range for MCS-1 (high value only)' />
1557 <param name='&lt;0-35&gt;' doc='MCS-1 high (dB)' />
1558 <param name='mcs2' doc='Set quality range for MCS-2' />
1559 <param name='&lt;0-35&gt;' doc='MCS-2 high (dB)' />
1560 <param name='&lt;0-35&gt;' doc='MCS-2 low (dB)' />
1561 <param name='mcs3' doc='Set quality range for MCS-3' />
1562 <param name='&lt;0-35&gt;' doc='MCS-3 high (dB)' />
1563 <param name='&lt;0-35&gt;' doc='MCS-3 low (dB)' />
1564 <param name='mcs4' doc='Set quality range for MCS-4' />
1565 <param name='&lt;0-35&gt;' doc='MCS-4 high (dB)' />
1566 <param name='&lt;0-35&gt;' doc='MCS-4 low (dB)' />
1567 <param name='mcs5' doc='Set quality range for MCS-5' />
1568 <param name='&lt;0-35&gt;' doc='MCS-5 high (dB)' />
1569 <param name='&lt;0-35&gt;' doc='MCS-5 low (dB)' />
1570 <param name='mcs6' doc='Set quality range for MCS-6' />
1571 <param name='&lt;0-35&gt;' doc='MCS-6 low (dB)' />
1572 <param name='&lt;0-35&gt;' doc='MCS-6 high (dB)' />
1573 <param name='mcs7' doc='Set quality range for MCS-7' />
1574 <param name='&lt;0-35&gt;' doc='MCS-7 low (dB)' />
1575 <param name='&lt;0-35&gt;' doc='MCS-7 high (dB)' />
1576 <param name='mcs8' doc='Set quality range for MCS-8' />
1577 <param name='&lt;0-35&gt;' doc='MCS-8 low (dB)' />
1578 <param name='&lt;0-35&gt;' doc='MCS-8 high (dB)' />
1579 <param name='mcs9' doc='Set quality range for MCS-9 (low value only)' />
1580 <param name='&lt;0-35&gt;' doc='MCS-9 low (dB)' />
1581 </params>
1582 </command>
1583 <command id='mcs &lt;1-9&gt; [&lt;1-9&gt;]'>
1584 <params>
1585 <param name='mcs' doc='Modulation and Coding Scheme configuration (EGPRS)' />
1586 <param name='&lt;1-9&gt;' doc='Initial MCS value to be used (default 1)' />
1587 <param name='[&lt;1-9&gt;]' doc='Use a different initial MCS value for the uplink' />
1588 </params>
1589 </command>
1590 <command id='egprs dl arq-type (spb|arq2)'>
1591 <params>
1592 <param name='egprs' doc='EGPRS configuration' />
1593 <param name='dl' doc='downlink specific configuration' />
1594 <param name='arq-type' doc='ARQ options' />
1595 <param name='spb' doc='enable SPB(ARQ1) support' />
1596 <param name='arq2' doc='enable ARQ2 support' />
1597 </params>
1598 </command>
1599 <command id='no mcs'>
1600 <params>
1601 <param name='no' doc='Negate a command or set its defaults' />
1602 <param name='mcs' doc='Modulation and Coding Scheme configuration (EGPRS)' />
1603 </params>
1604 </command>
1605 <command id='mcs max &lt;1-9&gt; [&lt;1-9&gt;]'>
1606 <params>
1607 <param name='mcs' doc='Modulation and Coding Scheme configuration (EGPRS)' />
1608 <param name='max' doc='Set maximum values for adaptive CS selection (overrides BTS config)' />
1609 <param name='&lt;1-9&gt;' doc='Maximum MCS value to be used' />
1610 <param name='[&lt;1-9&gt;]' doc='Use a different maximum MCS value for the uplink' />
1611 </params>
1612 </command>
1613 <command id='no mcs max'>
1614 <params>
1615 <param name='no' doc='Negate a command or set its defaults' />
1616 <param name='mcs' doc='Modulation and Coding Scheme configuration (EGPRS)' />
1617 <param name='max' doc='Set maximum values for adaptive CS selection (overrides BTS config)' />
1618 </params>
1619 </command>
1620 <command id='window-size &lt;0-1024&gt; [&lt;0-256&gt;]'>
1621 <params>
1622 <param name='window-size' doc='Window size configuration (b + N_PDCH * f)' />
1623 <param name='&lt;0-1024&gt;' doc='Base value (b)' />
1624 <param name='[&lt;0-256&gt;]' doc='Factor for number of PDCH (f)' />
1625 </params>
1626 </command>
1627 <command id='queue lifetime &lt;1-65534&gt;'>
1628 <params>
1629 <param name='queue' doc='Packet queue options' />
1630 <param name='lifetime' doc='Set lifetime limit of LLC frame in centi-seconds (overrides the value given by SGSN)' />
1631 <param name='&lt;1-65534&gt;' doc='Lifetime in centi-seconds' />
1632 </params>
1633 </command>
1634 <command id='queue lifetime infinite'>
1635 <params>
1636 <param name='queue' doc='Packet queue options' />
1637 <param name='lifetime' doc='Set lifetime limit of LLC frame in centi-seconds (overrides the value given by SGSN)' />
1638 <param name='infinite' doc='Infinite lifetime' />
1639 </params>
1640 </command>
1641 <command id='no queue lifetime'>
1642 <params>
1643 <param name='no' doc='Negate a command or set its defaults' />
1644 <param name='queue' doc='Packet queue options' />
1645 <param name='lifetime' doc='Disable lifetime limit of LLC frame (use value given by SGSN)' />
1646 </params>
1647 </command>
1648 <command id='queue hysteresis &lt;1-65535&gt;'>
1649 <params>
1650 <param name='queue' doc='Packet queue options' />
1651 <param name='hysteresis' doc='Set lifetime hysteresis of LLC frame in centi-seconds (continue discarding until lifetime-hysteresis is reached)' />
1652 <param name='&lt;1-65535&gt;' doc='Hysteresis in centi-seconds' />
1653 </params>
1654 </command>
1655 <command id='no queue hysteresis'>
1656 <params>
1657 <param name='no' doc='Negate a command or set its defaults' />
1658 <param name='queue' doc='Packet queue options' />
1659 <param name='hysteresis' doc='Set lifetime hysteresis of LLC frame in centi-seconds (continue discarding until lifetime-hysteresis is reached)' />
1660 </params>
1661 </command>
1662 <command id='queue codel'>
1663 <params>
1664 <param name='queue' doc='Packet queue options' />
1665 <param name='codel' doc='Set CoDel queue management' />
1666 </params>
1667 </command>
1668 <command id='queue codel interval &lt;1-1000&gt;'>
1669 <params>
1670 <param name='queue' doc='Packet queue options' />
1671 <param name='codel' doc='Set CoDel queue management' />
1672 <param name='interval' doc='Specify interval' />
1673 <param name='&lt;1-1000&gt;' doc='Interval in centi-seconds' />
1674 </params>
1675 </command>
1676 <command id='no queue codel'>
1677 <params>
1678 <param name='no' doc='Negate a command or set its defaults' />
1679 <param name='queue' doc='Packet queue options' />
1680 <param name='codel' doc='Set CoDel queue management' />
1681 </params>
1682 </command>
1683 <command id='queue idle-ack-delay &lt;1-65535&gt;'>
1684 <params>
1685 <param name='queue' doc='Packet queue options' />
1686 <param name='idle-ack-delay' doc='Request an ACK after the last DL LLC frame in centi-seconds' />
1687 <param name='&lt;1-65535&gt;' doc='Idle ACK delay in centi-seconds' />
1688 </params>
1689 </command>
1690 <command id='no queue idle-ack-delay'>
1691 <params>
1692 <param name='no' doc='Negate a command or set its defaults' />
1693 <param name='queue' doc='Packet queue options' />
1694 <param name='idle-ack-delay' doc='Request an ACK after the last DL LLC frame in centi-seconds' />
1695 </params>
1696 </command>
1697 <command id='alloc-algorithm (a|b|dynamic)'>
1698 <params>
1699 <param name='alloc-algorithm' doc='Select slot allocation algorithm to use when assigning timeslots on PACCH' />
1700 <param name='a' doc='Single slot is assigned only' />
1701 <param name='b' doc='Multiple slots are assigned for semi-duplex operation' />
1702 <param name='dynamic' doc='Dynamically select the algorithm based on the system state' />
1703 </params>
1704 </command>
1705 <command id='two-phase-access'>
1706 <params>
1707 <param name='two-phase-access' doc='Force two phase access when MS requests single phase access' />
1708 </params>
1709 </command>
1710 <command id='flow-control-interval &lt;1-10&gt;'>
1711 <params>
1712 <param name='flow-control-interval' doc='Interval between sending subsequent Flow Control PDUs' />
1713 <param name='&lt;1-10&gt;' doc='Interval time in seconds' />
1714 </params>
1715 </command>
1716 <command id='flow-control bucket-time &lt;1-65534&gt;'>
1717 <params>
1718 <param name='flow-control' doc='BSSGP Flow Control configuration' />
1719 <param name='bucket-time' doc='Set target downlink maximum queueing time (only affects the advertised bucket size)' />
1720 <param name='&lt;1-65534&gt;' doc='Time in centi-seconds' />
1721 </params>
1722 </command>
1723 <command id='no flow-control bucket-time'>
1724 <params>
1725 <param name='no' doc='Negate a command or set its defaults' />
1726 <param name='flow-control' doc='BSSGP Flow Control configuration' />
1727 <param name='bucket-time' doc='Set target downlink maximum queueing time (only affects the advertised bucket size)' />
1728 </params>
1729 </command>
1730 <command id='flow-control force-bvc-bucket-size &lt;1-6553500&gt;'>
1731 <params>
1732 <param name='flow-control' doc='BSSGP Flow Control configuration' />
1733 <param name='force-bvc-bucket-size' doc='Force a fixed value for the BVC bucket size' />
1734 <param name='&lt;1-6553500&gt;' doc='Bucket size in octets' />
1735 </params>
1736 </command>
1737 <command id='no flow-control force-bvc-bucket-size'>
1738 <params>
1739 <param name='no' doc='Negate a command or set its defaults' />
1740 <param name='flow-control' doc='BSSGP Flow Control configuration' />
1741 <param name='force-bvc-bucket-size' doc='Force a fixed value for the BVC bucket size' />
1742 </params>
1743 </command>
1744 <command id='flow-control force-bvc-leak-rate &lt;1-6553500&gt;'>
1745 <params>
1746 <param name='flow-control' doc='BSSGP Flow Control configuration' />
1747 <param name='force-bvc-leak-rate' doc='Force a fixed value for the BVC leak rate' />
1748 <param name='&lt;1-6553500&gt;' doc='Leak rate in bit/s' />
1749 </params>
1750 </command>
1751 <command id='no flow-control force-bvc-leak-rate'>
1752 <params>
1753 <param name='no' doc='Negate a command or set its defaults' />
1754 <param name='flow-control' doc='BSSGP Flow Control configuration' />
1755 <param name='force-bvc-leak-rate' doc='Force a fixed value for the BVC leak rate' />
1756 </params>
1757 </command>
1758 <command id='flow-control force-ms-bucket-size &lt;1-6553500&gt;'>
1759 <params>
1760 <param name='flow-control' doc='BSSGP Flow Control configuration' />
1761 <param name='force-ms-bucket-size' doc='Force a fixed value for the default MS bucket size' />
1762 <param name='&lt;1-6553500&gt;' doc='Bucket size in octets' />
1763 </params>
1764 </command>
1765 <command id='no flow-control force-ms-bucket-size'>
1766 <params>
1767 <param name='no' doc='Negate a command or set its defaults' />
1768 <param name='flow-control' doc='BSSGP Flow Control configuration' />
1769 <param name='force-ms-bucket-size' doc='Force a fixed value for the default MS bucket size' />
1770 </params>
1771 </command>
1772 <command id='flow-control force-ms-leak-rate &lt;1-6553500&gt;'>
1773 <params>
1774 <param name='flow-control' doc='BSSGP Flow Control configuration' />
1775 <param name='force-ms-leak-rate' doc='Force a fixed value for the default MS leak rate' />
1776 <param name='&lt;1-6553500&gt;' doc='Leak rate in bit/s' />
1777 </params>
1778 </command>
1779 <command id='no flow-control force-ms-leak-rate'>
1780 <params>
1781 <param name='no' doc='Negate a command or set its defaults' />
1782 <param name='flow-control' doc='BSSGP Flow Control configuration' />
1783 <param name='force-ms-leak-rate' doc='Force a fixed value for the default MS leak rate' />
1784 </params>
1785 </command>
1786 <command id='alpha &lt;0-10&gt;'>
1787 <params>
1788 <param name='alpha' doc='Alpha parameter for MS power control in units of 0.1 (see TS 05.08) NOTE: Be sure to set Alpha value at System information 13 too.' />
1789 <param name='&lt;0-10&gt;' doc='Alpha in units of 0.1' />
1790 </params>
1791 </command>
1792 <command id='gamma &lt;0-62&gt;'>
1793 <params>
1794 <param name='gamma' doc='Gamma parameter for MS power control in units of dB (see TS 05.08)' />
1795 <param name='&lt;0-62&gt;' doc='Gamma in even unit of dBs' />
1796 </params>
1797 </command>
1798 <command id='dl-tbf-idle-time &lt;1-5000&gt;'>
1799 <params>
1800 <param name='dl-tbf-idle-time' doc='keep an idle DL TBF alive for the time given' />
1801 <param name='&lt;1-5000&gt;' doc='idle time in msec' />
1802 </params>
1803 </command>
1804 <command id='no dl-tbf-idle-time'>
1805 <params>
1806 <param name='no' doc='Negate a command or set its defaults' />
1807 <param name='dl-tbf-idle-time' doc='keep an idle DL TBF alive for the time given' />
1808 </params>
1809 </command>
1810 <command id='ms-idle-time &lt;1-7200&gt;'>
1811 <params>
1812 <param name='ms-idle-time' doc='keep an idle MS object alive for the time given' />
1813 <param name='&lt;1-7200&gt;' doc='idle time in sec' />
1814 </params>
1815 </command>
1816 <command id='no ms-idle-time'>
1817 <params>
1818 <param name='no' doc='Negate a command or set its defaults' />
1819 <param name='ms-idle-time' doc='keep an idle MS object alive for the time given' />
1820 </params>
1821 </command>
1822 <command id='gsmtap-category (dl-unknown|dl-dummy|dl-ctrl|dl-data-gprs|dl-data-egprs|dl-ptcch|ul-unknown|ul-dummy|ul-ctrl|ul-data-gprs|ul-data-egprs)'>
1823 <params>
1824 <param name='gsmtap-category' doc='GSMTAP Category' />
1825 <param name='dl-unknown' doc='Unknown / Unparseable / Erroneous Downlink Blocks' />
1826 <param name='dl-dummy' doc='Downlink Dummy Blocks' />
1827 <param name='dl-ctrl' doc='Downlink Control Blocks' />
1828 <param name='dl-data-gprs' doc='Downlink Data Blocks (GPRS)' />
1829 <param name='dl-data-egprs' doc='Downlink Data Blocks (EGPRS)' />
1830 <param name='dl-ptcch' doc='Downlink PTCCH Blocks' />
1831 <param name='ul-unknown' doc='Unknown / Unparseable / Erroneous Downlink Blocks' />
1832 <param name='ul-dummy' doc='Uplink Dummy Blocks' />
1833 <param name='ul-ctrl' doc='Uplink Control Blocks' />
1834 <param name='ul-data-gprs' doc='Uplink Data Blocks (GPRS)' />
1835 <param name='ul-data-egprs' doc='Uplink Data Blocks (EGPRS)' />
1836 </params>
1837 </command>
1838 <command id='no gsmtap-category (dl-unknown|dl-dummy|dl-ctrl|dl-data-gprs|dl-data-egprs|dl-ptcch|ul-unknown|ul-dummy|ul-ctrl|ul-data-gprs|ul-data-egprs)'>
1839 <params>
1840 <param name='no' doc='Negate a command or set its defaults' />
1841 <param name='gsmtap-category' doc='GSMTAP Category' />
1842 <param name='dl-unknown' doc='Unknown / Unparseable / Erroneous Downlink Blocks' />
1843 <param name='dl-dummy' doc='Downlink Dummy Blocks' />
1844 <param name='dl-ctrl' doc='Downlink Control Blocks' />
1845 <param name='dl-data-gprs' doc='Downlink Data Blocks (GPRS)' />
1846 <param name='dl-data-egprs' doc='Downlink Data Blocks (EGPRS)' />
1847 <param name='dl-ptcch' doc='Downlink PTCCH Blocks' />
1848 <param name='ul-unknown' doc='Unknown / Unparseable / Erroneous Downlink Blocks' />
1849 <param name='ul-dummy' doc='Uplink Dummy Blocks' />
1850 <param name='ul-ctrl' doc='Uplink Control Blocks' />
1851 <param name='ul-data-gprs' doc='Uplink Data Blocks (GPRS)' />
1852 <param name='ul-data-egprs' doc='Uplink Data Blocks (EGPRS)' />
1853 </params>
1854 </command>
1855 <command id='pcu-socket PATH'>
1856 <params>
1857 <param name='pcu-socket' doc='Configure the osmo-bts PCU socket file/path name' />
1858 <param name='PATH' doc='Path of the socket to connect to' />
1859 </params>
1860 </command>
1861 <command id='gb-dialect (classic|ip-sns)'>
1862 <params>
1863 <param name='gb-dialect' doc='Select which Gb interface dialect to use' />
1864 <param name='classic' doc='Classic Gb interface with NS-{RESET,BLOCK,UNBLOCK} and static configuration' />
1865 <param name='ip-sns' doc='Modern Gb interface with IP-SNS (Sub Network Service) and dynamic configuration' />
1866 </params>
1867 </command>
1868 </node>
1869</vtydoc>