Project

General

Profile

Osmocom Network In The Box » History » Version 97

neels, 12/29/2017 11:25 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 97 neels
Once your HLR is running, you will want to add subscribers with authentication keys to the HLR database. Please refer to the OsmoHLR [[Osmocom Manuals]], section "Managing Subscribers".
130
131 6 neels
h2. OsmoMSC
132 1 neels
133 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.
134 66 neels
135 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.
136 26 neels
137 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.
138 7 neels
139 86 neels
* There is a default point code, currently 0.23.1 (in 8.8.3 point code format, see [[Point Codes]]).
140 6 neels
* OsmoMSC will by default look for OsmoSTP on localhost's M3UA port, 2905.
141 7 neels
142 51 neels
To direct RTP streams, OsmoMSC needs an OsmoMGW instance (see OsmoMGW below).
143 38 neels
144 51 neels
You only need to set up your MCC, MNC, and how to reach/use the MGW.
145 43 neels
146 49 neels
*osmo-msc.cfg*
147 1 neels
<pre>
148 38 neels
network
149
 network country code 901
150 53 neels
 mobile network code 70
151
msc
152 82 neels
 mgw remote-ip 192.168.0.9
153 45 neels
 mgw endpoint-range 1 32
154 38 neels
</pre>
155 47 neels
156 1 neels
h2. OsmoMGW
157
158 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).
159 52 neels
160 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).
161
162
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.
163
164
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.
165
166
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.
167
168
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.
169
170
h3. OsmoMGW for OsmoMSC
171 1 neels
172 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.*
173 47 neels
174 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'.
175 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:
176 1 neels
177
*osmo-mgw-for-msc.cfg*
178 9 neels
<pre>
179 48 neels
mgcp
180 82 neels
 bind ip 192.168.0.9
181 40 neels
 number endpoints 64
182 82 neels
line vty
183
 bind 127.0.0.1
184 1 neels
</pre>
185
186 47 neels
h3. OsmoMGW for OsmoBSC
187 1 neels
188
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.
189
190 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:
191 1 neels
192
*osmo-mgw-for-bsc.cfg*
193
<pre>
194 40 neels
mgcp
195 82 neels
 bind ip 192.168.0.9
196
 # default port is 2427 (is used for MSC's MGW)
197 47 neels
 bind port 12427
198
 number endpoints 64
199 41 neels
line vty
200 82 neels
 # default VTY interface is on 127.0.0.1 (used for MSC's MGW)
201 41 neels
 bind 127.0.0.2
202 40 neels
</pre>
203
204 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.
205 1 neels
206 9 neels
h2. OsmoSTP
207
208 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.
209 9 neels
210
The basic configuration that permits dynamic routing is:
211
212
*osmo-stp.cfg*
213
<pre>
214
cs7 instance 0
215
 xua rkm routing-key-allocation dynamic-permitted
216
 listen m3ua 2905
217 11 neels
  accept-asp-connections dynamic-permitted
218
</pre>
219 1 neels
220
h2. OsmoBSC
221 11 neels
222 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.
223 67 neels
224 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]].
225 11 neels
226 48 neels
OsmoBSC needs to contact an OsmoMGW to direct RTP streams between BTS and the MSC's MGW, as discussed above under "OsmoMGW".
227 42 neels
228 11 neels
OsmoBSC also needs complete configuration of all connected BTS. This example shows configuration for a sysmoBTS.
229 15 neels
230
Furthermore, some network properties need to be set.
231 1 neels
232 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.
233 15 neels
234 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:
235 15 neels
236 43 neels
*osmo-bsc.cfg* for voice and data service
237 48 neels
<pre>
238 75 neels
network
239
 network country code 901
240 1 neels
 mobile network code 70
241 75 neels
 bts 0
242
  type sysmobts
243
  band GSM-1800
244
  location_area_code 23
245
  ip.access unit_id 1800 0
246
  gprs mode gprs
247 82 neels
  gprs nsvc 0 remote ip 192.168.0.9
248 75 neels
  gprs nsvc 0 remote udp port 23000
249
  gprs nsvc 0 local udp port 23000
250
  gprs nsvc 0 nsvci 1800
251
  gprs nsei 1800
252
  gprs cell bvci 1800
253
  trx 0
254
   rf_locked 0
255
   arfcn 868
256
   nominal power 23
257
   timeslot 0
258
    phys_chan_config CCCH+SDCCH4
259
   timeslot 1
260
    phys_chan_config SDCCH8
261
   timeslot 2
262
    phys_chan_config TCH/F_TCH/H_PDCH
263
   timeslot 3
264 1 neels
    phys_chan_config TCH/F_TCH/H_PDCH
