Project

General

Profile

Osmo-nitb VTY » History » Version 24

laforge, 02/19/2016 10:48 PM
new "gprs enable" -> "gprs mode" syntax at BTS level

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