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