Harald Welte | 75c0e08 | 2016-02-20 10:56:10 +0100 | [diff] [blame] | 1 | == Running OsmoBSC |
| 2 | |
| 3 | The OsmoBSC executable (`osmo-bsc`) offers the following command-line |
| 4 | arguments: |
| 5 | |
Neels Hofmeyr | 4c297e7 | 2016-10-17 06:12:13 +0200 | [diff] [blame] | 6 | === SYNOPSIS |
Harald Welte | 75c0e08 | 2016-02-20 10:56:10 +0100 | [diff] [blame] | 7 | |
| 8 | *osmo-bsc* [-h|-V] [-d 'DBGMASK'] [-D] [-c 'CONFIGFILE'] [-s] [-T] [-e 'LOGLEVEL'] [-l 'IP'] [-r 'RFCTL'] |
| 9 | |
Neels Hofmeyr | 4c297e7 | 2016-10-17 06:12:13 +0200 | [diff] [blame] | 10 | === OPTIONS |
Harald Welte | 75c0e08 | 2016-02-20 10:56:10 +0100 | [diff] [blame] | 11 | |
| 12 | *-h, --help*:: |
| 13 | Print a short help message about the supported options |
| 14 | *-V, --version*:: |
Harald Welte | 16c8910 | 2019-12-01 14:23:34 +0100 | [diff] [blame] | 15 | Print the compile-time version number of the program |
Harald Welte | 75c0e08 | 2016-02-20 10:56:10 +0100 | [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 | 5397326 | 2018-10-23 18:17:28 +0200 | [diff] [blame] | 24 | used. If none is specified, use `osmo-bsc.cfg` in the current |
Harald Welte | 75c0e08 | 2016-02-20 10:56:10 +0100 | [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 configu- ration, 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. |
| 38 | *-l, --local='IP'*:: |
| 39 | Specify the local IP address of the OsmoBSC-MGCP |
| 40 | *-r, --rf-ctl 'RFCTL'*:: |
| 41 | Offer a Unix domain socket for RF control at the path/filename |
| 42 | 'RFCTL' in the file system. |
Neels Hofmeyr | 21a2c81 | 2020-03-18 01:01:39 +0100 | [diff] [blame] | 43 | |
| 44 | |
| 45 | === Multiple instances |
| 46 | |
| 47 | Running multiple instances of `osmo-bsc` on the same host is possible if all |
| 48 | interfaces (VTY, CTRL) are separated using the appropriate configuration |
| 49 | options. The IP based interfaces are binding to local host by default. In order |
| 50 | to separate the processes, the user has to bind those services to specific but |
| 51 | different IP addresses and/or ports. |
| 52 | |
| 53 | The VTY and the Control interface can be bound to IP addresses from the loopback |
| 54 | address range, for example: |
| 55 | |
| 56 | ---- |
| 57 | line vty |
| 58 | bind 127.0.0.2 |
| 59 | ctrl |
| 60 | bind 127.0.0.2 |
| 61 | ---- |
| 62 | |
| 63 | For the following links, OsmoBSC acts as a client and does not listen/bind to a |
| 64 | specific interface, and will hence not encounter conflicts for multiple instances |
| 65 | running on the same interface: |
| 66 | |
| 67 | - The SCCP/M3UA links are established by OsmoBSC contacting an STP. |
| 68 | - The MGCP link is established by OsmoMSC contacting an MGW. |
| 69 | |
| 70 | To run multiple OsmoBSC instances on the same A-interface (SCCP/M3UA), each BSC |
Neels Hofmeyr | b5a25b0 | 2020-03-18 01:01:52 +0100 | [diff] [blame] | 71 | has to configure a distinct point-code. See <<cs7_config>>. |
Neels Hofmeyr | 21a2c81 | 2020-03-18 01:01:39 +0100 | [diff] [blame] | 72 | |
| 73 | |
| 74 | === Configure primary links |
| 75 | |
Neels Hofmeyr | 6ab7a52 | 2020-03-20 00:44:16 +0100 | [diff] [blame] | 76 | ==== Connect to an MSC's _A_ interface |
| 77 | |
| 78 | ===== Configure SCCP/M3UA (AoIP) |
Neels Hofmeyr | 21a2c81 | 2020-03-18 01:01:39 +0100 | [diff] [blame] | 79 | |
| 80 | OsmoBSC acts as client to contact an STP instance and establish an SCCP/M3UA |
| 81 | link. |
| 82 | |
| 83 | An example configuration of OsmoBSC's AoIP SCCP link, assuming the BSC at |
| 84 | point-code 1.23.3 and the MSC reachable at point-code 0.23.1 via an SG |
| 85 | listening for M3UA at 127.0.0.1:2905: |
| 86 | |
| 87 | ---- |
| 88 | cs7 instance 0 |
| 89 | point-code 1.23.3 |
| 90 | asp asp-clnt-msc-0 2905 0 m3ua |
| 91 | remote-ip 127.0.0.1 |
| 92 | sctp-role client |
| 93 | sccp-address msc |
| 94 | point-code 0.23.1 |
| 95 | msc 0 |
Neels Hofmeyr | 6e06bd3 | 2020-05-13 19:15:58 +0200 | [diff] [blame^] | 96 | msc-addr msc |
Neels Hofmeyr | 21a2c81 | 2020-03-18 01:01:39 +0100 | [diff] [blame] | 97 | ---- |
| 98 | |
Neels Hofmeyr | b5a25b0 | 2020-03-18 01:01:52 +0100 | [diff] [blame] | 99 | This configuration is explained in detail in <<cs7_config>>. |
| 100 | |
Neels Hofmeyr | 6ab7a52 | 2020-03-20 00:44:16 +0100 | [diff] [blame] | 101 | ===== Configure SCCPlite |
| 102 | |
| 103 | Traditionally, OsmoBSC implemented only an SCCPlite based A-interface, an |
| 104 | ad-hoc standard encapsulating BSSAP in an IPA Multiplex. Since 2017, OsmoBSC |
| 105 | supports primarily a proper 3GPP compliant SCCP/M3UA A-interface known as AoIP, |
| 106 | by a new libosmo-sigtran implementation. In 2018, SCCPlite compatibility was |
| 107 | added to libosmo-sigtran, re-enabling the option of using an SCCPlite based |
| 108 | A-interface. For details, see the OsmoSTP manual, chapter "IPA / SCCPlite |
| 109 | backwards compatibility". |
| 110 | |
| 111 | Here is an example configuration of OsmoBSC for SCCPlite, assuming the BSC at |
| 112 | point-code 1.23.3 and an SCCPlite MSC listening on 127.0.0.1:5000 with own |
| 113 | point-code 0.23.1: |
| 114 | |
| 115 | ---- |
| 116 | cs7 instance 0 |
| 117 | point-code 1.23.3 |
| 118 | asp asp-clnt-msc-0 5000 0 ipa |
| 119 | remote-ip 127.0.0.1 |
| 120 | as as-clnt-msc-0 ipa |
| 121 | asp asp-clnt-msc-0 |
| 122 | routing-key 0 1.23.3 |
| 123 | point-code override dpc 0.23.1 |
| 124 | sccp-address remote_msc |
| 125 | point-code 0.23.1 |
| 126 | msc 0 |
| 127 | msc-addr remote_msc |
| 128 | ---- |
| 129 | |
Neels Hofmeyr | 21a2c81 | 2020-03-18 01:01:39 +0100 | [diff] [blame] | 130 | ==== Configure MGCP to connect to an MGW |
| 131 | |
| 132 | OsmoBSC uses a media gateway (typically OsmoMGW) to direct RTP streams. By |
| 133 | default, an MGW is expected to receive MGCP requests on the IANA-registered |
| 134 | default port for MGCP (2427) on local host (127.0.0.1). |
| 135 | |
| 136 | Here is an example configuration for a remote MGW: |
| 137 | |
| 138 | ---- |
| 139 | msc 0 |
| 140 | mgw remote-ip 10.9.8.7 |
| 141 | mgw remote-port 2427 |
| 142 | ---- |