blob: f2266e4e7bf2388da3dcea9f8f79af76d8a8b3f0 [file] [log] [blame]
Neels Hofmeyr9f157572018-03-06 14:59:00 +01001<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>
Oliver Smithb5bfa712020-03-27 10:29:51 +010021 <command id='write file [PATH]'>
Neels Hofmeyr9f157572018-03-06 14:59:00 +010022 <params>
23 <param name='write' doc='Write running configuration to memory, network, or terminal' />
24 <param name='file' doc='Write to configuration file' />
Oliver Smithb5bfa712020-03-27 10:29:51 +010025 <param name='[PATH]' doc='Set file path to store the config, or replace if already exists' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +010026 </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>
Neels Hofmeyr9f157572018-03-06 14:59:00 +010089 <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='show stats'>
101 <params>
102 <param name='show' doc='Show running system information' />
103 <param name='stats' doc='Show statistical values' />
104 </params>
105 </command>
106 <command id='show stats level (global|peer|subscriber)'>
107 <params>
108 <param name='show' doc='Show running system information' />
109 <param name='stats' doc='Show statistical values' />
110 <param name='level' doc='Set the maximum group level' />
111 <param name='global' doc='Show global groups only' />
112 <param name='peer' doc='Show global and network peer related groups' />
113 <param name='subscriber' doc='Show global, peer, and subscriber groups' />
114 </params>
115 </command>
116 <command id='show asciidoc counters'>
117 <params>
118 <param name='show' doc='Show running system information' />
119 <param name='asciidoc' doc='Asciidoc generation' />
120 <param name='counters' doc='Generate table of all registered counters' />
121 </params>
122 </command>
Neels Hofmeyr39e12152018-11-05 02:56:09 +0100123 <command id='show rate-counters'>
124 <params>
125 <param name='show' doc='Show running system information' />
126 <param name='rate-counters' doc='Show all rate counters' />
127 </params>
128 </command>
Neels Hofmeyr9f157572018-03-06 14:59:00 +0100129 <command id='show network'>
130 <params>
131 <param name='show' doc='Show running system information' />
132 <param name='network' doc='Display information about a GSM NETWORK' />
133 </params>
134 </command>
135 <command id='show bts [&lt;0-255&gt;]'>
136 <params>
137 <param name='show' doc='Show running system information' />
138 <param name='bts' doc='Display information about a BTS' />
139 <param name='[&lt;0-255&gt;]' doc='BTS number' />
140 </params>
141 </command>
Oliver Smithb5bfa712020-03-27 10:29:51 +0100142 <command id='show bts &lt;0-255&gt; fail-rep [reset]'>
143 <params>
144 <param name='show' doc='Show running system information' />
145 <param name='bts' doc='Display information about a BTS' />
146 <param name='&lt;0-255&gt;' doc='BTS number' />
147 <param name='fail-rep' doc='OML failure reports' />
148 <param name='[reset]' doc='Clear the list of failure reports after showing them' />
149 </params>
150 </command>
Neels Hofmeyr39e12152018-11-05 02:56:09 +0100151 <command id='show rejected-bts'>
152 <params>
153 <param name='show' doc='Show running system information' />
154 <param name='rejected-bts' doc='Display recently rejected BTS devices' />
155 </params>
156 </command>
Neels Hofmeyr9f157572018-03-06 14:59:00 +0100157 <command id='show trx [&lt;0-255&gt;] [&lt;0-255&gt;]'>
158 <params>
159 <param name='show' doc='Show running system information' />
160 <param name='trx' doc='Display information about a TRX' />
161 <param name='[&lt;0-255&gt;]' doc='BTS Number' />
162 <param name='[&lt;0-255&gt;]' doc='TRX Number' />
163 </params>
164 </command>
Daniel Willmannf450f442019-06-06 17:52:25 +0200165 <command id='show trx (connected|disconnected)'>
166 <params>
167 <param name='show' doc='Show running system information' />
168 <param name='trx' doc='Display information about a TRX' />
169 <param name='connected' doc='Show TRX with RSL connected' />
170 <param name='disconnected' doc='Show TRX with RSL disconnected' />
171 </params>
172 </command>
Neels Hofmeyr9f157572018-03-06 14:59:00 +0100173 <command id='show timeslot [&lt;0-255&gt;] [&lt;0-255&gt;] [&lt;0-7&gt;]'>
174 <params>
175 <param name='show' doc='Show running system information' />
176 <param name='timeslot' doc='Display information about a TS' />
177 <param name='[&lt;0-255&gt;]' doc='BTS Number' />
178 <param name='[&lt;0-255&gt;]' doc='TRX Number' />
179 <param name='[&lt;0-7&gt;]' doc='Timeslot Number' />
180 </params>
181 </command>
182 <command id='show lchan [&lt;0-255&gt;] [&lt;0-255&gt;] [&lt;0-7&gt;] [&lt;0-7&gt;]'>
183 <params>
184 <param name='show' doc='Show running system information' />
185 <param name='lchan' doc='Display information about a logical channel' />
186 <param name='[&lt;0-255&gt;]' doc='BTS Number' />
187 <param name='[&lt;0-255&gt;]' doc='TRX Number' />
188 <param name='[&lt;0-7&gt;]' doc='Timeslot Number' />
189 <param name='[&lt;0-7&gt;]' doc='Logical Channel Number' />
190 </params>
191 </command>
192 <command id='show lchan summary [&lt;0-255&gt;] [&lt;0-255&gt;] [&lt;0-7&gt;] [&lt;0-7&gt;]'>
193 <params>
194 <param name='show' doc='Show running system information' />
195 <param name='lchan' doc='Display information about a logical channel' />
Daniel Willmannf450f442019-06-06 17:52:25 +0200196 <param name='summary' doc='Short summary (used lchans)' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +0100197 <param name='[&lt;0-255&gt;]' doc='BTS Number' />
198 <param name='[&lt;0-255&gt;]' doc='TRX Number' />
199 <param name='[&lt;0-7&gt;]' doc='Timeslot Number' />
200 <param name='[&lt;0-7&gt;]' doc='Logical Channel Number' />
201 </params>
202 </command>
Daniel Willmannf450f442019-06-06 17:52:25 +0200203 <command id='show lchan summary-all [&lt;0-255&gt;] [&lt;0-255&gt;] [&lt;0-7&gt;] [&lt;0-7&gt;]'>
204 <params>
205 <param name='show' doc='Show running system information' />
206 <param name='lchan' doc='Display information about a logical channel' />
207 <param name='summary-all' doc='Short summary (all lchans)' />
208 <param name='[&lt;0-255&gt;]' doc='BTS Number' />
209 <param name='[&lt;0-255&gt;]' doc='TRX Number' />
210 <param name='[&lt;0-7&gt;]' doc='Timeslot Number' />
211 <param name='[&lt;0-7&gt;]' doc='Logical Channel Number' />
212 </params>
213 </command>
214 <command id='show timer [TNNNN]'>
215 <params>
216 <param name='show' doc='Show running system information' />
217 <param name='timer' doc='Show timers' />
218 <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;.' />
219 </params>
220 </command>
Neels Hofmeyr9f157572018-03-06 14:59:00 +0100221 <command id='show conns'>
222 <params>
223 <param name='show' doc='Show running system information' />
224 <param name='conns' doc='Display currently active subscriber connections' />
225 </params>
226 </command>
Neels Hofmeyr9f157572018-03-06 14:59:00 +0100227 <command id='show paging [&lt;0-255&gt;]'>
228 <params>
229 <param name='show' doc='Show running system information' />
Neels Hofmeyr39e12152018-11-05 02:56:09 +0100230 <param name='paging' doc='Display information about paging requests of a BTS' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +0100231 <param name='[&lt;0-255&gt;]' doc='BTS Number' />
232 </params>
233 </command>
234 <command id='show paging-group &lt;0-255&gt; IMSI'>
235 <params>
236 <param name='show' doc='Show running system information' />
237 <param name='paging-group' doc='Display the paging group' />
238 <param name='&lt;0-255&gt;' doc='BTS Number' />
239 <param name='IMSI' doc='IMSI' />
240 </params>
241 </command>
242 <command id='logging enable'>
243 <params>
244 <param name='logging' doc='Configure logging' />
245 <param name='enable' doc='Enables logging to this vty' />
246 </params>
247 </command>
248 <command id='logging disable'>
249 <params>
250 <param name='logging' doc='Configure logging' />
251 <param name='disable' doc='Disables logging to this vty' />
252 </params>
253 </command>
254 <command id='logging filter all (0|1)'>
255 <params>
256 <param name='logging' doc='Configure logging' />
257 <param name='filter' doc='Filter log messages' />
258 <param name='all' doc='Do you want to log all messages?' />
259 <param name='0' doc='Only print messages matched by other filters' />
260 <param name='1' doc='Bypass filter and print all messages' />
261 </params>
262 </command>
263 <command id='logging color (0|1)'>
264 <params>
265 <param name='logging' doc='Configure logging' />
266 <param name='color' doc='Configure color-printing for log messages' />
267 <param name='0' doc='Don&apos;t use color for printing messages' />
268 <param name='1' doc='Use color for printing messages' />
269 </params>
270 </command>
271 <command id='logging timestamp (0|1)'>
272 <params>
273 <param name='logging' doc='Configure logging' />
274 <param name='timestamp' doc='Configure log message timestamping' />
275 <param name='0' doc='Don&apos;t prefix each log message' />
276 <param name='1' doc='Prefix each log message with current timestamp' />
277 </params>
278 </command>
279 <command id='logging print extended-timestamp (0|1)'>
280 <params>
281 <param name='logging' doc='Configure logging' />
282 <param name='print' doc='Log output settings' />
283 <param name='extended-timestamp' doc='Configure log message timestamping' />
284 <param name='0' doc='Don&apos;t prefix each log message' />
285 <param name='1' doc='Prefix each log message with current timestamp with YYYYMMDDhhmmssnnn' />
286 </params>
287 </command>
288 <command id='logging print category (0|1)'>
289 <params>
290 <param name='logging' doc='Configure logging' />
291 <param name='print' doc='Log output settings' />
292 <param name='category' doc='Configure log message' />
293 <param name='0' doc='Don&apos;t prefix each log message' />
294 <param name='1' doc='Prefix each log message with category/subsystem name' />
295 </params>
296 </command>
297 <command id='logging print category-hex (0|1)'>
298 <params>
299 <param name='logging' doc='Configure logging' />
300 <param name='print' doc='Log output settings' />
301 <param name='category-hex' doc='Configure log message' />
302 <param name='0' doc='Don&apos;t prefix each log message' />
303 <param name='1' doc='Prefix each log message with category/subsystem nr in hex (&apos;&lt;000b&gt;&apos;)' />
304 </params>
305 </command>
306 <command id='logging print level (0|1)'>
307 <params>
308 <param name='logging' doc='Configure logging' />
309 <param name='print' doc='Log output settings' />
310 <param name='level' doc='Configure log message' />
311 <param name='0' doc='Don&apos;t prefix each log message' />
312 <param name='1' doc='Prefix each log message with the log level name' />
313 </params>
314 </command>
Neels Hofmeyr39e12152018-11-05 02:56:09 +0100315 <command id='logging print file (0|1|basename) [last]'>
Neels Hofmeyr9f157572018-03-06 14:59:00 +0100316 <params>
317 <param name='logging' doc='Configure logging' />
318 <param name='print' doc='Log output settings' />
319 <param name='file' doc='Configure log message' />
320 <param name='0' doc='Don&apos;t prefix each log message' />
321 <param name='1' doc='Prefix each log message with the source file and line' />
322 <param name='basename' doc='Prefix each log message with the source file&apos;s basename (strip leading paths) and line' />
Neels Hofmeyr39e12152018-11-05 02:56:09 +0100323 <param name='[last]' doc='Log source file info at the end of a log line. If omitted, log source file info just before the log text.' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +0100324 </params>
325 </command>
326 <command id='logging set-log-mask MASK'>
327 <params>
328 <param name='logging' doc='Configure logging' />
329 <param name='set-log-mask' doc='Set the logmask of this logging target' />
330 <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' />
331 </params>
332 </command>
Vadim Yanitskiyf06b9bf2020-04-05 00:39:45 +0700333 <command id='logging level (rll|mm|rr|rsl|nm|pag|meas|msc|ho|hodec|ref|ctrl|filter|pcu|lcls|chan|ts|as|cbs|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro) (debug|info|notice|error|fatal)'>
Neels Hofmeyr9f157572018-03-06 14:59:00 +0100334 <params>
335 <param name='logging' doc='Configure logging' />
336 <param name='level' doc='Set the log level for a specified category' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +0100337 <param name='rll' doc='A-bis Radio Link Layer (RLL)' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +0100338 <param name='mm' doc='Layer3 Mobility Management (MM)' />
339 <param name='rr' doc='Layer3 Radio Resource (RR)' />
Neels Hofmeyr39e12152018-11-05 02:56:09 +0100340 <param name='rsl' doc='A-bis Radio Signalling Link (RSL)' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +0100341 <param name='nm' doc='A-bis Network Management / O&amp;M (NM/OML)' />
342 <param name='pag' doc='Paging Subsystem' />
343 <param name='meas' doc='Radio Measurement Processing' />
344 <param name='msc' doc='Mobile Switching Center' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +0100345 <param name='ho' doc='Hand-Over Process' />
346 <param name='hodec' doc='Hand-Over Decision' />
347 <param name='ref' doc='Reference Counting' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +0100348 <param name='ctrl' doc='Control interface' />
349 <param name='filter' doc='BSC/NAT IMSI based filtering' />
350 <param name='pcu' doc='PCU Interface' />
Neels Hofmeyr39e12152018-11-05 02:56:09 +0100351 <param name='lcls' doc='Local Call, Local Switch' />
352 <param name='chan' doc='lchan FSM' />
353 <param name='ts' doc='timeslot FSM' />
354 <param name='as' doc='assignment FSM' />
Harald Welted41b7c72019-06-13 09:41:58 +0200355 <param name='cbs' doc='Cell Broadcast System' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +0100356 <param name='lglobal' doc='Library-internal global log family' />
357 <param name='llapd' doc='LAPD in libosmogsm' />
358 <param name='linp' doc='A-bis Intput Subsystem' />
359 <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' />
360 <param name='lmi' doc='A-bis Input Driver for Signalling' />
361 <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' />
362 <param name='lsms' doc='Layer3 Short Message Service (SMS)' />
363 <param name='lctrl' doc='Control Interface' />
364 <param name='lgtp' doc='GPRS GTP library' />
365 <param name='lstats' doc='Statistics messages and logging' />
366 <param name='lgsup' doc='Generic Subscriber Update Protocol' />
367 <param name='loap' doc='Osmocom Authentication Protocol' />
368 <param name='lss7' doc='libosmo-sigtran Signalling System 7' />
369 <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' />
370 <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' />
371 <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' />
372 <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' />
373 <param name='ljibuf' doc='libosmo-netif Jitter Buffer' />
Daniel Willmannf450f442019-06-06 17:52:25 +0200374 <param name='lrspro' doc='Remote SIM protocol' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +0100375 <param name='debug' doc='Log debug messages and higher levels' />
376 <param name='info' doc='Log informational messages and higher levels' />
377 <param name='notice' doc='Log noticeable messages and higher levels' />
378 <param name='error' doc='Log error messages and higher levels' />
379 <param name='fatal' doc='Log only fatal messages' />
380 </params>
381 </command>
Neels Hofmeyr39e12152018-11-05 02:56:09 +0100382 <command id='logging level set-all (debug|info|notice|error|fatal)'>
383 <params>
384 <param name='logging' doc='Configure logging' />
385 <param name='level' doc='Set the log level for a specified category' />
386 <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.' />
387 <param name='debug' doc='Log debug messages and higher levels' />
388 <param name='info' doc='Log informational messages and higher levels' />
389 <param name='notice' doc='Log noticeable messages and higher levels' />
390 <param name='error' doc='Log error messages and higher levels' />
391 <param name='fatal' doc='Log only fatal messages' />
392 </params>
393 </command>
394 <command id='logging level force-all (debug|info|notice|error|fatal)'>
395 <params>
396 <param name='logging' doc='Configure logging' />
397 <param name='level' doc='Set the log level for a specified category' />
398 <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.' />
399 <param name='debug' doc='Log debug messages and higher levels' />
400 <param name='info' doc='Log informational messages and higher levels' />
401 <param name='notice' doc='Log noticeable messages and higher levels' />
402 <param name='error' doc='Log error messages and higher levels' />
403 <param name='fatal' doc='Log only fatal messages' />
404 </params>
405 </command>
406 <command id='no logging level force-all'>
407 <params>
408 <param name='no' doc='Negate a command or set its defaults' />
409 <param name='logging' doc='Configure logging' />
410 <param name='level' doc='Set the log level for a specified category' />
411 <param name='force-all' doc='Release any globally forced log level set with &apos;logging level force-all &lt;level&gt;&apos;' />
412 </params>
413 </command>
Vadim Yanitskiyf06b9bf2020-04-05 00:39:45 +0700414 <command id='logp (rll|mm|rr|rsl|nm|pag|meas|msc|ho|hodec|ref|ctrl|filter|pcu|lcls|chan|ts|as|cbs|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'>
Harald Welte7104ed22019-09-02 10:55:21 +0200415 <params>
416 <param name='logp' doc='Print a message on all log outputs; useful for placing markers in test logs' />
417 <param name='rll' doc='A-bis Radio Link Layer (RLL)' />
418 <param name='mm' doc='Layer3 Mobility Management (MM)' />
419 <param name='rr' doc='Layer3 Radio Resource (RR)' />
420 <param name='rsl' doc='A-bis Radio Signalling Link (RSL)' />
421 <param name='nm' doc='A-bis Network Management / O&amp;M (NM/OML)' />
422 <param name='pag' doc='Paging Subsystem' />
423 <param name='meas' doc='Radio Measurement Processing' />
424 <param name='msc' doc='Mobile Switching Center' />
425 <param name='ho' doc='Hand-Over Process' />
426 <param name='hodec' doc='Hand-Over Decision' />
427 <param name='ref' doc='Reference Counting' />
Harald Welte7104ed22019-09-02 10:55:21 +0200428 <param name='ctrl' doc='Control interface' />
429 <param name='filter' doc='BSC/NAT IMSI based filtering' />
430 <param name='pcu' doc='PCU Interface' />
431 <param name='lcls' doc='Local Call, Local Switch' />
432 <param name='chan' doc='lchan FSM' />
433 <param name='ts' doc='timeslot FSM' />
434 <param name='as' doc='assignment FSM' />
435 <param name='cbs' doc='Cell Broadcast System' />
436 <param name='lglobal' doc='Library-internal global log family' />
437 <param name='llapd' doc='LAPD in libosmogsm' />
438 <param name='linp' doc='A-bis Intput Subsystem' />
439 <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' />
440 <param name='lmi' doc='A-bis Input Driver for Signalling' />
441 <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' />
442 <param name='lsms' doc='Layer3 Short Message Service (SMS)' />
443 <param name='lctrl' doc='Control Interface' />
444 <param name='lgtp' doc='GPRS GTP library' />
445 <param name='lstats' doc='Statistics messages and logging' />
446 <param name='lgsup' doc='Generic Subscriber Update Protocol' />
447 <param name='loap' doc='Osmocom Authentication Protocol' />
448 <param name='lss7' doc='libosmo-sigtran Signalling System 7' />
449 <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' />
450 <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' />
451 <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' />
452 <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' />
453 <param name='ljibuf' doc='libosmo-netif Jitter Buffer' />
454 <param name='lrspro' doc='Remote SIM protocol' />
455 <param name='debug' doc='Log debug messages and higher levels' />
456 <param name='info' doc='Log informational messages and higher levels' />
457 <param name='notice' doc='Log noticeable messages and higher levels' />
458 <param name='error' doc='Log error messages and higher levels' />
459 <param name='fatal' doc='Log only fatal messages' />
460 <param name='.LOGMESSAGE' doc='Arbitrary message to log on given category and log level' />
461 </params>
462 </command>
Neels Hofmeyr9f157572018-03-06 14:59:00 +0100463 <command id='show logging vty'>
464 <params>
465 <param name='show' doc='Show running system information' />
466 <param name='logging' doc='Show current logging configuration' />
467 <param name='vty' doc='Show current logging configuration for this vty' />
468 </params>
469 </command>
470 <command id='show alarms'>
471 <params>
472 <param name='show' doc='Show running system information' />
473 <param name='alarms' doc='Show current logging configuration' />
474 </params>
475 </command>
476 <command id='show talloc-context (application|all) (full|brief|DEPTH)'>
477 <params>
478 <param name='show' doc='Show running system information' />
479 <param name='talloc-context' doc='Show talloc memory hierarchy' />
480 <param name='application' doc='Application&apos;s context' />
481 <param name='all' doc='All contexts, if NULL-context tracking is enabled' />
482 <param name='full' doc='Display a full talloc memory hierarchy' />
483 <param name='brief' doc='Display a brief talloc memory hierarchy' />
484 <param name='DEPTH' doc='Specify required maximal depth value' />
485 </params>
486 </command>
487 <command id='show talloc-context (application|all) (full|brief|DEPTH) tree ADDRESS'>
488 <params>
489 <param name='show' doc='Show running system information' />
490 <param name='talloc-context' doc='Show talloc memory hierarchy' />
491 <param name='application' doc='Application&apos;s context' />
492 <param name='all' doc='All contexts, if NULL-context tracking is enabled' />
493 <param name='full' doc='Display a full talloc memory hierarchy' />
494 <param name='brief' doc='Display a brief talloc memory hierarchy' />
495 <param name='DEPTH' doc='Specify required maximal depth value' />
496 <param name='tree' doc='Display only a specific memory chunk' />
497 <param name='ADDRESS' doc='Chunk address (e.g. 0xdeadbeef)' />
498 </params>
499 </command>
500 <command id='show talloc-context (application|all) (full|brief|DEPTH) filter REGEXP'>
501 <params>
502 <param name='show' doc='Show running system information' />
503 <param name='talloc-context' doc='Show talloc memory hierarchy' />
504 <param name='application' doc='Application&apos;s context' />
505 <param name='all' doc='All contexts, if NULL-context tracking is enabled' />
506 <param name='full' doc='Display a full talloc memory hierarchy' />
507 <param name='brief' doc='Display a brief talloc memory hierarchy' />
508 <param name='DEPTH' doc='Specify required maximal depth value' />
509 <param name='filter' doc='Filter chunks using regular expression' />
510 <param name='REGEXP' doc='Regular expression' />
511 </params>
512 </command>
Neels Hofmeyr39e12152018-11-05 02:56:09 +0100513 <command id='show bts &lt;0-255&gt; neighbor arfcn &lt;0-1023&gt; bsic (&lt;0-63&gt;|any)'>
514 <params>
515 <param name='show' doc='Show running system information' />
516 <param name='bts' doc='Display information about a BTS' />
517 <param name='&lt;0-255&gt;' doc='BTS number' />
518 <param name='neighbor' doc='Query which cell would be the target for this neighbor ARFCN+BSIC' />
519 <param name='arfcn' doc='ARFCN of neighbor cell' />
520 <param name='&lt;0-1023&gt;' doc='ARFCN value' />
521 <param name='bsic' doc='BSIC of neighbor cell' />
522 <param name='&lt;0-63&gt;' doc='BSIC value' />
523 <param name='any' doc='for all BSICs / use any BSIC in this ARFCN' />
524 </params>
525 </command>
Neels Hofmeyr9f157572018-03-06 14:59:00 +0100526 <command id='show e1_driver'>
527 <params>
528 <param name='show' doc='Show running system information' />
529 <param name='e1_driver' doc='Display information about available E1 drivers' />
530 </params>
531 </command>
532 <command id='show e1_line [line_nr] [stats]'>
533 <params>
534 <param name='show' doc='Show running system information' />
535 <param name='e1_line' doc='Display information about a E1 line' />
536 <param name='[line_nr]' doc='E1 Line Number' />
537 <param name='[stats]' doc='Include statistics' />
538 </params>
539 </command>
540 <command id='show e1_timeslot [line_nr] [ts_nr]'>
541 <params>
542 <param name='show' doc='Show running system information' />
543 <param name='e1_timeslot' doc='Display information about a E1 timeslot' />
544 <param name='[line_nr]' doc='E1 Line Number' />
545 <param name='[ts_nr]' doc='E1 Timeslot Number' />
546 </params>
547 </command>
548 <command id='show fsm NAME'>
549 <params>
550 <param name='show' doc='Show running system information' />
551 <param name='fsm' doc='Show information about finite state machines' />
552 <param name='NAME' doc='Display information about a single named finite state machine' />
553 </params>
554 </command>
555 <command id='show fsm all'>
556 <params>
557 <param name='show' doc='Show running system information' />
558 <param name='fsm' doc='Show information about finite state machines' />
559 <param name='all' doc='Display a list of all registered finite state machines' />
560 </params>
561 </command>
562 <command id='show fsm-instances NAME'>
563 <params>
564 <param name='show' doc='Show running system information' />
565 <param name='fsm-instances' doc='Show information about finite state machine instances' />
566 <param name='NAME' doc='Display a list of all FSM instances of the named finite state machine' />
567 </params>
568 </command>
569 <command id='show fsm-instances all'>
570 <params>
571 <param name='show' doc='Show running system information' />
572 <param name='fsm-instances' doc='Show information about finite state machine instances' />
573 <param name='all' doc='Display a list of all FSM instances of all finite state machine' />
574 </params>
575 </command>
Harald Welted41b7c72019-06-13 09:41:58 +0200576 <command id='show cbc'>
577 <params>
578 <param name='show' doc='Show running system information' />
579 <param name='cbc' doc='Display state of CBC / CBSP' />
580 </params>
581 </command>
582 <command id='show bts &lt;0-255&gt; smscb [(basic|extended)]'>
583 <params>
584 <param name='show' doc='Show running system information' />
585 <param name='bts' doc='Display information about a BTS' />
586 <param name='&lt;0-255&gt;' doc='BTS number' />
587 <param name='smscb' doc='SMS Cell Broadcast State' />
588 <param name='[basic]' doc='Show only information related to CBCH BASIC' />
589 <param name='[extended]' doc='Show only information related to CBCH EXTENDED' />
590 </params>
591 </command>
Neels Hofmeyr9f157572018-03-06 14:59:00 +0100592 <command id='show statistics'>
593 <params>
594 <param name='show' doc='Show running system information' />
595 <param name='statistics' doc='Statistics about the BSC' />
596 </params>
597 </command>
598 <command id='show mscs'>
599 <params>
600 <param name='show' doc='Show running system information' />
601 <param name='mscs' doc='MSC Connections and State' />
602 </params>
603 </command>
604 <command id='show position'>
605 <params>
606 <param name='show' doc='Show running system information' />
607 <param name='position' doc='Position information of the BTS' />
608 </params>
609 </command>
610 <command id='logging filter imsi IMSI'>
611 <params>
612 <param name='logging' doc='Configure logging' />
613 <param name='filter' doc='Filter log messages' />
614 <param name='imsi' doc='Filter log messages by IMSI' />
615 <param name='IMSI' doc='IMSI to be used as filter' />
616 </params>
617 </command>
618 <command id='show subscriber all'>
619 <params>
620 <param name='show' doc='Show running system information' />
621 <param name='subscriber' doc='Display information about subscribers' />
622 <param name='all' doc='All Subscribers' />
623 </params>
624 </command>
625 <command id='show access-list NAME'>
626 <params>
627 <param name='show' doc='Show running system information' />
628 <param name='access-list' doc='IMSI access list' />
629 <param name='NAME' doc='Name of the access list' />
630 </params>
631 </command>
632 <command id='show cs7 instance &lt;0-15&gt; users'>
633 <params>
634 <param name='show' doc='Show running system information' />
635 <param name='cs7' doc='ITU-T Signaling System 7' />
636 <param name='instance' doc='An instance of the SS7 stack' />
637 <param name='&lt;0-15&gt;' doc='An instance of the SS7 stack' />
638 <param name='users' doc='User Table' />
639 </params>
640 </command>
641 <command id='show cs7 (sua|m3ua|ipa) [&lt;0-65534&gt;]'>
642 <params>
643 <param name='show' doc='Show running system information' />
644 <param name='cs7' doc='ITU-T Signaling System 7' />
645 <param name='sua' doc='SCCP User Adaptation' />
646 <param name='m3ua' doc='MTP3 User Adaptation' />
647 <param name='ipa' doc='IPA Multiplex (SCCP Lite)' />
648 <param name='[&lt;0-65534&gt;]' doc='Port Number' />
649 </params>
650 </command>
Oliver Smithb5bfa712020-03-27 10:29:51 +0100651 <command id='show cs7 config'>
652 <params>
653 <param name='show' doc='Show running system information' />
654 <param name='cs7' doc='ITU-T Signaling System 7' />
655 <param name='config' doc='Currently running cs7 configuration' />
656 </params>
657 </command>
Neels Hofmeyr9f157572018-03-06 14:59:00 +0100658 <command id='show cs7 instance &lt;0-15&gt; asp'>
659 <params>
660 <param name='show' doc='Show running system information' />
661 <param name='cs7' doc='ITU-T Signaling System 7' />
662 <param name='instance' doc='An instance of the SS7 stack' />
663 <param name='&lt;0-15&gt;' doc='An instance of the SS7 stack' />
664 <param name='asp' doc='Application Server Process (ASP)' />
665 </params>
666 </command>
667 <command id='show cs7 instance &lt;0-15&gt; as (active|all|m3ua|sua)'>
668 <params>
669 <param name='show' doc='Show running system information' />
670 <param name='cs7' doc='ITU-T Signaling System 7' />
671 <param name='instance' doc='An instance of the SS7 stack' />
672 <param name='&lt;0-15&gt;' doc='An instance of the SS7 stack' />
673 <param name='as' doc='Application Server (AS)' />
674 <param name='active' doc='Display all active ASs' />
675 <param name='all' doc='Display all ASs (default)' />
676 <param name='m3ua' doc='Display all m3ua ASs' />
677 <param name='sua' doc='Display all SUA ASs' />
678 </params>
679 </command>
Neels Hofmeyr39e12152018-11-05 02:56:09 +0100680 <command id='show cs7 instance &lt;0-15&gt; sccp addressbook'>
681 <params>
682 <param name='show' doc='Show running system information' />
683 <param name='cs7' doc='ITU-T Signaling System 7' />
684 <param name='instance' doc='An instance of the SS7 stack' />
685 <param name='&lt;0-15&gt;' doc='An instance of the SS7 stack' />
686 <param name='sccp' doc='Signalling Connection Control Part' />
687 <param name='addressbook' doc='List all SCCP addressbook entries' />
688 </params>
689 </command>
690 <command id='show cs7 instance &lt;0-15&gt; sccp users'>
691 <params>
692 <param name='show' doc='Show running system information' />
693 <param name='cs7' doc='ITU-T Signaling System 7' />
694 <param name='instance' doc='An instance of the SS7 stack' />
695 <param name='&lt;0-15&gt;' doc='An instance of the SS7 stack' />
696 <param name='sccp' doc='Signalling Connection Control Part' />
697 <param name='users' doc='Show List of SCCP Users registered' />
698 </params>
699 </command>
700 <command id='show cs7 instance &lt;0-15&gt; sccp ssn &lt;0-65535&gt;'>
701 <params>
702 <param name='show' doc='Show running system information' />
703 <param name='cs7' doc='ITU-T Signaling System 7' />
704 <param name='instance' doc='An instance of the SS7 stack' />
705 <param name='&lt;0-15&gt;' doc='An instance of the SS7 stack' />
706 <param name='sccp' doc='Signalling Connection Control Part' />
707 <param name='ssn' doc='Find an SCCP User registered for the given SSN' />
708 <param name='&lt;0-65535&gt;' doc='Subsystem Number (SSN)' />
709 </params>
710 </command>
711 <command id='show cs7 instance &lt;0-15&gt; sccp connections'>
712 <params>
713 <param name='show' doc='Show running system information' />
714 <param name='cs7' doc='ITU-T Signaling System 7' />
715 <param name='instance' doc='An instance of the SS7 stack' />
716 <param name='&lt;0-15&gt;' doc='An instance of the SS7 stack' />
717 <param name='sccp' doc='Signalling Connection Control Part' />
718 <param name='connections' doc='Show List of active SCCP connections' />
719 </params>
720 </command>
721 <command id='show cs7 instance &lt;0-15&gt; sccp timers'>
722 <params>
723 <param name='show' doc='Show running system information' />
724 <param name='cs7' doc='ITU-T Signaling System 7' />
725 <param name='instance' doc='An instance of the SS7 stack' />
726 <param name='&lt;0-15&gt;' doc='An instance of the SS7 stack' />
727 <param name='sccp' doc='Signaling Connection Control Part' />
728 <param name='timers' doc='Show List of SCCP timers' />
729 </params>
730 </command>
Neels Hofmeyr9f157572018-03-06 14:59:00 +0100731 </node>
732 <node id='enable'>
733 <name>enable</name>
734 <command id='disable'>
735 <params>
736 <param name='disable' doc='Turn off privileged mode command' />
737 </params>
738 </command>
739 <command id='configure terminal'>
740 <params>
741 <param name='configure' doc='Configuration from vty interface' />
742 <param name='terminal' doc='Configuration terminal' />
743 </params>
744 </command>
745 <command id='copy running-config startup-config'>
746 <params>
747 <param name='copy' doc='Copy configuration' />
748 <param name='running-config' doc='Copy running config to... ' />
749 <param name='startup-config' doc='Copy running config to startup config (same as write file)' />
750 </params>
751 </command>
752 <command id='show startup-config'>
753 <params>
754 <param name='show' doc='Show running system information' />
755 <param name='startup-config' doc='Contentes of startup configuration' />
756 </params>
757 </command>
758 <command id='show version'>
759 <params>
760 <param name='show' doc='Show running system information' />
761 <param name='version' doc='Displays program version' />
762 </params>
763 </command>
764 <command id='show online-help'>
765 <params>
766 <param name='show' doc='Show running system information' />
767 <param name='online-help' doc='Online help' />
768 </params>
769 </command>
770 <command id='terminal length &lt;0-512&gt;'>
771 <params>
772 <param name='terminal' doc='Set terminal line parameters' />
773 <param name='length' doc='Set number of lines on a screen' />
774 <param name='&lt;0-512&gt;' doc='Number of lines on screen (0 for no pausing)' />
775 </params>
776 </command>
777 <command id='terminal no length'>
778 <params>
779 <param name='terminal' doc='Set terminal line parameters' />
780 <param name='no' doc='Negate a command or set its defaults' />
781 <param name='length' doc='Set number of lines on a screen' />
782 </params>
783 </command>
Neels Hofmeyr9f157572018-03-06 14:59:00 +0100784 <command id='who'>
785 <params>
786 <param name='who' doc='Display who is on vty' />
787 </params>
788 </command>
789 <command id='show history'>
790 <params>
791 <param name='show' doc='Show running system information' />
792 <param name='history' doc='Display the session command history' />
793 </params>
794 </command>
795 <command id='terminal monitor'>
796 <params>
797 <param name='terminal' doc='Set terminal line parameters' />
798 <param name='monitor' doc='Copy debug output to the current terminal line' />
799 </params>
800 </command>
801 <command id='terminal no monitor'>
802 <params>
803 <param name='terminal' doc='Set terminal line parameters' />
804 <param name='no' doc='Negate a command or set its defaults' />
805 <param name='monitor' doc='Copy debug output to the current terminal line' />
806 </params>
807 </command>
808 <command id='show stats'>
809 <params>
810 <param name='show' doc='Show running system information' />
811 <param name='stats' doc='Show statistical values' />
812 </params>
813 </command>
814 <command id='show stats level (global|peer|subscriber)'>
815 <params>
816 <param name='show' doc='Show running system information' />
817 <param name='stats' doc='Show statistical values' />
818 <param name='level' doc='Set the maximum group level' />
819 <param name='global' doc='Show global groups only' />
820 <param name='peer' doc='Show global and network peer related groups' />
821 <param name='subscriber' doc='Show global, peer, and subscriber groups' />
822 </params>
823 </command>
824 <command id='show asciidoc counters'>
825 <params>
826 <param name='show' doc='Show running system information' />
827 <param name='asciidoc' doc='Asciidoc generation' />
828 <param name='counters' doc='Generate table of all registered counters' />
829 </params>
830 </command>
Neels Hofmeyr39e12152018-11-05 02:56:09 +0100831 <command id='show rate-counters'>
832 <params>
833 <param name='show' doc='Show running system information' />
834 <param name='rate-counters' doc='Show all rate counters' />
835 </params>
836 </command>
Neels Hofmeyr9f157572018-03-06 14:59:00 +0100837 <command id='show network'>
838 <params>
839 <param name='show' doc='Show running system information' />
840 <param name='network' doc='Display information about a GSM NETWORK' />
841 </params>
842 </command>
843 <command id='show bts [&lt;0-255&gt;]'>
844 <params>
845 <param name='show' doc='Show running system information' />
846 <param name='bts' doc='Display information about a BTS' />
847 <param name='[&lt;0-255&gt;]' doc='BTS number' />
848 </params>
849 </command>
Oliver Smithb5bfa712020-03-27 10:29:51 +0100850 <command id='show bts &lt;0-255&gt; fail-rep [reset]'>
851 <params>
852 <param name='show' doc='Show running system information' />
853 <param name='bts' doc='Display information about a BTS' />
854 <param name='&lt;0-255&gt;' doc='BTS number' />
855 <param name='fail-rep' doc='OML failure reports' />
856 <param name='[reset]' doc='Clear the list of failure reports after showing them' />
857 </params>
858 </command>
Neels Hofmeyr39e12152018-11-05 02:56:09 +0100859 <command id='show rejected-bts'>
860 <params>
861 <param name='show' doc='Show running system information' />
862 <param name='rejected-bts' doc='Display recently rejected BTS devices' />
863 </params>
864 </command>
Neels Hofmeyr9f157572018-03-06 14:59:00 +0100865 <command id='show trx [&lt;0-255&gt;] [&lt;0-255&gt;]'>
866 <params>
867 <param name='show' doc='Show running system information' />
868 <param name='trx' doc='Display information about a TRX' />
869 <param name='[&lt;0-255&gt;]' doc='BTS Number' />
870 <param name='[&lt;0-255&gt;]' doc='TRX Number' />
871 </params>
872 </command>
Daniel Willmannf450f442019-06-06 17:52:25 +0200873 <command id='show trx (connected|disconnected)'>
874 <params>
875 <param name='show' doc='Show running system information' />
876 <param name='trx' doc='Display information about a TRX' />
877 <param name='connected' doc='Show TRX with RSL connected' />
878 <param name='disconnected' doc='Show TRX with RSL disconnected' />
879 </params>
880 </command>
Neels Hofmeyr9f157572018-03-06 14:59:00 +0100881 <command id='show timeslot [&lt;0-255&gt;] [&lt;0-255&gt;] [&lt;0-7&gt;]'>
882 <params>
883 <param name='show' doc='Show running system information' />
884 <param name='timeslot' doc='Display information about a TS' />
885 <param name='[&lt;0-255&gt;]' doc='BTS Number' />
886 <param name='[&lt;0-255&gt;]' doc='TRX Number' />
887 <param name='[&lt;0-7&gt;]' doc='Timeslot Number' />
888 </params>
889 </command>
890 <command id='show lchan [&lt;0-255&gt;] [&lt;0-255&gt;] [&lt;0-7&gt;] [&lt;0-7&gt;]'>
891 <params>
892 <param name='show' doc='Show running system information' />
893 <param name='lchan' doc='Display information about a logical channel' />
894 <param name='[&lt;0-255&gt;]' doc='BTS Number' />
895 <param name='[&lt;0-255&gt;]' doc='TRX Number' />
896 <param name='[&lt;0-7&gt;]' doc='Timeslot Number' />
897 <param name='[&lt;0-7&gt;]' doc='Logical Channel Number' />
898 </params>
899 </command>
900 <command id='show lchan summary [&lt;0-255&gt;] [&lt;0-255&gt;] [&lt;0-7&gt;] [&lt;0-7&gt;]'>
901 <params>
902 <param name='show' doc='Show running system information' />
903 <param name='lchan' doc='Display information about a logical channel' />
Daniel Willmannf450f442019-06-06 17:52:25 +0200904 <param name='summary' doc='Short summary (used lchans)' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +0100905 <param name='[&lt;0-255&gt;]' doc='BTS Number' />
906 <param name='[&lt;0-255&gt;]' doc='TRX Number' />
907 <param name='[&lt;0-7&gt;]' doc='Timeslot Number' />
908 <param name='[&lt;0-7&gt;]' doc='Logical Channel Number' />
909 </params>
910 </command>
Daniel Willmannf450f442019-06-06 17:52:25 +0200911 <command id='show lchan summary-all [&lt;0-255&gt;] [&lt;0-255&gt;] [&lt;0-7&gt;] [&lt;0-7&gt;]'>
912 <params>
913 <param name='show' doc='Show running system information' />
914 <param name='lchan' doc='Display information about a logical channel' />
915 <param name='summary-all' doc='Short summary (all lchans)' />
916 <param name='[&lt;0-255&gt;]' doc='BTS Number' />
917 <param name='[&lt;0-255&gt;]' doc='TRX Number' />
918 <param name='[&lt;0-7&gt;]' doc='Timeslot Number' />
919 <param name='[&lt;0-7&gt;]' doc='Logical Channel Number' />
920 </params>
921 </command>
922 <command id='show timer [TNNNN]'>
923 <params>
924 <param name='show' doc='Show running system information' />
925 <param name='timer' doc='Show timers' />
926 <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;.' />
927 </params>
928 </command>
Neels Hofmeyr9f157572018-03-06 14:59:00 +0100929 <command id='show conns'>
930 <params>
931 <param name='show' doc='Show running system information' />
932 <param name='conns' doc='Display currently active subscriber connections' />
933 </params>
934 </command>
Neels Hofmeyr39e12152018-11-05 02:56:09 +0100935 <command id='show paging [&lt;0-255&gt;]'>
936 <params>
937 <param name='show' doc='Show running system information' />
938 <param name='paging' doc='Display information about paging requests of a BTS' />
939 <param name='[&lt;0-255&gt;]' doc='BTS Number' />
940 </params>
941 </command>
942 <command id='show paging-group &lt;0-255&gt; IMSI'>
943 <params>
944 <param name='show' doc='Show running system information' />
945 <param name='paging-group' doc='Display the paging group' />
946 <param name='&lt;0-255&gt;' doc='BTS Number' />
947 <param name='IMSI' doc='IMSI' />
948 </params>
949 </command>
Neels Hofmeyr9f157572018-03-06 14:59:00 +0100950 <command id='handover any'>
951 <params>
952 <param name='handover' doc='Manually trigger handover (for debugging)' />
953 <param name='any' doc='Pick any actively used TCH/F or TCH/H lchan and handover to any other BTS. This is likely to fail if not all BTS are guaranteed to be reachable by the MS.' />
954 </params>
955 </command>
956 <command id='assignment any'>
957 <params>
958 <param name='assignment' doc='Manually trigger assignment (for debugging)' />
959 <param name='any' doc='Pick any actively used TCH/F or TCH/H lchan and re-assign within the same BTS. This will fail if no lchans of the same type are available besides the used one.' />
960 </params>
961 </command>
Neels Hofmeyr39e12152018-11-05 02:56:09 +0100962 <command id='handover any to arfcn &lt;0-1023&gt; bsic (&lt;0-63&gt;|any)'>
Neels Hofmeyr9f157572018-03-06 14:59:00 +0100963 <params>
Neels Hofmeyr39e12152018-11-05 02:56:09 +0100964 <param name='handover' doc='Manually trigger handover (for debugging)' />
965 <param name='any' doc='Pick any actively used TCH/F or TCH/H lchan to handover to another cell. This is likely to fail outside of a lab setup where you are certain that all MS are able to see the target cell.' />
966 <param name='to' doc='&apos;to&apos;' />
967 <param name='arfcn' doc='ARFCN of neighbor cell' />
968 <param name='&lt;0-1023&gt;' doc='ARFCN value' />
969 <param name='bsic' doc='BSIC of neighbor cell' />
970 <param name='&lt;0-63&gt;' doc='BSIC value' />
971 <param name='any' doc='for all BSICs / use any BSIC in this ARFCN' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +0100972 </params>
973 </command>
974 <command id='logging enable'>
975 <params>
976 <param name='logging' doc='Configure logging' />
977 <param name='enable' doc='Enables logging to this vty' />
978 </params>
979 </command>
980 <command id='logging disable'>
981 <params>
982 <param name='logging' doc='Configure logging' />
983 <param name='disable' doc='Disables logging to this vty' />
984 </params>
985 </command>
986 <command id='logging filter all (0|1)'>
987 <params>
988 <param name='logging' doc='Configure logging' />
989 <param name='filter' doc='Filter log messages' />
990 <param name='all' doc='Do you want to log all messages?' />
991 <param name='0' doc='Only print messages matched by other filters' />
992 <param name='1' doc='Bypass filter and print all messages' />
993 </params>
994 </command>
995 <command id='logging color (0|1)'>
996 <params>
997 <param name='logging' doc='Configure logging' />
998 <param name='color' doc='Configure color-printing for log messages' />
999 <param name='0' doc='Don&apos;t use color for printing messages' />
1000 <param name='1' doc='Use color for printing messages' />
1001 </params>
1002 </command>
1003 <command id='logging timestamp (0|1)'>
1004 <params>
1005 <param name='logging' doc='Configure logging' />
1006 <param name='timestamp' doc='Configure log message timestamping' />
1007 <param name='0' doc='Don&apos;t prefix each log message' />
1008 <param name='1' doc='Prefix each log message with current timestamp' />
1009 </params>
1010 </command>
1011 <command id='logging print extended-timestamp (0|1)'>
1012 <params>
1013 <param name='logging' doc='Configure logging' />
1014 <param name='print' doc='Log output settings' />
1015 <param name='extended-timestamp' doc='Configure log message timestamping' />
1016 <param name='0' doc='Don&apos;t prefix each log message' />
1017 <param name='1' doc='Prefix each log message with current timestamp with YYYYMMDDhhmmssnnn' />
1018 </params>
1019 </command>
1020 <command id='logging print category (0|1)'>
1021 <params>
1022 <param name='logging' doc='Configure logging' />
1023 <param name='print' doc='Log output settings' />
1024 <param name='category' doc='Configure log message' />
1025 <param name='0' doc='Don&apos;t prefix each log message' />
1026 <param name='1' doc='Prefix each log message with category/subsystem name' />
1027 </params>
1028 </command>
1029 <command id='logging print category-hex (0|1)'>
1030 <params>
1031 <param name='logging' doc='Configure logging' />
1032 <param name='print' doc='Log output settings' />
1033 <param name='category-hex' doc='Configure log message' />
1034 <param name='0' doc='Don&apos;t prefix each log message' />
1035 <param name='1' doc='Prefix each log message with category/subsystem nr in hex (&apos;&lt;000b&gt;&apos;)' />
1036 </params>
1037 </command>
1038 <command id='logging print level (0|1)'>
1039 <params>
1040 <param name='logging' doc='Configure logging' />
1041 <param name='print' doc='Log output settings' />
1042 <param name='level' doc='Configure log message' />
1043 <param name='0' doc='Don&apos;t prefix each log message' />
1044 <param name='1' doc='Prefix each log message with the log level name' />
1045 </params>
1046 </command>
Neels Hofmeyr39e12152018-11-05 02:56:09 +01001047 <command id='logging print file (0|1|basename) [last]'>
Neels Hofmeyr9f157572018-03-06 14:59:00 +01001048 <params>
1049 <param name='logging' doc='Configure logging' />
1050 <param name='print' doc='Log output settings' />
1051 <param name='file' doc='Configure log message' />
1052 <param name='0' doc='Don&apos;t prefix each log message' />
1053 <param name='1' doc='Prefix each log message with the source file and line' />
1054 <param name='basename' doc='Prefix each log message with the source file&apos;s basename (strip leading paths) and line' />
Neels Hofmeyr39e12152018-11-05 02:56:09 +01001055 <param name='[last]' doc='Log source file info at the end of a log line. If omitted, log source file info just before the log text.' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01001056 </params>
1057 </command>
1058 <command id='logging set-log-mask MASK'>
1059 <params>
1060 <param name='logging' doc='Configure logging' />
1061 <param name='set-log-mask' doc='Set the logmask of this logging target' />
1062 <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' />
1063 </params>
1064 </command>
Vadim Yanitskiyf06b9bf2020-04-05 00:39:45 +07001065 <command id='logging level (rll|mm|rr|rsl|nm|pag|meas|msc|ho|hodec|ref|ctrl|filter|pcu|lcls|chan|ts|as|cbs|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro) (debug|info|notice|error|fatal)'>
Neels Hofmeyr9f157572018-03-06 14:59:00 +01001066 <params>
1067 <param name='logging' doc='Configure logging' />
1068 <param name='level' doc='Set the log level for a specified category' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01001069 <param name='rll' doc='A-bis Radio Link Layer (RLL)' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01001070 <param name='mm' doc='Layer3 Mobility Management (MM)' />
1071 <param name='rr' doc='Layer3 Radio Resource (RR)' />
Neels Hofmeyr39e12152018-11-05 02:56:09 +01001072 <param name='rsl' doc='A-bis Radio Signalling Link (RSL)' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01001073 <param name='nm' doc='A-bis Network Management / O&amp;M (NM/OML)' />
1074 <param name='pag' doc='Paging Subsystem' />
1075 <param name='meas' doc='Radio Measurement Processing' />
1076 <param name='msc' doc='Mobile Switching Center' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01001077 <param name='ho' doc='Hand-Over Process' />
1078 <param name='hodec' doc='Hand-Over Decision' />
1079 <param name='ref' doc='Reference Counting' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01001080 <param name='ctrl' doc='Control interface' />
1081 <param name='filter' doc='BSC/NAT IMSI based filtering' />
1082 <param name='pcu' doc='PCU Interface' />
Neels Hofmeyr39e12152018-11-05 02:56:09 +01001083 <param name='lcls' doc='Local Call, Local Switch' />
1084 <param name='chan' doc='lchan FSM' />
1085 <param name='ts' doc='timeslot FSM' />
1086 <param name='as' doc='assignment FSM' />
Harald Welted41b7c72019-06-13 09:41:58 +02001087 <param name='cbs' doc='Cell Broadcast System' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01001088 <param name='lglobal' doc='Library-internal global log family' />
1089 <param name='llapd' doc='LAPD in libosmogsm' />
1090 <param name='linp' doc='A-bis Intput Subsystem' />
1091 <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' />
1092 <param name='lmi' doc='A-bis Input Driver for Signalling' />
1093 <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' />
1094 <param name='lsms' doc='Layer3 Short Message Service (SMS)' />
1095 <param name='lctrl' doc='Control Interface' />
1096 <param name='lgtp' doc='GPRS GTP library' />
1097 <param name='lstats' doc='Statistics messages and logging' />
1098 <param name='lgsup' doc='Generic Subscriber Update Protocol' />
1099 <param name='loap' doc='Osmocom Authentication Protocol' />
1100 <param name='lss7' doc='libosmo-sigtran Signalling System 7' />
1101 <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' />
1102 <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' />
1103 <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' />
1104 <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' />
1105 <param name='ljibuf' doc='libosmo-netif Jitter Buffer' />
Daniel Willmannf450f442019-06-06 17:52:25 +02001106 <param name='lrspro' doc='Remote SIM protocol' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01001107 <param name='debug' doc='Log debug messages and higher levels' />
1108 <param name='info' doc='Log informational messages and higher levels' />
1109 <param name='notice' doc='Log noticeable messages and higher levels' />
1110 <param name='error' doc='Log error messages and higher levels' />
1111 <param name='fatal' doc='Log only fatal messages' />
1112 </params>
1113 </command>
Neels Hofmeyr39e12152018-11-05 02:56:09 +01001114 <command id='logging level set-all (debug|info|notice|error|fatal)'>
1115 <params>
1116 <param name='logging' doc='Configure logging' />
1117 <param name='level' doc='Set the log level for a specified category' />
1118 <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.' />
1119 <param name='debug' doc='Log debug messages and higher levels' />
1120 <param name='info' doc='Log informational messages and higher levels' />
1121 <param name='notice' doc='Log noticeable messages and higher levels' />
1122 <param name='error' doc='Log error messages and higher levels' />
1123 <param name='fatal' doc='Log only fatal messages' />
1124 </params>
1125 </command>
1126 <command id='logging level force-all (debug|info|notice|error|fatal)'>
1127 <params>
1128 <param name='logging' doc='Configure logging' />
1129 <param name='level' doc='Set the log level for a specified category' />
1130 <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.' />
1131 <param name='debug' doc='Log debug messages and higher levels' />
1132 <param name='info' doc='Log informational messages and higher levels' />
1133 <param name='notice' doc='Log noticeable messages and higher levels' />
1134 <param name='error' doc='Log error messages and higher levels' />
1135 <param name='fatal' doc='Log only fatal messages' />
1136 </params>
1137 </command>
1138 <command id='no logging level force-all'>
1139 <params>
1140 <param name='no' doc='Negate a command or set its defaults' />
1141 <param name='logging' doc='Configure logging' />
1142 <param name='level' doc='Set the log level for a specified category' />
1143 <param name='force-all' doc='Release any globally forced log level set with &apos;logging level force-all &lt;level&gt;&apos;' />
1144 </params>
1145 </command>
Vadim Yanitskiyf06b9bf2020-04-05 00:39:45 +07001146 <command id='logp (rll|mm|rr|rsl|nm|pag|meas|msc|ho|hodec|ref|ctrl|filter|pcu|lcls|chan|ts|as|cbs|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'>
Harald Welte7104ed22019-09-02 10:55:21 +02001147 <params>
1148 <param name='logp' doc='Print a message on all log outputs; useful for placing markers in test logs' />
1149 <param name='rll' doc='A-bis Radio Link Layer (RLL)' />
1150 <param name='mm' doc='Layer3 Mobility Management (MM)' />
1151 <param name='rr' doc='Layer3 Radio Resource (RR)' />
1152 <param name='rsl' doc='A-bis Radio Signalling Link (RSL)' />
1153 <param name='nm' doc='A-bis Network Management / O&amp;M (NM/OML)' />
1154 <param name='pag' doc='Paging Subsystem' />
1155 <param name='meas' doc='Radio Measurement Processing' />
1156 <param name='msc' doc='Mobile Switching Center' />
1157 <param name='ho' doc='Hand-Over Process' />
1158 <param name='hodec' doc='Hand-Over Decision' />
1159 <param name='ref' doc='Reference Counting' />
Harald Welte7104ed22019-09-02 10:55:21 +02001160 <param name='ctrl' doc='Control interface' />
1161 <param name='filter' doc='BSC/NAT IMSI based filtering' />
1162 <param name='pcu' doc='PCU Interface' />
1163 <param name='lcls' doc='Local Call, Local Switch' />
1164 <param name='chan' doc='lchan FSM' />
1165 <param name='ts' doc='timeslot FSM' />
1166 <param name='as' doc='assignment FSM' />
1167 <param name='cbs' doc='Cell Broadcast System' />
1168 <param name='lglobal' doc='Library-internal global log family' />
1169 <param name='llapd' doc='LAPD in libosmogsm' />
1170 <param name='linp' doc='A-bis Intput Subsystem' />
1171 <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' />
1172 <param name='lmi' doc='A-bis Input Driver for Signalling' />
1173 <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' />
1174 <param name='lsms' doc='Layer3 Short Message Service (SMS)' />
1175 <param name='lctrl' doc='Control Interface' />
1176 <param name='lgtp' doc='GPRS GTP library' />
1177 <param name='lstats' doc='Statistics messages and logging' />
1178 <param name='lgsup' doc='Generic Subscriber Update Protocol' />
1179 <param name='loap' doc='Osmocom Authentication Protocol' />
1180 <param name='lss7' doc='libosmo-sigtran Signalling System 7' />
1181 <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' />
1182 <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' />
1183 <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' />
1184 <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' />
1185 <param name='ljibuf' doc='libosmo-netif Jitter Buffer' />
1186 <param name='lrspro' doc='Remote SIM protocol' />
1187 <param name='debug' doc='Log debug messages and higher levels' />
1188 <param name='info' doc='Log informational messages and higher levels' />
1189 <param name='notice' doc='Log noticeable messages and higher levels' />
1190 <param name='error' doc='Log error messages and higher levels' />
1191 <param name='fatal' doc='Log only fatal messages' />
1192 <param name='.LOGMESSAGE' doc='Arbitrary message to log on given category and log level' />
1193 </params>
1194 </command>
Neels Hofmeyr9f157572018-03-06 14:59:00 +01001195 <command id='show logging vty'>
1196 <params>
1197 <param name='show' doc='Show running system information' />
1198 <param name='logging' doc='Show current logging configuration' />
1199 <param name='vty' doc='Show current logging configuration for this vty' />
1200 </params>
1201 </command>
1202 <command id='show alarms'>
1203 <params>
1204 <param name='show' doc='Show running system information' />
1205 <param name='alarms' doc='Show current logging configuration' />
1206 </params>
1207 </command>
1208 <command id='show talloc-context (application|all) (full|brief|DEPTH)'>
1209 <params>
1210 <param name='show' doc='Show running system information' />
1211 <param name='talloc-context' doc='Show talloc memory hierarchy' />
1212 <param name='application' doc='Application&apos;s context' />
1213 <param name='all' doc='All contexts, if NULL-context tracking is enabled' />
1214 <param name='full' doc='Display a full talloc memory hierarchy' />
1215 <param name='brief' doc='Display a brief talloc memory hierarchy' />
1216 <param name='DEPTH' doc='Specify required maximal depth value' />
1217 </params>
1218 </command>
1219 <command id='show talloc-context (application|all) (full|brief|DEPTH) tree ADDRESS'>
1220 <params>
1221 <param name='show' doc='Show running system information' />
1222 <param name='talloc-context' doc='Show talloc memory hierarchy' />
1223 <param name='application' doc='Application&apos;s context' />
1224 <param name='all' doc='All contexts, if NULL-context tracking is enabled' />
1225 <param name='full' doc='Display a full talloc memory hierarchy' />
1226 <param name='brief' doc='Display a brief talloc memory hierarchy' />
1227 <param name='DEPTH' doc='Specify required maximal depth value' />
1228 <param name='tree' doc='Display only a specific memory chunk' />
1229 <param name='ADDRESS' doc='Chunk address (e.g. 0xdeadbeef)' />
1230 </params>
1231 </command>
1232 <command id='show talloc-context (application|all) (full|brief|DEPTH) filter REGEXP'>
1233 <params>
1234 <param name='show' doc='Show running system information' />
1235 <param name='talloc-context' doc='Show talloc memory hierarchy' />
1236 <param name='application' doc='Application&apos;s context' />
1237 <param name='all' doc='All contexts, if NULL-context tracking is enabled' />
1238 <param name='full' doc='Display a full talloc memory hierarchy' />
1239 <param name='brief' doc='Display a brief talloc memory hierarchy' />
1240 <param name='DEPTH' doc='Specify required maximal depth value' />
1241 <param name='filter' doc='Filter chunks using regular expression' />
1242 <param name='REGEXP' doc='Regular expression' />
1243 </params>
1244 </command>
Neels Hofmeyr39e12152018-11-05 02:56:09 +01001245 <command id='show bts &lt;0-255&gt; neighbor arfcn &lt;0-1023&gt; bsic (&lt;0-63&gt;|any)'>
1246 <params>
1247 <param name='show' doc='Show running system information' />
1248 <param name='bts' doc='Display information about a BTS' />
1249 <param name='&lt;0-255&gt;' doc='BTS number' />
1250 <param name='neighbor' doc='Query which cell would be the target for this neighbor ARFCN+BSIC' />
1251 <param name='arfcn' doc='ARFCN of neighbor cell' />
1252 <param name='&lt;0-1023&gt;' doc='ARFCN value' />
1253 <param name='bsic' doc='BSIC of neighbor cell' />
1254 <param name='&lt;0-63&gt;' doc='BSIC value' />
1255 <param name='any' doc='for all BSICs / use any BSIC in this ARFCN' />
1256 </params>
1257 </command>
Neels Hofmeyr9f157572018-03-06 14:59:00 +01001258 <command id='drop bts connection &lt;0-65535&gt; (oml|rsl)'>
1259 <params>
1260 <param name='drop' doc='Debug/Simulation command to drop Abis/IP BTS' />
1261 <param name='bts' doc='Debug/Simulation command to drop Abis/IP BTS' />
1262 <param name='connection' doc='Debug/Simulation command to drop Abis/IP BTS' />
1263 <param name='&lt;0-65535&gt;' doc='BTS NR' />
1264 <param name='oml' doc='Drop OML Connection' />
1265 <param name='rsl' doc='Drop RSL Connection' />
1266 </params>
1267 </command>
1268 <command id='restart-bts &lt;0-65535&gt;'>
1269 <params>
1270 <param name='restart-bts' doc='Restart ip.access nanoBTS through OML' />
1271 <param name='&lt;0-65535&gt;' doc='BTS Number' />
1272 </params>
1273 </command>
1274 <command id='bts &lt;0-255&gt; resend-system-information'>
1275 <params>
1276 <param name='bts' doc='BTS Specific Commands' />
1277 <param name='&lt;0-255&gt;' doc='BTS Number' />
1278 <param name='resend-system-information' doc='Re-generate + re-send BCCH SYSTEM INFORMATION' />
1279 </params>
1280 </command>
1281 <command id='bts &lt;0-255&gt; trx &lt;0-255&gt; timeslot &lt;0-7&gt; pdch (activate|deactivate)'>
1282 <params>
1283 <param name='bts' doc='BTS for manual command' />
1284 <param name='&lt;0-255&gt;' doc='BTS Number' />
1285 <param name='trx' doc='TRX for manual command' />
1286 <param name='&lt;0-255&gt;' doc='TRX Number' />
1287 <param name='timeslot' doc='Timeslot for manual command' />
1288 <param name='&lt;0-7&gt;' doc='Timeslot Number' />
1289 <param name='pdch' doc='Packet Data Channel' />
1290 <param name='activate' doc='Activate Dynamic PDCH/TCH (-&gt; PDCH mode)' />
1291 <param name='deactivate' doc='Deactivate Dynamic PDCH/TCH (-&gt; TCH mode)' />
1292 </params>
1293 </command>
1294 <command id='bts &lt;0-255&gt; trx &lt;0-255&gt; timeslot &lt;0-7&gt; sub-slot &lt;0-7&gt; (activate|deactivate) (hr|fr|efr|amr) [&lt;0-7&gt;]'>
1295 <params>
1296 <param name='bts' doc='BTS for manual command' />
1297 <param name='&lt;0-255&gt;' doc='BTS Number' />
1298 <param name='trx' doc='TRX for manual command' />
1299 <param name='&lt;0-255&gt;' doc='TRX Number' />
1300 <param name='timeslot' doc='Timeslot for manual command' />
1301 <param name='&lt;0-7&gt;' doc='Timeslot Number' />
1302 <param name='sub-slot' doc='Sub-slot for manual command' />
1303 <param name='&lt;0-7&gt;' doc='Sub-slot Number' />
1304 <param name='activate' doc='Manual Channel Activation (e.g. for BER test)' />
1305 <param name='deactivate' doc='Manual Channel Deactivation (e.g. for BER test)' />
1306 <param name='hr' doc='Half-Rate v1' />
1307 <param name='fr' doc='Full-Rate' />
1308 <param name='efr' doc='Enhanced Full Rate' />
1309 <param name='amr' doc='Adaptive Multi-Rate' />
1310 <param name='[&lt;0-7&gt;]' doc='AMR Mode' />
1311 </params>
1312 </command>
1313 <command id='bts &lt;0-255&gt; trx &lt;0-255&gt; timeslot &lt;0-7&gt; sub-slot &lt;0-7&gt; mdcx A.B.C.D &lt;0-65535&gt;'>
1314 <params>
1315 <param name='bts' doc='BTS for manual command' />
1316 <param name='&lt;0-255&gt;' doc='BTS Number' />
1317 <param name='trx' doc='TRX for manual command' />
1318 <param name='&lt;0-255&gt;' doc='TRX Number' />
1319 <param name='timeslot' doc='Timeslot for manual command' />
1320 <param name='&lt;0-7&gt;' doc='Timeslot Number' />
1321 <param name='sub-slot' doc='Sub-slot for manual command' />
1322 <param name='&lt;0-7&gt;' doc='Sub-slot Number' />
1323 <param name='mdcx' doc='Modify RTP Connection' />
1324 <param name='A.B.C.D' doc='MGW IP Address' />
1325 <param name='&lt;0-65535&gt;' doc='MGW UDP Port' />
1326 </params>
1327 </command>
1328 <command id='bts &lt;0-255&gt; trx &lt;0-255&gt; timeslot &lt;0-7&gt; sub-slot &lt;0-7&gt; handover &lt;0-255&gt;'>
1329 <params>
1330 <param name='bts' doc='BTS for manual command' />
1331 <param name='&lt;0-255&gt;' doc='BTS Number' />
1332 <param name='trx' doc='TRX for manual command' />
1333 <param name='&lt;0-255&gt;' doc='TRX Number' />
1334 <param name='timeslot' doc='Timeslot for manual command' />
1335 <param name='&lt;0-7&gt;' doc='Timeslot Number' />
1336 <param name='sub-slot' doc='Sub-slot for manual command' />
1337 <param name='&lt;0-7&gt;' doc='Sub-slot Number' />
1338 <param name='handover' doc='Manually trigger handover (for debugging)' />
1339 <param name='&lt;0-255&gt;' doc='New BTS Number' />
1340 </params>
1341 </command>
1342 <command id='bts &lt;0-255&gt; trx &lt;0-255&gt; timeslot &lt;0-7&gt; sub-slot &lt;0-7&gt; assignment'>
1343 <params>
1344 <param name='bts' doc='BTS for manual command' />
1345 <param name='&lt;0-255&gt;' doc='BTS Number' />
1346 <param name='trx' doc='TRX for manual command' />
1347 <param name='&lt;0-255&gt;' doc='TRX Number' />
1348 <param name='timeslot' doc='Timeslot for manual command' />
1349 <param name='&lt;0-7&gt;' doc='Timeslot Number' />
1350 <param name='sub-slot' doc='Sub-slot for manual command' />
1351 <param name='&lt;0-7&gt;' doc='Sub-slot Number' />
1352 <param name='assignment' doc='Manually trigger assignment (for debugging)' />
1353 </params>
1354 </command>
Daniel Willmannf450f442019-06-06 17:52:25 +02001355 <command id='bts &lt;0-255&gt; smscb-command (normal|schedule|default) &lt;1-4&gt; HEXSTRING'>
Neels Hofmeyr9f157572018-03-06 14:59:00 +01001356 <params>
1357 <param name='bts' doc='BTS related commands' />
1358 <param name='&lt;0-255&gt;' doc='BTS Number' />
1359 <param name='smscb-command' doc='SMS Cell Broadcast' />
Daniel Willmannf450f442019-06-06 17:52:25 +02001360 <param name='normal' doc='Normal (one-shot) SMSCB Message; sent once over Abis+Um' />
Martin Haukea29affd2019-11-13 22:10:41 +01001361 <param name='schedule' doc='Schedule (one-shot) SMSCB Message; sent once over Abis+Um' />
Daniel Willmannf450f442019-06-06 17:52:25 +02001362 <param name='default' doc='Default (repeating) SMSCB Message; sent once over Abis, unlimited ovrer Um' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01001363 <param name='&lt;1-4&gt;' doc='Last Valid Block' />
1364 <param name='HEXSTRING' doc='Hex Encoded SMSCB message (up to 88 octets)' />
1365 </params>
1366 </command>
1367 <command id='ctrl-interface generate-trap TRAP VALUE'>
1368 <params>
1369 <param name='ctrl-interface' doc='Commands related to the CTRL Interface' />
1370 <param name='generate-trap' doc='Generate a TRAP for test purpose' />
1371 <param name='TRAP' doc='Identity/Name of the TRAP variable' />
1372 <param name='VALUE' doc='Value of the TRAP variable' />
1373 </params>
1374 </command>
1375 <command id='bts &lt;0-255&gt; oml class (site-manager|bts|radio-carrier|baseband-transceiver|channel|adjc|handover|power-contorl|btse|rack|test|envabtse|bport|gprs-nse|gprs-cell|gprs-nsvc|siemenshw) instance &lt;0-255&gt; &lt;0-255&gt; &lt;0-255&gt;'>
1376 <params>
1377 <param name='bts' doc='BTS related commands' />
1378 <param name='&lt;0-255&gt;' doc='BTS Number' />
1379 <param name='oml' doc='Manipulate the OML managed objects' />
1380 <param name='class' doc='Object Class' />
1381 <param name='site-manager' doc='Site Manager Object' />
1382 <param name='bts' doc='BTS Object' />
1383 <param name='radio-carrier' doc='Radio Carrier Object' />
1384 <param name='baseband-transceiver' doc='Baseband Transceiver Object' />
1385 <param name='channel' doc='Channel (Timeslot) Object' />
1386 <param name='adjc' doc='Adjacent Object (Siemens)' />
1387 <param name='handover' doc='Handover Object (Siemens)' />
1388 <param name='power-contorl' doc='Power Control Object (Siemens)' />
1389 <param name='btse' doc='BTSE Object (Siemens)' />
1390 <param name='rack' doc='Rack Object (Siemens)' />
1391 <param name='test' doc='Test Object (Siemens)' />
1392 <param name='envabtse' doc='ENVABTSE Object (Siemens)' />
1393 <param name='bport' doc='BPORT Object (Siemens)' />
1394 <param name='gprs-nse' doc='GPRS NSE Object (ip.access/osmo-bts)' />
1395 <param name='gprs-cell' doc='GPRS Cell Object (ip.acecss/osmo-bts)' />
1396 <param name='gprs-nsvc' doc='GPRS NSVC Object (ip.acecss/osmo-bts)' />
1397 <param name='siemenshw' doc='SIEMENSHW Object (Siemens)' />
1398 <param name='instance' doc='Object Instance' />
1399 <param name='&lt;0-255&gt;' doc='BTS Number' />
1400 <param name='&lt;0-255&gt;' doc='TRX Number' />
1401 <param name='&lt;0-255&gt;' doc='TS Number' />
1402 </params>
1403 </command>
1404 <command id='bts &lt;0-255&gt; oml class &lt;0-255&gt; instance &lt;0-255&gt; &lt;0-255&gt; &lt;0-255&gt;'>
1405 <params>
1406 <param name='bts' doc='BTS related commands' />
1407 <param name='&lt;0-255&gt;' doc='BTS Number' />
1408 <param name='oml' doc='Manipulate the OML managed objects' />
1409 <param name='class' doc='Object Class' />
1410 <param name='&lt;0-255&gt;' doc='Object Class' />
1411 <param name='instance' doc='Object Instance' />
1412 <param name='&lt;0-255&gt;' doc='BTS Number' />
1413 <param name='&lt;0-255&gt;' doc='TRX Number' />
1414 <param name='&lt;0-255&gt;' doc='TS Number' />
1415 </params>
1416 </command>
1417 <command id='bts &lt;0-255&gt; om2000 class (trxc|ts|tf|is|con|dp|cf|tx|rx) &lt;0-255&gt; &lt;0-255&gt; &lt;0-255&gt;'>
1418 <params>
1419 <param name='bts' doc='BTS related commands' />
1420 <param name='&lt;0-255&gt;' doc='BTS Number' />
1421 <param name='om2000' doc='Manipulate the OM2000 managed objects' />
1422 <param name='class' doc='Object Class' />
1423 <param name='trxc' doc='TRX Controller' />
1424 <param name='ts' doc='Timeslot' />
1425 <param name='tf' doc='Timing Function' />
1426 <param name='is' doc='Interface Switch' />
1427 <param name='con' doc='Abis Concentrator' />
1428 <param name='dp' doc='Digital Path' />
1429 <param name='cf' doc='Central Function' />
1430 <param name='tx' doc='Transmitter' />
1431 <param name='rx' doc='Receiver' />
1432 <param name='&lt;0-255&gt;' doc='BTS Number' />
1433 <param name='&lt;0-255&gt;' doc='Associated SO Instance' />
1434 <param name='&lt;0-255&gt;' doc='Instance Number' />
1435 </params>
1436 </command>
1437 <command id='bts &lt;0-255&gt; om2000 class &lt;0-255&gt; &lt;0-255&gt; &lt;0-255&gt; &lt;0-255&gt;'>
1438 <params>
1439 <param name='bts' doc='BTS related commands' />
1440 <param name='&lt;0-255&gt;' doc='BTS Number' />
1441 <param name='om2000' doc='Manipulate the OML managed objects' />
1442 <param name='class' doc='Object Class' />
1443 <param name='&lt;0-255&gt;' doc='Object Class' />
1444 <param name='&lt;0-255&gt;' doc='BTS Number' />
1445 <param name='&lt;0-255&gt;' doc='Associated SO Instance' />
1446 <param name='&lt;0-255&gt;' doc='Instance Number' />
1447 </params>
1448 </command>
1449 <command id='show e1_driver'>
1450 <params>
1451 <param name='show' doc='Show running system information' />
1452 <param name='e1_driver' doc='Display information about available E1 drivers' />
1453 </params>
1454 </command>
1455 <command id='show e1_line [line_nr] [stats]'>
1456 <params>
1457 <param name='show' doc='Show running system information' />
1458 <param name='e1_line' doc='Display information about a E1 line' />
1459 <param name='[line_nr]' doc='E1 Line Number' />
1460 <param name='[stats]' doc='Include statistics' />
1461 </params>
1462 </command>
1463 <command id='show e1_timeslot [line_nr] [ts_nr]'>
1464 <params>
1465 <param name='show' doc='Show running system information' />
1466 <param name='e1_timeslot' doc='Display information about a E1 timeslot' />
1467 <param name='[line_nr]' doc='E1 Line Number' />
1468 <param name='[ts_nr]' doc='E1 Timeslot Number' />
1469 </params>
1470 </command>
1471 <command id='show fsm NAME'>
1472 <params>
1473 <param name='show' doc='Show running system information' />
1474 <param name='fsm' doc='Show information about finite state machines' />
1475 <param name='NAME' doc='Display information about a single named finite state machine' />
1476 </params>
1477 </command>
1478 <command id='show fsm all'>
1479 <params>
1480 <param name='show' doc='Show running system information' />
1481 <param name='fsm' doc='Show information about finite state machines' />
1482 <param name='all' doc='Display a list of all registered finite state machines' />
1483 </params>
1484 </command>
1485 <command id='show fsm-instances NAME'>
1486 <params>
1487 <param name='show' doc='Show running system information' />
1488 <param name='fsm-instances' doc='Show information about finite state machine instances' />
1489 <param name='NAME' doc='Display a list of all FSM instances of the named finite state machine' />
1490 </params>
1491 </command>
1492 <command id='show fsm-instances all'>
1493 <params>
1494 <param name='show' doc='Show running system information' />
1495 <param name='fsm-instances' doc='Show information about finite state machine instances' />
1496 <param name='all' doc='Display a list of all FSM instances of all finite state machine' />
1497 </params>
1498 </command>
Harald Welted41b7c72019-06-13 09:41:58 +02001499 <command id='show bts &lt;0-255&gt; smscb [(basic|extended)]'>
1500 <params>
1501 <param name='show' doc='Show running system information' />
1502 <param name='bts' doc='Display information about a BTS' />
1503 <param name='&lt;0-255&gt;' doc='BTS number' />
1504 <param name='smscb' doc='SMS Cell Broadcast State' />
1505 <param name='[basic]' doc='Show only information related to CBCH BASIC' />
1506 <param name='[extended]' doc='Show only information related to CBCH EXTENDED' />
1507 </params>
1508 </command>
Neels Hofmeyr9f157572018-03-06 14:59:00 +01001509 <command id='show statistics'>
1510 <params>
1511 <param name='show' doc='Show running system information' />
1512 <param name='statistics' doc='Statistics about the BSC' />
1513 </params>
1514 </command>
1515 <command id='show mscs'>
1516 <params>
1517 <param name='show' doc='Show running system information' />
1518 <param name='mscs' doc='MSC Connections and State' />
1519 </params>
1520 </command>
1521 <command id='show position'>
1522 <params>
1523 <param name='show' doc='Show running system information' />
1524 <param name='position' doc='Position information of the BTS' />
1525 </params>
1526 </command>
1527 <command id='logging filter imsi IMSI'>
1528 <params>
1529 <param name='logging' doc='Configure logging' />
1530 <param name='filter' doc='Filter log messages' />
1531 <param name='imsi' doc='Filter log messages by IMSI' />
1532 <param name='IMSI' doc='IMSI to be used as filter' />
1533 </params>
1534 </command>
1535 <command id='show subscriber all'>
1536 <params>
1537 <param name='show' doc='Show running system information' />
1538 <param name='subscriber' doc='Display information about subscribers' />
1539 <param name='all' doc='All Subscribers' />
1540 </params>
1541 </command>
1542 <command id='generate-location-state-trap &lt;0-255&gt;'>
1543 <params>
1544 <param name='generate-location-state-trap' doc='Generate location state report' />
1545 <param name='&lt;0-255&gt;' doc='BTS to report' />
1546 </params>
1547 </command>
1548 <command id='show access-list NAME'>
1549 <params>
1550 <param name='show' doc='Show running system information' />
1551 <param name='access-list' doc='IMSI access list' />
1552 <param name='NAME' doc='Name of the access list' />
1553 </params>
1554 </command>
1555 <command id='show cs7 instance &lt;0-15&gt; users'>
1556 <params>
1557 <param name='show' doc='Show running system information' />
1558 <param name='cs7' doc='ITU-T Signaling System 7' />
1559 <param name='instance' doc='An instance of the SS7 stack' />
1560 <param name='&lt;0-15&gt;' doc='An instance of the SS7 stack' />
1561 <param name='users' doc='User Table' />
1562 </params>
1563 </command>
1564 <command id='show cs7 (sua|m3ua|ipa) [&lt;0-65534&gt;]'>
1565 <params>
1566 <param name='show' doc='Show running system information' />
1567 <param name='cs7' doc='ITU-T Signaling System 7' />
1568 <param name='sua' doc='SCCP User Adaptation' />
1569 <param name='m3ua' doc='MTP3 User Adaptation' />
1570 <param name='ipa' doc='IPA Multiplex (SCCP Lite)' />
1571 <param name='[&lt;0-65534&gt;]' doc='Port Number' />
1572 </params>
1573 </command>
Oliver Smithb5bfa712020-03-27 10:29:51 +01001574 <command id='show cs7 config'>
1575 <params>
1576 <param name='show' doc='Show running system information' />
1577 <param name='cs7' doc='ITU-T Signaling System 7' />
1578 <param name='config' doc='Currently running cs7 configuration' />
1579 </params>
1580 </command>
Neels Hofmeyr9f157572018-03-06 14:59:00 +01001581 <command id='show cs7 instance &lt;0-15&gt; asp'>
1582 <params>
1583 <param name='show' doc='Show running system information' />
1584 <param name='cs7' doc='ITU-T Signaling System 7' />
1585 <param name='instance' doc='An instance of the SS7 stack' />
1586 <param name='&lt;0-15&gt;' doc='An instance of the SS7 stack' />
1587 <param name='asp' doc='Application Server Process (ASP)' />
1588 </params>
1589 </command>
1590 <command id='show cs7 instance &lt;0-15&gt; as (active|all|m3ua|sua)'>
1591 <params>
1592 <param name='show' doc='Show running system information' />
1593 <param name='cs7' doc='ITU-T Signaling System 7' />
1594 <param name='instance' doc='An instance of the SS7 stack' />
1595 <param name='&lt;0-15&gt;' doc='An instance of the SS7 stack' />
1596 <param name='as' doc='Application Server (AS)' />
1597 <param name='active' doc='Display all active ASs' />
1598 <param name='all' doc='Display all ASs (default)' />
1599 <param name='m3ua' doc='Display all m3ua ASs' />
1600 <param name='sua' doc='Display all SUA ASs' />
1601 </params>
1602 </command>
Neels Hofmeyr39e12152018-11-05 02:56:09 +01001603 <command id='show cs7 instance &lt;0-15&gt; sccp addressbook'>
1604 <params>
1605 <param name='show' doc='Show running system information' />
1606 <param name='cs7' doc='ITU-T Signaling System 7' />
1607 <param name='instance' doc='An instance of the SS7 stack' />
1608 <param name='&lt;0-15&gt;' doc='An instance of the SS7 stack' />
1609 <param name='sccp' doc='Signalling Connection Control Part' />
1610 <param name='addressbook' doc='List all SCCP addressbook entries' />
1611 </params>
1612 </command>
1613 <command id='show cs7 instance &lt;0-15&gt; sccp users'>
1614 <params>
1615 <param name='show' doc='Show running system information' />
1616 <param name='cs7' doc='ITU-T Signaling System 7' />
1617 <param name='instance' doc='An instance of the SS7 stack' />
1618 <param name='&lt;0-15&gt;' doc='An instance of the SS7 stack' />
1619 <param name='sccp' doc='Signalling Connection Control Part' />
1620 <param name='users' doc='Show List of SCCP Users registered' />
1621 </params>
1622 </command>
1623 <command id='show cs7 instance &lt;0-15&gt; sccp ssn &lt;0-65535&gt;'>
1624 <params>
1625 <param name='show' doc='Show running system information' />
1626 <param name='cs7' doc='ITU-T Signaling System 7' />
1627 <param name='instance' doc='An instance of the SS7 stack' />
1628 <param name='&lt;0-15&gt;' doc='An instance of the SS7 stack' />
1629 <param name='sccp' doc='Signalling Connection Control Part' />
1630 <param name='ssn' doc='Find an SCCP User registered for the given SSN' />
1631 <param name='&lt;0-65535&gt;' doc='Subsystem Number (SSN)' />
1632 </params>
1633 </command>
1634 <command id='show cs7 instance &lt;0-15&gt; sccp connections'>
1635 <params>
1636 <param name='show' doc='Show running system information' />
1637 <param name='cs7' doc='ITU-T Signaling System 7' />
1638 <param name='instance' doc='An instance of the SS7 stack' />
1639 <param name='&lt;0-15&gt;' doc='An instance of the SS7 stack' />
1640 <param name='sccp' doc='Signalling Connection Control Part' />
1641 <param name='connections' doc='Show List of active SCCP connections' />
1642 </params>
1643 </command>
1644 <command id='show cs7 instance &lt;0-15&gt; sccp timers'>
1645 <params>
1646 <param name='show' doc='Show running system information' />
1647 <param name='cs7' doc='ITU-T Signaling System 7' />
1648 <param name='instance' doc='An instance of the SS7 stack' />
1649 <param name='&lt;0-15&gt;' doc='An instance of the SS7 stack' />
1650 <param name='sccp' doc='Signaling Connection Control Part' />
1651 <param name='timers' doc='Show List of SCCP timers' />
1652 </params>
1653 </command>
Neels Hofmeyr9f157572018-03-06 14:59:00 +01001654 </node>
1655 <node id='config'>
1656 <name>config</name>
1657 <command id='hostname WORD'>
1658 <params>
1659 <param name='hostname' doc='Set system&apos;s network name' />
1660 <param name='WORD' doc='This system&apos;s network name' />
1661 </params>
1662 </command>
1663 <command id='no hostname [HOSTNAME]'>
1664 <params>
1665 <param name='no' doc='Negate a command or set its defaults' />
1666 <param name='hostname' doc='Reset system&apos;s network name' />
1667 <param name='[HOSTNAME]' doc='Host name of this router' />
1668 </params>
1669 </command>
1670 <command id='password (8|) WORD'>
1671 <params>
1672 <param name='password' doc='Assign the terminal connection password' />
1673 <param name='8' doc='Specifies a HIDDEN password will follow' />
1674 <param name='' doc='dummy string ' />
1675 <param name='WORD' doc='The HIDDEN line password string' />
1676 </params>
1677 </command>
1678 <command id='password LINE'>
1679 <params>
1680 <param name='password' doc='Assign the terminal connection password' />
1681 <param name='LINE' doc='The UNENCRYPTED (cleartext) line password' />
1682 </params>
1683 </command>
1684 <command id='enable password (8|) WORD'>
1685 <params>
1686 <param name='enable' doc='Modify enable password parameters' />
1687 <param name='password' doc='Assign the privileged level password' />
1688 <param name='8' doc='Specifies a HIDDEN password will follow' />
1689 <param name='' doc='dummy string ' />
1690 <param name='WORD' doc='The HIDDEN &apos;enable&apos; password string' />
1691 </params>
1692 </command>
1693 <command id='enable password LINE'>
1694 <params>
1695 <param name='enable' doc='Modify enable password parameters' />
1696 <param name='password' doc='Assign the privileged level password' />
1697 <param name='LINE' doc='The UNENCRYPTED (cleartext) &apos;enable&apos; password' />
1698 </params>
1699 </command>
1700 <command id='no enable password'>
1701 <params>
1702 <param name='no' doc='Negate a command or set its defaults' />
1703 <param name='enable' doc='Modify enable password parameters' />
1704 <param name='password' doc='Assign the privileged level password' />
1705 </params>
1706 </command>
1707 <command id='banner motd default'>
1708 <params>
1709 <param name='banner' doc='Set banner string' />
1710 <param name='motd' doc='Strings for motd' />
1711 <param name='default' doc='Default string' />
1712 </params>
1713 </command>
1714 <command id='banner motd file [FILE]'>
1715 <params>
1716 <param name='banner' doc='Set banner' />
1717 <param name='motd' doc='Banner for motd' />
1718 <param name='file' doc='Banner from a file' />
1719 <param name='[FILE]' doc='Filename' />
1720 </params>
1721 </command>
1722 <command id='no banner motd'>
1723 <params>
1724 <param name='no' doc='Negate a command or set its defaults' />
1725 <param name='banner' doc='Set banner string' />
1726 <param name='motd' doc='Strings for motd' />
1727 </params>
1728 </command>
1729 <command id='service terminal-length &lt;0-512&gt;'>
1730 <params>
1731 <param name='service' doc='Set up miscellaneous service' />
1732 <param name='terminal-length' doc='System wide terminal length configuration' />
1733 <param name='&lt;0-512&gt;' doc='Number of lines of VTY (0 means no line control)' />
1734 </params>
1735 </command>
1736 <command id='no service terminal-length [&lt;0-512&gt;]'>
1737 <params>
1738 <param name='no' doc='Negate a command or set its defaults' />
1739 <param name='service' doc='Set up miscellaneous service' />
1740 <param name='terminal-length' doc='System wide terminal length configuration' />
1741 <param name='[&lt;0-512&gt;]' doc='Number of lines of VTY (0 means no line control)' />
1742 </params>
1743 </command>
1744 <command id='line vty'>
1745 <params>
1746 <param name='line' doc='Configure a terminal line' />
1747 <param name='vty' doc='Virtual terminal' />
1748 </params>
1749 </command>
1750 <command id='service advanced-vty'>
1751 <params>
1752 <param name='service' doc='Set up miscellaneous service' />
1753 <param name='advanced-vty' doc='Enable advanced mode vty interface' />
1754 </params>
1755 </command>
1756 <command id='no service advanced-vty'>
1757 <params>
1758 <param name='no' doc='Negate a command or set its defaults' />
1759 <param name='service' doc='Set up miscellaneous service' />
1760 <param name='advanced-vty' doc='Enable advanced mode vty interface' />
1761 </params>
1762 </command>
1763 <command id='show history'>
1764 <params>
1765 <param name='show' doc='Show running system information' />
1766 <param name='history' doc='Display the session command history' />
1767 </params>
1768 </command>
1769 <command id='stats reporter statsd'>
1770 <params>
1771 <param name='stats' doc='Configure stats sub-system' />
1772 <param name='reporter' doc='Configure a stats reporter' />
1773 <param name='statsd' doc='Report to a STATSD server' />
1774 </params>
1775 </command>
1776 <command id='no stats reporter statsd'>
1777 <params>
1778 <param name='no' doc='Negate a command or set its defaults' />
1779 <param name='stats' doc='Configure stats sub-system' />
1780 <param name='reporter' doc='Configure a stats reporter' />
1781 <param name='statsd' doc='Report to a STATSD server' />
1782 </params>
1783 </command>
1784 <command id='stats reporter log'>
1785 <params>
1786 <param name='stats' doc='Configure stats sub-system' />
1787 <param name='reporter' doc='Configure a stats reporter' />
1788 <param name='log' doc='Report to the logger' />
1789 </params>
1790 </command>
1791 <command id='no stats reporter log'>
1792 <params>
1793 <param name='no' doc='Negate a command or set its defaults' />
1794 <param name='stats' doc='Configure stats sub-system' />
1795 <param name='reporter' doc='Configure a stats reporter' />
1796 <param name='log' doc='Report to the logger' />
1797 </params>
1798 </command>
1799 <command id='stats interval &lt;1-65535&gt;'>
1800 <params>
1801 <param name='stats' doc='Configure stats sub-system' />
1802 <param name='interval' doc='Set the reporting interval' />
1803 <param name='&lt;1-65535&gt;' doc='Interval in seconds' />
1804 </params>
1805 </command>
1806 <command id='network'>
1807 <params>
1808 <param name='network' doc='Configure the GSM network' />
1809 </params>
1810 </command>
1811 <command id='log stderr'>
1812 <params>
1813 <param name='log' doc='Configure logging sub-system' />
1814 <param name='stderr' doc='Logging via STDERR of the process' />
1815 </params>
1816 </command>
1817 <command id='no log stderr'>
1818 <params>
1819 <param name='no' doc='Negate a command or set its defaults' />
1820 <param name='log' doc='Configure logging sub-system' />
1821 <param name='stderr' doc='Logging via STDERR of the process' />
1822 </params>
1823 </command>
1824 <command id='log file .FILENAME'>
1825 <params>
1826 <param name='log' doc='Configure logging sub-system' />
1827 <param name='file' doc='Logging to text file' />
1828 <param name='.FILENAME' doc='Filename' />
1829 </params>
1830 </command>
1831 <command id='no log file .FILENAME'>
1832 <params>
1833 <param name='no' doc='Negate a command or set its defaults' />
1834 <param name='log' doc='Configure logging sub-system' />
1835 <param name='file' doc='Logging to text file' />
1836 <param name='.FILENAME' doc='Filename' />
1837 </params>
1838 </command>
1839 <command id='log alarms &lt;2-32700&gt;'>
1840 <params>
1841 <param name='log' doc='Configure logging sub-system' />
1842 <param name='alarms' doc='Logging alarms to osmo_strrb' />
1843 <param name='&lt;2-32700&gt;' doc='Maximum number of messages to log' />
1844 </params>
1845 </command>
1846 <command id='no log alarms'>
1847 <params>
1848 <param name='no' doc='Negate a command or set its defaults' />
1849 <param name='log' doc='Configure logging sub-system' />
1850 <param name='alarms' doc='Logging alarms to osmo_strrb' />
1851 </params>
1852 </command>
1853 <command id='log syslog (authpriv|cron|daemon|ftp|lpr|mail|news|user|uucp)'>
1854 <params>
1855 <param name='log' doc='Configure logging sub-system' />
1856 <param name='syslog' doc='Logging via syslog' />
1857 <param name='authpriv' doc='Security/authorization messages facility' />
1858 <param name='cron' doc='Clock daemon (cron/at) facility' />
1859 <param name='daemon' doc='General system daemon facility' />
1860 <param name='ftp' doc='Ftp daemon facility' />
1861 <param name='lpr' doc='Line printer facility' />
1862 <param name='mail' doc='Mail facility' />
1863 <param name='news' doc='News facility' />
1864 <param name='user' doc='Generic facility' />
1865 <param name='uucp' doc='UUCP facility' />
1866 </params>
1867 </command>
1868 <command id='log syslog local &lt;0-7&gt;'>
1869 <params>
1870 <param name='log' doc='Configure logging sub-system' />
1871 <param name='syslog' doc='Logging via syslog' />
1872 <param name='local' doc='Syslog LOCAL facility' />
1873 <param name='&lt;0-7&gt;' doc='Local facility number' />
1874 </params>
1875 </command>
1876 <command id='no log syslog'>
1877 <params>
1878 <param name='no' doc='Negate a command or set its defaults' />
1879 <param name='log' doc='Configure logging sub-system' />
1880 <param name='syslog' doc='Logging via syslog' />
1881 </params>
1882 </command>
1883 <command id='log gsmtap [HOSTNAME]'>
1884 <params>
1885 <param name='log' doc='Configure logging sub-system' />
1886 <param name='gsmtap' doc='Logging via GSMTAP' />
1887 <param name='[HOSTNAME]' doc='Host name to send the GSMTAP logging to (UDP port 4729)' />
1888 </params>
1889 </command>
1890 <command id='e1_input'>
1891 <params>
1892 <param name='e1_input' doc='Configure E1/T1/J1 TDM input' />
1893 </params>
1894 </command>
Harald Welted41b7c72019-06-13 09:41:58 +02001895 <command id='cbc'>
1896 <params>
1897 <param name='cbc' doc='Configure CBSP Link to Cell Broadcast Centre' />
1898 </params>
1899 </command>
Neels Hofmeyr9f157572018-03-06 14:59:00 +01001900 <command id='msc [&lt;0-1000&gt;]'>
1901 <params>
1902 <param name='msc' doc='Configure MSC details' />
1903 <param name='[&lt;0-1000&gt;]' doc='MSC connection to configure' />
1904 </params>
1905 </command>
1906 <command id='bsc'>
1907 <params>
1908 <param name='bsc' doc='Configure BSC' />
1909 </params>
1910 </command>
1911 <command id='ctrl'>
1912 <params>
1913 <param name='ctrl' doc='Configure the Control Interface' />
1914 </params>
1915 </command>
1916 <command id='cs7 instance &lt;0-15&gt;'>
1917 <params>
1918 <param name='cs7' doc='ITU-T Signaling System 7' />
1919 <param name='instance' doc='Configure a SS7 Instance' />
1920 <param name='&lt;0-15&gt;' doc='An instance of the SS7 stack' />
1921 </params>
1922 </command>
1923 </node>
1924 <node id='config-log'>
1925 <name>config-log</name>
1926 <command id='logging filter all (0|1)'>
1927 <params>
1928 <param name='logging' doc='Configure logging' />
1929 <param name='filter' doc='Filter log messages' />
1930 <param name='all' doc='Do you want to log all messages?' />
1931 <param name='0' doc='Only print messages matched by other filters' />
1932 <param name='1' doc='Bypass filter and print all messages' />
1933 </params>
1934 </command>
1935 <command id='logging color (0|1)'>
1936 <params>
1937 <param name='logging' doc='Configure logging' />
1938 <param name='color' doc='Configure color-printing for log messages' />
1939 <param name='0' doc='Don&apos;t use color for printing messages' />
1940 <param name='1' doc='Use color for printing messages' />
1941 </params>
1942 </command>
1943 <command id='logging timestamp (0|1)'>
1944 <params>
1945 <param name='logging' doc='Configure logging' />
1946 <param name='timestamp' doc='Configure log message timestamping' />
1947 <param name='0' doc='Don&apos;t prefix each log message' />
1948 <param name='1' doc='Prefix each log message with current timestamp' />
1949 </params>
1950 </command>
1951 <command id='logging print extended-timestamp (0|1)'>
1952 <params>
1953 <param name='logging' doc='Configure logging' />
1954 <param name='print' doc='Log output settings' />
1955 <param name='extended-timestamp' doc='Configure log message timestamping' />
1956 <param name='0' doc='Don&apos;t prefix each log message' />
1957 <param name='1' doc='Prefix each log message with current timestamp with YYYYMMDDhhmmssnnn' />
1958 </params>
1959 </command>
1960 <command id='logging print category (0|1)'>
1961 <params>
1962 <param name='logging' doc='Configure logging' />
1963 <param name='print' doc='Log output settings' />
1964 <param name='category' doc='Configure log message' />
1965 <param name='0' doc='Don&apos;t prefix each log message' />
1966 <param name='1' doc='Prefix each log message with category/subsystem name' />
1967 </params>
1968 </command>
1969 <command id='logging print category-hex (0|1)'>
1970 <params>
1971 <param name='logging' doc='Configure logging' />
1972 <param name='print' doc='Log output settings' />
1973 <param name='category-hex' doc='Configure log message' />
1974 <param name='0' doc='Don&apos;t prefix each log message' />
1975 <param name='1' doc='Prefix each log message with category/subsystem nr in hex (&apos;&lt;000b&gt;&apos;)' />
1976 </params>
1977 </command>
1978 <command id='logging print level (0|1)'>
1979 <params>
1980 <param name='logging' doc='Configure logging' />
1981 <param name='print' doc='Log output settings' />
1982 <param name='level' doc='Configure log message' />
1983 <param name='0' doc='Don&apos;t prefix each log message' />
1984 <param name='1' doc='Prefix each log message with the log level name' />
1985 </params>
1986 </command>
Neels Hofmeyr39e12152018-11-05 02:56:09 +01001987 <command id='logging print file (0|1|basename) [last]'>
Neels Hofmeyr9f157572018-03-06 14:59:00 +01001988 <params>
1989 <param name='logging' doc='Configure logging' />
1990 <param name='print' doc='Log output settings' />
1991 <param name='file' doc='Configure log message' />
1992 <param name='0' doc='Don&apos;t prefix each log message' />
1993 <param name='1' doc='Prefix each log message with the source file and line' />
1994 <param name='basename' doc='Prefix each log message with the source file&apos;s basename (strip leading paths) and line' />
Neels Hofmeyr39e12152018-11-05 02:56:09 +01001995 <param name='[last]' doc='Log source file info at the end of a log line. If omitted, log source file info just before the log text.' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01001996 </params>
1997 </command>
Vadim Yanitskiyf06b9bf2020-04-05 00:39:45 +07001998 <command id='logging level (rll|mm|rr|rsl|nm|pag|meas|msc|ho|hodec|ref|ctrl|filter|pcu|lcls|chan|ts|as|cbs|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro) (debug|info|notice|error|fatal)'>
Neels Hofmeyr9f157572018-03-06 14:59:00 +01001999 <params>
2000 <param name='logging' doc='Configure logging' />
2001 <param name='level' doc='Set the log level for a specified category' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01002002 <param name='rll' doc='A-bis Radio Link Layer (RLL)' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01002003 <param name='mm' doc='Layer3 Mobility Management (MM)' />
2004 <param name='rr' doc='Layer3 Radio Resource (RR)' />
Neels Hofmeyr39e12152018-11-05 02:56:09 +01002005 <param name='rsl' doc='A-bis Radio Signalling Link (RSL)' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01002006 <param name='nm' doc='A-bis Network Management / O&amp;M (NM/OML)' />
2007 <param name='pag' doc='Paging Subsystem' />
2008 <param name='meas' doc='Radio Measurement Processing' />
2009 <param name='msc' doc='Mobile Switching Center' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01002010 <param name='ho' doc='Hand-Over Process' />
2011 <param name='hodec' doc='Hand-Over Decision' />
2012 <param name='ref' doc='Reference Counting' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01002013 <param name='ctrl' doc='Control interface' />
2014 <param name='filter' doc='BSC/NAT IMSI based filtering' />
2015 <param name='pcu' doc='PCU Interface' />
Neels Hofmeyr39e12152018-11-05 02:56:09 +01002016 <param name='lcls' doc='Local Call, Local Switch' />
2017 <param name='chan' doc='lchan FSM' />
2018 <param name='ts' doc='timeslot FSM' />
2019 <param name='as' doc='assignment FSM' />
Harald Welted41b7c72019-06-13 09:41:58 +02002020 <param name='cbs' doc='Cell Broadcast System' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01002021 <param name='lglobal' doc='Library-internal global log family' />
2022 <param name='llapd' doc='LAPD in libosmogsm' />
2023 <param name='linp' doc='A-bis Intput Subsystem' />
2024 <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' />
2025 <param name='lmi' doc='A-bis Input Driver for Signalling' />
2026 <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' />
2027 <param name='lsms' doc='Layer3 Short Message Service (SMS)' />
2028 <param name='lctrl' doc='Control Interface' />
2029 <param name='lgtp' doc='GPRS GTP library' />
2030 <param name='lstats' doc='Statistics messages and logging' />
2031 <param name='lgsup' doc='Generic Subscriber Update Protocol' />
2032 <param name='loap' doc='Osmocom Authentication Protocol' />
2033 <param name='lss7' doc='libosmo-sigtran Signalling System 7' />
2034 <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' />
2035 <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' />
2036 <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' />
2037 <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' />
2038 <param name='ljibuf' doc='libosmo-netif Jitter Buffer' />
Daniel Willmannf450f442019-06-06 17:52:25 +02002039 <param name='lrspro' doc='Remote SIM protocol' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01002040 <param name='debug' doc='Log debug messages and higher levels' />
2041 <param name='info' doc='Log informational messages and higher levels' />
2042 <param name='notice' doc='Log noticeable messages and higher levels' />
2043 <param name='error' doc='Log error messages and higher levels' />
2044 <param name='fatal' doc='Log only fatal messages' />
2045 </params>
2046 </command>
Neels Hofmeyr39e12152018-11-05 02:56:09 +01002047 <command id='logging level set-all (debug|info|notice|error|fatal)'>
2048 <params>
2049 <param name='logging' doc='Configure logging' />
2050 <param name='level' doc='Set the log level for a specified category' />
2051 <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.' />
2052 <param name='debug' doc='Log debug messages and higher levels' />
2053 <param name='info' doc='Log informational messages and higher levels' />
2054 <param name='notice' doc='Log noticeable messages and higher levels' />
2055 <param name='error' doc='Log error messages and higher levels' />
2056 <param name='fatal' doc='Log only fatal messages' />
2057 </params>
2058 </command>
2059 <command id='logging level force-all (debug|info|notice|error|fatal)'>
2060 <params>
2061 <param name='logging' doc='Configure logging' />
2062 <param name='level' doc='Set the log level for a specified category' />
2063 <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.' />
2064 <param name='debug' doc='Log debug messages and higher levels' />
2065 <param name='info' doc='Log informational messages and higher levels' />
2066 <param name='notice' doc='Log noticeable messages and higher levels' />
2067 <param name='error' doc='Log error messages and higher levels' />
2068 <param name='fatal' doc='Log only fatal messages' />
2069 </params>
2070 </command>
2071 <command id='no logging level force-all'>
2072 <params>
2073 <param name='no' doc='Negate a command or set its defaults' />
2074 <param name='logging' doc='Configure logging' />
2075 <param name='level' doc='Set the log level for a specified category' />
2076 <param name='force-all' doc='Release any globally forced log level set with &apos;logging level force-all &lt;level&gt;&apos;' />
2077 </params>
2078 </command>
Neels Hofmeyr9f157572018-03-06 14:59:00 +01002079 <command id='logging filter imsi IMSI'>
2080 <params>
2081 <param name='logging' doc='Configure logging' />
2082 <param name='filter' doc='Filter log messages' />
2083 <param name='imsi' doc='Filter log messages by IMSI' />
2084 <param name='IMSI' doc='IMSI to be used as filter' />
2085 </params>
2086 </command>
2087 </node>
2088 <node id='config-stats'>
2089 <name>config-stats</name>
2090 <command id='local-ip ADDR'>
2091 <params>
2092 <param name='local-ip' doc='Set the IP address to which we bind locally' />
2093 <param name='ADDR' doc='IP Address' />
2094 </params>
2095 </command>
2096 <command id='no local-ip'>
2097 <params>
2098 <param name='no' doc='Negate a command or set its defaults' />
2099 <param name='local-ip' doc='Set the IP address to which we bind locally' />
2100 </params>
2101 </command>
2102 <command id='remote-ip ADDR'>
2103 <params>
2104 <param name='remote-ip' doc='Set the remote IP address to which we connect' />
2105 <param name='ADDR' doc='IP Address' />
2106 </params>
2107 </command>
2108 <command id='remote-port &lt;1-65535&gt;'>
2109 <params>
2110 <param name='remote-port' doc='Set the remote port to which we connect' />
2111 <param name='&lt;1-65535&gt;' doc='Remote port number' />
2112 </params>
2113 </command>
2114 <command id='mtu &lt;100-65535&gt;'>
2115 <params>
2116 <param name='mtu' doc='Set the maximum packet size' />
2117 <param name='&lt;100-65535&gt;' doc='Size in byte' />
2118 </params>
2119 </command>
2120 <command id='no mtu'>
2121 <params>
2122 <param name='no' doc='Negate a command or set its defaults' />
2123 <param name='mtu' doc='Set the maximum packet size' />
2124 </params>
2125 </command>
2126 <command id='prefix PREFIX'>
2127 <params>
2128 <param name='prefix' doc='Set the item name prefix' />
2129 <param name='PREFIX' doc='The prefix string' />
2130 </params>
2131 </command>
2132 <command id='no prefix'>
2133 <params>
2134 <param name='no' doc='Negate a command or set its defaults' />
2135 <param name='prefix' doc='Set the item name prefix' />
2136 </params>
2137 </command>
2138 <command id='level (global|peer|subscriber)'>
2139 <params>
2140 <param name='level' doc='Set the maximum group level' />
2141 <param name='global' doc='Report global groups only' />
2142 <param name='peer' doc='Report global and network peer related groups' />
2143 <param name='subscriber' doc='Report global, peer, and subscriber groups' />
2144 </params>
2145 </command>
2146 <command id='enable'>
2147 <params>
2148 <param name='enable' doc='Enable the reporter' />
2149 </params>
2150 </command>
2151 <command id='disable'>
2152 <params>
2153 <param name='disable' doc='Disable the reporter' />
2154 </params>
2155 </command>
2156 </node>
2157 <node id='config-line'>
2158 <name>config-line</name>
2159 <command id='login'>
2160 <params>
2161 <param name='login' doc='Enable password checking' />
2162 </params>
2163 </command>
2164 <command id='no login'>
2165 <params>
2166 <param name='no' doc='Negate a command or set its defaults' />
2167 <param name='login' doc='Enable password checking' />
2168 </params>
2169 </command>
Daniel Willmannf450f442019-06-06 17:52:25 +02002170 <command id='bind A.B.C.D [&lt;0-65535&gt;]'>
Neels Hofmeyr9f157572018-03-06 14:59:00 +01002171 <params>
2172 <param name='bind' doc='Accept VTY telnet connections on local interface' />
2173 <param name='A.B.C.D' doc='Local interface IP address (default: 127.0.0.1)' />
Daniel Willmannf450f442019-06-06 17:52:25 +02002174 <param name='[&lt;0-65535&gt;]' doc='Local TCP port number' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01002175 </params>
2176 </command>
2177 </node>
2178 <node id='config-e1_input'>
2179 <name>config-e1_input</name>
Oliver Smithb5bfa712020-03-27 10:29:51 +01002180 <command id='e1_line &lt;0-255&gt; driver (misdn|misdn_lapd|dahdi|e1d|ipa|unixsocket)'>
Neels Hofmeyr9f157572018-03-06 14:59:00 +01002181 <params>
2182 <param name='e1_line' doc='Configure E1/T1/J1 Line' />
2183 <param name='&lt;0-255&gt;' doc='Line Number' />
2184 <param name='driver' doc='Set driver for this line' />
2185 <param name='misdn' doc='mISDN supported E1 Card (kernel LAPD)' />
2186 <param name='misdn_lapd' doc='mISDN supported E1 Card (userspace LAPD)' />
2187 <param name='dahdi' doc='DAHDI supported E1/T1/J1 Card' />
Oliver Smithb5bfa712020-03-27 10:29:51 +01002188 <param name='e1d' doc='IPA TCP/IP input' />
2189 <param name='ipa' doc='HSL TCP/IP input' />
2190 <param name='unixsocket' doc='Unix socket input' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01002191 </params>
2192 </command>
2193 <command id='e1_line &lt;0-255&gt; port &lt;0-255&gt;'>
2194 <params>
2195 <param name='e1_line' doc='Configure E1/T1/J1 Line' />
2196 <param name='&lt;0-255&gt;' doc='Line Number' />
2197 <param name='port' doc='Set physical port/span/card number' />
2198 <param name='&lt;0-255&gt;' doc='E1/T1 Port/Span/Card number' />
2199 </params>
2200 </command>
2201 <command id='e1_line &lt;0-255&gt; socket .SOCKET'>
2202 <params>
2203 <param name='e1_line' doc='Configure E1/T1/J1 Line' />
2204 <param name='&lt;0-255&gt;' doc='Line Number' />
2205 <param name='socket' doc='Set socket path for unixsocket' />
2206 <param name='.SOCKET' doc='socket path' />
2207 </params>
2208 </command>
2209 <command id='e1_line &lt;0-255&gt; name .LINE'>
2210 <params>
2211 <param name='e1_line' doc='Configure E1/T1/J1 Line' />
2212 <param name='&lt;0-255&gt;' doc='Line Number' />
2213 <param name='name' doc='Set name for this line' />
2214 <param name='.LINE' doc='Human readable name' />
2215 </params>
2216 </command>
2217 <command id='e1_line &lt;0-255&gt; keepalive'>
2218 <params>
2219 <param name='e1_line' doc='Configure E1/T1/J1 Line' />
2220 <param name='&lt;0-255&gt;' doc='Line Number' />
2221 <param name='keepalive' doc='Enable keep-alive probing' />
2222 </params>
2223 </command>
2224 <command id='e1_line &lt;0-255&gt; keepalive &lt;1-300&gt; &lt;1-20&gt; &lt;1-300&gt;'>
2225 <params>
2226 <param name='e1_line' doc='Configure E1/T1/J1 Line' />
2227 <param name='&lt;0-255&gt;' doc='Line Number' />
2228 <param name='keepalive' doc='Enable keep-alive probing' />
2229 <param name='&lt;1-300&gt;' doc='Idle interval in seconds before probes are sent' />
2230 <param name='&lt;1-20&gt;' doc='Number of probes to sent' />
2231 <param name='&lt;1-300&gt;' doc='Delay between probe packets in seconds' />
2232 </params>
2233 </command>
2234 <command id='no e1_line &lt;0-255&gt; keepalive'>
2235 <params>
2236 <param name='no' doc='Negate a command or set its defaults' />
2237 <param name='e1_line' doc='Configure E1/T1/J1 Line' />
2238 <param name='&lt;0-255&gt;' doc='Line Number' />
2239 <param name='keepalive' doc='Enable keep-alive probing' />
2240 </params>
2241 </command>
Oliver Smithb5bfa712020-03-27 10:29:51 +01002242 <command id='e1_line &lt;0-255&gt; ipa-keepalive &lt;1-300&gt; &lt;1-300&gt;'>
2243 <params>
2244 <param name='e1_line' doc='Configure E1/T1/J1 Line' />
2245 <param name='&lt;0-255&gt;' doc='Line Number' />
2246 <param name='ipa-keepalive' doc='Enable IPA PING/PONG keep-alive' />
2247 <param name='&lt;1-300&gt;' doc='Idle interval in seconds before probes are sent' />
2248 <param name='&lt;1-300&gt;' doc='Time to wait for PONG response' />
2249 </params>
2250 </command>
2251 <command id='no e1_line &lt;0-255&gt; ipa-keepalive'>
2252 <params>
2253 <param name='no' doc='Negate a command or set its defaults' />
2254 <param name='e1_line' doc='Configure E1/T1/J1 Line' />
2255 <param name='&lt;0-255&gt;' doc='Line Number' />
2256 <param name='ipa-keepalive' doc='Enable IPA PING/PONG keep-alive' />
2257 </params>
2258 </command>
Neels Hofmeyr9f157572018-03-06 14:59:00 +01002259 <command id='ipa bind A.B.C.D'>
2260 <params>
2261 <param name='ipa' doc='ipa driver config' />
2262 <param name='bind' doc='Set ipa local bind address' />
2263 <param name='A.B.C.D' doc='Listen on this IP address (default 0.0.0.0)' />
2264 </params>
2265 </command>
2266 </node>
2267 <node id='config-ctrl'>
2268 <name>config-ctrl</name>
2269 <command id='bind A.B.C.D'>
2270 <params>
2271 <param name='bind' doc='Set bind address to listen for Control connections' />
2272 <param name='A.B.C.D' doc='Local IP address (default 127.0.0.1)' />
2273 </params>
2274 </command>
2275 </node>
2276 <node id='config-cs7'>
2277 <name>config-cs7</name>
2278 <command id='description .TEXT'>
2279 <params>
2280 <param name='description' doc='Save human-readable description of the object' />
2281 <param name='.TEXT' doc='Text until the end of the line' />
2282 </params>
2283 </command>
2284 <command id='network-indicator (international | national | reserved | spare)'>
2285 <params>
2286 <param name='network-indicator' doc='Configure the Network Indicator' />
2287 <param name='international' doc='International Network' />
2288 <param name='national' doc='National Network' />
2289 <param name='reserved' doc='Reserved Network' />
2290 <param name='spare' doc='Spare Network' />
2291 </params>
2292 </command>
2293 <command id='point-code POINT_CODE'>
2294 <params>
2295 <param name='point-code' doc='Configure the local Point Code' />
2296 <param name='POINT_CODE' doc='Point Code' />
2297 </params>
2298 </command>
2299 <command id='point-code format &lt;1-24&gt; [&lt;1-23&gt;] [&lt;1-22&gt;]'>
2300 <params>
2301 <param name='point-code' doc='Point Code' />
2302 <param name='format' doc='Configure Point Code Format' />
2303 <param name='&lt;1-24&gt;' doc='Length of first PC component' />
2304 <param name='[&lt;1-23&gt;]' doc='Length of second PC component' />
2305 <param name='[&lt;1-22&gt;]' doc='Length of third PC component' />
2306 </params>
2307 </command>
2308 <command id='point-code format default'>
2309 <params>
2310 <param name='point-code' doc='Point Code' />
2311 <param name='format' doc='Configure Point Code Format' />
2312 <param name='default' doc='Default Point Code Format (3.8.3)' />
2313 </params>
2314 </command>
2315 <command id='point-code delimiter (default|dash)'>
2316 <params>
2317 <param name='point-code' doc='Point Code' />
2318 <param name='delimiter' doc='Configure Point Code Delimiter' />
2319 <param name='default' doc='Use dot as delimiter' />
2320 <param name='dash' doc='User dash as delimiter' />
2321 </params>
2322 </command>
2323 <command id='xua rkm routing-key-allocation (static-only|dynamic-permitted)'>
2324 <params>
2325 <param name='xua' doc='SIGTRAN xxxUA related' />
2326 <param name='rkm' doc='Routing Key Management' />
2327 <param name='routing-key-allocation' doc='Routing Key Management Allocation Policy' />
2328 <param name='static-only' doc='Only static (pre-confgured) Routing Keys permitted' />
2329 <param name='dynamic-permitted' doc='Dynamically allocate Routing Keys for what ASPs request' />
2330 </params>
2331 </command>
2332 <command id='asp NAME &lt;0-65535&gt; &lt;0-65535&gt; (sua|m3ua|ipa)'>
2333 <params>
2334 <param name='asp' doc='Configure Application Server Process' />
2335 <param name='NAME' doc='Name of ASP' />
2336 <param name='&lt;0-65535&gt;' doc='Remote SCTP port number' />
2337 <param name='&lt;0-65535&gt;' doc='Local SCTP port number' />
2338 <param name='sua' doc='SCCP User Adaptation' />
2339 <param name='m3ua' doc='MTP3 User Adaptation' />
2340 <param name='ipa' doc='IPA Multiplex (SCCP Lite)' />
2341 </params>
2342 </command>
2343 <command id='no asp NAME'>
2344 <params>
2345 <param name='no' doc='Negate a command or set its defaults' />
2346 <param name='asp' doc='Disable Application Server Process' />
2347 <param name='NAME' doc='Name of ASP' />
2348 </params>
2349 </command>
2350 <command id='as NAME (sua|m3ua|ipa)'>
2351 <params>
2352 <param name='as' doc='Configure an Application Server' />
2353 <param name='NAME' doc='Name of the Application Server' />
2354 <param name='sua' doc='SCCP User Adaptation' />
2355 <param name='m3ua' doc='MTP3 User Adaptation' />
2356 <param name='ipa' doc='IPA Multiplex (SCCP Lite)' />
2357 </params>
2358 </command>
2359 <command id='no as NAME'>
2360 <params>
2361 <param name='no' doc='Negate a command or set its defaults' />
2362 <param name='as' doc='Disable Application Server' />
2363 <param name='NAME' doc='Name of AS' />
2364 </params>
2365 </command>
Neels Hofmeyr9f157572018-03-06 14:59:00 +01002366 <command id='sccp-address NAME'>
2367 <params>
2368 <param name='sccp-address' doc='Create/Modify an SCCP addressbook entry' />
2369 <param name='NAME' doc='Name of the SCCP Address' />
2370 </params>
2371 </command>
2372 <command id='no sccp-address NAME'>
2373 <params>
2374 <param name='no' doc='Negate a command or set its defaults' />
2375 <param name='sccp-address' doc='Delete an SCCP addressbook entry' />
2376 <param name='NAME' doc='Name of the SCCP Address' />
2377 </params>
2378 </command>
Neels Hofmeyr39e12152018-11-05 02:56:09 +01002379 <command id='sccp-timer (conn_est|ias|iar|rel|repeat_rel|int|guard|reset|reassembly) &lt;1-999999&gt;'>
2380 <params>
2381 <param name='sccp-timer' doc='Configure SCCP timer values, see ITU-T Q.714' />
2382 <param name='conn_est' doc='Waiting for connection confirm message, 1 to 2 minutes (default: 60)' />
2383 <param name='ias' doc='Send keep-alive: on an idle connection, delay before sending an Idle Timer message, 5 to 10 minutes (default: 420)' />
2384 <param name='iar' doc='Receive keep-alive: on an idle connection, delay until considering a connection as stale, 11 to 21 minutes (default: 900)' />
2385 <param name='rel' doc='Waiting for release complete message, 10 to 20 seconds (default: 10)' />
2386 <param name='repeat_rel' doc='Waiting for release complete message; or to repeat sending released message after the initial expiry, 10 to 20 seconds (default: 10)' />
2387 <param name='int' doc='Waiting for release complete message; or to release connection resources, freeze the LRN and alert a maintenance function after the initial expiry, extending to 1 minute (default: 60)' />
2388 <param name='guard' doc='Waiting to resume normal procedure for temporary connection sections during the restart procedure, 23 to 25 minutes (default: 1380)' />
2389 <param name='reset' doc='Waiting to release temporary connection section or alert maintenance function after reset request message is sent, 10 to 20 seconds (default: 10)' />
2390 <param name='reassembly' doc='Waiting to receive all the segments of the remaining segments, single segmented message after receiving the first segment, 10 to 20 seconds (default: 10)' />
2391 <param name='&lt;1-999999&gt;' doc='Timer value, in seconds' />
2392 </params>
2393 </command>
Neels Hofmeyr9f157572018-03-06 14:59:00 +01002394 </node>
2395 <node id='config-cs7-as'>
2396 <name>config-cs7-as</name>
2397 <command id='description .TEXT'>
2398 <params>
2399 <param name='description' doc='Save human-readable description of the object' />
2400 <param name='.TEXT' doc='Text until the end of the line' />
2401 </params>
2402 </command>
2403 <command id='asp NAME'>
2404 <params>
2405 <param name='asp' doc='Specify that a given ASP is part of this AS' />
2406 <param name='NAME' doc='Name of ASP to be added to AS' />
2407 </params>
2408 </command>
2409 <command id='no asp NAME'>
2410 <params>
2411 <param name='no' doc='Negate a command or set its defaults' />
2412 <param name='asp' doc='Specify ASP to be removed from this AS' />
2413 <param name='NAME' doc='Name of ASP to be removed' />
2414 </params>
2415 </command>
2416 <command id='traffic-mode (broadcast | loadshare | roundrobin | override)'>
2417 <params>
2418 <param name='traffic-mode' doc='Specifies traffic mode of operation of the ASP within the AS' />
2419 <param name='broadcast' doc='Broadcast to all ASP within AS' />
2420 <param name='loadshare' doc='Share Load among all ASP within AS' />
2421 <param name='roundrobin' doc='Round-Robin between all ASP within AS' />
2422 <param name='override' doc='Override' />
2423 </params>
2424 </command>
2425 <command id='recovery-timeout &lt;1-2000&gt;'>
2426 <params>
2427 <param name='recovery-timeout' doc='Specifies the recovery timeout value in milliseconds' />
2428 <param name='&lt;1-2000&gt;' doc='Recovery Timeout in Milliseconds' />
2429 </params>
2430 </command>
2431 <command id='qos-class &lt;0-255&gt;'>
2432 <params>
2433 <param name='qos-class' doc='Specity QoS Class of AS' />
2434 <param name='&lt;0-255&gt;' doc='QoS Class of AS' />
2435 </params>
2436 </command>
2437 <command id='routing-key RCONTEXT DPC'>
2438 <params>
2439 <param name='routing-key' doc='Define a routing key' />
2440 <param name='RCONTEXT' doc='Routing context number' />
2441 <param name='DPC' doc='Destination Point Code' />
2442 </params>
2443 </command>
2444 <command id='routing-key RCONTEXT DPC si (aal2|bicc|b-isup|h248|isup|sat-isup|sccp|tup)'>
2445 <params>
2446 <param name='routing-key' doc='Define a routing key' />
2447 <param name='RCONTEXT' doc='Routing context number' />
2448 <param name='DPC' doc='Destination Point Code' />
2449 <param name='si' doc='Match on Service Indicator' />
2450 <param name='aal2' doc='ATM Adaption Layer 2' />
2451 <param name='bicc' doc='Bearer Independent Call Control' />
2452 <param name='b-isup' doc='Broadband ISDN User Part' />
2453 <param name='h248' doc='H.248' />
2454 <param name='isup' doc='ISDN User Part' />
2455 <param name='sat-isup' doc='Sattelite ISDN User Part' />
2456 <param name='sccp' doc='Signalling Connection Control Part' />
2457 <param name='tup' doc='Telephony User Part' />
2458 </params>
2459 </command>
2460 <command id='routing-key RCONTEXT DPC ssn SSN'>
2461 <params>
2462 <param name='routing-key' doc='Define a routing key' />
2463 <param name='RCONTEXT' doc='Routing context number' />
2464 <param name='DPC' doc='Destination Point Code' />
2465 <param name='ssn' doc='Match on Sub-System Number' />
2466 <param name='SSN' doc='Sub-System Number to match on' />
2467 </params>
2468 </command>
2469 <command id='routing-key RCONTEXT DPC si (aal2|bicc|b-isup|h248|isup|sat-isup|sccp|tup) ssn SSN'>
2470 <params>
2471 <param name='routing-key' doc='Define a routing key' />
2472 <param name='RCONTEXT' doc='Routing context number' />
2473 <param name='DPC' doc='Destination Point Code' />
2474 <param name='si' doc='Match on Service Indicator' />
2475 <param name='aal2' doc='ATM Adaption Layer 2' />
2476 <param name='bicc' doc='Bearer Independent Call Control' />
2477 <param name='b-isup' doc='Broadband ISDN User Part' />
2478 <param name='h248' doc='H.248' />
2479 <param name='isup' doc='ISDN User Part' />
2480 <param name='sat-isup' doc='Sattelite ISDN User Part' />
2481 <param name='sccp' doc='Signalling Connection Control Part' />
2482 <param name='tup' doc='Telephony User Part' />
2483 <param name='ssn' doc='Match on Sub-System Number' />
2484 <param name='SSN' doc='Sub-System Number to match on' />
2485 </params>
2486 </command>
2487 <command id='point-code override dpc PC'>
2488 <params>
2489 <param name='point-code' doc='Point Code Specific Features' />
2490 <param name='override' doc='Override (force) a point-code to hard-coded value' />
2491 <param name='dpc' doc='Override Source Point Code' />
2492 <param name='PC' doc='Override Destination Point Code' />
2493 </params>
2494 </command>
Oliver Smithb5bfa712020-03-27 10:29:51 +01002495 <command id='point-code override patch-sccp (disabled|both)'>
2496 <params>
2497 <param name='point-code' doc='Point Code Specific Features' />
2498 <param name='override' doc='Override (force) a point-code to hard-coded value' />
2499 <param name='patch-sccp' doc='Patch point code values into SCCP called/calling address' />
2500 <param name='disabled' doc='Don&apos;t patch any point codes into SCCP called/calling address' />
2501 <param name='both' doc='Patch both origin and destination point codes into SCCP called/calling address' />
2502 </params>
2503 </command>
Neels Hofmeyr9f157572018-03-06 14:59:00 +01002504 </node>
2505 <node id='config-cs7-asp'>
2506 <name>config-cs7-asp</name>
2507 <command id='description .TEXT'>
2508 <params>
2509 <param name='description' doc='Save human-readable description of the object' />
2510 <param name='.TEXT' doc='Text until the end of the line' />
2511 </params>
2512 </command>
2513 <command id='remote-ip A.B.C.D'>
2514 <params>
2515 <param name='remote-ip' doc='Specify Remote IP Address of ASP' />
2516 <param name='A.B.C.D' doc='Remote IP Address of ASP' />
2517 </params>
2518 </command>
2519 <command id='local-ip A.B.C.D'>
2520 <params>
2521 <param name='local-ip' doc='Specify Local IP Address from which to contact ASP' />
2522 <param name='A.B.C.D' doc='Local IP Address from which to contact of ASP' />
2523 </params>
2524 </command>
2525 <command id='qos-class &lt;0-255&gt;'>
2526 <params>
2527 <param name='qos-class' doc='Specify QoS Class of ASP' />
2528 <param name='&lt;0-255&gt;' doc='QoS Class of ASP' />
2529 </params>
2530 </command>
Oliver Smithb5bfa712020-03-27 10:29:51 +01002531 <command id='role (sg|asp|ipsp)'>
2532 <params>
2533 <param name='role' doc='Specify the xUA role for this ASP' />
2534 <param name='sg' doc='SG (Signaling Gateway)' />
2535 <param name='asp' doc='ASP (Application Server Process)' />
2536 <param name='ipsp' doc='IPSP (IP Signalling Point)' />
2537 </params>
2538 </command>
2539 <command id='sctp-role (client|server)'>
2540 <params>
2541 <param name='sctp-role' doc='Specify the SCTP role for this ASP' />
2542 <param name='client' doc='Operate as SCTP client; connect to a server' />
2543 <param name='server' doc='Operate as SCTP server; wait for client connections' />
2544 </params>
2545 </command>
Neels Hofmeyr9f157572018-03-06 14:59:00 +01002546 <command id='block'>
2547 <params>
2548 <param name='block' doc='Allows a SCTP Association with ASP, but doesn&apos;t let it become active' />
2549 </params>
2550 </command>
2551 <command id='shutdown'>
2552 <params>
2553 <param name='shutdown' doc='Terminates SCTP association; New associations will be rejected' />
2554 </params>
2555 </command>
2556 </node>
2557 <node id='config-cs7-sccpaddr'>
2558 <name>config-cs7-sccpaddr</name>
2559 <command id='no point-code'>
2560 <params>
2561 <param name='no' doc='Negate a command or set its defaults' />
2562 <param name='point-code' doc='Remove point-code Number' />
2563 </params>
2564 </command>
2565 <command id='no subsystem-number'>
2566 <params>
2567 <param name='no' doc='Negate a command or set its defaults' />
2568 <param name='subsystem-number' doc='Remove Subsystem Number' />
2569 </params>
2570 </command>
2571 <command id='no global-title'>
2572 <params>
2573 <param name='no' doc='Negate a command or set its defaults' />
2574 <param name='global-title' doc='Remove Global Title' />
2575 </params>
2576 </command>
2577 <command id='routing-indicator (GT|PC|IP)'>
2578 <params>
2579 <param name='routing-indicator' doc='Add Routing Indicator' />
2580 <param name='GT' doc='by global-title' />
2581 <param name='PC' doc='by point-code' />
2582 <param name='IP' doc='by ip-address' />
2583 </params>
2584 </command>
2585 <command id='point-code POINT_CODE'>
2586 <params>
2587 <param name='point-code' doc='Add point-code Number' />
2588 <param name='POINT_CODE' doc='PC' />
2589 </params>
2590 </command>
2591 <command id='subsystem-number &lt;0-4294967295&gt;'>
2592 <params>
2593 <param name='subsystem-number' doc='Add Subsystem Number' />
2594 <param name='&lt;0-4294967295&gt;' doc='SSN' />
2595 </params>
2596 </command>
2597 <command id='global-title'>
2598 <params>
2599 <param name='global-title' doc='Add/Modify Global Title' />
2600 </params>
2601 </command>
2602 </node>
2603 <node id='config-cs7-sccpaddr-gt'>
2604 <name>config-cs7-sccpaddr-gt</name>
2605 <command id='global-title-indicator &lt;0-15&gt;'>
2606 <params>
2607 <param name='global-title-indicator' doc='Set Global Title Indicator' />
2608 <param name='&lt;0-15&gt;' doc='GTI' />
2609 </params>
2610 </command>
2611 <command id='translation-type &lt;0-255&gt;'>
2612 <params>
2613 <param name='translation-type' doc='Set Global Title Translation Type' />
2614 <param name='&lt;0-255&gt;' doc='TT' />
2615 </params>
2616 </command>
2617 <command id='numbering-plan-indicator &lt;0-15&gt;'>
2618 <params>
2619 <param name='numbering-plan-indicator' doc='Set Global Title Numbering Plan Indicator' />
2620 <param name='&lt;0-15&gt;' doc='NPI' />
2621 </params>
2622 </command>
2623 <command id='nature-of-address-indicator &lt;0-127&gt;'>
2624 <params>
2625 <param name='nature-of-address-indicator' doc='Set Global Title Nature of Address Indicator' />
2626 <param name='&lt;0-127&gt;' doc='NAI' />
2627 </params>
2628 </command>
2629 <command id='digits DIGITS'>
2630 <params>
2631 <param name='digits' doc='Set Global Title Digits' />
2632 <param name='DIGITS' doc='Number digits' />
2633 </params>
2634 </command>
2635 </node>
2636 <node id='config-net'>
2637 <name>config-net</name>
2638 <command id='network country code &lt;1-999&gt;'>
2639 <params>
2640 <param name='network' doc='Set the GSM network country code' />
2641 <param name='country' doc='Country commands' />
2642 <param name='code' doc='Code commands' />
2643 <param name='&lt;1-999&gt;' doc='Network Country Code to use' />
2644 </params>
2645 </command>
2646 <command id='mobile network code &lt;0-999&gt;'>
2647 <params>
2648 <param name='mobile' doc='Set the GSM mobile network code' />
2649 <param name='network' doc='Network Commands' />
2650 <param name='code' doc='Code commands' />
2651 <param name='&lt;0-999&gt;' doc='Mobile Network Code to use' />
2652 </params>
2653 </command>
2654 <command id='encryption a5 &lt;0-3&gt; [&lt;0-3&gt;] [&lt;0-3&gt;] [&lt;0-3&gt;]'>
2655 <params>
2656 <param name='encryption' doc='Encryption options' />
2657 <param name='a5' doc='GSM A5 Air Interface Encryption' />
2658 <param name='&lt;0-3&gt;' doc='A5/n Algorithm Number' />
2659 <param name='[&lt;0-3&gt;]' doc='A5/n Algorithm Number' />
2660 <param name='[&lt;0-3&gt;]' doc='A5/n Algorithm Number' />
2661 <param name='[&lt;0-3&gt;]' doc='A5/n Algorithm Number' />
2662 </params>
2663 </command>
2664 <command id='timezone &lt;-19-19&gt; (0|15|30|45)'>
2665 <params>
2666 <param name='timezone' doc='Set the Timezone Offset of the network' />
2667 <param name='&lt;-19-19&gt;' doc='Timezone offset (hours)' />
2668 <param name='0' doc='Timezone offset (00 minutes)' />
2669 <param name='15' doc='Timezone offset (15 minutes)' />
2670 <param name='30' doc='Timezone offset (30 minutes)' />
2671 <param name='45' doc='Timezone offset (45 minutes)' />
2672 </params>
2673 </command>
2674 <command id='timezone &lt;-19-19&gt; (0|15|30|45) &lt;0-2&gt;'>
2675 <params>
2676 <param name='timezone' doc='Set the Timezone Offset of the network' />
2677 <param name='&lt;-19-19&gt;' doc='Timezone offset (hours)' />
2678 <param name='0' doc='Timezone offset (00 minutes)' />
2679 <param name='15' doc='Timezone offset (15 minutes)' />
2680 <param name='30' doc='Timezone offset (30 minutes)' />
2681 <param name='45' doc='Timezone offset (45 minutes)' />
2682 <param name='&lt;0-2&gt;' doc='DST offset (hours)' />
2683 </params>
2684 </command>
2685 <command id='no timezone'>
2686 <params>
2687 <param name='no' doc='Negate a command or set its defaults' />
2688 <param name='timezone' doc='Disable network timezone override, use system tz' />
2689 </params>
2690 </command>
2691 <command id='periodic location update &lt;6-1530&gt;'>
2692 <params>
2693 <param name='periodic' doc='Periodic Location Updating Interval' />
2694 <param name='location' doc='Periodic Location Updating Interval' />
2695 <param name='update' doc='Periodic Location Updating Interval' />
2696 <param name='&lt;6-1530&gt;' doc='Periodic Location Updating Interval in Minutes' />
2697 </params>
2698 </command>
2699 <command id='no periodic location update'>
2700 <params>
2701 <param name='no' doc='Negate a command or set its defaults' />
2702 <param name='periodic' doc='Periodic Location Updating Interval' />
2703 <param name='location' doc='Periodic Location Updating Interval' />
2704 <param name='update' doc='Periodic Location Updating Interval' />
2705 </params>
2706 </command>
Neels Hofmeyr39e12152018-11-05 02:56:09 +01002707 <command id='meas-feed destination ADDR &lt;0-65535&gt;'>
Neels Hofmeyr9f157572018-03-06 14:59:00 +01002708 <params>
Neels Hofmeyr39e12152018-11-05 02:56:09 +01002709 <param name='meas-feed' doc='Measurement Report export' />
2710 <param name='destination' doc='Where to forward Measurement Report feeds' />
2711 <param name='ADDR' doc='address or hostname' />
2712 <param name='&lt;0-65535&gt;' doc='port number' />
2713 </params>
2714 </command>
2715 <command id='meas-feed scenario NAME'>
2716 <params>
2717 <param name='meas-feed' doc='Measurement Report export' />
2718 <param name='scenario' doc='Set a name to include in the Measurement Report feeds' />
2719 <param name='NAME' doc='Name string, up to 31 characters' />
2720 </params>
2721 </command>
Daniel Willmannf450f442019-06-06 17:52:25 +02002722 <command id='timer [TNNNN] [(&lt;0-2147483647&gt;|default)]'>
Neels Hofmeyr39e12152018-11-05 02:56:09 +01002723 <params>
Daniel Willmannf450f442019-06-06 17:52:25 +02002724 <param name='timer' doc='Configure or show timers' />
2725 <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;.' />
2726 <param name='[&lt;0-2147483647&gt;]' doc='New timer value' />
2727 <param name='[default]' doc='Set to default timer value' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01002728 </params>
2729 </command>
Oliver Smithb5bfa712020-03-27 10:29:51 +01002730 <command id='allow-unusable-timeslots'>
2731 <params>
2732 <param name='allow-unusable-timeslots' doc='Don&apos;t refuse to start with mutually exclusive codec settings' />
2733 </params>
2734 </command>
Neels Hofmeyr9f157572018-03-06 14:59:00 +01002735 <command id='neci (0|1)'>
2736 <params>
2737 <param name='neci' doc='New Establish Cause Indication' />
2738 <param name='0' doc='Don&apos;t set the NECI bit' />
2739 <param name='1' doc='Set the NECI bit' />
2740 </params>
2741 </command>
Neels Hofmeyr9f157572018-03-06 14:59:00 +01002742 <command id='paging any use tch (0|1)'>
2743 <params>
2744 <param name='paging' doc='Assign a TCH when receiving a Paging Any request' />
2745 <param name='any' doc='Any Channel' />
2746 <param name='use' doc='Use' />
2747 <param name='tch' doc='TCH' />
2748 <param name='0' doc='Do not use TCH for Paging Request Any' />
2749 <param name='1' doc='Do use TCH for Paging Request Any' />
2750 </params>
2751 </command>
2752 <command id='bts &lt;0-255&gt;'>
2753 <params>
2754 <param name='bts' doc='Select a BTS to configure' />
2755 <param name='&lt;0-255&gt;' doc='BTS Number' />
2756 </params>
2757 </command>
2758 <command id='handover (0|1|default)'>
2759 <params>
2760 <param name='handover' doc='Handover general config' />
2761 <param name='0' doc='Disable in-call handover' />
2762 <param name='1' doc='Enable in-call handover' />
2763 <param name='default' doc='Enable/disable handover: Use default (0), remove explicit setting on this node' />
2764 </params>
2765 </command>
2766 <command id='handover algorithm (1|2|default)'>
2767 <params>
2768 <param name='handover' doc='Handover general config' />
2769 <param name='algorithm' doc='Choose algorithm for handover decision' />
2770 <param name='1' doc='Algorithm 1: trigger handover based on comparing current cell and neighbor RxLev and RxQual, only.' />
2771 <param name='2' doc='Algorithm 2: trigger handover on RxLev/RxQual, and also to balance the load across several cells. Consider available codecs. Prevent repeated handover by penalty timers.' />
2772 <param name='default' doc='Use default (1), remove explicit setting on this node' />
2773 </params>
2774 </command>
2775 <command id='handover1 window rxlev averaging (&lt;1-10&gt;|default)'>
2776 <params>
2777 <param name='handover1' doc='Handover options for handover decision algorithm 1' />
2778 <param name='window' doc='Measurement averaging settings' />
2779 <param name='rxlev' doc='Received-Level averaging' />
Harald Welte7104ed22019-09-02 10:55:21 +02002780 <param name='averaging' doc='How many RxLev measurements to use for averaging' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01002781 <param name='&lt;1-10&gt;' doc='RxLev averaging: Number of values to average over' />
2782 <param name='default' doc='Use default (10), remove explicit setting on this node' />
2783 </params>
2784 </command>
2785 <command id='handover1 window rxqual averaging (&lt;1-10&gt;|default)'>
2786 <params>
2787 <param name='handover1' doc='Handover options for handover decision algorithm 1' />
2788 <param name='window' doc='Measurement averaging settings' />
2789 <param name='rxqual' doc='Received-Quality averaging' />
Harald Welte7104ed22019-09-02 10:55:21 +02002790 <param name='averaging' doc='How many RxQual measurements to use for averaging' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01002791 <param name='&lt;1-10&gt;' doc='RxQual averaging: Number of values to average over' />
2792 <param name='default' doc='Use default (1), remove explicit setting on this node' />
2793 </params>
2794 </command>
2795 <command id='handover1 window rxlev neighbor averaging (&lt;1-10&gt;|default)'>
2796 <params>
2797 <param name='handover1' doc='Handover options for handover decision algorithm 1' />
2798 <param name='window' doc='Measurement averaging settings' />
2799 <param name='rxlev' doc='Received-Level averaging' />
Harald Welte7104ed22019-09-02 10:55:21 +02002800 <param name='neighbor' doc='How many Neighbor RxLev measurements to use for averaging' />
2801 <param name='averaging' doc='How many Neighbor RxLev measurements to use for averaging' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01002802 <param name='&lt;1-10&gt;' doc='Neighbor RxLev averaging: Number of values to average over' />
2803 <param name='default' doc='Use default (10), remove explicit setting on this node' />
2804 </params>
2805 </command>
2806 <command id='handover1 power budget interval (&lt;1-99&gt;|default)'>
2807 <params>
2808 <param name='handover1' doc='Handover options for handover decision algorithm 1' />
2809 <param name='power' doc='Neighbor cell power triggering' />
2810 <param name='budget' doc='Neighbor cell power triggering' />
2811 <param name='interval' doc='How often to check for a better cell (SACCH frames)' />
2812 <param name='&lt;1-99&gt;' doc='Check for stronger neighbor every N number of SACCH frames' />
2813 <param name='default' doc='Use default (6), remove explicit setting on this node' />
2814 </params>
2815 </command>
2816 <command id='handover1 power budget hysteresis (&lt;0-999&gt;|default)'>
2817 <params>
2818 <param name='handover1' doc='Handover options for handover decision algorithm 1' />
2819 <param name='power' doc='Neighbor cell power triggering' />
2820 <param name='budget' doc='Neighbor cell power triggering' />
Neels Hofmeyr39e12152018-11-05 02:56:09 +01002821 <param name='hysteresis' doc='How many dB stronger must a neighbor be to become a HO candidate' />
2822 <param name='&lt;0-999&gt;' doc='Neighbor&apos;s strength difference in dB' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01002823 <param name='default' doc='Use default (3), remove explicit setting on this node' />
2824 </params>
2825 </command>
2826 <command id='handover1 maximum distance (&lt;0-9999&gt;|default)'>
2827 <params>
2828 <param name='handover1' doc='Handover options for handover decision algorithm 1' />
2829 <param name='maximum' doc='Maximum Timing-Advance value (i.e. MS distance) before triggering HO' />
2830 <param name='distance' doc='Maximum Timing-Advance value (i.e. MS distance) before triggering HO' />
2831 <param name='&lt;0-9999&gt;' doc='Maximum Timing-Advance value (i.e. MS distance) before triggering HO' />
2832 <param name='default' doc='Use default (9999), remove explicit setting on this node' />
2833 </params>
2834 </command>
2835 <command id='handover2 window rxlev averaging (&lt;1-10&gt;|default)'>
2836 <params>
2837 <param name='handover2' doc='Handover options for handover decision algorithm 2' />
2838 <param name='window' doc='Measurement averaging settings' />
2839 <param name='rxlev' doc='Received-Level averaging' />
Harald Welte7104ed22019-09-02 10:55:21 +02002840 <param name='averaging' doc='How many RxLev measurements to use for averaging' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01002841 <param name='&lt;1-10&gt;' doc='RxLev averaging: Number of values to average over' />
2842 <param name='default' doc='Use default (10), remove explicit setting on this node' />
2843 </params>
2844 </command>
2845 <command id='handover2 window rxqual averaging (&lt;1-10&gt;|default)'>
2846 <params>
2847 <param name='handover2' doc='Handover options for handover decision algorithm 2' />
2848 <param name='window' doc='Measurement averaging settings' />
2849 <param name='rxqual' doc='Received-Quality averaging' />
Harald Welte7104ed22019-09-02 10:55:21 +02002850 <param name='averaging' doc='How many RxQual measurements to use for averaging' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01002851 <param name='&lt;1-10&gt;' doc='RxQual averaging: Number of values to average over' />
2852 <param name='default' doc='Use default (1), remove explicit setting on this node' />
2853 </params>
2854 </command>
2855 <command id='handover2 window rxlev neighbor averaging (&lt;1-10&gt;|default)'>
2856 <params>
2857 <param name='handover2' doc='Handover options for handover decision algorithm 2' />
2858 <param name='window' doc='Measurement averaging settings' />
2859 <param name='rxlev' doc='Received-Level averaging' />
Harald Welte7104ed22019-09-02 10:55:21 +02002860 <param name='neighbor' doc='How many Neighbor RxLev measurements to use for averaging' />
2861 <param name='averaging' doc='How many Neighbor RxLev measurements to use for averaging' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01002862 <param name='&lt;1-10&gt;' doc='Neighbor RxLev averaging: Number of values to average over' />
2863 <param name='default' doc='Use default (10), remove explicit setting on this node' />
2864 </params>
2865 </command>
2866 <command id='handover2 power budget interval (&lt;1-99&gt;|default)'>
2867 <params>
2868 <param name='handover2' doc='Handover options for handover decision algorithm 2' />
2869 <param name='power' doc='Neighbor cell power triggering' />
2870 <param name='budget' doc='Neighbor cell power triggering' />
2871 <param name='interval' doc='How often to check for a better cell (SACCH frames)' />
2872 <param name='&lt;1-99&gt;' doc='Check for stronger neighbor every N number of SACCH frames' />
2873 <param name='default' doc='Use default (6), remove explicit setting on this node' />
2874 </params>
2875 </command>
2876 <command id='handover2 power budget hysteresis (&lt;0-999&gt;|default)'>
2877 <params>
2878 <param name='handover2' doc='Handover options for handover decision algorithm 2' />
2879 <param name='power' doc='Neighbor cell power triggering' />
2880 <param name='budget' doc='Neighbor cell power triggering' />
Neels Hofmeyr39e12152018-11-05 02:56:09 +01002881 <param name='hysteresis' doc='How many dB stronger must a neighbor be to become a HO candidate' />
2882 <param name='&lt;0-999&gt;' doc='Neighbor&apos;s strength difference in dB' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01002883 <param name='default' doc='Use default (3), remove explicit setting on this node' />
2884 </params>
2885 </command>
2886 <command id='handover2 maximum distance (&lt;0-9999&gt;|default)'>
2887 <params>
2888 <param name='handover2' doc='Handover options for handover decision algorithm 2' />
2889 <param name='maximum' doc='Maximum Timing-Advance value (i.e. MS distance) before triggering HO' />
2890 <param name='distance' doc='Maximum Timing-Advance value (i.e. MS distance) before triggering HO' />
2891 <param name='&lt;0-9999&gt;' doc='Maximum Timing-Advance value (i.e. MS distance) before triggering HO' />
2892 <param name='default' doc='Use default (9999), remove explicit setting on this node' />
2893 </params>
2894 </command>
2895 <command id='handover2 assignment (0|1|default)'>
2896 <params>
2897 <param name='handover2' doc='Handover options for handover decision algorithm 2' />
Harald Welte7104ed22019-09-02 10:55:21 +02002898 <param name='assignment' doc='Enable or disable in-call channel re-assignment within the same cell' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01002899 <param name='0' doc='Disable in-call assignment' />
2900 <param name='1' doc='Enable in-call assignment' />
2901 <param name='default' doc='Use default (0), remove explicit setting on this node' />
2902 </params>
2903 </command>
2904 <command id='handover2 tdma-measurement (full|subset|default)'>
2905 <params>
2906 <param name='handover2' doc='Handover options for handover decision algorithm 2' />
Neels Hofmeyr39e12152018-11-05 02:56:09 +01002907 <param name='tdma-measurement' doc='Define measurement set of TDMA frames' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01002908 <param name='full' doc='Full set of 102/104 TDMA frames' />
2909 <param name='subset' doc='Sub set of 4 TDMA frames (SACCH)' />
2910 <param name='default' doc='Use default (subset), remove explicit setting on this node' />
2911 </params>
2912 </command>
2913 <command id='handover2 min rxlev (&lt;-110--50&gt;|default)'>
2914 <params>
2915 <param name='handover2' doc='Handover options for handover decision algorithm 2' />
Neels Hofmeyr39e12152018-11-05 02:56:09 +01002916 <param name='min' doc='Minimum Level/Quality thresholds before triggering HO' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01002917 <param name='rxlev' doc='How weak may RxLev of an MS become before triggering HO' />
Harald Welte7104ed22019-09-02 10:55:21 +02002918 <param name='&lt;-110--50&gt;' doc='minimum RxLev (dBm; note: negative values)' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01002919 <param name='default' doc='Use default (-100), remove explicit setting on this node' />
2920 </params>
2921 </command>
2922 <command id='handover2 min rxqual (&lt;0-7&gt;|default)'>
2923 <params>
2924 <param name='handover2' doc='Handover options for handover decision algorithm 2' />
Neels Hofmeyr39e12152018-11-05 02:56:09 +01002925 <param name='min' doc='Minimum Level/Quality thresholds before triggering HO' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01002926 <param name='rxqual' doc='How bad may RxQual of an MS become before triggering HO' />
Neels Hofmeyr39e12152018-11-05 02:56:09 +01002927 <param name='&lt;0-7&gt;' doc='minimum RxQual' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01002928 <param name='default' doc='Use default (5), remove explicit setting on this node' />
2929 </params>
2930 </command>
2931 <command id='handover2 afs-bias rxlev (&lt;0-20&gt;|default)'>
2932 <params>
2933 <param name='handover2' doc='Handover options for handover decision algorithm 2' />
Neels Hofmeyr39e12152018-11-05 02:56:09 +01002934 <param name='afs-bias' doc='Configure bias to prefer AFS (AMR on TCH/F) over other codecs' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01002935 <param name='rxlev' doc='RxLev improvement bias for AFS over other codecs' />
Neels Hofmeyr39e12152018-11-05 02:56:09 +01002936 <param name='&lt;0-20&gt;' doc='Virtual RxLev improvement (dB)' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01002937 <param name='default' doc='Use default (0), remove explicit setting on this node' />
2938 </params>
2939 </command>
2940 <command id='handover2 afs-bias rxqual (&lt;0-7&gt;|default)'>
2941 <params>
2942 <param name='handover2' doc='Handover options for handover decision algorithm 2' />
Neels Hofmeyr39e12152018-11-05 02:56:09 +01002943 <param name='afs-bias' doc='Configure bias to prefer AFS (AMR on TCH/F) over other codecs' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01002944 <param name='rxqual' doc='RxQual improvement bias for AFS over other codecs' />
Neels Hofmeyr39e12152018-11-05 02:56:09 +01002945 <param name='&lt;0-7&gt;' doc='Virtual RxQual improvement' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01002946 <param name='default' doc='Use default (0), remove explicit setting on this node' />
2947 </params>
2948 </command>
2949 <command id='handover2 min-free-slots tch/f (&lt;0-9999&gt;|default)'>
2950 <params>
2951 <param name='handover2' doc='Handover options for handover decision algorithm 2' />
Neels Hofmeyr39e12152018-11-05 02:56:09 +01002952 <param name='min-free-slots' doc='Minimum free TCH timeslots before cell is considered congested' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01002953 <param name='tch/f' doc='Minimum free TCH/F timeslots before cell is considered congested' />
2954 <param name='&lt;0-9999&gt;' doc='Number of TCH/F slots' />
2955 <param name='default' doc='Use default (0), remove explicit setting on this node' />
2956 </params>
2957 </command>
2958 <command id='handover2 min-free-slots tch/h (&lt;0-9999&gt;|default)'>
2959 <params>
2960 <param name='handover2' doc='Handover options for handover decision algorithm 2' />
Neels Hofmeyr39e12152018-11-05 02:56:09 +01002961 <param name='min-free-slots' doc='Minimum free TCH timeslots before cell is considered congested' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01002962 <param name='tch/h' doc='Minimum free TCH/H timeslots before cell is considered congested' />
2963 <param name='&lt;0-9999&gt;' doc='Number of TCH/H slots' />
2964 <param name='default' doc='Use default (0), remove explicit setting on this node' />
2965 </params>
2966 </command>
2967 <command id='handover2 max-handovers (&lt;1-9999&gt;|default)'>
2968 <params>
2969 <param name='handover2' doc='Handover options for handover decision algorithm 2' />
Neels Hofmeyr39e12152018-11-05 02:56:09 +01002970 <param name='max-handovers' doc='Maximum number of concurrent handovers allowed per cell' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01002971 <param name='&lt;1-9999&gt;' doc='Number' />
2972 <param name='default' doc='Use default (9999), remove explicit setting on this node' />
2973 </params>
2974 </command>
2975 <command id='handover2 penalty-time max-distance (&lt;0-99999&gt;|default)'>
2976 <params>
2977 <param name='handover2' doc='Handover options for handover decision algorithm 2' />
Neels Hofmeyr39e12152018-11-05 02:56:09 +01002978 <param name='penalty-time' doc='Set penalty times to wait between repeated handovers' />
Harald Welte7104ed22019-09-02 10:55:21 +02002979 <param name='max-distance' doc='Time to suspend handover for a subscriber after leaving this cell due to exceeding max distance; see also &apos;handover2 retries&apos;' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01002980 <param name='&lt;0-99999&gt;' doc='Seconds' />
2981 <param name='default' doc='Use default (300), remove explicit setting on this node' />
2982 </params>
2983 </command>
2984 <command id='handover2 penalty-time failed-ho (&lt;0-99999&gt;|default)'>
2985 <params>
2986 <param name='handover2' doc='Handover options for handover decision algorithm 2' />
Neels Hofmeyr39e12152018-11-05 02:56:09 +01002987 <param name='penalty-time' doc='Set penalty times to wait between repeated handovers' />
Harald Welte7104ed22019-09-02 10:55:21 +02002988 <param name='failed-ho' doc='Time to suspend handover for a subscriber after a failed handover into this cell; see also &apos;handover2 retries&apos;' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01002989 <param name='&lt;0-99999&gt;' doc='Seconds' />
2990 <param name='default' doc='Use default (60), remove explicit setting on this node' />
2991 </params>
2992 </command>
2993 <command id='handover2 penalty-time failed-assignment (&lt;0-99999&gt;|default)'>
2994 <params>
2995 <param name='handover2' doc='Handover options for handover decision algorithm 2' />
Neels Hofmeyr39e12152018-11-05 02:56:09 +01002996 <param name='penalty-time' doc='Set penalty times to wait between repeated handovers' />
Harald Welte7104ed22019-09-02 10:55:21 +02002997 <param name='failed-assignment' doc='Time to suspend handover for a subscriber after a failed re-assignment within this cell; see also &apos;handover2 retries&apos;' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01002998 <param name='&lt;0-99999&gt;' doc='Seconds' />
2999 <param name='default' doc='Use default (60), remove explicit setting on this node' />
3000 </params>
3001 </command>
3002 <command id='handover2 retries (&lt;0-9&gt;|default)'>
3003 <params>
3004 <param name='handover2' doc='Handover options for handover decision algorithm 2' />
Harald Welte7104ed22019-09-02 10:55:21 +02003005 <param name='retries' doc='Number of times to immediately retry a failed handover/assignment, before a penalty time is applied' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01003006 <param name='&lt;0-9&gt;' doc='Number of retries' />
3007 <param name='default' doc='Use default (0), remove explicit setting on this node' />
3008 </params>
3009 </command>
Neels Hofmeyr9f157572018-03-06 14:59:00 +01003010 <command id='handover2 congestion-check (disabled|&lt;1-999&gt;|now)'>
3011 <params>
3012 <param name='handover2' doc='Handover options for handover decision algorithm 2' />
Neels Hofmeyr39e12152018-11-05 02:56:09 +01003013 <param name='congestion-check' doc='Configure congestion check interval' />
Harald Welte7104ed22019-09-02 10:55:21 +02003014 <param name='disabled' doc='Disable congestion checking, do not handover based on cell load. Note: there is one global congestion check interval, i.e. contrary to other handover2 settings, this is not configurable per individual cell.' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01003015 <param name='&lt;1-999&gt;' doc='Congestion check interval in seconds (default 10)' />
3016 <param name='now' doc='Manually trigger a congestion check to run right now' />
3017 </params>
3018 </command>
3019 </node>
3020 <node id='config-net-bts'>
3021 <name>config-net-bts</name>
3022 <command id='type (unknown|bs11|nanobts|rbs2000|nokia_site|sysmobts)'>
3023 <params>
3024 <param name='type' doc='BTS Vendor/Type' />
3025 <param name='unknown' doc='Unknown BTS Type' />
3026 <param name='bs11' doc='Siemens BTS (BS-11 or compatible)' />
3027 <param name='nanobts' doc='ip.access nanoBTS or compatible' />
3028 <param name='rbs2000' doc='Ericsson RBS2000 Series' />
3029 <param name='nokia_site' doc='Nokia {Metro,Ultra,In}Site' />
3030 <param name='sysmobts' doc='sysmocom sysmoBTS' />
3031 </params>
3032 </command>
3033 <command id='description .TEXT'>
3034 <params>
3035 <param name='description' doc='Save human-readable description of the object' />
3036 <param name='.TEXT' doc='Text until the end of the line' />
3037 </params>
3038 </command>
3039 <command id='no description'>
3040 <params>
3041 <param name='no' doc='Negate a command or set its defaults' />
3042 <param name='description' doc='Remove description of the object' />
3043 </params>
3044 </command>
3045 <command id='band BAND'>
3046 <params>
3047 <param name='band' doc='Set the frequency band of this BTS' />
3048 <param name='BAND' doc='Frequency band' />
3049 </params>
3050 </command>
3051 <command id='cell_identity &lt;0-65535&gt;'>
3052 <params>
3053 <param name='cell_identity' doc='Set the Cell identity of this BTS' />
3054 <param name='&lt;0-65535&gt;' doc='Cell Identity' />
3055 </params>
3056 </command>
3057 <command id='dtx uplink [force]'>
3058 <params>
3059 <param name='dtx' doc='Configure discontinuous transmission' />
3060 <param name='uplink' doc='Enable Uplink DTX for this BTS' />
3061 <param name='[force]' doc='MS &apos;shall&apos; use DTXu instead of &apos;may&apos; use (might not be supported by older phones).' />
3062 </params>
3063 </command>
3064 <command id='dtx downlink'>
3065 <params>
3066 <param name='dtx' doc='Configure discontinuous transmission' />
3067 <param name='downlink' doc='Enable Downlink DTX for this BTS' />
3068 </params>
3069 </command>
3070 <command id='no dtx uplink'>
3071 <params>
3072 <param name='no' doc='Negate a command or set its defaults' />
3073 <param name='dtx' doc='Configure discontinuous transmission' />
3074 <param name='uplink' doc='Disable Uplink DTX for this BTS' />
3075 </params>
3076 </command>
3077 <command id='no dtx downlink'>
3078 <params>
3079 <param name='no' doc='Negate a command or set its defaults' />
3080 <param name='dtx' doc='Configure discontinuous transmission' />
3081 <param name='downlink' doc='Disable Downlink DTX for this BTS' />
3082 </params>
3083 </command>
3084 <command id='location_area_code &lt;0-65535&gt;'>
3085 <params>
3086 <param name='location_area_code' doc='Set the Location Area Code (LAC) of this BTS' />
3087 <param name='&lt;0-65535&gt;' doc='LAC' />
3088 </params>
3089 </command>
Neels Hofmeyr9f157572018-03-06 14:59:00 +01003090 <command id='base_station_id_code &lt;0-63&gt;'>
3091 <params>
3092 <param name='base_station_id_code' doc='Set the Base Station Identity Code (BSIC) of this BTS' />
3093 <param name='&lt;0-63&gt;' doc='BSIC of this BTS' />
3094 </params>
3095 </command>
Eric Wild10def2c2019-06-04 13:38:28 +02003096 <command id='ipa unit-id &lt;0-65534&gt; &lt;0-255&gt;'>
Neels Hofmeyr9f157572018-03-06 14:59:00 +01003097 <params>
Harald Welte7104ed22019-09-02 10:55:21 +02003098 <param name='ipa' doc='Abis/IP specific options' />
3099 <param name='unit-id' doc='Set the IPA BTS Unit ID' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01003100 <param name='&lt;0-65534&gt;' doc='Unit ID (Site)' />
3101 <param name='&lt;0-255&gt;' doc='Unit ID (BTS)' />
3102 </params>
3103 </command>
Eric Wild10def2c2019-06-04 13:38:28 +02003104 <command id='ipa rsl-ip A.B.C.D'>
Neels Hofmeyr9f157572018-03-06 14:59:00 +01003105 <params>
Harald Welte7104ed22019-09-02 10:55:21 +02003106 <param name='ipa' doc='Abis/IP specific options' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01003107 <param name='rsl-ip' doc='Set the IPA RSL IP Address of the BSC' />
3108 <param name='A.B.C.D' doc='Destination IP address for RSL connection' />
3109 </params>
3110 </command>
3111 <command id='nokia_site skip-reset (0|1)'>
3112 <params>
3113 <param name='nokia_site' doc='Nokia *Site related commands' />
3114 <param name='skip-reset' doc='Skip the reset step during bootstrap process of this BTS' />
3115 <param name='0' doc='Do NOT skip the reset' />
3116 <param name='1' doc='Skip the reset' />
3117 </params>
3118 </command>
3119 <command id='nokia_site no-local-rel-conf (0|1)'>
3120 <params>
3121 <param name='nokia_site' doc='Nokia *Site related commands' />
3122 <param name='no-local-rel-conf' doc='Do not wait for RELease CONFirm message when releasing channel locally' />
3123 <param name='0' doc='Wait for RELease CONFirm' />
3124 <param name='1' doc='Do not wait for RELease CONFirm' />
3125 </params>
3126 </command>
3127 <command id='nokia_site bts-reset-timer &lt;15-100&gt;'>
3128 <params>
3129 <param name='nokia_site' doc='Nokia *Site related commands' />
3130 <param name='bts-reset-timer' doc='The amount of time (in sec.) between BTS_RESET is sent,' />
3131 <param name='&lt;15-100&gt;' doc='and the BTS is being bootstrapped.' />
3132 </params>
3133 </command>
Eric Wild10def2c2019-06-04 13:38:28 +02003134 <command id='oml ipa stream-id &lt;0-255&gt; line E1_LINE'>
Neels Hofmeyr9f157572018-03-06 14:59:00 +01003135 <params>
3136 <param name='oml' doc='Organization &amp; Maintenance Link' />
Harald Welte7104ed22019-09-02 10:55:21 +02003137 <param name='ipa' doc='A-bis/IP Specific Options' />
3138 <param name='stream-id' doc='Set the ipa Stream ID of the OML link of this BTS' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01003139 <param name='&lt;0-255&gt;' doc='Stream Identifier' />
3140 <param name='line' doc='Virtual E1 Line Number' />
3141 <param name='E1_LINE' doc='Virtual E1 Line Number' />
3142 </params>
3143 </command>
3144 <command id='oml e1 line E1_LINE timeslot &lt;1-31&gt; sub-slot (0|1|2|3|full)'>
3145 <params>
3146 <param name='oml' doc='Organization &amp; Maintenance Link' />
3147 <param name='e1' doc='OML E1/T1 Configuration' />
3148 <param name='line' doc='E1/T1 line number to be used for OML' />
3149 <param name='E1_LINE' doc='E1/T1 line number to be used for OML' />
3150 <param name='timeslot' doc='E1/T1 timeslot to be used for OML' />
3151 <param name='&lt;1-31&gt;' doc='E1/T1 timeslot to be used for OML' />
3152 <param name='sub-slot' doc='E1/T1 sub-slot to be used for OML' />
3153 <param name='0' doc='Use E1/T1 sub-slot 0' />
3154 <param name='1' doc='Use E1/T1 sub-slot 1' />
3155 <param name='2' doc='Use E1/T1 sub-slot 2' />
3156 <param name='3' doc='Use E1/T1 sub-slot 3' />
3157 <param name='full' doc='Use full E1 slot 3' />
3158 </params>
3159 </command>
3160 <command id='oml e1 tei &lt;0-63&gt;'>
3161 <params>
3162 <param name='oml' doc='Organization &amp; Maintenance Link' />
3163 <param name='e1' doc='OML E1/T1 Configuration' />
3164 <param name='tei' doc='Set the TEI to be used for OML' />
3165 <param name='&lt;0-63&gt;' doc='TEI Number' />
3166 </params>
3167 </command>
3168 <command id='channel allocator (ascending|descending)'>
3169 <params>
Ruben Undheim06e6f8a2019-07-16 21:13:12 +02003170 <param name='channel' doc='Channel Allocator' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01003171 <param name='allocator' doc='Channel Allocator' />
3172 <param name='ascending' doc='Allocate Timeslots and Transceivers in ascending order' />
3173 <param name='descending' doc='Allocate Timeslots and Transceivers in descending order' />
3174 </params>
3175 </command>
3176 <command id='rach tx integer &lt;0-15&gt;'>
3177 <params>
3178 <param name='rach' doc='Random Access Control Channel' />
3179 <param name='tx' doc='Set the raw tx integer value in RACH Control parameters IE' />
3180 <param name='integer' doc='Set the raw tx integer value in RACH Control parameters IE' />
3181 <param name='&lt;0-15&gt;' doc='Raw tx integer value in RACH Control parameters IE' />
3182 </params>
3183 </command>
3184 <command id='rach max transmission (1|2|4|7)'>
3185 <params>
3186 <param name='rach' doc='Random Access Control Channel' />
3187 <param name='max' doc='Set the maximum number of RACH burst transmissions' />
3188 <param name='transmission' doc='Set the maximum number of RACH burst transmissions' />
3189 <param name='1' doc='Maximum number of 1 RACH burst transmissions' />
3190 <param name='2' doc='Maximum number of 2 RACH burst transmissions' />
3191 <param name='4' doc='Maximum number of 4 RACH burst transmissions' />
3192 <param name='7' doc='Maximum number of 7 RACH burst transmissions' />
3193 </params>
3194 </command>
Harald Welte7fbcc2e2019-06-18 10:58:21 +02003195 <command id='channel-description attach (0|1)'>
Neels Hofmeyr9f157572018-03-06 14:59:00 +01003196 <params>
Harald Welte7fbcc2e2019-06-18 10:58:21 +02003197 <param name='channel-description' doc='Channel Description' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01003198 <param name='attach' doc='Set if attachment is required' />
3199 <param name='0' doc='Attachment is NOT required' />
3200 <param name='1' doc='Attachment is required (standard)' />
3201 </params>
3202 </command>
Harald Welte7fbcc2e2019-06-18 10:58:21 +02003203 <command id='channel-description bs-pa-mfrms &lt;2-9&gt;'>
Neels Hofmeyr9f157572018-03-06 14:59:00 +01003204 <params>
Harald Welte7fbcc2e2019-06-18 10:58:21 +02003205 <param name='channel-description' doc='Channel Description' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01003206 <param name='bs-pa-mfrms' doc='Set number of multiframe periods for paging groups' />
3207 <param name='&lt;2-9&gt;' doc='Number of multiframe periods for paging groups' />
3208 </params>
3209 </command>
Harald Welte7fbcc2e2019-06-18 10:58:21 +02003210 <command id='channel-description bs-ag-blks-res &lt;0-7&gt;'>
Neels Hofmeyr9f157572018-03-06 14:59:00 +01003211 <params>
Harald Welte7fbcc2e2019-06-18 10:58:21 +02003212 <param name='channel-description' doc='Channel Description' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01003213 <param name='bs-ag-blks-res' doc='Set number of blocks reserved for access grant' />
3214 <param name='&lt;0-7&gt;' doc='Number of blocks reserved for access grant' />
3215 </params>
3216 </command>
Daniel Willmannf450f442019-06-06 17:52:25 +02003217 <command id='ccch load-indication-threshold &lt;0-100&gt;'>
3218 <params>
3219 <param name='ccch' doc='Common Control Channel' />
3220 <param name='load-indication-threshold' doc='Percentage of CCCH load at which BTS sends RSL CCCH LOAD IND' />
3221 <param name='&lt;0-100&gt;' doc='CCCH Load Threshold in percent (Default: 10)' />
3222 </params>
3223 </command>
Neels Hofmeyr9f157572018-03-06 14:59:00 +01003224 <command id='rach nm busy threshold &lt;0-255&gt;'>
3225 <params>
3226 <param name='rach' doc='Random Access Control Channel' />
3227 <param name='nm' doc='Network Management' />
3228 <param name='busy' doc='Set the NM Busy Threshold' />
3229 <param name='threshold' doc='Set the NM Busy Threshold' />
3230 <param name='&lt;0-255&gt;' doc='NM Busy Threshold in dB' />
3231 </params>
3232 </command>
3233 <command id='rach nm load average &lt;0-65535&gt;'>
3234 <params>
3235 <param name='rach' doc='Random Access Control Channel' />
3236 <param name='nm' doc='Network Management' />
3237 <param name='load' doc='Set the NM Loadaverage Slots value' />
3238 <param name='average' doc='Set the NM Loadaverage Slots value' />
3239 <param name='&lt;0-65535&gt;' doc='NM Loadaverage Slots value' />
3240 </params>
3241 </command>
3242 <command id='cell barred (0|1)'>
3243 <params>
3244 <param name='cell' doc='Should this cell be barred from access?' />
3245 <param name='barred' doc='Should this cell be barred from access?' />
3246 <param name='0' doc='Cell should NOT be barred' />
3247 <param name='1' doc='Cell should be barred' />
3248 </params>
3249 </command>
3250 <command id='rach emergency call allowed (0|1)'>
3251 <params>
3252 <param name='rach' doc='Random Access Control Channel' />
3253 <param name='emergency' doc='Should this cell allow emergency calls?' />
3254 <param name='call' doc='Should this cell allow emergency calls?' />
3255 <param name='allowed' doc='Should this cell allow emergency calls?' />
3256 <param name='0' doc='Do NOT allow emergency calls' />
3257 <param name='1' doc='Allow emergency calls' />
3258 </params>
3259 </command>
3260 <command id='rach access-control-class (0|1|2|3|4|5|6|7|8|9|11|12|13|14|15) (barred|allowed)'>
3261 <params>
3262 <param name='rach' doc='Random Access Control Channel' />
3263 <param name='access-control-class' doc='Set access control class' />
3264 <param name='0' doc='Access control class 0' />
3265 <param name='1' doc='Access control class 1' />
3266 <param name='2' doc='Access control class 2' />
3267 <param name='3' doc='Access control class 3' />
3268 <param name='4' doc='Access control class 4' />
3269 <param name='5' doc='Access control class 5' />
3270 <param name='6' doc='Access control class 6' />
3271 <param name='7' doc='Access control class 7' />
3272 <param name='8' doc='Access control class 8' />
3273 <param name='9' doc='Access control class 9' />
3274 <param name='11' doc='Access control class 11 for PLMN use' />
3275 <param name='12' doc='Access control class 12 for security services' />
3276 <param name='13' doc='Access control class 13 for public utilities (e.g. water/gas suppliers)' />
3277 <param name='14' doc='Access control class 14 for emergency services' />
3278 <param name='15' doc='Access control class 15 for PLMN staff' />
3279 <param name='barred' doc='barred to use access control class' />
3280 <param name='allowed' doc='allowed to use access control class' />
3281 </params>
3282 </command>
3283 <command id='ms max power &lt;0-40&gt;'>
3284 <params>
3285 <param name='ms' doc='MS Options' />
3286 <param name='max' doc='Maximum transmit power of the MS' />
3287 <param name='power' doc='Maximum transmit power of the MS' />
3288 <param name='&lt;0-40&gt;' doc='Maximum transmit power of the MS in dBm' />
3289 </params>
3290 </command>
3291 <command id='cell reselection hysteresis &lt;0-14&gt;'>
3292 <params>
3293 <param name='cell' doc='Cell Parameters' />
3294 <param name='reselection' doc='Cell re-selection parameters' />
3295 <param name='hysteresis' doc='Cell Re-Selection Hysteresis in dB' />
3296 <param name='&lt;0-14&gt;' doc='Cell Re-Selection Hysteresis in dB' />
3297 </params>
3298 </command>
3299 <command id='rxlev access min &lt;0-63&gt;'>
3300 <params>
3301 <param name='rxlev' doc='Minimum RxLev needed for cell access' />
3302 <param name='access' doc='Minimum RxLev needed for cell access' />
3303 <param name='min' doc='Minimum RxLev needed for cell access' />
3304 <param name='&lt;0-63&gt;' doc='Minimum RxLev needed for cell access (better than -110dBm)' />
3305 </params>
3306 </command>
3307 <command id='cell bar qualify (0|1)'>
3308 <params>
3309 <param name='cell' doc='Cell Parameters' />
3310 <param name='bar' doc='Cell Bar Qualify' />
3311 <param name='qualify' doc='Cell Bar Qualify' />
3312 <param name='0' doc='Set CBQ to 0' />
3313 <param name='1' doc='Set CBQ to 1' />
3314 </params>
3315 </command>
3316 <command id='cell reselection offset &lt;0-126&gt;'>
3317 <params>
3318 <param name='cell' doc='Cell Parameters' />
3319 <param name='reselection' doc='Cell Re-Selection Parameters' />
3320 <param name='offset' doc='Cell Re-Selection Offset (CRO) in dB' />
3321 <param name='&lt;0-126&gt;' doc='Cell Re-Selection Offset (CRO) in dB' />
3322 </params>
3323 </command>
3324 <command id='temporary offset &lt;0-60&gt;'>
3325 <params>
3326 <param name='temporary' doc='Cell selection temporary negative offset' />
3327 <param name='offset' doc='Cell selection temporary negative offset' />
3328 <param name='&lt;0-60&gt;' doc='Cell selection temporary negative offset in dB' />
3329 </params>
3330 </command>
3331 <command id='temporary offset infinite'>
3332 <params>
3333 <param name='temporary' doc='Cell selection temporary negative offset' />
3334 <param name='offset' doc='Cell selection temporary negative offset' />
3335 <param name='infinite' doc='Sets cell selection temporary negative offset to infinity' />
3336 </params>
3337 </command>
3338 <command id='penalty time &lt;20-620&gt;'>
3339 <params>
3340 <param name='penalty' doc='Cell selection penalty time' />
3341 <param name='time' doc='Cell selection penalty time' />
3342 <param name='&lt;20-620&gt;' doc='Cell selection penalty time in seconds (by 20s increments)' />
3343 </params>
3344 </command>
3345 <command id='penalty time reserved'>
3346 <params>
3347 <param name='penalty' doc='Cell selection penalty time' />
3348 <param name='time' doc='Cell selection penalty time' />
3349 <param name='reserved' doc='Set cell selection penalty time to reserved value 31, (indicate that CELL_RESELECT_OFFSET is subtracted from C2 and TEMPORARY_OFFSET is ignored)' />
3350 </params>
3351 </command>
3352 <command id='radio-link-timeout &lt;4-64&gt;'>
3353 <params>
3354 <param name='radio-link-timeout' doc='Radio link timeout criterion (BTS side)' />
3355 <param name='&lt;4-64&gt;' doc='Radio link timeout value (lost SACCH block)' />
3356 </params>
3357 </command>
3358 <command id='radio-link-timeout infinite'>
3359 <params>
3360 <param name='radio-link-timeout' doc='Radio link timeout criterion (BTS side)' />
3361 <param name='infinite' doc='Infinite Radio link timeout value (use only for BTS RF testing)' />
3362 </params>
3363 </command>
3364 <command id='gprs mode (none|gprs|egprs)'>
3365 <params>
3366 <param name='gprs' doc='GPRS Packet Network' />
3367 <param name='mode' doc='GPRS Mode for this BTS' />
3368 <param name='none' doc='GPRS Disabled on this BTS' />
3369 <param name='gprs' doc='GPRS Enabled on this BTS' />
3370 <param name='egprs' doc='EGPRS (EDGE) Enabled on this BTS' />
3371 </params>
3372 </command>
3373 <command id='gprs 11bit_rach_support_for_egprs (0|1)'>
3374 <params>
3375 <param name='gprs' doc='GPRS Packet Network' />
3376 <param name='11bit_rach_support_for_egprs' doc='11 bit RACH options' />
3377 <param name='0' doc='Disable 11 bit RACH for EGPRS' />
3378 <param name='1' doc='Enable 11 bit RACH for EGPRS' />
3379 </params>
3380 </command>
Daniel Willmannf450f442019-06-06 17:52:25 +02003381 <command id='gprs ns timer (tns-block|tns-block-retries|tns-reset|tns-reset-retries|tns-test|tns-alive|tns-alive-retries|tsns-prov) &lt;0-255&gt;'>
Neels Hofmeyr9f157572018-03-06 14:59:00 +01003382 <params>
3383 <param name='gprs' doc='GPRS Packet Network' />
3384 <param name='ns' doc='Network Service' />
3385 <param name='timer' doc='Network Service Timer' />
3386 <param name='tns-block' doc='(un)blocking Timer (Tns-block) timeout' />
3387 <param name='tns-block-retries' doc='(un)blocking Timer (Tns-block) number of retries' />
3388 <param name='tns-reset' doc='Reset Timer (Tns-reset) timeout' />
3389 <param name='tns-reset-retries' doc='Reset Timer (Tns-reset) number of retries' />
3390 <param name='tns-test' doc='Test Timer (Tns-test) timeout' />
3391 <param name='tns-alive' doc='Alive Timer (Tns-alive) timeout' />
3392 <param name='tns-alive-retries' doc='Alive Timer (Tns-alive) number of retries' />
Daniel Willmannf450f442019-06-06 17:52:25 +02003393 <param name='tsns-prov' doc='SNS Provision Timer (Tsns-prov) timeout' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01003394 <param name='&lt;0-255&gt;' doc='Timer Value' />
3395 </params>
3396 </command>
3397 <command id='gprs routing area &lt;0-255&gt;'>
3398 <params>
3399 <param name='gprs' doc='GPRS Packet Network' />
3400 <param name='routing' doc='GPRS Routing Area Code' />
3401 <param name='area' doc='GPRS Routing Area Code' />
3402 <param name='&lt;0-255&gt;' doc='GPRS Routing Area Code' />
3403 </params>
3404 </command>
3405 <command id='gprs network-control-order (nc0|nc1|nc2)'>
3406 <params>
3407 <param name='gprs' doc='GPRS Packet Network' />
3408 <param name='network-control-order' doc='GPRS Network Control Order' />
3409 <param name='nc0' doc='MS controlled cell re-selection, no measurement reporting' />
3410 <param name='nc1' doc='MS controlled cell re-selection, MS sends measurement reports' />
3411 <param name='nc2' doc='Network controlled cell re-selection, MS sends measurement reports' />
3412 </params>
3413 </command>
3414 <command id='gprs control-ack-type-rach'>
3415 <params>
3416 <param name='gprs' doc='GPRS Packet Network' />
3417 <param name='control-ack-type-rach' doc='Set GPRS Control Ack Type for PACKET CONTROL ACKNOWLEDGMENT message to four access bursts format instead of default RLC/MAC control block' />
3418 </params>
3419 </command>
3420 <command id='no gprs control-ack-type-rach'>
3421 <params>
3422 <param name='no' doc='Negate a command or set its defaults' />
3423 <param name='gprs' doc='GPRS Packet Network' />
3424 <param name='control-ack-type-rach' doc='Set GPRS Control Ack Type for PACKET CONTROL ACKNOWLEDGMENT message to four access bursts format instead of default RLC/MAC control block' />
3425 </params>
3426 </command>
3427 <command id='gprs cell bvci &lt;2-65535&gt;'>
3428 <params>
3429 <param name='gprs' doc='GPRS Packet Network' />
3430 <param name='cell' doc='GPRS Cell Settings' />
3431 <param name='bvci' doc='GPRS BSSGP VC Identifier' />
3432 <param name='&lt;2-65535&gt;' doc='GPRS BSSGP VC Identifier' />
3433 </params>
3434 </command>
3435 <command id='gprs cell timer (blocking-timer|blocking-retries|unblocking-retries|reset-timer|reset-retries|suspend-timer|suspend-retries|resume-timer|resume-retries|capability-update-timer|capability-update-retries) &lt;0-255&gt;'>
3436 <params>
3437 <param name='gprs' doc='GPRS Packet Network' />
3438 <param name='cell' doc='Cell / BSSGP' />
3439 <param name='timer' doc='Cell/BSSGP Timer' />
3440 <param name='blocking-timer' doc='Tbvc-block timeout' />
3441 <param name='blocking-retries' doc='Tbvc-block retries' />
3442 <param name='unblocking-retries' doc='Tbvc-unblock retries' />
3443 <param name='reset-timer' doc='Tbvcc-reset timeout' />
3444 <param name='reset-retries' doc='Tbvc-reset retries' />
3445 <param name='suspend-timer' doc='Tbvc-suspend timeout' />
3446 <param name='suspend-retries' doc='Tbvc-suspend retries' />
3447 <param name='resume-timer' doc='Tbvc-resume timeout' />
3448 <param name='resume-retries' doc='Tbvc-resume retries' />
3449 <param name='capability-update-timer' doc='Tbvc-capa-update timeout' />
3450 <param name='capability-update-retries' doc='Tbvc-capa-update retries' />
3451 <param name='&lt;0-255&gt;' doc='Timer Value' />
3452 </params>
3453 </command>
3454 <command id='gprs nsei &lt;0-65535&gt;'>
3455 <params>
3456 <param name='gprs' doc='GPRS Packet Network' />
3457 <param name='nsei' doc='GPRS NS Entity Identifier' />
3458 <param name='&lt;0-65535&gt;' doc='GPRS NS Entity Identifier' />
3459 </params>
3460 </command>
3461 <command id='gprs nsvc &lt;0-1&gt; nsvci &lt;0-65535&gt;'>
3462 <params>
3463 <param name='gprs' doc='GPRS Packet Network' />
3464 <param name='nsvc' doc='Network Service Virtual Connection (NS-VC)' />
3465 <param name='&lt;0-1&gt;' doc='NSVC Logical Number' />
3466 <param name='nsvci' doc='NS Virtual Connection Identifier' />
3467 <param name='&lt;0-65535&gt;' doc='GPRS NS VC Identifier' />
3468 </params>
3469 </command>
3470 <command id='gprs nsvc &lt;0-1&gt; local udp port &lt;0-65535&gt;'>
3471 <params>
3472 <param name='gprs' doc='GPRS Packet Network' />
3473 <param name='nsvc' doc='Network Service Virtual Connection (NS-VC)' />
3474 <param name='&lt;0-1&gt;' doc='NSVC Logical Number' />
3475 <param name='local' doc='GPRS NS Local UDP Port' />
3476 <param name='udp' doc='GPRS NS Local UDP Port' />
3477 <param name='port' doc='GPRS NS Local UDP Port' />
3478 <param name='&lt;0-65535&gt;' doc='GPRS NS Local UDP Port Number' />
3479 </params>
3480 </command>
3481 <command id='gprs nsvc &lt;0-1&gt; remote udp port &lt;0-65535&gt;'>
3482 <params>
3483 <param name='gprs' doc='GPRS Packet Network' />
3484 <param name='nsvc' doc='Network Service Virtual Connection (NS-VC)' />
3485 <param name='&lt;0-1&gt;' doc='NSVC Logical Number' />
3486 <param name='remote' doc='GPRS NS Remote UDP Port' />
3487 <param name='udp' doc='GPRS NS Remote UDP Port' />
3488 <param name='port' doc='GPRS NS Remote UDP Port' />
3489 <param name='&lt;0-65535&gt;' doc='GPRS NS Remote UDP Port Number' />
3490 </params>
3491 </command>
3492 <command id='gprs nsvc &lt;0-1&gt; remote ip A.B.C.D'>
3493 <params>
3494 <param name='gprs' doc='GPRS Packet Network' />
3495 <param name='nsvc' doc='Network Service Virtual Connection (NS-VC)' />
3496 <param name='&lt;0-1&gt;' doc='NSVC Logical Number' />
3497 <param name='remote' doc='GPRS NS Remote IP Address' />
3498 <param name='ip' doc='GPRS NS Remote IP Address' />
3499 <param name='A.B.C.D' doc='GPRS NS Remote IP Address' />
3500 </params>
3501 </command>
3502 <command id='paging free &lt;-1-1024&gt;'>
3503 <params>
3504 <param name='paging' doc='Paging options' />
3505 <param name='free' doc='Only page when having a certain amount of free slots' />
3506 <param name='&lt;-1-1024&gt;' doc='amount of required free paging slots. -1 to disable' />
3507 </params>
3508 </command>
3509 <command id='system-information (1|2|3|4|5|6|7|8|9|10|13|16|17|18|19|20|2bis|2ter|2quater|5bis|5ter) mode (static|computed)'>
3510 <params>
3511 <param name='system-information' doc='System Information Messages' />
3512 <param name='1' doc='System Information Type 1' />
3513 <param name='2' doc='System Information Type 2' />
3514 <param name='3' doc='System Information Type 3' />
3515 <param name='4' doc='System Information Type 4' />
3516 <param name='5' doc='System Information Type 5' />
3517 <param name='6' doc='System Information Type 6' />
3518 <param name='7' doc='System Information Type 7' />
3519 <param name='8' doc='System Information Type 8' />
3520 <param name='9' doc='System Information Type 9' />
3521 <param name='10' doc='System Information Type 10' />
3522 <param name='13' doc='System Information Type 13' />
3523 <param name='16' doc='System Information Type 16' />
3524 <param name='17' doc='System Information Type 17' />
3525 <param name='18' doc='System Information Type 18' />
3526 <param name='19' doc='System Information Type 19' />
3527 <param name='20' doc='System Information Type 20' />
3528 <param name='2bis' doc='System Information Type 2bis' />
3529 <param name='2ter' doc='System Information Type 2ter' />
3530 <param name='2quater' doc='System Information Type 2quater' />
3531 <param name='5bis' doc='System Information Type 5bis' />
3532 <param name='5ter' doc='System Information Type 5ter' />
3533 <param name='mode' doc='System Information Mode' />
3534 <param name='static' doc='Static user-specified' />
3535 <param name='computed' doc='Dynamic, BSC-computed' />
3536 </params>
3537 </command>
3538 <command id='system-information (1|2|3|4|5|6|7|8|9|10|13|16|17|18|19|20|2bis|2ter|2quater|5bis|5ter) static HEXSTRING'>
3539 <params>
3540 <param name='system-information' doc='System Information Messages' />
3541 <param name='1' doc='System Information Type 1' />
3542 <param name='2' doc='System Information Type 2' />
3543 <param name='3' doc='System Information Type 3' />
3544 <param name='4' doc='System Information Type 4' />
3545 <param name='5' doc='System Information Type 5' />
3546 <param name='6' doc='System Information Type 6' />
3547 <param name='7' doc='System Information Type 7' />
3548 <param name='8' doc='System Information Type 8' />
3549 <param name='9' doc='System Information Type 9' />
3550 <param name='10' doc='System Information Type 10' />
3551 <param name='13' doc='System Information Type 13' />
3552 <param name='16' doc='System Information Type 16' />
3553 <param name='17' doc='System Information Type 17' />
3554 <param name='18' doc='System Information Type 18' />
3555 <param name='19' doc='System Information Type 19' />
3556 <param name='20' doc='System Information Type 20' />
3557 <param name='2bis' doc='System Information Type 2bis' />
3558 <param name='2ter' doc='System Information Type 2ter' />
3559 <param name='2quater' doc='System Information Type 2quater' />
3560 <param name='5bis' doc='System Information Type 5bis' />
3561 <param name='5ter' doc='System Information Type 5ter' />
3562 <param name='static' doc='Static System Information filling' />
3563 <param name='HEXSTRING' doc='Static user-specified SI content in HEX notation' />
3564 </params>
3565 </command>
Daniel Willmannf450f442019-06-06 17:52:25 +02003566 <command id='system-information unused-send-empty'>
3567 <params>
3568 <param name='system-information' doc='System Information Messages' />
3569 <param name='unused-send-empty' doc='Send BCCH Info with empty &apos;Full BCCH Info&apos; TLV to notify disabled SI. Some nanoBTS fw versions are known to fail upon receival of these messages.' />
3570 </params>
3571 </command>
3572 <command id='no system-information unused-send-empty'>
3573 <params>
3574 <param name='no' doc='Negate a command or set its defaults' />
3575 <param name='system-information' doc='System Information Messages' />
3576 <param name='unused-send-empty' doc='Avoid sending BCCH Info with empty &apos;Full BCCH Info&apos; TLV to notify disabled SI. Some nanoBTS fw versions are known to fail upon receival of these messages.' />
3577 </params>
3578 </command>
Neels Hofmeyr9f157572018-03-06 14:59:00 +01003579 <command id='early-classmark-sending (allowed|forbidden)'>
3580 <params>
3581 <param name='early-classmark-sending' doc='Early Classmark Sending' />
3582 <param name='allowed' doc='Early Classmark Sending is allowed' />
3583 <param name='forbidden' doc='Early Classmark Sending is forbidden' />
3584 </params>
3585 </command>
3586 <command id='early-classmark-sending-3g (allowed|forbidden)'>
3587 <params>
3588 <param name='early-classmark-sending-3g' doc='3G Early Classmark Sending' />
3589 <param name='allowed' doc='3G Early Classmark Sending is allowed' />
3590 <param name='forbidden' doc='3G Early Classmark Sending is forbidden' />
3591 </params>
3592 </command>
3593 <command id='neighbor-list mode (automatic|manual|manual-si5)'>
3594 <params>
3595 <param name='neighbor-list' doc='Neighbor List' />
3596 <param name='mode' doc='Mode of Neighbor List generation' />
Daniel Willmannf450f442019-06-06 17:52:25 +02003597 <param name='automatic' doc='Automatically from all BTS in this BSC' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01003598 <param name='manual' doc='Manual' />
3599 <param name='manual-si5' doc='Manual with different lists for SI2 and SI5' />
3600 </params>
3601 </command>
3602 <command id='neighbor-list (add|del) arfcn &lt;0-1023&gt;'>
3603 <params>
3604 <param name='neighbor-list' doc='Neighbor List' />
3605 <param name='add' doc='Add to manual neighbor list' />
3606 <param name='del' doc='Delete from manual neighbor list' />
3607 <param name='arfcn' doc='ARFCN of neighbor' />
3608 <param name='&lt;0-1023&gt;' doc='ARFCN of neighbor' />
3609 </params>
3610 </command>
3611 <command id='si5 neighbor-list (add|del) arfcn &lt;0-1023&gt;'>
3612 <params>
3613 <param name='si5' doc='SI5 Neighbor List' />
3614 <param name='neighbor-list' doc='SI5 Neighbor List' />
3615 <param name='add' doc='Add to manual SI5 neighbor list' />
3616 <param name='del' doc='Delete from SI5 manual neighbor list' />
3617 <param name='arfcn' doc='ARFCN of neighbor' />
3618 <param name='&lt;0-1023&gt;' doc='ARFCN of neighbor' />
3619 </params>
3620 </command>
3621 <command id='si2quater neighbor-list add earfcn &lt;0-65535&gt; thresh-hi &lt;0-31&gt; thresh-lo &lt;0-32&gt; prio &lt;0-8&gt; qrxlv &lt;0-32&gt; meas &lt;0-8&gt;'>
3622 <params>
3623 <param name='si2quater' doc='SI2quater Neighbor List' />
3624 <param name='neighbor-list' doc='SI2quater Neighbor List' />
3625 <param name='add' doc='Add to manual SI2quater neighbor list' />
3626 <param name='earfcn' doc='EARFCN of neighbor' />
3627 <param name='&lt;0-65535&gt;' doc='EARFCN of neighbor' />
3628 <param name='thresh-hi' doc='threshold high bits' />
3629 <param name='&lt;0-31&gt;' doc='threshold high bits' />
3630 <param name='thresh-lo' doc='threshold low bits' />
3631 <param name='&lt;0-32&gt;' doc='threshold low bits (32 means NA)' />
3632 <param name='prio' doc='priority' />
3633 <param name='&lt;0-8&gt;' doc='priority (8 means NA)' />
3634 <param name='qrxlv' doc='QRXLEVMIN' />
3635 <param name='&lt;0-32&gt;' doc='QRXLEVMIN (32 means NA)' />
3636 <param name='meas' doc='measurement bandwidth' />
3637 <param name='&lt;0-8&gt;' doc='measurement bandwidth (8 means NA)' />
3638 </params>
3639 </command>
3640 <command id='si2quater neighbor-list del earfcn &lt;0-65535&gt;'>
3641 <params>
3642 <param name='si2quater' doc='SI2quater Neighbor List' />
3643 <param name='neighbor-list' doc='SI2quater Neighbor List' />
3644 <param name='del' doc='Delete from SI2quater manual neighbor list' />
3645 <param name='earfcn' doc='EARFCN of neighbor' />
3646 <param name='&lt;0-65535&gt;' doc='EARFCN' />
3647 </params>
3648 </command>
3649 <command id='si2quater neighbor-list add uarfcn &lt;0-16383&gt; &lt;0-511&gt; &lt;0-1&gt;'>
3650 <params>
3651 <param name='si2quater' doc='SI2quater Neighbor List' />
3652 <param name='neighbor-list' doc='SI2quater Neighbor List' />
3653 <param name='add' doc='Add to manual SI2quater neighbor list' />
3654 <param name='uarfcn' doc='UARFCN of neighbor' />
3655 <param name='&lt;0-16383&gt;' doc='UARFCN of neighbor' />
3656 <param name='&lt;0-511&gt;' doc='scrambling code' />
3657 <param name='&lt;0-1&gt;' doc='diversity bit' />
3658 </params>
3659 </command>
3660 <command id='si2quater neighbor-list del uarfcn &lt;0-16383&gt; &lt;0-511&gt;'>
3661 <params>
3662 <param name='si2quater' doc='SI2quater Neighbor List' />
3663 <param name='neighbor-list' doc='SI2quater Neighbor List' />
3664 <param name='del' doc='Delete from SI2quater manual neighbor list' />
3665 <param name='uarfcn' doc='UARFCN of neighbor' />
3666 <param name='&lt;0-16383&gt;' doc='UARFCN' />
3667 <param name='&lt;0-511&gt;' doc='scrambling code' />
3668 </params>
3669 </command>
3670 <command id='rf-lock-exclude'>
3671 <params>
3672 <param name='rf-lock-exclude' doc='Exclude this BTS from the global RF Lock' />
3673 </params>
3674 </command>
3675 <command id='no rf-lock-exclude'>
3676 <params>
3677 <param name='no' doc='Negate a command or set its defaults' />
3678 <param name='rf-lock-exclude' doc='Exclude this BTS from the global RF Lock' />
3679 </params>
3680 </command>
3681 <command id='force-combined-si'>
3682 <params>
3683 <param name='force-combined-si' doc='Force the generation of a single SI (no ter/bis)' />
3684 </params>
3685 </command>
3686 <command id='no force-combined-si'>
3687 <params>
3688 <param name='no' doc='Negate a command or set its defaults' />
3689 <param name='force-combined-si' doc='Force the generation of a single SI (no ter/bis)' />
3690 </params>
3691 </command>
3692 <command id='codec-support fr'>
3693 <params>
3694 <param name='codec-support' doc='Codec Support settings' />
3695 <param name='fr' doc='Fullrate' />
3696 </params>
3697 </command>
3698 <command id='codec-support fr (hr|efr|amr)'>
3699 <params>
3700 <param name='codec-support' doc='Codec Support settings' />
3701 <param name='fr' doc='Fullrate' />
3702 <param name='hr' doc='Half Rate' />
3703 <param name='efr' doc='Enhanced Full Rate' />
3704 <param name='amr' doc='Adaptive Multirate' />
3705 </params>
3706 </command>
3707 <command id='codec-support fr (hr|efr|amr) (hr|efr|amr)'>
3708 <params>
3709 <param name='codec-support' doc='Codec Support settings' />
3710 <param name='fr' doc='Fullrate' />
3711 <param name='hr' doc='Half Rate' />
3712 <param name='efr' doc='Enhanced Full Rate' />
3713 <param name='amr' doc='Adaptive Multirate' />
3714 <param name='hr' doc='Half Rate' />
3715 <param name='efr' doc='Enhanced Full Rate' />
3716 <param name='amr' doc='Adaptive Multirate' />
3717 </params>
3718 </command>
3719 <command id='codec-support fr (hr|efr|amr) (hr|efr|amr) (hr|efr|amr)'>
3720 <params>
3721 <param name='codec-support' doc='Codec Support settings' />
3722 <param name='fr' doc='Fullrate' />
3723 <param name='hr' doc='Half Rate' />
3724 <param name='efr' doc='Enhanced Full Rate' />
3725 <param name='amr' doc='Adaptive Multirate' />
3726 <param name='hr' doc='Half Rate' />
3727 <param name='efr' doc='Enhanced Full Rate' />
3728 <param name='amr' doc='Adaptive Multirate' />
3729 <param name='hr' doc='Half Rate' />
3730 <param name='efr' doc='Enhanced Full Rate' />
3731 <param name='amr' doc='Adaptive Multirate' />
3732 </params>
3733 </command>
3734 <command id='codec-support fr (hr|efr|amr) (hr|efr|amr) (hr|efr|amr) (hr|efr|amr)'>
3735 <params>
3736 <param name='codec-support' doc='Codec Support settings' />
3737 <param name='fr' doc='Fullrate' />
3738 <param name='hr' doc='Half Rate' />
3739 <param name='efr' doc='Enhanced Full Rate' />
3740 <param name='amr' doc='Adaptive Multirate' />
3741 <param name='hr' doc='Half Rate' />
3742 <param name='efr' doc='Enhanced Full Rate' />
3743 <param name='amr' doc='Adaptive Multirate' />
3744 <param name='hr' doc='Half Rate' />
3745 <param name='efr' doc='Enhanced Full Rate' />
3746 <param name='amr' doc='Adaptive Multirate' />
3747 <param name='hr' doc='Half Rate' />
3748 <param name='efr' doc='Enhanced Full Rate' />
3749 <param name='amr' doc='Adaptive Multirate' />
3750 </params>
3751 </command>
3752 <command id='depends-on-bts &lt;0-255&gt;'>
3753 <params>
3754 <param name='depends-on-bts' doc='This BTS can only be started if another one is up' />
3755 <param name='&lt;0-255&gt;' doc='BTS Number' />
3756 </params>
3757 </command>
Oliver Smithb5bfa712020-03-27 10:29:51 +01003758 <command id='no depends-on-bts &lt;0-255&gt;'>
Neels Hofmeyr9f157572018-03-06 14:59:00 +01003759 <params>
Oliver Smithb5bfa712020-03-27 10:29:51 +01003760 <param name='no' doc='Negate a command or set its defaults' />
3761 <param name='depends-on-bts' doc='This BTS can only be started if another one is up' />
3762 <param name='&lt;0-255&gt;' doc='BTS Number' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01003763 </params>
3764 </command>
3765 <command id='amr tch-f modes (0|1|2|3|4|5|6|7)'>
3766 <params>
3767 <param name='amr' doc='Adaptive Multi Rate settings' />
3768 <param name='tch-f' doc='Full Rate' />
3769 <param name='modes' doc='Codec modes to use with AMR codec' />
3770 <param name='0' doc='4,75k' />
3771 <param name='1' doc='5,15k' />
3772 <param name='2' doc='5,90k' />
3773 <param name='3' doc='6,70k' />
3774 <param name='4' doc='7,40k' />
3775 <param name='5' doc='7,95k' />
3776 <param name='6' doc='10,2k' />
3777 <param name='7' doc='12,2k' />
3778 </params>
3779 </command>
3780 <command id='amr tch-f modes (0|1|2|3|4|5|6|7) (0|1|2|3|4|5|6|7)'>
3781 <params>
3782 <param name='amr' doc='Adaptive Multi Rate settings' />
3783 <param name='tch-f' doc='Full Rate' />
3784 <param name='modes' doc='Codec modes to use with AMR codec' />
3785 <param name='0' doc='4,75k' />
3786 <param name='1' doc='5,15k' />
3787 <param name='2' doc='5,90k' />
3788 <param name='3' doc='6,70k' />
3789 <param name='4' doc='7,40k' />
3790 <param name='5' doc='7,95k' />
3791 <param name='6' doc='10,2k' />
3792 <param name='7' doc='12,2k' />
3793 <param name='0' doc='4,75k' />
3794 <param name='1' doc='5,15k' />
3795 <param name='2' doc='5,90k' />
3796 <param name='3' doc='6,70k' />
3797 <param name='4' doc='7,40k' />
3798 <param name='5' doc='7,95k' />
3799 <param name='6' doc='10,2k' />
3800 <param name='7' doc='12,2k' />
3801 </params>
3802 </command>
3803 <command id='amr tch-f modes (0|1|2|3|4|5|6|7) (0|1|2|3|4|5|6|7) (0|1|2|3|4|5|6|7)'>
3804 <params>
3805 <param name='amr' doc='Adaptive Multi Rate settings' />
3806 <param name='tch-f' doc='Full Rate' />
3807 <param name='modes' doc='Codec modes to use with AMR codec' />
3808 <param name='0' doc='4,75k' />
3809 <param name='1' doc='5,15k' />
3810 <param name='2' doc='5,90k' />
3811 <param name='3' doc='6,70k' />
3812 <param name='4' doc='7,40k' />
3813 <param name='5' doc='7,95k' />
3814 <param name='6' doc='10,2k' />
3815 <param name='7' doc='12,2k' />
3816 <param name='0' doc='4,75k' />
3817 <param name='1' doc='5,15k' />
3818 <param name='2' doc='5,90k' />
3819 <param name='3' doc='6,70k' />
3820 <param name='4' doc='7,40k' />
3821 <param name='5' doc='7,95k' />
3822 <param name='6' doc='10,2k' />
3823 <param name='7' doc='12,2k' />
3824 <param name='0' doc='4,75k' />
3825 <param name='1' doc='5,15k' />
3826 <param name='2' doc='5,90k' />
3827 <param name='3' doc='6,70k' />
3828 <param name='4' doc='7,40k' />
3829 <param name='5' doc='7,95k' />
3830 <param name='6' doc='10,2k' />
3831 <param name='7' doc='12,2k' />
3832 </params>
3833 </command>
3834 <command id='amr tch-f modes (0|1|2|3|4|5|6|7) (0|1|2|3|4|5|6|7) (0|1|2|3|4|5|6|7) (0|1|2|3|4|5|6|7)'>
3835 <params>
3836 <param name='amr' doc='Adaptive Multi Rate settings' />
3837 <param name='tch-f' doc='Full Rate' />
3838 <param name='modes' doc='Codec modes to use with AMR codec' />
3839 <param name='0' doc='4,75k' />
3840 <param name='1' doc='5,15k' />
3841 <param name='2' doc='5,90k' />
3842 <param name='3' doc='6,70k' />
3843 <param name='4' doc='7,40k' />
3844 <param name='5' doc='7,95k' />
3845 <param name='6' doc='10,2k' />
3846 <param name='7' doc='12,2k' />
3847 <param name='0' doc='4,75k' />
3848 <param name='1' doc='5,15k' />
3849 <param name='2' doc='5,90k' />
3850 <param name='3' doc='6,70k' />
3851 <param name='4' doc='7,40k' />
3852 <param name='5' doc='7,95k' />
3853 <param name='6' doc='10,2k' />
3854 <param name='7' doc='12,2k' />
3855 <param name='0' doc='4,75k' />
3856 <param name='1' doc='5,15k' />
3857 <param name='2' doc='5,90k' />
3858 <param name='3' doc='6,70k' />
3859 <param name='4' doc='7,40k' />
3860 <param name='5' doc='7,95k' />
3861 <param name='6' doc='10,2k' />
3862 <param name='7' doc='12,2k' />
3863 <param name='0' doc='4,75k' />
3864 <param name='1' doc='5,15k' />
3865 <param name='2' doc='5,90k' />
3866 <param name='3' doc='6,70k' />
3867 <param name='4' doc='7,40k' />
3868 <param name='5' doc='7,95k' />
3869 <param name='6' doc='10,2k' />
3870 <param name='7' doc='12,2k' />
3871 </params>
3872 </command>
3873 <command id='amr tch-f threshold (ms|bts) &lt;0-63&gt;'>
3874 <params>
3875 <param name='amr' doc='Adaptive Multi Rate settings' />
3876 <param name='tch-f' doc='Full Rate' />
3877 <param name='threshold' doc='AMR threshold between codecs' />
3878 <param name='ms' doc='MS side' />
3879 <param name='bts' doc='BTS side' />
3880 <param name='&lt;0-63&gt;' doc='Threshold between codec 1 and 2' />
3881 </params>
3882 </command>
3883 <command id='amr tch-f threshold (ms|bts) &lt;0-63&gt; &lt;0-63&gt;'>
3884 <params>
3885 <param name='amr' doc='Adaptive Multi Rate settings' />
3886 <param name='tch-f' doc='Full Rate' />
3887 <param name='threshold' doc='AMR threshold between codecs' />
3888 <param name='ms' doc='MS side' />
3889 <param name='bts' doc='BTS side' />
3890 <param name='&lt;0-63&gt;' doc='Threshold between codec 1 and 2' />
3891 <param name='&lt;0-63&gt;' doc='Threshold between codec 1 and 2' />
3892 </params>
3893 </command>
3894 <command id='amr tch-f threshold (ms|bts) &lt;0-63&gt; &lt;0-63&gt; &lt;0-63&gt;'>
3895 <params>
3896 <param name='amr' doc='Adaptive Multi Rate settings' />
3897 <param name='tch-f' doc='Full Rate' />
3898 <param name='threshold' doc='AMR threshold between codecs' />
3899 <param name='ms' doc='MS side' />
3900 <param name='bts' doc='BTS side' />
3901 <param name='&lt;0-63&gt;' doc='Threshold between codec 1 and 2' />
3902 <param name='&lt;0-63&gt;' doc='Threshold between codec 1 and 2' />
3903 <param name='&lt;0-63&gt;' doc='Threshold between codec 1 and 2' />
3904 </params>
3905 </command>
3906 <command id='amr tch-f hysteresis (ms|bts) &lt;0-15&gt;'>
3907 <params>
3908 <param name='amr' doc='Adaptive Multi Rate settings' />
3909 <param name='tch-f' doc='Full Rate' />
3910 <param name='hysteresis' doc='AMR hysteresis between codecs' />
3911 <param name='ms' doc='MS side' />
3912 <param name='bts' doc='BTS side' />
3913 <param name='&lt;0-15&gt;' doc='Hysteresis between codec 1 and 2' />
3914 </params>
3915 </command>
3916 <command id='amr tch-f hysteresis (ms|bts) &lt;0-15&gt; &lt;0-15&gt;'>
3917 <params>
3918 <param name='amr' doc='Adaptive Multi Rate settings' />
3919 <param name='tch-f' doc='Full Rate' />
3920 <param name='hysteresis' doc='AMR hysteresis between codecs' />
3921 <param name='ms' doc='MS side' />
3922 <param name='bts' doc='BTS side' />
3923 <param name='&lt;0-15&gt;' doc='Hysteresis between codec 1 and 2' />
3924 <param name='&lt;0-15&gt;' doc='Hysteresis between codec 1 and 2' />
3925 </params>
3926 </command>
3927 <command id='amr tch-f hysteresis (ms|bts) &lt;0-15&gt; &lt;0-15&gt; &lt;0-15&gt;'>
3928 <params>
3929 <param name='amr' doc='Adaptive Multi Rate settings' />
3930 <param name='tch-f' doc='Full Rate' />
3931 <param name='hysteresis' doc='AMR hysteresis between codecs' />
3932 <param name='ms' doc='MS side' />
3933 <param name='bts' doc='BTS side' />
3934 <param name='&lt;0-15&gt;' doc='Hysteresis between codec 1 and 2' />
3935 <param name='&lt;0-15&gt;' doc='Hysteresis between codec 1 and 2' />
3936 <param name='&lt;0-15&gt;' doc='Hysteresis between codec 1 and 2' />
3937 </params>
3938 </command>
3939 <command id='amr tch-f start-mode (auto|1|2|3|4)'>
3940 <params>
3941 <param name='amr' doc='Adaptive Multi Rate settings' />
3942 <param name='tch-f' doc='Full Rate' />
3943 <param name='start-mode' doc='Initial codec to use with AMR' />
3944 <param name='auto' doc='Automatically' />
3945 <param name='1' doc='First codec' />
3946 <param name='2' doc='Second codec' />
3947 <param name='3' doc='Third codec' />
3948 <param name='4' doc='Fourth codec' />
3949 </params>
3950 </command>
3951 <command id='amr tch-h modes (0|1|2|3|4|5)'>
3952 <params>
3953 <param name='amr' doc='Adaptive Multi Rate settings' />
3954 <param name='tch-h' doc='Half Rate' />
3955 <param name='modes' doc='Codec modes to use with AMR codec' />
3956 <param name='0' doc='4,75k' />
3957 <param name='1' doc='5,15k' />
3958 <param name='2' doc='5,90k' />
3959 <param name='3' doc='6,70k' />
3960 <param name='4' doc='7,40k' />
3961 <param name='5' doc='7,95k' />
3962 </params>
3963 </command>
3964 <command id='amr tch-h modes (0|1|2|3|4|5) (0|1|2|3|4|5)'>
3965 <params>
3966 <param name='amr' doc='Adaptive Multi Rate settings' />
3967 <param name='tch-h' doc='Half Rate' />
3968 <param name='modes' doc='Codec modes to use with AMR codec' />
3969 <param name='0' doc='4,75k' />
3970 <param name='1' doc='5,15k' />
3971 <param name='2' doc='5,90k' />
3972 <param name='3' doc='6,70k' />
3973 <param name='4' doc='7,40k' />
3974 <param name='5' doc='7,95k' />
3975 <param name='0' doc='4,75k' />
3976 <param name='1' doc='5,15k' />
3977 <param name='2' doc='5,90k' />
3978 <param name='3' doc='6,70k' />
3979 <param name='4' doc='7,40k' />
3980 <param name='5' doc='7,95k' />
3981 </params>
3982 </command>
3983 <command id='amr tch-h modes (0|1|2|3|4|5) (0|1|2|3|4|5) (0|1|2|3|4|5)'>
3984 <params>
3985 <param name='amr' doc='Adaptive Multi Rate settings' />
3986 <param name='tch-h' doc='Half Rate' />
3987 <param name='modes' doc='Codec modes to use with AMR codec' />
3988 <param name='0' doc='4,75k' />
3989 <param name='1' doc='5,15k' />
3990 <param name='2' doc='5,90k' />
3991 <param name='3' doc='6,70k' />
3992 <param name='4' doc='7,40k' />
3993 <param name='5' doc='7,95k' />
3994 <param name='0' doc='4,75k' />
3995 <param name='1' doc='5,15k' />
3996 <param name='2' doc='5,90k' />
3997 <param name='3' doc='6,70k' />
3998 <param name='4' doc='7,40k' />
3999 <param name='5' doc='7,95k' />
4000 <param name='0' doc='4,75k' />
4001 <param name='1' doc='5,15k' />
4002 <param name='2' doc='5,90k' />
4003 <param name='3' doc='6,70k' />
4004 <param name='4' doc='7,40k' />
4005 <param name='5' doc='7,95k' />
4006 </params>
4007 </command>
4008 <command id='amr tch-h modes (0|1|2|3|4|5) (0|1|2|3|4|5) (0|1|2|3|4|5) (0|1|2|3|4|5)'>
4009 <params>
4010 <param name='amr' doc='Adaptive Multi Rate settings' />
4011 <param name='tch-h' doc='Half Rate' />
4012 <param name='modes' doc='Codec modes to use with AMR codec' />
4013 <param name='0' doc='4,75k' />
4014 <param name='1' doc='5,15k' />
4015 <param name='2' doc='5,90k' />
4016 <param name='3' doc='6,70k' />
4017 <param name='4' doc='7,40k' />
4018 <param name='5' doc='7,95k' />
4019 <param name='0' doc='4,75k' />
4020 <param name='1' doc='5,15k' />
4021 <param name='2' doc='5,90k' />
4022 <param name='3' doc='6,70k' />
4023 <param name='4' doc='7,40k' />
4024 <param name='5' doc='7,95k' />
4025 <param name='0' doc='4,75k' />
4026 <param name='1' doc='5,15k' />
4027 <param name='2' doc='5,90k' />
4028 <param name='3' doc='6,70k' />
4029 <param name='4' doc='7,40k' />
4030 <param name='5' doc='7,95k' />
4031 <param name='0' doc='4,75k' />
4032 <param name='1' doc='5,15k' />
4033 <param name='2' doc='5,90k' />
4034 <param name='3' doc='6,70k' />
4035 <param name='4' doc='7,40k' />
4036 <param name='5' doc='7,95k' />
4037 </params>
4038 </command>
4039 <command id='amr tch-h threshold (ms|bts) &lt;0-63&gt;'>
4040 <params>
4041 <param name='amr' doc='Adaptive Multi Rate settings' />
4042 <param name='tch-h' doc='Half Rate' />
4043 <param name='threshold' doc='AMR threshold between codecs' />
4044 <param name='ms' doc='MS side' />
4045 <param name='bts' doc='BTS side' />
4046 <param name='&lt;0-63&gt;' doc='Threshold between codec 1 and 2' />
4047 </params>
4048 </command>
4049 <command id='amr tch-h threshold (ms|bts) &lt;0-63&gt; &lt;0-63&gt;'>
4050 <params>
4051 <param name='amr' doc='Adaptive Multi Rate settings' />
4052 <param name='tch-h' doc='Half Rate' />
4053 <param name='threshold' doc='AMR threshold between codecs' />
4054 <param name='ms' doc='MS side' />
4055 <param name='bts' doc='BTS side' />
4056 <param name='&lt;0-63&gt;' doc='Threshold between codec 1 and 2' />
4057 <param name='&lt;0-63&gt;' doc='Threshold between codec 1 and 2' />
4058 </params>
4059 </command>
4060 <command id='amr tch-h threshold (ms|bts) &lt;0-63&gt; &lt;0-63&gt; &lt;0-63&gt;'>
4061 <params>
4062 <param name='amr' doc='Adaptive Multi Rate settings' />
4063 <param name='tch-h' doc='Half Rate' />
4064 <param name='threshold' doc='AMR threshold between codecs' />
4065 <param name='ms' doc='MS side' />
4066 <param name='bts' doc='BTS side' />
4067 <param name='&lt;0-63&gt;' doc='Threshold between codec 1 and 2' />
4068 <param name='&lt;0-63&gt;' doc='Threshold between codec 1 and 2' />
4069 <param name='&lt;0-63&gt;' doc='Threshold between codec 1 and 2' />
4070 </params>
4071 </command>
4072 <command id='amr tch-h hysteresis (ms|bts) &lt;0-15&gt;'>
4073 <params>
4074 <param name='amr' doc='Adaptive Multi Rate settings' />
4075 <param name='tch-h' doc='Half Rate' />
4076 <param name='hysteresis' doc='AMR hysteresis between codecs' />
4077 <param name='ms' doc='MS side' />
4078 <param name='bts' doc='BTS side' />
4079 <param name='&lt;0-15&gt;' doc='Hysteresis between codec 1 and 2' />
4080 </params>
4081 </command>
4082 <command id='amr tch-h hysteresis (ms|bts) &lt;0-15&gt; &lt;0-15&gt;'>
4083 <params>
4084 <param name='amr' doc='Adaptive Multi Rate settings' />
4085 <param name='tch-h' doc='Half Rate' />
4086 <param name='hysteresis' doc='AMR hysteresis between codecs' />
4087 <param name='ms' doc='MS side' />
4088 <param name='bts' doc='BTS side' />
4089 <param name='&lt;0-15&gt;' doc='Hysteresis between codec 1 and 2' />
4090 <param name='&lt;0-15&gt;' doc='Hysteresis between codec 1 and 2' />
4091 </params>
4092 </command>
4093 <command id='amr tch-h hysteresis (ms|bts) &lt;0-15&gt; &lt;0-15&gt; &lt;0-15&gt;'>
4094 <params>
4095 <param name='amr' doc='Adaptive Multi Rate settings' />
4096 <param name='tch-h' doc='Half Rate' />
4097 <param name='hysteresis' doc='AMR hysteresis between codecs' />
4098 <param name='ms' doc='MS side' />
4099 <param name='bts' doc='BTS side' />
4100 <param name='&lt;0-15&gt;' doc='Hysteresis between codec 1 and 2' />
4101 <param name='&lt;0-15&gt;' doc='Hysteresis between codec 1 and 2' />
4102 <param name='&lt;0-15&gt;' doc='Hysteresis between codec 1 and 2' />
4103 </params>
4104 </command>
4105 <command id='amr tch-h start-mode (auto|1|2|3|4)'>
4106 <params>
4107 <param name='amr' doc='Adaptive Multi Rate settings' />
4108 <param name='tch-h' doc='Half Rate' />
4109 <param name='start-mode' doc='Initial codec to use with AMR' />
4110 <param name='auto' doc='Automatically' />
4111 <param name='1' doc='First codec' />
4112 <param name='2' doc='Second codec' />
4113 <param name='3' doc='Third codec' />
4114 <param name='4' doc='Fourth codec' />
4115 </params>
4116 </command>
4117 <command id='pcu-socket PATH'>
4118 <params>
4119 <param name='pcu-socket' doc='PCU Socket Path for using OsmoPCU co-located with BSC (legacy BTS)' />
4120 <param name='PATH' doc='Path in the file system for the unix-domain PCU socket' />
4121 </params>
4122 </command>
4123 <command id='access-control-class-ramping'>
4124 <params>
4125 <param name='access-control-class-ramping' doc='Enable Access Control Class ramping' />
4126 </params>
4127 </command>
4128 <command id='no access-control-class-ramping'>
4129 <params>
4130 <param name='no' doc='Negate a command or set its defaults' />
4131 <param name='access-control-class-ramping' doc='Disable Access Control Class ramping' />
4132 </params>
4133 </command>
4134 <command id='access-control-class-ramping-step-interval (&lt;30-600&gt;|dynamic)'>
4135 <params>
4136 <param name='access-control-class-ramping-step-interval' doc='Configure Access Control Class ramping step interval' />
4137 <param name='&lt;30-600&gt;' doc='Set a fixed step interval (in seconds)' />
4138 <param name='dynamic' doc='Use dynamic step interval based on BTS channel load' />
4139 </params>
4140 </command>
4141 <command id='access-control-class-ramping-step-size (&lt;1-10&gt;)'>
4142 <params>
4143 <param name='access-control-class-ramping-step-size' doc='Configure Access Control Class ramping step size' />
4144 <param name='&lt;1-10&gt;' doc='Set the number of Access Control Classes to enable per ramping step' />
4145 </params>
4146 </command>
Daniel Willmannf450f442019-06-06 17:52:25 +02004147 <command id='timer-dynamic TNNNN'>
4148 <params>
4149 <param name='timer-dynamic' doc='Calculate T3113 dynamically based on channel config and load' />
4150 <param name='TNNNN' doc='T-number, optionally preceded by &apos;t&apos; or &apos;T&apos;' />
4151 </params>
4152 </command>
4153 <command id='no timer-dynamic TNNNN'>
4154 <params>
4155 <param name='no' doc='Negate a command or set its defaults' />
4156 <param name='timer-dynamic' doc='Set given timer to non-dynamic and use the default or user provided fixed value' />
4157 <param name='TNNNN' doc='T-number, optionally preceded by &apos;t&apos; or &apos;T&apos;' />
4158 </params>
4159 </command>
Neels Hofmeyr39e12152018-11-05 02:56:09 +01004160 <command id='neighbor bts &lt;0-255&gt;'>
4161 <params>
4162 <param name='neighbor' doc='Manage local and remote-BSS neighbor cells' />
4163 <param name='bts' doc='Add Neighbor cell by local BTS number' />
4164 <param name='&lt;0-255&gt;' doc='BTS number' />
4165 </params>
4166 </command>
4167 <command id='neighbor lac &lt;0-65535&gt;'>
4168 <params>
4169 <param name='neighbor' doc='Manage local and remote-BSS neighbor cells' />
4170 <param name='lac' doc='Add Neighbor cell by LAC' />
4171 <param name='&lt;0-65535&gt;' doc='LAC' />
4172 </params>
4173 </command>
4174 <command id='neighbor lac-ci &lt;0-65535&gt; &lt;0-65535&gt;'>
4175 <params>
4176 <param name='neighbor' doc='Manage local and remote-BSS neighbor cells' />
4177 <param name='lac-ci' doc='Add Neighbor cell by LAC and CI' />
4178 <param name='&lt;0-65535&gt;' doc='LAC' />
4179 <param name='&lt;0-65535&gt;' doc='CI' />
4180 </params>
4181 </command>
4182 <command id='neighbor cgi &lt;0-999&gt; &lt;0-999&gt; &lt;0-65535&gt; &lt;0-65535&gt;'>
4183 <params>
4184 <param name='neighbor' doc='Manage local and remote-BSS neighbor cells' />
4185 <param name='cgi' doc='Add Neighbor cell by cgi' />
4186 <param name='&lt;0-999&gt;' doc='MCC' />
4187 <param name='&lt;0-999&gt;' doc='MNC' />
4188 <param name='&lt;0-65535&gt;' doc='LAC' />
4189 <param name='&lt;0-65535&gt;' doc='CI' />
4190 </params>
4191 </command>
4192 <command id='neighbor lac &lt;0-65535&gt; arfcn &lt;0-1023&gt; bsic (&lt;0-63&gt;|any)'>
4193 <params>
4194 <param name='neighbor' doc='Manage local and remote-BSS neighbor cells' />
4195 <param name='lac' doc='Add Neighbor cell by LAC' />
4196 <param name='&lt;0-65535&gt;' doc='LAC' />
4197 <param name='arfcn' doc='ARFCN of neighbor cell' />
4198 <param name='&lt;0-1023&gt;' doc='ARFCN value' />
4199 <param name='bsic' doc='BSIC of neighbor cell' />
4200 <param name='&lt;0-63&gt;' doc='BSIC value' />
4201 <param name='any' doc='for all BSICs / use any BSIC in this ARFCN' />
4202 </params>
4203 </command>
4204 <command id='neighbor lac-ci &lt;0-65535&gt; &lt;0-65535&gt; arfcn &lt;0-1023&gt; bsic (&lt;0-63&gt;|any)'>
4205 <params>
4206 <param name='neighbor' doc='Manage local and remote-BSS neighbor cells' />
4207 <param name='lac-ci' doc='Add Neighbor cell by LAC and CI' />
4208 <param name='&lt;0-65535&gt;' doc='LAC' />
4209 <param name='&lt;0-65535&gt;' doc='CI' />
4210 <param name='arfcn' doc='ARFCN of neighbor cell' />
4211 <param name='&lt;0-1023&gt;' doc='ARFCN value' />
4212 <param name='bsic' doc='BSIC of neighbor cell' />
4213 <param name='&lt;0-63&gt;' doc='BSIC value' />
4214 <param name='any' doc='for all BSICs / use any BSIC in this ARFCN' />
4215 </params>
4216 </command>
4217 <command id='neighbor cgi &lt;0-999&gt; &lt;0-999&gt; &lt;0-65535&gt; &lt;0-65535&gt; arfcn &lt;0-1023&gt; bsic (&lt;0-63&gt;|any)'>
4218 <params>
4219 <param name='neighbor' doc='Manage local and remote-BSS neighbor cells' />
4220 <param name='cgi' doc='Add Neighbor cell by cgi' />
4221 <param name='&lt;0-999&gt;' doc='MCC' />
4222 <param name='&lt;0-999&gt;' doc='MNC' />
4223 <param name='&lt;0-65535&gt;' doc='LAC' />
4224 <param name='&lt;0-65535&gt;' doc='CI' />
4225 <param name='arfcn' doc='ARFCN of neighbor cell' />
4226 <param name='&lt;0-1023&gt;' doc='ARFCN value' />
4227 <param name='bsic' doc='BSIC of neighbor cell' />
4228 <param name='&lt;0-63&gt;' doc='BSIC value' />
4229 <param name='any' doc='for all BSICs / use any BSIC in this ARFCN' />
4230 </params>
4231 </command>
4232 <command id='no neighbor bts &lt;0-255&gt;'>
4233 <params>
4234 <param name='no' doc='Negate a command or set its defaults' />
4235 <param name='neighbor' doc='Remove local or remote-BSS neighbor cell' />
4236 <param name='bts' doc='Neighbor cell by local BTS number' />
4237 <param name='&lt;0-255&gt;' doc='BTS number' />
4238 </params>
4239 </command>
4240 <command id='no neighbor arfcn &lt;0-1023&gt; bsic (&lt;0-63&gt;|any)'>
4241 <params>
4242 <param name='no' doc='Negate a command or set its defaults' />
4243 <param name='neighbor' doc='Remove local or remote-BSS neighbor cell' />
4244 <param name='arfcn' doc='ARFCN of neighbor cell' />
4245 <param name='&lt;0-1023&gt;' doc='ARFCN value' />
4246 <param name='bsic' doc='BSIC of neighbor cell' />
4247 <param name='&lt;0-63&gt;' doc='BSIC value' />
4248 <param name='any' doc='for all BSICs / use any BSIC in this ARFCN' />
4249 </params>
4250 </command>
Harald Welte7104ed22019-09-02 10:55:21 +02004251 <command id='no neighbors'>
4252 <params>
4253 <param name='no' doc='Negate a command or set its defaults' />
4254 <param name='neighbors' doc='Remove all local and remote-BSS neighbor config for this cell. Note that this falls back to the legacy behavior of regarding all local cells as neighbors.' />
4255 </params>
4256 </command>
Neels Hofmeyr9f157572018-03-06 14:59:00 +01004257 <command id='trx &lt;0-255&gt;'>
4258 <params>
4259 <param name='trx' doc='Radio Transceiver' />
4260 <param name='&lt;0-255&gt;' doc='Select a TRX to configure' />
4261 </params>
4262 </command>
4263 <command id='is-connection-list (add|del) &lt;0-2047&gt; &lt;0-2047&gt; &lt;0-255&gt;'>
4264 <params>
4265 <param name='is-connection-list' doc='Interface Switch Connection List' />
4266 <param name='add' doc='Add to IS list' />
4267 <param name='del' doc='Delete from IS list' />
4268 <param name='&lt;0-2047&gt;' doc='ICP1' />
4269 <param name='&lt;0-2047&gt;' doc='ICP2' />
4270 <param name='&lt;0-255&gt;' doc='Contiguity Index' />
4271 </params>
4272 </command>
4273 <command id='abis-lower-transport (single-timeslot|super-channel)'>
4274 <params>
4275 <param name='abis-lower-transport' doc='Configure thee Abis Lower Transport' />
4276 <param name='single-timeslot' doc='Single Timeslot (classic Abis)' />
4277 <param name='super-channel' doc='SuperChannel (Packet Abis)' />
4278 </params>
4279 </command>
4280 <command id='con-connection-group &lt;1-31&gt;'>
4281 <params>
4282 <param name='con-connection-group' doc='Configure a CON (Concentrator) Connection Group' />
4283 <param name='&lt;1-31&gt;' doc='CON Connection Group Number' />
4284 </params>
4285 </command>
4286 <command id='del-connection-group &lt;1-31&gt;'>
4287 <params>
4288 <param name='del-connection-group' doc='Delete a CON (Concentrator) Connection Group' />
4289 <param name='&lt;1-31&gt;' doc='CON Connection Group Number' />
4290 </params>
4291 </command>
4292 <command id='handover (0|1|default)'>
4293 <params>
4294 <param name='handover' doc='Handover general config' />
4295 <param name='0' doc='Disable in-call handover' />
4296 <param name='1' doc='Enable in-call handover' />
4297 <param name='default' doc='Enable/disable handover: Use default (0), remove explicit setting on this node' />
4298 </params>
4299 </command>
4300 <command id='handover algorithm (1|2|default)'>
4301 <params>
4302 <param name='handover' doc='Handover general config' />
4303 <param name='algorithm' doc='Choose algorithm for handover decision' />
4304 <param name='1' doc='Algorithm 1: trigger handover based on comparing current cell and neighbor RxLev and RxQual, only.' />
4305 <param name='2' doc='Algorithm 2: trigger handover on RxLev/RxQual, and also to balance the load across several cells. Consider available codecs. Prevent repeated handover by penalty timers.' />
4306 <param name='default' doc='Use default (1), remove explicit setting on this node' />
4307 </params>
4308 </command>
4309 <command id='handover1 window rxlev averaging (&lt;1-10&gt;|default)'>
4310 <params>
4311 <param name='handover1' doc='Handover options for handover decision algorithm 1' />
4312 <param name='window' doc='Measurement averaging settings' />
4313 <param name='rxlev' doc='Received-Level averaging' />
Harald Welte7104ed22019-09-02 10:55:21 +02004314 <param name='averaging' doc='How many RxLev measurements to use for averaging' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01004315 <param name='&lt;1-10&gt;' doc='RxLev averaging: Number of values to average over' />
4316 <param name='default' doc='Use default (10), remove explicit setting on this node' />
4317 </params>
4318 </command>
4319 <command id='handover1 window rxqual averaging (&lt;1-10&gt;|default)'>
4320 <params>
4321 <param name='handover1' doc='Handover options for handover decision algorithm 1' />
4322 <param name='window' doc='Measurement averaging settings' />
4323 <param name='rxqual' doc='Received-Quality averaging' />
Harald Welte7104ed22019-09-02 10:55:21 +02004324 <param name='averaging' doc='How many RxQual measurements to use for averaging' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01004325 <param name='&lt;1-10&gt;' doc='RxQual averaging: Number of values to average over' />
4326 <param name='default' doc='Use default (1), remove explicit setting on this node' />
4327 </params>
4328 </command>
4329 <command id='handover1 window rxlev neighbor averaging (&lt;1-10&gt;|default)'>
4330 <params>
4331 <param name='handover1' doc='Handover options for handover decision algorithm 1' />
4332 <param name='window' doc='Measurement averaging settings' />
4333 <param name='rxlev' doc='Received-Level averaging' />
Harald Welte7104ed22019-09-02 10:55:21 +02004334 <param name='neighbor' doc='How many Neighbor RxLev measurements to use for averaging' />
4335 <param name='averaging' doc='How many Neighbor RxLev measurements to use for averaging' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01004336 <param name='&lt;1-10&gt;' doc='Neighbor RxLev averaging: Number of values to average over' />
4337 <param name='default' doc='Use default (10), remove explicit setting on this node' />
4338 </params>
4339 </command>
4340 <command id='handover1 power budget interval (&lt;1-99&gt;|default)'>
4341 <params>
4342 <param name='handover1' doc='Handover options for handover decision algorithm 1' />
4343 <param name='power' doc='Neighbor cell power triggering' />
4344 <param name='budget' doc='Neighbor cell power triggering' />
4345 <param name='interval' doc='How often to check for a better cell (SACCH frames)' />
4346 <param name='&lt;1-99&gt;' doc='Check for stronger neighbor every N number of SACCH frames' />
4347 <param name='default' doc='Use default (6), remove explicit setting on this node' />
4348 </params>
4349 </command>
4350 <command id='handover1 power budget hysteresis (&lt;0-999&gt;|default)'>
4351 <params>
4352 <param name='handover1' doc='Handover options for handover decision algorithm 1' />
4353 <param name='power' doc='Neighbor cell power triggering' />
4354 <param name='budget' doc='Neighbor cell power triggering' />
Neels Hofmeyr39e12152018-11-05 02:56:09 +01004355 <param name='hysteresis' doc='How many dB stronger must a neighbor be to become a HO candidate' />
4356 <param name='&lt;0-999&gt;' doc='Neighbor&apos;s strength difference in dB' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01004357 <param name='default' doc='Use default (3), remove explicit setting on this node' />
4358 </params>
4359 </command>
4360 <command id='handover1 maximum distance (&lt;0-9999&gt;|default)'>
4361 <params>
4362 <param name='handover1' doc='Handover options for handover decision algorithm 1' />
4363 <param name='maximum' doc='Maximum Timing-Advance value (i.e. MS distance) before triggering HO' />
4364 <param name='distance' doc='Maximum Timing-Advance value (i.e. MS distance) before triggering HO' />
4365 <param name='&lt;0-9999&gt;' doc='Maximum Timing-Advance value (i.e. MS distance) before triggering HO' />
4366 <param name='default' doc='Use default (9999), remove explicit setting on this node' />
4367 </params>
4368 </command>
4369 <command id='handover2 window rxlev averaging (&lt;1-10&gt;|default)'>
4370 <params>
4371 <param name='handover2' doc='Handover options for handover decision algorithm 2' />
4372 <param name='window' doc='Measurement averaging settings' />
4373 <param name='rxlev' doc='Received-Level averaging' />
Harald Welte7104ed22019-09-02 10:55:21 +02004374 <param name='averaging' doc='How many RxLev measurements to use for averaging' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01004375 <param name='&lt;1-10&gt;' doc='RxLev averaging: Number of values to average over' />
4376 <param name='default' doc='Use default (10), remove explicit setting on this node' />
4377 </params>
4378 </command>
4379 <command id='handover2 window rxqual averaging (&lt;1-10&gt;|default)'>
4380 <params>
4381 <param name='handover2' doc='Handover options for handover decision algorithm 2' />
4382 <param name='window' doc='Measurement averaging settings' />
4383 <param name='rxqual' doc='Received-Quality averaging' />
Harald Welte7104ed22019-09-02 10:55:21 +02004384 <param name='averaging' doc='How many RxQual measurements to use for averaging' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01004385 <param name='&lt;1-10&gt;' doc='RxQual averaging: Number of values to average over' />
4386 <param name='default' doc='Use default (1), remove explicit setting on this node' />
4387 </params>
4388 </command>
4389 <command id='handover2 window rxlev neighbor averaging (&lt;1-10&gt;|default)'>
4390 <params>
4391 <param name='handover2' doc='Handover options for handover decision algorithm 2' />
4392 <param name='window' doc='Measurement averaging settings' />
4393 <param name='rxlev' doc='Received-Level averaging' />
Harald Welte7104ed22019-09-02 10:55:21 +02004394 <param name='neighbor' doc='How many Neighbor RxLev measurements to use for averaging' />
4395 <param name='averaging' doc='How many Neighbor RxLev measurements to use for averaging' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01004396 <param name='&lt;1-10&gt;' doc='Neighbor RxLev averaging: Number of values to average over' />
4397 <param name='default' doc='Use default (10), remove explicit setting on this node' />
4398 </params>
4399 </command>
4400 <command id='handover2 power budget interval (&lt;1-99&gt;|default)'>
4401 <params>
4402 <param name='handover2' doc='Handover options for handover decision algorithm 2' />
4403 <param name='power' doc='Neighbor cell power triggering' />
4404 <param name='budget' doc='Neighbor cell power triggering' />
4405 <param name='interval' doc='How often to check for a better cell (SACCH frames)' />
4406 <param name='&lt;1-99&gt;' doc='Check for stronger neighbor every N number of SACCH frames' />
4407 <param name='default' doc='Use default (6), remove explicit setting on this node' />
4408 </params>
4409 </command>
4410 <command id='handover2 power budget hysteresis (&lt;0-999&gt;|default)'>
4411 <params>
4412 <param name='handover2' doc='Handover options for handover decision algorithm 2' />
4413 <param name='power' doc='Neighbor cell power triggering' />
4414 <param name='budget' doc='Neighbor cell power triggering' />
Neels Hofmeyr39e12152018-11-05 02:56:09 +01004415 <param name='hysteresis' doc='How many dB stronger must a neighbor be to become a HO candidate' />
4416 <param name='&lt;0-999&gt;' doc='Neighbor&apos;s strength difference in dB' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01004417 <param name='default' doc='Use default (3), remove explicit setting on this node' />
4418 </params>
4419 </command>
4420 <command id='handover2 maximum distance (&lt;0-9999&gt;|default)'>
4421 <params>
4422 <param name='handover2' doc='Handover options for handover decision algorithm 2' />
4423 <param name='maximum' doc='Maximum Timing-Advance value (i.e. MS distance) before triggering HO' />
4424 <param name='distance' doc='Maximum Timing-Advance value (i.e. MS distance) before triggering HO' />
4425 <param name='&lt;0-9999&gt;' doc='Maximum Timing-Advance value (i.e. MS distance) before triggering HO' />
4426 <param name='default' doc='Use default (9999), remove explicit setting on this node' />
4427 </params>
4428 </command>
4429 <command id='handover2 assignment (0|1|default)'>
4430 <params>
4431 <param name='handover2' doc='Handover options for handover decision algorithm 2' />
Harald Welte7104ed22019-09-02 10:55:21 +02004432 <param name='assignment' doc='Enable or disable in-call channel re-assignment within the same cell' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01004433 <param name='0' doc='Disable in-call assignment' />
4434 <param name='1' doc='Enable in-call assignment' />
4435 <param name='default' doc='Use default (0), remove explicit setting on this node' />
4436 </params>
4437 </command>
4438 <command id='handover2 tdma-measurement (full|subset|default)'>
4439 <params>
4440 <param name='handover2' doc='Handover options for handover decision algorithm 2' />
Neels Hofmeyr39e12152018-11-05 02:56:09 +01004441 <param name='tdma-measurement' doc='Define measurement set of TDMA frames' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01004442 <param name='full' doc='Full set of 102/104 TDMA frames' />
4443 <param name='subset' doc='Sub set of 4 TDMA frames (SACCH)' />
4444 <param name='default' doc='Use default (subset), remove explicit setting on this node' />
4445 </params>
4446 </command>
4447 <command id='handover2 min rxlev (&lt;-110--50&gt;|default)'>
4448 <params>
4449 <param name='handover2' doc='Handover options for handover decision algorithm 2' />
Neels Hofmeyr39e12152018-11-05 02:56:09 +01004450 <param name='min' doc='Minimum Level/Quality thresholds before triggering HO' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01004451 <param name='rxlev' doc='How weak may RxLev of an MS become before triggering HO' />
Harald Welte7104ed22019-09-02 10:55:21 +02004452 <param name='&lt;-110--50&gt;' doc='minimum RxLev (dBm; note: negative values)' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01004453 <param name='default' doc='Use default (-100), remove explicit setting on this node' />
4454 </params>
4455 </command>
4456 <command id='handover2 min rxqual (&lt;0-7&gt;|default)'>
4457 <params>
4458 <param name='handover2' doc='Handover options for handover decision algorithm 2' />
Neels Hofmeyr39e12152018-11-05 02:56:09 +01004459 <param name='min' doc='Minimum Level/Quality thresholds before triggering HO' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01004460 <param name='rxqual' doc='How bad may RxQual of an MS become before triggering HO' />
Neels Hofmeyr39e12152018-11-05 02:56:09 +01004461 <param name='&lt;0-7&gt;' doc='minimum RxQual' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01004462 <param name='default' doc='Use default (5), remove explicit setting on this node' />
4463 </params>
4464 </command>
4465 <command id='handover2 afs-bias rxlev (&lt;0-20&gt;|default)'>
4466 <params>
4467 <param name='handover2' doc='Handover options for handover decision algorithm 2' />
Neels Hofmeyr39e12152018-11-05 02:56:09 +01004468 <param name='afs-bias' doc='Configure bias to prefer AFS (AMR on TCH/F) over other codecs' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01004469 <param name='rxlev' doc='RxLev improvement bias for AFS over other codecs' />
Neels Hofmeyr39e12152018-11-05 02:56:09 +01004470 <param name='&lt;0-20&gt;' doc='Virtual RxLev improvement (dB)' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01004471 <param name='default' doc='Use default (0), remove explicit setting on this node' />
4472 </params>
4473 </command>
4474 <command id='handover2 afs-bias rxqual (&lt;0-7&gt;|default)'>
4475 <params>
4476 <param name='handover2' doc='Handover options for handover decision algorithm 2' />
Neels Hofmeyr39e12152018-11-05 02:56:09 +01004477 <param name='afs-bias' doc='Configure bias to prefer AFS (AMR on TCH/F) over other codecs' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01004478 <param name='rxqual' doc='RxQual improvement bias for AFS over other codecs' />
Neels Hofmeyr39e12152018-11-05 02:56:09 +01004479 <param name='&lt;0-7&gt;' doc='Virtual RxQual improvement' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01004480 <param name='default' doc='Use default (0), remove explicit setting on this node' />
4481 </params>
4482 </command>
4483 <command id='handover2 min-free-slots tch/f (&lt;0-9999&gt;|default)'>
4484 <params>
4485 <param name='handover2' doc='Handover options for handover decision algorithm 2' />
Neels Hofmeyr39e12152018-11-05 02:56:09 +01004486 <param name='min-free-slots' doc='Minimum free TCH timeslots before cell is considered congested' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01004487 <param name='tch/f' doc='Minimum free TCH/F timeslots before cell is considered congested' />
4488 <param name='&lt;0-9999&gt;' doc='Number of TCH/F slots' />
4489 <param name='default' doc='Use default (0), remove explicit setting on this node' />
4490 </params>
4491 </command>
4492 <command id='handover2 min-free-slots tch/h (&lt;0-9999&gt;|default)'>
4493 <params>
4494 <param name='handover2' doc='Handover options for handover decision algorithm 2' />
Neels Hofmeyr39e12152018-11-05 02:56:09 +01004495 <param name='min-free-slots' doc='Minimum free TCH timeslots before cell is considered congested' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01004496 <param name='tch/h' doc='Minimum free TCH/H timeslots before cell is considered congested' />
4497 <param name='&lt;0-9999&gt;' doc='Number of TCH/H slots' />
4498 <param name='default' doc='Use default (0), remove explicit setting on this node' />
4499 </params>
4500 </command>
4501 <command id='handover2 max-handovers (&lt;1-9999&gt;|default)'>
4502 <params>
4503 <param name='handover2' doc='Handover options for handover decision algorithm 2' />
Neels Hofmeyr39e12152018-11-05 02:56:09 +01004504 <param name='max-handovers' doc='Maximum number of concurrent handovers allowed per cell' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01004505 <param name='&lt;1-9999&gt;' doc='Number' />
4506 <param name='default' doc='Use default (9999), remove explicit setting on this node' />
4507 </params>
4508 </command>
4509 <command id='handover2 penalty-time max-distance (&lt;0-99999&gt;|default)'>
4510 <params>
4511 <param name='handover2' doc='Handover options for handover decision algorithm 2' />
Neels Hofmeyr39e12152018-11-05 02:56:09 +01004512 <param name='penalty-time' doc='Set penalty times to wait between repeated handovers' />
Harald Welte7104ed22019-09-02 10:55:21 +02004513 <param name='max-distance' doc='Time to suspend handover for a subscriber after leaving this cell due to exceeding max distance; see also &apos;handover2 retries&apos;' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01004514 <param name='&lt;0-99999&gt;' doc='Seconds' />
4515 <param name='default' doc='Use default (300), remove explicit setting on this node' />
4516 </params>
4517 </command>
4518 <command id='handover2 penalty-time failed-ho (&lt;0-99999&gt;|default)'>
4519 <params>
4520 <param name='handover2' doc='Handover options for handover decision algorithm 2' />
Neels Hofmeyr39e12152018-11-05 02:56:09 +01004521 <param name='penalty-time' doc='Set penalty times to wait between repeated handovers' />
Harald Welte7104ed22019-09-02 10:55:21 +02004522 <param name='failed-ho' doc='Time to suspend handover for a subscriber after a failed handover into this cell; see also &apos;handover2 retries&apos;' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01004523 <param name='&lt;0-99999&gt;' doc='Seconds' />
4524 <param name='default' doc='Use default (60), remove explicit setting on this node' />
4525 </params>
4526 </command>
4527 <command id='handover2 penalty-time failed-assignment (&lt;0-99999&gt;|default)'>
4528 <params>
4529 <param name='handover2' doc='Handover options for handover decision algorithm 2' />
Neels Hofmeyr39e12152018-11-05 02:56:09 +01004530 <param name='penalty-time' doc='Set penalty times to wait between repeated handovers' />
Harald Welte7104ed22019-09-02 10:55:21 +02004531 <param name='failed-assignment' doc='Time to suspend handover for a subscriber after a failed re-assignment within this cell; see also &apos;handover2 retries&apos;' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01004532 <param name='&lt;0-99999&gt;' doc='Seconds' />
4533 <param name='default' doc='Use default (60), remove explicit setting on this node' />
4534 </params>
4535 </command>
4536 <command id='handover2 retries (&lt;0-9&gt;|default)'>
4537 <params>
4538 <param name='handover2' doc='Handover options for handover decision algorithm 2' />
Harald Welte7104ed22019-09-02 10:55:21 +02004539 <param name='retries' doc='Number of times to immediately retry a failed handover/assignment, before a penalty time is applied' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01004540 <param name='&lt;0-9&gt;' doc='Number of retries' />
4541 <param name='default' doc='Use default (0), remove explicit setting on this node' />
4542 </params>
4543 </command>
Neels Hofmeyr9f157572018-03-06 14:59:00 +01004544 </node>
4545 <node id='config-net-bts-trx'>
4546 <name>config-net-bts-trx</name>
4547 <command id='arfcn &lt;0-1023&gt;'>
4548 <params>
4549 <param name='arfcn' doc='Set the ARFCN for this TRX' />
4550 <param name='&lt;0-1023&gt;' doc='Absolute Radio Frequency Channel Number' />
4551 </params>
4552 </command>
4553 <command id='description .TEXT'>
4554 <params>
4555 <param name='description' doc='Save human-readable description of the object' />
4556 <param name='.TEXT' doc='Text until the end of the line' />
4557 </params>
4558 </command>
4559 <command id='no description'>
4560 <params>
4561 <param name='no' doc='Negate a command or set its defaults' />
4562 <param name='description' doc='Remove description of the object' />
4563 </params>
4564 </command>
4565 <command id='nominal power &lt;0-100&gt;'>
4566 <params>
4567 <param name='nominal' doc='Nominal TRX RF Power in dBm' />
4568 <param name='power' doc='Nominal TRX RF Power in dBm' />
4569 <param name='&lt;0-100&gt;' doc='Nominal TRX RF Power in dBm' />
4570 </params>
4571 </command>
4572 <command id='max_power_red &lt;0-100&gt;'>
4573 <params>
4574 <param name='max_power_red' doc='Reduction of maximum BS RF Power (relative to nominal power)' />
4575 <param name='&lt;0-100&gt;' doc='Reduction of maximum BS RF Power in dB' />
4576 </params>
4577 </command>
4578 <command id='rsl e1 line E1_LINE timeslot &lt;1-31&gt; sub-slot (0|1|2|3|full)'>
4579 <params>
4580 <param name='rsl' doc='RSL Parameters' />
4581 <param name='e1' doc='E1/T1 interface to be used for RSL' />
4582 <param name='line' doc='E1/T1 interface to be used for RSL' />
4583 <param name='E1_LINE' doc='E1/T1 Line Number to be used for RSL' />
4584 <param name='timeslot' doc='E1/T1 Timeslot to be used for RSL' />
4585 <param name='&lt;1-31&gt;' doc='E1/T1 Timeslot to be used for RSL' />
4586 <param name='sub-slot' doc='E1/T1 Sub-slot to be used for RSL' />
4587 <param name='0' doc='E1/T1 Sub-slot 0 is to be used for RSL' />
4588 <param name='1' doc='E1/T1 Sub-slot 1 is to be used for RSL' />
4589 <param name='2' doc='E1/T1 Sub-slot 2 is to be used for RSL' />
4590 <param name='3' doc='E1/T1 Sub-slot 3 is to be used for RSL' />
4591 <param name='full' doc='E1/T1 full timeslot is to be used for RSL' />
4592 </params>
4593 </command>
4594 <command id='rsl e1 tei &lt;0-63&gt;'>
4595 <params>
4596 <param name='rsl' doc='RSL Parameters' />
4597 <param name='e1' doc='Set the TEI to be used for RSL' />
4598 <param name='tei' doc='Set the TEI to be used for RSL' />
4599 <param name='&lt;0-63&gt;' doc='TEI to be used for RSL' />
4600 </params>
4601 </command>
4602 <command id='rf_locked (0|1)'>
4603 <params>
4604 <param name='rf_locked' doc='Set or unset the RF Locking (Turn off RF of the TRX)' />
4605 <param name='0' doc='TRX is NOT RF locked (active)' />
4606 <param name='1' doc='TRX is RF locked (turned off)' />
4607 </params>
4608 </command>
4609 <command id='timeslot &lt;0-7&gt;'>
4610 <params>
4611 <param name='timeslot' doc='Select a Timeslot to configure' />
4612 <param name='&lt;0-7&gt;' doc='Timeslot number' />
4613 </params>
4614 </command>
4615 </node>
4616 <node id='config-net-bts-trx-ts'>
4617 <name>config-net-bts-trx-ts</name>
4618 <command id='phys_chan_config (none|ccch|ccch+sdcch4|tch/f|tch/h|sdcch8|pdch|tch/f_pdch|unknown|ccch+sdcch4+cbch|sdcch8+cbch|tch/f_tch/h_pdch)'>
4619 <params>
4620 <param name='phys_chan_config' doc='Physical Channel Combination' />
4621 <param name='none' doc='Physical Channel not configured' />
4622 <param name='ccch' doc='FCCH + SCH + BCCH + CCCH (Comb. IV)' />
4623 <param name='ccch+sdcch4' doc='FCCH + SCH + BCCH + CCCH + 4 SDCCH + 2 SACCH (Comb. V)' />
4624 <param name='tch/f' doc='TCH/F + FACCH/F + SACCH (Comb. I)' />
4625 <param name='tch/h' doc='2 TCH/H + 2 FACCH/H + 2 SACCH (Comb. II)' />
4626 <param name='sdcch8' doc='8 SDCCH + 4 SACCH (Comb. VII)' />
4627 <param name='pdch' doc='Packet Data Channel for GPRS/EDGE' />
4628 <param name='tch/f_pdch' doc='Dynamic TCH/F or GPRS PDCH' />
4629 <param name='unknown' doc='Unknown / Unsupported channel combination' />
4630 <param name='ccch+sdcch4+cbch' doc='FCCH + SCH + BCCH + CCCH + CBCH + 3 SDCCH + 2 SACCH (Comb. V)' />
4631 <param name='sdcch8+cbch' doc='7 SDCCH + 4 SACCH + CBCH (Comb. VII)' />
4632 <param name='tch/f_tch/h_pdch' doc='Dynamic TCH/F or TCH/H or GPRS PDCH' />
4633 </params>
4634 </command>
Neels Hofmeyr9f157572018-03-06 14:59:00 +01004635 <command id='training_sequence_code &lt;0-7&gt;'>
4636 <params>
4637 <param name='training_sequence_code' doc='Training Sequence Code of the Timeslot' />
4638 <param name='&lt;0-7&gt;' doc='TSC' />
4639 </params>
4640 </command>
4641 <command id='hopping enabled (0|1)'>
4642 <params>
4643 <param name='hopping' doc='Configure frequency hopping' />
4644 <param name='enabled' doc='Enable or disable frequency hopping' />
4645 <param name='0' doc='Disable frequency hopping' />
4646 <param name='1' doc='Enable frequency hopping' />
4647 </params>
4648 </command>
4649 <command id='hopping sequence-number &lt;0-63&gt;'>
4650 <params>
4651 <param name='hopping' doc='Configure frequency hopping' />
4652 <param name='sequence-number' doc='Which hopping sequence to use for this channel' />
4653 <param name='&lt;0-63&gt;' doc='Hopping Sequence Number (HSN)' />
4654 </params>
4655 </command>
4656 <command id='hopping maio &lt;0-63&gt;'>
4657 <params>
4658 <param name='hopping' doc='Configure frequency hopping' />
4659 <param name='maio' doc='Which hopping MAIO to use for this channel' />
4660 <param name='&lt;0-63&gt;' doc='Mobile Allocation Index Offset (MAIO)' />
4661 </params>
4662 </command>
4663 <command id='hopping arfcn add &lt;0-1023&gt;'>
4664 <params>
4665 <param name='hopping' doc='Configure frequency hopping' />
4666 <param name='arfcn' doc='Configure hopping ARFCN list' />
4667 <param name='add' doc='Add an entry to the hopping ARFCN list' />
4668 <param name='&lt;0-1023&gt;' doc='ARFCN' />
4669 </params>
4670 </command>
4671 <command id='hopping arfcn del &lt;0-1023&gt;'>
4672 <params>
4673 <param name='hopping' doc='Configure frequency hopping' />
4674 <param name='arfcn' doc='Configure hopping ARFCN list' />
4675 <param name='del' doc='Delete an entry to the hopping ARFCN list' />
4676 <param name='&lt;0-1023&gt;' doc='ARFCN' />
4677 </params>
4678 </command>
4679 <command id='e1 line E1_LINE timeslot &lt;1-31&gt; sub-slot (0|1|2|3|full)'>
4680 <params>
4681 <param name='e1' doc='E1/T1 channel connected to this on-air timeslot' />
4682 <param name='line' doc='E1/T1 channel connected to this on-air timeslot' />
4683 <param name='E1_LINE' doc='E1/T1 line connected to this on-air timeslot' />
4684 <param name='timeslot' doc='E1/T1 timeslot connected to this on-air timeslot' />
4685 <param name='&lt;1-31&gt;' doc='E1/T1 timeslot connected to this on-air timeslot' />
4686 <param name='sub-slot' doc='E1/T1 sub-slot connected to this on-air timeslot' />
4687 <param name='0' doc='E1/T1 sub-slot 0 connected to this on-air timeslot' />
4688 <param name='1' doc='E1/T1 sub-slot 1 connected to this on-air timeslot' />
4689 <param name='2' doc='E1/T1 sub-slot 2 connected to this on-air timeslot' />
4690 <param name='3' doc='E1/T1 sub-slot 3 connected to this on-air timeslot' />
4691 <param name='full' doc='Full E1/T1 timeslot connected to this on-air timeslot' />
4692 </params>
4693 </command>
4694 </node>
4695 <node id='oml'>
4696 <name>oml</name>
4697 <command id='change-adm-state (locked|unlocked|shutdown|null)'>
4698 <params>
4699 <param name='change-adm-state' doc='Change the Administrative State' />
4700 <param name='locked' doc='Locked' />
4701 <param name='unlocked' doc='Unlocked' />
4702 <param name='shutdown' doc='Shutdown' />
4703 <param name='null' doc='NULL' />
4704 </params>
4705 </command>
4706 <command id='opstart'>
4707 <params>
4708 <param name='opstart' doc='Send an OPSTART message to the object' />
4709 </params>
4710 </command>
4711 </node>
4712 <node id='config-msc'>
4713 <name>config-msc</name>
4714 <command id='core-mobile-network-code &lt;1-999&gt;'>
4715 <params>
4716 <param name='core-mobile-network-code' doc='Use this network code for the core network' />
4717 <param name='&lt;1-999&gt;' doc='MNC value' />
4718 </params>
4719 </command>
4720 <command id='core-mobile-country-code &lt;1-999&gt;'>
4721 <params>
4722 <param name='core-mobile-country-code' doc='Use this country code for the core network' />
4723 <param name='&lt;1-999&gt;' doc='MCC value' />
4724 </params>
4725 </command>
4726 <command id='core-location-area-code &lt;0-65535&gt;'>
4727 <params>
4728 <param name='core-location-area-code' doc='Use this location area code for the core network' />
4729 <param name='&lt;0-65535&gt;' doc='LAC value' />
4730 </params>
4731 </command>
4732 <command id='core-cell-identity &lt;0-65535&gt;'>
4733 <params>
4734 <param name='core-cell-identity' doc='Use this cell identity for the core network' />
4735 <param name='&lt;0-65535&gt;' doc='CI value' />
4736 </params>
4737 </command>
4738 <command id='ip.access rtp-base &lt;1-65000&gt;'>
4739 <params>
4740 <param name='ip.access' doc='IP.ACCESS specific' />
4741 <param name='rtp-base' doc='Set the rtp-base port for the RTP stream' />
4742 <param name='&lt;1-65000&gt;' doc='Port number' />
4743 </params>
4744 </command>
4745 <command id='codec-list .LIST'>
4746 <params>
4747 <param name='codec-list' doc='Set the allowed audio codecs' />
4748 <param name='.LIST' doc='List of audio codecs, e.g. fr3 fr1 hr3' />
4749 </params>
4750 </command>
Neels Hofmeyr9f157572018-03-06 14:59:00 +01004751 <command id='bsc-welcome-text .TEXT'>
4752 <params>
4753 <param name='bsc-welcome-text' doc='Set the USSD notification to be sent' />
4754 <param name='.TEXT' doc='Text to be sent' />
4755 </params>
4756 </command>
4757 <command id='no bsc-welcome-text'>
4758 <params>
4759 <param name='no' doc='Negate a command or set its defaults' />
4760 <param name='bsc-welcome-text' doc='Clear the USSD notification to be sent' />
4761 </params>
4762 </command>
4763 <command id='bsc-msc-lost-text .TEXT'>
4764 <params>
4765 <param name='bsc-msc-lost-text' doc='Set the USSD notification to be sent on MSC connection loss' />
4766 <param name='.TEXT' doc='Text to be sent' />
4767 </params>
4768 </command>
4769 <command id='no bsc-msc-lost-text'>
4770 <params>
4771 <param name='no' doc='Negate a command or set its defaults' />
4772 <param name='bsc-msc-lost-text' doc='Clear the USSD notification to be sent on MSC connection loss' />
4773 </params>
4774 </command>
4775 <command id='bsc-grace-text .TEXT'>
4776 <params>
4777 <param name='bsc-grace-text' doc='Set the USSD notification to be sent when the MSC has entered the grace period' />
4778 <param name='.TEXT' doc='Text to be sent' />
4779 </params>
4780 </command>
4781 <command id='no bsc-grace-text'>
4782 <params>
4783 <param name='no' doc='Negate a command or set its defaults' />
4784 <param name='bsc-grace-text' doc='Clear the USSD notification to be sent when the MSC has entered the grace period' />
4785 </params>
4786 </command>
4787 <command id='type (normal|local)'>
4788 <params>
4789 <param name='type' doc='Select the MSC type' />
4790 <param name='normal' doc='Plain GSM MSC' />
4791 <param name='local' doc='Special MSC for local call routing' />
4792 </params>
4793 </command>
4794 <command id='allow-emergency (allow|deny)'>
4795 <params>
4796 <param name='allow-emergency' doc='Allow CM ServiceRequests with type emergency' />
4797 <param name='allow' doc='Allow' />
4798 <param name='deny' doc='Deny' />
4799 </params>
4800 </command>
4801 <command id='local-prefix REGEXP'>
4802 <params>
4803 <param name='local-prefix' doc='Prefix for local numbers' />
4804 <param name='REGEXP' doc='REGEXP used' />
4805 </params>
4806 </command>
4807 <command id='amr-config 12_2k (allowed|forbidden)'>
4808 <params>
4809 <param name='amr-config' doc='AMR Multirate Configuration' />
4810 <param name='12_2k' doc='Bitrate' />
4811 <param name='allowed' doc='Allowed' />
4812 <param name='forbidden' doc='Forbidden' />
4813 </params>
4814 </command>
4815 <command id='amr-config 10_2k (allowed|forbidden)'>
4816 <params>
4817 <param name='amr-config' doc='AMR Multirate Configuration' />
4818 <param name='10_2k' doc='Bitrate' />
4819 <param name='allowed' doc='Allowed' />
4820 <param name='forbidden' doc='Forbidden' />
4821 </params>
4822 </command>
4823 <command id='amr-config 7_95k (allowed|forbidden)'>
4824 <params>
4825 <param name='amr-config' doc='AMR Multirate Configuration' />
4826 <param name='7_95k' doc='Bitrate' />
4827 <param name='allowed' doc='Allowed' />
4828 <param name='forbidden' doc='Forbidden' />
4829 </params>
4830 </command>
4831 <command id='amr-config 7_40k (allowed|forbidden)'>
4832 <params>
4833 <param name='amr-config' doc='AMR Multirate Configuration' />
4834 <param name='7_40k' doc='Bitrate' />
4835 <param name='allowed' doc='Allowed' />
4836 <param name='forbidden' doc='Forbidden' />
4837 </params>
4838 </command>
4839 <command id='amr-config 6_70k (allowed|forbidden)'>
4840 <params>
4841 <param name='amr-config' doc='AMR Multirate Configuration' />
4842 <param name='6_70k' doc='Bitrate' />
4843 <param name='allowed' doc='Allowed' />
4844 <param name='forbidden' doc='Forbidden' />
4845 </params>
4846 </command>
4847 <command id='amr-config 5_90k (allowed|forbidden)'>
4848 <params>
4849 <param name='amr-config' doc='AMR Multirate Configuration' />
4850 <param name='5_90k' doc='Bitrate' />
4851 <param name='allowed' doc='Allowed' />
4852 <param name='forbidden' doc='Forbidden' />
4853 </params>
4854 </command>
4855 <command id='amr-config 5_15k (allowed|forbidden)'>
4856 <params>
4857 <param name='amr-config' doc='AMR Multirate Configuration' />
4858 <param name='5_15k' doc='Bitrate' />
4859 <param name='allowed' doc='Allowed' />
4860 <param name='forbidden' doc='Forbidden' />
4861 </params>
4862 </command>
4863 <command id='amr-config 4_75k (allowed|forbidden)'>
4864 <params>
4865 <param name='amr-config' doc='AMR Multirate Configuration' />
4866 <param name='4_75k' doc='Bitrate' />
4867 <param name='allowed' doc='Allowed' />
4868 <param name='forbidden' doc='Forbidden' />
4869 </params>
4870 </command>
Daniel Willmannf450f442019-06-06 17:52:25 +02004871 <command id='amr-payload (octet-aligned|bandwith-efficient'>
4872 <params>
4873 <param name='amr-payload' doc='Set AMR payload framing mode' />
4874 <param name='octet-aligned' doc='payload fields aligned on octet boundaries' />
4875 <param name='bandwith-efficient' doc='payload fields packed (AoIP)' />
4876 </params>
4877 </command>
4878 <command id='lcls-mode (disabled|mgw-loop|bts-loop)'>
Neels Hofmeyr39e12152018-11-05 02:56:09 +01004879 <params>
4880 <param name='lcls-mode' doc='Configure 3GPP LCLS (Local Call, Local Switch)' />
4881 <param name='disabled' doc='Disable LCLS for all calls of this MSC' />
Daniel Willmannf450f442019-06-06 17:52:25 +02004882 <param name='mgw-loop' doc='Enable LCLS with looping traffic in MGW' />
4883 <param name='bts-loop' doc='Enable LCLS with looping traffic between BTS' />
Neels Hofmeyr39e12152018-11-05 02:56:09 +01004884 </params>
4885 </command>
4886 <command id='lcls-codec-mismatch (allowed|forbidden)'>
4887 <params>
4888 <param name='lcls-codec-mismatch' doc='Allow 3GPP LCLS (Local Call, Local Switch) when call legs use different codec/rate' />
4889 <param name='allowed' doc='Allow LCLS only only for calls that use the same codec/rate on both legs' />
4890 <param name='forbidden' doc='Do not Allow LCLS for calls that use a different codec/rate on both legs' />
4891 </params>
4892 </command>
Neels Hofmeyr9f157572018-03-06 14:59:00 +01004893 <command id='access-list-name NAME'>
4894 <params>
4895 <param name='access-list-name' doc='Set the name of the access list to use.' />
4896 <param name='NAME' doc='The name of the to be used access list.' />
4897 </params>
4898 </command>
4899 <command id='no access-list-name'>
4900 <params>
4901 <param name='no' doc='Negate a command or set its defaults' />
4902 <param name='access-list-name' doc='Remove the access list from the NAT.' />
4903 </params>
4904 </command>
4905 <command id='bsc-addr NAME'>
4906 <params>
4907 <param name='bsc-addr' doc='Calling Address (local address of this BSC)' />
4908 <param name='NAME' doc='SCCP address name' />
4909 </params>
4910 </command>
4911 <command id='msc-addr NAME'>
4912 <params>
4913 <param name='msc-addr' doc='Called Address (remote address of the MSC)' />
4914 <param name='NAME' doc='SCCP address name' />
4915 </params>
4916 </command>
Neels Hofmeyr39e12152018-11-05 02:56:09 +01004917 <command id='asp-protocol (m3ua|sua|ipa)'>
4918 <params>
4919 <param name='asp-protocol' doc='A interface protocol to use for this MSC)' />
4920 <param name='m3ua' doc='MTP3 User Adaptation' />
4921 <param name='sua' doc='SCCP User Adaptation' />
4922 <param name='ipa' doc='IPA Multiplex (SCCP Lite)' />
4923 </params>
4924 </command>
Neels Hofmeyr9f157572018-03-06 14:59:00 +01004925 <command id='mgw local-ip A.B.C.D'>
4926 <params>
4927 <param name='mgw' doc='Configure MGCP connection to Media Gateway' />
4928 <param name='local-ip' doc='local bind to connect to MGW from' />
4929 <param name='A.B.C.D' doc='local bind IP address' />
4930 </params>
4931 </command>
4932 <command id='mgw local-port &lt;0-65535&gt;'>
4933 <params>
4934 <param name='mgw' doc='Configure MGCP connection to Media Gateway' />
4935 <param name='local-port' doc='local port to connect to MGW from' />
4936 <param name='&lt;0-65535&gt;' doc='local bind port' />
4937 </params>
4938 </command>
4939 <command id='mgw remote-ip A.B.C.D'>
4940 <params>
4941 <param name='mgw' doc='Configure MGCP connection to Media Gateway' />
4942 <param name='remote-ip' doc='remote IP address to reach the MGW at' />
4943 <param name='A.B.C.D' doc='remote IP address' />
4944 </params>
4945 </command>
4946 <command id='mgw remote-port &lt;0-65535&gt;'>
4947 <params>
4948 <param name='mgw' doc='Configure MGCP connection to Media Gateway' />
4949 <param name='remote-port' doc='remote port to reach the MGW at' />
4950 <param name='&lt;0-65535&gt;' doc='remote port' />
4951 </params>
4952 </command>
Daniel Willmannf450f442019-06-06 17:52:25 +02004953 <command id='mgw endpoint-domain NAME'>
Neels Hofmeyr9f157572018-03-06 14:59:00 +01004954 <params>
4955 <param name='mgw' doc='Configure MGCP connection to Media Gateway' />
Daniel Willmannf450f442019-06-06 17:52:25 +02004956 <param name='endpoint-domain' doc='Set the domain name to send in MGCP messages, e.g. the part &apos;foo&apos; in &apos;rtpbridge/*@foo&apos;.' />
4957 <param name='NAME' doc='Domain name, should be alphanumeric.' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01004958 </params>
4959 </command>
Neels Hofmeyr39e12152018-11-05 02:56:09 +01004960 <command id='mgw x-osmo-ign call-id'>
Neels Hofmeyr9f157572018-03-06 14:59:00 +01004961 <params>
Neels Hofmeyr39e12152018-11-05 02:56:09 +01004962 <param name='mgw' doc='Configure MGCP connection to Media Gateway' />
4963 <param name='x-osmo-ign' doc='Set a (non-standard) X-Osmo-IGN header in all CRCX messages for RTP streams associated with this MSC, useful for A/SCCPlite MSCs, since osmo-bsc cannot know the MSC&apos;s chosen CallID. This is enabled by default for A/SCCPlite connections, disabled by default for all others.' />
4964 <param name='call-id' doc='Send &apos;X-Osmo-IGN: C&apos; to ignore CallID mismatches. See OsmoMGW.' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01004965 </params>
4966 </command>
Neels Hofmeyr39e12152018-11-05 02:56:09 +01004967 <command id='no mgw x-osmo-ign'>
Neels Hofmeyr9f157572018-03-06 14:59:00 +01004968 <params>
Neels Hofmeyr39e12152018-11-05 02:56:09 +01004969 <param name='no' doc='Negate a command or set its defaults' />
4970 <param name='mgw' doc='Configure MGCP connection to Media Gateway' />
4971 <param name='x-osmo-ign' doc='Do not send X-Osmo-IGN MGCP header to this MSC' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01004972 </params>
4973 </command>
Daniel Willmannf450f442019-06-06 17:52:25 +02004974 <command id='osmux (on|off|only)'>
4975 <params>
4976 <param name='osmux' doc='RTP multiplexing' />
4977 <param name='on' doc='Enable OSMUX' />
4978 <param name='off' doc='Disable OSMUX' />
4979 <param name='only' doc='Only use OSMUX' />
4980 </params>
4981 </command>
Neels Hofmeyr9f157572018-03-06 14:59:00 +01004982 </node>
4983 <node id='om2k'>
4984 <name>om2k</name>
4985 <command id='reset-command'>
4986 <params>
4987 <param name='reset-command' doc='Reset the MO' />
4988 </params>
4989 </command>
4990 <command id='start-request'>
4991 <params>
4992 <param name='start-request' doc='Start the MO' />
4993 </params>
4994 </command>
4995 <command id='status-request'>
4996 <params>
4997 <param name='status-request' doc='Get the MO Status' />
4998 </params>
4999 </command>
5000 <command id='connect-command'>
5001 <params>
5002 <param name='connect-command' doc='Connect the MO' />
5003 </params>
5004 </command>
5005 <command id='disconnect-command'>
5006 <params>
5007 <param name='disconnect-command' doc='Disconnect the MO' />
5008 </params>
5009 </command>
5010 <command id='enable-request'>
5011 <params>
5012 <param name='enable-request' doc='Enable the MO' />
5013 </params>
5014 </command>
5015 <command id='disable-request'>
5016 <params>
5017 <param name='disable-request' doc='Disable the MO' />
5018 </params>
5019 </command>
5020 <command id='operational-info &lt;0-1&gt;'>
5021 <params>
5022 <param name='operational-info' doc='Set operational information' />
5023 <param name='&lt;0-1&gt;' doc='Set operational info to 0 or 1' />
5024 </params>
5025 </command>
5026 <command id='test-request'>
5027 <params>
5028 <param name='test-request' doc='Test the MO' />
5029 </params>
5030 </command>
5031 <command id='capabilities-request'>
5032 <params>
5033 <param name='capabilities-request' doc='Request MO capabilities' />
5034 </params>
5035 </command>
5036 <command id='configuration-request'>
5037 <params>
5038 <param name='configuration-request' doc='Send the configuration request for current MO' />
5039 </params>
5040 </command>
5041 </node>
5042 <node id='om2k-con-group'>
5043 <name>om2k-con-group</name>
5044 <command id='con-path (add|del) &lt;0-2047&gt; &lt;0-255&gt; deconcentrated &lt;0-63&gt;'>
5045 <params>
5046 <param name='con-path' doc='CON Path (In/Out)' />
5047 <param name='add' doc='Add CON Path to Concentration Group' />
5048 <param name='del' doc='Delete CON Path from Concentration Group' />
Ruben Undheim06e6f8a2019-07-16 21:13:12 +02005049 <param name='&lt;0-2047&gt;' doc='CON Connection Point' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01005050 <param name='&lt;0-255&gt;' doc='Contiguity Index' />
5051 <param name='deconcentrated' doc='De-concentrated in/outlet' />
5052 <param name='&lt;0-63&gt;' doc='TEI Value' />
5053 </params>
5054 </command>
5055 <command id='con-path (add|del) &lt;0-2047&gt; &lt;0-255&gt; concentrated &lt;1-16&gt;'>
5056 <params>
5057 <param name='con-path' doc='CON Path (In/Out)' />
5058 <param name='add' doc='Add CON Path to Concentration Group' />
5059 <param name='del' doc='Delete CON Path from Concentration Group' />
Ruben Undheim06e6f8a2019-07-16 21:13:12 +02005060 <param name='&lt;0-2047&gt;' doc='CON Connection Point' />
Neels Hofmeyr9f157572018-03-06 14:59:00 +01005061 <param name='&lt;0-255&gt;' doc='Contiguity Index' />
5062 <param name='concentrated' doc='Concentrated in/outlet' />
5063 <param name='&lt;1-16&gt;' doc='Tag Number' />
5064 </params>
5065 </command>
5066 </node>
5067 <node id='config-bsc'>
5068 <name>config-bsc</name>
5069 <command id='mid-call-text .TEXT'>
5070 <params>
5071 <param name='mid-call-text' doc='Set the USSD notification sent to running calls when switching from Grace to Off.' />
5072 <param name='.TEXT' doc='Text to be sent' />
5073 </params>
5074 </command>
5075 <command id='mid-call-timeout NR'>
5076 <params>
5077 <param name='mid-call-timeout' doc='Switch from Grace to Off in NR seconds.' />
5078 <param name='NR' doc='Timeout in seconds' />
5079 </params>
5080 </command>
5081 <command id='bsc-rf-socket PATH'>
5082 <params>
5083 <param name='bsc-rf-socket' doc='Set the filename for the RF control interface.' />
5084 <param name='PATH' doc='RF Control path' />
5085 </params>
5086 </command>
5087 <command id='bsc-auto-rf-off &lt;1-65000&gt;'>
5088 <params>
5089 <param name='bsc-auto-rf-off' doc='Disable RF on MSC Connection' />
5090 <param name='&lt;1-65000&gt;' doc='Timeout' />
5091 </params>
5092 </command>
5093 <command id='no bsc-auto-rf-off'>
5094 <params>
5095 <param name='no' doc='Negate a command or set its defaults' />
5096 <param name='bsc-auto-rf-off' doc='Disable RF on MSC Connection' />
5097 </params>
5098 </command>
5099 <command id='missing-msc-text .TEXT'>
5100 <params>
5101 <param name='missing-msc-text' doc='Set the USSD notification to be send when a MSC has not been found.' />
5102 <param name='.TEXT' doc='Text to be sent' />
5103 </params>
5104 </command>
5105 <command id='no missing-msc-text'>
5106 <params>
5107 <param name='no' doc='Negate a command or set its defaults' />
5108 <param name='missing-msc-text' doc='Clear the USSD notification to be send when a MSC has not been found.' />
5109 </params>
5110 </command>
5111 <command id='access-list-name NAME'>
5112 <params>
5113 <param name='access-list-name' doc='Set the name of the access list to use.' />
5114 <param name='NAME' doc='The name of the to be used access list.' />
5115 </params>
5116 </command>
5117 <command id='no access-list-name'>
5118 <params>
5119 <param name='no' doc='Negate a command or set its defaults' />
5120 <param name='access-list-name' doc='Remove the access list from the BSC' />
5121 </params>
5122 </command>
5123 <command id='access-list NAME imsi-allow [REGEXP]'>
5124 <params>
5125 <param name='access-list' doc='Access list commands' />
5126 <param name='NAME' doc='Name of the access list' />
5127 <param name='imsi-allow' doc='Add allowed IMSI to the list' />
5128 <param name='[REGEXP]' doc='Regexp for IMSIs' />
5129 </params>
5130 </command>
5131 <command id='access-list NAME imsi-deny [REGEXP] (&lt;0-256&gt;) (&lt;0-256&gt;)'>
5132 <params>
5133 <param name='access-list' doc='Access list commands' />
5134 <param name='NAME' doc='Name of the access list' />
5135 <param name='imsi-deny' doc='Add denied IMSI to the list' />
5136 <param name='[REGEXP]' doc='Regexp for IMSIs' />
5137 <param name='&lt;0-256&gt;' doc='CM Service Reject reason' />
5138 <param name='&lt;0-256&gt;' doc='LU Reject reason' />
5139 </params>
5140 </command>
5141 <command id='no access-list NAME'>
5142 <params>
5143 <param name='no' doc='Negate a command or set its defaults' />
5144 <param name='access-list' doc='Remove an access-list by name' />
5145 <param name='NAME' doc='The access-list to remove' />
5146 </params>
5147 </command>
5148 </node>
Harald Welted41b7c72019-06-13 09:41:58 +02005149 <node id='config-cbc'>
5150 <name>config-cbc</name>
5151 <command id='remote-ip A.B.C.D'>
5152 <params>
5153 <param name='remote-ip' doc='IP Address of the Cell Broadcast Centre' />
5154 <param name='A.B.C.D' doc='IP Address of the Cell Broadcast Centre' />
5155 </params>
5156 </command>
5157 <command id='no remote-ip'>
5158 <params>
5159 <param name='no' doc='Negate a command or set its defaults' />
5160 <param name='remote-ip' doc='Remove IP address of CBC; disables outbound CBSP connections' />
5161 </params>
5162 </command>
5163 <command id='remote-port &lt;1-65535&gt;'>
5164 <params>
5165 <param name='remote-port' doc='TCP Port number of the Cell Broadcast Centre (Default: 48049)' />
5166 <param name='&lt;1-65535&gt;' doc='TCP Port number of the Cell Broadcast Centre (Default: 48049)' />
5167 </params>
5168 </command>
5169 <command id='listen-port &lt;1-65535&gt;'>
5170 <params>
5171 <param name='listen-port' doc='Local TCP port at which BSC listens for incoming CBSP connections from CBC' />
5172 <param name='&lt;1-65535&gt;' doc='Local TCP port at which BSC listens for incoming CBSP connections from CBC' />
5173 </params>
5174 </command>
5175 <command id='no listen-port'>
5176 <params>
5177 <param name='no' doc='Negate a command or set its defaults' />
5178 <param name='listen-port' doc='Remove CBSP Listen Port; disables inbound CBSP connections' />
5179 </params>
5180 </command>
5181 <command id='listen-ip A.B.C.D'>
5182 <params>
5183 <param name='listen-ip' doc='Local IP Address where BSC listens for incoming CBC connections (Default: 0.0.0.0)' />
5184 <param name='A.B.C.D' doc='Local IP Address where BSC listens for incoming CBC connections' />
5185 </params>
5186 </command>
5187 </node>
Neels Hofmeyr9f157572018-03-06 14:59:00 +01005188</vtydoc>