dexter has uploaded this change for review. (
https://gerrit.osmocom.org/c/osmo-msc/+/34870?usp=email )
Change subject: manuals: add section about the SGs interface.
......................................................................
manuals: add section about the SGs interface.
The SGs interface is currently only casually mentioned in the chapter
running, even though the SGs interface is a prominent and often
requested feature. Let's give the SGs interface its own section so that
users can find the info about it quicker.
Related: OS#6008
Change-Id: Ic7c17511ee19cb7f6d5069b27beb661ecb4b0be8
---
M doc/manuals/chapters/running.adoc
A doc/manuals/chapters/sgs.adoc
M doc/manuals/osmomsc-usermanual.adoc
3 files changed, 70 insertions(+), 9 deletions(-)
git pull ssh://gerrit.osmocom.org:29418/osmo-msc refs/changes/70/34870/1
diff --git a/doc/manuals/chapters/running.adoc
b/doc/manuals/chapters/running.adoc
index 0db5761..1fa5540 100644
--- a/doc/manuals/chapters/running.adoc
+++ b/doc/manuals/chapters/running.adoc
@@ -74,15 +74,8 @@
More on MNCC in <<mncc>>.
-The SGs interface by default listens on 0.0.0.0:29118. Configure a different
IP and/or port for each osmo-msc instance.
-You may also want to configure different VLR names:
-
-----
-sgs
- local-ip 127.0.0.1
- local-port 29118
- vlr-name vlr.example.net
-----
+The SGs interface by default listens on 0.0.0.0:29118 (SCTP). Each instance of
OsmoMSC must use a different IP address
+and/or port. For details about the configuration of the SGs interface, see
section <<sgs>>
For the following links, OsmoMSC acts as a client and does not listen/bind to a
specific interface, and will hence not encounter conflicts for multiple
instances
diff --git a/doc/manuals/chapters/sgs.adoc b/doc/manuals/chapters/sgs.adoc
new file mode 100644
index 0000000..4ce4360
--- /dev/null
+++ b/doc/manuals/chapters/sgs.adoc
@@ -0,0 +1,51 @@
+[[sgs]]
+== SGs interface
+
+OsmoMSC offers an SGs/SGsAP interface. The SGs interface is an optional
+interface between a 2G (GERAN) / 3G (UTRAN) MSC and an LTE/EPC MME. It's
purpose
+is to facilitate both CSFB (Circuit-Switched Fall Back) and SMSoS (SMS over
SGs).
+It is used for Mobility management (MM) and paging procedures between the EPS
+(Evolved Packet Services) and CS (Circuit Switched) domain.
+
+=== VTY configuration
+
+The SGs interface implementation in OsmoMSC is automatically active and
requires
+only minimal configuration. When no specific configuration is provided OsmoMSC
+will listen on 0.0.0.0:29118 (SCTP) for incoming connections.
+
+This is sufficient in the most configurations, but in larger installations,
+where services are either tied to specific interfaces and/or more instances of
+OsmoMSC run in parallel, a custom configuration is necessary.
+
+The user has the option to configure the IP address and the SCTP port and also
+the vlr-name that OsmoMSC uses to identify itself towards the MME.
+
+----
+sgs
+ local-ip 127.0.0.1
+ local-port 29118
+ vlr-name vlr.example.net
+----
+
+In order to fine tune the behavior of the SGs interface the user also has
+control over the relevant timers (ts5, ts6-2, ts7, ts11, ts14, ts15) and
+counters (ns7, ns11). Each timer and counter has to be configured separately.
+In the following example we change the value of ts and ns11.
+
+----
+sgs
+ timer ts7 23
+ counter ns11 100
+----
+
+
+[NOTE]
+====
+In case multiple instances of OsmoMSC run in parallel, it is advised to use a
+different vlr-name for each instance.
+====
+
+=== Connection monitoring
+
+The user can use the VTY command "show sgs-connections" to list the MMEs that
+are currently connected to OsmoMSC
diff --git a/doc/manuals/osmomsc-usermanual.adoc
b/doc/manuals/osmomsc-usermanual.adoc
index ad55e53..45be140 100644
--- a/doc/manuals/osmomsc-usermanual.adoc
+++ b/doc/manuals/osmomsc-usermanual.adoc
@@ -38,6 +38,8 @@
include::./common/chapters/mgwpool.adoc[]
+include::{srcdir}/chapters/sgs.adoc[]
+
include::./common/chapters/control_if.adoc[]
include::./common/chapters/gsup.adoc[]
--
To view, visit https://gerrit.osmocom.org/c/osmo-msc/+/34870?usp=email
To unsubscribe, or for help writing mail filters, visit
https://gerrit.osmocom.org/settings
Gerrit-Project: osmo-msc
Gerrit-Branch: master
Gerrit-Change-Id: Ic7c17511ee19cb7f6d5069b27beb661ecb4b0be8
Gerrit-Change-Number: 34870
Gerrit-PatchSet: 1
Gerrit-Owner: dexter <pma...@sysmocom.de>
Gerrit-MessageType: newchange
