Project

General

Profile

Osmo-nitb VTY » History » Version 30

laforge, 02/19/2016 10:48 PM
Name changed from bsc_hack_VTY to osmo-nitb_VTY

1 3 laforge
[[PageOutline]]
2 1
3 3 laforge
This page is a reference fo all VTY commands that you can use interactively on the OpenBSC VTY telnet interface.
4
5
In addition, the same commands are used for the configuration file.
6
7 1
== configuration reference ==
8
9 28 laforge
=== e1_input level ===
10
11
At the e1_line level, you configure which E1 line number is using which driver
12
13
==== e1_line <0-255> driver (misdn|dahdi) ====
14
15
You can specify which of your line numbers shall be using which driver.
16
17 29 laforge
=== log file FILENAME ===
18
19
Configure the logging parameters for logging to the indicated text file
20
21
=== log syslog (authpriv|cron|daemon|ftp|lpr|mail|news|user|uucp) ===
22
23
Configure logging via {{{syslogd}}} using the facility as indicated.
24
25
=== log syslog local <0-7> ===
26
27
Configure logging via {{{syslogd}}} using the facility LOG_LOCAL0...LOG_LOCAL7
28
29
=== log stderr ===
30
31
Configure logging via stderr of the process
32
33
=== Commands below the log level ===
34
The following commands work on any 'log level' command, independent of stderr/syslog/file based logging.
35
36
==== logging filter all (0|1) ====
37
Define whether to use the '''filter all''', i.e. to match and log all messages.
38
39
==== logging color (0|1) ====
40
Define whether to use color when writing log lines.
41
42
==== logging timestamp (0|1) ====
43
Define whether the log statements should include a timestamp.
44
45
==== logging level SUBSYS LEVEL ====
46
47
48 1
=== network level ===
49
50 3 laforge
At the network level, we specify parameters that are global for an entire GSM network.
51
52 1
==== network country code ====
53
54 3 laforge
The network country code (NCC) to be used for this network.  Default is 1.
55 1
56
==== mobile network code ====
57
58 3 laforge
The mobile network code (MNC) to be used for this network.  Default is 1.
59 1
60
==== short name ====
61
62
This is the short network name to be used in the GSM 04.08 MM INFO message.
63
64
==== long name ====
65
66
This is the long network name to be used in the GSM 04.08 MM INFO message.
67
68
==== auth policy ====
69
70
This defines the authentication policy of the network.  Possible values are:
71
72
 * ''closed'': Don't allow anyone who is not marked as authorized=1 in the hlr database
73
 * ''accept-all': Accept everyone into the network
74
 * ''token'': Use a special [wiki:TokenAuthPolicy]
75
76 17 laforge
==== location updating reject cause <2-111> ====
77
78
Set the CAUSE value when sending LOCATION UPDATING REJECT to a MS.  Possible values are
79
defined in GSM TS 04.08 / 10.5.3.6.
80
81 10
==== encryption a5 (0|1|2) ====
82 5
83 6
* Enable/Disable A5/X encryption on the network.
84 5
85 10
==== neci (0|1) ====
86 8
87
Changes the Cell Selection Parameter called NECI Half Rate Support.
88
89
 * "0": New establishment causes are not supported.
90
 * "1": New establishment causes are supported.
91
92 17 laforge
==== rrlp mode (none|ms-based|ms-preferred|ass-preferred) ====
93
94
Set the RRLP mode, i.e. if OpenBSC should routinely send RRLP inquiries to phones and store the response
95
96
 * none: Do not perform RRLP inquiries
97
 * ms-based: Ask for a MS-Based location
98
 * ms-preferred: Ask for a location, MS based is preferred over Network Assistance based
99
 * ass-preferred: Ask for a location, Netowrk Assistance based is preferred over MS based