265 75 neels
   timeslot 4
266
    phys_chan_config TCH/F_TCH/H_PDCH
267
   timeslot 5
268
    phys_chan_config TCH/F_TCH/H_PDCH
269
   timeslot 6
270
    phys_chan_config TCH/F_TCH/H_PDCH
271
   timeslot 7
272
    phys_chan_config PDCH
273
e1_input
274 1 neels
 e1_line 0 driver ipa
275 75 neels
msc 0
276 82 neels
 mgw remote-ip 192.168.0.9
277 75 neels
 mgw remote-port 12427
278
 mgw endpoint-range 33 64
279 1 neels
 allow-emergency deny
280
 codec-list hr3
281
</pre>
282
283
h2. OsmoHNBGW
284
285 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.
286 1 neels
287 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]].
288 1 neels
289
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.
290
291 16 neels
*osmo-hnbgw.cfg*
292 1 neels
<pre>
293 82 neels
hnbgw
294
 iuh
295
  local-ip 192.168.0.9
296
</pre>
297
298 96 neels
*NOTE:* To connect your femto cell to the HNBGW, see for example [[Configuring_the_ipaccess_nano3G]]
299
300 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 )
301 96 neels
302
303 95 neels
304 1 neels
h2. OsmoGGSN
305
306 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.
307 1 neels
308 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
309 12 neels
310 82 neels
<pre>
311
sudo ip addr add 192.168.0.42/32 dev eth0
312
</pre>
313
314
This is of course blatantly ignoring the local DHCP server's authority, just a quick hack.
315
316 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.
317 13 neels
318 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:
319 13 neels
320 82 neels
<pre>
321
sudo ip tuntap add dev apn0 mode tun user $USER group $USER
322
sudo ip addr add 192.168.42.0/24 dev apn0
323
sudo ip link set apn0 up
324
</pre>
325
326
IPv4 operation is enabled by default, but for future compatibility, it is good to indicate that explicitly.
327
328 76 neels
OsmoGGSN furthermore indicates DNS servers, as well as an IPv4 address range to assign to subscribers' PDP contexts.
329 13 neels
330 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.
331 13 neels
332 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_.
333 84 neels
334 13 neels
*osmo-ggsn.cfg*
335
NOTE: this configuration requires running osmo-ggsn with root privileges, as well as IP-forwarding and masquerading to be enabled
336
<pre>
337
ggsn ggsn0
338 82 neels
 gtp bind-ip 192.168.0.42
339 76 neels
 apn internet
340 82 neels
  tun-device apn0
341 1 neels
  type-support v4
342
  ip dns 0 192.168.0.1
343 76 neels
  ip dns 1 8.8.8.8
344
  ip prefix dynamic 192.168.42.0/24
345 82 neels
  no shutdown
346
 default-apn internet
347 14 neels
 no shutdown ggsn
348
</pre>
349 67 neels
350
h2. OsmoSGSN
351 14 neels
352 93 neels
[[OsmoSGSN:]] is the Serving GPRS Support Node: it handles signalling, i.e. attach/detach of subscribers and PDP contexts for data services.
353 14 neels
354
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.
355
356
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).
357
358 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.
359
360
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]].
361 14 neels
362 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 
363
364
*osmo-sgsn.cfg*
365 14 neels
<pre>
366 77 neels
sgsn
367 82 neels
 gtp local-ip 192.168.0.9
368
 ggsn 0 remote-ip 192.168.0.42
369 79 neels
 ggsn 0 gtp-version 1
370 14 neels
 auth-policy remote
371 1 neels
 gsup remote-ip 127.0.0.1
372
ns
373
 encapsulation udp local-ip 192.168.0.9
374
 encapsulation udp local-port 23000
375
 encapsulation framerelay-gre enabled 0
