Project

General

Profile

Osmocom Network In The Box » History » Version 95

neels, 12/29/2017 07:47 PM

1 23 neels
{{>toc}}
2
3 1 neels
h1. Osmocom Network In The Box
4
5 22 neels
This is a brief guide to the most basic and minimal setup of an Osmocom 2G and/or 3G network for voice and data services. It is a good starting point for newcomers to familiarize with the software, and to expand upon by the [[Osmocom Manuals]] and other wiki pages.
6 21 neels
7 68 neels
h1. OsmoNITB R.I.P., long live the Network In The Box
8 1 neels
9 2 neels
Historically, Osmocom offered the [[OsmoNITB:]] "Network-In-The-Box" as an actual single program. It was a useful simplification at the time, but in 2017, Osmocom have decided to split OsmoNITB into programs more closely resembling traditional network architecture. It is recommended to use the new separate components instead of the OsmoNITB, since active development focus has moved there.
10 1 neels
11 4 neels
It is still very much possible to run a complete Osmocom core network in one "box". For example, a sysmoBTS can run the entire core network on the same hardware that drives the TRX, making it a complete network in actually one single box. At the same time, having separate components also allows scaling to large deployments, with properly distributed load and a central subscriber database.
12 1 neels
13 2 neels
To migrate from OsmoNITB to the new separate programs, see the [[OsmoNITB Migration Guide]].
14
15 68 neels
h1. Part of this Complete Network
16 2 neels
17 32 neels
Assuming that you have your radio hardware ready (a BTS, a femto cell or an SDR driven by osmo-trx), the core network consists of separate programs providing voice/SMS/USSD ("circuit-switched" or CS) and data ("packet-switched" or PS) services.
18 2 neels
19 32 neels
Here is a table of the components you need:
20 1 neels
21 32 neels
|\4. *Required for*  |/3. *Program* |/3. *Description* |
22
|\2. *2G*  |\2. *3G* |
23
| *CS* | *PS* | *CS* | *PS* |
24 92 neels
| ✔ | ✔ | ✔ | ✔ | [[Osmocom Network In The Box#OsmoHLR|OsmoHLR]] | Home Location Register, stores subscriber IMSI, phone number and auth tokens. |
25
| ✔ | (1) | ✔ | (1) | [[Osmocom Network In The Box#OsmoMSC|OsmoMSC]] | Mobile Switching Center, handles signalling, i.e. attach/detach of subscribers, call establishment, messaging (SMS and USSD). |
26
| ✔ |   | ✔ |   | [[Osmocom Network In The Box#OsmoMGW|OsmoMGW]] | Media Gateway, is instructed by the MSC and/or the BSC to direct RTP streams for active voice calls. |
27
| ✔ | ✔ | ✔ | ✔ | [[Osmocom Network In The Box#OsmoSTP|OsmoSTP]] | Signal Transfer Point, routes SCCP messages between MSC, BSC, HNBGW and for 3G also the SGSN. |
28
| ✔ | (1) |   |   | [[Osmocom Network In The Box#OsmoBSC|OsmoBSC]] | 2G Base Station Controller, manages logical channels and other lower level aspects for one or more 2G BTS; it is technically part of the BSS and not the "core network". |
29
|   |   | ✔ | ✔ | [[Osmocom Network In The Box#OsmoHNBGW|OsmoHNBGW]] | 3G HomeNodeB Gateway, receives the Iuh protocol from a 3G femto cell and forwards to MSC and SGSN by SCCP/M3UA via OsmoSTP. |
30
|   | ✔ (2) |   | ✔ (2) | [[Osmocom Network In The Box#OsmoGGSN|OsmoGGSN]] | Gateway GPRS Support Node, "opens" GTP tunnels received from SGSNs to internet uplink. |
31
|   | ✔ |   | ✔ | [[Osmocom Network In The Box#OsmoSGSN|OsmoSGSN]] | Serving GPRS Support Node, handles signalling, i.e. attach/detach of subscribers and PDP contexts. |
32
| ✔ | (1) |   |   | [[Osmocom Network In The Box#OsmoBTS|OsmoBTS]] | for 2G networks, drives the TRX and ties to the BSC via Abis-interface. |
33
|   | ✔ |   |   | [[Osmocom Network In The Box#OsmoPCU|OsmoPCU]] | for 2G networks, a component closely tied to the BTS, drives the TRX for PS timeslots and ties to the SGSN via Gb-interface. |
34 37 neels
|   |   | ✔ | ✔ | hNodeb | 3rd party 3G femto cell hardware to connect to OsmoHNBGW via Iuh |
35 5 neels
36 32 neels
1: PS is always an _addition_ to CS: even though these components do not handle PS requests, you need to have these to be able to setup and register with a network, which is a prerequisite for data services.
37 28 neels
38 74 neels
2: For the GGSN to successfully route packets to an internet uplink, it needs a tun device set up and usually IP masquerading/forwarding enabled. Please refer to the OsmoGGSN manual for more details.
39 18 neels
40 68 neels
h2. Topology
41 55 neels
42
{{graphviz_link()
43
digraph G {
44
  rankdir = LR;
45 56 neels
  
46
  MS [label="MS\n(2G phone)"]
47
  UE [label="UE\n(3G phone)"]
48 1 neels
49 56 neels
  subgraph cluster_bts {
50
    BTS [rank="min"]
51
    PCU [rank="min"]
52
  }
53
54
  subgraph cluster_msc_mgw {
55 59 neels
    label=MGCP;style=dotted
56 56 neels
    MSC
57 57 neels
    MGW1 [label="MGW"]
58 56 neels
  }
59
60
  subgraph cluster_bsc_mgw {
61 59 neels
    label=MGCP;style=dotted
62 56 neels
    BSC
63 57 neels
    MGW2 [label="MGW"]
64 1 neels
  }
65
66 59 neels
  hNodeB [shape="box",label="hNodeB\n(3G femto cell)"]
67
68 61 neels
  MS -> BTS [label="Um"]
69 65 neels
  MS -> PCU [style="dashed"]
70 60 neels
 
71 56 neels
  BTS -> BSC [label="Abis/IP"]
72
  STP [label="STP\n(SCCP/M3UA)"]
73
  BSC -> STP -> MSC [label="A"]
74 70 neels
  MSC -> HLR [label="GSUP"]
75
  SGSN -> HLR [label="GSUP",style="dashed"]
76 62 neels
  UE -> hNodeB [label="Uu"]
77 65 neels
  UE -> hNodeB [style="dashed"]
78 56 neels
  hNodeB -> HNBGW [label="Iuh"]
79
  HNBGW -> STP -> MSC [label="IuCS"]
80 58 neels
  HNBGW -> STP -> SGSN [label="IuPS",style="dashed"]
81 61 neels
  PCU -> SGSN [label="Gb",style="dashed"]
82 58 neels
  SGSN -> GGSN [label="GTP-C",style="dashed"]
83
  SGSN -> GGSN [label="GTP-U(2G)",style="dashed"]
84
  hNodeB -> GGSN [label="GTP-U(3G)",style="dashed"]
85
  GGSN -> internet [label="tun",style="dashed"]
86 56 neels
87 73 neels
  BTS -> MGW2 -> MGW1 [label="RTP"]
88 59 neels
  MGW1 -> MGW1 [label="RTP"]
89 1 neels
  hNodeB -> MGW1 [label="IuUP/RTP"]
90 59 neels
91
  A, B, C, D [style="invisible"]
92 63 neels
  A -> B [label="data (PS)",style="dashed"]
93
  C -> D [label="voice (CS)"]
94 56 neels
95 55 neels
}
96
}}
97
98 5 neels
h1. Have to Know
99 10 neels
100
Each program features a detailed [[Osmocom Manuals|user manual]], your primary source of information to expand on the setup described here.
101 24 laforge
102 5 neels
Osmocom offers [[Binary_Packages|compiled packages for various distributions]]. If you're up to it, you may also [[Build from Source]].
103
104
Each Osmocom program typically has
105
106 1 neels
* a distinct configuration file;
107 25 neels
* a VTY telnet console for live interaction;
108 1 neels
* a CTRL interface for live interaction from 3rd party programs.
109 18 neels
110
See [[Port Numbers]] to find out which program runs VTY on which port.
111
112
h1. Configuration Examples
113 5 neels
114 83 neels
Here is a tarball of the config files discussed below: attachment:nitb.tar
115
116 6 neels
h2. OsmoHLR
117
118 93 neels
[[OsmoHLR:]] is the Home Location Register: it stores subscriber IMSI, phone number and auth tokens. This is where you configure who is allowed on your network and who has which phone number.
119 67 neels
120 72 neels
osmo-hlr will automatically bootstrap an empty subscriber database. See the [[Osmocom Manuals|manual]] on how to add one or more subscribers -- if you don't know your IMSI, it can be useful to attempt a connection and watch the OsmoHLR log for a rejected IMSI. To migrate subscribers from an older OsmoNITB database, see the [[OsmoNITB migration guide]].
121 6 neels
122 50 neels
While you do need one, your configuration file may actually remain empty. This will serve GSUP on localhost (127.0.0.1), sufficient for a Network In The Box with MSC and SGSN on the same machine as the HLR.
123 6 neels
124 48 neels
*osmo-hlr.cfg*
125
<pre>
126 71 neels
# empty, the defaults are sufficient
127 48 neels
</pre>
128
129 6 neels
h2. OsmoMSC
130 1 neels
131 93 neels
[[OsmoMSC:]] is the Mobile Switching Center: it handles signalling, i.e. attach/detach of subscribers, call establishment, messaging (SMS and USSD). The OsmoMSC is your central "manager" of the network.
132 66 neels
133 6 neels
The VLR component of OsmoMSC needs to connect to the OsmoHLR's GSUP server to know which subscribers are authorized. By default, it will connect to OsmoHLR on localhost, no explicit config needed.
134 26 neels
135 6 neels
To be reachable by OsmoBSC and OsmoHNBGW, OsmoMSC needs an SCCP point code, and it needs to connect to OsmoSTP to make itself known to SCCP routing.
136 7 neels
137 86 neels
* There is a default point code, currently 0.23.1 (in 8.8.3 point code format, see [[Point Codes]]).
138 6 neels
* OsmoMSC will by default look for OsmoSTP on localhost's M3UA port, 2905.
139 7 neels
140 51 neels
To direct RTP streams, OsmoMSC needs an OsmoMGW instance (see OsmoMGW below).
141 38 neels
142 51 neels
You only need to set up your MCC, MNC, and how to reach/use the MGW.
143 43 neels
144 49 neels
*osmo-msc.cfg*
145 1 neels
<pre>
146 38 neels
network
147
 network country code 901
148 53 neels
 mobile network code 70
149
msc
150 82 neels
 mgw remote-ip 192.168.0.9
151 45 neels
 mgw endpoint-range 1 32
152 38 neels
</pre>
153 47 neels
154 1 neels
h2. OsmoMGW
155
156 93 neels
[[OsmoMGW:]] is the Media Gateway: it is instructed by the MSC and/or the BSC to direct RTP streams for active voice calls. The Media Gateway receives instructions in the form of MGCP messages from OsmoMSC/OsmoBSC. It forwards RTP streams directly between BTS, femto cells and remote endpoints, e.g. other MGW instances, and its job is to transcode between codecs (future).
157 52 neels
158 47 neels
You need an OsmoMGW to serve OsmoMSC's MGCP requests, and an OsmoMGW to serve OsmoBSC's MGCP requests. In fact, these two can be served by one single OsmoMGW instance. If you would like to keep two separate OsmoMGW instances, you need to take care that they don't attempt to bind to identical ports on the same IP address (for MGCP, but also for VTY and CTRL interfaces).
159
160
Consider that you have a 2G network with an external BTS (say a sysmoBTS), which means that you need your OsmoBSC's MGW instance to be reachable on a public interface. So far the MSC's MGW can be on a local loopback interface, it only needs to be reachable by the BSC's MGW and by the MSC.
161
162
If you also have a 3G femto cell, then the MSC's MGW instance also needs to be on a public interface. At this point you either need two public interface addresses, or you need to put one of the MGWs on a different MGCP port.
163
164
If you use one OsmoMGW for both BSC and MSC, there are no port conflicts, but you need to take care that MSC and BSC use differing endpoint identifiers, or they will interfere with each others' RTP stream configurations.
165
166
To increase the likelihood that your first setup will work out, below examples pick distinct endpoint ranges so that MSC and BSC could use the same MGW instance, while at the same time provide config files that allow running two MGWs on the same public IP address.
167
168
h3. OsmoMGW for OsmoMSC
169 1 neels
170 9 neels
*NOTE: Currently, OsmoMSC still requires the legacy osmo-bsc_mgcp program, which will move to the new osmo-mgw soon. osmo-bsc_mgcp is still available from osmo-mgw.git. For osmo-bsc_mgcp, you can use the identical config as shown for the MSC's MGW here.*
171 47 neels
172 1 neels
* In a setup that truly runs in one box (e.g. sysmoBTS or osmo-trx with co-located core network), this may be localhost (127.0.0.1), which is the default, and your config file may omit the 'bind ip'.
173 9 neels
* With a separate BTS and/or RNC (e.g. 3G femto cell or nanoBTS), make sure to configure an IP address that is reachable by the hNodeB and BTS:
174 1 neels
175
*osmo-mgw-for-msc.cfg*
176 9 neels
<pre>
177 48 neels
mgcp
178 82 neels
 bind ip 192.168.0.9
179 40 neels
 number endpoints 64
180 82 neels
line vty
181
 bind 127.0.0.1
182 1 neels
</pre>
183
184 47 neels
h3. OsmoMGW for OsmoBSC
185 1 neels
186
OsmoBSC also requires an OsmoMGW instance to run alongside it. In a setup where OsmoBSC and OsmoMGW run on the same box, they may in fact share the same OsmoMGW instance, as long as BSC and MSC use different endpoint identifiers.
187
188 47 neels
It is semantically more clear to run a separate OsmoMGW instance for the OsmoBSC, which then needs to not interfere with the other MGW's ports, for example:
189 1 neels
190
*osmo-mgw-for-bsc.cfg*
191
<pre>
192 40 neels
mgcp
193 82 neels
 bind ip 192.168.0.9
194
 # default port is 2427 (is used for MSC's MGW)
195 47 neels
 bind port 12427
196
 number endpoints 64
197 41 neels
line vty
198 82 neels
 # default VTY interface is on 127.0.0.1 (used for MSC's MGW)
199 41 neels
 bind 127.0.0.2
200 40 neels
</pre>
201
202 9 neels
Note that osmo-bsc.cfg below sets the 'mgw remote-port' to the 'bind port' configured here (the method to run two MGW on the same public IP address), and picks a different 'mgw endpoint' range than the OsmoMSC (the method to use the same MGW for both BSC and MSC) -- these are two separate, redundant measures, and you usually would pick only one of them.
203 1 neels
204 9 neels
h2. OsmoSTP
205
206 93 neels
[[OsmoSTP:]] is the Signal Transfer Point: it acts as a server for routing SCCP messages. OsmoMSC, OsmoBSC, OsmoHNBGW and OsmoSGSN contact OsmoSTP and announce their own point code, after which they may instruct OsmoSTP to route SCCP messages to each other by these point codes.
207 9 neels
208
The basic configuration that permits dynamic routing is:
209
210
*osmo-stp.cfg*
211
<pre>
212
cs7 instance 0
213
 xua rkm routing-key-allocation dynamic-permitted
214
 listen m3ua 2905
215 11 neels
  accept-asp-connections dynamic-permitted
216
</pre>
217 1 neels
218
h2. OsmoBSC
219 11 neels
220 93 neels
[[OsmoBSC:]] is the 2G Base Station Controller: it manages logical channels and other lower level aspects for one or more 2G BTS. The BSC tells the MSC what the phones would like to do, and in turn the MSC tells the BSC to establish channels, page phones, and take care of the lower level BTS maintenance.
221 67 neels
222 87 neels
OsmoBSC needs to register with OsmoSTP, and contact the MSC by its point code. If not configured otherwise, it will use OsmoMSC's default point code to contact it, see [[Point Codes]].
223 11 neels
224 48 neels
OsmoBSC needs to contact an OsmoMGW to direct RTP streams between BTS and the MSC's MGW, as discussed above under "OsmoMGW".
225 42 neels
226 11 neels
OsmoBSC also needs complete configuration of all connected BTS. This example shows configuration for a sysmoBTS.
227 15 neels
228
Furthermore, some network properties need to be set.
229 1 neels
230 83 neels
The 'gprs mode' determines whether packet switched access will be enabled. 'gprs mode none' switches off data services, it tells osmo-bts not to contact osmo-pcu to establish data service.
231 15 neels
232 83 neels
To allow data service, set a 'gprs mode gprs' or 'gprs mode egprs', and configure PDCH timeslots. Traditionally, a fixed amount of TCH timeslots for voice and PDCH timeslots for data service are configured. OsmoBTS also supports two types of dynamic timeslots, as described in the "Abis manual":http://ftp.osmocom.org/docs/latest/osmobts-abis.pdf, chapter "Dynamic Channel Combinations". The following is a configuration with voice-and-data service based on Osmocom style dynamic timeslots:
233 15 neels
234 43 neels
*osmo-bsc.cfg* for voice and data service
235 48 neels
<pre>
236 75 neels
network
237
 network country code 901
238 1 neels
 mobile network code 70
239 75 neels
 bts 0
240
  type sysmobts
241
  band GSM-1800
242
  location_area_code 23
243
  ip.access unit_id 1800 0
244
  gprs mode gprs
245 82 neels
  gprs nsvc 0 remote ip 192.168.0.9
246 75 neels
  gprs nsvc 0 remote udp port 23000
247
  gprs nsvc 0 local udp port 23000
248
  gprs nsvc 0 nsvci 1800
249
  gprs nsei 1800
250
  gprs cell bvci 1800
251
  trx 0
252
   rf_locked 0
253
   arfcn 868
254
   nominal power 23
255
   timeslot 0
256
    phys_chan_config CCCH+SDCCH4
257
   timeslot 1
258
    phys_chan_config SDCCH8
259
   timeslot 2
260
    phys_chan_config TCH/F_TCH/H_PDCH
261
   timeslot 3
262 1 neels
    phys_chan_config TCH/F_TCH/H_PDCH
263 75 neels
   timeslot 4
264
    phys_chan_config TCH/F_TCH/H_PDCH
265
   timeslot 5
266
    phys_chan_config TCH/F_TCH/H_PDCH
267
   timeslot 6
268
    phys_chan_config TCH/F_TCH/H_PDCH
269
   timeslot 7
270
    phys_chan_config PDCH
271
e1_input
272 1 neels
 e1_line 0 driver ipa
273 75 neels
msc 0
274 82 neels
 mgw remote-ip 192.168.0.9
275 75 neels
 mgw remote-port 12427
276
 mgw endpoint-range 33 64
277 1 neels
 allow-emergency deny
278
 codec-list hr3
279
</pre>
280
281
h2. OsmoHNBGW
282
283 93 neels
[[OsmoHNBGW:]] is the 3G HomeNodeB Gateway, found in the osmo-iuh.git repository: it receives the Iuh protocol from a 3G femto cell, separates it into IuCS and IuPS and forwards to the MSC and SGSN.
284 1 neels
285 89 neels
OsmoHNBGW needs to connect to OsmoSTP for routing, and needs to know the MSC and SGSN point codes. If omitted, it assumes OsmoSTP on 127.0.0.1 and uses the point codes that are default in OsmoMSC and OsmoSGSN, see [[Point Codes]].
286 1 neels
287
It must also be reachable by the hNodeB, hence its Iuh must typically run on a public IP, not a loopback address like 127.0.0.1.
288
289 16 neels
*osmo-hnbgw.cfg*
290 1 neels
<pre>
291 82 neels
hnbgw
292
 iuh
293
  local-ip 192.168.0.9
294
</pre>
295
296 95 neels
*NOTE:* this minimal config is not yet possible in the "latest" packages, only in the nightly packages (20170-12-29, http://git.osmocom.org/osmo-iuh/commit/?id=2af648f443257284d994ea6d79d9554ed866dfa6 )
297
298 1 neels
h2. OsmoGGSN
299
300 93 neels
[[OpenGGSN:|OsmoGGSN]] is the Gateway GPRS Support Node: it "opens" GTP tunnels received from SGSNs to internet uplink. To provide packet switched service, OsmoGGSN must offer GTP service to the OsmoSGSN.
301 1 neels
302 82 neels
Notably, both OsmoGGSN and OsmoSGSN must use identical port numbers, which is an intrinsic requirement of the GTP protocol. Hence they must not run on the same IP address. Furthermore, for 2G networks, the SGSN must be reachable by the PCU and thus needs to be on a public interface if the BTS is a separate box; for 3G networks, the GGSN must be reachable by the hNodeB and thus needs to be on a public interface. So, to cover both, you need to have *two* public interfaces; this example uses 192.168.0.42, made available by
303 12 neels
304 82 neels
<pre>
305
sudo ip addr add 192.168.0.42/32 dev eth0
306
</pre>
307
308
This is of course blatantly ignoring the local DHCP server's authority, just a quick hack.
309
310 1 neels
OsmoGGSN maintains a gsn_restart counter, to be able to reliably communicate to the SGSN that it has restarted. This is kept in the 'state-dir', by default in /tmp.
311 13 neels
312 82 neels
It also needs access to a tun device with an address range available to subscribers' PDP contexts. This may be configured ahead of time, so that OsmoGGSN does not need root privileges. If run with 'sudo', OsmoGGSN may also create its own tun device. In below example, the 'apn0' device has been created ahead of time, with:
313 13 neels
314 82 neels
<pre>
315
sudo ip tuntap add dev apn0 mode tun user $USER group $USER
316
sudo ip addr add 192.168.42.0/24 dev apn0
317
sudo ip link set apn0 up
318
</pre>
319
320
IPv4 operation is enabled by default, but for future compatibility, it is good to indicate that explicitly.
321
322 76 neels
OsmoGGSN furthermore indicates DNS servers, as well as an IPv4 address range to assign to subscribers' PDP contexts.
323 13 neels
324 85 neels
Note that the APN named in this config file (here "internet") needs to be configured on your phone, see [[Osmocom Network In The Box#APN-for-Data-Service|APN for Data Service]] below. With the @default-apn@ command, any unknown APN name will use that default APN instead, but still you usually have to define _some_ APN on your phone so that it even tries to connect to the data service.
325 13 neels
326 85 neels
A profound part of GGSN configuration is the network setup of your system: you need to allow the packets to be routed between the subscribers and your internet uplink. See the [[Osmocom Manuals|OsmoGGSN User Manual]], section _Running OsmoGGSN_ / _Routing_.
327 84 neels
328 13 neels
*osmo-ggsn.cfg*
329
NOTE: this configuration requires running osmo-ggsn with root privileges, as well as IP-forwarding and masquerading to be enabled
330
<pre>
331
ggsn ggsn0
332 82 neels
 gtp bind-ip 192.168.0.42
333 76 neels
 apn internet
334 82 neels
  tun-device apn0
335 1 neels
  type-support v4
336
  ip dns 0 192.168.0.1
337 76 neels
  ip dns 1 8.8.8.8
338
  ip prefix dynamic 192.168.42.0/24
339 82 neels
  no shutdown
340
 default-apn internet
341 14 neels
 no shutdown ggsn
342
</pre>
343 67 neels
344
h2. OsmoSGSN
345 14 neels
346 93 neels
[[OsmoSGSN:]] is the Serving GPRS Support Node: it handles signalling, i.e. attach/detach of subscribers and PDP contexts for data services.
347 14 neels
348
OsmoSGSN needs to reach the GGSN to establish GTP tunnels for subscribers. It must have a separate GTP IP address from OsmoGGSN, as mentioned before.
349
350
For 2G, OsmoSGSN needs to be reachable by the PCU, and needs a public IP for the Gb interface if it is not running directly on the BTS hardware (e.g. on sysmoBTS or when using osmo-trx). For 2G operation, SGSN and GGSN may both use a local IP address for GTP, as long as they differ (e.g. 127.0.0.1 and 127.0.0.2).
351
352 88 neels
For 3G, OsmoSGSN needs to be reachable by both the HNBGW for IuPS as well as by the hNodeB for GTP, i.e. it definitely needs to have a public IP address for the GTP port.
353
354
For 3G IuPS, the SGSN must sign up at OsmoSTP with a point code that the HNBGW knows. If not configured explicitly, the respective defaults are used, see [[Point Codes]].
355 14 neels
356 1 neels
Finally, OsmoSGSN needs access to OsmoHLR to access subscriber data. Set 'auth-policy remote' to use the HLR for subscriber authorization. The default 
357
358
*osmo-sgsn.cfg*
359 14 neels
<pre>
360 77 neels
sgsn
361 82 neels
 gtp local-ip 192.168.0.9
362
 ggsn 0 remote-ip 192.168.0.42
363 79 neels
 ggsn 0 gtp-version 1
364 14 neels
 auth-policy remote
365 1 neels
 gsup remote-ip 127.0.0.1
366
ns
367
 encapsulation udp local-ip 192.168.0.9
368
 encapsulation udp local-port 23000
369
 encapsulation framerelay-gre enabled 0
370
</pre>
371
372
The @auth-policy remote@ requires that you have the SIM cards' authentication tokens in your OsmoHLR database. Instead, you can use @auth-policy accept-all@, but be aware that this will only work for 2G. 3G networks _require_ successful authentication, and @auth-policy remote@ is your _only_ option for a 3G SGSN.
373 93 neels
374
h1. OsmoBTS
375
376
[[OsmoBTS:]] operates 2G radio hardware. OsmoBTS supports various hardware platforms including sysmoBTS and USRP. Instead, you may choose BTS vendors like ip.access or Siemens, which can also directly operate with OsmoBSC without OsmoBTS being involved.
377
378
The BTS needs to know where to reach OsmoBSC's Abis interface, and its unit id needs to match one of the BTS unit ids configured at OsmoBSC.
379
380
An example configuration for a sysmoBTS is:
381
382
<pre>
383
phy 0
384
 instance 0
385
bts 0
386
 band 1800
387
 ipa unit-id 1800 0
388
 oml remote-ip 192.168.0.9
389
 trx 0
390
  phy 0 instance 0
391
</pre>
392
393
h1. OsmoPCU
394
395
[[OsmoPCU:]] operates the packet-switched part of 2G radio hardware. Timeslots used for data transmission are controlled by the PCU instead of the BTS. OsmoPCU is typically configured from the @gprs@ config items in OsmoBSC, which is communicated to the PCU via OML and OsmoBTS (via the PCU socket). An example configuration for OsmoPCU would be:
396
397
<pre>
398
pcu
399
 flow-control-interval 10
400
 cs 2
401
 alloc-algorithm dynamic
402
 alpha 0
403
 gamma 0
404
 two-phase-access
405
</pre>
406 17 neels
407
h1. Running Examples
408
409
Each Osmocom program comes with a systemd service file. It is recommended to place config files in /etc/osmocom/ and launch the individual components using systemd.
410
411
When installed from debian or opkg feeds, you will find the systemd service files in /lib/systemd/system/.
412
413
Re/starting and stopping then works like this:
414
415
<pre>
416 1 neels
systemctl restart osmo-hlr
417
systemctl stop osmo-hlr
418
</pre>
419 36 neels
420
It can be useful to have an @osmo-all@ script to re/start or stop all components at once, edit to pick yours:
421
422
*osmo-all* script
423
<pre>
424
#!/bin/sh
425
cmd="${1:-start}"
426
set -ex
427
systemctl $cmd osmo-hlr osmo-msc osmo-mgw osmo-ggsn osmo-sgsn osmo-stp osmo-bsc osmo-hnbgw osmo-bts-sysmo osmo-pcu 
428
</pre>
429
430
which allows
431
432
<pre>
433 1 neels
./osmo-all restart
434
./osmo-all status
435 36 neels
./osmo-all stop
436
</pre>
437
438 1 neels
For illustration, the manual command invocations for the components would look like this:
439
440
<pre>
441
osmo-hlr -l hlr.db -c osmo-hlr.cfg
442
osmo-msc -c osmo-msc.cfg
443
osmo-mgw -c osmo-mgw-for-msc.cfg
444
osmo-mgw -c osmo-mgw-for-bsc.cfg
445 48 neels
osmo-ggsn -c osmo-ggsn.cfg
446
osmo-sgsn -c osmo-sgsn.cfg
447 36 neels
osmo-stp -c osmo-stp.cfg
448 1 neels
osmo-bsc -c osmo-bsc.cfg
449
osmo-hnbgw -c osmo-hnbgw.cfg
450
# on a 2G sysmoBTS:
451 36 neels
osmo-bts-sysmo -c osmo-bts.cfg -s -M
452
osmo-pcu -c osmo-pcu.cfg
453
</pre>
454 18 neels
455
h1. Logging Examples
456
457
Osmocom programs have a common logging mechanism, configurable by the config files as well as the telnet VTY.
458
459 82 neels
h2. System Logging
460
461 18 neels
Depending on the system's logging configuration, logs may by default be visible in /var/log/daemon.log, or by using journalctl:
462
463 1 neels
<pre>
464
journalctl -f -u osmo-hlr
465
</pre>
466
467
When journalctl is used, it may be necessary to enable it first, e.g. by setting "Storage=volatile" in /etc/systemd/journald.conf followed by a 'systemctl restart systemd-journald'; you may also need to 'systemctl unmask systemd-journald.service systemd-jounald.socket'. Logging will only start appearing for components that were restarted after these changes.
468
469 82 neels
h2. telnet VTY logging
470
471 1 neels
A sure way to see the logs is to connect to the program's telnet VTY and enable logging on the VTY session -- this way you do not modify the application's default logging, but create a separate logging target for your telnet VTY session:
472
473
<pre>
474
$ telnet localhost 4254
475
OsmoMSC> logging enable 
476
OsmoMSC> logging level ?
477
  all      Global setting for all subsystems
478
  rll      A-bis Radio Link Layer (RLL)
479 18 neels
  cc       Layer3 Call Control (CC)
480
  mm       Layer3 Mobility Management (MM)
481
  [...]
482 35 neels
OsmoMSC> logging level all ?
483 19 neels
everything debug      info       notice     error      fatal      
484
OsmoMSC> logging level all debug 
485
OsmoMSC> logging filter all 1
486 1 neels
</pre>
487
488
You will see logging output on your telnet console immediately. Note that the VTY prompt is still listening, so you may at any time issue 'logging filter all 0' to switch off logging, and be able to type commands without being cluttered by ongoing log output.
489
490
h2. stderr logging
491
492
A common configuration you can add to any of the above configuration files to show *all* logging on stderr is:
493
494
<pre>
495
log stderr
496
 logging filter all 1
497
 logging color 1
498
 logging print category 1
499
 logging timestamp 1
500
 logging print extended-timestamp 1
501
 logging level all debug
502
</pre>
503
504
The @filter all 1@ switches on logging, read "do not discard all logging". The amount of logging seen is determined by @logging level ...@ commands, here all categories are set to level @debug@, to show absolutely all logging. You will probably want to refine that.
505 90 neels
506
h1. Point Codes
507
508
If you'd like to configure non-default point-codes, see this example for OsmoHNBGW on the general approach:
509
510
<pre>
511
cs7 instance 0
512
 # HNBGW's local point code
513
 point-code 0.23.5
514
 # Address book entries, used below
515
 sccp-address my_msc
516
  point-code 0.23.1
517
 sccp-address my_sgsn
518
  point-code 0.23.4
519
hnbgw
520
 iucs
521
  remote-addr my_msc
522
 iups
523
  remote-addr my_sgsn
524
</pre>
525 76 neels
526
h1. Troubleshooting
527
528
h2. APN for Data Service
529
530
For the data service to work, phones generally need an APN added to their
531
configuration, or they will not even attempt to establish a data connection.
532
The APN should match the name configured in osmo-ggsn.conf.
533
534
The APN configuration steps are usually similar to:
535
536
* Navigate to APN settings:
537
** 'Settings'
538
** 'Wireless & Networks'
539
** 'Mobile networks'
540
** 'Access Point Names'
541
* You should see the list of APNs (possibly empty)
542
* Press the Menu button
543
* Choose 'New APN'
544
* Enter values for 'Name' as well as 'APN'
545
* Again press the Menu button
546
* Choose 'Save'
547
* The APN should now appear in the list of APNs.
548 1 neels
* Possibly tap the bullet icon to select the APN as default.
Add picture from clipboard (Maximum size: 48.8 MB)