blob: 57b8231bbe63f95b2d7296c70874d617a900a8ea [file] [log] [blame]
Harald Welte6d839f52019-12-01 14:19:54 +01001== Running OsmoHNBGW
2
3The OsmoHNBGW executable (`osmo-hnbgw`) offers the following command-line
4arguments:
5
6=== SYNOPSIS
7
8*osmo-hnbgw* [-h|-V] [-d 'DBGMASK'] [-D] [-c 'CONFIGFILE'] [-s] [-T] [-e 'LOGLEVEL']
9
10=== OPTIONS
11
12*-h, --help*::
13 Print a short help message about the supported options
14*-V, --version*::
15 Print the compile-time version number of the OsmoHNBGW program
16*-d, --debug 'DBGMASK','DBGLEVELS'*::
17 Set the log subsystems and levels for logging to stderr. This
18 has mostly been superseded by VTY-based logging configuration,
19 see <<logging>> for further information.
20*-D, --daemonize*::
21 Fork the process as a daemon into background.
22*-c, --config-file 'CONFIGFILE'*::
23 Specify the file and path name of the configuration file to be
24 used. If none is specified, use `osmo-msc.cfg` in the current
25 working directory.
26*-s, --disable-color*::
27 Disable colors for logging to stderr. This has mostly been
28 deprecated by VTY based logging configuration, see <<logging>>
29 for more information.
30*-T, --timestamp*::
31 Enable time-stamping of log messages to stderr. This has mostly
32 been deprecated by VTY based logging configuration, see
33 <<logging>> for more information.
34*-e, --log-level 'LOGLEVEL'*::
35 Set the global log level for logging to stderr. This has mostly
36 been deprecated by VTY based logging configuration, see
37 <<logging>> for more information.
Neels Hofmeyr50865f82020-03-18 01:25:42 +010038
39
40=== Multiple instances
41
42Running multiple instances of `osmo-hnbgw` on the same computer is possible if
43all interfaces (VTY, CTRL, Iuh) are separated using the appropriate
44configuration options. The IP based interfaces are binding to local host by
45default. In order to separate the processes, the user has to bind those
46services to specific but different IP addresses and/or ports.
47
48The VTY and the Control interface can be bound to IP addresses from the loopback
49address range, for example:
50
51----
52line vty
53 bind 127.0.0.2
54ctrl
55 bind 127.0.0.2
56----
57
58The Iuh interface can be bound to an individual port:
59
60----
61hnbgw
62 iuh
63 local-ip 0.0.0.0
64 local-port 29169
65----
66
67For the following links, OsmoHNBGW acts as a client and does not listen/bind to a
68specific interface, and will hence not encounter conflicts for multiple instances
69running on the same interface:
70
71- The SCCP/M3UA links are established by OsmoHNBGW contacting an STP.
72
73To run multiple OsmoHNBGW instances on the same SCCP routing, each HNBGW has to
74configure a distinct point-code, see <<configure_iucs_iups>>.
75
76
77=== Configuring Primary Links
78
79[[configure_iucs_iups]]
80==== Configure SCCP/M3UA to connect to an MSC's _IuCS_ and an SGSN's _IuPS_ interface
81
82OsmoHNBGW acts as client to contact an STP instance and establish an SCCP/M3UA
83link.
84
85An example configuration of OsmoHNBGW's SCCP link:
86
87----
88cs7 instance 0
89 point-code 0.23.5
90 asp asp-clnt-OsmoHNBGW 2905 0 m3ua
91 remote-ip 127.0.0.1
92 sctp-role client
93 sccp-address msc
94 routing-indicator PC
95 point-code 0.23.1
96 sccp-address sgsn
97 routing-indicator PC
98 point-code 0.23.2
99hnbgw
100 iucs
101 remote-addr msc
102 iups
103 remote-addr sgsn
104----
105
106==== Configure RUA to accept Iuh connections from hNodeB
107
108OsmoHNBGW acts as server to accept Iuh connections from hNodeB devices.
109
110An example configuration for OsmoHNBGW's RUA server:
111
112----
113hnbgw
114 iuh
115 local-ip 10.9.8.7
116 local-port 29169
117----