diff options
Diffstat (limited to 'doc/manuals')
-rw-r--r-- | doc/manuals/chapters/running.adoc | 100 | ||||
-rw-r--r-- | doc/manuals/osmobsc-usermanual.adoc | 2 | ||||
-rw-r--r-- | doc/manuals/vty/bsc_vty_reference.xml | 123 |
3 files changed, 204 insertions, 21 deletions
diff --git a/doc/manuals/chapters/running.adoc b/doc/manuals/chapters/running.adoc index 995fd88fb..eeefa6cde 100644 --- a/doc/manuals/chapters/running.adoc +++ b/doc/manuals/chapters/running.adoc @@ -40,3 +40,103 @@ arguments: *-r, --rf-ctl 'RFCTL'*:: Offer a Unix domain socket for RF control at the path/filename 'RFCTL' in the file system. + + +=== Multiple instances + +Running multiple instances of `osmo-bsc` on the same host is possible if all +interfaces (VTY, CTRL) are separated using the appropriate configuration +options. The IP based interfaces are binding to local host by default. In order +to separate the processes, the user has to bind those services to specific but +different IP addresses and/or ports. + +The VTY and the Control interface can be bound to IP addresses from the loopback +address range, for example: + +---- +line vty + bind 127.0.0.2 +ctrl + bind 127.0.0.2 +---- + +For the following links, OsmoBSC acts as a client and does not listen/bind to a +specific interface, and will hence not encounter conflicts for multiple instances +running on the same interface: + +- The SCCP/M3UA links are established by OsmoBSC contacting an STP. +- The MGCP link is established by OsmoMSC contacting an MGW. + +To run multiple OsmoBSC instances on the same A-interface (SCCP/M3UA), each BSC +has to configure a distinct point-code. See <<cs7_config>>. + + +=== Configure primary links + +==== Connect to an MSC's _A_ interface + +===== Configure SCCP/M3UA (AoIP) + +OsmoBSC acts as client to contact an STP instance and establish an SCCP/M3UA +link. + +An example configuration of OsmoBSC's AoIP SCCP link, assuming the BSC at +point-code 1.23.3 and the MSC reachable at point-code 0.23.1 via an SG +listening for M3UA at 127.0.0.1:2905: + +---- +cs7 instance 0 + point-code 1.23.3 + asp asp-clnt-msc-0 2905 0 m3ua + remote-ip 127.0.0.1 + sctp-role client + sccp-address msc + point-code 0.23.1 +msc 0 + msc-address msc +---- + +This configuration is explained in detail in <<cs7_config>>. + +===== Configure SCCPlite + +Traditionally, OsmoBSC implemented only an SCCPlite based A-interface, an +ad-hoc standard encapsulating BSSAP in an IPA Multiplex. Since 2017, OsmoBSC +supports primarily a proper 3GPP compliant SCCP/M3UA A-interface known as AoIP, +by a new libosmo-sigtran implementation. In 2018, SCCPlite compatibility was +added to libosmo-sigtran, re-enabling the option of using an SCCPlite based +A-interface. For details, see the OsmoSTP manual, chapter "IPA / SCCPlite +backwards compatibility". + +Here is an example configuration of OsmoBSC for SCCPlite, assuming the BSC at +point-code 1.23.3 and an SCCPlite MSC listening on 127.0.0.1:5000 with own +point-code 0.23.1: + +---- +cs7 instance 0 + point-code 1.23.3 + asp asp-clnt-msc-0 5000 0 ipa + remote-ip 127.0.0.1 + as as-clnt-msc-0 ipa + asp asp-clnt-msc-0 + routing-key 0 1.23.3 + point-code override dpc 0.23.1 + sccp-address remote_msc + point-code 0.23.1 +msc 0 + msc-addr remote_msc +---- + +==== Configure MGCP to connect to an MGW + +OsmoBSC uses a media gateway (typically OsmoMGW) to direct RTP streams. By +default, an MGW is expected to receive MGCP requests on the IANA-registered +default port for MGCP (2427) on local host (127.0.0.1). + +Here is an example configuration for a remote MGW: + +---- +msc 0 + mgw remote-ip 10.9.8.7 + mgw remote-port 2427 +---- diff --git a/doc/manuals/osmobsc-usermanual.adoc b/doc/manuals/osmobsc-usermanual.adoc index 26f49da03..c518c96eb 100644 --- a/doc/manuals/osmobsc-usermanual.adoc +++ b/doc/manuals/osmobsc-usermanual.adoc @@ -16,6 +16,8 @@ include::./common/chapters/vty.adoc[] include::./common/chapters/logging.adoc[] +include::./common/chapters/cs7-config.adoc[] + include::./common/chapters/bts.adoc[] include::{srcdir}/chapters/bts-examples.adoc[] diff --git a/doc/manuals/vty/bsc_vty_reference.xml b/doc/manuals/vty/bsc_vty_reference.xml index 84010436e..dac4ec58b 100644 --- a/doc/manuals/vty/bsc_vty_reference.xml +++ b/doc/manuals/vty/bsc_vty_reference.xml @@ -18,10 +18,11 @@ <param name='terminal' doc='Write to terminal' /> </params> </command> - <command id='write file'> + <command id='write file [PATH]'> <params> <param name='write' doc='Write running configuration to memory, network, or terminal' /> <param name='file' doc='Write to configuration file' /> + <param name='[PATH]' doc='Set file path to store the config, or replace if already exists' /> </params> </command> <command id='write memory'> @@ -138,6 +139,15 @@ <param name='[<0-255>]' doc='BTS number' /> </params> </command> + <command id='show bts <0-255> fail-rep [reset]'> + <params> + <param name='show' doc='Show running system information' /> + <param name='bts' doc='Display information about a BTS' /> + <param name='<0-255>' doc='BTS number' /> + <param name='fail-rep' doc='OML failure reports' /> + <param name='[reset]' doc='Clear the list of failure reports after showing them' /> + </params> + </command> <command id='show rejected-bts'> <params> <param name='show' doc='Show running system information' /> @@ -320,7 +330,7 @@ <param name='MASK' doc='List of logging categories to log, e.g. 'abc:mno:xyz'. Available log categories depend on the specific application, refer to the 'logging level' command. Optionally add individual log levels like 'abc,1:mno,3:xyz,5', where the level numbers are LOGL_DEBUG=1 LOGL_INFO=3 LOGL_NOTICE=5 LOGL_ERROR=7 LOGL_FATAL=8' /> </params> </command> - <command id='logging level (rll|mm|rr|rsl|nm|pag|meas|msc|ho|hodec|ref|nat|ctrl|filter|pcu|lcls|chan|ts|as|cbs|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro) (debug|info|notice|error|fatal)'> + <command id='logging level (rll|mm|rr|rsl|nm|pag|meas|msc|ho|hodec|ref|ctrl|filter|pcu|lcls|chan|ts|as|cbs|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro) (debug|info|notice|error|fatal)'> <params> <param name='logging' doc='Configure logging' /> <param name='level' doc='Set the log level for a specified category' /> @@ -335,7 +345,6 @@ <param name='ho' doc='Hand-Over Process' /> <param name='hodec' doc='Hand-Over Decision' /> <param name='ref' doc='Reference Counting' /> - <param name='nat' doc='GSM 08.08 NAT/Multiplexer' /> <param name='ctrl' doc='Control interface' /> <param name='filter' doc='BSC/NAT IMSI based filtering' /> <param name='pcu' doc='PCU Interface' /> @@ -402,7 +411,7 @@ <param name='force-all' doc='Release any globally forced log level set with 'logging level force-all <level>'' /> </params> </command> - <command id='logp (rll|mm|rr|rsl|nm|pag|meas|msc|ho|hodec|ref|nat|ctrl|filter|pcu|lcls|chan|ts|as|cbs|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro) (debug|info|notice|error|fatal) .LOGMESSAGE'> + <command id='logp (rll|mm|rr|rsl|nm|pag|meas|msc|ho|hodec|ref|ctrl|filter|pcu|lcls|chan|ts|as|cbs|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro) (debug|info|notice|error|fatal) .LOGMESSAGE'> <params> <param name='logp' doc='Print a message on all log outputs; useful for placing markers in test logs' /> <param name='rll' doc='A-bis Radio Link Layer (RLL)' /> @@ -416,7 +425,6 @@ <param name='ho' doc='Hand-Over Process' /> <param name='hodec' doc='Hand-Over Decision' /> <param name='ref' doc='Reference Counting' /> - <param name='nat' doc='GSM 08.08 NAT/Multiplexer' /> <param name='ctrl' doc='Control interface' /> <param name='filter' doc='BSC/NAT IMSI based filtering' /> <param name='pcu' doc='PCU Interface' /> @@ -640,6 +648,13 @@ <param name='[<0-65534>]' doc='Port Number' /> </params> </command> + <command id='show cs7 config'> + <params> + <param name='show' doc='Show running system information' /> + <param name='cs7' doc='ITU-T Signaling System 7' /> + <param name='config' doc='Currently running cs7 configuration' /> + </params> + </command> <command id='show cs7 instance <0-15> asp'> <params> <param name='show' doc='Show running system information' /> @@ -832,6 +847,15 @@ <param name='[<0-255>]' doc='BTS number' /> </params> </command> + <command id='show bts <0-255> fail-rep [reset]'> + <params> + <param name='show' doc='Show running system information' /> + <param name='bts' doc='Display information about a BTS' /> + <param name='<0-255>' doc='BTS number' /> + <param name='fail-rep' doc='OML failure reports' /> + <param name='[reset]' doc='Clear the list of failure reports after showing them' /> + </params> + </command> <command id='show rejected-bts'> <params> <param name='show' doc='Show running system information' /> @@ -1038,7 +1062,7 @@ <param name='MASK' doc='List of logging categories to log, e.g. 'abc:mno:xyz'. Available log categories depend on the specific application, refer to the 'logging level' command. Optionally add individual log levels like 'abc,1:mno,3:xyz,5', where the level numbers are LOGL_DEBUG=1 LOGL_INFO=3 LOGL_NOTICE=5 LOGL_ERROR=7 LOGL_FATAL=8' /> </params> </command> - <command id='logging level (rll|mm|rr|rsl|nm|pag|meas|msc|ho|hodec|ref|nat|ctrl|filter|pcu|lcls|chan|ts|as|cbs|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro) (debug|info|notice|error|fatal)'> + <command id='logging level (rll|mm|rr|rsl|nm|pag|meas|msc|ho|hodec|ref|ctrl|filter|pcu|lcls|chan|ts|as|cbs|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro) (debug|info|notice|error|fatal)'> <params> <param name='logging' doc='Configure logging' /> <param name='level' doc='Set the log level for a specified category' /> @@ -1053,7 +1077,6 @@ <param name='ho' doc='Hand-Over Process' /> <param name='hodec' doc='Hand-Over Decision' /> <param name='ref' doc='Reference Counting' /> - <param name='nat' doc='GSM 08.08 NAT/Multiplexer' /> <param name='ctrl' doc='Control interface' /> <param name='filter' doc='BSC/NAT IMSI based filtering' /> <param name='pcu' doc='PCU Interface' /> @@ -1120,7 +1143,7 @@ <param name='force-all' doc='Release any globally forced log level set with 'logging level force-all <level>'' /> </params> </command> - <command id='logp (rll|mm|rr|rsl|nm|pag|meas|msc|ho|hodec|ref|nat|ctrl|filter|pcu|lcls|chan|ts|as|cbs|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro) (debug|info|notice|error|fatal) .LOGMESSAGE'> + <command id='logp (rll|mm|rr|rsl|nm|pag|meas|msc|ho|hodec|ref|ctrl|filter|pcu|lcls|chan|ts|as|cbs|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro) (debug|info|notice|error|fatal) .LOGMESSAGE'> <params> <param name='logp' doc='Print a message on all log outputs; useful for placing markers in test logs' /> <param name='rll' doc='A-bis Radio Link Layer (RLL)' /> @@ -1134,7 +1157,6 @@ <param name='ho' doc='Hand-Over Process' /> <param name='hodec' doc='Hand-Over Decision' /> <param name='ref' doc='Reference Counting' /> - <param name='nat' doc='GSM 08.08 NAT/Multiplexer' /> <param name='ctrl' doc='Control interface' /> <param name='filter' doc='BSC/NAT IMSI based filtering' /> <param name='pcu' doc='PCU Interface' /> @@ -1549,6 +1571,13 @@ <param name='[<0-65534>]' doc='Port Number' /> </params> </command> + <command id='show cs7 config'> + <params> + <param name='show' doc='Show running system information' /> + <param name='cs7' doc='ITU-T Signaling System 7' /> + <param name='config' doc='Currently running cs7 configuration' /> + </params> + </command> <command id='show cs7 instance <0-15> asp'> <params> <param name='show' doc='Show running system information' /> @@ -1966,7 +1995,7 @@ <param name='[last]' doc='Log source file info at the end of a log line. If omitted, log source file info just before the log text.' /> </params> </command> - <command id='logging level (rll|mm|rr|rsl|nm|pag|meas|msc|ho|hodec|ref|nat|ctrl|filter|pcu|lcls|chan|ts|as|cbs|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro) (debug|info|notice|error|fatal)'> + <command id='logging level (rll|mm|rr|rsl|nm|pag|meas|msc|ho|hodec|ref|ctrl|filter|pcu|lcls|chan|ts|as|cbs|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro) (debug|info|notice|error|fatal)'> <params> <param name='logging' doc='Configure logging' /> <param name='level' doc='Set the log level for a specified category' /> @@ -1981,7 +2010,6 @@ <param name='ho' doc='Hand-Over Process' /> <param name='hodec' doc='Hand-Over Decision' /> <param name='ref' doc='Reference Counting' /> - <param name='nat' doc='GSM 08.08 NAT/Multiplexer' /> <param name='ctrl' doc='Control interface' /> <param name='filter' doc='BSC/NAT IMSI based filtering' /> <param name='pcu' doc='PCU Interface' /> @@ -2149,7 +2177,7 @@ </node> <node id='config-e1_input'> <name>config-e1_input</name> - <command id='e1_line <0-255> driver (misdn|misdn_lapd|dahdi|ipa|unixsocket)'> + <command id='e1_line <0-255> driver (misdn|misdn_lapd|dahdi|e1d|ipa|unixsocket)'> <params> <param name='e1_line' doc='Configure E1/T1/J1 Line' /> <param name='<0-255>' doc='Line Number' /> @@ -2157,8 +2185,9 @@ <param name='misdn' doc='mISDN supported E1 Card (kernel LAPD)' /> <param name='misdn_lapd' doc='mISDN supported E1 Card (userspace LAPD)' /> <param name='dahdi' doc='DAHDI supported E1/T1/J1 Card' /> - <param name='ipa' doc='IPA TCP/IP input' /> - <param name='unixsocket' doc='HSL TCP/IP input' /> + <param name='e1d' doc='IPA TCP/IP input' /> + <param name='ipa' doc='HSL TCP/IP input' /> + <param name='unixsocket' doc='Unix socket input' /> </params> </command> <command id='e1_line <0-255> port <0-255>'> @@ -2210,6 +2239,23 @@ <param name='keepalive' doc='Enable keep-alive probing' /> </params> </command> + <command id='e1_line <0-255> ipa-keepalive <1-300> <1-300>'> + <params> + <param name='e1_line' doc='Configure E1/T1/J1 Line' /> + <param name='<0-255>' doc='Line Number' /> + <param name='ipa-keepalive' doc='Enable IPA PING/PONG keep-alive' /> + <param name='<1-300>' doc='Idle interval in seconds before probes are sent' /> + <param name='<1-300>' doc='Time to wait for PONG response' /> + </params> + </command> + <command id='no e1_line <0-255> ipa-keepalive'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='e1_line' doc='Configure E1/T1/J1 Line' /> + <param name='<0-255>' doc='Line Number' /> + <param name='ipa-keepalive' doc='Enable IPA PING/PONG keep-alive' /> + </params> + </command> <command id='ipa bind A.B.C.D'> <params> <param name='ipa' doc='ipa driver config' /> @@ -2446,6 +2492,15 @@ <param name='PC' doc='Override Destination Point Code' /> </params> </command> + <command id='point-code override patch-sccp (disabled|both)'> + <params> + <param name='point-code' doc='Point Code Specific Features' /> + <param name='override' doc='Override (force) a point-code to hard-coded value' /> + <param name='patch-sccp' doc='Patch point code values into SCCP called/calling address' /> + <param name='disabled' doc='Don't patch any point codes into SCCP called/calling address' /> + <param name='both' doc='Patch both origin and destination point codes into SCCP called/calling address' /> + </params> + </command> </node> <node id='config-cs7-asp'> <name>config-cs7-asp</name> @@ -2473,6 +2528,21 @@ <param name='<0-255>' doc='QoS Class of ASP' /> </params> </command> + <command id='role (sg|asp|ipsp)'> + <params> + <param name='role' doc='Specify the xUA role for this ASP' /> + <param name='sg' doc='SG (Signaling Gateway)' /> + <param name='asp' doc='ASP (Application Server Process)' /> + <param name='ipsp' doc='IPSP (IP Signalling Point)' /> + </params> + </command> + <command id='sctp-role (client|server)'> + <params> + <param name='sctp-role' doc='Specify the SCTP role for this ASP' /> + <param name='client' doc='Operate as SCTP client; connect to a server' /> + <param name='server' doc='Operate as SCTP server; wait for client connections' /> + </params> + </command> <command id='block'> <params> <param name='block' doc='Allows a SCTP Association with ASP, but doesn't let it become active' /> @@ -2657,6 +2727,11 @@ <param name='[default]' doc='Set to default timer value' /> </params> </command> + <command id='allow-unusable-timeslots'> + <params> + <param name='allow-unusable-timeslots' doc='Don't refuse to start with mutually exclusive codec settings' /> + </params> + </command> <command id='neci (0|1)'> <params> <param name='neci' doc='New Establish Cause Indication' /> @@ -3295,12 +3370,17 @@ <param name='egprs' doc='EGPRS (EDGE) Enabled on this BTS' /> </params> </command> - <command id='gprs 11bit_rach_support_for_egprs (0|1)'> + <command id='no gprs egprs-packet-channel-request'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='gprs' doc='GPRS Packet Network' /> + <param name='egprs-packet-channel-request' doc='EGPRS Packet Channel Request support' /> + </params> + </command> + <command id='gprs egprs-packet-channel-request'> <params> <param name='gprs' doc='GPRS Packet Network' /> - <param name='11bit_rach_support_for_egprs' doc='11 bit RACH options' /> - <param name='0' doc='Disable 11 bit RACH for EGPRS' /> - <param name='1' doc='Enable 11 bit RACH for EGPRS' /> + <param name='egprs-packet-channel-request' doc='EGPRS Packet Channel Request support' /> </params> </command> <command id='gprs ns timer (tns-block|tns-block-retries|tns-reset|tns-reset-retries|tns-test|tns-alive|tns-alive-retries|tsns-prov) <0-255>'> @@ -3680,10 +3760,11 @@ <param name='<0-255>' doc='BTS Number' /> </params> </command> - <command id='depeneds-on-bts <0-255>'> + <command id='no depends-on-bts <0-255>'> <params> - <param name='depeneds-on-bts' doc='Negate a command or set its defaults' /> - <param name='<0-255>' doc='This BTS can only be started if another one is up' /> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='depends-on-bts' doc='This BTS can only be started if another one is up' /> + <param name='<0-255>' doc='BTS Number' /> </params> </command> <command id='amr tch-f modes (0|1|2|3|4|5|6|7)'> |