100
101
==== mm info (0|1) ====
102
103
Should we send MM INFO messages with network name and timezone information?
104
105
==== handover (0|1) ====
106
Should the BSC enable in-call handover between multiple BTS?
107
108
==== handover window rxlev averaging <1-10> ====
109
Over how many SACCH frames should the Rx Level of the serving cell be averaged?
110
111
==== handover window rxqual averaging <1-10> ====
112
Over how many SACCH frames should the Rx Quality of the serving cell be averaged?
113
114 21
==== handover window rxlev neighbor averaging <1-10> ====
115 17 laforge
Over how many SACCH frames should the Rx Level of a neighbor cell be averaged?
116
117
==== handover power budget interval <1-99> ====
118
Every how many SACCH frames should the BSC think about performing a power budget (rx level)
119
handover?
120
121
==== handover power budget hysteresis <0-999> ====
122
How large should the hysteresis be, i.e. to prevent continuous handover back and forth
123
124
==== handover maximum distance <0-9999> ====
125
What is the maximum distance from a BTS, after which we try to perform distance handover?
126
127 11
==== timer t3101 <0-65535> ====
128
 * Started after IMMEDIATE ASSIGMENT, should be higher than the time for a L2 establishment attempt
129 10
130 11
==== timer t3103 <0-65535> ====
131
 * Started by sending a HANDOVER message. This timer is currently not in use.
132 10
133 11
==== timer t3105 <0-65535> ====
134
 * Used for the repetition of the PHYSICAL INFORMATION message during handover. This timer is currently not in use.
135
136 10
==== timer t3107 <0-65535> ====
137 11
 * Started after ASSIGMENT COMMAND to keep the old channel long enough alive. This timer is currently not in use due the usage of very early assignment in Call Control
138 1
139 12
140
==== timer t3109 <0-65535> ====
141 1
 * The purpose of this timer is to release channels in case of loss of communucation.
142 12
143 1
==== timer t3111 <0-65535> ====
144 20
 * GSM Spec: This timer value is equal to T3110 and is used to delay the channel deactivation after disconnecting the main signalling link.
145
 * OpenBSC will wait t3111 seconds after all SAPIs were released to send the RF Channel Release to the BTS. After the following RF Channel Release ACK OpenBSC will reuse the channel for further requests.
146 12
147 1
==== timer t3113 <0-65535> ====
148 12
 * This timer is used for the PAGING REQUEST
149
150 1
==== timer t3115 <0-65535> ====
151 12
 * This timer is used for the repetition of the VGCS UPLINK GRANT message, it is currently not in use.
152
153 1
==== timer t3117 <0-65535> ====
154 9
 *  This is started after sending the PDCH ASSIGNMENT COMMAND
155 14
156 17 laforge
==== timer t3119 <0-65535> ====
157 14
 * This is started after sending the RR-CELL CHANGE ORDER message.
158 15
159 14
==== timer t3141 <0-65535> ====
160 16
161
==== [bsc_msc_ip] ipacc rtp_payload <0-256> ====
162 1
 * This option is currently only available in the on-waves/bsc-master branch (but it will be merged in one way or another).
163 3 laforge
 * This configuration will override the RTP Payload in the MDCX message to not use the returned value by the nanoBTS but use this network setting.
164 1
165
==== [bsc_msc_ip] rtp base <0-65534> ====
166
 * This option is currently only available in the on-waves/bsc-master branch (but it will be merged in one way or another).
167
 * In the bsc_msc_ip sceneriao the BSC and the MGCP do not communicate with each other. To make it work they will need to share the secret of the base port.
168 3 laforge
169 1
==== [bsc_msc_ip] core mobile network code <1-999> ====
170
 * A network specific hack
171
 * Be able to use a different network code inside the A communication than used on A-bis.
172 19
 * This way one can differentiate networks on the phone but use the same one in the core network
173
174
==== [bsc_msc_ip] token TOKEN ====
175
 * Send this token to the MSC when asked for the id.
176
 * It can be any text..
177
 * This is a very weak authentication scheme.
178
179 23
==== [bsc_msc_ip] msc ip IP ====
180
 * The IP address to use when attempting to connect to the MSC.
181
182 26
==== [bsc_msc_ip] msc port PORT ====
183 23
 * The port to use when attempting to connect to the MSC.
184
185 27
==== [bsc_msc_ip] msc ip-tos TOS ====
186
 * The IP Type of Service (TOS) to use for the connection to the MSC.
