From 8c8ebb13b6d8a16ebb0771079f011c54c4de4bf4 Mon Sep 17 00:00:00 2001 From: Neels Hofmeyr Date: Mon, 18 Sep 2017 16:19:30 +0200 Subject: add OsmoMSC manual Add OsmoMSC and OsmoHLR to bibliography (even though the OsmoHLR manual does not yet exist, a reference to it has been added in OsmoMSC's manual). Change-Id: I9ecff2837fbf5fdc19675a726f6d70c21eb178ee --- doc/manuals/Makefile | 42 + doc/manuals/chapters/control.adoc | 31 + doc/manuals/chapters/net.adoc | 154 ++ doc/manuals/chapters/overview.adoc | 127 ++ doc/manuals/chapters/running.adoc | 148 ++ doc/manuals/osmomsc-usermanual-docinfo.xml | 47 + doc/manuals/osmomsc-usermanual.adoc | 36 + doc/manuals/osmomsc-vty-reference.xml | 38 + doc/manuals/vty/msc_vty_additions.xml | 24 + doc/manuals/vty/msc_vty_reference.xml | 3019 ++++++++++++++++++++++++++++ 10 files changed, 3666 insertions(+) create mode 100644 doc/manuals/Makefile create mode 100644 doc/manuals/chapters/control.adoc create mode 100644 doc/manuals/chapters/net.adoc create mode 100644 doc/manuals/chapters/overview.adoc create mode 100644 doc/manuals/chapters/running.adoc create mode 100644 doc/manuals/osmomsc-usermanual-docinfo.xml create mode 100644 doc/manuals/osmomsc-usermanual.adoc create mode 100644 doc/manuals/osmomsc-vty-reference.xml create mode 100644 doc/manuals/vty/msc_vty_additions.xml create mode 100644 doc/manuals/vty/msc_vty_reference.xml (limited to 'doc') diff --git a/doc/manuals/Makefile b/doc/manuals/Makefile new file mode 100644 index 000000000..febf7d1f5 --- /dev/null +++ b/doc/manuals/Makefile @@ -0,0 +1,42 @@ +# XSL stylesheets downloaded from http://docbook.sourceforge.net/release/xsl/current/html/ +# Makefile from BitBake/OpenEmbedded manuals + +topdir = . +msc_reference = $(topdir)/osmomsc-vty-reference.xml +manuals = $(msc_reference) +# types = pdf txt rtf ps xhtml html man tex texi dvi +# types = pdf txt +types = $(docbooktotypes) +docbooktotypes = pdf +# htmlcssfile = +# htmlcss = + +TOPDIR := .. +ASCIIDOCS := osmomsc-usermanual + +include $(TOPDIR)/build/Makefile.asciidoc.inc +include $(TOPDIR)/build/Makefile.inc + +osmomsc-usermanual.pdf: chapters/*.adoc generated/docbook_vty.xml + +clean: + -rm -rf $(cleanfiles) + -rm osmomsc-usermanual__*.svg + -rm osmomsc-usermanual__*.png + -rm osmomsc-usermanual.check + +generated/docbook_vty.xml: osmomsc-vty-reference.xml vty/*xml ../common/vty_additions.xml ../vty_reference.xsl + $(call command,xsltproc -o generated/combined1.xml \ + --stringparam with $(PWD)/../common/vty_additions.xml \ + $(MERGE_DOC) vty/msc_vty_reference.xml, \ + XSLTPROC,Merging Common VTY) + $(call command,xsltproc -o generated/combined2.xml \ + --stringparam with $(PWD)/../common/bsc_vty_additions.xml \ + $(MERGE_DOC) generated/combined1.xml, \ + XSLTPROC,Merging Common BSC VTY) + $(call command,xsltproc -o generated/combined3.xml \ + --stringparam with $(PWD)/vty/msc_vty_additions.xml \ + $(MERGE_DOC) generated/combined2.xml, \ + XSLTPROC,Merging MSC VTY) + $(call command,xsltproc ../vty_reference.xsl generated/combined3.xml > generated/docbook_vty.xml, \ + XSLTPROC,Converting MSC VTY to DocBook) 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 <>, the variables common +to all programs using it are described in <>. 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 + +---- +,\n[,\n[...]] +---- + +For example: + +---- +901700000015252,22801 +901700000015253,22802 +---- diff --git a/doc/manuals/chapters/net.adoc b/doc/manuals/chapters/net.adoc new file mode 100644 index 000000000..06be4bad2 --- /dev/null +++ b/doc/manuals/chapters/net.adoc @@ -0,0 +1,154 @@ +[[net]] +== Configuring the Core Network + +The core network parameters are configured by the config file (as in `osmo-msc +-c osmo-msc.cfg`). The config file is parsed by the VTY, which is also +available via telnet in the running `osmo-msc` instance. Be aware that even +though you may be able to change these parameters without restarting +`osmo-msc`, some may not take immediate effect, and it is safest to use the +config file to have these parameters set at startup time. + +The core network parameters are found in the `config` / `network`. + +A full reference to the available commands can be found in the _OsmoMSC VTY +reference manual_ <>. This section describes only the most +commonly used settings. + +Here is an overview of the config items, described in more detail below: + +---- +network + network country code 262 + mobile network code 89 + mm info 1 + short name OsmoMSC + long name OsmoMSC + authentication required + encryption a5 3 +---- + +[TIP] +==== +Use the telnet VTY interface to query the current configuration of a running +`osmo-msc` process: + +---- +$ telnet localhost 4254 +OsmoMSC> enable +OsmoMSC# show running-config +---- + +Some parameters may be changed without restarting `osmo-msc`. To reach the +`network` node, enter: + +---- +OsmoMSC> enable +OsmoMSC# configure terminal +OsmoMSC(config)# network +OsmoMSC(config-net)# short name Example-Name +OsmoMSC(config-net)# exit +OsmoMSC(config)# +---- + +The telnet VTY features tab-completion as well as context sensitive help shown +when entering a `?` question mark. + +You can always use the `list` VTY command or enter `?` on the blank prompt to +get a list of all possible commands at the current node. +==== + + +=== MCC/MNC + +The key identities of every GSM PLMN is the Mobile Country Code and the Mobile +Network Code. They are identical over the entire network. In most cases, the +MCC/MNC will be allocated to the operator by the respective local regulatory +authority. For example, to set the MCC/MNC of 262-89, have this in your +osmo-msc.cfg: + +---- +network + network country code 262 + mobile network code 89 +---- + + +=== Configuring MM INFO + +The _MM INFO_ procedure can be used after a successful _LOCATION UPDATE_ in +order to transmit the human-readable network name as well as local time zone +information to the MS. By default, _MM INFO_ is not active, i.e. `0`. Set to `1` +to activate this feature: + +---- +network + mm info 1 + short name OsmoMSC + long name OsmoMSC +---- + +[NOTE] +==== +Not all phones support the MM INFO procedure. If a phone is not +factory-programmed to contain the name for your MCC/MNC, it will likely only +provide a numeric display of the network name, such as _262-89_, or show the +country code transformed into a letter, such as _D 89_. +==== + +The time information transmitted is determined by the local system time of the +operating system on which OsmoMSC is running. + + +=== Authentication + +Authorized subscribers must be entered in the HLR database, see the _OsmoHLR +reference manual_ <>. If authentication tokens (such as KI for +2G, or K and OP/OPC for UMTS) are present in the HLR, OsmoMSC will only attach +a subscriber after successful authentication. + +If no authentication keys are present in the HLR for a given subscriber, +OsmoMSC will attach the subscriber _without_ authentication. You can reject +subscribers that lack authentication info in the HLR with this setting: + +---- +network + authentication required +---- + +=== Ciphering + +To enable ciphering on the radio link, authentication must take place first: +the Kc resulting from authentication is the key used for ciphering. Hence, all +subscribers must have authentication tokens available in the HLR for ciphering. + +The MS, BTS and MSC must agree on a ciphering algorithm to use. + +- The MS sends its supported ciphering algorithms via Classmark IEs during + Location Updating. +- Typically the BSC needs to know which A5 ciphers are supported by connected + BTSes. +- Finally, OsmoMSC may impose that specific A5 ciphers shall not be considered. + +It is the responsibility of the BSC to then pick an A5 cipher that satisfies +all requirements. + +- In OsmoMSC, A5/0 means that ciphering is turned off. ++ +---- +network + encryption a5 0 +---- + +- A5/1 and A5/3 are currently supported by Osmocom. ++ +---- +network + encryption a5 3 +---- + +- Never use A5/2: it is an "export grade cipher" and has been deprecated for + its low ciphering strength. + +NOTE: At the time of writing, OsmoMSC supports setting only a single A5 cipher, +while it should be able to allow a set of ciphers. This is subject to ongoing +development. diff --git a/doc/manuals/chapters/overview.adoc b/doc/manuals/chapters/overview.adoc new file mode 100644 index 000000000..0bb47d72d --- /dev/null +++ b/doc/manuals/chapters/overview.adoc @@ -0,0 +1,127 @@ +[[overview]] +== Overview + +This manual should help you getting started with OsmoMSC. It will cover +aspects of configuring and running the OsmoMSC. + +[[intro_overview]] +=== About OsmoMSC + +OsmoMSC is the Osmocom implementation of a Mobile Switching Center (MSC) for 2G +and 3G GSM and UMTS mobile networks. Its interfaces are: + +- GSUP towards OsmoHLR (or a MAP proxy); +- A over IP towards a BSC (e.g. OsmoBSC); +- IuCS towards an RNC or HNB-GW (e.g. OsmoHNBGW) for 3G voice; +- MNCC (Mobile Network Call Control derived from GSM TS 04.07); +- SMPP 3.4 (Short Message Peer-to-Peer); +- The Osmocom typical telnet VTY and CTRL interfaces. + +OsmoMSC originated from the OpenBSC project, which started as a minimalistic +all-in-one implementation of the GSM Network. In 2017, OpenBSC had reached +maturity and diversity (including M3UA SIGTRAN and 3G support in the form of +IuCS and IuPS interfaces) that naturally lead to a separation of the all-in-one +approach to fully independent separate programs as in typical GSM networks. +Before it was split off, OsmoMSC originated from libmsc of the old openbsc.git. +Since a true _A_ interface and IuCS for 3G support is available, OsmoMSC +exists only as a separate standalone entity. + +Key differences of the new OsmoMSC compared to the old OsmoNITB are: + +- The complete VLR implementation that communicates with the separate HLR + (OsmoHLR) for subscriber management. In contrast to the OsmoNITB, HLR queries + are fully asynchronous, and the separate HLR allows using centralized + subscriber management for both circuit-switched and packet-switched domains + (i.e. one OsmoHLR for both OsmoMSC and OsmoSGSN). + +- VLR and HLR brought full UMTS AKA (Authentication and Key Agreement) support, + i.e. Milenage authentication in both the full 3G variant as well as the + backwards compatible 2G variant. + +- Addition of a true _A_ interface for 2G voice services. Previously, OsmoBSC + had an SCCPlite based _A_ interface towards 3rd party MSC implementations. + OsmoMSC features a true SCCP/M3UA _A_ interface, which allows running OsmoBSC + against this Osmocom based MSC implementation. The new SCCP/M3UA SIGTRAN for + the _A_ interface is implemented in libosmo-sccp, which is used by OsmoMSC + and OsmoBSC (and others), to establish a link via an STP (e.g. OsmoSTP). + +- Addition of an _IuCS_ interface to allow operating 3G voice services, also + via SCCP/M3UA SIGTRAN, for example connecting via OsmoHNBGW to a 3G small + cell device. + +Find the OsmoMSC issue tracker and wiki online at + +- https://osmocom.org/projects/osmomsc +- https://osmocom.org/projects/osmomsc/wiki + + +[[fig-gsm]] +.Typical GSM network architecture used with OsmoMSC +[graphviz] +---- +digraph G { + rankdir=LR; + MS0 [label="MS"] + MS1 [label="MS"] + MS2 [label="MS"] + MS3 [label="MS"] + UE0 [label="UE"] + UE1 [label="UE"] + BTS0 [label="BTS"] + BTS1 [label="BTS"] + STP [label="STP\n(SCCP routing)"] + HLR [label="HLR+AUC+EIR"] + HNB [label="RNC or hNodeB"] + MGW + MS0->BTS0 [label="Um"] + MS1->BTS0 [label="Um"] + MS2->BTS1 [label="Um"] + MS3->BTS1 [label="Um"] + UE0->HNB + UE1->HNB + BTS0->BSC [label="Abis"] + BTS1->BSC [label="Abis"] + BSC->STP [label="A/SCCP/M3UA"] + STP->MSC [label="A/SCCP/M3UA"] + STP->MSC [label="IuCS/SCCP/M3UA"] + VLR->HLR [label="GSUP"] + HNB->HNBGW [label="Iuh"] + HNBGW->STP [label="IuCS/SCCP/M3UA"] + MSC->MGW [label="MGCP"] + BTS0->MGW [label="RTP"] + BTS1->MGW [label="RTP"] + subgraph cluster_msc { + label = "OsmoMSC"; + MSC->SMSC; + MSC->VLR + } +} +---- + + +=== Software Components + +This is a brief description of OsmoMSC's internal software components. + +==== SMSC + +A minimal store-and-forward server for SMS, supporting both MO and MT +SMS service, as well as multi-part messages. + +The built-in SMSC also supports an external SMSC interface. For more +information, see <>. + +==== MSC + +The MSC component implements the mobility management (MM) functions of the TS +04.08 and delegates to SMSC for SMS message handling and the VLR for subscriber +management. + +Furthermore, it can handle TS 04.08 Call Control (CC), either by use of +an internal MNCC handler, or by use of an external MNCC agent. For more +information see <>. + +==== VLR + +A fully featured Visitor Location Register handles the subscriber management +and authentication, and interfaces via GSUP to the external HLR. diff --git a/doc/manuals/chapters/running.adoc b/doc/manuals/chapters/running.adoc new file mode 100644 index 000000000..5925e02ea --- /dev/null +++ b/doc/manuals/chapters/running.adoc @@ -0,0 +1,148 @@ +== Running OsmoMSC + +The OsmoMSC executable (`osmo-msc`) offers the following command-line +arguments: + +=== SYNOPSIS + +*osmo-msc* [-h|-V] [-d 'DBGMASK'] [-D] [-c 'CONFIGFILE'] [-s] [-T] [-e 'LOGLEVEL'] [-l 'DATABASE'] [-M 'SOCKETPATH'] [-C] + +=== OPTIONS + +*-h, --help*:: + Print a short help message about the supported options +*-V, --version*:: + Print the compile-time version number of the OsmoBTS program +*-d, --debug 'DBGMASK','DBGLEVELS'*:: + Set the log subsystems and levels for logging to stderr. This + has mostly been superseded by VTY-based logging configuration, + see <> for further information. +*-D, --daemonize*:: + Fork the process as a daemon into background. +*-c, --config-file 'CONFIGFILE'*:: + Specify the file and path name of the configuration file to be + used. If none is specified, use `openbsc.cfg` in the current + working directory. +*-s, --disable-color*:: + Disable colors for logging to stderr. This has mostly been + deprecated by VTY based logging configuration, see <> + for more information. +*-T, --timestamp*:: + Enable time-stamping of log messages to stderr. This has mostly + been deprecated by VTY based logging configuration, see + <> for more information. +*-e, --log-level 'LOGLEVEL'*:: + Set the global log level for logging to stderr. This has mostly + been deprecated by VTY based logging configuration, see + <> for more information. +*-l, --database 'DATABASE'*:: + Specify the file name of the SQLite3 database to use as SMS storage +*-M, --mncc-sock-path*:: + Enable the MNCC socket for an external MNCC handler. See + <> for further information. +*-m, --mncc-sock*:: + Same as option -M (deprecated). +*-C, --no-dbcounter*:: + Disable the regular periodic synchronization of statistics + counters to the database. + + +=== Multiple instances + +Running multiple instances of `osmo-msc` is possible if all interfaces (VTY, +CTRL) are separated using the appropriate configuration options. The IP based +interfaces are binding to local host by default. In order to separate the +processes, the user has to bind those services to specific but different IP +addresses. + +The VTY and the Control interface can be bound to IP addresses from the loopback +address range, for example: + +---- +line vty + bind 127.0.0.2 +ctrl + bind 127.0.0.2 +---- + +If external SMPP is enabled, you may bind it to a different interface using: + +---- +smpp + local-tcp-ip 10.23.42.1 2775 +---- + +More on SMPP configuration in <>. + +The external MNCC handler is configured by the `--mncc-sock` commandline +argument. Choose a different such socket path for each OsmoMSC instance running +on the same file system. See more in <>. + +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 +running on the same interface: + +- The SCCP/M3UA links are established by OsmoMSC contacting an STP. +- The GSUP link is established by OsmoMSC contacting an HLR. + + +=== Configure primary links + +==== Configure SCCP/M3UA to accept _A_ and _IuCS_ links + +OsmoMSC will contact an STP instance to establish an SCCP/M3UA link. BSC and +HNBGW will then reach the MSC via this link. By default, an STP instance is +assumed to listen on the default M3UA port (2905) on the local host. + +Establishing an SCCP/M3UA link towards an STP instance not on the local host +can be configured as follows: + +---- +cs7 instance 0 + asp my-OsmoMSC 2905 0 m3ua + ! IP address of the remote STP: + remote-ip 10.23.24.1 +---- + +Note that _A_ and _IuCS_ may use different SCCP instances, if so desired: + +---- +cs7 instance 0 + asp my-OsmoMSC-A 2905 0 m3ua + remote-ip 10.23.42.1 +cs7 instance 1 + asp my-OsmoMSC-Iu 2905 0 m3ua + remote-ip 10.23.42.2 +msc + cs7-instance-a 0 + cs7-instance-iu 1 +---- + +A full configuration needs an `asp` on an `as` -- an Application Server Process +running on an Application Server -- as well as a local point code and routing +configuration. The SCCP VTY automatically creates those parts that are missing, +by assuming sane defaults. A complete configuration would look like this: + +---- +cs7 instance 0 + point-code 0.23.1 + asp my-OsmoMSC-A-Iu 2905 0 m3ua + remote-ip 127.0.0.1 + as my-as-for-OsmoMSC-A-Iu m3ua + asp my-OsmoMSC-A-Iu + routing-key 0 0.23.1 +---- + +==== Configure GSUP to reach the HLR + +OsmoMSC will assume a GSUP server (OsmoHLR) to run on the local host and the +default GSUP port (4222). Contacting an HLR at a different IP address can be +configured as follows: + +---- +hlr + ! IP address of the remote HLR: + remote-ip 10.23.42.1 + ! default port is 4222, optionally configurable by: + remote-port 1234 +---- diff --git a/doc/manuals/osmomsc-usermanual-docinfo.xml b/doc/manuals/osmomsc-usermanual-docinfo.xml new file mode 100644 index 000000000..d99bba7c8 --- /dev/null +++ b/doc/manuals/osmomsc-usermanual-docinfo.xml @@ -0,0 +1,47 @@ + + + 1 + September 18th, 2017 + NH + + Initial version; based on OsmoNITB manual version 2. + + + + + + + Neels + Hofmeyr + nhofmeyr@sysmocom.de + NH + + sysmocom + sysmocom - s.f.m.c. GmbH + Senior Developer + + + + + + 2017 + sysmocom - s.f.m.c. GmbH + + + + + Permission is granted to copy, distribute and/or modify this + document under the terms of the GNU Free Documentation License, + Version 1.3 or any later version published by the Free Software + Foundation; with the Invariant Sections being just 'Foreword', + 'Acknowledgements' and 'Preface', with no Front-Cover Texts, + and no Back-Cover Texts. A copy of the license is included in + the section entitled "GNU Free Documentation License". + + + The Asciidoc source code of this manual can be found at + + http://git.osmocom.org/osmo-gsm-manuals/ + + + diff --git a/doc/manuals/osmomsc-usermanual.adoc b/doc/manuals/osmomsc-usermanual.adoc new file mode 100644 index 000000000..7c200200a --- /dev/null +++ b/doc/manuals/osmomsc-usermanual.adoc @@ -0,0 +1,36 @@ +:gfdl-enabled: +:program-name: OsmoMSC + +OsmoMSC User Manual +==================== +Neels Hofmeyr + + +include::../common/chapters/preface.adoc[] + +include::chapters/overview.adoc[] + +include::chapters/running.adoc[] + +include::chapters/control.adoc[] + +include::../common/chapters/vty.adoc[] + +include::../common/chapters/logging.adoc[] + +include::chapters/net.adoc[] + +include::../common/chapters/smpp.adoc[] + +include::../common/chapters/mncc.adoc[] + +include::../common/chapters/control_if.adoc[] + +include::../common/chapters/port_numbers.adoc[] + +include::../common/chapters/bibliography.adoc[] + +include::../common/chapters/glossary.adoc[] + +include::../common/chapters/gfdl.adoc[] + diff --git a/doc/manuals/osmomsc-vty-reference.xml b/doc/manuals/osmomsc-vty-reference.xml new file mode 100644 index 000000000..a954b843b --- /dev/null +++ b/doc/manuals/osmomsc-vty-reference.xml @@ -0,0 +1,38 @@ + + + + +]> + + + + + + v1 + 18th September 2017 + nh + Initial + + + + OsmoMSC VTY Reference + + + 2017 + + + + This work is copyright by sysmocom - s.f.m.c. GmbH. All rights reserved. + + + + + + &chapter-vty; + + diff --git a/doc/manuals/vty/msc_vty_additions.xml b/doc/manuals/vty/msc_vty_additions.xml new file mode 100644 index 000000000..0d473bd60 --- /dev/null +++ b/doc/manuals/vty/msc_vty_additions.xml @@ -0,0 +1,24 @@ + + + + MNCC Internal Configuration + This node allows to configure the default codecs for + the internal call control handling. + + + + SMPP Configuration + This node allows to configure the SMPP interface + for interfacing with external SMS applications. This section + contains generic/common SMPP related configuration, and no + per-ESME specific parameters. + + + + ESME Configuration + This node allows to configure one particular SMPP + ESME, which is an External SMS Entity such as a SMS based + application server. You can define any number of ESME within + the SMPP node of the OsmoNITB VTY. + + diff --git a/doc/manuals/vty/msc_vty_reference.xml b/doc/manuals/vty/msc_vty_reference.xml new file mode 100644 index 000000000..b7311ab11 --- /dev/null +++ b/doc/manuals/vty/msc_vty_reference.xml @@ -0,0 +1,3019 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file -- cgit v1.2.3 From fee9dd7902b1ae7163705b5390f3e626cf3160bf Mon Sep 17 00:00:00 2001 From: Neels Hofmeyr Date: Mon, 25 Sep 2017 16:37:34 +0200 Subject: add OsmoHLR manual, OsmoHLR VTY reference Change-Id: Ieb6a362a26a7e65199f68f5cd32d9b6b0e5d0fbf --- doc/manuals/chapters/running.adoc | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'doc') diff --git a/doc/manuals/chapters/running.adoc b/doc/manuals/chapters/running.adoc index 5925e02ea..8656a586b 100644 --- a/doc/manuals/chapters/running.adoc +++ b/doc/manuals/chapters/running.adoc @@ -49,11 +49,11 @@ arguments: === Multiple instances -Running multiple instances of `osmo-msc` is possible if all interfaces (VTY, -CTRL) are separated using the appropriate configuration options. The IP based -interfaces are binding to local host by default. In order to separate the -processes, the user has to bind those services to specific but different IP -addresses. +Running multiple instances of `osmo-msc` on the same computer is possible if all +interfaces (VTY, CTRL) are separated using the appropriate configuration +options. The IP based interfaces are binding to local host by default. In order +to separate the processes, the user has to bind those services to specific but +different IP addresses and/or ports. The VTY and the Control interface can be bound to IP addresses from the loopback address range, for example: -- cgit v1.2.3 From adfbd3b8d65cedc19ebfa6a1718699cb9aba753f Mon Sep 17 00:00:00 2001 From: Neels Hofmeyr Date: Thu, 19 Oct 2017 05:11:57 +0200 Subject: refactor Makefile build rules, don't use the FORCE The initial goal was to make sure we don't have overall FORCE rules causing unnecessary rebuilds -- annoying while writing documentation. As I looked through possible dependencies, I finally understood what's going on here. Remove code dup and nicely sort which belongs where in build/Makefile.*.inc. In each, describe in a top comment how to use it, and also unify how they are used: - Rename Makefile.inc to Makefile.docbook.inc and refactor - Add Makefile.vty-reference.inc - Add Makefile.common.inc Make sure that we accurately pick up all dependencies. Drop use of the macro called 'command', that silenced the actual command lines invoked and replaced them with short strings: it obscures what is actually going on and makes the Makefiles hard to read and understand. Each manual's makefile is greatly reduced to few definitions and a Makefile include, e.g. one for asciidoc, one for VTY reference. Move common/bsc_vty_additions.xml to OsmoBSC/vty/libbsc_vty_additions.xml, link from OsmoNITB. It applies only to OsmoBSC and OsmoNITB. Add a script that combines a VTY reference file with *all* additions files found in a manual's vty/ dir. Call this from Makefile.vty-reference.inc. Change-Id: I9758e04162a480e28c7dc83475b514cf7fd25ec0 --- doc/manuals/Makefile | 44 ++++++-------------------------------------- 1 file changed, 6 insertions(+), 38 deletions(-) (limited to 'doc') diff --git a/doc/manuals/Makefile b/doc/manuals/Makefile index febf7d1f5..c9edcef7f 100644 --- a/doc/manuals/Makefile +++ b/doc/manuals/Makefile @@ -1,42 +1,10 @@ -# XSL stylesheets downloaded from http://docbook.sourceforge.net/release/xsl/current/html/ -# Makefile from BitBake/OpenEmbedded manuals - -topdir = . -msc_reference = $(topdir)/osmomsc-vty-reference.xml -manuals = $(msc_reference) -# types = pdf txt rtf ps xhtml html man tex texi dvi -# types = pdf txt -types = $(docbooktotypes) -docbooktotypes = pdf -# htmlcssfile = -# htmlcss = - -TOPDIR := .. -ASCIIDOCS := osmomsc-usermanual +TOPDIR = .. +ASCIIDOC = osmomsc-usermanual.adoc +ASCIIDOC_DEPS = chapters/*.adoc include $(TOPDIR)/build/Makefile.asciidoc.inc -include $(TOPDIR)/build/Makefile.inc - -osmomsc-usermanual.pdf: chapters/*.adoc generated/docbook_vty.xml -clean: - -rm -rf $(cleanfiles) - -rm osmomsc-usermanual__*.svg - -rm osmomsc-usermanual__*.png - -rm osmomsc-usermanual.check +VTY_REFERENCE = osmomsc-vty-reference.xml +include $(TOPDIR)/build/Makefile.vty-reference.inc -generated/docbook_vty.xml: osmomsc-vty-reference.xml vty/*xml ../common/vty_additions.xml ../vty_reference.xsl - $(call command,xsltproc -o generated/combined1.xml \ - --stringparam with $(PWD)/../common/vty_additions.xml \ - $(MERGE_DOC) vty/msc_vty_reference.xml, \ - XSLTPROC,Merging Common VTY) - $(call command,xsltproc -o generated/combined2.xml \ - --stringparam with $(PWD)/../common/bsc_vty_additions.xml \ - $(MERGE_DOC) generated/combined1.xml, \ - XSLTPROC,Merging Common BSC VTY) - $(call command,xsltproc -o generated/combined3.xml \ - --stringparam with $(PWD)/vty/msc_vty_additions.xml \ - $(MERGE_DOC) generated/combined2.xml, \ - XSLTPROC,Merging MSC VTY) - $(call command,xsltproc ../vty_reference.xsl generated/combined3.xml > generated/docbook_vty.xml, \ - XSLTPROC,Converting MSC VTY to DocBook) +include $(TOPDIR)/build/Makefile.common.inc -- cgit v1.2.3 From 7fd0e0fd646aadb820747970e077f5c98c05c945 Mon Sep 17 00:00:00 2001 From: Alexander Couzens Date: Tue, 5 Dec 2017 14:50:43 +0000 Subject: OsmoMSC: add rate counter documentation Change-Id: Idc105fd16511c6ea4f5069a57b217ea3319bdbec --- doc/manuals/chapters/counters.adoc | 4 +++ doc/manuals/chapters/counters_generated.adoc | 40 ++++++++++++++++++++++++++++ doc/manuals/osmomsc-usermanual.adoc | 2 ++ 3 files changed, 46 insertions(+) create mode 100644 doc/manuals/chapters/counters.adoc create mode 100644 doc/manuals/chapters/counters_generated.adoc (limited to 'doc') diff --git a/doc/manuals/chapters/counters.adoc b/doc/manuals/chapters/counters.adoc new file mode 100644 index 000000000..7fbb10c6f --- /dev/null +++ b/doc/manuals/chapters/counters.adoc @@ -0,0 +1,4 @@ +[[counters]] +== Counters + +include::./counters_generated.adoc[] diff --git a/doc/manuals/chapters/counters_generated.adoc b/doc/manuals/chapters/counters_generated.adoc new file mode 100644 index 000000000..afeb8ffe5 --- /dev/null +++ b/doc/manuals/chapters/counters_generated.adoc @@ -0,0 +1,40 @@ +// autogenerated by show asciidoc counters +These counters and their description based on OsmoMSC UNKNOWN (OsmoMSC). + +// generating tables for rate_ctr_group +// rate_ctr_group table mobile switching center +.msc - mobile switching center +[options="header"] +|=== +| Name | Reference | Description +| loc_update_type:attach | <> | Received location update imsi attach requests. +| loc_update_type:normal | <> | Received location update normal requests. +| loc_update_type:periodic | <> | Received location update periodic requests. +| loc_update_type:detach | <> | Received location update detach indication. +| loc_update_resp:failed | <> | Rejected location updates. +| loc_update_resp:completed | <> | Successful location updates. +| sms:submitted | <> | Received a RPDU from a MS (MO). +| sms:no_receiver | <> | Counts SMS which couldn't routed because no receiver found. +| sms:delivered | <> | Global SMS Deliver attempts. +| sms:rp_err_mem | <> | CAUSE_MT_MEM_EXCEEDED errors of MS responses on a sms deliver attempt. +| sms:rp_err_other | <> | Other error of MS responses on a sms delive attempt. +| sms:deliver_unknown_error | <> | Unknown error occured during sms delivery. +| call:mo_setup | <> | Received setup requests from a MS to init a MO call. +| call:mo_connect_ack | <> | Received a connect ack from MS of a MO call. Call is now succesful connected up. +| call:mt_setup | <> | Sent setup requests to the MS (MT). +| call:mt_connect | <> | Sent a connect to the MS (MT). +| call:active | <> | Count total amount of calls that ever reached active state. +| call:complete | <> | Count total amount of calls which got terminated by disconnect req or ind after reaching active state. +| call:incomplete | <> | Count total amount of call which got terminated by any other reason after reaching active state. +|=== +// generating tables for osmo_stat_items +// generating tables for osmo_counters +// ungrouped osmo_counters +.ungrouped osmo counters +[options="header"] +|=== +| Name | Reference | Description +| msc.active_calls | <> | +|=== + + diff --git a/doc/manuals/osmomsc-usermanual.adoc b/doc/manuals/osmomsc-usermanual.adoc index 7c200200a..619048148 100644 --- a/doc/manuals/osmomsc-usermanual.adoc +++ b/doc/manuals/osmomsc-usermanual.adoc @@ -14,6 +14,8 @@ include::chapters/running.adoc[] include::chapters/control.adoc[] +include::chapters/counters.adoc[] + include::../common/chapters/vty.adoc[] include::../common/chapters/logging.adoc[] -- cgit v1.2.3 From 593bbb5e5ec25672b18191e1ddafbbc52f2a027a Mon Sep 17 00:00:00 2001 From: Harald Welte Date: Fri, 26 Jan 2018 11:16:45 +0100 Subject: share chapters/gsup.adoc from OsmoSGSN to OsmoMSC + OsmoHLR Since the NITB split, GSUP is used in all three network elements, so make the protocol a shared chapter Change-Id: Id2d7c27ef16eb0ebe5f60d625a1fcf42f1603f4f --- doc/manuals/osmomsc-usermanual.adoc | 2 ++ 1 file changed, 2 insertions(+) (limited to 'doc') diff --git a/doc/manuals/osmomsc-usermanual.adoc b/doc/manuals/osmomsc-usermanual.adoc index 619048148..ac68d93e7 100644 --- a/doc/manuals/osmomsc-usermanual.adoc +++ b/doc/manuals/osmomsc-usermanual.adoc @@ -28,6 +28,8 @@ include::../common/chapters/mncc.adoc[] include::../common/chapters/control_if.adoc[] +include::../common/chapters/gsup.adoc[] + include::../common/chapters/port_numbers.adoc[] include::../common/chapters/bibliography.adoc[] -- cgit v1.2.3 From df7d7ffc524bf1efa501bb50d2a1f3e083a05743 Mon Sep 17 00:00:00 2001 From: Neels Hofmeyr Date: Tue, 6 Mar 2018 14:59:00 +0100 Subject: OsmoMSC: update VTY reference This is the first update since the libosmocore changes to the 'show online-help' generated output. Hence the produced document now benefits from the structural improvements: - not repeating common commands for every node; - using section names that match the VTY prompt. Update msc_vty_additions.xml to match the new node ID scheme. Change-Id: I6f1698dbc205334cf69234f88b124abfce54cc9a --- doc/manuals/vty/msc_vty_additions.xml | 9 +- doc/manuals/vty/msc_vty_reference.xml | 5551 +++++++++++++++------------------ 2 files changed, 2535 insertions(+), 3025 deletions(-) (limited to 'doc') diff --git a/doc/manuals/vty/msc_vty_additions.xml b/doc/manuals/vty/msc_vty_additions.xml index 0d473bd60..adc0f7ef7 100644 --- a/doc/manuals/vty/msc_vty_additions.xml +++ b/doc/manuals/vty/msc_vty_additions.xml @@ -1,20 +1,17 @@ - - + MNCC Internal Configuration This node allows to configure the default codecs for the internal call control handling. - - + SMPP Configuration This node allows to configure the SMPP interface for interfacing with external SMS applications. This section contains generic/common SMPP related configuration, and no per-ESME specific parameters. - - + ESME Configuration This node allows to configure one particular SMPP ESME, which is an External SMS Entity such as a SMS based diff --git a/doc/manuals/vty/msc_vty_reference.xml b/doc/manuals/vty/msc_vty_reference.xml index b7311ab11..7cf57c03e 100644 --- a/doc/manuals/vty/msc_vty_reference.xml +++ b/doc/manuals/vty/msc_vty_reference.xml @@ -1,3019 +1,2532 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file + + + Common Commands + These commands are available on all VTY nodes. They are listed here only once, to unclutter the VTY reference. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + view + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + enable + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + config + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + config-log + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + config-stats + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + config-line + + + + + + + + + + + + + + + + + + + + config-ctrl + + + + + + + + + config-cs7 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + config-cs7-as + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + config-cs7-asp + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + config-cs7-sccpaddr + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + config-cs7-sccpaddr-gt + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + config-net + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + config-msc + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + config-mncc-int + + + + + + + + + + + + + + + + + + + + config-smpp + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + config-smpp-esme + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + config-hlr + + + + + + + + + + + + + + -- cgit v1.2.3 From d89f1d18cb06816d95cf301448d4d0c2063ba0b3 Mon Sep 17 00:00:00 2001 From: Harald Welte Date: Sat, 17 Mar 2018 14:15:38 +0100 Subject: vty-ref: Update URI of docbook 5.0 schema ... to match the /etc/xml/catalog file on debian (no "www" in hostname) Change-Id: Id9f3579c7f2bc3af13fe30b5268f249b6f59ed0d --- doc/manuals/osmomsc-vty-reference.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'doc') diff --git a/doc/manuals/osmomsc-vty-reference.xml b/doc/manuals/osmomsc-vty-reference.xml index a954b843b..3b54e9e8b 100644 --- a/doc/manuals/osmomsc-vty-reference.xml +++ b/doc/manuals/osmomsc-vty-reference.xml @@ -3,8 +3,8 @@ ex:ts=2:sw=42sts=2:et -*- tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- --> - ]> -- cgit v1.2.3 From 732443c3b8c11f571e1b78b7ddb015db23ce2fa4 Mon Sep 17 00:00:00 2001 From: Harald Welte Date: Fri, 5 Oct 2018 23:42:14 +0200 Subject: add SGs / CSFB related dot + msc files Those graphs + message sequence charts are not yet used by any of our manuals, but they should become used by the OsmoMSC user manual once SGs interface support is added. Related: OS#2583 Change-Id: Idfd3a66c18131b5458d183b8e66f62eaaab65991 --- doc/manuals/images/sgs-imsi_attach_lu.msc | 15 +++++++++++++++ doc/manuals/images/sgs-mo_call_no_ps_ho.msc | 18 ++++++++++++++++++ doc/manuals/images/sgs-mo_sms_idle.msc | 21 +++++++++++++++++++++ doc/manuals/images/sgs-mt_call_idle.msc | 17 +++++++++++++++++ doc/manuals/images/sgs-mt_sms_idle.msc | 22 ++++++++++++++++++++++ 5 files changed, 93 insertions(+) create mode 100644 doc/manuals/images/sgs-imsi_attach_lu.msc create mode 100644 doc/manuals/images/sgs-mo_call_no_ps_ho.msc create mode 100644 doc/manuals/images/sgs-mo_sms_idle.msc create mode 100644 doc/manuals/images/sgs-mt_call_idle.msc create mode 100644 doc/manuals/images/sgs-mt_sms_idle.msc (limited to 'doc') diff --git a/doc/manuals/images/sgs-imsi_attach_lu.msc b/doc/manuals/images/sgs-imsi_attach_lu.msc new file mode 100644 index 000000000..e62c2b842 --- /dev/null +++ b/doc/manuals/images/sgs-imsi_attach_lu.msc @@ -0,0 +1,15 @@ +msc { + UE, MME, VLR [label="MSC/VLR"], HSS [label="HSS/HLR"]; + + UE => MME [label="Attach Request"]; + UE box HSS [label="Steps 3..16 of LTE Attach procedure TS 23.401"]; + MME box MME [label="Derive VLR Number"]; + MME => VLR [label="LU Request"]; + VLR box VLR [label="Create SGs Association"]; + VLR box HSS [label="MAP/GSUP UL / ISD"]; + MME <= VLR [label="LU Accept"]; + UE box HSS [label="Steps 17..16 of LTE Attach procedure TS 23.401"]; + |||; + ...; + MME <= VLR [label="Paging Request"]; +} diff --git a/doc/manuals/images/sgs-mo_call_no_ps_ho.msc b/doc/manuals/images/sgs-mo_call_no_ps_ho.msc new file mode 100644 index 000000000..f886c89d6 --- /dev/null +++ b/doc/manuals/images/sgs-mo_call_no_ps_ho.msc @@ -0,0 +1,18 @@ +msc { + hscale=2; + UE, ENB [label="eNodeB"], BSS, MME, VLR [label="MSC/VLR"], HSS [label="HSS/HLR"]; + + UE => MME [label="NAS Extended Service Request"]; + ENB <= MME [label="S1-AP UE Context Mod Req with CSFB"]; + ENB => MME [label="S1-AP UE Context Mod Resp"]; + UE <= ENB [label="NACC (Network Assisted Cell Change)"]; + ENB => MME [label="S1-AP S1 UE Context Release Req"]; + UE box MME [label="S1 UE Context Release"]; + + UE box HSS [label="UE changes RAT then LA and/or RA update"]; + UE <=> HSS [label="PS Suspend (TS 23.060)"]; + + UE => BSS [label="CM SERV REQ"]; + BSS => VLR [label="COMPL L3 (CM SERV REQ)"]; + UE <=> VLR [label="Normal 2G Voice Call"]; +} diff --git a/doc/manuals/images/sgs-mo_sms_idle.msc b/doc/manuals/images/sgs-mo_sms_idle.msc new file mode 100644 index 000000000..5acc0e833 --- /dev/null +++ b/doc/manuals/images/sgs-mo_sms_idle.msc @@ -0,0 +1,21 @@ +msc { + hscale=2; + UE, MME, VLR [label="MSC/VLR"], HSS [label="HSS/HLR"], SMSC; + + UE box HSS [label="EPS/IMSI attach procedure"]; + ...; + UE box MME [label="UE triggered Service Request"]; + UE => MME [label="UL NAS Transport"]; + MME => VLR [label="SGsAP UPLINK UNITDATA\n(CP-DATA/RP-DATA/TPDU)"]; + VLR => SMSC [label="MAP/GSUP Forward SM"]; + MME <= VLR [label="SGsAP DOWNLINK UNITDATA"]; + UE <= MME [label="DL NAS Transport"]; + ...; + + VLR <= SMSC [label="Delivery Report"]; + MME <= VLR [label="SGsAP DOWNLINK UNITDATA"]; + UE <= MME [label="DL NAS Transport"]; + UE => MME [label="UL NAS Transport"]; + MME => VLR [label="SGsAP UPLINK UNITDATA"]; + MME <= VLR [label="SGsAP RELEASE REQ"]; +} diff --git a/doc/manuals/images/sgs-mt_call_idle.msc b/doc/manuals/images/sgs-mt_call_idle.msc new file mode 100644 index 000000000..b3cff3c59 --- /dev/null +++ b/doc/manuals/images/sgs-mt_call_idle.msc @@ -0,0 +1,17 @@ +msc { + hscale=2; + UE, ENB [label="eNodeB"], BSS, MME, VLR [label="MSC/VLR"], PSTN; + + VLR <= PSTN [label="ISUP IAM or SIP INVITE"]; + MME <= VLR [label="SGsAP PAGING REQUEST"]; + ENB <= MME [label="Paging"]; + UE <= MME [label="Paging"]; + + UE => MME [label="Extended Service Req"]; + MME => VLR [label="SGsAP SERVICE REQUEST"]; + ENB <= MME [label="Initial UE Ctx Setup"]; + + UE => BSS [label="Paging Response"]; + BSS => VLR [label="COMPL L3 (PAGING RESP)"]; + UE <=> VLR [label="Normal 2G Voice Call"]; +} diff --git a/doc/manuals/images/sgs-mt_sms_idle.msc b/doc/manuals/images/sgs-mt_sms_idle.msc new file mode 100644 index 000000000..7b453e0b5 --- /dev/null +++ b/doc/manuals/images/sgs-mt_sms_idle.msc @@ -0,0 +1,22 @@ +msc { + hscale=2; + UE, MME, VLR [label="MSC/VLR"], HSS [label="HSS/HLR"], SMSC; + + UE box HSS [label="EPS/IMSI attach procedure"]; + ...; + + VLR <= SMSC [label="MAP/GSUP ForwardSM"]; + MME <= VLR [label="SGsAP PAGING"]; + UE <= MME [label="Paging"]; + UE box MME [label="Service Request"]; + MME => VLR [label="SGsAP SERVICE REQ"]; + MME <= VLR [label="SGsAP DL UNITDATA\n(CP-DATA/RP-DATA/TPDU)"]; + UE <= MME [label="DL NAS Transport"]; + UE => MME [label="UL NAS Transport"]; + MME => VLR [label="SGsAP UL UNITDATA"]; + ...; + UE => MME [label="UL NAS Transport"]; + MME => VLR [label="SGsAP UL UNITDATA"]; + VLR => SMSC [label="Delivery report"]; + MME <= VLR [label="SGsAP RELEASE REQ"]; +} -- cgit v1.2.3 From 020a48528724854234e2a429fb560d8dd7dbc4c5 Mon Sep 17 00:00:00 2001 From: Daniel Willmann Date: Tue, 23 Oct 2018 18:17:28 +0200 Subject: OsmoBSC/HLR/MSC: Fix default config file name Mention that the default is not openbsc.cfg, but osmo-*.cfg Change-Id: I139e6004e28d6f918f31792e634214a6153edd0e --- doc/manuals/chapters/running.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/manuals/chapters/running.adoc b/doc/manuals/chapters/running.adoc index 8656a586b..cb6815779 100644 --- a/doc/manuals/chapters/running.adoc +++ b/doc/manuals/chapters/running.adoc @@ -21,7 +21,7 @@ arguments: Fork the process as a daemon into background. *-c, --config-file 'CONFIGFILE'*:: Specify the file and path name of the configuration file to be - used. If none is specified, use `openbsc.cfg` in the current + used. If none is specified, use `osmo-msc.cfg` in the current working directory. *-s, --disable-color*:: Disable colors for logging to stderr. This has mostly been -- cgit v1.2.3 From ab3ade70c4bb76bbd6f508c4e522d59df2523de1 Mon Sep 17 00:00:00 2001 From: Neels Hofmeyr Date: Mon, 5 Nov 2018 03:19:12 +0100 Subject: msc: update vty reference Change-Id: I31f1d388b5323af8ece8a71a82c1b91f80d404e1 --- doc/manuals/vty/msc_vty_reference.xml | 468 ++++++++++++++++++++++------------ 1 file changed, 311 insertions(+), 157 deletions(-) (limited to 'doc') diff --git a/doc/manuals/vty/msc_vty_reference.xml b/doc/manuals/vty/msc_vty_reference.xml index 7cf57c03e..bb7e958b2 100644 --- a/doc/manuals/vty/msc_vty_reference.xml +++ b/doc/manuals/vty/msc_vty_reference.xml @@ -85,12 +85,6 @@ - - - - - - @@ -143,6 +137,57 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -216,7 +261,7 @@ - + @@ -224,6 +269,7 @@ + @@ -233,20 +279,10 @@ - - - - - - - - - - + - @@ -282,7 +318,6 @@ - @@ -290,6 +325,38 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -363,6 +430,12 @@ + + + + + + @@ -391,11 +464,12 @@ - + - + + @@ -443,17 +517,19 @@ - + - + + - + + @@ -462,17 +538,19 @@ - + - + + - + + @@ -481,10 +559,11 @@ - + - + + @@ -497,10 +576,11 @@ - + - + + @@ -509,10 +589,11 @@ - + - + + @@ -524,10 +605,11 @@ - + - + + @@ -543,10 +625,11 @@ - + - + + @@ -555,15 +638,16 @@ - + - + + - + @@ -646,12 +730,6 @@ - - - - - - @@ -717,6 +795,57 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -790,7 +919,7 @@ - + @@ -798,6 +927,7 @@ + @@ -807,20 +937,10 @@ - - - - - - - - - - + - @@ -856,7 +976,6 @@ - @@ -864,6 +983,38 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -937,6 +1088,12 @@ + + + + + + @@ -965,11 +1122,12 @@ - + - + + @@ -1017,17 +1175,19 @@ - + - + + - + + @@ -1036,17 +1196,19 @@ - + - + + - + + @@ -1055,10 +1217,11 @@ - + - + + @@ -1071,10 +1234,11 @@ - + - + + @@ -1083,10 +1247,11 @@ - + - + + @@ -1098,10 +1263,11 @@ - + - + + @@ -1117,10 +1283,11 @@ - + - + + @@ -1129,15 +1296,16 @@ - + - + + - + @@ -1160,10 +1328,11 @@ - + - + + @@ -1171,21 +1340,6 @@ - - - - - - - - - - - - - - - @@ -1212,10 +1366,11 @@ - + - + + @@ -1563,7 +1718,7 @@ - + @@ -1571,13 +1726,13 @@ + - + - @@ -1613,7 +1768,6 @@ - @@ -1621,6 +1775,38 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -1818,15 +2004,6 @@ - - - - - - - - - @@ -1840,6 +2017,21 @@ + + + + + + + + + + + + + + + config-cs7-as @@ -2176,6 +2368,12 @@ + + + + + + @@ -2265,49 +2463,6 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -2413,8 +2568,7 @@ - - + -- cgit v1.2.3