[M] Change in osmo-msc[master]: manuals: add section about the SGs interface.
laforge has submitted this change. (
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, 74 insertions(+), 9 deletions(-)
Approvals:
fixeria: Looks good to me, but someone else must approve
Jenkins Builder: Verified
laforge: Looks good to me, approved
diff --git a/doc/manuals/chapters/running.adoc
b/doc/manuals/chapters/running.adoc
index d6e734b..3041145 100644
--- a/doc/manuals/chapters/running.adoc
+++ b/doc/manuals/chapters/running.adoc
@@ -74,15 +74,8 @@
More on MNCC in <>.
-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 <>.
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 000..1f0240b
--- /dev/null
+++ b/doc/manuals/chapters/sgs.adoc
@@ -0,0 +1,55 @@
+[[sgs]]
+== SGs interface
+
+OsmoMSC offers an SGs interface using the SGsAP protocol. The SGs interface is
an
+optional interface between a 2G (GERAN) / 3G (UTRAN) MSC and an 4G (EUTRAN)
MME.
+Its 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 (`local-ip`) and the SCTP
+port (`local-port`) and also the `vlr-name` that OsmoMSC uses to identify
itself
+towards the MME. It should be noted that the `vlr-name` is usually the DNS name
+for the IP address of the VLR/MSC, so IP address used and the `vlr-name` should
+match the DNS server entry.
+
+
+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. In any case it must be ensured that the
+SGs interface of each instance is bound to a different IP address and/or port.
+
+
+=== 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: 2
Gerrit-Owner: dexter
Gerrit-Reviewer: Jenkins Builder
Gerrit-Reviewer: fixeria
Gerrit-Reviewer: laforge
Gerrit-Reviewer: pespin
Gerrit-MessageType: merged
[M] Change in osmo-msc[master]: manuals: add section about the SGs interface.
Attention is currently required from: dexter, pespin. laforge has posted comments on this change. ( https://gerrit.osmocom.org/c/osmo-msc/+/34870?usp=email ) Change subject: manuals: add section about the SGs interface. .. Patch Set 2: Code-Review+2 -- 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: 2 Gerrit-Owner: dexter Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: fixeria Gerrit-Reviewer: laforge Gerrit-Reviewer: pespin Gerrit-Attention: pespin Gerrit-Attention: dexter Gerrit-Comment-Date: Wed, 01 Nov 2023 16:11:31 + Gerrit-HasComments: No Gerrit-Has-Labels: Yes Gerrit-MessageType: comment
[M] Change in osmo-msc[master]: manuals: add section about the SGs interface.
Attention is currently required from: dexter, laforge, pespin. fixeria has posted comments on this change. ( https://gerrit.osmocom.org/c/osmo-msc/+/34870?usp=email ) Change subject: manuals: add section about the SGs interface. .. Patch Set 2: Code-Review+1 -- 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: 2 Gerrit-Owner: dexter Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: fixeria Gerrit-Reviewer: laforge Gerrit-Reviewer: pespin Gerrit-Attention: laforge Gerrit-Attention: pespin Gerrit-Attention: dexter Gerrit-Comment-Date: Tue, 31 Oct 2023 05:23:13 + Gerrit-HasComments: No Gerrit-Has-Labels: Yes Gerrit-MessageType: comment
[M] Change in osmo-msc[master]: manuals: add section about the SGs interface.
Attention is currently required from: fixeria, laforge, pespin. Hello Jenkins Builder, laforge, pespin, I'd like you to reexamine a change. Please visit https://gerrit.osmocom.org/c/osmo-msc/+/34870?usp=email to look at the new patch set (#2). The following approvals got outdated and were removed: Verified+1 by Jenkins Builder 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, 74 insertions(+), 9 deletions(-) git pull ssh://gerrit.osmocom.org:29418/osmo-msc refs/changes/70/34870/2 -- 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: 2 Gerrit-Owner: dexter Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: laforge Gerrit-Reviewer: pespin Gerrit-CC: fixeria Gerrit-Attention: laforge Gerrit-Attention: fixeria Gerrit-Attention: pespin Gerrit-MessageType: newpatchset
[M] Change in osmo-msc[master]: manuals: add section about the SGs interface.
Attention is currently required from: fixeria, laforge, pespin. dexter has posted comments on this change. ( https://gerrit.osmocom.org/c/osmo-msc/+/34870?usp=email ) Change subject: manuals: add section about the SGs interface. .. Patch Set 2: (8 comments) File doc/manuals/chapters/running.adoc: https://gerrit.osmocom.org/c/osmo-msc/+/34870/comment/a037315a_b956a4a5 PS1, Line 78: see section <> > missing dot at the end of sentence Done File doc/manuals/chapters/sgs.adoc: https://gerrit.osmocom.org/c/osmo-msc/+/34870/comment/83f29025_38b439ef PS1, Line 4: SGs/SGsAP > The interface is called SGs. The application layer protocol for it is SGsAP. > […] Done https://gerrit.osmocom.org/c/osmo-msc/+/34870/comment/e171c93d_a0f533e9 PS1, Line 5: It's > Its (not it is) Done https://gerrit.osmocom.org/c/osmo-msc/+/34870/comment/cfb3ca28_94bbe224 PS1, Line 5: LTE/EPC > you used "2G (GERAN)" before, then here it would make sense to use the same > format e.g. […] Done https://gerrit.osmocom.org/c/osmo-msc/+/34870/comment/c23f7cbe_8ae98588 PS1, Line 31: ts5, ts6-2, ts7, ts11, ts14, ts15 > cosmetic: use \` text \` for `highlighting` Done https://gerrit.osmocom.org/c/osmo-msc/+/34870/comment/250a3f51_773352b6 PS1, Line 44: In case multiple instances of OsmoMSC run in parallel, it is advised to use a : different vlr-name for each instance > you might want to add that they of course need to be bound to different IP > addresses. […] Done https://gerrit.osmocom.org/c/osmo-msc/+/34870/comment/82cf4c4f_5dabfcfb PS1, Line 50: show sgs-connections > cosmetic: use \` text \` for `highlighting` Done https://gerrit.osmocom.org/c/osmo-msc/+/34870/comment/b24dab01_3efe3f9b PS1, Line 51: OsmoMSC > missing dot Done -- 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: 2 Gerrit-Owner: dexter Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: laforge Gerrit-Reviewer: pespin Gerrit-CC: fixeria Gerrit-Attention: laforge Gerrit-Attention: fixeria Gerrit-Attention: pespin Gerrit-Comment-Date: Mon, 30 Oct 2023 16:51:51 + Gerrit-HasComments: Yes Gerrit-Has-Labels: No Comment-In-Reply-To: laforge Comment-In-Reply-To: fixeria Gerrit-MessageType: comment
[M] Change in osmo-msc[master]: manuals: add section about the SGs interface.
Attention is currently required from: dexter, pespin. fixeria has posted comments on this change. ( https://gerrit.osmocom.org/c/osmo-msc/+/34870?usp=email ) Change subject: manuals: add section about the SGs interface. .. Patch Set 1: (5 comments) File doc/manuals/chapters/running.adoc: https://gerrit.osmocom.org/c/osmo-msc/+/34870/comment/39c9ce3f_49db50ec PS1, Line 78: see section <> missing dot at the end of sentence File doc/manuals/chapters/sgs.adoc: https://gerrit.osmocom.org/c/osmo-msc/+/34870/comment/197f15aa_7a614d0b PS1, Line 5: It's Its (not it is) https://gerrit.osmocom.org/c/osmo-msc/+/34870/comment/bf031fab_4426e89d PS1, Line 31: ts5, ts6-2, ts7, ts11, ts14, ts15 cosmetic: use \` text \` for `highlighting` https://gerrit.osmocom.org/c/osmo-msc/+/34870/comment/92ec4377_526ea070 PS1, Line 50: show sgs-connections cosmetic: use \` text \` for `highlighting` https://gerrit.osmocom.org/c/osmo-msc/+/34870/comment/cc441d2b_84506370 PS1, Line 51: OsmoMSC missing dot -- 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 Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: laforge Gerrit-Reviewer: pespin Gerrit-CC: fixeria Gerrit-Attention: pespin Gerrit-Attention: dexter Gerrit-Comment-Date: Mon, 23 Oct 2023 16:22:39 + Gerrit-HasComments: Yes Gerrit-Has-Labels: No Gerrit-MessageType: comment
[M] Change in osmo-msc[master]: manuals: add section about the SGs interface.
Attention is currently required from: dexter, pespin. laforge has posted comments on this change. ( https://gerrit.osmocom.org/c/osmo-msc/+/34870?usp=email ) Change subject: manuals: add section about the SGs interface. .. Patch Set 1: (3 comments) File doc/manuals/chapters/sgs.adoc: https://gerrit.osmocom.org/c/osmo-msc/+/34870/comment/f66de8d8_e1f96e55 PS1, Line 4: SGs/SGsAP The interface is called SGs. The application layer protocol for it is SGsAP. SO if you want to mention both and stay correct, you'd have to phrase it like "offers a SGs interface using the SGsAP protocol" or the like. https://gerrit.osmocom.org/c/osmo-msc/+/34870/comment/4794f557_2275e5d8 PS1, Line 5: LTE/EPC you used "2G (GERAN)" before, then here it would make sense to use the same format e.g. "4G (EUTRAN)" or if needed "4G (EUTRAN/LTE)" https://gerrit.osmocom.org/c/osmo-msc/+/34870/comment/861d2b51_9da779e3 PS1, Line 44: In case multiple instances of OsmoMSC run in parallel, it is advised to use a : different vlr-name for each instance you might want to add that they of course need to be bound to different IP addresses. btw: the vlr-name is usually the DNS name for the IP address of that VLR/MSC, so they should agree. -- 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 Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: laforge Gerrit-Reviewer: pespin Gerrit-Attention: pespin Gerrit-Attention: dexter Gerrit-Comment-Date: Mon, 23 Oct 2023 16:07:01 + Gerrit-HasComments: Yes Gerrit-Has-Labels: No Gerrit-MessageType: comment
[M] Change in osmo-msc[master]: manuals: add section about the SGs interface.
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 <>.
-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 <>
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 000..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
Gerrit-MessageType: newchange
