diff options
| author | Oliver Smith <osmith@sysmocom.de> | 2021-02-01 12:48:48 +0100 |
|---|---|---|
| committer | osmith <osmith@sysmocom.de> | 2021-02-08 11:52:53 +0000 |
| commit | 901ed14c898ef229c654009ac0dc078d09d7b054 (patch) | |
| tree | bb23d5be682970a6a6a764b1b8c23f4e95d1cc96 /doc | |
| parent | 4be5ab37071d8102c133d65546b76117d1da18f1 (diff) | |
gbproxy: remove (moved to own repository)
New repository:
https://git.osmocom.org/osmo-gbproxy/
Related: OS#4992
Change-Id: I37f7cebaf2a06bd93627a452f5df44edcfc0f87a
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/examples/Makefile.am | 2 | ||||
| -rw-r--r-- | doc/examples/osmo-gbproxy/osmo-gbproxy-legacy.cfg | 42 | ||||
| -rw-r--r-- | doc/examples/osmo-gbproxy/osmo-gbproxy-pool.cfg | 32 | ||||
| -rw-r--r-- | doc/examples/osmo-gbproxy/osmo-gbproxy.cfg | 23 | ||||
| -rw-r--r-- | doc/manuals/Makefile.am | 8 | ||||
| -rw-r--r-- | doc/manuals/chapters/gbproxy-configuration.adoc | 41 | ||||
| -rw-r--r-- | doc/manuals/chapters/gbproxy-control.adoc | 29 | ||||
| -rw-r--r-- | doc/manuals/chapters/gbproxy-details.adoc | 113 | ||||
| -rw-r--r-- | doc/manuals/chapters/gbproxy-overview.adoc | 95 | ||||
| -rw-r--r-- | doc/manuals/chapters/gbproxy-running.adoc | 39 | ||||
| -rw-r--r-- | doc/manuals/chapters/gbproxy-sgsnpool.adoc | 219 | ||||
| -rw-r--r-- | doc/manuals/osmogbproxy-usermanual-docinfo.xml | 46 | ||||
| -rw-r--r-- | doc/manuals/osmogbproxy-usermanual.adoc | 36 | ||||
| -rw-r--r-- | doc/manuals/osmogbproxy-vty-reference.xml | 38 | ||||
| -rwxr-xr-x | doc/manuals/regen_doc.sh | 6 | ||||
| -rw-r--r-- | doc/manuals/vty-osmogbproxy/gbproxy_vty_additions.xml | 5 | ||||
| -rw-r--r-- | doc/manuals/vty-osmogbproxy/gbproxy_vty_reference.xml | 1627 |
17 files changed, 3 insertions, 2398 deletions
diff --git a/doc/examples/Makefile.am b/doc/examples/Makefile.am index 2b5781a59..c725bc1ad 100644 --- a/doc/examples/Makefile.am +++ b/doc/examples/Makefile.am @@ -1,7 +1,7 @@ OSMOCONF_FILES = \ osmo-gtphub/osmo-gtphub.cfg \ osmo-sgsn/osmo-sgsn.cfg \ - osmo-gbproxy/osmo-gbproxy.cfg + $(NULL) osmoconfdir = $(sysconfdir)/osmocom osmoconf_DATA = $(OSMOCONF_FILES) diff --git a/doc/examples/osmo-gbproxy/osmo-gbproxy-legacy.cfg b/doc/examples/osmo-gbproxy/osmo-gbproxy-legacy.cfg deleted file mode 100644 index e30b9f7fe..000000000 --- a/doc/examples/osmo-gbproxy/osmo-gbproxy-legacy.cfg +++ /dev/null @@ -1,42 +0,0 @@ -! -! OsmoGbProxy (UNKNOWN) configuration saved from vty -!! -! -log stderr - logging filter all 1 - logging color 1 - logging timestamp 0 - logging level all debug - logging level gprs debug - logging level ns info - logging level bssgp debug - logging level lglobal notice - logging level llapd notice - logging level linp notice - logging level lmux notice - logging level lmi notice - logging level lmib notice - logging level lsms notice -! -line vty - no login -! -ns - bind udp local - listen 127.0.0.1 23000 - accept-ipaccess - nse 666 - nsvc ipa local 127.0.0.1 23001 nsvci 666 - timer tns-block 3 - timer tns-block-retries 3 - timer tns-reset 3 - timer tns-reset-retries 3 - timer tns-test 30 - timer tns-alive 3 - timer tns-alive-retries 10 -gbproxy - sgsn nsei 666 - core-mobile-country-code 666 - core-mobile-network-code 6 - core-access-point-name none match-imsi ^666066|^66607 - tlli-list max-length 200 diff --git a/doc/examples/osmo-gbproxy/osmo-gbproxy-pool.cfg b/doc/examples/osmo-gbproxy/osmo-gbproxy-pool.cfg deleted file mode 100644 index bbc8a1b70..000000000 --- a/doc/examples/osmo-gbproxy/osmo-gbproxy-pool.cfg +++ /dev/null @@ -1,32 +0,0 @@ -! -! Osmocom Gb Proxy (0.9.0.404-6463) configuration saved from vty -!! -! -line vty - no login -! -gbproxy - nri bitlen 4 - nri null add 0 4 -sgsn nsei 101 - name main - nri add 1 - nri add 11 -sgsn nsei 102 - nri add 2 - nri add 12 -ns - bind udp local - listen 127.0.0.100 23000 - accept-ipaccess - nse 101 - nsvc ipa local 192.168.100.239 7777 nsvci 101 - nse 102 - nsvc ipa local 192.168.100.239 7778 nsvci 102 - timer tns-block 3 - timer tns-block-retries 3 - timer tns-reset 3 - timer tns-reset-retries 3 - timer tns-test 30 - timer tns-alive 3 - timer tns-alive-retries 10 diff --git a/doc/examples/osmo-gbproxy/osmo-gbproxy.cfg b/doc/examples/osmo-gbproxy/osmo-gbproxy.cfg deleted file mode 100644 index 777d0b0f9..000000000 --- a/doc/examples/osmo-gbproxy/osmo-gbproxy.cfg +++ /dev/null @@ -1,23 +0,0 @@ -! -! Osmocom Gb Proxy (0.9.0.404-6463) configuration saved from vty -!! -! -line vty - no login -! -gbproxy -sgsn nsei 101 - name main -ns - bind udp local - listen 127.0.0.100 23000 - accept-ipaccess - nse 101 - nsvc ipa local 192.168.100.239 7777 nsvci 101 - timer tns-block 3 - timer tns-block-retries 3 - timer tns-reset 3 - timer tns-reset-retries 3 - timer tns-test 30 - timer tns-alive 3 - timer tns-alive-retries 10 diff --git a/doc/manuals/Makefile.am b/doc/manuals/Makefile.am index cd57cf148..bc3449743 100644 --- a/doc/manuals/Makefile.am +++ b/doc/manuals/Makefile.am @@ -1,21 +1,17 @@ EXTRA_DIST = osmosgsn-usermanual.adoc \ osmosgsn-usermanual-docinfo.xml \ osmosgsn-vty-reference.xml \ - osmogbproxy-usermanual.adoc \ - osmogbproxy-usermanual-docinfo.xml \ regen_doc.sh \ chapters \ vty \ - osmogbproxy-vty-reference.xml \ - vty-osmogbproxy \ $(NULL) if BUILD_MANUALS - ASCIIDOC = osmosgsn-usermanual.adoc osmogbproxy-usermanual.adoc + ASCIIDOC = osmosgsn-usermanual.adoc ASCIIDOC_DEPS = $(srcdir)/chapters/*.adoc include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.asciidoc.inc - VTY_REFERENCE = osmosgsn-vty-reference.xml osmogbproxy-vty-reference.xml + VTY_REFERENCE = osmosgsn-vty-reference.xml include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.vty-reference.inc OSMO_REPOSITORY = osmo-sgsn diff --git a/doc/manuals/chapters/gbproxy-configuration.adoc b/doc/manuals/chapters/gbproxy-configuration.adoc deleted file mode 100644 index 87da471ff..000000000 --- a/doc/manuals/chapters/gbproxy-configuration.adoc +++ /dev/null @@ -1,41 +0,0 @@ -== Configuring OsmoGbProxy - -OsmoGbProxy requires very little configuration, most of it being the -configuration of the NS links. -Most config options specific to OsmoGbProxy are related to SGSN pooling and -telling the proxy which NSE(s) it should use to talk to the SGSN(s). - -=== Configure the Network Service (NS) - -A detailed description of the NS configuration can be found in <<libosmogb>>. -The following config snippets assume the SGSN(s) (NSEI 101 and 102) are using -IP-SNS and listen on 10.0.1.1:23000 and 10.0.1.2:23000 respectively. - -This would be the NS config for the SGSN(s): - -.Example: NS configuration example (SGSN) ----- -ns - bind udp local - listen 10.0.0.1 23000 <1> - nse 101 <2> - ip-sns 10.0.1.1 23000 <3> - nse 102 - ip-sns 10.0.1.2 23000 ----- -<1> Define the local IP/port from which to connect -<2> Define an NSE with NSEI -<3> Use IP-SNS to connect to the SGSN - -=== Configure an SGSN - -Configuration of a single (non-pooling) SGSN is rather simple. - -.Example: SGSN configuration example ----- -sgsn 101 <1> - name Main SGSN <2> ----- -<1> Each SGSN is identified by its NSEI (same as in the NS configuration) -<2> An SGSN can optionally have a name. If none is set a default name will be used. - diff --git a/doc/manuals/chapters/gbproxy-control.adoc b/doc/manuals/chapters/gbproxy-control.adoc deleted file mode 100644 index 2f83e6add..000000000 --- a/doc/manuals/chapters/gbproxy-control.adoc +++ /dev/null @@ -1,29 +0,0 @@ -[[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>>. Here we -describe variables specific to OsmoGbProxy. - -.Variables available over control interface -[options="header",width="100%",cols="20%,5%,5%,50%,20%"] -|=== -|Name|Access|Trap|Value|Comment -|nsvc-state|RO|No|"<nsei>,<nsvci>,<local-alive>,<local-blocked>,<remote-role>,<remote-alive>,<remote-blocked>"|See <<nsvc_state>> for details. -|gbproxy-state|RO|No|"<nsei>,<bvci>,<mcc>,<mnc>,<lac>,<rac>,<blocked>"|See <<gbproxy_state>> for details. -|number-of-peers|RO|No|"<num-of-bss>"|Count of concurrent BSS(BTS) peers. -|=== - -[[nsvc_state]] -=== nsvc-state - -Return the list of active NS-VCs (NS Virtual Circuits), including information -on the key parameters, such as NSEI, NSVCI and the local + remote ALIVE -and BLOCKED state. - -[[gbproxy_state]] -=== gbproxy-state - -Return the list of active Peers, including information on the key -parameters, such as NSEI, BVCI, and the MCC-MNC-LAC-RAC of the attached -BSS, as well as the overall state (BLOCKED or UNBLOCKED). diff --git a/doc/manuals/chapters/gbproxy-details.adoc b/doc/manuals/chapters/gbproxy-details.adoc deleted file mode 100644 index f77d40cf9..000000000 --- a/doc/manuals/chapters/gbproxy-details.adoc +++ /dev/null @@ -1,113 +0,0 @@ -[[chapter_details]] -== Proxy details - -=== BVC handling - -This section describes in more detail how BVCs are handled in OsmoGbProxy - -If a BSS connects to OsmoGbProxy while the SGSN is not available it will -acknowledge the BVC RESET on the signalling BVC, but ignore other messages -(especially any PTP BVC RESET). - -.BSS connects to OsmoGbProxy -[mscgen] ----- -msc { - hscale="1.8"; - bss1 [label="BSS1"], bss2 [label="BSS2"], gbproxy [label="GbProxy"], sgsn [label="SGSN"]; - bss1 <=> gbproxy [label="NS link available"]; - bss1 => gbproxy [label="BVC RESET (BVCI=0)"]; - gbproxy => bss1 [label="BVC RESET ACK"]; - bss1 -x gbproxy [label="PTP BVC RESET (ignored)"]; -} ----- - -As soon as the SGSN is reachable through NS OsmoGbProxy will send a BVC RESET -to the signalling BVC towards the SGSN. After that completes it will reset the -signalling BVC of all BSS connections. At this point the BSS will send a BVC -RESET for its PTP BVCs which will be forwarded to the SGSN, similarly the PTP -BVC RESET ACK from the SGSN will be sent back to the BSS. - -.SGSN connection to OsmoGbProxy -[mscgen] ----- -msc { - hscale="1.8"; - bss1 [label="BSS1"], bss2 [label="BSS2"], gbproxy [label="GbProxy"], sgsn [label="SGSN"]; - gbproxy <=> sgsn [label="NS link available"]; - gbproxy => sgsn [label="BVC RESET (BVCI=0)"]; - sgsn => gbproxy [label="BVC RESET ACK"]; - - gbproxy => bss1 [label="BVC RESET (BVCI=0)"]; - bss1 => gbproxy [label="BVC RESET ACK"]; - bss1 box bss1 [label="PTP BVCs need to be reset"]; - bss1 => gbproxy [label="PTP BVC RESET (BVCI=x)"]; - gbproxy => sgsn [label="PTP BVC RESET (BVCI=x)"]; - sgsn => gbproxy [label="PTP BVC RESET ACK (BVCI=x)"]; - gbproxy => bss1 [label="PTP BVC RESET ACK (BVCI=x)"]; - bss2 <=> sgsn [label="BVCI x established"]; -} ----- - -The communication on the PTP BVC will then be forwarded between the BSS and the -SGSN. - -If a BSS connects while the SGSN is up the PTP BVC RESET will directly be -forwarded. - -.BSS connects to OsmoGbProxy -[mscgen] ----- -msc { - hscale="1.8"; - bss1 [label="BSS1"], bss2 [label="BSS2"], gbproxy [label="GbProxy"], sgsn [label="SGSN"]; - bss2 <=> gbproxy [label="NS link available"]; - bss2 => gbproxy [label="BVC RESET (BVCI=0)"]; - gbproxy => bss2 [label="BVC RESET ACK"]; - bss2 => gbproxy [label="PTP BVC RESET (BVCI=y)"]; - gbproxy => sgsn [label="PTP BVC RESET (BVCI=y)"]; - sgsn => gbproxy [label="PTP BVC RESET ACK (BVCI=y)"]; - gbproxy => bss2 [label="PTP BVC RESET ACK (BVCI=y)"]; - bss2 <=> sgsn [label="BVCI y established"]; -} ----- - -If OsmoGbProxy looses the connection to the SGSN it will reset the signalling -BVC of all BSS connections. This ensures that the BSS will not send traffic -over a PTP BVC before its reset procedure has been completed. - -.SGSN connection fails -[mscgen] ----- -msc { - hscale="1.8"; - bss1 [label="BSS1"], bss2 [label="BSS2"], gbproxy [label="GbProxy"], sgsn [label="SGSN"]; - gbproxy <=> sgsn [label="NS link fails"]; - gbproxy => bss1 [label="BVC RESET (BVCI=0)"]; - gbproxy => bss2 [label="BVC RESET (BVCI=0)"]; -} ----- - -When the connection to the SGSN is eventually restored the signalling BVC -between OsmoGbProxy and SGSN will be reset. - -After that completes OsmoGbProxy will reset the signalling BVC on all BSS NS -connections and forward the PTP BVC RESET messages. - -.SGSN connection restored -[mscgen] ----- -msc { - hscale="1.8"; - bss1 [label="BSS1"], bss2 [label="BSS2"], gbproxy [label="GbProxy"], sgsn [label="SGSN"]; - gbproxy <=> sgsn [label="NS link available"]; - gbproxy => sgsn [label="BVC RESET (BVCI=0)"]; - sgsn => gbproxy [label="BVC RESET ACK"]; - gbproxy => bss1 [label="BVC RESET (BVCI=0)"]; - bss1 => gbproxy [label="BVC RESET ACK"]; - bss1 box bss1 [label="PTP BVCs need to be reset"]; - gbproxy => bss2 [label="BVC RESET (BVCI=0)"]; - bss2 => gbproxy [label="BVC RESET ACK"]; - bss2 box bss2 [label="PTP BVCs need to be reset"]; -} ----- diff --git a/doc/manuals/chapters/gbproxy-overview.adoc b/doc/manuals/chapters/gbproxy-overview.adoc deleted file mode 100644 index 3cd0d73c8..000000000 --- a/doc/manuals/chapters/gbproxy-overview.adoc +++ /dev/null @@ -1,95 +0,0 @@ -[[chapter_overview]] -== Overview - -IMPORTANT: If you have used an earlier version of OsmoGbProxy please note -that support for various features such as PLMN/APN patching, support for a -secondary SGSN has been removed. - -=== About OsmoGbProxy - -OsmoGbProxy is the Osmocom proxy for the 3GPP Gb interface. The Gb -interface is defined by 3GPP as the protocol between the BSS and the -SGSN inside the 2G/2.5G/2.75G packet switched network domain. - -As Osmocom implements a BTS-colocated PCU, there are potentially many -Gb interface connections between all those many PCUs in the network -and the SGSN. This can be cumbersome to configure/maintain at the -SGSN side. - -OsmoGbProxy aggregates many PCU-facing Gb connections into one Gb -connection to the SGSN. This is achieved by - -* maintaining separate NS-VCs on the PCU side and on the SGSN side -* more or less transparently routing BSSGP peer-to-peer Virtual Circuits - (BVCs) through the proxy -* having some special handling for the signaling BVC (BVCI=0) which is - shared among all the PCUs connected to the proxy - - -=== Data Model - -==== gbproxy_config - -This contains the parsed configuration of the OsmoGbProxy. - -==== gbproxy_nse - -The remote NS-entity that the proxy interacts with. Includes -information about: - -* the [unique] NSEI of the peer -* the Routeing Area (RA) of the peer -* which side this NSE is facing - SGSN or BSS -* the list of BVCs in this NSE - -==== gbproxy_bvc - -A ptp-BVC on an NSE - -* the BVCI of this BVC -* the routing area of this BVC -* the BVC state machine - -==== gbproxy_cell - -This contains a view of the cell and its associated BVCs - -* the unique BVCI of this cell -* the routing area of this cell -* one bss-side BVC -* one BVC per SGSN in the pool - -==== gbproxy_sgsn - -Represents one SGSN in the pool. Contains: - -* the NSE belonging to this SGSN -* a (configurable) name of the SGSN -* pool-related configuration of the SGSNs - -==== IMSI cache - -In order to route messages to the correct BSS or SGSN OsmoGbProxy -sometimes needs to cache where messages came from. - -In BSS->SGSN direction the IMSI-cache is needed for - -* paging ps reject -* dummy paging response - -when SGSN-pooling is enabled and multiple SGSNs are configured. The IMSI -contained in a paging ps or dummy paging message is cached together with -the originating SGSN/NSE. The answer, which also contains the IMSI, is -then routed back to the original SGSN. - -==== TLLI cache - -In SGSN->BSS direction OsmoGbProxy needs a TLLI cache to correctly route the -following messages: - -* suspend ack/nack -* resume ack/nack - -Suspend/resume are sent over the signalling BVC to the SGSN. OsmoGbProxy saves -the TLLI->NSE association in the TLLI cache and routes the ack/nack back to -the signalling BVC of the originating NSE.
\ No newline at end of file diff --git a/doc/manuals/chapters/gbproxy-running.adoc b/doc/manuals/chapters/gbproxy-running.adoc deleted file mode 100644 index 1f6b6a1bb..000000000 --- a/doc/manuals/chapters/gbproxy-running.adoc +++ /dev/null @@ -1,39 +0,0 @@ -== Running OsmoGbProxy - -The OsmoGbProxy executable (`osmo-gbproxy`) offers the following command-line -options: - - -=== SYNOPSIS - -*osmo-gbproxy* [-h|-V] [-d 'DBGMASK'] [-D] [-c 'CONFIGFILE'] [-s] [-e 'LOGLEVEL'] [-T] - - -=== OPTIONS - -*-h, --help*:: - Print a short help message about the supported options -*-V, --version*:: - Print the compile-time version number of the 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_sgsn.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. -*-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. -*-T, --timestamp*:: - Enable prefixing each log line on stderr with a timestamp. This - has mostly been deprecated by VTY based logging configuration, see - <<logging>> for more information. diff --git a/doc/manuals/chapters/gbproxy-sgsnpool.adoc b/doc/manuals/chapters/gbproxy-sgsnpool.adoc deleted file mode 100644 index 61806af8c..000000000 --- a/doc/manuals/chapters/gbproxy-sgsnpool.adoc +++ /dev/null @@ -1,219 +0,0 @@ -== SGSN Pooling - -SGSN pooling is described in 3GPP TS 23.236 <<3gpp-ts-23-236>>, and is supported -by OsmoGbProxy since early 2021. - -The aim of SGSN pooling is to distribute load from a BSS across multiple SGSNs, -which are equivalent and redundant infrastructure for the same core network. - -The main mechanism for SGSN pooling is the TLLI/P-TMSI, which an SGSN hands out -to its attached subscribers. Typically 10 bits of the P-TMSI are designated as a -Network Resource Identifier (NRI) that identifies the originating SGSN, and -allows OsmoGbProxy to direct a subscriber back to the same SGSN instance that -previously negotiated the Attach procedure. Typically, the full NRI value -range available is divided into N even ranges, where each SGSN is assigned one -NRI range. - -Subscribers attaching without a TLLI, or those with unknown NRI value, -are evenly distributed across SGSN instances. OsmoGbProxy uses a hash-based -approach to distribute load across all connected SGSNs. - -A Paging Response from a subscriber is always returned back to whichever SGSN -initiated the Paging, regardless of the Mobile Identity used. - -Finally, a NULL-NRI is a special NRI value that indicates that the SGSN wishes -to offload this subscriber to a different SGSN. A NULL-NRI is an arbitrary NRI -value that is chosen distinctly for each PLMN served by a BSS, so that a -subscriber can be reassigned within that PLMN. Upon (periodic) Location -Updating, an offloading SGSN hands out a NULL-NRI value in the assigned TLLI, -along with a non-broadcast LAI. The subscriber will notice the LAI mismatch, -and immediately re-attempt the attach using the TLLI containing the NULL-NRI. -OsmoGbProxy recognises the NULL-NRI and redirects the subscriber to one of the -other SGSNs. A prerequisite for this to work well is that the particular SGSN is -previously marked as not accepting new subscribers, in OsmoGbProxy's configuration. - -The mechanisms described above make up the NAS node selection function -implemented in OsmoGbProxy. - -3GPP TS 23.236 also defines that an offloading SGSN hands subscriber information -to the newly assigned SGSN, which takes place outside the scope of OsmoGbProxy. - -=== Configuring SGSN Pooling - -The NRI ranges assigned to each SGSN must match in the OsmoGbProxy and the SGSN -configuration. If inconsistent NRI value ranges are configured, -attached subscribers would be redirected to SGSN instances that did not perform the -attach, possibly rendering the core network unusable. - -==== Connecting Multiple SGSNs - ----- -# Configure the Network Service -ns - bind udp sgsn - listen 10.0.0.1 23000 - nse 1 - ip-sns 10.0.1.1 23000 - ip-sns 10.0.1.1 23001 - nse 2 - ip-sns 10.0.1.2 23000 - nse 3 - ip-sns 10.0.1.3 23000 -# configure NRI value ranges -gbproxy - nri bitlen 10 - nri null add 0 -sgsn 1 - nri add 1 341 -sgsn 2 - nri add 342 682 -sgsn 3 - nri add 683 1023 ----- - -==== NRI Value Bit Length - -In OsmGbProxy, the NRI value's bit length is freely configurable from 0 to 15 -bits. 3GPP TS 23.236 suggests a typical bit length of 10. Setting the length -to 0 disables SGSN pooling, this is also the default. -The NRI bit length must be identical across the entire SGSN pool. - -Change the NRI value bit length in OsmoGbProxy's VTY configuration like this: - ----- -gbproxy - nri bitlen 10 ----- - -In the TMSI bits, regardless of the NRI bit length, the NRI value always starts -just after the most significant octet of a TMSI (most significant bit at TMSI's -bit 23). - -==== NULL-NRI - -Since OsmoGbProxy supports serving only one PLMN, NULL-NRI are configured globally. -Even though 3GPP TS 23.236 indicates that there is a single NULL-NRI per PLMN, -OsmoGbProxy allows configuring multiple NULL-NRI values. - ----- -network - nri null add 0 - nri null add 423 ----- - -==== Assigning NRI Ranges to SGSNs - -Each SGSN configured in OsmoGbProxy must be assigned a distinct NRI value range. -Overlapping NRI value ranges will cause failure to serve subscribers. - -NRI values are typically configured in ranges, here dividing a 10bit range -(0..1023) into three equal ranges, while leaving 0 available to be configured -as NULL-NRI: - ----- -sgsn nsei 1 - nri add 1 341 -sgsn nsei 2 - nri add 342 684 -sgsn nsei 3 - nri add 685 1023 ----- - -NRI can also be assigned in single values: - ----- -sgsn nsei 1 - nri add 23 ----- - -Ranges can be constructed arbitrarily by a sequence of `add` and `del` -configurations, here a contrived example: - ----- -sgsn nsei 1 - nri add 0 342 - nri del 23 - nri del 42 235 - nri add 1000 1023 ----- - -On the VIEW and ENABLE VTY nodes, `show nri all` shows all SGSNs: - ----- -OsmoGbProxy> show nri all -sgsn nsei 1 - nri add 1 341 -sgsn nsei 2 - nri add 342 684 -sgsn nsei 3 - nri add 685 1023 ----- - -When configuring overlapping NRI value ranges across SGSNs, the telnet VTY warns -about it, and starting OsmoGbProxy with such a configuration will fail: - ----- -sgsn nsei 1 - nri add 1 511 -sgsn nsei 2 - nri add 512 1023 -sgsn nsei 3 - nri add 500 555 ----- - -This results in: - ----- -$ osmo-gbproxy -% Warning: NSE(00003/SGSN): NRI range [500..555] overlaps between NSE 00003 and NSE 00001. For overlaps, NSE 00001 has higher priority than NSE 00003 -% Warning: NSE(00003/SGSN): NRI range [500..555] overlaps between NSE 00003 and NSE 00002. For overlaps, NSE 00002 has higher priority than NSE 00003 ----- - -==== SGSN Offloading - -To effectively offload a particular SGSN, it must be marked as no longer taking -new subscribers in OsmoGbProxy. This can be achieved in the telnet VTY by: - ----- -sgsn nsei 1 - no allow-attach ----- - -This SGSN will, as long as it is connected, continue to serve subscribers -already attached to it: those that yield an NRI matching this SGSN, and those -that are being paged by this SGSN. But OsmoGbProxy will no longer direct new -subscribers to this SGSN. - -TODO: Is paging response relevant for SGSN? - -To re-enable an SGSN for attaching new subscribers: - ----- -sgsn nsei 1 - allow-attach ----- - -==== Traffic allocation - -In a SGSN pool, osmo-gbproxy is facing the problem of dividing the downlink -capacity of a cell towards the SGSN. The BSS advertises the per-BVC capacity -by means of the BSSGP FLOW-CONTROL-BVC messages, but as there are multiple -SGSN in a pool, they all have to share / divide that total capacity. - -By default, osmo-gbproxy advertises the full capacity to _each_ of the SGSN -pool members, which results in significant over-provisioning and can lead to -overload situations. - -The administrator can configure the _percentage_ of the overall BSS-advertised -capacity that shall be reported to each pool member SGSN using the -`pool bvc-flow-control-ratio <1-100>` configuration command. - -A setting of 100 means that each pool member is informed of 100% of the -BSS side capacity. - -A setting of 25 means that each pool member is informed of 25% of the -BSS side capacity. This would make most sense in a set-up with four -SGSN of equal share. - -More complex capacity division schemes are so far not supported by -osmo-gbproxy. diff --git a/doc/manuals/osmogbproxy-usermanual-docinfo.xml b/doc/manuals/osmogbproxy-usermanual-docinfo.xml deleted file mode 100644 index 29bb2aa74..000000000 --- a/doc/manuals/osmogbproxy-usermanual-docinfo.xml +++ /dev/null @@ -1,46 +0,0 @@ -<revhistory> - <revision> - <revnumber>1</revnumber> - <date>March 21, 2019</date> - <authorinitials>HW</authorinitials> - <revremark> - Initial version. - </revremark> - </revision> -</revhistory> - -<authorgroup> - <author> - <firstname>Harald</firstname> - <surname>Welte</surname> - <email>hwelte@sysmocom.de</email> - <authorinitials>HW</authorinitials> - <affiliation> - <shortaffil>sysmocom</shortaffil> - <orgname>sysmocom - s.f.m.c. GmbH</orgname> - <jobtitle>Managing Director</jobtitle> - </affiliation> - </author> -</authorgroup> - -<copyright> - <year>2013-2019</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 no Invariant Sections, 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="https://git.osmocom.org/osmo-sgsn/doc/"> - https://git.osmocom.org/osmo-sgsn/doc/ - </ulink> - </para> -</legalnotice> diff --git a/doc/manuals/osmogbproxy-usermanual.adoc b/doc/manuals/osmogbproxy-usermanual.adoc deleted file mode 100644 index d19bdd4af..000000000 --- a/doc/manuals/osmogbproxy-usermanual.adoc +++ /dev/null @@ -1,36 +0,0 @@ -:gfdl-enabled: - -OsmoGbProxy User Manual -======================= -Harald Welte <hwelte@sysmocom.de> - - -include::./common/chapters/preface.adoc[] - -include::{srcdir}/chapters/gbproxy-overview.adoc[] - -include::{srcdir}/chapters/gbproxy-details.adoc[] - -include::{srcdir}/chapters/gbproxy-running.adoc[] - -include::{srcdir}/chapters/gbproxy-control.adoc[] - -include::./common/chapters/vty.adoc[] - -include::./common/chapters/logging.adoc[] - -include::{srcdir}/chapters/gbproxy-configuration.adoc[] - -include::./common/chapters/gb.adoc[] - -include::./common/chapters/control_if.adoc[] - -//include::{srcdir}/chapters/counters.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/osmogbproxy-vty-reference.xml b/doc/manuals/osmogbproxy-vty-reference.xml deleted file mode 100644 index ecf226808..000000000 --- a/doc/manuals/osmogbproxy-vty-reference.xml +++ /dev/null @@ -1,38 +0,0 @@ -<?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_osmogbproxy-vty-reference.xml" > -]> - -<book> - <info> - <revhistory> - <revision> - <revnumber>v1</revnumber> - <date>2nd December 2019</date> - <authorinitials>hw</authorinitials> - <revremark>Initial</revremark> - </revision> - </revhistory> - - <title>OsmoGbProxy VTY Reference</title> - - <copyright> - <year>2019</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/regen_doc.sh b/doc/manuals/regen_doc.sh index 847b764aa..9fcebb8b4 100755 --- a/doc/manuals/regen_doc.sh +++ b/doc/manuals/regen_doc.sh @@ -62,12 +62,6 @@ interact_vty \ osmo-sgsn -c "../examples/osmo-sgsn/osmo-sgsn.cfg" interact_vty \ - "update_vty_reference" \ - "vty-osmogbproxy/gbproxy_vty_reference.xml" \ - 4246 \ - osmo-gbproxy -c "../examples/osmo-gbproxy/osmo-gbproxy.cfg" - -interact_vty \ "update_counters" \ "chapters/counters_generated.adoc" \ 4245 \ diff --git a/doc/manuals/vty-osmogbproxy/gbproxy_vty_additions.xml b/doc/manuals/vty-osmogbproxy/gbproxy_vty_additions.xml deleted file mode 100644 index 6da2d2f2f..000000000 --- a/doc/manuals/vty-osmogbproxy/gbproxy_vty_additions.xml +++ /dev/null @@ -1,5 +0,0 @@ -<vtydoc xmlns='urn:osmocom:xml:libosmocore:vty:doc:1.0'> - <node id='config-gbproxy'> - <description>Configure the Gb proxy</description> - </node> -</vtydoc> diff --git a/doc/manuals/vty-osmogbproxy/gbproxy_vty_reference.xml b/doc/manuals/vty-osmogbproxy/gbproxy_vty_reference.xml deleted file mode 100644 index 1db3c0d2f..000000000 --- a/doc/manuals/vty-osmogbproxy/gbproxy_vty_reference.xml +++ /dev/null @@ -1,1627 +0,0 @@ -<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 [PATH]'> - <params> - <param name='write' doc='Write running configuration to memory, network, or terminal' /> - <param name='file' doc='Write to configuration file' /> - <param name='[PATH]' doc='Set file path to store the config, or replace if already exists' /> - </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='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 (|gprs|ns|bssgp|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro) (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='gprs' doc='GPRS Packet Service' /> - <param name='ns' doc='GPRS Network Service (NS)' /> - <param name='bssgp' doc='GPRS BSS Gateway Protocol (BSSGP)' /> - <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='lrspro' doc='Remote SIM protocol' /> - <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='logp (|gprs|ns|bssgp|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro) (debug|info|notice|error|fatal) .LOGMESSAGE'> - <params> - <param name='logp' doc='Print a message on all log outputs; useful for placing markers in test logs' /> - <param name='gprs' doc='GPRS Packet Service' /> - <param name='ns' doc='GPRS Network Service (NS)' /> - <param name='bssgp' doc='GPRS BSS Gateway Protocol (BSSGP)' /> - <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='lrspro' doc='Remote SIM protocol' /> - <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' /> - <param name='.LOGMESSAGE' doc='Arbitrary message to log on given category and log 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 gbproxy [stats]'> - <params> - <param name='show' doc='Show running system information' /> - <param name='gbproxy' doc='Display information about the Gb proxy' /> - <param name='[stats]' doc='Show statistics' /> - </params> - </command> - <command id='show gbproxy links'> - <params> - <param name='show' doc='Show running system information' /> - <param name='gbproxy' doc='Display information about the Gb proxy' /> - <param name='links' doc='Show logical links' /> - </params> - </command> - <command id='show ns'> - <params> - <param name='show' doc='Show running system information' /> - <param name='ns' doc='Display information about the NS protocol' /> - </params> - </command> - <command id='show ns stats'> - <params> - <param name='show' doc='Show running system information' /> - <param name='ns' doc='Display information about the NS protocol' /> - <param name='stats' doc='Include statistics' /> - </params> - </command> - <command id='show ns persistent'> - <params> - <param name='show' doc='Show running system information' /> - <param name='ns' doc='Display information about the NS protocol' /> - <param name='persistent' doc='Show only persistent NS' /> - </params> - </command> - <command id='show ns (nsei|nsvc) <0-65535> [stats]'> - <params> - <param name='show' doc='Show running system information' /> - <param name='ns' doc='Display information about the NS protocol' /> - <param name='nsei' doc='Select one NSE by its NSE Identifier' /> - <param name='nsvc' doc='Select one NSE by its NS-VC Identifier' /> - <param name='<0-65535>' doc='The Identifier of selected type' /> - <param name='[stats]' doc='Include Statistics' /> - </params> - </command> - <command id='logging filter nsvc (nsei|nsvci) <0-65535>'> - <params> - <param name='logging' doc='Configure logging' /> - <param name='filter' doc='Filter log messages' /> - <param name='nsvc' doc='Filter based on NS Virtual Connection' /> - <param name='nsei' doc='Identify NS-VC by NSEI' /> - <param name='nsvci' doc='Identify NS-VC by NSVCI' /> - <param name='<0-65535>' doc='Numeric identifier' /> - </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='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 (|gprs|ns|bssgp|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro) (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='gprs' doc='GPRS Packet Service' /> - <param name='ns' doc='GPRS Network Service (NS)' /> - <param name='bssgp' doc='GPRS BSS Gateway Protocol (BSSGP)' /> - <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='lrspro' doc='Remote SIM protocol' /> - <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='logp (|gprs|ns|bssgp|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro) (debug|info|notice|error|fatal) .LOGMESSAGE'> - <params> - <param name='logp' doc='Print a message on all log outputs; useful for placing markers in test logs' /> - <param name='gprs' doc='GPRS Packet Service' /> - <param name='ns' doc='GPRS Network Service (NS)' /> - <param name='bssgp' doc='GPRS BSS Gateway Protocol (BSSGP)' /> - <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='lrspro' doc='Remote SIM protocol' /> - <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' /> - <param name='.LOGMESSAGE' doc='Arbitrary message to log on given category and log 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 gbproxy [stats]'> - <params> - <param name='show' doc='Show running system information' /> - <param name='gbproxy' doc='Display information about the Gb proxy' /> - <param name='[stats]' doc='Show statistics' /> - </params> - </command> - <command id='show gbproxy links'> - <params> - <param name='show' doc='Show running system information' /> - <param name='gbproxy' doc='Display information about the Gb proxy' /> - <param name='links' doc='Show logical links' /> - </params> - </command> - <command id='delete-gbproxy-peer <0-65534> bvci <2-65534>'> - <params> - <param name='delete-gbproxy-peer' doc='Delete a GBProxy peer by NSEI and optionally BVCI' /> - <param name='<0-65534>' doc='NSEI number' /> - <param name='bvci' doc='Only delete peer with a matching BVCI' /> - <param name='<2-65534>' doc='BVCI number' /> - </params> - </command> - <command id='delete-gbproxy-peer <0-65534> (only-bvc|only-nsvc|all) [dry-run]'> - <params> - <param name='delete-gbproxy-peer' doc='Delete a GBProxy peer by NSEI and optionally BVCI' /> - <param name='<0-65534>' doc='NSEI number' /> - <param name='only-bvc' doc='Only delete BSSGP connections (BVC)' /> - <param name='only-nsvc' doc='Only delete dynamic NS connections (NS-VC)' /> - <param name='all' doc='Delete BVC and dynamic NS connections' /> - <param name='[dry-run]' doc='Show what would be deleted instead of actually deleting' /> - </params> - </command> - <command id='delete-gbproxy-link <0-65534> (tlli|imsi|sgsn-nsei) IDENT'> - <params> - <param name='delete-gbproxy-link' doc='Delete a GBProxy logical link entry by NSEI and identification' /> - <param name='<0-65534>' doc='NSEI number' /> - <param name='tlli' doc='Delete entries with a matching TLLI (hex)' /> - <param name='imsi' doc='Delete entries with a matching IMSI' /> - <param name='sgsn-nsei' doc='Delete entries with a matching SGSN NSEI' /> - <param name='IDENT' doc='Identification to match' /> - </params> - </command> - <command id='delete-gbproxy-link <0-65534> (stale|de-registered)'> - <params> - <param name='delete-gbproxy-link' doc='Delete a GBProxy logical link entry by NSEI and identification' /> - <param name='<0-65534>' doc='NSEI number' /> - <param name='stale' doc='Delete stale entries' /> - <param name='de-registered' doc='Delete de-registered entries' /> - </params> - </command> - <command id='show ns'> - <params> - <param name='show' doc='Show running system information' /> - <param name='ns' doc='Display information about the NS protocol' /> - </params> - </command> - <command id='show ns stats'> - <params> - <param name='show' doc='Show running system information' /> - <param name='ns' doc='Display information about the NS protocol' /> - <param name='stats' doc='Include statistics' /> - </params> - </command> - <command id='show ns persistent'> - <params> - <param name='show' doc='Show running system information' /> - <param name='ns' doc='Display information about the NS protocol' /> - <param name='persistent' doc='Show only persistent NS' /> - </params> - </command> - <command id='show ns (nsei|nsvc) <0-65535> [stats]'> - <params> - <param name='show' doc='Show running system information' /> - <param name='ns' doc='Display information about the NS protocol' /> - <param name='nsei' doc='Select one NSE by its NSE Identifier' /> - <param name='nsvc' doc='Select one NSE by its NS-VC Identifier' /> - <param name='<0-65535>' doc='The Identifier of selected type' /> - <param name='[stats]' doc='Include Statistics' /> - </params> - </command> - <command id='logging filter nsvc (nsei|nsvci) <0-65535>'> - <params> - <param name='logging' doc='Configure logging' /> - <param name='filter' doc='Filter log messages' /> - <param name='nsvc' doc='Filter based on NS Virtual Connection' /> - <param name='nsei' doc='Identify NS-VC by NSEI' /> - <param name='nsvci' doc='Identify NS-VC by NSVCI' /> - <param name='<0-65535>' doc='Numeric identifier' /> - </params> - </command> - <command id='nsvc (nsei|nsvci) <0-65535> (block|unblock|reset)'> - <params> - <param name='nsvc' doc='Perform an operation on a NSVC' /> - <param name='nsei' doc='NSEI to identify NS-VC Identifier (NS-VCI)' /> - <param name='nsvci' doc='NS-VC Identifier (NS-VCI)' /> - <param name='<0-65535>' doc='The NSEI' /> - <param name='block' doc='Initiate BLOCK procedure' /> - <param name='unblock' doc='Initiate UNBLOCK procedure' /> - <param name='reset' doc='Initiate RESET procedure' /> - </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='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='gbproxy'> - <params> - <param name='gbproxy' doc='Configure the Gb proxy' /> - </params> - </command> - <command id='ns'> - <params> - <param name='ns' doc='Configure the GPRS Network Service' /> - </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 (|gprs|ns|bssgp|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro) (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='gprs' doc='GPRS Packet Service' /> - <param name='ns' doc='GPRS Network Service (NS)' /> - <param name='bssgp' doc='GPRS BSS Gateway Protocol (BSSGP)' /> - <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='lrspro' doc='Remote SIM protocol' /> - <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 nsvc (nsei|nsvci) <0-65535>'> - <params> - <param name='logging' doc='Configure logging' /> - <param name='filter' doc='Filter log messages' /> - <param name='nsvc' doc='Filter based on NS Virtual Connection' /> - <param name='nsei' doc='Identify NS-VC by NSEI' /> - <param name='nsvci' doc='Identify NS-VC by NSVCI' /> - <param name='<0-65535>' doc='Numeric identifier' /> - </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 [<0-65535>]'> - <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)' /> - <param name='[<0-65535>]' doc='Local TCP port number' /> - </params> - </command> - </node> - <node id='config-ns'> - <name>config-ns</name> - <command id='nse <0-65535> nsvci <0-65534>'> - <params> - <param name='nse' doc='Persistent NS Entity' /> - <param name='<0-65535>' doc='NS Entity ID (NSEI)' /> - <param name='nsvci' doc='NS Virtual Connection' /> - <param name='<0-65534>' doc='NS Virtual Connection ID (NSVCI)' /> - </params> - </command> - <command id='nse <0-65535> remote-ip A.B.C.D'> - <params> - <param name='nse' doc='Persistent NS Entity' /> - <param name='<0-65535>' doc='NS Entity ID (NSEI)' /> - <param name='remote-ip' doc='Remote IP Address' /> - <param name='A.B.C.D' doc='Remote IP Address' /> - </params> - </command> - <command id='nse <0-65535> remote-port <0-65535>'> - <params> - <param name='nse' doc='Persistent NS Entity' /> - <param name='<0-65535>' doc='NS Entity ID (NSEI)' /> - <param name='remote-port' doc='Remote UDP Port' /> - <param name='<0-65535>' doc='Remote UDP Port Number' /> - </params> - </command> - <command id='nse <0-65535> fr-dlci <16-1007>'> - <params> - <param name='nse' doc='Persistent NS Entity' /> - <param name='<0-65535>' doc='NS Entity ID (NSEI)' /> - <param name='fr-dlci' doc='Frame Relay DLCI' /> - <param name='<16-1007>' doc='Frame Relay DLCI Number' /> - </params> - </command> - <command id='nse <0-65535> encapsulation (udp|framerelay-gre)'> - <params> - <param name='nse' doc='Persistent NS Entity' /> - <param name='<0-65535>' doc='NS Entity ID (NSEI)' /> - <param name='encapsulation' doc='Encapsulation for NS' /> - <param name='udp' doc='UDP/IP Encapsulation' /> - <param name='framerelay-gre' doc='Frame-Relay/GRE/IP Encapsulation' /> - </params> - </command> - <command id='nse <0-65535> remote-role (sgsn|bss)'> - <params> - <param name='nse' doc='Persistent NS Entity' /> - <param name='<0-65535>' doc='NS Entity ID (NSEI)' /> - <param name='remote-role' doc='Remote NSE Role' /> - <param name='sgsn' doc='Remote Peer is SGSN' /> - <param name='bss' doc='Remote Peer is BSS' /> - </params> - </command> - <command id='no nse <0-65535>'> - <params> - <param name='no' doc='Delete Persistent NS Entity' /> - <param name='nse' doc='Delete Persistent NS Entity' /> - <param name='<0-65535>' doc='NS Entity ID (NSEI)' /> - </params> - </command> - <command id='timer (tns-block|tns-block-retries|tns-reset|tns-reset-retries|tns-test|tns-alive|tns-alive-retries|tsns-prov) <0-65535>'> - <params> - <param name='timer' doc='Network Service Timer' /> - <param name='tns-block' doc='(un)blocking Timer (Tns-block) timeout' /> - <param name='tns-block-retries' doc='(un)blocking Timer (Tns-block) number of retries' /> - <param name='tns-reset' doc='Reset Timer (Tns-reset) timeout' /> - <param name='tns-reset-retries' doc='Reset Timer (Tns-reset) number of retries' /> - <param name='tns-test' doc='Test Timer (Tns-test) timeout' /> - <param name='tns-alive' doc='Alive Timer (Tns-alive) timeout' /> - <param name='tns-alive-retries' doc='Alive Timer (Tns-alive) number of retries' /> - <param name='tsns-prov' doc='SNS Provision Timer (Tsns-prov) timeout' /> - <param name='<0-65535>' doc='Timer Value' /> - </params> - </command> - <command id='encapsulation udp local-ip A.B.C.D'> - <params> - <param name='encapsulation' doc='NS encapsulation options' /> - <param name='udp' doc='NS over UDP Encapsulation' /> - <param name='local-ip' doc='Set the IP address on which we listen for NS/UDP' /> - <param name='A.B.C.D' doc='IP Address' /> - </params> - </command> - <command id='encapsulation udp local-port <0-65535>'> - <params> - <param name='encapsulation' doc='NS encapsulation options' /> - <param name='udp' doc='NS over UDP Encapsulation' /> - <param name='local-port' doc='Set the UDP port on which we listen for NS/UDP' /> - <param name='<0-65535>' doc='UDP port number' /> - </params> - </command> - <command id='encapsulation udp dscp <0-255>'> - <params> - <param name='encapsulation' doc='NS encapsulation options' /> - <param name='udp' doc='NS over UDP Encapsulation' /> - <param name='dscp' doc='Set DSCP/TOS on the UDP socket' /> - <param name='<0-255>' doc='DSCP Value' /> - </params> - </command> - <command id='encapsulation framerelay-gre enabled (1|0)'> - <params> - <param name='encapsulation' doc='NS encapsulation options' /> - <param name='framerelay-gre' doc='NS over Frame Relay over GRE Encapsulation' /> - <param name='enabled' doc='Enable or disable Frame Relay over GRE' /> - <param name='1' doc='Enable' /> - <param name='0' doc='Disable' /> - </params> - </command> - <command id='encapsulation framerelay-gre local-ip A.B.C.D'> - <params> - <param name='encapsulation' doc='NS encapsulation options' /> - <param name='framerelay-gre' doc='NS over Frame Relay over GRE Encapsulation' /> - <param name='local-ip' doc='Set the IP address on which we listen for NS/FR/GRE' /> - <param name='A.B.C.D' doc='IP Address' /> - </params> - </command> - </node> - <node id='config-gbproxy'> - <name>config-gbproxy</name> - <command id='sgsn nsei <0-65534>'> - <params> - <param name='sgsn' doc='SGSN information' /> - <param name='nsei' doc='NSEI to be used in the connection with the SGSN' /> - <param name='<0-65534>' doc='The NSEI' /> - </params> - </command> - <command id='core-mobile-country-code <1-999>'> - <params> - <param name='core-mobile-country-code' doc='Use this country code for the core network' /> - <param name='<1-999>' doc='MCC value' /> - </params> - </command> - <command id='core-mobile-network-code <1-999>'> - <params> - <param name='core-mobile-network-code' doc='Use this network code for the core network' /> - <param name='<1-999>' doc='NCC value' /> - </params> - </command> - <command id='match-imsi (patching|routing) .REGEXP'> - <params> - <param name='match-imsi' doc='Restrict actions to certain IMSIs' /> - <param name='patching' doc='Patch MS related information elements on match only' /> - <param name='routing' doc='Route to the secondary SGSN on match only' /> - <param name='.REGEXP' doc='Regular expression for the IMSI match' /> - </params> - </command> - <command id='core-access-point-name (APN|none)'> - <params> - <param name='core-access-point-name' doc='Use this access point name (APN) for the backbone' /> - <param name='APN' doc='Replace APN by this string' /> - <param name='none' doc='Remove APN' /> - </params> - </command> - <command id='secondary-sgsn nsei <0-65534>'> - <params> - <param name='secondary-sgsn' doc='Route matching LLC connections to a second SGSN (Experimental)' /> - <param name='nsei' doc='NSEI to be used in the connection with the SGSN' /> - <param name='<0-65534>' doc='The NSEI' /> - </params> - </command> - <command id='patch-ptmsi'> - <params> - <param name='patch-ptmsi' doc='Patch P-TMSI/TLLI' /> - </params> - </command> - <command id='acquire-imsi'> - <params> - <param name='acquire-imsi' doc='Acquire the IMSI before establishing a LLC connection (Experimental)' /> - </params> - </command> - <command id='link-list clean-stale-timer <1-999999>'> - <params> - <param name='link-list' doc='Set TLLI list parameters' /> - <param name='clean-stale-timer' doc='Periodic timer to clean stale links' /> - <param name='<1-999999>' doc='Frequency at which the periodic timer is fired (in seconds)' /> - </params> - </command> - <command id='link-list max-age <1-999999>'> - <params> - <param name='link-list' doc='Set TLLI list parameters' /> - <param name='max-age' doc='Limit maximum age' /> - <param name='<1-999999>' doc='Maximum age in seconds' /> - </params> - </command> - <command id='link-list max-length <1-99999>'> - <params> - <param name='link-list' doc='Set TLLI list parameters' /> - <param name='max-length' doc='Limit list length' /> - <param name='<1-99999>' doc='Maximum number of logical links in the list' /> - </params> - </command> - <command id='link-list keep-mode (never|re-attach|identified|always)'> - <params> - <param name='link-list' doc='Set TLLI list parameters' /> - <param name='keep-mode' doc='How to keep entries for detached logical links' /> - <param name='never' doc='Discard entry immediately after detachment' /> - <param name='re-attach' doc='Keep entry if a re-attachment has be requested' /> - <param name='identified' doc='Keep entry if it associated with an IMSI' /> - <param name='always' doc='Don't discard entries after detachment' /> - </params> - </command> - <command id='link stored-msgs-max-length <1-99999>'> - <params> - <param name='link' doc='Set TLLI parameters' /> - <param name='stored-msgs-max-length' doc='Limit list length' /> - <param name='<1-99999>' doc='Maximum number of msgb stored in the logical link waiting to acquire its IMSI' /> - </params> - </command> - <command id='no core-mobile-country-code'> - <params> - <param name='no' doc='Negate a command or set its defaults' /> - <param name='core-mobile-country-code' doc='Use this country code for the core network' /> - </params> - </command> - <command id='no core-mobile-network-code'> - <params> - <param name='no' doc='Negate a command or set its defaults' /> - <param name='core-mobile-network-code' doc='Use this network code for the core network' /> - </params> - </command> - <command id='no match-imsi'> - <params> - <param name='no' doc='Negate a command or set its defaults' /> - <param name='match-imsi' doc='Restrict actions to certain IMSIs' /> - </params> - </command> - <command id='no core-access-point-name'> - <params> - <param name='no' doc='Negate a command or set its defaults' /> - <param name='core-access-point-name' doc='Use this access point name (APN) for the backbone' /> - </params> - </command> - <command id='no secondary-sgsn'> - <params> - <param name='no' doc='Negate a command or set its defaults' /> - <param name='secondary-sgsn' doc='Route matching LLC connections to a second SGSN (Experimental)' /> - </params> - </command> - <command id='no patch-ptmsi'> - <params> - <param name='no' doc='Negate a command or set its defaults' /> - <param name='patch-ptmsi' doc='Patch P-TMSI/TLLI' /> - </params> - </command> - <command id='no acquire-imsi'> - <params> - <param name='no' doc='Negate a command or set its defaults' /> - <param name='acquire-imsi' doc='Acquire the IMSI before establishing a LLC connection (Experimental)' /> - </params> - </command> - <command id='no link-list clean-stale-timer'> - <params> - <param name='no' doc='Negate a command or set its defaults' /> - <param name='link-list' doc='Set TLLI list parameters' /> - <param name='clean-stale-timer' doc='Periodic timer to clean stale links' /> - </params> - </command> - <command id='no link-list max-age'> - <params> - <param name='no' doc='Negate a command or set its defaults' /> - <param name='link-list' doc='Set TLLI list parameters' /> - <param name='max-age' doc='Limit maximum age' /> - </params> - </command> - <command id='no link-list max-length'> - <params> - <param name='no' doc='Negate a command or set its defaults' /> - <param name='link-list' doc='Set TLLI list parameters' /> - <param name='max-length' doc='Limit list length' /> - </params> - </command> - <command id='no link stored-msgs-max-length'> - <params> - <param name='no' doc='Negate a command or set its defaults' /> - <param name='link' doc='Set TLLI parameters' /> - <param name='stored-msgs-max-length' doc='Limit list length' /> - </params> - </command> - </node> -</vtydoc> |