376
</pre>
377
378
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.
379 93 neels
380
h1. OsmoBTS
381
382
[[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.
383
384
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.
385
386
An example configuration for a sysmoBTS is:
387
388
<pre>
389
phy 0
390
 instance 0
391
bts 0
392
 band 1800
393
 ipa unit-id 1800 0
394
 oml remote-ip 192.168.0.9
395
 trx 0
396
  phy 0 instance 0
397
</pre>
398
399
h1. OsmoPCU
400
401
[[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:
402
403
<pre>
404
pcu
405
 flow-control-interval 10
406
 cs 2
407
 alloc-algorithm dynamic
408
 alpha 0
409
 gamma 0
410
 two-phase-access
411
</pre>
412 17 neels
413
h1. Running Examples
414
415
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.
416
417
When installed from debian or opkg feeds, you will find the systemd service files in /lib/systemd/system/.
418
419
Re/starting and stopping then works like this:
420
421
<pre>
422 1 neels
systemctl restart osmo-hlr
423
systemctl stop osmo-hlr
424
</pre>
425 36 neels
426
It can be useful to have an @osmo-all@ script to re/start or stop all components at once, edit to pick yours:
427
428
*osmo-all* script
429
<pre>
430
#!/bin/sh
431
cmd="${1:-start}"
432
set -ex
433
systemctl $cmd osmo-hlr osmo-msc osmo-mgw osmo-ggsn osmo-sgsn osmo-stp osmo-bsc osmo-hnbgw osmo-bts-sysmo osmo-pcu 
434
</pre>
435
436
which allows
437
438
<pre>
439 1 neels
./osmo-all restart
440
./osmo-all status
441 36 neels
./osmo-all stop
442
</pre>
443
444 1 neels
For illustration, the manual command invocations for the components would look like this:
445
446
<pre>
447
osmo-hlr -l hlr.db -c osmo-hlr.cfg
448
osmo-msc -c osmo-msc.cfg
449
osmo-mgw -c osmo-mgw-for-msc.cfg
450
osmo-mgw -c osmo-mgw-for-bsc.cfg
451 48 neels
osmo-ggsn -c osmo-ggsn.cfg
452
osmo-sgsn -c osmo-sgsn.cfg
453 36 neels
osmo-stp -c osmo-stp.cfg
454 1 neels
osmo-bsc -c osmo-bsc.cfg
455
osmo-hnbgw -c osmo-hnbgw.cfg
456
# on a 2G sysmoBTS:
457 36 neels
osmo-bts-sysmo -c osmo-bts.cfg -s -M
458
osmo-pcu -c osmo-pcu.cfg
459
</pre>
460 18 neels
461
h1. Logging Examples
462
463
Osmocom programs have a common logging mechanism, configurable by the config files as well as the telnet VTY.
464
465 82 neels
h2. System Logging
466
467 18 neels
Depending on the system's logging configuration, logs may by default be visible in /var/log/daemon.log, or by using journalctl:
468
469 1 neels
<pre>
470
journalctl -f -u osmo-hlr
471
</pre>
472
473
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.
474
475 82 neels
h2. telnet VTY logging
476
477 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:
478
479
<pre>
480
$ telnet localhost 4254
481
OsmoMSC> logging enable 
482
OsmoMSC> logging level ?
483
  all      Global setting for all subsystems
484
  rll      A-bis Radio Link Layer (RLL)
485 18 neels
  cc       Layer3 Call Control (CC)
486
  mm       Layer3 Mobility Management (MM)
487
  [...]
488 35 neels
OsmoMSC> logging level all ?
489 19 neels
everything debug      info       notice     error      fatal      
490
OsmoMSC> logging level all debug 
491
OsmoMSC> logging filter all 1
492 1 neels
</pre>
493
494
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.
495
496
h2. stderr logging
497
498
A common configuration you can add to any of the above configuration files to show *all* logging on stderr is:
499
500
<pre>
501
log stderr
502
 logging filter all 1
503
 logging color 1
504
 logging print category 1
505
 logging timestamp 1
506
 logging print extended-timestamp 1
507
 logging level all debug
508
</pre>
509
510
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.
511 90 neels
512
h1. Point Codes
513
514
If you'd like to configure non-default point-codes, see this example for OsmoHNBGW on the general approach:
515
516
<pre>
517
cs7 instance 0
518
 # HNBGW's local point code
519
 point-code 0.23.5
520
 # Address book entries, used below
521
 sccp-address my_msc
522
  point-code 0.23.1
523
 sccp-address my_sgsn
524
  point-code 0.23.4
525
hnbgw
526
 iucs
527
  remote-addr my_msc
528
 iups
529
  remote-addr my_sgsn
530
</pre>
531 76 neels
532
h1. Troubleshooting
533
534
h2. APN for Data Service
535
536
For the data service to work, phones generally need an APN added to their
537
configuration, or they will not even attempt to establish a data connection.
538
The APN should match the name configured in osmo-ggsn.conf.
539
540
The APN configuration steps are usually similar to:
541
542
* Navigate to APN settings:
543
** 'Settings'
544
** 'Wireless & Networks'
545
** 'Mobile networks'
546
** 'Access Point Names'
547
* You should see the list of APNs (possibly empty)
548
* Press the Menu button
549
* Choose 'New APN'
550
* Enter values for 'Name' as well as 'APN'
551
* Again press the Menu button
552
* Choose 'Save'
553
* The APN should now appear in the list of APNs.
554 1 neels
* Possibly tap the bullet icon to select the APN as default.
Add picture from clipboard (Maximum size: 48.8 MB)