Neels Hofmeyr | 8c8ebb1 | 2017-09-18 16:19:30 +0200 | [diff] [blame] | 1 | == Running OsmoMSC |
| 2 | |
| 3 | The OsmoMSC executable (`osmo-msc`) offers the following command-line |
| 4 | arguments: |
| 5 | |
| 6 | === SYNOPSIS |
| 7 | |
Vadim Yanitskiy | aefbf7a | 2021-11-12 20:28:08 +0300 | [diff] [blame] | 8 | *osmo-msc* [-h|-V] [-d 'DBGMASK'] [-D] [-c 'CONFIGFILE'] [-s] [-T] [-e 'LOGLEVEL'] |
Neels Hofmeyr | 8c8ebb1 | 2017-09-18 16:19:30 +0200 | [diff] [blame] | 9 | |
| 10 | === OPTIONS |
| 11 | |
| 12 | *-h, --help*:: |
| 13 | Print a short help message about the supported options |
| 14 | *-V, --version*:: |
Harald Welte | 22d0ba8 | 2019-12-01 14:25:39 +0100 | [diff] [blame] | 15 | Print the compile-time version number of the program |
Neels Hofmeyr | 8c8ebb1 | 2017-09-18 16:19:30 +0200 | [diff] [blame] | 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 |
Daniel Willmann | 020a485 | 2018-10-23 18:17:28 +0200 | [diff] [blame] | 24 | used. If none is specified, use `osmo-msc.cfg` in the current |
Neels Hofmeyr | 8c8ebb1 | 2017-09-18 16:19:30 +0200 | [diff] [blame] | 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 Hofmeyr | 8c8ebb1 | 2017-09-18 16:19:30 +0200 | [diff] [blame] | 38 | |
| 39 | |
| 40 | === Multiple instances |
| 41 | |
Neels Hofmeyr | fee9dd7 | 2017-09-25 16:37:34 +0200 | [diff] [blame] | 42 | Running multiple instances of `osmo-msc` on the same computer is possible if all |
| 43 | interfaces (VTY, CTRL) are separated using the appropriate configuration |
| 44 | options. The IP based interfaces are binding to local host by default. In order |
| 45 | to separate the processes, the user has to bind those services to specific but |
| 46 | different IP addresses and/or ports. |
Neels Hofmeyr | 8c8ebb1 | 2017-09-18 16:19:30 +0200 | [diff] [blame] | 47 | |
| 48 | The VTY and the Control interface can be bound to IP addresses from the loopback |
| 49 | address range, for example: |
| 50 | |
| 51 | ---- |
| 52 | line vty |
| 53 | bind 127.0.0.2 |
| 54 | ctrl |
| 55 | bind 127.0.0.2 |
| 56 | ---- |
| 57 | |
| 58 | If external SMPP is enabled, you may bind it to a different interface using: |
| 59 | |
| 60 | ---- |
| 61 | smpp |
| 62 | local-tcp-ip 10.23.42.1 2775 |
| 63 | ---- |
| 64 | |
| 65 | More on SMPP configuration in <<smpp-config-global>>. |
| 66 | |
Neels Hofmeyr | 92b0246 | 2020-05-26 23:13:53 +0200 | [diff] [blame] | 67 | The external MNCC handler is a UNIX domain socket that is created when external MNCC handling is configured. A separate |
| 68 | path must be used per osmo-msc instance: |
| 69 | |
| 70 | ---- |
| 71 | msc |
| 72 | mncc external /tmp/mncc_socket |
| 73 | ---- |
| 74 | |
| 75 | More on MNCC in <<mncc-external>>. |
| 76 | |
Philipp Maier | 1759ed5 | 2023-10-23 17:05:27 +0200 | [diff] [blame^] | 77 | The SGs interface by default listens on 0.0.0.0:29118 (SCTP). Each instance of OsmoMSC must use a different IP address |
| 78 | and/or port. For details about the configuration of the SGs interface, see section <<sgs>>. |
Neels Hofmeyr | 8c8ebb1 | 2017-09-18 16:19:30 +0200 | [diff] [blame] | 79 | |
| 80 | For the following links, OsmoMSC acts as a client and does not listen/bind to a |
| 81 | specific interface, and will hence not encounter conflicts for multiple instances |
| 82 | running on the same interface: |
| 83 | |
| 84 | - The SCCP/M3UA links are established by OsmoMSC contacting an STP. |
| 85 | - The GSUP link is established by OsmoMSC contacting an HLR. |
Neels Hofmeyr | d233104 | 2020-03-18 01:08:46 +0100 | [diff] [blame] | 86 | - The MGCP link is established by OsmoMSC contacting an MGW. |
Neels Hofmeyr | 8c8ebb1 | 2017-09-18 16:19:30 +0200 | [diff] [blame] | 87 | |
| 88 | |
| 89 | === Configure primary links |
| 90 | |
| 91 | ==== Configure SCCP/M3UA to accept _A_ and _IuCS_ links |
| 92 | |
Neels Hofmeyr | 346a3b9 | 2020-03-18 01:10:42 +0100 | [diff] [blame] | 93 | OsmoMSC acts as client to contact an STP instance and establish an SCCP/M3UA |
| 94 | link. |
Neels Hofmeyr | 8c8ebb1 | 2017-09-18 16:19:30 +0200 | [diff] [blame] | 95 | |
Neels Hofmeyr | 346a3b9 | 2020-03-18 01:10:42 +0100 | [diff] [blame] | 96 | An example configuration of OsmoMSC's SCCP link: |
Neels Hofmeyr | 8c8ebb1 | 2017-09-18 16:19:30 +0200 | [diff] [blame] | 97 | |
| 98 | ---- |
| 99 | cs7 instance 0 |
Neels Hofmeyr | 346a3b9 | 2020-03-18 01:10:42 +0100 | [diff] [blame] | 100 | point-code 0.23.1 |
| 101 | asp asp-clnt-OsmoMSC-A-Iu 2905 0 m3ua |
| 102 | remote-ip 127.0.0.1 |
Pau Espin Pedrol | 11c420a | 2023-06-08 19:39:13 +0200 | [diff] [blame] | 103 | role asp |
Neels Hofmeyr | 346a3b9 | 2020-03-18 01:10:42 +0100 | [diff] [blame] | 104 | sctp-role client |
Neels Hofmeyr | 8c8ebb1 | 2017-09-18 16:19:30 +0200 | [diff] [blame] | 105 | ---- |
| 106 | |
Neels Hofmeyr | 346a3b9 | 2020-03-18 01:10:42 +0100 | [diff] [blame] | 107 | This configuration is explained in detail in <<cs7_config>>. |
| 108 | |
Neels Hofmeyr | 8c8ebb1 | 2017-09-18 16:19:30 +0200 | [diff] [blame] | 109 | Note that _A_ and _IuCS_ may use different SCCP instances, if so desired: |
| 110 | |
| 111 | ---- |
| 112 | cs7 instance 0 |
| 113 | asp my-OsmoMSC-A 2905 0 m3ua |
| 114 | remote-ip 10.23.42.1 |
Pau Espin Pedrol | 11c420a | 2023-06-08 19:39:13 +0200 | [diff] [blame] | 115 | role asp |
| 116 | sctp-role client |
Neels Hofmeyr | 8c8ebb1 | 2017-09-18 16:19:30 +0200 | [diff] [blame] | 117 | cs7 instance 1 |
| 118 | asp my-OsmoMSC-Iu 2905 0 m3ua |
| 119 | remote-ip 10.23.42.2 |
Pau Espin Pedrol | 11c420a | 2023-06-08 19:39:13 +0200 | [diff] [blame] | 120 | role asp |
| 121 | sctp-role client |
Neels Hofmeyr | 8c8ebb1 | 2017-09-18 16:19:30 +0200 | [diff] [blame] | 122 | msc |
| 123 | cs7-instance-a 0 |
| 124 | cs7-instance-iu 1 |
| 125 | ---- |
| 126 | |
Neels Hofmeyr | 8c8ebb1 | 2017-09-18 16:19:30 +0200 | [diff] [blame] | 127 | ==== Configure GSUP to reach the HLR |
| 128 | |
| 129 | OsmoMSC will assume a GSUP server (OsmoHLR) to run on the local host and the |
| 130 | default GSUP port (4222). Contacting an HLR at a different IP address can be |
| 131 | configured as follows: |
| 132 | |
| 133 | ---- |
| 134 | hlr |
| 135 | ! IP address of the remote HLR: |
| 136 | remote-ip 10.23.42.1 |
| 137 | ! default port is 4222, optionally configurable by: |
| 138 | remote-port 1234 |
| 139 | ---- |
Philipp Maier | 945b060 | 2021-08-03 11:33:20 +0200 | [diff] [blame] | 140 | |
| 141 | ==== Configure MGCP to connect to an MGW |
| 142 | |
| 143 | OsmoMSC uses a media gateway (typically OsmoMGW) to direct RTP streams. By |
| 144 | default, an MGW is expected to receive MGCP requests on the IANA-registered |
| 145 | default port for MGCP (2427) on local host (127.0.0.1). |
| 146 | |
| 147 | Here is an example configuration for a remote MGW: |
| 148 | |
| 149 | ---- |
Pau Espin Pedrol | b44cf2d | 2022-10-17 18:09:15 +0200 | [diff] [blame] | 150 | network |
| 151 | mgw 0 |
Pau Espin Pedrol | ef70bb2 | 2022-10-19 13:25:55 +0200 | [diff] [blame] | 152 | remote-ip 10.9.8.7 |
| 153 | remote-port 2427 |
| 154 | reset-endpoint rtpbridge/* <1> |
Philipp Maier | 945b060 | 2021-08-03 11:33:20 +0200 | [diff] [blame] | 155 | ---- |
| 156 | <1> The 'reset-endpoint' setting instructs the OsmoMGW to send a wildcarded |
| 157 | DLCX to the media gateway. This helps to clear lingering calls from the |
| 158 | media gateway when the OsmoMSC is restarted. |
Pau Espin Pedrol | b44cf2d | 2022-10-17 18:09:15 +0200 | [diff] [blame] | 159 | |
Pau Espin Pedrol | 68d2a67 | 2022-10-20 16:24:06 +0200 | [diff] [blame] | 160 | OsmoMSC is also able to handle a pool of media gateways for load |
| 161 | distribution. See also <<mgw_pooling>>. |
| 162 | |
Pau Espin Pedrol | b44cf2d | 2022-10-17 18:09:15 +0200 | [diff] [blame] | 163 | [NOTE] |
| 164 | ==== |
| 165 | Previous versions of OsmoMSC (1.9.0 and below) didn't have the 'mgw' VTY node and |
| 166 | hence didn't support the MGW pooling feature. Therefore, historically the MGW |
| 167 | related commands where placed under the `msc` VTY node. The MGW related commands |
| 168 | under the `msc` VTY are still parsed and used but its use is deprecated and |
| 169 | hence discouraged in favour of the new `mgw` node. Writing the config to a file |
| 170 | from within OsmoMSC will automatically convert the config to use the new `mgw` |
| 171 | node. |
| 172 | ==== |