path: root/doc
diff options
authorMax <msuraev@sysmocom.de>2016-05-04 16:37:36 +0200
committerNeels Hofmeyr <neels@hofmeyr.de>2018-11-27 18:10:00 +0100
commit2b6d272549b0e12b656571b405aa449491b2b043 (patch)
tree981dd9406af8a0d657e0ce2ebdd9df564a38041c /doc
parent5530c91d3db69664c296de41f718cd16ece4d017 (diff)
Add OsmoSGSN control interface description
Diffstat (limited to 'doc')
2 files changed, 25 insertions, 0 deletions
diff --git a/doc/manuals/chapters/control.adoc b/doc/manuals/chapters/control.adoc
new file mode 100644
index 00000000..0f2bfae0
--- /dev/null
+++ b/doc/manuals/chapters/control.adoc
@@ -0,0 +1,23 @@
+== Control interface
+The actual protocol is described in <<common-control-if>>, the variables
+common to all programs using it are described in <<ctrl_common_vars>>. Here we
+describe variables specific to OsmoSGSN.
+.Variables available over control interface
+|subscriber-list-active-v1|RO|No|"<imsi>,<addr>"|See <<subs>> for details.
+=== subscriber-list-active-v1
+Return the list of active subscribers as a concatenated set of pairs "<imsi>",
+"addr" where first element of the pair is subscriber's IMSI and the second
+element (which might be empty) is the subscriber's address. The address value
+might be "none", "invalid" and "PPP" in addition to actual IP address. In case
+of IP address it will be prefixed with "IPv4" or "IPv6" string depending on the
+version of IP protocol.
diff --git a/doc/manuals/osmosgsn-usermanual.adoc b/doc/manuals/osmosgsn-usermanual.adoc
index d532a31d..12a7b875 100644
--- a/doc/manuals/osmosgsn-usermanual.adoc
+++ b/doc/manuals/osmosgsn-usermanual.adoc
@@ -9,6 +9,8 @@ include::chapters/overview.adoc[]