diff options
author | Neels Hofmeyr <neels@hofmeyr.de> | 2018-11-27 17:44:56 +0100 |
---|---|---|
committer | Neels Hofmeyr <neels@hofmeyr.de> | 2018-11-27 17:44:56 +0100 |
commit | d9fb15603e5e92e24086b5ac5069108b8d510d0e (patch) | |
tree | 5946b0c3f075d10b7ae06409fe3131232714a476 /doc/manuals | |
parent | 380b2195cfee8378b5e8be97129205b0ca1d9929 (diff) | |
parent | ab3ade70c4bb76bbd6f508c4e522d59df2523de1 (diff) |
Merge history from osmo-gsm-manuals.git
Change-Id: I30ec6b3bc18fa36e7bad74ca445bc9949dcefe80
Diffstat (limited to 'doc/manuals')
-rw-r--r-- | doc/manuals/Makefile | 10 | ||||
-rw-r--r-- | doc/manuals/chapters/control.adoc | 31 | ||||
-rw-r--r-- | doc/manuals/chapters/counters.adoc | 4 | ||||
-rw-r--r-- | doc/manuals/chapters/counters_generated.adoc | 40 | ||||
-rw-r--r-- | doc/manuals/chapters/net.adoc | 154 | ||||
-rw-r--r-- | doc/manuals/chapters/overview.adoc | 127 | ||||
-rw-r--r-- | doc/manuals/chapters/running.adoc | 148 | ||||
-rw-r--r-- | doc/manuals/images/sgs-imsi_attach_lu.msc | 15 | ||||
-rw-r--r-- | doc/manuals/images/sgs-mo_call_no_ps_ho.msc | 18 | ||||
-rw-r--r-- | doc/manuals/images/sgs-mo_sms_idle.msc | 21 | ||||
-rw-r--r-- | doc/manuals/images/sgs-mt_call_idle.msc | 17 | ||||
-rw-r--r-- | doc/manuals/images/sgs-mt_sms_idle.msc | 22 | ||||
-rw-r--r-- | doc/manuals/osmomsc-usermanual-docinfo.xml | 47 | ||||
-rw-r--r-- | doc/manuals/osmomsc-usermanual.adoc | 40 | ||||
-rw-r--r-- | doc/manuals/osmomsc-vty-reference.xml | 38 | ||||
-rw-r--r-- | doc/manuals/vty/msc_vty_additions.xml | 21 | ||||
-rw-r--r-- | doc/manuals/vty/msc_vty_reference.xml | 2686 |
17 files changed, 3439 insertions, 0 deletions
diff --git a/doc/manuals/Makefile b/doc/manuals/Makefile new file mode 100644 index 000000000..c9edcef7f --- /dev/null +++ b/doc/manuals/Makefile @@ -0,0 +1,10 @@ +TOPDIR = .. + +ASCIIDOC = osmomsc-usermanual.adoc +ASCIIDOC_DEPS = chapters/*.adoc +include $(TOPDIR)/build/Makefile.asciidoc.inc + +VTY_REFERENCE = osmomsc-vty-reference.xml +include $(TOPDIR)/build/Makefile.vty-reference.inc + +include $(TOPDIR)/build/Makefile.common.inc 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 +---- 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 | <<msc_loc_update_type:attach>> | Received location update imsi attach requests. +| loc_update_type:normal | <<msc_loc_update_type:normal>> | Received location update normal requests. +| loc_update_type:periodic | <<msc_loc_update_type:periodic>> | Received location update periodic requests. +| loc_update_type:detach | <<msc_loc_update_type:detach>> | Received location update detach indication. +| loc_update_resp:failed | <<msc_loc_update_resp:failed>> | Rejected location updates. +| loc_update_resp:completed | <<msc_loc_update_resp:completed>> | Successful location updates. +| sms:submitted | <<msc_sms:submitted>> | Received a RPDU from a MS (MO). +| sms:no_receiver | <<msc_sms:no_receiver>> | Counts SMS which couldn't routed because no receiver found. +| sms:delivered | <<msc_sms:delivered>> | Global SMS Deliver attempts. +| sms:rp_err_mem | <<msc_sms:rp_err_mem>> | CAUSE_MT_MEM_EXCEEDED errors of MS responses on a sms deliver attempt. +| sms:rp_err_other | <<msc_sms:rp_err_other>> | Other error of MS responses on a sms delive attempt. +| sms:deliver_unknown_error | <<msc_sms:deliver_unknown_error>> | Unknown error occured during sms delivery. +| call:mo_setup | <<msc_call:mo_setup>> | Received setup requests from a MS to init a MO call. +| call:mo_connect_ack | <<msc_call:mo_connect_ack>> | Received a connect ack from MS of a MO call. Call is now succesful connected up. +| call:mt_setup | <<msc_call:mt_setup>> | Sent setup requests to the MS (MT). +| call:mt_connect | <<msc_call:mt_connect>> | Sent a connect to the MS (MT). +| call:active | <<msc_call:active>> | Count total amount of calls that ever reached active state. +| call:complete | <<msc_call:complete>> | Count total amount of calls which got terminated by disconnect req or ind after reaching active state. +| call:incomplete | <<msc_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 | <<ungroup_counter_msc.active_calls>> | +|=== + + 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_ <<vty-ref-osmomsc>>. 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_ <<userman-osmohlr>>. 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 <<smpp>>. + +==== 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 <<mncc>>. + +==== 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..cb6815779 --- /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 <<logging>> 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 `osmo-msc.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 <<logging>> + for more information. +*-T, --timestamp*:: + Enable time-stamping of log messages to stderr. This has mostly + been deprecated by VTY based logging configuration, see + <<logging>> 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 + <<logging>> 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 + <<mncc>> 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` 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: + +---- +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 <<smpp-config-global>>. + +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 <<mncc-external>>. + +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/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"]; +} 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 @@ +<revhistory> + <revision> + <revnumber>1</revnumber> + <date>September 18th, 2017</date> + <authorinitials>NH</authorinitials> + <revremark> + Initial version; based on OsmoNITB manual version 2. + </revremark> + </revision> +</revhistory> + +<authorgroup> + <author> + <firstname>Neels</firstname> + <surname>Hofmeyr</surname> + <email>nhofmeyr@sysmocom.de</email> + <authorinitials>NH</authorinitials> + <affiliation> + <shortaffil>sysmocom</shortaffil> + <orgname>sysmocom - s.f.m.c. GmbH</orgname> + <jobtitle>Senior Developer</jobtitle> + </affiliation> + </author> +</authorgroup> + +<copyright> + <year>2017</year> + <holder>sysmocom - s.f.m.c. GmbH</holder> +</copyright> + +<legalnotice> + <para> + 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". + </para> + <para> + The Asciidoc source code of this manual can be found at + <ulink url="http://git.osmocom.org/osmo-gsm-manuals/"> + http://git.osmocom.org/osmo-gsm-manuals/ + </ulink> + </para> +</legalnotice> diff --git a/doc/manuals/osmomsc-usermanual.adoc b/doc/manuals/osmomsc-usermanual.adoc new file mode 100644 index 000000000..ac68d93e7 --- /dev/null +++ b/doc/manuals/osmomsc-usermanual.adoc @@ -0,0 +1,40 @@ +:gfdl-enabled: +:program-name: OsmoMSC + +OsmoMSC User Manual +==================== +Neels Hofmeyr <nhofmeyr@sysmocom.de> + + +include::../common/chapters/preface.adoc[] + +include::chapters/overview.adoc[] + +include::chapters/running.adoc[] + +include::chapters/control.adoc[] + +include::chapters/counters.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/gsup.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..3b54e9e8b --- /dev/null +++ b/doc/manuals/osmomsc-vty-reference.xml @@ -0,0 +1,38 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + ex:ts=2:sw=42sts=2:et + -*- tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- +--> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML 5.0//EN" +"http://docbook.org/xml/5.0/dtd/docbook.dtd" [ +<!ENTITY chapter-vty SYSTEM "../common/chapters/vty.xml" > +<!ENTITY sections-vty SYSTEM "generated/docbook_vty.xml" > +]> + +<book> + <info> + <revhistory> + <revision> + <revnumber>v1</revnumber> + <date>18th September 2017</date> + <authorinitials>nh</authorinitials> + <revremark>Initial</revremark> + </revision> + </revhistory> + + <title>OsmoMSC VTY Reference</title> + + <copyright> + <year>2017</year> + </copyright> + + <legalnotice> + <para>This work is copyright by <orgname>sysmocom - s.f.m.c. GmbH</orgname>. All rights reserved. + </para> + </legalnotice> + </info> + + <!-- Main chapters--> + &chapter-vty; +</book> + diff --git a/doc/manuals/vty/msc_vty_additions.xml b/doc/manuals/vty/msc_vty_additions.xml new file mode 100644 index 000000000..adc0f7ef7 --- /dev/null +++ b/doc/manuals/vty/msc_vty_additions.xml @@ -0,0 +1,21 @@ +<vtydoc xmlns='urn:osmocom:xml:libosmocore:vty:doc:1.0'> + <node id='config-mncc-int'> + <name>MNCC Internal Configuration</name> + <description>This node allows to configure the default codecs for + the internal call control handling.</description> + </node> + <node id='config-smpp'> + <name>SMPP Configuration</name> + <description>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.</description> + </node> + <node id='config-smpp-esme'> + <name>ESME Configuration</name> + <description>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.</description> + </node> +</vtydoc> diff --git a/doc/manuals/vty/msc_vty_reference.xml b/doc/manuals/vty/msc_vty_reference.xml new file mode 100644 index 000000000..bb7e958b2 --- /dev/null +++ b/doc/manuals/vty/msc_vty_reference.xml @@ -0,0 +1,2686 @@ +<vtydoc xmlns='urn:osmocom:xml:libosmocore:vty:doc:1.0'> + <node id='_common_cmds_'> + <name>Common Commands</name> + <description>These commands are available on all VTY nodes. They are listed here only once, to unclutter the VTY reference.</description> + <command id='help'> + <params> + <param name='help' doc='Description of the interactive help system' /> + </params> + </command> + <command id='list'> + <params> + <param name='list' doc='Print command list' /> + </params> + </command> + <command id='write terminal'> + <params> + <param name='write' doc='Write running configuration to memory, network, or terminal' /> + <param name='terminal' doc='Write to terminal' /> + </params> + </command> + <command id='write file'> + <params> + <param name='write' doc='Write running configuration to memory, network, or terminal' /> + <param name='file' doc='Write to configuration file' /> + </params> + </command> + <command id='write memory'> + <params> + <param name='write' doc='Write running configuration to memory, network, or terminal' /> + <param name='memory' doc='Write configuration to the file (same as write file)' /> + </params> + </command> + <command id='write'> + <params> + <param name='write' doc='Write running configuration to memory, network, or terminal' /> + </params> + </command> + <command id='show running-config'> + <params> + <param name='show' doc='Show running system information' /> + <param name='running-config' doc='running configuration' /> + </params> + </command> + <command id='exit'> + <params> + <param name='exit' doc='Exit current mode and down to previous mode' /> + </params> + </command> + <command id='end'> + <params> + <param name='end' doc='End current mode and change to enable mode.' /> + </params> + </command> + </node> + <node id='view'> + <name>view</name> + <command id='show version'> + <params> + <param name='show' doc='Show running system information' /> + <param name='version' doc='Displays program version' /> + </params> + </command> + <command id='show online-help'> + <params> + <param name='show' doc='Show running system information' /> + <param name='online-help' doc='Online help' /> + </params> + </command> + <command id='enable'> + <params> + <param name='enable' doc='Turn on privileged mode command' /> + </params> + </command> + <command id='terminal length <0-512>'> + <params> + <param name='terminal' doc='Set terminal line parameters' /> + <param name='length' doc='Set number of lines on a screen' /> + <param name='<0-512>' doc='Number of lines on screen (0 for no pausing)' /> + </params> + </command> + <command id='terminal no length'> + <params> + <param name='terminal' doc='Set terminal line parameters' /> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='length' doc='Set number of lines on a screen' /> + </params> + </command> + <command id='who'> + <params> + <param name='who' doc='Display who is on vty' /> + </params> + </command> + <command id='show history'> + <params> + <param name='show' doc='Show running system information' /> + <param name='history' doc='Display the session command history' /> + </params> + </command> + <command id='show cs7 instance <0-15> users'> + <params> + <param name='show' doc='Show running system information' /> + <param name='cs7' doc='ITU-T Signaling System 7' /> + <param name='instance' doc='An instance of the SS7 stack' /> + <param name='<0-15>' doc='An instance of the SS7 stack' /> + <param name='users' doc='User Table' /> + </params> + </command> + <command id='show cs7 (sua|m3ua|ipa) [<0-65534>]'> + <params> + <param name='show' doc='Show running system information' /> + <param name='cs7' doc='ITU-T Signaling System 7' /> + <param name='sua' doc='SCCP User Adaptation' /> + <param name='m3ua' doc='MTP3 User Adaptation' /> + <param name='ipa' doc='IPA Multiplex (SCCP Lite)' /> + <param name='[<0-65534>]' doc='Port Number' /> + </params> + </command> + <command id='show cs7 instance <0-15> asp'> + <params> + <param name='show' doc='Show running system information' /> + <param name='cs7' doc='ITU-T Signaling System 7' /> + <param name='instance' doc='An instance of the SS7 stack' /> + <param name='<0-15>' doc='An instance of the SS7 stack' /> + <param name='asp' doc='Application Server Process (ASP)' /> + </params> + </command> + <command id='show cs7 instance <0-15> as (active|all|m3ua|sua)'> + <params> + <param name='show' doc='Show running system information' /> + <param name='cs7' doc='ITU-T Signaling System 7' /> + <param name='instance' doc='An instance of the SS7 stack' /> + <param name='<0-15>' doc='An instance of the SS7 stack' /> + <param name='as' doc='Application Server (AS)' /> + <param name='active' doc='Display all active ASs' /> + <param name='all' doc='Display all ASs (default)' /> + <param name='m3ua' doc='Display all m3ua ASs' /> + <param name='sua' doc='Display all SUA ASs' /> + </params> + </command> + <command id='show cs7 instance <0-15> sccp addressbook'> + <params> + <param name='show' doc='Show running system information' /> + <param name='cs7' doc='ITU-T Signaling System 7' /> + <param name='instance' doc='An instance of the SS7 stack' /> + <param name='<0-15>' doc='An instance of the SS7 stack' /> + <param name='sccp' doc='Signalling Connection Control Part' /> + <param name='addressbook' doc='List all SCCP addressbook entries' /> + </params> + </command> + <command id='show cs7 instance <0-15> sccp users'> + <params> + <param name='show' doc='Show running system information' /> + <param name='cs7' doc='ITU-T Signaling System 7' /> + <param name='instance' doc='An instance of the SS7 stack' /> + <param name='<0-15>' doc='An instance of the SS7 stack' /> + <param name='sccp' doc='Signalling Connection Control Part' /> + <param name='users' doc='Show List of SCCP Users registered' /> + </params> + </command> + <command id='show cs7 instance <0-15> sccp ssn <0-65535>'> + <params> + <param name='show' doc='Show running system information' /> + <param name='cs7' doc='ITU-T Signaling System 7' /> + <param name='instance' doc='An instance of the SS7 stack' /> + <param name='<0-15>' doc='An instance of the SS7 stack' /> + <param name='sccp' doc='Signalling Connection Control Part' /> + <param name='ssn' doc='Find an SCCP User registered for the given SSN' /> + <param name='<0-65535>' doc='Subsystem Number (SSN)' /> + </params> + </command> + <command id='show cs7 instance <0-15> sccp connections'> + <params> + <param name='show' doc='Show running system information' /> + <param name='cs7' doc='ITU-T Signaling System 7' /> + <param name='instance' doc='An instance of the SS7 stack' /> + <param name='<0-15>' doc='An instance of the SS7 stack' /> + <param name='sccp' doc='Signalling Connection Control Part' /> + <param name='connections' doc='Show List of active SCCP connections' /> + </params> + </command> + <command id='show cs7 instance <0-15> sccp timers'> + <params> + <param name='show' doc='Show running system information' /> + <param name='cs7' doc='ITU-T Signaling System 7' /> + <param name='instance' doc='An instance of the SS7 stack' /> + <param name='<0-15>' doc='An instance of the SS7 stack' /> + <param name='sccp' doc='Signaling Connection Control Part' /> + <param name='timers' doc='Show List of SCCP timers' /> + </params> + </command> + <command id='logging enable'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='enable' doc='Enables logging to this vty' /> + </params> + </command> + <command id='logging disable'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='disable' doc='Disables logging to this vty' /> + </params> + </command> + <command id='logging filter all (0|1)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='filter' doc='Filter log messages' /> + <param name='all' doc='Do you want to log all messages?' /> + <param name='0' doc='Only print messages matched by other filters' /> + <param name='1' doc='Bypass filter and print all messages' /> + </params> + </command> + <command id='logging color (0|1)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='color' doc='Configure color-printing for log messages' /> + <param name='0' doc='Don't use color for printing messages' /> + <param name='1' doc='Use color for printing messages' /> + </params> + </command> + <command id='logging timestamp (0|1)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='timestamp' doc='Configure log message timestamping' /> + <param name='0' doc='Don't prefix each log message' /> + <param name='1' doc='Prefix each log message with current timestamp' /> + </params> + </command> + <command id='logging print extended-timestamp (0|1)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='print' doc='Log output settings' /> + <param name='extended-timestamp' doc='Configure log message timestamping' /> + <param name='0' doc='Don't prefix each log message' /> + <param name='1' doc='Prefix each log message with current timestamp with YYYYMMDDhhmmssnnn' /> + </params> + </command> + <command id='logging print category (0|1)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='print' doc='Log output settings' /> + <param name='category' doc='Configure log message' /> + <param name='0' doc='Don't prefix each log message' /> + <param name='1' doc='Prefix each log message with category/subsystem name' /> + </params> + </command> + <command id='logging print category-hex (0|1)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='print' doc='Log output settings' /> + <param name='category-hex' doc='Configure log message' /> + <param name='0' doc='Don't prefix each log message' /> + <param name='1' doc='Prefix each log message with category/subsystem nr in hex ('<000b>')' /> + </params> + </command> + <command id='logging print level (0|1)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='print' doc='Log output settings' /> + <param name='level' doc='Configure log message' /> + <param name='0' doc='Don't prefix each log message' /> + <param name='1' doc='Prefix each log message with the log level name' /> + </params> + </command> + <command id='logging print file (0|1|basename) [last]'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='print' doc='Log output settings' /> + <param name='file' doc='Configure log message' /> + <param name='0' doc='Don't prefix each log message' /> + <param name='1' doc='Prefix each log message with the source file and line' /> + <param name='basename' doc='Prefix each log message with the source file's basename (strip leading paths) and line' /> + <param name='[last]' doc='Log source file info at the end of a log line. If omitted, log source file info just before the log text.' /> + </params> + </command> + <command id='logging set-log-mask MASK'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='set-log-mask' doc='Set the logmask of this logging target' /> + <param name='MASK' doc='List of logging categories to log, e.g. 'abc:mno:xyz'. Available log categories depend on the specific application, refer to the 'logging level' command. Optionally add individual log levels like 'abc,1:mno,3:xyz,5', where the level numbers are LOGL_DEBUG=1 LOGL_INFO=3 LOGL_NOTICE=5 LOGL_ERROR=7 LOGL_FATAL=8' /> + </params> + </command> + <command id='logging level (rll|cc|mm|rr|mncc|pag|msc|mgcp|ho|db|ref|ctrl|smpp|ranap|vlr|iucs|bssap|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf) (debug|info|notice|error|fatal)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='level' doc='Set the log level for a specified category' /> + <param name='rll' doc='A-bis Radio Link Layer (RLL)' /> + <param name='cc' doc='Layer3 Call Control (CC)' /> + <param name='mm' doc='Layer3 Mobility Management (MM)' /> + <param name='rr' doc='Layer3 Radio Resource (RR)' /> + <param name='mncc' doc='MNCC API for Call Control application' /> + <param name='pag' doc='Paging Subsystem' /> + <param name='msc' doc='Mobile Switching Center' /> + <param name='mgcp' doc='Media Gateway Control Protocol' /> + <param name='ho' doc='Hand-Over' /> + <param name='db' doc='Database Layer' /> + <param name='ref' doc='Reference Counting' /> + <param name='ctrl' doc='Control interface' /> + <param name='smpp' doc='SMPP interface for external SMS apps' /> + <param name='ranap' doc='Radio Access Network Application Part Protocol' /> + <param name='vlr' doc='Visitor Location Register' /> + <param name='iucs' doc='Iu-CS Protocol' /> + <param name='bssap' doc='BSSAP Protocol (A Interface)' /> + <param name='lglobal' doc='Library-internal global log family' /> + <param name='llapd' doc='LAPD in libosmogsm' /> + <param name='linp' doc='A-bis Intput Subsystem' /> + <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' /> + <param name='lmi' doc='A-bis Input Driver for Signalling' /> + <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' /> + <param name='lsms' doc='Layer3 Short Message Service (SMS)' /> + <param name='lctrl' doc='Control Interface' /> + <param name='lgtp' doc='GPRS GTP library' /> + <param name='lstats' doc='Statistics messages and logging' /> + <param name='lgsup' doc='Generic Subscriber Update Protocol' /> + <param name='loap' doc='Osmocom Authentication Protocol' /> + <param name='lss7' doc='libosmo-sigtran Signalling System 7' /> + <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' /> + <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' /> + <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' /> + <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' /> + <param name='ljibuf' doc='libosmo-netif Jitter Buffer' /> + <param name='debug' doc='Log debug messages and higher levels' /> + <param name='info' doc='Log informational messages and higher levels' /> + <param name='notice' doc='Log noticeable messages and higher levels' /> + <param name='error' doc='Log error messages and higher levels' /> + <param name='fatal' doc='Log only fatal messages' /> + </params> + </command> + <command id='logging level set-all (debug|info|notice|error|fatal)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='level' doc='Set the log level for a specified category' /> + <param name='set-all' doc='Once-off set all categories to the given log level. There is no single command to take back these changes -- each category is set to the given level, period.' /> + <param name='debug' doc='Log debug messages and higher levels' /> + <param name='info' doc='Log informational messages and higher levels' /> + <param name='notice' doc='Log noticeable messages and higher levels' /> + <param name='error' doc='Log error messages and higher levels' /> + <param name='fatal' doc='Log only fatal messages' /> + </params> + </command> + <command id='logging level force-all (debug|info|notice|error|fatal)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='level' doc='Set the log level for a specified category' /> + <param name='force-all' doc='Globally force all logging categories to a specific level. This is released by the 'no logging level force-all' command. Note: any 'logging level <category> <level>' commands will have no visible effect after this, until the forced level is released.' /> + <param name='debug' doc='Log debug messages and higher levels' /> + <param name='info' doc='Log informational messages and higher levels' /> + <param name='notice' doc='Log noticeable messages and higher levels' /> + <param name='error' doc='Log error messages and higher levels' /> + <param name='fatal' doc='Log only fatal messages' /> + </params> + </command> + <command id='no logging level force-all'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='logging' doc='Configure logging' /> + <param name='level' doc='Set the log level for a specified category' /> + <param name='force-all' doc='Release any globally forced log level set with 'logging level force-all <level>'' /> + </params> + </command> + <command id='show logging vty'> + <params> + <param name='show' doc='Show running system information' /> + <param name='logging' doc='Show current logging configuration' /> + <param name='vty' doc='Show current logging configuration for this vty' /> + </params> + </command> + <command id='show alarms'> + <params> + <param name='show' doc='Show running system information' /> + <param name='alarms' doc='Show current logging configuration' /> + </params> + </command> + <command id='show talloc-context (application|all) (full|brief|DEPTH)'> + <params> + <param name='show' doc='Show running system information' /> + <param name='talloc-context' doc='Show talloc memory hierarchy' /> + <param name='application' doc='Application's context' /> + <param name='all' doc='All contexts, if NULL-context tracking is enabled' /> + <param name='full' doc='Display a full talloc memory hierarchy' /> + <param name='brief' doc='Display a brief talloc memory hierarchy' /> + <param name='DEPTH' doc='Specify required maximal depth value' /> + </params> + </command> + <command id='show talloc-context (application|all) (full|brief|DEPTH) tree ADDRESS'> + <params> + <param name='show' doc='Show running system information' /> + <param name='talloc-context' doc='Show talloc memory hierarchy' /> + <param name='application' doc='Application's context' /> + <param name='all' doc='All contexts, if NULL-context tracking is enabled' /> + <param name='full' doc='Display a full talloc memory hierarchy' /> + <param name='brief' doc='Display a brief talloc memory hierarchy' /> + <param name='DEPTH' doc='Specify required maximal depth value' /> + <param name='tree' doc='Display only a specific memory chunk' /> + <param name='ADDRESS' doc='Chunk address (e.g. 0xdeadbeef)' /> + </params> + </command> + <command id='show talloc-context (application|all) (full|brief|DEPTH) filter REGEXP'> + <params> + <param name='show' doc='Show running system information' /> + <param name='talloc-context' doc='Show talloc memory hierarchy' /> + <param name='application' doc='Application's context' /> + <param name='all' doc='All contexts, if NULL-context tracking is enabled' /> + <param name='full' doc='Display a full talloc memory hierarchy' /> + <param name='brief' doc='Display a brief talloc memory hierarchy' /> + <param name='DEPTH' doc='Specify required maximal depth value' /> + <param name='filter' doc='Filter chunks using regular expression' /> + <param name='REGEXP' doc='Regular expression' /> + </params> + </command> + <command id='show stats'> + <params> + <param name='show' doc='Show running system information' /> + <param name='stats' doc='Show statistical values' /> + </params> + </command> + <command id='show stats level (global|peer|subscriber)'> + <params> + <param name='show' doc='Show running system information' /> + <param name='stats' doc='Show statistical values' /> + <param name='level' doc='Set the maximum group level' /> + <param name='global' doc='Show global groups only' /> + <param name='peer' doc='Show global and network peer related groups' /> + <param name='subscriber' doc='Show global, peer, and subscriber groups' /> + </params> + </command> + <command id='show asciidoc counters'> + <params> + <param name='show' doc='Show running system information' /> + <param name='asciidoc' doc='Asciidoc generation' /> + <param name='counters' doc='Generate table of all registered counters' /> + </params> + </command> + <command id='show rate-counters'> + <params> + <param name='show' doc='Show running system information' /> + <param name='rate-counters' doc='Show all rate counters' /> + </params> + </command> + <command id='show fsm NAME'> + <params> + <param name='show' doc='Show running system information' /> + <param name='fsm' doc='Show information about finite state machines' /> + <param name='NAME' doc='Display information about a single named finite state machine' /> + </params> + </command> + <command id='show fsm all'> + <params> + <param name='show' doc='Show running system information' /> + <param name='fsm' doc='Show information about finite state machines' /> + <param name='all' doc='Display a list of all registered finite state machines' /> + </params> + </command> + <command id='show fsm-instances NAME'> + <params> + <param name='show' doc='Show running system information' /> + <param name='fsm-instances' doc='Show information about finite state machine instances' /> + <param name='NAME' doc='Display a list of all FSM instances of the named finite state machine' /> + </params> + </command> + <command id='show fsm-instances all'> + <params> + <param name='show' doc='Show running system information' /> + <param name='fsm-instances' doc='Show information about finite state machine instances' /> + <param name='all' doc='Display a list of all FSM instances of all finite state machine' /> + </params> + </command> + <command id='show subscriber (msisdn|extension|imsi|tmsi|id) ID'> + <params> + <param name='show' doc='Show running system information' /> + <param name='subscriber' doc='Operations on a Subscriber' /> + <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' /> + <param name='extension' doc='Legacy alias for 'msisdn'' /> + <param name='imsi' doc='Identify subscriber by IMSI' /> + <param name='tmsi' doc='Identify subscriber by TMSI' /> + <param name='id' doc='Identify subscriber by database ID' /> + <param name='ID' doc='Identifier for the subscriber' /> + </params> + </command> + <command id='show subscriber cache'> + <params> + <param name='show' doc='Show running system information' /> + <param name='subscriber' doc='Show information about subscribers' /> + <param name='cache' doc='Display contents of subscriber cache' /> + </params> + </command> + <command id='show connection'> + <params> + <param name='show' doc='Show running system information' /> + <param name='connection' doc='Subscriber Connections' /> + </params> + </command> + <command id='show transaction'> + <params> + <param name='show' doc='Show running system information' /> + <param name='transaction' doc='Transactions' /> + </params> + </command> + <command id='sms send pending'> + <params> + <param name='sms' doc='SMS related commands' /> + <param name='send' doc='SMS Sending related commands' /> + <param name='pending' doc='Send all pending SMS' /> + </params> + </command> + <command id='sms delete expired'> + <params> + <param name='sms' doc='SMS related commands' /> + <param name='delete' doc='SMS Database related commands' /> + <param name='expired' doc='Delete all expired SMS' /> + </params> + </command> + <command id='subscriber create imsi ID'> + <params> + <param name='subscriber' doc='Operations on a Subscriber' /> + <param name='create' doc='Create new subscriber' /> + <param name='imsi' doc='Identify the subscriber by his IMSI' /> + <param name='ID' doc='Identifier for the subscriber' /> + </params> + </command> + <command id='subscriber (msisdn|extension|imsi|tmsi|id) ID sms sender (msisdn|extension|imsi|tmsi|id) SENDER_ID send .LINE'> + <params> + <param name='subscriber' doc='Operations on a Subscriber' /> + <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' /> + <param name='extension' doc='Legacy alias for 'msisdn'' /> + <param name='imsi' doc='Identify subscriber by IMSI' /> + <param name='tmsi' doc='Identify subscriber by TMSI' /> + <param name='id' doc='Identify subscriber by database ID' /> + <param name='ID' doc='Identifier for the subscriber' /> + <param name='sms' doc='SMS Operations' /> + <param name='sender' doc='Operations on a Subscriber' /> + <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' /> + <param name='extension' doc='Legacy alias for 'msisdn'' /> + <param name='imsi' doc='Identify subscriber by IMSI' /> + <param name='tmsi' doc='Identify subscriber by TMSI' /> + <param name='id' doc='Identify subscriber by database ID' /> + <param name='SENDER_ID' doc='Identifier for the subscriber' /> + <param name='send' doc='Send SMS' /> + <param name='.LINE' doc='Actual SMS Text' /> + </params> + </command> + <command id='subscriber (msisdn|extension|imsi|tmsi|id) ID silent-sms sender (msisdn|extension|imsi|tmsi|id) SENDER_ID send .LINE'> + <params> + <param name='subscriber' doc='Operations on a Subscriber' /> + <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' /> + <param name='extension' doc='Legacy alias for 'msisdn'' /> + <param name='imsi' doc='Identify subscriber by IMSI' /> + <param name='tmsi' doc='Identify subscriber by TMSI' /> + <param name='id' doc='Identify subscriber by database ID' /> + <param name='ID' doc='Identifier for the subscriber' /> + <param name='silent-sms' doc='Silent SMS Operations' /> + <param name='sender' doc='Operations on a Subscriber' /> + <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' /> + <param name='extension' doc='Legacy alias for 'msisdn'' /> + <param name='imsi' doc='Identify subscriber by IMSI' /> + <param name='tmsi' doc='Identify subscriber by TMSI' /> + <param name='id' doc='Identify subscriber by database ID' /> + <param name='SENDER_ID' doc='Identifier for the subscriber' /> + <param name='send' doc='Send SMS' /> + <param name='.LINE' doc='Actual SMS Text' /> + </params> + </command> + <command id='subscriber (msisdn|extension|imsi|tmsi|id) ID silent-call start (any|tch/f|tch/any|sdcch)'> + <params> + <param name='subscriber' doc='Operations on a Subscriber' /> + <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' /> + <param name='extension' doc='Legacy alias for 'msisdn'' /> + <param name='imsi' doc='Identify subscriber by IMSI' /> + <param name='tmsi' doc='Identify subscriber by TMSI' /> + <param name='id' doc='Identify subscriber by database ID' /> + <param name='ID' doc='Identifier for the subscriber' /> + <param name='silent-call' doc='Silent call operation' /> + <param name='start' doc='Start silent call' /> + <param name='any' doc='Any channel' /> + <param name='tch/f' doc='TCH/F channel' /> + <param name='tch/any' doc='Any TCH channel' /> + <param name='sdcch' doc='SDCCH channel' /> + </params> + </command> + <command id='subscriber (msisdn|extension|imsi|tmsi|id) ID silent-call stop'> + <params> + <param name='subscriber' doc='Operations on a Subscriber' /> + <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' /> + <param name='extension' doc='Legacy alias for 'msisdn'' /> + <param name='imsi' doc='Identify subscriber by IMSI' /> + <param name='tmsi' doc='Identify subscriber by TMSI' /> + <param name='id' doc='Identify subscriber by database ID' /> + <param name='ID' doc='Identifier for the subscriber' /> + <param name='silent-call' doc='Silent call operation' /> + <param name='stop' doc='Stop silent call' /> + </params> + </command> + <command id='subscriber (msisdn|extension|imsi|tmsi|id) ID ussd-notify (0|1|2) .TEXT'> + <params> + <param name='subscriber' doc='Operations on a Subscriber' /> + <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' /> + <param name='extension' doc='Legacy alias for 'msisdn'' /> + <param name='imsi' doc='Identify subscriber by IMSI' /> + <param name='tmsi' doc='Identify subscriber by TMSI' /> + <param name='id' doc='Identify subscriber by database ID' /> + <param name='ID' doc='Identifier for the subscriber' /> + <param name='ussd-notify' doc='Send a USSD notify to the subscriber' /> + <param name='0' doc='Alerting Level 0' /> + <param name='1' doc='Alerting Level 1' /> + <param name='2' doc='Alerting Level 2' /> + <param name='.TEXT' doc='Text of USSD message to send' /> + </params> + </command> + <command id='subscriber (msisdn|extension|imsi|tmsi|id) ID ms-test close-loop (a|b|c|d|e|f|i)'> + <params> + <param name='subscriber' doc='Operations on a Subscriber' /> + <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' /> + <param name='extension' doc='Legacy alias for 'msisdn'' /> + <param name='imsi' doc='Identify subscriber by IMSI' /> + <param name='tmsi' doc='Identify subscriber by TMSI' /> + <param name='id' doc='Identify subscriber by database ID' /> + <param name='ID' doc='Identifier for the subscriber' /> + <param name='ms-test' doc='Send a TS 04.14 MS Test Command to subscriber' /> + <param name='close-loop' doc='Close a TCH Loop inside the MS' /> + <param name='a' doc='Loop Type A' /> + <param name='b' doc='Loop Type B' /> + <param name='c' doc='Loop Type C' /> + <param name='d' doc='Loop Type D' /> + <param name='e' doc='Loop Type E' /> + <param name='f' doc='Loop Type F' /> + <param name='i' doc='Loop Type I' /> + </params> + </command> + <command id='subscriber (msisdn|extension|imsi|tmsi|id) ID ms-test open-loop'> + <params> + <param name='subscriber' doc='Operations on a Subscriber' /> + <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' /> + <param name='extension' doc='Legacy alias for 'msisdn'' /> + <param name='imsi' doc='Identify subscriber by IMSI' /> + <param name='tmsi' doc='Identify subscriber by TMSI' /> + <param name='id' doc='Identify subscriber by database ID' /> + <param name='ID' doc='Identifier for the subscriber' /> + <param name='ms-test' doc='Send a TS 04.14 MS Test Command to subscriber' /> + <param name='open-loop' doc='Open a TCH Loop inside the MS' /> + </params> + </command> + <command id='subscriber (msisdn|extension|imsi|tmsi|id) ID paging'> + <params> + <param name='subscriber' doc='Operations on a Subscriber' /> + <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' /> + <param name='extension' doc='Legacy alias for 'msisdn'' /> + <param name='imsi' doc='Identify subscriber by IMSI' /> + <param name='tmsi' doc='Identify subscriber by TMSI' /> + <param name='id' doc='Identify subscriber by database ID' /> + <param name='ID' doc='Identifier for the subscriber' /> + <param name='paging' doc='Issue an empty Paging for the subscriber (for debugging)' /> + </params> + </command> + <command id='show statistics'> + <params> + <param name='show' doc='Show running system information' /> + <param name='statistics' doc='Display network statistics' /> + </params> + </command> + <command id='show sms-queue'> + <params> + <param name='show' doc='Show running system information' /> + <param name='sms-queue' doc='Display SMSqueue statistics' /> + </params> + </command> + <command id='logging filter imsi IMSI'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='filter' doc='Filter log messages' /> + <param name='imsi' doc='Filter log messages by IMSI' /> + <param name='IMSI' doc='IMSI to be used as filter' /> + </params> + </command> + <command id='show smpp esme'> + <params> + <param name='show' doc='Show running system information' /> + <param name='smpp' doc='SMPP Interface' /> + <param name='esme' doc='SMPP Extrenal SMS Entity' /> + </params> + </command> + </node> + <node id='enable'> + <name>enable</name> + <command id='disable'> + <params> + <param name='disable' doc='Turn off privileged mode command' /> + </params> + </command> + <command id='configure terminal'> + <params> + <param name='configure' doc='Configuration from vty interface' /> + <param name='terminal' doc='Configuration terminal' /> + </params> + </command> + <command id='copy running-config startup-config'> + <params> + <param name='copy' doc='Copy configuration' /> + <param name='running-config' doc='Copy running config to... ' /> + <param name='startup-config' doc='Copy running config to startup config (same as write file)' /> + </params> + </command> + <command id='show startup-config'> + <params> + <param name='show' doc='Show running system information' /> + <param name='startup-config' doc='Contentes of startup configuration' /> + </params> + </command> + <command id='show version'> + <params> + <param name='show' doc='Show running system information' /> + <param name='version' doc='Displays program version' /> + </params> + </command> + <command id='show online-help'> + <params> + <param name='show' doc='Show running system information' /> + <param name='online-help' doc='Online help' /> + </params> + </command> + <command id='terminal length <0-512>'> + <params> + <param name='terminal' doc='Set terminal line parameters' /> + <param name='length' doc='Set number of lines on a screen' /> + <param name='<0-512>' doc='Number of lines on screen (0 for no pausing)' /> + </params> + </command> + <command id='terminal no length'> + <params> + <param name='terminal' doc='Set terminal line parameters' /> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='length' doc='Set number of lines on a screen' /> + </params> + </command> + <command id='who'> + <params> + <param name='who' doc='Display who is on vty' /> + </params> + </command> + <command id='show history'> + <params> + <param name='show' doc='Show running system information' /> + <param name='history' doc='Display the session command history' /> + </params> + </command> + <command id='terminal monitor'> + <params> + <param name='terminal' doc='Set terminal line parameters' /> + <param name='monitor' doc='Copy debug output to the current terminal line' /> + </params> + </command> + <command id='terminal no monitor'> + <params> + <param name='terminal' doc='Set terminal line parameters' /> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='monitor' doc='Copy debug output to the current terminal line' /> + </params> + </command> + <command id='show cs7 instance <0-15> users'> + <params> + <param name='show' doc='Show running system information' /> + <param name='cs7' doc='ITU-T Signaling System 7' /> + <param name='instance' doc='An instance of the SS7 stack' /> + <param name='<0-15>' doc='An instance of the SS7 stack' /> + <param name='users' doc='User Table' /> + </params> + </command> + <command id='show cs7 (sua|m3ua|ipa) [<0-65534>]'> + <params> + <param name='show' doc='Show running system information' /> + <param name='cs7' doc='ITU-T Signaling System 7' /> + <param name='sua' doc='SCCP User Adaptation' /> + <param name='m3ua' doc='MTP3 User Adaptation' /> + <param name='ipa' doc='IPA Multiplex (SCCP Lite)' /> + <param name='[<0-65534>]' doc='Port Number' /> + </params> + </command> + <command id='show cs7 instance <0-15> asp'> + <params> + <param name='show' doc='Show running system information' /> + <param name='cs7' doc='ITU-T Signaling System 7' /> + <param name='instance' doc='An instance of the SS7 stack' /> + <param name='<0-15>' doc='An instance of the SS7 stack' /> + <param name='asp' doc='Application Server Process (ASP)' /> + </params> + </command> + <command id='show cs7 instance <0-15> as (active|all|m3ua|sua)'> + <params> + <param name='show' doc='Show running system information' /> + <param name='cs7' doc='ITU-T Signaling System 7' /> + <param name='instance' doc='An instance of the SS7 stack' /> + <param name='<0-15>' doc='An instance of the SS7 stack' /> + <param name='as' doc='Application Server (AS)' /> + <param name='active' doc='Display all active ASs' /> + <param name='all' doc='Display all ASs (default)' /> + <param name='m3ua' doc='Display all m3ua ASs' /> + <param name='sua' doc='Display all SUA ASs' /> + </params> + </command> + <command id='show cs7 instance <0-15> sccp addressbook'> + <params> + <param name='show' doc='Show running system information' /> + <param name='cs7' doc='ITU-T Signaling System 7' /> + <param name='instance' doc='An instance of the SS7 stack' /> + <param name='<0-15>' doc='An instance of the SS7 stack' /> + <param name='sccp' doc='Signalling Connection Control Part' /> + <param name='addressbook' doc='List all SCCP addressbook entries' /> + </params> + </command> + <command id='show cs7 instance <0-15> sccp users'> + <params> + <param name='show' doc='Show running system information' /> + <param name='cs7' doc='ITU-T Signaling System 7' /> + <param name='instance' doc='An instance of the SS7 stack' /> + <param name='<0-15>' doc='An instance of the SS7 stack' /> + <param name='sccp' doc='Signalling Connection Control Part' /> + <param name='users' doc='Show List of SCCP Users registered' /> + </params> + </command> + <command id='show cs7 instance <0-15> sccp ssn <0-65535>'> + <params> + <param name='show' doc='Show running system information' /> + <param name='cs7' doc='ITU-T Signaling System 7' /> + <param name='instance' doc='An instance of the SS7 stack' /> + <param name='<0-15>' doc='An instance of the SS7 stack' /> + <param name='sccp' doc='Signalling Connection Control Part' /> + <param name='ssn' doc='Find an SCCP User registered for the given SSN' /> + <param name='<0-65535>' doc='Subsystem Number (SSN)' /> + </params> + </command> + <command id='show cs7 instance <0-15> sccp connections'> + <params> + <param name='show' doc='Show running system information' /> + <param name='cs7' doc='ITU-T Signaling System 7' /> + <param name='instance' doc='An instance of the SS7 stack' /> + <param name='<0-15>' doc='An instance of the SS7 stack' /> + <param name='sccp' doc='Signalling Connection Control Part' /> + <param name='connections' doc='Show List of active SCCP connections' /> + </params> + </command> + <command id='show cs7 instance <0-15> sccp timers'> + <params> + <param name='show' doc='Show running system information' /> + <param name='cs7' doc='ITU-T Signaling System 7' /> + <param name='instance' doc='An instance of the SS7 stack' /> + <param name='<0-15>' doc='An instance of the SS7 stack' /> + <param name='sccp' doc='Signaling Connection Control Part' /> + <param name='timers' doc='Show List of SCCP timers' /> + </params> + </command> + <command id='logging enable'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='enable' doc='Enables logging to this vty' /> + </params> + </command> + <command id='logging disable'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='disable' doc='Disables logging to this vty' /> + </params> + </command> + <command id='logging filter all (0|1)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='filter' doc='Filter log messages' /> + <param name='all' doc='Do you want to log all messages?' /> + <param name='0' doc='Only print messages matched by other filters' /> + <param name='1' doc='Bypass filter and print all messages' /> + </params> + </command> + <command id='logging color (0|1)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='color' doc='Configure color-printing for log messages' /> + <param name='0' doc='Don't use color for printing messages' /> + <param name='1' doc='Use color for printing messages' /> + </params> + </command> + <command id='logging timestamp (0|1)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='timestamp' doc='Configure log message timestamping' /> + <param name='0' doc='Don't prefix each log message' /> + <param name='1' doc='Prefix each log message with current timestamp' /> + </params> + </command> + <command id='logging print extended-timestamp (0|1)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='print' doc='Log output settings' /> + <param name='extended-timestamp' doc='Configure log message timestamping' /> + <param name='0' doc='Don't prefix each log message' /> + <param name='1' doc='Prefix each log message with current timestamp with YYYYMMDDhhmmssnnn' /> + </params> + </command> + <command id='logging print category (0|1)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='print' doc='Log output settings' /> + <param name='category' doc='Configure log message' /> + <param name='0' doc='Don't prefix each log message' /> + <param name='1' doc='Prefix each log message with category/subsystem name' /> + </params> + </command> + <command id='logging print category-hex (0|1)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='print' doc='Log output settings' /> + <param name='category-hex' doc='Configure log message' /> + <param name='0' doc='Don't prefix each log message' /> + <param name='1' doc='Prefix each log message with category/subsystem nr in hex ('<000b>')' /> + </params> + </command> + <command id='logging print level (0|1)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='print' doc='Log output settings' /> + <param name='level' doc='Configure log message' /> + <param name='0' doc='Don't prefix each log message' /> + <param name='1' doc='Prefix each log message with the log level name' /> + </params> + </command> + <command id='logging print file (0|1|basename) [last]'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='print' doc='Log output settings' /> + <param name='file' doc='Configure log message' /> + <param name='0' doc='Don't prefix each log message' /> + <param name='1' doc='Prefix each log message with the source file and line' /> + <param name='basename' doc='Prefix each log message with the source file's basename (strip leading paths) and line' /> + <param name='[last]' doc='Log source file info at the end of a log line. If omitted, log source file info just before the log text.' /> + </params> + </command> + <command id='logging set-log-mask MASK'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='set-log-mask' doc='Set the logmask of this logging target' /> + <param name='MASK' doc='List of logging categories to log, e.g. 'abc:mno:xyz'. Available log categories depend on the specific application, refer to the 'logging level' command. Optionally add individual log levels like 'abc,1:mno,3:xyz,5', where the level numbers are LOGL_DEBUG=1 LOGL_INFO=3 LOGL_NOTICE=5 LOGL_ERROR=7 LOGL_FATAL=8' /> + </params> + </command> + <command id='logging level (rll|cc|mm|rr|mncc|pag|msc|mgcp|ho|db|ref|ctrl|smpp|ranap|vlr|iucs|bssap|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf) (debug|info|notice|error|fatal)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='level' doc='Set the log level for a specified category' /> + <param name='rll' doc='A-bis Radio Link Layer (RLL)' /> + <param name='cc' doc='Layer3 Call Control (CC)' /> + <param name='mm' doc='Layer3 Mobility Management (MM)' /> + <param name='rr' doc='Layer3 Radio Resource (RR)' /> + <param name='mncc' doc='MNCC API for Call Control application' /> + <param name='pag' doc='Paging Subsystem' /> + <param name='msc' doc='Mobile Switching Center' /> + <param name='mgcp' doc='Media Gateway Control Protocol' /> + <param name='ho' doc='Hand-Over' /> + <param name='db' doc='Database Layer' /> + <param name='ref' doc='Reference Counting' /> + <param name='ctrl' doc='Control interface' /> + <param name='smpp' doc='SMPP interface for external SMS apps' /> + <param name='ranap' doc='Radio Access Network Application Part Protocol' /> + <param name='vlr' doc='Visitor Location Register' /> + <param name='iucs' doc='Iu-CS Protocol' /> + <param name='bssap' doc='BSSAP Protocol (A Interface)' /> + <param name='lglobal' doc='Library-internal global log family' /> + <param name='llapd' doc='LAPD in libosmogsm' /> + <param name='linp' doc='A-bis Intput Subsystem' /> + <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' /> + <param name='lmi' doc='A-bis Input Driver for Signalling' /> + <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' /> + <param name='lsms' doc='Layer3 Short Message Service (SMS)' /> + <param name='lctrl' doc='Control Interface' /> + <param name='lgtp' doc='GPRS GTP library' /> + <param name='lstats' doc='Statistics messages and logging' /> + <param name='lgsup' doc='Generic Subscriber Update Protocol' /> + <param name='loap' doc='Osmocom Authentication Protocol' /> + <param name='lss7' doc='libosmo-sigtran Signalling System 7' /> + <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' /> + <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' /> + <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' /> + <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' /> + <param name='ljibuf' doc='libosmo-netif Jitter Buffer' /> + <param name='debug' doc='Log debug messages and higher levels' /> + <param name='info' doc='Log informational messages and higher levels' /> + <param name='notice' doc='Log noticeable messages and higher levels' /> + <param name='error' doc='Log error messages and higher levels' /> + <param name='fatal' doc='Log only fatal messages' /> + </params> + </command> + <command id='logging level set-all (debug|info|notice|error|fatal)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='level' doc='Set the log level for a specified category' /> + <param name='set-all' doc='Once-off set all categories to the given log level. There is no single command to take back these changes -- each category is set to the given level, period.' /> + <param name='debug' doc='Log debug messages and higher levels' /> + <param name='info' doc='Log informational messages and higher levels' /> + <param name='notice' doc='Log noticeable messages and higher levels' /> + <param name='error' doc='Log error messages and higher levels' /> + <param name='fatal' doc='Log only fatal messages' /> + </params> + </command> + <command id='logging level force-all (debug|info|notice|error|fatal)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='level' doc='Set the log level for a specified category' /> + <param name='force-all' doc='Globally force all logging categories to a specific level. This is released by the 'no logging level force-all' command. Note: any 'logging level <category> <level>' commands will have no visible effect after this, until the forced level is released.' /> + <param name='debug' doc='Log debug messages and higher levels' /> + <param name='info' doc='Log informational messages and higher levels' /> + <param name='notice' doc='Log noticeable messages and higher levels' /> + <param name='error' doc='Log error messages and higher levels' /> + <param name='fatal' doc='Log only fatal messages' /> + </params> + </command> + <command id='no logging level force-all'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='logging' doc='Configure logging' /> + <param name='level' doc='Set the log level for a specified category' /> + <param name='force-all' doc='Release any globally forced log level set with 'logging level force-all <level>'' /> + </params> + </command> + <command id='show logging vty'> + <params> + <param name='show' doc='Show running system information' /> + <param name='logging' doc='Show current logging configuration' /> + <param name='vty' doc='Show current logging configuration for this vty' /> + </params> + </command> + <command id='show alarms'> + <params> + <param name='show' doc='Show running system information' /> + <param name='alarms' doc='Show current logging configuration' /> + </params> + </command> + <command id='show talloc-context (application|all) (full|brief|DEPTH)'> + <params> + <param name='show' doc='Show running system information' /> + <param name='talloc-context' doc='Show talloc memory hierarchy' /> + <param name='application' doc='Application's context' /> + <param name='all' doc='All contexts, if NULL-context tracking is enabled' /> + <param name='full' doc='Display a full talloc memory hierarchy' /> + <param name='brief' doc='Display a brief talloc memory hierarchy' /> + <param name='DEPTH' doc='Specify required maximal depth value' /> + </params> + </command> + <command id='show talloc-context (application|all) (full|brief|DEPTH) tree ADDRESS'> + <params> + <param name='show' doc='Show running system information' /> + <param name='talloc-context' doc='Show talloc memory hierarchy' /> + <param name='application' doc='Application's context' /> + <param name='all' doc='All contexts, if NULL-context tracking is enabled' /> + <param name='full' doc='Display a full talloc memory hierarchy' /> + <param name='brief' doc='Display a brief talloc memory hierarchy' /> + <param name='DEPTH' doc='Specify required maximal depth value' /> + <param name='tree' doc='Display only a specific memory chunk' /> + <param name='ADDRESS' doc='Chunk address (e.g. 0xdeadbeef)' /> + </params> + </command> + <command id='show talloc-context (application|all) (full|brief|DEPTH) filter REGEXP'> + <params> + <param name='show' doc='Show running system information' /> + <param name='talloc-context' doc='Show talloc memory hierarchy' /> + <param name='application' doc='Application's context' /> + <param name='all' doc='All contexts, if NULL-context tracking is enabled' /> + <param name='full' doc='Display a full talloc memory hierarchy' /> + <param name='brief' doc='Display a brief talloc memory hierarchy' /> + <param name='DEPTH' doc='Specify required maximal depth value' /> + <param name='filter' doc='Filter chunks using regular expression' /> + <param name='REGEXP' doc='Regular expression' /> + </params> + </command> + <command id='show stats'> + <params> + <param name='show' doc='Show running system information' /> + <param name='stats' doc='Show statistical values' /> + </params> + </command> + <command id='show stats level (global|peer|subscriber)'> + <params> + <param name='show' doc='Show running system information' /> + <param name='stats' doc='Show statistical values' /> + <param name='level' doc='Set the maximum group level' /> + <param name='global' doc='Show global groups only' /> + <param name='peer' doc='Show global and network peer related groups' /> + <param name='subscriber' doc='Show global, peer, and subscriber groups' /> + </params> + </command> + <command id='show asciidoc counters'> + <params> + <param name='show' doc='Show running system information' /> + <param name='asciidoc' doc='Asciidoc generation' /> + <param name='counters' doc='Generate table of all registered counters' /> + </params> + </command> + <command id='show rate-counters'> + <params> + <param name='show' doc='Show running system information' /> + <param name='rate-counters' doc='Show all rate counters' /> + </params> + </command> + <command id='show fsm NAME'> + <params> + <param name='show' doc='Show running system information' /> + <param name='fsm' doc='Show information about finite state machines' /> + <param name='NAME' doc='Display information about a single named finite state machine' /> + </params> + </command> + <command id='show fsm all'> + <params> + <param name='show' doc='Show running system information' /> + <param name='fsm' doc='Show information about finite state machines' /> + <param name='all' doc='Display a list of all registered finite state machines' /> + </params> + </command> + <command id='show fsm-instances NAME'> + <params> + <param name='show' doc='Show running system information' /> + <param name='fsm-instances' doc='Show information about finite state machine instances' /> + <param name='NAME' doc='Display a list of all FSM instances of the named finite state machine' /> + </params> + </command> + <command id='show fsm-instances all'> + <params> + <param name='show' doc='Show running system information' /> + <param name='fsm-instances' doc='Show information about finite state machine instances' /> + <param name='all' doc='Display a list of all FSM instances of all finite state machine' /> + </params> + </command> + <command id='show subscriber (msisdn|extension|imsi|tmsi|id) ID'> + <params> + <param name='show' doc='Show running system information' /> + <param name='subscriber' doc='Operations on a Subscriber' /> + <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' /> + <param name='extension' doc='Legacy alias for 'msisdn'' /> + <param name='imsi' doc='Identify subscriber by IMSI' /> + <param name='tmsi' doc='Identify subscriber by TMSI' /> + <param name='id' doc='Identify subscriber by database ID' /> + <param name='ID' doc='Identifier for the subscriber' /> + </params> + </command> + <command id='show subscriber cache'> + <params> + <param name='show' doc='Show running system information' /> + <param name='subscriber' doc='Show information about subscribers' /> + <param name='cache' doc='Display contents of subscriber cache' /> + </params> + </command> + <command id='show connection'> + <params> + <param name='show' doc='Show running system information' /> + <param name='connection' doc='Subscriber Connections' /> + </params> + </command> + <command id='show transaction'> + <params> + <param name='show' doc='Show running system information' /> + <param name='transaction' doc='Transactions' /> + </params> + </command> + <command id='sms send pending'> + <params> + <param name='sms' doc='SMS related commands' /> + <param name='send' doc='SMS Sending related commands' /> + <param name='pending' doc='Send all pending SMS' /> + </params> + </command> + <command id='sms delete expired'> + <params> + <param name='sms' doc='SMS related commands' /> + <param name='delete' doc='SMS Database related commands' /> + <param name='expired' doc='Delete all expired SMS' /> + </params> + </command> + <command id='subscriber create imsi ID'> + <params> + <param name='subscriber' doc='Operations on a Subscriber' /> + <param name='create' doc='Create new subscriber' /> + <param name='imsi' doc='Identify the subscriber by his IMSI' /> + <param name='ID' doc='Identifier for the subscriber' /> + </params> + </command> + <command id='subscriber (msisdn|extension|imsi|tmsi|id) ID sms sender (msisdn|extension|imsi|tmsi|id) SENDER_ID send .LINE'> + <params> + <param name='subscriber' doc='Operations on a Subscriber' /> + <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' /> + <param name='extension' doc='Legacy alias for 'msisdn'' /> + <param name='imsi' doc='Identify subscriber by IMSI' /> + <param name='tmsi' doc='Identify subscriber by TMSI' /> + <param name='id' doc='Identify subscriber by database ID' /> + <param name='ID' doc='Identifier for the subscriber' /> + <param name='sms' doc='SMS Operations' /> + <param name='sender' doc='Operations on a Subscriber' /> + <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' /> + <param name='extension' doc='Legacy alias for 'msisdn'' /> + <param name='imsi' doc='Identify subscriber by IMSI' /> + <param name='tmsi' doc='Identify subscriber by TMSI' /> + <param name='id' doc='Identify subscriber by database ID' /> + <param name='SENDER_ID' doc='Identifier for the subscriber' /> + <param name='send' doc='Send SMS' /> + <param name='.LINE' doc='Actual SMS Text' /> + </params> + </command> + <command id='subscriber (msisdn|extension|imsi|tmsi|id) ID silent-sms sender (msisdn|extension|imsi|tmsi|id) SENDER_ID send .LINE'> + <params> + <param name='subscriber' doc='Operations on a Subscriber' /> + <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' /> + <param name='extension' doc='Legacy alias for 'msisdn'' /> + <param name='imsi' doc='Identify subscriber by IMSI' /> + <param name='tmsi' doc='Identify subscriber by TMSI' /> + <param name='id' doc='Identify subscriber by database ID' /> + <param name='ID' doc='Identifier for the subscriber' /> + <param name='silent-sms' doc='Silent SMS Operations' /> + <param name='sender' doc='Operations on a Subscriber' /> + <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' /> + <param name='extension' doc='Legacy alias for 'msisdn'' /> + <param name='imsi' doc='Identify subscriber by IMSI' /> + <param name='tmsi' doc='Identify subscriber by TMSI' /> + <param name='id' doc='Identify subscriber by database ID' /> + <param name='SENDER_ID' doc='Identifier for the subscriber' /> + <param name='send' doc='Send SMS' /> + <param name='.LINE' doc='Actual SMS Text' /> + </params> + </command> + <command id='subscriber (msisdn|extension|imsi|tmsi|id) ID silent-call start (any|tch/f|tch/any|sdcch)'> + <params> + <param name='subscriber' doc='Operations on a Subscriber' /> + <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' /> + <param name='extension' doc='Legacy alias for 'msisdn'' /> + <param name='imsi' doc='Identify subscriber by IMSI' /> + <param name='tmsi' doc='Identify subscriber by TMSI' /> + <param name='id' doc='Identify subscriber by database ID' /> + <param name='ID' doc='Identifier for the subscriber' /> + <param name='silent-call' doc='Silent call operation' /> + <param name='start' doc='Start silent call' /> + <param name='any' doc='Any channel' /> + <param name='tch/f' doc='TCH/F channel' /> + <param name='tch/any' doc='Any TCH channel' /> + <param name='sdcch' doc='SDCCH channel' /> + </params> + </command> + <command id='subscriber (msisdn|extension|imsi|tmsi|id) ID silent-call stop'> + <params> + <param name='subscriber' doc='Operations on a Subscriber' /> + <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' /> + <param name='extension' doc='Legacy alias for 'msisdn'' /> + <param name='imsi' doc='Identify subscriber by IMSI' /> + <param name='tmsi' doc='Identify subscriber by TMSI' /> + <param name='id' doc='Identify subscriber by database ID' /> + <param name='ID' doc='Identifier for the subscriber' /> + <param name='silent-call' doc='Silent call operation' /> + <param name='stop' doc='Stop silent call' /> + </params> + </command> + <command id='subscriber (msisdn|extension|imsi|tmsi|id) ID ussd-notify (0|1|2) .TEXT'> + <params> + <param name='subscriber' doc='Operations on a Subscriber' /> + <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' /> + <param name='extension' doc='Legacy alias for 'msisdn'' /> + <param name='imsi' doc='Identify subscriber by IMSI' /> + <param name='tmsi' doc='Identify subscriber by TMSI' /> + <param name='id' doc='Identify subscriber by database ID' /> + <param name='ID' doc='Identifier for the subscriber' /> + <param name='ussd-notify' doc='Send a USSD notify to the subscriber' /> + <param name='0' doc='Alerting Level 0' /> + <param name='1' doc='Alerting Level 1' /> + <param name='2' doc='Alerting Level 2' /> + <param name='.TEXT' doc='Text of USSD message to send' /> + </params> + </command> + <command id='subscriber (msisdn|extension|imsi|tmsi|id) ID ms-test close-loop (a|b|c|d|e|f|i)'> + <params> + <param name='subscriber' doc='Operations on a Subscriber' /> + <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' /> + <param name='extension' doc='Legacy alias for 'msisdn'' /> + <param name='imsi' doc='Identify subscriber by IMSI' /> + <param name='tmsi' doc='Identify subscriber by TMSI' /> + <param name='id' doc='Identify subscriber by database ID' /> + <param name='ID' doc='Identifier for the subscriber' /> + <param name='ms-test' doc='Send a TS 04.14 MS Test Command to subscriber' /> + <param name='close-loop' doc='Close a TCH Loop inside the MS' /> + <param name='a' doc='Loop Type A' /> + <param name='b' doc='Loop Type B' /> + <param name='c' doc='Loop Type C' /> + <param name='d' doc='Loop Type D' /> + <param name='e' doc='Loop Type E' /> + <param name='f' doc='Loop Type F' /> + <param name='i' doc='Loop Type I' /> + </params> + </command> + <command id='subscriber (msisdn|extension|imsi|tmsi|id) ID ms-test open-loop'> + <params> + <param name='subscriber' doc='Operations on a Subscriber' /> + <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' /> + <param name='extension' doc='Legacy alias for 'msisdn'' /> + <param name='imsi' doc='Identify subscriber by IMSI' /> + <param name='tmsi' doc='Identify subscriber by TMSI' /> + <param name='id' doc='Identify subscriber by database ID' /> + <param name='ID' doc='Identifier for the subscriber' /> + <param name='ms-test' doc='Send a TS 04.14 MS Test Command to subscriber' /> + <param name='open-loop' doc='Open a TCH Loop inside the MS' /> + </params> + </command> + <command id='subscriber (msisdn|extension|imsi|tmsi|id) ID paging'> + <params> + <param name='subscriber' doc='Operations on a Subscriber' /> + <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' /> + <param name='extension' doc='Legacy alias for 'msisdn'' /> + <param name='imsi' doc='Identify subscriber by IMSI' /> + <param name='tmsi' doc='Identify subscriber by TMSI' /> + <param name='id' doc='Identify subscriber by database ID' /> + <param name='ID' doc='Identifier for the subscriber' /> + <param name='paging' doc='Issue an empty Paging for the subscriber (for debugging)' /> + </params> + </command> + <command id='show statistics'> + <params> + <param name='show' doc='Show running system information' /> + <param name='statistics' doc='Display network statistics' /> + </params> + </command> + <command id='show sms-queue'> + <params> + <param name='show' doc='Show running system information' /> + <param name='sms-queue' doc='Display SMSqueue statistics' /> + </params> + </command> + <command id='logging filter imsi IMSI'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='filter' doc='Filter log messages' /> + <param name='imsi' doc='Filter log messages by IMSI' /> + <param name='IMSI' doc='IMSI to be used as filter' /> + </params> + </command> + <command id='subscriber (msisdn|extension|imsi|tmsi|id) ID expire'> + <params> + <param name='subscriber' doc='Operations on a Subscriber' /> + <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' /> + <param name='extension' doc='Legacy alias for 'msisdn'' /> + <param name='imsi' doc='Identify subscriber by IMSI' /> + <param name='tmsi' doc='Identify subscriber by TMSI' /> + <param name='id' doc='Identify subscriber by database ID' /> + <param name='ID' doc='Identifier for the subscriber' /> + <param name='expire' doc='Expire the subscriber Now' /> + </params> + </command> + <command id='sms-queue trigger'> + <params> + <param name='sms-queue' doc='SMS Queue' /> + <param name='trigger' doc='Trigger sending messages' /> + </params> + </command> + <command id='sms-queue max-pending <1-500>'> + <params> + <param name='sms-queue' doc='SMS Queue' /> + <param name='max-pending' doc='SMS to deliver in parallel' /> + <param name='<1-500>' doc='Amount' /> + </params> + </command> + <command id='sms-queue clear'> + <params> + <param name='sms-queue' doc='SMS Queue' /> + <param name='clear' doc='Clear the queue of pending SMS' /> + </params> + </command> + <command id='sms-queue max-failure <1-500>'> + <params> + <param name='sms-queue' doc='SMS Queue' /> + <param name='max-failure' doc='Maximum amount of delivery failures' /> + <param name='<1-500>' doc='Amount' /> + </params> + </command> + <command id='subscriber (msisdn|extension|imsi|tmsi|id) ID sms pending-send'> + <params> + <param name='subscriber' doc='Operations on a Subscriber' /> + <param name='msisdn' doc='Identify subscriber by MSISDN (phone number)' /> + <param name='extension' doc='Legacy alias for 'msisdn'' /> + <param name='imsi' doc='Identify subscriber by IMSI' /> + <param name='tmsi' doc='Identify subscriber by TMSI' /> + <param name='id' doc='Identify subscriber by database ID' /> + <param name='ID' doc='Identifier for the subscriber' /> + <param name='sms' doc='SMS Operations' /> + <param name='pending-send' doc='Send pending SMS' /> + </params> + </command> + <command id='show smpp esme'> + <params> + <param name='show' doc='Show running system information' /> + <param name='smpp' doc='SMPP Interface' /> + <param name='esme' doc='SMPP Extrenal SMS Entity' /> + </params> + </command> + </node> + <node id='config'> + <name>config</name> + <command id='hostname WORD'> + <params> + <param name='hostname' doc='Set system's network name' /> + <param name='WORD' doc='This system's network name' /> + </params> + </command> + <command id='no hostname [HOSTNAME]'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='hostname' doc='Reset system's network name' /> + <param name='[HOSTNAME]' doc='Host name of this router' /> + </params> + </command> + <command id='password (8|) WORD'> + <params> + <param name='password' doc='Assign the terminal connection password' /> + <param name='8' doc='Specifies a HIDDEN password will follow' /> + <param name='' doc='dummy string ' /> + <param name='WORD' doc='The HIDDEN line password string' /> + </params> + </command> + <command id='password LINE'> + <params> + <param name='password' doc='Assign the terminal connection password' /> + <param name='LINE' doc='The UNENCRYPTED (cleartext) line password' /> + </params> + </command> + <command id='enable password (8|) WORD'> + <params> + <param name='enable' doc='Modify enable password parameters' /> + <param name='password' doc='Assign the privileged level password' /> + <param name='8' doc='Specifies a HIDDEN password will follow' /> + <param name='' doc='dummy string ' /> + <param name='WORD' doc='The HIDDEN 'enable' password string' /> + </params> + </command> + <command id='enable password LINE'> + <params> + <param name='enable' doc='Modify enable password parameters' /> + <param name='password' doc='Assign the privileged level password' /> + <param name='LINE' doc='The UNENCRYPTED (cleartext) 'enable' password' /> + </params> + </command> + <command id='no enable password'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='enable' doc='Modify enable password parameters' /> + <param name='password' doc='Assign the privileged level password' /> + </params> + </command> + <command id='banner motd default'> + <params> + <param name='banner' doc='Set banner string' /> + <param name='motd' doc='Strings for motd' /> + <param name='default' doc='Default string' /> + </params> + </command> + <command id='banner motd file [FILE]'> + <params> + <param name='banner' doc='Set banner' /> + <param name='motd' doc='Banner for motd' /> + <param name='file' doc='Banner from a file' /> + <param name='[FILE]' doc='Filename' /> + </params> + </command> + <command id='no banner motd'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='banner' doc='Set banner string' /> + <param name='motd' doc='Strings for motd' /> + </params> + </command> + <command id='service terminal-length <0-512>'> + <params> + <param name='service' doc='Set up miscellaneous service' /> + <param name='terminal-length' doc='System wide terminal length configuration' /> + <param name='<0-512>' doc='Number of lines of VTY (0 means no line control)' /> + </params> + </command> + <command id='no service terminal-length [<0-512>]'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='service' doc='Set up miscellaneous service' /> + <param name='terminal-length' doc='System wide terminal length configuration' /> + <param name='[<0-512>]' doc='Number of lines of VTY (0 means no line control)' /> + </params> + </command> + <command id='line vty'> + <params> + <param name='line' doc='Configure a terminal line' /> + <param name='vty' doc='Virtual terminal' /> + </params> + </command> + <command id='service advanced-vty'> + <params> + <param name='service' doc='Set up miscellaneous service' /> + <param name='advanced-vty' doc='Enable advanced mode vty interface' /> + </params> + </command> + <command id='no service advanced-vty'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='service' doc='Set up miscellaneous service' /> + <param name='advanced-vty' doc='Enable advanced mode vty interface' /> + </params> + </command> + <command id='show history'> + <params> + <param name='show' doc='Show running system information' /> + <param name='history' doc='Display the session command history' /> + </params> + </command> + <command id='cs7 instance <0-15>'> + <params> + <param name='cs7' doc='ITU-T Signaling System 7' /> + <param name='instance' doc='Configure a SS7 Instance' /> + <param name='<0-15>' doc='An instance of the SS7 stack' /> + </params> + </command> + <command id='ctrl'> + <params> + <param name='ctrl' doc='Configure the Control Interface' /> + </params> + </command> + <command id='log stderr'> + <params> + <param name='log' doc='Configure logging sub-system' /> + <param name='stderr' doc='Logging via STDERR of the process' /> + </params> + </command> + <command id='no log stderr'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='log' doc='Configure logging sub-system' /> + <param name='stderr' doc='Logging via STDERR of the process' /> + </params> + </command> + <command id='log file .FILENAME'> + <params> + <param name='log' doc='Configure logging sub-system' /> + <param name='file' doc='Logging to text file' /> + <param name='.FILENAME' doc='Filename' /> + </params> + </command> + <command id='no log file .FILENAME'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='log' doc='Configure logging sub-system' /> + <param name='file' doc='Logging to text file' /> + <param name='.FILENAME' doc='Filename' /> + </params> + </command> + <command id='log alarms <2-32700>'> + <params> + <param name='log' doc='Configure logging sub-system' /> + <param name='alarms' doc='Logging alarms to osmo_strrb' /> + <param name='<2-32700>' doc='Maximum number of messages to log' /> + </params> + </command> + <command id='no log alarms'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='log' doc='Configure logging sub-system' /> + <param name='alarms' doc='Logging alarms to osmo_strrb' /> + </params> + </command> + <command id='log syslog (authpriv|cron|daemon|ftp|lpr|mail|news|user|uucp)'> + <params> + <param name='log' doc='Configure logging sub-system' /> + <param name='syslog' doc='Logging via syslog' /> + <param name='authpriv' doc='Security/authorization messages facility' /> + <param name='cron' doc='Clock daemon (cron/at) facility' /> + <param name='daemon' doc='General system daemon facility' /> + <param name='ftp' doc='Ftp daemon facility' /> + <param name='lpr' doc='Line printer facility' /> + <param name='mail' doc='Mail facility' /> + <param name='news' doc='News facility' /> + <param name='user' doc='Generic facility' /> + <param name='uucp' doc='UUCP facility' /> + </params> + </command> + <command id='log syslog local <0-7>'> + <params> + <param name='log' doc='Configure logging sub-system' /> + <param name='syslog' doc='Logging via syslog' /> + <param name='local' doc='Syslog LOCAL facility' /> + <param name='<0-7>' doc='Local facility number' /> + </params> + </command> + <command id='no log syslog'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='log' doc='Configure logging sub-system' /> + <param name='syslog' doc='Logging via syslog' /> + </params> + </command> + <command id='log gsmtap [HOSTNAME]'> + <params> + <param name='log' doc='Configure logging sub-system' /> + <param name='gsmtap' doc='Logging via GSMTAP' /> + <param name='[HOSTNAME]' doc='Host name to send the GSMTAP logging to (UDP port 4729)' /> + </params> + </command> + <command id='stats reporter statsd'> + <params> + <param name='stats' doc='Configure stats sub-system' /> + <param name='reporter' doc='Configure a stats reporter' /> + <param name='statsd' doc='Report to a STATSD server' /> + </params> + </command> + <command id='no stats reporter statsd'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='stats' doc='Configure stats sub-system' /> + <param name='reporter' doc='Configure a stats reporter' /> + <param name='statsd' doc='Report to a STATSD server' /> + </params> + </command> + <command id='stats reporter log'> + <params> + <param name='stats' doc='Configure stats sub-system' /> + <param name='reporter' doc='Configure a stats reporter' /> + <param name='log' doc='Report to the logger' /> + </params> + </command> + <command id='no stats reporter log'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='stats' doc='Configure stats sub-system' /> + <param name='reporter' doc='Configure a stats reporter' /> + <param name='log' doc='Report to the logger' /> + </params> + </command> + <command id='stats interval <1-65535>'> + <params> + <param name='stats' doc='Configure stats sub-system' /> + <param name='interval' doc='Set the reporting interval' /> + <param name='<1-65535>' doc='Interval in seconds' /> + </params> + </command> + <command id='network'> + <params> + <param name='network' doc='Configure the GSM network' /> + </params> + </command> + <command id='msc'> + <params> + <param name='msc' doc='Configure MSC options' /> + </params> + </command> + <command id='mncc-int'> + <params> + <param name='mncc-int' doc='Configure internal MNCC handler' /> + </params> + </command> + <command id='hlr'> + <params> + <param name='hlr' doc='Configure connection to the HLR' /> + </params> + </command> + <command id='smpp'> + <params> + <param name='smpp' doc='Configure SMPP SMS Interface' /> + </params> + </command> + </node> + <node id='config-log'> + <name>config-log</name> + <command id='logging filter all (0|1)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='filter' doc='Filter log messages' /> + <param name='all' doc='Do you want to log all messages?' /> + <param name='0' doc='Only print messages matched by other filters' /> + <param name='1' doc='Bypass filter and print all messages' /> + </params> + </command> + <command id='logging color (0|1)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='color' doc='Configure color-printing for log messages' /> + <param name='0' doc='Don't use color for printing messages' /> + <param name='1' doc='Use color for printing messages' /> + </params> + </command> + <command id='logging timestamp (0|1)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='timestamp' doc='Configure log message timestamping' /> + <param name='0' doc='Don't prefix each log message' /> + <param name='1' doc='Prefix each log message with current timestamp' /> + </params> + </command> + <command id='logging print extended-timestamp (0|1)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='print' doc='Log output settings' /> + <param name='extended-timestamp' doc='Configure log message timestamping' /> + <param name='0' doc='Don't prefix each log message' /> + <param name='1' doc='Prefix each log message with current timestamp with YYYYMMDDhhmmssnnn' /> + </params> + </command> + <command id='logging print category (0|1)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='print' doc='Log output settings' /> + <param name='category' doc='Configure log message' /> + <param name='0' doc='Don't prefix each log message' /> + <param name='1' doc='Prefix each log message with category/subsystem name' /> + </params> + </command> + <command id='logging print category-hex (0|1)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='print' doc='Log output settings' /> + <param name='category-hex' doc='Configure log message' /> + <param name='0' doc='Don't prefix each log message' /> + <param name='1' doc='Prefix each log message with category/subsystem nr in hex ('<000b>')' /> + </params> + </command> + <command id='logging print level (0|1)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='print' doc='Log output settings' /> + <param name='level' doc='Configure log message' /> + <param name='0' doc='Don't prefix each log message' /> + <param name='1' doc='Prefix each log message with the log level name' /> + </params> + </command> + <command id='logging print file (0|1|basename) [last]'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='print' doc='Log output settings' /> + <param name='file' doc='Configure log message' /> + <param name='0' doc='Don't prefix each log message' /> + <param name='1' doc='Prefix each log message with the source file and line' /> + <param name='basename' doc='Prefix each log message with the source file's basename (strip leading paths) and line' /> + <param name='[last]' doc='Log source file info at the end of a log line. If omitted, log source file info just before the log text.' /> + </params> + </command> + <command id='logging level (rll|cc|mm|rr|mncc|pag|msc|mgcp|ho|db|ref|ctrl|smpp|ranap|vlr|iucs|bssap|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf) (debug|info|notice|error|fatal)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='level' doc='Set the log level for a specified category' /> + <param name='rll' doc='A-bis Radio Link Layer (RLL)' /> + <param name='cc' doc='Layer3 Call Control (CC)' /> + <param name='mm' doc='Layer3 Mobility Management (MM)' /> + <param name='rr' doc='Layer3 Radio Resource (RR)' /> + <param name='mncc' doc='MNCC API for Call Control application' /> + <param name='pag' doc='Paging Subsystem' /> + <param name='msc' doc='Mobile Switching Center' /> + <param name='mgcp' doc='Media Gateway Control Protocol' /> + <param name='ho' doc='Hand-Over' /> + <param name='db' doc='Database Layer' /> + <param name='ref' doc='Reference Counting' /> + <param name='ctrl' doc='Control interface' /> + <param name='smpp' doc='SMPP interface for external SMS apps' /> + <param name='ranap' doc='Radio Access Network Application Part Protocol' /> + <param name='vlr' doc='Visitor Location Register' /> + <param name='iucs' doc='Iu-CS Protocol' /> + <param name='bssap' doc='BSSAP Protocol (A Interface)' /> + <param name='lglobal' doc='Library-internal global log family' /> + <param name='llapd' doc='LAPD in libosmogsm' /> + <param name='linp' doc='A-bis Intput Subsystem' /> + <param name='lmux' doc='A-bis B-Subchannel TRAU Frame Multiplex' /> + <param name='lmi' doc='A-bis Input Driver for Signalling' /> + <param name='lmib' doc='A-bis Input Driver for B-Channels (voice)' /> + <param name='lsms' doc='Layer3 Short Message Service (SMS)' /> + <param name='lctrl' doc='Control Interface' /> + <param name='lgtp' doc='GPRS GTP library' /> + <param name='lstats' doc='Statistics messages and logging' /> + <param name='lgsup' doc='Generic Subscriber Update Protocol' /> + <param name='loap' doc='Osmocom Authentication Protocol' /> + <param name='lss7' doc='libosmo-sigtran Signalling System 7' /> + <param name='lsccp' doc='libosmo-sigtran SCCP Implementation' /> + <param name='lsua' doc='libosmo-sigtran SCCP User Adaptation' /> + <param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' /> + <param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol' /> + <param name='ljibuf' doc='libosmo-netif Jitter Buffer' /> + <param name='debug' doc='Log debug messages and higher levels' /> + <param name='info' doc='Log informational messages and higher levels' /> + <param name='notice' doc='Log noticeable messages and higher levels' /> + <param name='error' doc='Log error messages and higher levels' /> + <param name='fatal' doc='Log only fatal messages' /> + </params> + </command> + <command id='logging level set-all (debug|info|notice|error|fatal)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='level' doc='Set the log level for a specified category' /> + <param name='set-all' doc='Once-off set all categories to the given log level. There is no single command to take back these changes -- each category is set to the given level, period.' /> + <param name='debug' doc='Log debug messages and higher levels' /> + <param name='info' doc='Log informational messages and higher levels' /> + <param name='notice' doc='Log noticeable messages and higher levels' /> + <param name='error' doc='Log error messages and higher levels' /> + <param name='fatal' doc='Log only fatal messages' /> + </params> + </command> + <command id='logging level force-all (debug|info|notice|error|fatal)'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='level' doc='Set the log level for a specified category' /> + <param name='force-all' doc='Globally force all logging categories to a specific level. This is released by the 'no logging level force-all' command. Note: any 'logging level <category> <level>' commands will have no visible effect after this, until the forced level is released.' /> + <param name='debug' doc='Log debug messages and higher levels' /> + <param name='info' doc='Log informational messages and higher levels' /> + <param name='notice' doc='Log noticeable messages and higher levels' /> + <param name='error' doc='Log error messages and higher levels' /> + <param name='fatal' doc='Log only fatal messages' /> + </params> + </command> + <command id='no logging level force-all'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='logging' doc='Configure logging' /> + <param name='level' doc='Set the log level for a specified category' /> + <param name='force-all' doc='Release any globally forced log level set with 'logging level force-all <level>'' /> + </params> + </command> + <command id='logging filter imsi IMSI'> + <params> + <param name='logging' doc='Configure logging' /> + <param name='filter' doc='Filter log messages' /> + <param name='imsi' doc='Filter log messages by IMSI' /> + <param name='IMSI' doc='IMSI to be used as filter' /> + </params> + </command> + </node> + <node id='config-stats'> + <name>config-stats</name> + <command id='local-ip ADDR'> + <params> + <param name='local-ip' doc='Set the IP address to which we bind locally' /> + <param name='ADDR' doc='IP Address' /> + </params> + </command> + <command id='no local-ip'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='local-ip' doc='Set the IP address to which we bind locally' /> + </params> + </command> + <command id='remote-ip ADDR'> + <params> + <param name='remote-ip' doc='Set the remote IP address to which we connect' /> + <param name='ADDR' doc='IP Address' /> + </params> + </command> + <command id='remote-port <1-65535>'> + <params> + <param name='remote-port' doc='Set the remote port to which we connect' /> + <param name='<1-65535>' doc='Remote port number' /> + </params> + </command> + <command id='mtu <100-65535>'> + <params> + <param name='mtu' doc='Set the maximum packet size' /> + <param name='<100-65535>' doc='Size in byte' /> + </params> + </command> + <command id='no mtu'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='mtu' doc='Set the maximum packet size' /> + </params> + </command> + <command id='prefix PREFIX'> + <params> + <param name='prefix' doc='Set the item name prefix' /> + <param name='PREFIX' doc='The prefix string' /> + </params> + </command> + <command id='no prefix'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='prefix' doc='Set the item name prefix' /> + </params> + </command> + <command id='level (global|peer|subscriber)'> + <params> + <param name='level' doc='Set the maximum group level' /> + <param name='global' doc='Report global groups only' /> + <param name='peer' doc='Report global and network peer related groups' /> + <param name='subscriber' doc='Report global, peer, and subscriber groups' /> + </params> + </command> + <command id='enable'> + <params> + <param name='enable' doc='Enable the reporter' /> + </params> + </command> + <command id='disable'> + <params> + <param name='disable' doc='Disable the reporter' /> + </params> + </command> + </node> + <node id='config-line'> + <name>config-line</name> + <command id='login'> + <params> + <param name='login' doc='Enable password checking' /> + </params> + </command> + <command id='no login'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='login' doc='Enable password checking' /> + </params> + </command> + <command id='bind A.B.C.D'> + <params> + <param name='bind' doc='Accept VTY telnet connections on local interface' /> + <param name='A.B.C.D' doc='Local interface IP address (default: 127.0.0.1)' /> + </params> + </command> + </node> + <node id='config-ctrl'> + <name>config-ctrl</name> + <command id='bind A.B.C.D'> + <params> + <param name='bind' doc='Set bind address to listen for Control connections' /> + <param name='A.B.C.D' doc='Local IP address (default 127.0.0.1)' /> + </params> + </command> + </node> + <node id='config-cs7'> + <name>config-cs7</name> + <command id='description .TEXT'> + <params> + <param name='description' doc='Save human-readable description of the object' /> + <param name='.TEXT' doc='Text until the end of the line' /> + </params> + </command> + <command id='network-indicator (international | national | reserved | spare)'> + <params> + <param name='network-indicator' doc='Configure the Network Indicator' /> + <param name='international' doc='International Network' /> + <param name='national' doc='National Network' /> + <param name='reserved' doc='Reserved Network' /> + <param name='spare' doc='Spare Network' /> + </params> + </command> + <command id='point-code POINT_CODE'> + <params> + <param name='point-code' doc='Configure the local Point Code' /> + <param name='POINT_CODE' doc='Point Code' /> + </params> + </command> + <command id='point-code format <1-24> [<1-23>] [<1-22>]'> + <params> + <param name='point-code' doc='Point Code' /> + <param name='format' doc='Configure Point Code Format' /> + <param name='<1-24>' doc='Length of first PC component' /> + <param name='[<1-23>]' doc='Length of second PC component' /> + <param name='[<1-22>]' doc='Length of third PC component' /> + </params> + </command> + <command id='point-code format default'> + <params> + <param name='point-code' doc='Point Code' /> + <param name='format' doc='Configure Point Code Format' /> + <param name='default' doc='Default Point Code Format (3.8.3)' /> + </params> + </command> + <command id='point-code delimiter (default|dash)'> + <params> + <param name='point-code' doc='Point Code' /> + <param name='delimiter' doc='Configure Point Code Delimiter' /> + <param name='default' doc='Use dot as delimiter' /> + <param name='dash' doc='User dash as delimiter' /> + </params> + </command> + <command id='xua rkm routing-key-allocation (static-only|dynamic-permitted)'> + <params> + <param name='xua' doc='SIGTRAN xxxUA related' /> + <param name='rkm' doc='Routing Key Management' /> + <param name='routing-key-allocation' doc='Routing Key Management Allocation Policy' /> + <param name='static-only' doc='Only static (pre-confgured) Routing Keys permitted' /> + <param name='dynamic-permitted' doc='Dynamically allocate Routing Keys for what ASPs request' /> + </params> + </command> + <command id='asp NAME <0-65535> <0-65535> (sua|m3ua|ipa)'> + <params> + <param name='asp' doc='Configure Application Server Process' /> + <param name='NAME' doc='Name of ASP' /> + <param name='<0-65535>' doc='Remote SCTP port number' /> + <param name='<0-65535>' doc='Local SCTP port number' /> + <param name='sua' doc='SCCP User Adaptation' /> + <param name='m3ua' doc='MTP3 User Adaptation' /> + <param name='ipa' doc='IPA Multiplex (SCCP Lite)' /> + </params> + </command> + <command id='no asp NAME'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='asp' doc='Disable Application Server Process' /> + <param name='NAME' doc='Name of ASP' /> + </params> + </command> + <command id='as NAME (sua|m3ua|ipa)'> + <params> + <param name='as' doc='Configure an Application Server' /> + <param name='NAME' doc='Name of the Application Server' /> + <param name='sua' doc='SCCP User Adaptation' /> + <param name='m3ua' doc='MTP3 User Adaptation' /> + <param name='ipa' doc='IPA Multiplex (SCCP Lite)' /> + </params> + </command> + <command id='no as NAME'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='as' doc='Disable Application Server' /> + <param name='NAME' doc='Name of AS' /> + </params> + </command> + <command id='sccp-address NAME'> + <params> + <param name='sccp-address' doc='Create/Modify an SCCP addressbook entry' /> + <param name='NAME' doc='Name of the SCCP Address' /> + </params> + </command> + <command id='no sccp-address NAME'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='sccp-address' doc='Delete an SCCP addressbook entry' /> + <param name='NAME' doc='Name of the SCCP Address' /> + </params> + </command> + <command id='sccp-timer (conn_est|ias|iar|rel|repeat_rel|int|guard|reset|reassembly) <1-999999>'> + <params> + <param name='sccp-timer' doc='Configure SCCP timer values, see ITU-T Q.714' /> + <param name='conn_est' doc='Waiting for connection confirm message, 1 to 2 minutes (default: 60)' /> + <param name='ias' doc='Send keep-alive: on an idle connection, delay before sending an Idle Timer message, 5 to 10 minutes (default: 420)' /> + <param name='iar' doc='Receive keep-alive: on an idle connection, delay until considering a connection as stale, 11 to 21 minutes (default: 900)' /> + <param name='rel' doc='Waiting for release complete message, 10 to 20 seconds (default: 10)' /> + <param name='repeat_rel' doc='Waiting for release complete message; or to repeat sending released message after the initial expiry, 10 to 20 seconds (default: 10)' /> + <param name='int' doc='Waiting for release complete message; or to release connection resources, freeze the LRN and alert a maintenance function after the initial expiry, extending to 1 minute (default: 60)' /> + <param name='guard' doc='Waiting to resume normal procedure for temporary connection sections during the restart procedure, 23 to 25 minutes (default: 1380)' /> + <param name='reset' doc='Waiting to release temporary connection section or alert maintenance function after reset request message is sent, 10 to 20 seconds (default: 10)' /> + <param name='reassembly' doc='Waiting to receive all the segments of the remaining segments, single segmented message after receiving the first segment, 10 to 20 seconds (default: 10)' /> + <param name='<1-999999>' doc='Timer value, in seconds' /> + </params> + </command> + </node> + <node id='config-cs7-as'> + <name>config-cs7-as</name> + <command id='description .TEXT'> + <params> + <param name='description' doc='Save human-readable description of the object' /> + <param name='.TEXT' doc='Text until the end of the line' /> + </params> + </command> + <command id='asp NAME'> + <params> + <param name='asp' doc='Specify that a given ASP is part of this AS' /> + <param name='NAME' doc='Name of ASP to be added to AS' /> + </params> + </command> + <command id='no asp NAME'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='asp' doc='Specify ASP to be removed from this AS' /> + <param name='NAME' doc='Name of ASP to be removed' /> + </params> + </command> + <command id='traffic-mode (broadcast | loadshare | roundrobin | override)'> + <params> + <param name='traffic-mode' doc='Specifies traffic mode of operation of the ASP within the AS' /> + <param name='broadcast' doc='Broadcast to all ASP within AS' /> + <param name='loadshare' doc='Share Load among all ASP within AS' /> + <param name='roundrobin' doc='Round-Robin between all ASP within AS' /> + <param name='override' doc='Override' /> + </params> + </command> + <command id='recovery-timeout <1-2000>'> + <params> + <param name='recovery-timeout' doc='Specifies the recovery timeout value in milliseconds' /> + <param name='<1-2000>' doc='Recovery Timeout in Milliseconds' /> + </params> + </command> + <command id='qos-class <0-255>'> + <params> + <param name='qos-class' doc='Specity QoS Class of AS' /> + <param name='<0-255>' doc='QoS Class of AS' /> + </params> + </command> + <command id='routing-key RCONTEXT DPC'> + <params> + <param name='routing-key' doc='Define a routing key' /> + <param name='RCONTEXT' doc='Routing context number' /> + <param name='DPC' doc='Destination Point Code' /> + </params> + </command> + <command id='routing-key RCONTEXT DPC si (aal2|bicc|b-isup|h248|isup|sat-isup|sccp|tup)'> + <params> + <param name='routing-key' doc='Define a routing key' /> + <param name='RCONTEXT' doc='Routing context number' /> + <param name='DPC' doc='Destination Point Code' /> + <param name='si' doc='Match on Service Indicator' /> + <param name='aal2' doc='ATM Adaption Layer 2' /> + <param name='bicc' doc='Bearer Independent Call Control' /> + <param name='b-isup' doc='Broadband ISDN User Part' /> + <param name='h248' doc='H.248' /> + <param name='isup' doc='ISDN User Part' /> + <param name='sat-isup' doc='Sattelite ISDN User Part' /> + <param name='sccp' doc='Signalling Connection Control Part' /> + <param name='tup' doc='Telephony User Part' /> + </params> + </command> + <command id='routing-key RCONTEXT DPC ssn SSN'> + <params> + <param name='routing-key' doc='Define a routing key' /> + <param name='RCONTEXT' doc='Routing context number' /> + <param name='DPC' doc='Destination Point Code' /> + <param name='ssn' doc='Match on Sub-System Number' /> + <param name='SSN' doc='Sub-System Number to match on' /> + </params> + </command> + <command id='routing-key RCONTEXT DPC si (aal2|bicc|b-isup|h248|isup|sat-isup|sccp|tup) ssn SSN'> + <params> + <param name='routing-key' doc='Define a routing key' /> + <param name='RCONTEXT' doc='Routing context number' /> + <param name='DPC' doc='Destination Point Code' /> + <param name='si' doc='Match on Service Indicator' /> + <param name='aal2' doc='ATM Adaption Layer 2' /> + <param name='bicc' doc='Bearer Independent Call Control' /> + <param name='b-isup' doc='Broadband ISDN User Part' /> + <param name='h248' doc='H.248' /> + <param name='isup' doc='ISDN User Part' /> + <param name='sat-isup' doc='Sattelite ISDN User Part' /> + <param name='sccp' doc='Signalling Connection Control Part' /> + <param name='tup' doc='Telephony User Part' /> + <param name='ssn' doc='Match on Sub-System Number' /> + <param name='SSN' doc='Sub-System Number to match on' /> + </params> + </command> + <command id='point-code override dpc PC'> + <params> + <param name='point-code' doc='Point Code Specific Features' /> + <param name='override' doc='Override (force) a point-code to hard-coded value' /> + <param name='dpc' doc='Override Source Point Code' /> + <param name='PC' doc='Override Destination Point Code' /> + </params> + </command> + </node> + <node id='config-cs7-asp'> + <name>config-cs7-asp</name> + <command id='description .TEXT'> + <params> + <param name='description' doc='Save human-readable description of the object' /> + <param name='.TEXT' doc='Text until the end of the line' /> + </params> + </command> + <command id='remote-ip A.B.C.D'> + <params> + <param name='remote-ip' doc='Specify Remote IP Address of ASP' /> + <param name='A.B.C.D' doc='Remote IP Address of ASP' /> + </params> + </command> + <command id='local-ip A.B.C.D'> + <params> + <param name='local-ip' doc='Specify Local IP Address from which to contact ASP' /> + <param name='A.B.C.D' doc='Local IP Address from which to contact of ASP' /> + </params> + </command> + <command id='qos-class <0-255>'> + <params> + <param name='qos-class' doc='Specify QoS Class of ASP' /> + <param name='<0-255>' doc='QoS Class of ASP' /> + </params> + </command> + <command id='block'> + <params> + <param name='block' doc='Allows a SCTP Association with ASP, but doesn't let it become active' /> + </params> + </command> + <command id='shutdown'> + <params> + <param name='shutdown' doc='Terminates SCTP association; New associations will be rejected' /> + </params> + </command> + </node> + <node id='config-cs7-sccpaddr'> + <name>config-cs7-sccpaddr</name> + <command id='no point-code'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='point-code' doc='Remove point-code Number' /> + </params> + </command> + <command id='no subsystem-number'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='subsystem-number' doc='Remove Subsystem Number' /> + </params> + </command> + <command id='no global-title'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='global-title' doc='Remove Global Title' /> + </params> + </command> + <command id='routing-indicator (GT|PC|IP)'> + <params> + <param name='routing-indicator' doc='Add Routing Indicator' /> + <param name='GT' doc='by global-title' /> + <param name='PC' doc='by point-code' /> + <param name='IP' doc='by ip-address' /> + </params> + </command> + <command id='point-code POINT_CODE'> + <params> + <param name='point-code' doc='Add point-code Number' /> + <param name='POINT_CODE' doc='PC' /> + </params> + </command> + <command id='subsystem-number <0-4294967295>'> + <params> + <param name='subsystem-number' doc='Add Subsystem Number' /> + <param name='<0-4294967295>' doc='SSN' /> + </params> + </command> + <command id='global-title'> + <params> + <param name='global-title' doc='Add/Modify Global Title' /> + </params> + </command> + </node> + <node id='config-cs7-sccpaddr-gt'> + <name>config-cs7-sccpaddr-gt</name> + <command id='global-title-indicator <0-15>'> + <params> + <param name='global-title-indicator' doc='Set Global Title Indicator' /> + <param name='<0-15>' doc='GTI' /> + </params> + </command> + <command id='translation-type <0-255>'> + <params> + <param name='translation-type' doc='Set Global Title Translation Type' /> + <param name='<0-255>' doc='TT' /> + </params> + </command> + <command id='numbering-plan-indicator <0-15>'> + <params> + <param name='numbering-plan-indicator' doc='Set Global Title Numbering Plan Indicator' /> + <param name='<0-15>' doc='NPI' /> + </params> + </command> + <command id='nature-of-address-indicator <0-127>'> + <params> + <param name='nature-of-address-indicator' doc='Set Global Title Nature of Address Indicator' /> + <param name='<0-127>' doc='NAI' /> + </params> + </command> + <command id='digits DIGITS'> + <params> + <param name='digits' doc='Set Global Title Digits' /> + <param name='DIGITS' doc='Number digits' /> + </params> + </command> + </node> + <node id='config-net'> + <name>config-net</name> + <command id='network country code <1-999>'> + <params> + <param name='network' doc='Set the GSM network country code' /> + <param name='country' doc='Country commands' /> + <param name='code' doc='Code commands' /> + <param name='<1-999>' doc='Network Country Code to use' /> + </params> + </command> + <command id='mobile network code <0-999>'> + <params> + <param name='mobile' doc='Set the GSM mobile network code' /> + <param name='network' doc='Network Commands' /> + <param name='code' doc='Code commands' /> + <param name='<0-999>' doc='Mobile Network Code to use' /> + </params> + </command> + <command id='short name NAME'> + <params> + <param name='short' doc='Set the short GSM network name' /> + <param name='name' doc='Name Commands' /> + <param name='NAME' doc='Name to use' /> + </params> + </command> + <command id='long name NAME'> + <params> + <param name='long' doc='Set the long GSM network name' /> + <param name='name' doc='Name Commands' /> + <param name='NAME' doc='Name to use' /> + </params> + </command> + <command id='encryption a5 <0-3> [<0-3>] [<0-3>] [<0-3>]'> + <params> + <param name='encryption' doc='Encryption options' /> + <param name='a5' doc='GSM A5 Air Interface Encryption' /> + <param name='<0-3>' doc='A5/n Algorithm Number' /> + <param name='[<0-3>]' doc='A5/n Algorithm Number' /> + <param name='[<0-3>]' doc='A5/n Algorithm Number' /> + <param name='[<0-3>]' doc='A5/n Algorithm Number' /> + </params> + </command> + <command id='authentication (optional|required)'> + <params> + <param name='authentication' doc='Whether to enforce MS authentication in 2G' /> + <param name='optional' doc='Allow MS to attach via 2G BSC without authentication' /> + <param name='required' doc='Always do authentication' /> + </params> + </command> + <command id='rrlp mode (none|ms-based|ms-preferred|ass-preferred)'> + <params> + <param name='rrlp' doc='Radio Resource Location Protocol' /> + <param name='mode' doc='Set the Radio Resource Location Protocol Mode' /> + <param name='none' doc='Don't send RRLP request' /> + <param name='ms-based' doc='Request MS-based location' /> + <param name='ms-preferred' doc='Request any location, prefer MS-based' /> + <param name='ass-preferred' doc='Request any location, prefer MS-assisted' /> + </params> + </command> + <command id='mm info (0|1)'> + <params> + <param name='mm' doc='Mobility Management' /> + <param name='info' doc='Send MM INFO after LOC UPD ACCEPT' /> + <param name='0' doc='Disable' /> + <param name='1' doc='Enable' /> + </params> + </command> + <command id='timezone <-19-19> (0|15|30|45)'> + <params> + <param name='timezone' doc='Set the Timezone Offset of the network' /> + <param name='<-19-19>' doc='Timezone offset (hours)' /> + <param name='0' doc='Timezone offset (00 minutes)' /> + <param name='15' doc='Timezone offset (15 minutes)' /> + <param name='30' doc='Timezone offset (30 minutes)' /> + <param name='45' doc='Timezone offset (45 minutes)' /> + </params> + </command> + <command id='timezone <-19-19> (0|15|30|45) <0-2>'> + <params> + <param name='timezone' doc='Set the Timezone Offset of the network' /> + <param name='<-19-19>' doc='Timezone offset (hours)' /> + <param name='0' doc='Timezone offset (00 minutes)' /> + <param name='15' doc='Timezone offset (15 minutes)' /> + <param name='30' doc='Timezone offset (30 minutes)' /> + <param name='45' doc='Timezone offset (45 minutes)' /> + <param name='<0-2>' doc='DST offset (hours)' /> + </params> + </command> + <command id='no timezone'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='timezone' doc='Disable network timezone override, use system tz' /> + </params> + </command> + <command id='periodic location update <6-1530>'> + <params> + <param name='periodic' doc='Periodic Location Updating Interval' /> + <param name='location' doc='Periodic Location Updating Interval' /> + <param name='update' doc='Periodic Location Updating Interval' /> + <param name='<6-1530>' doc='Periodic Location Updating Interval in Minutes' /> + </params> + </command> + <command id='no periodic location update'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='periodic' doc='Periodic Location Updating Interval' /> + <param name='location' doc='Periodic Location Updating Interval' /> + <param name='update' doc='Periodic Location Updating Interval' /> + </params> + </command> + </node> + <node id='config-msc'> + <name>config-msc</name> + <command id='assign-tmsi'> + <params> + <param name='assign-tmsi' doc='Assign TMSI during Location Updating.' /> + </params> + </command> + <command id='mncc-guard-timeout <0-255>'> + <params> + <param name='mncc-guard-timeout' doc='Set global guard timer for mncc interface activity' /> + <param name='<0-255>' doc='guard timer value (sec.)' /> + </params> + </command> + <command id='no assign-tmsi'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='assign-tmsi' doc='Assign TMSI during Location Updating.' /> + </params> + </command> + <command id='auth-tuple-max-reuse-count <-1-2147483647>'> + <params> + <param name='auth-tuple-max-reuse-count' doc='Configure authentication tuple re-use' /> + <param name='<-1-2147483647>' doc='0 to use each auth tuple at most once (default), >0 to limit re-use, -1 to re-use infinitely (vulnerable!).' /> + </params> + </command> + <command id='auth-tuple-reuse-on-error (0|1)'> + <params> + <param name='auth-tuple-reuse-on-error' doc='Configure authentication tuple re-use when HLR is not responsive' /> + <param name='0' doc='0 = never re-use auth tuples beyond auth-tuple-max-reuse-count (default)' /> + <param name='1' doc='1 = if the HLR does not deliver new tuples, do re-use already available old ones.' /> + </params> + </command> + <command id='cs7-instance-a <0-15>'> + <params> + <param name='cs7-instance-a' doc='Set SS7 to be used by the A-Interface.' /> + <param name='<0-15>' doc='SS7 instance reference number' /> + </params> + </command> + <command id='cs7-instance-iu <0-15>'> + <params> + <param name='cs7-instance-iu' doc='Set SS7 to be used by the Iu-Interface.' /> + <param name='<0-15>' doc='SS7 instance reference number' /> + </params> + </command> + <command id='paging response-timer (default|<1-65535>)'> + <params> + <param name='paging' doc='Configure Paging' /> + <param name='response-timer' doc='Set Paging timeout, the minimum time to pass between (unsuccessful) Pagings sent towards BSS or RNC' /> + <param name='default' doc='Set to default timeout (10 seconds)' /> + <param name='<1-65535>' doc='Set paging timeout in seconds' /> + </params> + </command> + <command id='emergency-call route-to-msisdn MSISDN'> + <params> + <param name='emergency-call' doc='Configure Emergency Call Behaviour' /> + <param name='route-to-msisdn' doc='MSISDN to which Emergency Calls are Dispatched' /> + <param name='MSISDN' doc='MSISDN (E.164 Phone Number)' /> + </params> + </command> + <command id='mgw local-ip A.B.C.D'> + <params> + <param name='mgw' doc='Configure MGCP connection to Media Gateway' /> + <param name='local-ip' doc='local bind to connect to MGW from' /> + <param name='A.B.C.D' doc='local bind IP address' /> + </params> + </command> + <command id='mgw local-port <0-65535>'> + <params> + <param name='mgw' doc='Configure MGCP connection to Media Gateway' /> + <param name='local-port' doc='local port to connect to MGW from' /> + <param name='<0-65535>' doc='local bind port' /> + </params> + </command> + <command id='mgw remote-ip A.B.C.D'> + <params> + <param name='mgw' doc='Configure MGCP connection to Media Gateway' /> + <param name='remote-ip' doc='remote IP address to reach the MGW at' /> + <param name='A.B.C.D' doc='remote IP address' /> + </params> + </command> + <command id='mgw remote-port <0-65535>'> + <params> + <param name='mgw' doc='Configure MGCP connection to Media Gateway' /> + <param name='remote-port' doc='remote port to reach the MGW at' /> + <param name='<0-65535>' doc='remote port' /> + </params> + </command> + <command id='mgw endpoint-range <1-65534> <1-65534>'> + <params> + <param name='mgw' doc='Configure MGCP connection to Media Gateway' /> + <param name='endpoint-range' doc='usable range of endpoint identifiers' /> + <param name='<1-65534>' doc='set first usable endpoint identifier' /> + <param name='<1-65534>' doc='set last usable endpoint identifier' /> + </params> + </command> + <command id='mgw bts-base <0-65534>'> + <params> + <param name='mgw' doc='Configure MGCP connection to Media Gateway' /> + <param name='bts-base' doc='First UDP port allocated for the BTS side' /> + <param name='<0-65534>' doc='UDP Port number' /> + </params> + </command> + <command id='iu rab-assign-addr-enc (x213|v4raw)'> + <params> + <param name='iu' doc='Iu interface protocol options' /> + <param name='rab-assign-addr-enc' doc='Choose RAB Assignment's Transport Layer Address encoding' /> + <param name='x213' doc='ITU-T X.213 compliant address encoding (default)' /> + <param name='v4raw' doc='32bit length raw IPv4 address (for ip.access nano3G)' /> + </params> + </command> + <command id='asn1 debug (1|0)'> + <params> + <param name='asn1' doc='ASN.1 settings' /> + <param name='debug' doc='Enable ASN.1 debug messages' /> + <param name='1' doc='Log ASN.1 debug messages to stderr' /> + <param name='0' doc='Do not log ASN.1 debug messages to stderr' /> + </params> + </command> + <command id='asn1 xer-print (1|0)'> + <params> + <param name='asn1' doc='ASN.1 settings' /> + <param name='xer-print' doc='Log human readable representations of all ASN.1 messages to stderr' /> + <param name='1' doc='Log XML representation of all ASN.1 messages to stderr' /> + <param name='0' doc='Do not log decoded ASN.1 messages to stderr' /> + </params> + </command> + </node> + <node id='config-mncc-int'> + <name>config-mncc-int</name> + <command id='default-codec tch-f (fr|efr|amr)'> + <params> + <param name='default-codec' doc='Set default codec' /> + <param name='tch-f' doc='Codec for TCH/F' /> + <param name='fr' doc='Full-Rate' /> + <param name='efr' doc='Enhanced Full-Rate' /> + <param name='amr' doc='Adaptive Multi-Rate' /> + </params> + </command> + <command id='default-codec tch-h (hr|amr)'> + <params> + <param name='default-codec' doc='Set default codec' /> + <param name='tch-h' doc='Codec for TCH/H' /> + <param name='hr' doc='Half-Rate' /> + <param name='amr' doc='Adaptive Multi-Rate' /> + </params> + </command> + </node> + <node id='config-smpp'> + <name>config-smpp</name> + <command id='smpp-first'> + <params> + <param name='smpp-first' doc='Try SMPP routes before the subscriber DB' /> + </params> + </command> + <command id='no smpp-first'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='smpp-first' doc='Try SMPP before routes before the subscriber DB' /> + </params> + </command> + <command id='local-tcp-port <1-65535>'> + <params> + <param name='local-tcp-port' doc='Set the local TCP port on which we listen for SMPP' /> + <param name='<1-65535>' doc='TCP port number' /> + </params> + </command> + <command id='local-tcp-ip A.B.C.D <1-65535>'> + <params> + <param name='local-tcp-ip' doc='Set the local IP address and TCP port on which we listen for SMPP' /> + <param name='A.B.C.D' doc='Local IP address' /> + <param name='<1-65535>' doc='TCP port number' /> + </params> + </command> + <command id='system-id ID'> + <params> + <param name='system-id' doc='Set the System ID of this SMSC' /> + <param name='ID' doc='Alphanumeric SMSC System ID' /> + </params> + </command> + <command id='policy (accept-all|closed)'> + <params> + <param name='policy' doc='Set the authentication policy of this SMSC' /> + <param name='accept-all' doc='Accept all SMPP connections independeint of system ID / passwd' /> + <param name='closed' doc='Accept only SMPP connections from ESMEs explicitly configured' /> + </params> + </command> + <command id='esme NAME'> + <params> + <param name='esme' doc='Configure a particular ESME' /> + <param name='NAME' doc='Alphanumeric System ID of the ESME to be configured' /> + </params> + </command> + <command id='no esme NAME'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='esme' doc='Remove ESME configuration' /> + <param name='NAME' doc='Alphanumeric System ID of the ESME to be removed' /> + </params> + </command> + </node> + <node id='config-smpp-esme'> + <name>config-smpp-esme</name> + <command id='password PASSWORD'> + <params> + <param name='password' doc='Set the password for this ESME' /> + <param name='PASSWORD' doc='Alphanumeric password string' /> + </params> + </command> <command id='no password'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='password' doc='Remove the password for this ESME' /> + </params> + </command> + <command id='route prefix (unknown|international|national|network|subscriber|alpha|abbrev) (unknown|isdn|x121|f69|e212|national|private|ermes|ip|wap) PREFIX'> + <params> + <param name='route' doc='Configure a route for MO-SMS to be sent to this ESME' /> + <param name='prefix' doc='Prefix-match route' /> + <param name='unknown' doc='Unknown type-of-number' /> + <param name='international' doc='International type-of-number' /> + <param name='national' doc='National type-of-number' /> + <param name='network' doc='Network specific type-of-number' /> + <param name='subscriber' doc='Subscriber type-of-number' /> + <param name='alpha' doc='Alphanumeric type-of-number' /> + <param name='abbrev' doc='Abbreviated type-of-number' /> + <param name='unknown' doc='Unknown numbering plan' /> + <param name='isdn' doc='ISDN (E.164) numbering plan' /> + <param name='x121' doc='X.121 numbering plan' /> + <param name='f69' doc='F.69 numbering plan' /> + <param name='e212' doc='E.212 numbering plan' /> + <param name='national' doc='National numbering plan' /> + <param name='private' doc='Private numbering plan' /> + <param name='ermes' doc='ERMES numbering plan' /> + <param name='ip' doc='IP numbering plan' /> + <param name='wap' doc='WAP numbeing plan' /> + <param name='PREFIX' doc='Destination number prefix' /> + </params> + </command> + <command id='no route prefix (unknown|international|national|network|subscriber|alpha|abbrev) (unknown|isdn|x121|f69|e212|national|private|ermes|ip|wap) PREFIX'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='route' doc='Configure a route for MO-SMS to be sent to this ESME' /> + <param name='prefix' doc='Prefix-match route' /> + <param name='unknown' doc='Unknown type-of-number' /> + <param name='international' doc='International type-of-number' /> + <param name='national' doc='National type-of-number' /> + <param name='network' doc='Network specific type-of-number' /> + <param name='subscriber' doc='Subscriber type-of-number' /> + <param name='alpha' doc='Alphanumeric type-of-number' /> + <param name='abbrev' doc='Abbreviated type-of-number' /> + <param name='unknown' doc='Unknown numbering plan' /> + <param name='isdn' doc='ISDN (E.164) numbering plan' /> + <param name='x121' doc='X.121 numbering plan' /> + <param name='f69' doc='F.69 numbering plan' /> + <param name='e212' doc='E.212 numbering plan' /> + <param name='national' doc='National numbering plan' /> + <param name='private' doc='Private numbering plan' /> + <param name='ermes' doc='ERMES numbering plan' /> + <param name='ip' doc='IP numbering plan' /> + <param name='wap' doc='WAP numbeing plan' /> + <param name='PREFIX' doc='Destination number prefix' /> + </params> + </command> + <command id='default-route'> + <params> + <param name='default-route' doc='Set this ESME as default-route for all SMS to unknown destinations' /> + </params> + </command> + <command id='no default-route'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='default-route' doc='Remove this ESME as default-route for all SMS to unknown destinations' /> + </params> + </command> + <command id='deliver-src-imsi'> + <params> + <param name='deliver-src-imsi' doc='Enable the use of IMSI as source address in DELIVER' /> + </params> + </command> + <command id='no deliver-src-imsi'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='deliver-src-imsi' doc='Disable the use of IMSI as source address in DELIVER' /> + </params> + </command> + <command id='osmocom-extensions'> + <params> + <param name='osmocom-extensions' doc='Enable the use of Osmocom SMPP Extensions for this ESME' /> + </params> + </command> + <command id='no osmocom-extensions'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='osmocom-extensions' doc='Disable the use of Osmocom SMPP Extensions for this ESME' /> + </params> + </command> + <command id='dcs-transparent'> + <params> + <param name='dcs-transparent' doc='Enable the transparent pass-through of TP-DCS to SMPP DataCoding' /> + </params> + </command> + <command id='no dcs-transparent'> + <params> + <param name='no' doc='Negate a command or set its defaults' /> + <param name='dcs-transparent' doc='Disable the transparent pass-through of TP-DCS to SMPP DataCoding' /> + </params> + </command> + </node> + <node id='config-hlr'> + <name>config-hlr</name> + <command id='remote-ip A.B.C.D'> + <params> + <param name='remote-ip' doc='Remote GSUP address of the HLR' /> + <param name='A.B.C.D' doc='Remote GSUP address (default: 127.0.0.1)' /> + </params> + </command> + <command id='remote-port <1-65535>'> + <params> + <param name='remote-port' doc='Remote GSUP port of the HLR' /> + <param name='<1-65535>' doc='Remote GSUP port (default: MSC_HLR_REMOTE_PORT_DEFAULT)' /> + </params> + </command> + </node> +</vtydoc> |