blob: 0a3174eea4f9334d1ac2f56d042fca8ea4839c28 [file] [log] [blame]
Harald Welteb53e2bf2020-08-21 16:33:42 +02001== Running OsmoSMLC
2
3The OsmoSMLC executable (`osmo-smlc`) offers the following command-line
4arguments:
5
6=== SYNOPSIS
7
8*osmo-smlc* [-h|-V] [-d 'DBGMASK'] [-D] [-c 'CONFIGFILE'] [-s] [-T] [-e 'LOGLEVEL'] [-l 'IP'] [-r 'RFCTL']
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 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-smlc.cfg` in the current
25 working directory.
26*-e, --log-level 'LOGLEVEL'*::
27 Set the global log level for logging to stderr. This has mostly
28 been deprecated by VTY based logging configuration, see
29 <<logging>> for more information.
30
31=== Multiple instances
32
33Running multiple instances of `osmo-smlc` on the same host is possible if all
34interfaces (VTY, CTRL) are separated using the appropriate configuration
35options. The IP based interfaces are binding to local host by default. In order
36to separate the processes, the user has to bind those services to specific but
37different IP addresses and/or ports.
38
39The VTY and the Control interface can be bound to IP addresses from the loopback
40address range, for example:
41
42----
43line vty
44 bind 127.0.0.2
45ctrl
46 bind 127.0.0.2
47----
48
49For the following links, OsmoSMLC acts as a client and does not listen/bind to a
50specific interface, and will hence not encounter conflicts for multiple instances
51running on the same interface:
52
53- The SCCP/M3UA links are established by OsmoSMLC contacting an STP.
54
55To run multiple OsmoSMLC instances on the same network, each SMLC
56has to configure a distinct point-code. See <<cs7_config>>.
57
58
59=== Configure primary links
60
61==== Connect to an STP
62
63===== Configure SCCP/M3UA (AoIP)
64
65OsmoSMLC acts as client to contact an STP instance and establish an SCCP/M3UA
66link.
67
68An example configuration of OsmoSMLC's Lb SCCP link, assuming the SMLC at
69point-code 1.23.6 via an SG listening for M3UA at 127.0.0.1:2905:
70
71----
72cs7 instance 0
73 point-code 1.23.6
74 asp asp-clnt-msc-0 2905 0 m3ua
75 remote-ip 127.0.0.1
76 sctp-role client
77----
78
79This configuration is explained in detail in <<cs7_config>>.