Osmocom Network In The Box¶

OsmoNITB R.I.P., long live the Network In The Box¶

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.

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.

To migrate from OsmoNITB to the new separate programs, see the OsmoNITB Migration Guide.

Part of this Complete Network¶

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") and data ("packet-switched") services.

Circuit-Switched Components¶

To run a circuit-switched core network, you need:

• OsmoHLR -- Home Location Register, stores subscriber IMSI, phone number and auth tokens.
• OsmoMSC -- Mobile Switching Center, handles signalling, i.e. attach/detach of subscribers, call establishment, messaging (SMS and USSD).
• OsmoSTP -- Signal Transfer Point, routes SCCP messages between MSC, BSC, HNBGW and for 3G also the SGSN.
• OsmoMGW -- Media Gateway, is instructed by the MSC and/or the BSC to direct RTP streams for active voice calls.
• 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".
• OsmoHNBGW -- 3G HomeNodeB Gateway, receives the Iuh protocol from a 3G femto cell and forwards to MSC and SGSN by SCCP/M3UA via OsmoSTP.

Packet-Switched Components¶

• OsmoGGSN -- Gateway GPRS Support Node, "opens" GTP tunnels received from SGSNs to internet uplink.
• OsmoSGSN -- Serving GPRS Support Node, handles signalling, i.e. attach/detach of subscribers and PDP contexts.
• OsmoHLR -- same as for circuit switched, see above.
• OsmoHNBGW -- for 3G packet switched networks, same as for 3G circuit switched, see above.
• (OsmoPCU -- for 2G networks, a component closely tied to the BTS, drives the TRX and ties to the SGSN via Gb-interface.)

Configuration Example¶

Have to Know¶

Each program features a detailed user manual.
Osmocom offers compiled packages for various distributions.
If you're up to it, you may also Build from Source.

Each Osmocom program typically has

• a distinct configuration file;
• a VTY telnet console for live interaction;
• a CTRL interface for live interaction with 3rd party programs.

OsmoHLR¶

See the manual on creating a subscriber database, and add one or more subscribers.

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.

OsmoMSC¶

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.

To be reachable by OsmoBSC and OsmoHNBGW, it needs an SCCP point code, and it needs to connect to OsmoSTP to make itself known to SCCP routing.

• There is a default point code, currently 0.23.1 (in 8.8.3 point code format).
• OsmoMSC will by default look for OsmoSTP on localhost's M3UA port, 2905.

To direct RTP streams, OsmoMSC needs an OsmoMGW instance. By default, it will look for an MGW on localhost and the default MGCP port, 4222.

Again, your config file may remain empty.