blob: 1f0240bedc6c086de4a73166fe28fb1b777c49f2 [file] [log] [blame]
Philipp Maier1759ed52023-10-23 17:05:27 +02001[[sgs]]
2== SGs interface
3
4OsmoMSC offers an SGs interface using the SGsAP protocol. The SGs interface is an
5optional interface between a 2G (GERAN) / 3G (UTRAN) MSC and an 4G (EUTRAN) MME.
6Its purpose is to facilitate both CSFB (Circuit-Switched Fall Back) and SMSoS
7(SMS over SGs). It is used for Mobility management (MM) and paging procedures
8between the EPS (Evolved Packet Services) and CS (Circuit Switched) domain.
9
10=== VTY configuration
11
12The SGs interface implementation in OsmoMSC is automatically active and requires
13only minimal configuration. When no specific configuration is provided OsmoMSC
14will listen on 0.0.0.0:29118 (SCTP) for incoming connections.
15
16This is sufficient in the most configurations, but in larger installations,
17where services are either tied to specific interfaces and/or more instances of
18OsmoMSC run in parallel, a custom configuration is necessary.
19
20The user has the option to configure the IP address (`local-ip`) and the SCTP
21port (`local-port`) and also the `vlr-name` that OsmoMSC uses to identify itself
22towards the MME. It should be noted that the `vlr-name` is usually the DNS name
23for the IP address of the VLR/MSC, so IP address used and the `vlr-name` should
24match the DNS server entry.
25
26----
27sgs
28 local-ip 127.0.0.1
29 local-port 29118
30 vlr-name vlr.example.net
31----
32
33In order to fine tune the behavior of the SGs interface the user also has
34control over the relevant timers (`ts5`, `ts6-2`, `ts7`, `ts11`, `ts14`, `ts15`)
35and counters (`ns7`, `ns11`). Each timer and counter has to be configured
36separately. In the following example we change the value of ts and ns11.
37
38----
39sgs
40 timer ts7 23
41 counter ns11 100
42----
43
44
45[NOTE]
46====
47In case multiple instances of OsmoMSC run in parallel, it is advised to use a
48different `vlr-name` for each instance. In any case it must be ensured that the
49SGs interface of each instance is bound to a different IP address and/or port.
50====
51
52=== Connection monitoring
53
54The user can use the VTY command `show sgs-connections` to list the MMEs that
55are currently connected to OsmoMSC.