aboutsummaryrefslogtreecommitdiffstats
path: root/doc/manuals/chapters/control.adoc
diff options
context:
space:
mode:
authorOliver Smith <osmith@sysmocom.de>2018-10-31 14:52:31 +0100
committerOliver Smith <osmith@sysmocom.de>2018-11-16 15:14:04 +0100
commit3e0af16bfd901acffb479cf502ce5235ca2eea3b (patch)
treec04cdcb969e1446a14e4bb25f1275213c128ca0b /doc/manuals/chapters/control.adoc
parentc51609aa5c85dc802823393ee3c37abb734db938 (diff)
move project specific manuals to their own repososmith/move-manuals-to-project-repos
Build manuals when ./configure --enable-manuals is specified. Requires osmo-gsm-manuals to be installed. Related: OS#3385 Depends: I96933dd4dd6cac159847647f1c642215051a9aad (osmo-gsm-manuals) Change-Id: I2f9c27f81940b02414f0e618483bffade72e8cf7
Diffstat (limited to 'doc/manuals/chapters/control.adoc')
-rw-r--r--doc/manuals/chapters/control.adoc31
1 files changed, 31 insertions, 0 deletions
diff --git a/doc/manuals/chapters/control.adoc b/doc/manuals/chapters/control.adoc
new file mode 100644
index 000000000..af03be7df
--- /dev/null
+++ b/doc/manuals/chapters/control.adoc
@@ -0,0 +1,31 @@
+[[control]]
+== 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>>. This section
+describes the CTRL interface variables specific to OsmoMSC.
+
+.Variables available on OsmoMSC's Control interface
+[options="header",width="100%",cols="20%,5%,5%,50%,20%"]
+|===
+|Name|Access|Trap|Value|Comment
+|subscriber-list-active-v1|RO|No||Return list of active subscribers.
+|===
+
+=== subscriber-list-active-v1
+
+Return a list of subscribers that are successfully attached (including full
+successful authentication and ciphering if those are enabled).
+
+The reply comprises of one subscriber per line, of the format
+
+----
+<IMSI>,<MSISDN>\n[<IMSI>,<MSISDN>\n[...]]
+----
+
+For example:
+
+----
+901700000015252,22801
+901700000015253,22802
+----