187 3 laforge
188 4
=== bts level ===
189 1
190 3 laforge
At the BTS level, we define parameters that are global for this particular BTS.
191
192 1
==== type ====
193
The type of the BTS.  Currently supported;
194 3 laforge
195
 * ''bs-11''
196 1
 * ''nanobts''
197
198
==== band ====
199
The GSM band of the BTS.  Currently supported:
200 3 laforge
 * GSM400
201 1
 * GSM850
202
 * GSM900
203
 * DCS1800
204
 * PCS1900
205
206
==== cell_identity <0-65535> ====
207
The Cell Identity of this BTS
208
209 17 laforge
==== location area code <0-65535> ====
210 1
The LAC of the location area to which this BTS belongs.
211
212
==== training_sequence_code <0-255> ====
213
Set the Training Sequence Code (TSC) of this BTS
214
215 17 laforge
==== base_station_id_code <0-63> ====
216 1
The BSIC of this BTS within the location area.
217
218 17 laforge
==== ip.access unit_id ====
219
The ip.access Unit ID.  Unit ID is used to identify the BTS to the BSC.  You set the Unit ID of the BTS by using the [wiki:ipaccess-config] program.  Make sure you use the same Unit ID in the nanoBTS as well as in OpenBSC.
220 1
221 17 laforge
==== oml ip.access stream_id <0-255> ====
222
Which IPA stream identifier is to be used for the OML link between BTS and BSC.
223 1
224 17 laforge
==== oml e1 tei ====
225
The Q.921 TEI to be used for the A-bis OML link of this BTS.
226 1
227 17 laforge
Make sure you use the same value than you have set in the BTS (by bs11-config or LMT).
228 1
229 17 laforge
==== oml e1 line E1_LINE timeslot <1-31> sub-slot (0|1|2|3|full) ====
230
Set the E1 line, E1 timeslot and E1 sub-slot for the OML link to this BTS.
231 1
232 17 laforge
Make sure you use the same value than you have set in the BTS (by bs11-config or LMT).
233
234
==== channel allocator ====
235 1
Whether the channels should be allocated in ascending or descending order.
236
237
If the channel allocator is in ascending mode, it will first allocate timeslot 0, then timeslot 1, ... of TRX0. If TRX0 is full, it will switch to TRX1.  In descending order, it is the other way around.
238
239 17 laforge
==== rach tx integer <0-15> ====
240
The RACH TX Integer announced on the BCCH in System Information messages
241 1
242 17 laforge
==== rach max transmission (1|2|4|7) ====
243
How many retransmissions should a MS make on a RACH request?
244
245 25
==== rach emergency call allowed (0|1) ====
246
'''ATTENTION: Only use this option when you know what you are doing and can route emergency calls to a proper place.'''
247
248
This setting is used in the System Information on the BCCH and indicates if this cell can be used to do emergency calls. The default value for this option is 0.
249
250 17 laforge
==== cell barred (0|1) ====
251 1
Whether this BTS is barred from access or not.
252
253 17 laforge
==== ms max power <0-40> ====
254
maximum transmit power (in dBm) to be used by MS in this BTS.  This is used in the System Information on the BCCH as
255
well as for the MS power level at the time a dedicated channel is activated.
256 1
257 17 laforge
==== periodic location update <0-1530> ====
258
Periodic Location Updating interval in minutes.
259 1
260 17 laforge
If you set this to a non-zero value, every MS will perform a periodic location updating procedure at the given interval.
261 1
262 17 laforge
A value of 0 will deactivate periodic location updating.
263 1
264 17 laforge
==== cell reselection hysteresis <0-14> ====
265
How many dB has a neighbor cell to be received better than the serving cell to perform cell reselection in idle mode.
266 1
267 17 laforge
==== rxlev access min <0-63> ====
268
How strong has the signal to be received at the MS, before a MS is allowed to switch to this cell in idle mode?
269 1
270 24 laforge
==== gprs mode (none|gprs|egprs) ====
271
272
Do you want to enable GPRS or EGPRS (EDGE) on this BTS?
273 1
274 17 laforge
==== gprs routing area <0-255> ====
275
To which GPRS routing area does this BTS belong?
276 3 laforge
277 17 laforge
==== gprs cell bvci <0-65535> ====
278
BSGP Virtual Connection Identifier
279 2
280 17 laforge
==== gprs nsei <0-65535> ====
281
NS Entity Identifier
282 3 laforge
283 17 laforge
==== gprs nsvc <0-1> nsvci <0-65535> ====
284
NS Virtual Connection Identifier
285 3 laforge
286 17 laforge
==== gprs nsvc <0-1> local udp port <0-65535> ====
287
The local UDP port (on the BTS) to be used for NS-over-IP
288 2
289 17 laforge
==== gprs nsvc <0-1> remote udp port <0-65535> ====
290
The remote UDP port (of the SGSN) to be used for NS-over-IP
291 1
292 17 laforge
==== gprs nsvc <0-1> remote ip A.B.C.D ====
293
The remote IP address (of the SGSN) to be used for NS-over-IP
294
295
=== trx level ===
296 1
At the trx level, we specify parameters for one particular TRX (transceiver).
297
298 2
==== arfcn ====
299 1
The ARFCN of a non-hopping TRX.
300
301 22
==== nominal power <0-100> ====
302 17 laforge
How many dBm is the nominal power of this BTS.  This setting is only used as a base for computing
303
power levels displayed to the user.
304 13
305 17 laforge
==== max_power_red <0-100> ====
306
How many dB the nominal transmit power of the TRX should be reduced from its maximum (by OML means)
307 13
308
If your transmitter is set to e.g. 24 dBm and you set this to 10, your actual output power will be 14 dBm.
309
310
==== rf_locked (0|1) ====
311 17 laforge
This option can be used at start and at runtime to enable/disable RF of the transceiver.
312 2
 * "0": RF is not locked (enabled)
313 3 laforge
 * "1": RF is locked (disabled)
314 2
315 17 laforge
==== rsl e1 tei <0-63> ====
316 2
The Q.921 TEI to be used for the A-bis RSL link between BTS and BSC.
317 3 laforge
318 2
Make sure you don't use the same TEI twice in one E1 Link!
319 3 laforge
320
==== rsl e1 line E1_LINE timeslot <1-31> sub-slot (0|1|2|3|full) ====
321 2
Set the E1 Line, E1 timeslot and E1 sub-slot for the RSL link to this BTS.
322 1
323 3 laforge
=== timeslot level ===
324
The timeslot level lists parameters for one specific on-air timeslot.
325 1
326
==== phys_chan_config ====
327
Set the physical channel configuration of this GSM on-air timeslot:
328 2
329
 * ''NONE'': do not use this timeslot
330
 * ''CCCH'': regular CCCH configuration (BCCH+RACH+PCH+AGCH)
331
 * ''CCCH+SDCCH4'': CCCH plus SDCCH/4 combination
332
 * ''TCH/F'': Full TCH
333
 * ''TCH/H'': Half TCH
334
 * ''SDCCH8'': SDCCH/8 combination
335 17 laforge
 * ''PDCH'': Packed Data CHannel
336
 * ''TCH/F_PDCH'': Alternating TCH/F and PDCH use
337 3 laforge
338
===== e1 line e1 line E1_LINE timeslot <1-31> sub-slot (0|1|2|3) =====
339
Set the E1 line, E1 timeslot and E1 sub-slot to be used for this on-air timeslot if it is used as a TCH.
340
341 1
The TRAU frames for this on-air timeslot will be sent to the sub-slot you have specified here.
342 18
343
== Runtime Options ==
344
The bsc_hack application listens on port 4242 on localhost and one can use telnet to connect to it. With the VTY interface one can use commands to inspect the state of OpenBSC, change the configuration and schedule work. Typing '?' will print a list of commands that are available in this screen and with tab completion one can complete command.
345
346
=== Subscriber commands ===
347
 * OpenBSC VTY has multiple ways to address a subscriber. It can be addressed by IMSI, by TMSI, the assigned extension and finally the id inside the database.
348
 
349
==== subscriber (extension|imsi|tmsi|id) NUMBER sms TEXT ====
350
 {{{OpenBSC> subscriber extension 666 sms send "Hallo"}}}
351
352
 * The above command will allow you to send a SMS to the subscriber.
Add picture from clipboard (Maximum size: 48.8 MB)