diff options
-rw-r--r-- | doc/manuals/Makefile | 41 | ||||
-rw-r--r-- | doc/manuals/chapters/configuration.adoc | 163 | ||||
-rw-r--r-- | doc/manuals/chapters/gsup.adoc | 592 | ||||
-rw-r--r-- | doc/manuals/chapters/overview.adoc | 126 | ||||
-rw-r--r-- | doc/manuals/chapters/running.adoc | 35 | ||||
-rw-r--r-- | doc/manuals/osmosgsn-usermanual-docinfo.xml | 48 | ||||
-rw-r--r-- | doc/manuals/osmosgsn-usermanual.adoc | 32 | ||||
-rw-r--r-- | doc/manuals/osmosgsn-vty-reference.xml | 44 | ||||
-rw-r--r-- | doc/manuals/vty/sgsn_vty_additions.xml | 113 | ||||
-rw-r--r-- | doc/manuals/vty/sgsn_vty_reference.xml | 1355 |
10 files changed, 2549 insertions, 0 deletions
diff --git a/doc/manuals/Makefile b/doc/manuals/Makefile new file mode 100644 index 000000000..803a74bfd --- /dev/null +++ b/doc/manuals/Makefile @@ -0,0 +1,41 @@ +# XSL stylesheets downloaded from http://docbook.sourceforge.net/release/xsl/current/html/ +# Makefile from BitBake/OpenEmbedded manuals + +EXTRA_DEPS = gen-sgsn-vty-docbook + +topdir = . +sgsn_reference = $(topdir)/osmosgsn-vty-reference.xml +manuals = $(sgsn_reference) +# types = pdf txt rtf ps xhtml html man tex texi dvi +# types = pdf txt +types = $(docbooktotypes) +docbooktotypes = pdf +# htmlcssfile = +# htmlcss = + +TOPDIR := .. +ASCIIDOCS := osmosgsn-usermanual + +include $(TOPDIR)/build/Makefile.asciidoc.inc +include $(TOPDIR)/build/Makefile.inc + +osmosgsn-usermanual.pdf: chapters/*.adoc + +clean: + rm -rf $(cleanfiles) + +gen-sgsn-vty-docbook: FORCE + $(call command,xsltproc -o generated/combined1.xml \ + --stringparam with $(PWD)/../common/vty_additions.xml \ + $(MERGE_DOC) vty/sgsn_vty_reference.xml, \ + XSLTPROC,Merging Common VTY) + $(call command,xsltproc -o generated/combined2.xml \ + --stringparam with $(PWD)/../common/ns_vty_additions.xml \ + $(MERGE_DOC) generated/combined1.xml, \ + XSLTPROC,Merging Common NS VTY) + $(call command,xsltproc -o generated/combined3.xml \ + --stringparam with $(PWD)/vty/sgsn_vty_additions.xml \ + $(MERGE_DOC) generated/combined2.xml, \ + XSLTPROC,Merging SGSN VTY) + $(call command,xsltproc ../vty_reference.xsl generated/combined3.xml > generated/docbook_vty.xml, \ + XSLTPROC,Converting SGSN VTY to DocBook) diff --git a/doc/manuals/chapters/configuration.adoc b/doc/manuals/chapters/configuration.adoc new file mode 100644 index 000000000..ce726ea0c --- /dev/null +++ b/doc/manuals/chapters/configuration.adoc @@ -0,0 +1,163 @@ +== Configuring OsmoSGSN + +Contrary to other network elements (like OsmoBSC, OsmoNITB), the +OsmoSGSN has a relatively simple configuration. + +On the one hand, this is primary because the PCU configuration happens +from the BSC side. + +On the other hand, it is because the Gb interface does not need an +explicit configuration of all each PCU connecting to the SGSN. The +administrator only has to ensure that the NS and BSSGP layer identities +(NSEI, NSVCI, BVCI) are unique for each PCU connecting to the SGSN. + +=== Configuring the Gp interface + +The Gp interface is the GTP-C and GTP-U based interface between the SGSN +and the GGSNs. It is implemented via UDP on well-known source and +destination ports. + +When a MS requests establishment of a PDP context, it specifies the APN +(Access Point Name) to which the context shall be established. This APN +determines which GGSN shall be used, and that in turn determines which +external IP network the MS will be connected to. + +There are two modes in which GGSNs can be configured: + +. static GGSN/APN configuration +. dynamic GGSN/APN configuration + +==== Static GGSN/APN configuration + +In this mode, there is a static list of GGSNs and APNs configured in +OsmoSGSN via the VTY / config file. + +This is a non-standard method outside of the 3GPP specifications for the +SGSN, and is typically only used in private/small GPRS networks without +any access to a GRX. + +.Example: Static GGSN/APN configuration (single catch-all GGSN) +---- +OsmoSGSN(config-sgsn)# gtp local-ip 172.0.0.1 <1> +OsmoSGSN(config-sgsn)# ggsn 0 remote-ip 127.0.0.2 <2> +OsmoSGSN(config-sgsn)# ggsn 0 gtp-version 1 <3> +OsmoSGSN(config-sgsn)# apn * ggsn 0 <4> +---- +<1> Configure the local IP address at the SGSN used for Gp/GTP +<2> Specify the remote IP address of the GGSN (for GGSN 0) +<3> Specify the GTP protocol version used for GGSN 0 +<4> Route all APN names to GGSN 0 + + +==== Dynamic GGSN/APN configuration + +In this mode, the SGSN will use a DNS-based method to perform the lookup +from the APN (as specified by the MS) towards the GGSN IP address. + +This is the official method as per the 3GPP specifications for the SGSN, +and what is used on GRX. + +.Example: Dynamic GGSN/APN configuration +---- +OsmoSGSN(config-sgsn)# gtp local-ip 192.168.0.11 <1> +OsmoSGSN(config-sgsn)# ggsn dynamic <2> +OsmoSGSN(config-sgsn)# grx-dns-add 1.2.3.4 <3> +---- +<1> Configure the local IP address at the SGSN used for Gp/GTP +<2> Enable the dynamic GGSN resolving mode +<3> Specify the IP address of a DNS server for APN resolution + + +=== Subscriber Configuration + +As opposed to OsmoNITB, OsmoSGSN does not feature a built-in HLR. + +It can thus operate only in the following two modes: + +. Accessing an external HLR (or HLR gateway) via the GSUP protocol +. Accepting subscribers based on internal ACL (access control list) + +==== Accessing an external HLR via GSUP + +The non-standard GSUP protocol was created to provide OsmoSGSN with +access to an external HLR while avoiding the complexities of the +TCAP/MAP protocol stack commonly used by HLRs. + +A custom HLR could either directly implement GSUP, or an external gateway +can be used to convert GSUP to the respective MAP operations. + +The primitives/operations of GSUP are modelled to have a 1:1 +correspondence to their MAP counterparts. However, the encoding is much +simplified by use of a binary TLV encoding similar to Layer 3 of +GSM/GPRS. + +GSUP performs a challenge-response authentication protocol called OAP, +which uses the standard MILEAGE algorithm for mutual authentication +between OsmoSGSN and the HLR/HLR-GW. + +[[sgsn-ex-gsup]] +.Example: Using an external HLR via GSUP +---- +OsmoSGSN(config-sgsn)# gsup remote-ip 2.3.4.5 <1> +OsmoSGSN(config-sgsn)# gsup remote-port 10000 <2> +OsmoSGSN(config-sgsn)# gsup oap-k 000102030405060708090a0b0c0d0e0f <3> +OsmoSGSN(config-sgsn)# gsup oap-opc 101112131415161718191a1b1c1d1e1f <4> +---- +<1> Configure the IP address of the (remote) HLR or HLR-GW +<2> Configure the TCP port of the (remote) HLR or HLR-GW +<3> Specify the OAP shared key +<4> Specify the OAP shared OPC + + +=== CDR configuration + +OsmoSGSN can write a text log file containing CDR (call data records), +which are commonly used for accounting/billing purpose. + +.Example: CDR configuration +---- +OsmoSGSN(config-sgsn)# cdr filename /var/log/osmosgsn.cdr +OsmoSGSN(config-sgsn)# cdr interval 600 <1> +---- +<1> Periodically log existing PDP contexts every 600 seconds (10 min) + +The CDR file is a simple CSV file including a header line naming the +individual fields of each CSV line. + +[[sgsn-cdr]] +.Descripton of CSV fields in OsmoSGSN CDR file +[options="header",cols="15%,85%"] +|=== +|timestamp|Timestamp in YYYYMMDDhhmmssXXX where XXX are milli-seconds +|imsi|IMSI causing this CDR +|imei|IMEI causing this CDR +|msisdn|MSISDN causing this CDR (if known) +|cell_id|Cell ID in which the MS was registered last +|lac|Location Area Code in which the MS was registered last +|hlr|HLR of the subscriber +|event|Possible events are explained below in <<sgsn-cdr-evt>> +|pdp| +|pdp_duration|duration of the PDP context so far +|ggsn_addr|GGSN related to the PDP context +|sgsn_addr|SGSN related to the PDP context +|apni|APN identifier of the PDP context +|eua_addr|IP address allocated to the PDP context +|vol_in|Number of bytes in MO direction +|vol_out|Number of bytes in MT direction +|charging_id|Related charging ID +|=== + +[[sgsn-cdr-event]] +.Description of OsmoSGSN CDR Events +[options="header",cols="15%,85%"] +|=== +|Event|Description +|attach|GMM ATTACH COMPLETE about to be sent to MS +|update|GMM ROUTING AREA UPDATE COMPLETE about to be sent to MS +|detach|GMM DETACH REQUEST received from MS +|free|Release of the MM context memory +|pdp-act|GTP CREATE PDP CONTEXT CONFIRM received from GGSN +|pdp-deact|GTP DELETE PDP CONTEXT CONFIRM received from GGSN +|pdp-terminate|Forced PDP context termination during MM context release +|pdp-free|Release of the PDP context memory +|=== diff --git a/doc/manuals/chapters/gsup.adoc b/doc/manuals/chapters/gsup.adoc new file mode 100644 index 000000000..9efc8c096 --- /dev/null +++ b/doc/manuals/chapters/gsup.adoc @@ -0,0 +1,592 @@ +[[gsup]] +== GPRS Subscriber Update Protocol + +=== General + +This chapter describes the remote protocol that is used by the SGSN to update +and manage the local subscriber list. The protocol and the messages are +designed after the corresponding MAP messages (see 3GPP TS 09.02) with the +following differences: + +* The encoding uses TLV structures instead of ASN.1 encodings +* Segmentation is not used + +For more information, see the specification of the Gr interface (3GPP TS 03.60). + +=== Connection + +The protocol expects that a reliable, ordered, packet boundaries preserving +connection is used (e.g. IPA over TCP). The remote peer is either a service +that understands the protocol natively or a wrapper service that maps the +messages to/from real MAP messages that can be used to directly communicate +with an HLR. + +=== Using IPA + +By default, the following identifiers should be used: + +* IPA Stream ID: 0xEE (OSMO) +* IPA OSMO protocol extension: 0x05 + +For more information about the IPA multiplex, please see the 'OsmoBTS +Abis/IP Specifiation'. + +=== Procedures + +==== Authentication management + +The SGSN sends a SEND_AUTHENTICATION_INFO_REQ message containing the MS's IMSI +to the peer. On errors, especially if authentication info is not availabe for +that IMSI, the peer returns a SEND_AUTHENTICATION_INFO_ERR message. Otherwise +the peer returns a SEND_AUTHENTICATION_INFO_RES message. If this message +contains at least one authentication tuple, the SGSN replaces all tuples that +are assigned to the subscriber. If the message doesn't contain any tuple the +SGSN may reject the Attach Request. (see 3GPP TS 09.02, 25.5.6) + +==== Location Updating + +The SGSN sends a UPDATE_LOCATION_REQ to the peer. If the request is denied by +the network, the peer returns an UPDATE_LOCATION_ERR message to the SGSN. +Otherwise the peer returns an UPDATE_LOCATION_RES message containing all +information fields that shall be inserted into the subscriber record. If +the 'PDP info complete' information element is set in the message, the SGSN +clears existing PDP information fields in the subscriber record first. +(see 3GPP TS 09.02, 19.1.1.8) + +... + +=== Message Format + +==== General + +Every message is based on the following message format + +[options="header",cols="5%,20%,45%,10%,10%,10%"] +|=== +|IEI|IE|Type|Presence|Format|Length +| |Message Type|<<gsup-ie-msgtype>>|M|V|1 +|01|IMSI|<<gsup-ie-imsi>>|M|TLV|2-10 +|=== + +If a numeric range is indicated in the 'presence' column, multiple information +elements with the same tag may be used in sequence. The information elements +shall be sent in the given order. Nevertheless after the generic part the +receiver shall be able to received them in any order. Unknown IE shall be +ignored. + +==== Send Authentication Info Request + +Direction: SGSN -> Network peer + +[options="header",cols="5%,20%,45%,10%,10%,10%"] +|=== +|IEI|IE|Type|Presence|Format|Length +| |Message Type|<<gsup-ie-msgtype>>|M|V|1 +|01|IMSI|<<gsup-ie-imsi>>|M|TLV|2-10 +|=== + +==== Send Authentication Info Error + +Direction: Network peer -> SGSN + +[options="header",cols="5%,20%,45%,10%,10%,10%"] +|=== +|IEI|IE|Type|Presence|Format|Length +| |Message Type|<<gsup-ie-msgtype>>|M|V|1 +|01|IMSI|<<gsup-ie-imsi>>|M|TLV|2-10 +|02|Cause|<<gsup-ie-cause>>|M|TLV|3 +|=== + +==== Send Authentication Info Response + +Direction: Network peer -> SGSN + +[options="header",cols="5%,20%,45%,10%,10%,10%"] +|=== +|IEI|IE|Type|Presence|Format|Length +| |Message Type|<<gsup-ie-msgtype>>|M|V|1 +|01|IMSI|<<gsup-ie-imsi>>|M|TLV|2-10 +|03|Auth Tuple|<<gsup-ie-authtuple>>|0-5|TLV|36 +|=== + +==== Update Location Request + +Direction: SGSN -> Network peer + +[options="header",cols="5%,20%,45%,10%,10%,10%"] +|=== +|IEI|IE|Type|Presence|Format|Length +| |Message Type|<<gsup-ie-msgtype>>|M|V|1 +|01|IMSI|<<gsup-ie-imsi>>|M|TLV|2-10 +|=== + +==== Update Location Error + +Direction: Network peer -> SGSN + +[options="header",cols="5%,20%,45%,10%,10%,10%"] +|=== +|IEI|IE|Type|Presence|Format|Length +| |Message Type|<<gsup-ie-msgtype>>|M|V|1 +|01|IMSI|<<gsup-ie-imsi>>|M|TLV|2-10 +|02|Cause|<<gsup-ie-cause>>|M|TLV|3 +|=== + +==== Update Location Result + +Direction: Network peer -> SGSN + +[options="header",cols="5%,20%,45%,10%,10%,10%"] +|=== +|IEI|IE|Type|Presence|Format|Length +| |Message Type|<<gsup-ie-msgtype>>|M|V|1 +|01|IMSI|<<gsup-ie-imsi>>|M|TLV|2-10 +|08|MSISDN|<<gsup-ie-msisdn>>|O|TLV|0-9 +|09|HLR Number|<<gsup-ie-hlr>>|O|TLV|0-9 +|04|PDP info complete|<<gsup-ie-empty>>|O|TLV|2 +|05|PDP info|<<gsup-ie-pdpinfo>>|1-10|TLV| +|=== + +If the PDP info complete IE is present, the old PDP info list shall be cleared. + +==== Location Cancellation Request + +Direction: Network peer -> SGSN + +[options="header",cols="5%,20%,45%,10%,10%,10%"] +|=== +|IEI|IE|Type|Presence|Format|Length +| |Message Type|<<gsup-ie-msgtype>>|M|V|1 +|01|IMSI|<<gsup-ie-imsi>>|M|TLV|2-10 +|06|Cancellation type|<<gsup-ie-canctype>>|O|TLV|3 +|=== + +==== Location Cancellation Result + +Direction: SGSN -> Network peer + +[options="header",cols="5%,20%,45%,10%,10%,10%"] +|=== +|IEI|IE|Type|Presence|Format|Length +| |Message Type|<<gsup-ie-msgtype>>|M|V|1 +|01|IMSI|<<gsup-ie-imsi>>|M|TLV|2-10 +|=== + +==== Purge MS Request + +Direction: SGSN -> Network peer + +[options="header",cols="5%,20%,45%,10%,10%,10%"] +|=== +|IEI|IE|Type|Presence|Format|Length +| |Message Type|<<gsup-ie-msgtype>>|M|V|1 +|01|IMSI|<<gsup-ie-imsi>>|M|TLV|2-10 +|09|HLR Number|<<gsup-ie-hlr>>|M|TLV|0-9 +|=== + +==== Purge MS Error + +Direction: Network peer -> SGSN + +[options="header",cols="5%,20%,45%,10%,10%,10%"] +|=== +|IEI|IE|Type|Presence|Format|Length +| |Message Type|<<gsup-ie-msgtype>>|M|V|1 +|01|IMSI|<<gsup-ie-imsi>>|M|TLV|2-10 +|02|Cause|<<gsup-ie-cause>>|M|TLV|3 +|=== + +==== Purge MS Result + +Direction: Network peer -> SGSN + +[options="header",cols="5%,20%,45%,10%,10%,10%"] +|=== +|IEI|IE|Type|Presence|Format|Length +| |Message Type|<<gsup-ie-msgtype>>|M|V|1 +|01|IMSI|<<gsup-ie-imsi>>|M|TLV|2-10 +|07|Freeze P-TMSI|<<gsup-ie-empty>>|M|TLV|2 +|=== + +==== Insert Subscriber Data Request + +Direction: Network peer -> SGSN + +[options="header",cols="5%,20%,45%,10%,10%,10%"] +|=== +|IEI|IE|Type|Presence|Format|Length +| |Message Type|<<gsup-ie-msgtype>>|M|V|1 +|01|IMSI|<<gsup-ie-imsi>>|M|TLV|2-10 +|04|PDP info complete|<<gsup-ie-empty>>|M|TLV|2 +|05|PDP info|<<gsup-ie-pdpinfo>>|0-10|TLV| +|=== + +If the PDP info complete IE is present, the old PDP info list shall be cleared. + +==== Insert Subscriber Data Error + +Direction: SGSN -> Network peer + +[options="header",cols="5%,20%,45%,10%,10%,10%"] +|=== +|IEI|IE|Type|Presence|Format|Length +| |Message Type|<<gsup-ie-msgtype>>|M|V|1 +|01|IMSI|<<gsup-ie-imsi>>|M|TLV|2-10 +|02|Cause|<<gsup-ie-cause>>|M|TLV|3 +|=== + +==== Insert Subscriber Data Result + +Direction: SGSN -> Network peer + +[options="header",cols="5%,20%,45%,10%,10%,10%"] +|=== +|IEI|IE|Type|Presence|Format|Length +| |Message Type|<<gsup-ie-msgtype>>|M|V|1 +|01|IMSI|<<gsup-ie-imsi>>|M|TLV|2-10 +|=== + +==== Delete Subscriber Data Request + +Direction: Network peer -> SGSN + +[options="header",cols="5%,20%,45%,10%,10%,10%"] +|=== +|IEI|IE|Type|Presence|Format|Length +| |Message Type|<<gsup-ie-msgtype>>|M|V|1 +|01|IMSI|<<gsup-ie-imsi>>|M|TLV|2-10 +|10|PDP context id|<<gsup-ie-pdpinfo>> (no conditional IE)|0-10|TLV| +|=== + +==== Delete Subscriber Data Error + +Direction: SGSN -> Network peer + +[options="header",cols="5%,20%,45%,10%,10%,10%"] +|=== +|IEI|IE|Type|Presence|Format|Length +| |Message Type|<<gsup-ie-msgtype>>|M|V|1 +|01|IMSI|<<gsup-ie-imsi>>|M|TLV|2-10 +|02|Cause|<<gsup-ie-cause>>|M|TLV|3 +|=== + +==== Delete Subscriber Data Result + +Direction: Network peer -> SGSN + +[options="header",cols="5%,20%,45%,10%,10%,10%"] +|=== +|IEI|IE|Type|Presence|Format|Length +| |Message Type|<<gsup-ie-msgtype>>|M|V|1 +|01|IMSI|<<gsup-ie-imsi>>|M|TLV|2-10 +|=== + +=== Information Elements + +[[gsup-ie-msgtype]] +==== Message Type + +[options="header",cols="10%,90%"] +|=== +|Type|Description +|0x04|Update Location Request +|0x05|Update Location Error +|0x06|Update Location Result +|0x08|Send Auth Info Request +|0x09|Send Auth Info Error +|0x0a|Send Auth Info Result +|0x0c|Purge MS Request +|0x0d|Purge MS Error +|0x0e|Purge MS Result +|0x10|Insert Subscriber Data Request +|0x11|Insert Subscriber Data Error +|0x12|Insert Subscriber Data Result +|0x14|Delete Subscriber Data Request +|0x15|Delete Subscriber Data Error +|0x16|Delete Subscriber Data Result +|0x1c|Location Cancellation Request +|0x1d|Location Cancellation Error +|0x1e|Location Cancellation Result +|=== + +[[gsup-ie-ipaddr]] +==== IP Address + +The value part is encoded like in the Packet data protocol address IE defined +in 3GPP TS 04.08, Chapter 10.5.6.4. PDP type organization must be set to +'IETF allocated address'. + +[[gsup-ie-pdpinfo]] +==== PDP Info + +This is a container for information elements describing a single PDP. + +[options="header",cols="5%,20%,45%,10%,10%,10%"] +|=== +|IEI|IE|Type|Presence|Format|Length +| |PDP Info IEI|<<gsup-iei>>|M|V|1 +| |Length of PDP Info IE||M|V|1 +|10|PDP Context ID|<<gsup-ie-pdpctxid>>|C|TLV|3 +|11|PDP Type|<<gsup-ie-pdptype>>|C|TLV|4 +|12|Access Point Name|3GPP TS 04.08, Ch. 10.5.6.1|C|TLV|3-102 +|13|Quality of Service|<<gsup-ie-qos>>|O|TLV|1-20 +|=== + +The conditional IE are mandantory unless mentioned otherwise. + +[[gsup-ie-pdptype]] +==== PDP Type + +The PDP type value consists of 2 octets that are encoded like octet 4-5 of the +End User Address defined in 3GPP TS 09.60, 7.9.18. + +[packetdiag] +---- +{ + colwidth = 8 + node_height = 24 + + 0-6: PDP type IEI + 7: Res + 8-15: Length (2) + 16-19: Spare + 20-23: PDP type org + 24-31: PDP type number +} +---- + +The spare bits are left undefined. While 09.60 defines them as '1 1 1 1', there +are MAP traces where these bits are set to '0 0 0 0'. So the receiver shall +ignore these bits. + +Examples: + +* IPv4: PDP type org: 1 (IETF), PDP type number: 0x21 +* IPv6: PDP type org: 1 (IETF), PDP type number: 0x57 + +[[gsup-ie-pdpctxid]] +==== PDP Context ID + +The PDP type context ID IE consists of a single integer byte wrapped in +a TLV. + +[packetdiag] +---- +{ + colwidth = 8 + node_height = 24 + + 0-6: PDP context ID IEI + 7: Res + 8-15: Length (1) + 16-23: PDP Context ID +} +---- + +[[gsup-ie-authtuple]] +==== Auth tuple + +This is a container for information elements describing a single authentication +tuple. + +[options="header",cols="5%,20%,45%,10%,10%,10%"] +|=== +|IEI|IE|Type|Presence|Format|Length +| |Auth Tuple IEI|<<gsup-iei>>|M|V|1 +| |Length of Auth Tuple IE||M|V|1 +|20|RAND|<<gsup-ie-rand>>|M|TLV|18 +|21|SRES|<<gsup-ie-sres>>|M|TLV|6 +|22|Kc|<<gsup-ie-kc>>|M|TLV|10 +|=== + +[[gsup-ie-rand]] +==== RAND + +The 16-byte Random Challenge of the GSM Authentication Algorithm. + +[[gsup-ie-sres]] +==== SRES + +The 4-byte Authentication Result of the GSM Authentication Algorithm. + +[[gsup-ie-kc]] +==== Kc + +The 8-byte Encryption Key of the GSM Authentication and Key Agreemnt +Algorithm. + +[[gsup-ie-canctype]] +==== Cancellation Type + +[packetdiag] +---- +{ + colwidth = 8 + node_height = 24 + + 0-6: PDP type IEI + 7: Res + 8-15: Length (1) + 16-23: Canc. Type Nr. +} +---- + +.Cancellation Type Number +[options="header",cols="10%,90%"] +|=== +|Number|Description +|0x00|Update Procedure +|0x01|Subscription Withdrawn +|=== + +[[gsup-iei]] +==== IE Identifier (informational) + +These are the standard values for the IEI. See the message definitions for the +IEI that shall be used for the encoding. + +.GSUP IE Identifiers +[options="header",cols="15%,35%,50%"] +|=== +|IEI|Info Element|Type / Encoding +|0x01|IMSI|Mobile Identity, 3GPP TS 04.08 Ch. 10.5.1.4 +|0x02|Cause|<<gsup-ie-cause>> +|0x03|Auth Tuple|<<gsup-ie-authtuple>> +|0x04|PDP Info Compl|<<gsup-ie-empty>> +|0x05|PDP Info|<<gsup-ie-pdpinfo>> +|0x06|Cancel Type|<<gsup-ie-canctype>> +|0x07|Freeze P-TMSI|<<gsup-ie-empty>> +|0x08|MSISDN|ISDN-AddressString/octet, <<gsup-ie-msisdn>> +|0x09|HLR Number|<<gsup-ie-hlr>> +|0x10|PDP Context ID|<<gsup-ie-pdpctxid>> +|0x11|PDP Type|<<gsup-ie-pdptype>> +|0x12|QoS|<<gsup-ie-qos>> +|0x20|RAND|<<gsup-ie-rand>> +|0x21|SRES|<<gsup-ie-sres>> +|0x22|Kc|<<gsup-ie-kc>> +|=== + +[[gsup-ie-empty]] +==== Empty field + +This is used for flags, if and only if this IE is present, the flag is set. +The semantics depend on the IEI and the context. + +[packetdiag] +---- +{ + colwidth = 8 + node_height = 24 + + 0-6: PDP type IEI + 7: Res + 8-15: Length (0) +} +---- + +[[gsup-ie-imsi]] +==== IMSI + +The IMSI is encoded like in octet 4-N of the Called Party BCD Number +defined in 3GPP TS 04.08, 10.5.4.7. + +[packetdiag] +---- +{ + colwidth = 8 + node_height = 24 + + 0-6: PDP type IEI + 7: Res + 8-15: Length of IE content + 16-19: Digit 1 + 20-23: Digit 2 + 24-27: Digit ... + 28-31: Digit N + 32-39: see Note +} +---- + +NOTE: Either '1 1 1 1 | Number digit N' (N odd) or 'Number digit N | +Number digit N-1' (N even), where N is the number of digits. + +[[gsup-ie-msisdn]] +==== ISDN-AddressString / MSISDN / Called Party BCD Number + +The MSISDN is encoded as an ISDN-AddressString in 3GPP TS 09.02 and Called Party +BCD Number in 3GPP TS 04.08. It will be stored by the SGSN and then passed as is +to the GGSN during the activation of the primary PDP Context. + +[packetdiag] +---- +{ + colwidth = 8 + node_height = 24 + + 0-6: PDP type IEI + 7: Res + 8-15: Length of IE content + 16-19: NPI + 20-22: TON + 23: ext + 24-27: Digit 1 + 28-31: Digit 2 + 32-35: Digit ... + 36-39: Digit N +} +---- + +[[gsup-ie-qos]] +==== Quality of Service Subscribed Service + +This encodes the subscribed QoS of a subscriber. It will be used by the +SGSN during the PDP Context activation. If the length of the QoS data +is 3 (three) octets it is assumed that these are octets 3-5 of the TS +3GPP TS 24.008 Quality of Service Octets. If it is more than three then +then it is assumed that the first octet is the Allocation/Retention +Priority and the reset are encoded as octets 3-N of 24.008. + +[packetdiag] +---- +{ + colwidth = 8 + node_height = 24 + + 0-6: PDP type IEI + 7: Res + 8-15: Length of IE content + 16-23: Payload +} +---- + +[[gsup-ie-hlr]] +==== HLR Number encoded as 3GPP TS 09.02 ISDN-AddressString + +The HLR Number is encoded as an ISDN-AddressString in 3GPP TS 09.02. It +will be stored by the SGSN can be used by the CDR module to keep a +record. + +[packetdiag] +---- +{ + colwidth = 8 + node_height = 24 + + 0-6: PDP type IEI + 7: Res + 8-15: Length of IE content + 16-19: NPI + 20-22: TON + 23: ext + 24-27: Digit 1 + 28-31: Digit 2 + 32-35: Digit ... + 36-39: Digit N +} +---- + +[[gsup-ie-cause]] +==== Cause + +This IE shall be encoded according to the 'GMM Cause' as described in +Chapter 10.5.5.14 of 3GPP TS 04.08. diff --git a/doc/manuals/chapters/overview.adoc b/doc/manuals/chapters/overview.adoc new file mode 100644 index 000000000..566124a3a --- /dev/null +++ b/doc/manuals/chapters/overview.adoc @@ -0,0 +1,126 @@ +[[chapter_introduction]] +== Overview + +[[intro_overview]] +=== About OsmoSGSN + +OsmoSGSN is the Osmocom implementation of the GPRS SGSN (Serving Gprs +Support Node) element inside the GPRS network. The SGSN plays a similar +central function to the GPRS network as the MSC plays in the GSM +network. + +The SGSN is connected on the downlink side to Gb interfaces of the BSS, +specifically the PCU inside the BSS. The SGSN is further connected by +the GTP protocol to the GGSN which terminates the tunnels towards the +external packet data network (e.g. IPv4). + +OsmoSGSN supports both a PCU that is co-located with(in) the BTS, as +well as a PCU that is co-located with(in) the BSC. In combination with +OsmoNITB/OsmoBSC/OsmoBTS, the PCU is co-located within the BTS. + +[[fig-gprs-pcubts]] +.GPRS network architecture with PCU in BTS +[graphviz] +---- +digraph G { + rankdir=LR; + MS0 [label="MS"] + MS1 [label="MS"] + MS0->BTS [label="Um"] + MS1->BTS [label="Um"] + BTS->BSC [label="Abis"] + BSC->MSC [label="A"] + BTS->PCU [label="pcu_sock"] + PCU->SGSN [label="Gb"] + SGSN->GGSN [label="GTP"] +} +---- + +=== Software Components + +OsmoNITB contains a variety of different software components, which +we'll quickly describe in this section. + +==== Gb Implementation + +OsmoSGSN implements the ETSI/3GPP specified Gb interface, including TS +08.16 (NS), TS 08.18 (BSSGP) and TS 08.64 (LLC) protocols. As transport +layers for NS, it supports NS/IP (NS encapsulated in UDP/IP), as well as +NS/FR/GRE/IP. The latter is provided in order to use a Router with +Ethernet and Frame Relay interface to convert to actual physical Frame +Relay medium, which is not directly supported by OsmoSGSN. + +The actual Gb Implementation is part of the libosmogb library, which is +in turn part of the libosmocore software package. This allows the same +Gb implementation to be used from osmo-pcu, osmo-gbproxy as well as +OsmoSGSN. + + +==== GTP Implementation + +OsmoSGSN uses the libgtp implementation originating from OpenGGSN. It +supports both GTPv0 and GTPv1. + + +==== GMM Implementation + +The GPRS Mobility Management implementation is quite simplistic at this +point. It supports the GPRS ATTACH and GPRS ROUTING AREA UPDATE +procedures, as well as GPRS ATTACH and GPRS DETACH. + +However, as the SGSN currently does not implement any type of HLR +access, it is not able to authenticate a subscriber or even check if the +subscriber exists at all. As such, all non-roaming subscribes are +allowed to attach to OsmoSGSN. Non-roaming means that the first 5 +digits of the IMSI must match the MCC and MNC of the cell that the +subscriber is registering to. + + +==== LLC Implementation + +The LLC (Logical Link Control) implementation of OsmoSGSN only supports +non-acknowledged mode, as this is the most common use case in real-world +GPRS networks. + +Furthermore, it does not support IP header nor payload compression at +this point. Addition of those features is subject to customer demand or +user/customer contributions. + +The LLC implementation does support LLC encryption. However, as no HLR +access is implemented yet, there is no way to enable/configure +per-subscriber specific keys. + + +==== Session Management Implementation + +The session management procedures ACTIVATE PDP CONTEXT and DEACTIVATE +PDP CONTEXT are supported. However, no MODIFY PDP CONTEXT and no +Network-initiated PDP context activation is possible. This is again +covering the predominant use cases and configurations in GPRS real-world +networks while skipping the more esoteric features. + +Multiple PDP contexts can be attached by a single MS. + +Currently, all PDP contexts are routed to the same GGSN, irrespective of +the APN used/configured in the MS. This is sufficient (and actually +desirable) for small autonomous networks, but of course not suitable for +real networks in roaming scenarios. Please contact sysmocom in case you +require additional features such as DNS-based APN resolving. + +=== Limitations + +At the time of writing, OsmoSGSN still has a number of limitations, +which are a result of the demand-driven Open Source development model. +If you require any of those features, please consider implementing and +contributing them, or contracting the existing OsmoSGSN developers for +performing that work. + +Known Limitations include: + +* No LLC encryption support +* No interface to the OsmoNITB HLR +* No paging coordination between SGSN and MSC +* No SMS over Ps support +* No IuPS interface for 3G (in progress) +* No IP header compression +* No payload compression diff --git a/doc/manuals/chapters/running.adoc b/doc/manuals/chapters/running.adoc new file mode 100644 index 000000000..d758b28d6 --- /dev/null +++ b/doc/manuals/chapters/running.adoc @@ -0,0 +1,35 @@ +== Running OsmoSGSN + +The OsmoSGSN executable (`osmo-sgsn`) offers the following command-line +options: + + +=== SYNOPSIS + +*osmo-sgsn* [-h|-V] [-d 'DBGMASK'] [-D] [-c 'CONFIGFILE'] [-s] [-e 'LOGLEVEL'] + + +=== OPTIONS + +*-h, --help*:: + Print a short help message about the supported options +*-V, --version*:: + Print the compile-time version number of the OsmoBTS program +*-d, --debug 'DBGMASK','DBGLEVELS'*:: + Set the log subsystems and levels for logging to stderr. This + has mostly been superseded by VTY-based logging configuration, + see <<logging>> for further information. +*-D, --daemonize*:: + Fork the process as a daemon into background. +*-c, --config-file 'CONFIGFILE'*:: + Specify the file and path name of the configuration file to be + used. If none is specified, use `osmo_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. diff --git a/doc/manuals/osmosgsn-usermanual-docinfo.xml b/doc/manuals/osmosgsn-usermanual-docinfo.xml new file mode 100644 index 000000000..6c3759244 --- /dev/null +++ b/doc/manuals/osmosgsn-usermanual-docinfo.xml @@ -0,0 +1,48 @@ +<revhistory> + <revision> + <revnumber>1</revnumber> + <date>January 13, 2013</date> + <authorinitials>HW</authorinitials> + <revremark> + Initial version. + </revremark> + </revision> + <revision> + <revnumber>2</revnumber> + <date>February 2016</date> + <authorinitials>HW</authorinitials> + <revremark> + Conversion to asciidoc, removal of sysmoBTS specific parts. + </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-2016</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> +</legalnotice> diff --git a/doc/manuals/osmosgsn-usermanual.adoc b/doc/manuals/osmosgsn-usermanual.adoc new file mode 100644 index 000000000..d532a31d2 --- /dev/null +++ b/doc/manuals/osmosgsn-usermanual.adoc @@ -0,0 +1,32 @@ +OsmoSGSN User Manual +==================== +Harald Welte <hwelte@sysmocom.de> + + +include::../common/chapters/preface.adoc[] + +include::chapters/overview.adoc[] + +include::chapters/running.adoc[] + +include::../common/chapters/vty.adoc[] + +include::../common/chapters/logging.adoc[] + +include::chapters/configuration.adoc[] + +include::../common/chapters/gb.adoc[] + +include::../common/chapters/control_if.adoc[] + +include::../common/chapters/oap.adoc[] + +include::chapters/gsup.adoc[] + +include::../common/chapters/port_numbers.adoc[] + +include::../common/chapters/bibliography.adoc[] + +include::../common/chapters/glossary.adoc[] + +include::../common/chapters/gfdl.adoc[] diff --git a/doc/manuals/osmosgsn-vty-reference.xml b/doc/manuals/osmosgsn-vty-reference.xml new file mode 100644 index 000000000..995e92a30 --- /dev/null +++ b/doc/manuals/osmosgsn-vty-reference.xml @@ -0,0 +1,44 @@ +<?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 V5.0//EN" +"http://www.docbook.org/xml/5.0/dtd/docbook.dtd" [ +<!ENTITY chapter-vty SYSTEM "../common/chapters/vty.xml" > +<!ENTITY sections-vty SYSTEM "generated/docbook_vty.xml" > +]> + +<book> + <info> + <revhistory> + <revision> + <revnumber>v1</revnumber> + <date>13th January 2013</date> + <authorinitials>hw</authorinitials> + <revremark>Initial</revremark> + </revision> + <revision> + <revnumber>v2</revnumber> + <date>5th March 2014</date> + <authorinitials>hf</authorinitials> + <revremark>Update to match osmo-bsc version 0.13.0-305</revremark> + </revision> + </revhistory> + + <title>OsmoSGSN VTY Reference</title> + + <copyright> + <year>2013-2014</year> + </copyright> + + <legalnotice> + <para>This work is copyright by <orgname>sysmocom - s.f.m.c. GmbH</orgname>. All rights reserved. + </para> + </legalnotice> + </info> + + <!-- Main chapters--> + &chapter-vty; +</book> + diff --git a/doc/manuals/vty/sgsn_vty_additions.xml b/doc/manuals/vty/sgsn_vty_additions.xml new file mode 100644 index 000000000..c9de19aa9 --- /dev/null +++ b/doc/manuals/vty/sgsn_vty_additions.xml @@ -0,0 +1,113 @@ +<vtydoc xmlns='urn:osmocom:xml:libosmocore:vty:doc:1.0'> + <node id='21'> + <child_of nodeid='4' /> + <name>SGSN Configuration Node</name> + <description>Configure the remote GGSN, access-control and other + attributes of the SGSN</description> + <command id='gtp local-ip A.B.C.D'> + <description> + Configure the local IP address to which the SGSN should + bind for the Gp interface (towards the GGSNs). + + Please note that in case you would like to run the GGSN + on the same machine as the SGSN, you can not run both on + the same IP address. It is suggested to use 127.0.0.1 + for the SGSN and 127.0.0.2 for the GGSN in such + situations. + </description> + </command> + <command id='ggsn <0-255> remote-ip A.B.C.D'> + <description> + Configure a static GGSN with a given numeric identifier + to use the specified remote IP address. + </description> + </command> + <command id='ggsn <0-255> gtp-version (0|1)'> + <description> + Configure whether to use GTPv0 or GTPv1 towards the + specified GSSN number. + </description> + </command> + <command id='ggsn dynamic'> + <description> + Enable dynamic resolving of GGSNs based on DNS resolving + the APN name like in a GRX-style setup. Changing this + setting requires a re-start of the SGSN. + </description> + </command> + <command id='grx-dns-add A.B.C.D'> + <description> + Use the specified IP address for DNS-resolving the AP + names to GGSN IP addresses + </description> + </command> + <command id='apn APNAME ggsn <0-255>'> + <description> + Map the given APN Name to the given GGSN number. + </description> + </command> + <command id='apn APNAME imsi-prefx IMSIPRE ggsn <0-255>'> + <description> + Map the given APN Name to the given GGSN number _only_ + if the IMSI matches the given prefix. + </description> + </command> + <command id='imsi-acl (add|del) IMSI'> + <description> + Add or delete the given IMSI to/from the global Access + Control List. + </description> + </command> + <command id='auth-policy (accept-all|closed|acl-only|remote)'> + <description> + Configure the Authorization policy of the SGSN. This + setting determines which subscribers are permitted to + register to the network. + </description> + </command> + <command id='gsup remote-ip A.B.C.D'> + <description> + Set the IP address of the HLR (gateway) for the GSUP protocol. + This setting only applies if auth-policy remote is used. + </description> + </command> + <command id='gsup oap-id <0-65535>'> + <description> + Set the OAP client ID for authentication on the GSUP + protocol. + This setting only applies if auth-policy remote is used. + </description> + </command> + <command id='gsup oap-k K'> + <description> + Set the OAP shared secret key K for authentication on + the GSUP protocol. + This setting only applies if auth-policy remote is used. + </description> + </command> + <command id='gsup oap-opc OPC'> + <description> + Set the OAP shared secret OPC for authentication on the + GSUP protocol. + This setting only applies if auth-policy remote is used. + </description> + </command> + <command id='access-point-name NAME'> + <description> + Globally allow the given APN name for all subscribers. + </description> + </command> + <command id='cdr filename NAME'> + <description> + Set the file name for the call-data-record file, + logging the data usage of each subscriber. + </description> + </command> + <command id='cdr interval <1-2147483647>'> + <description> + Set the interval (in secodnds) for the call-data-record + file. + </description> + </command> + </node> +</vtydoc> diff --git a/doc/manuals/vty/sgsn_vty_reference.xml b/doc/manuals/vty/sgsn_vty_reference.xml new file mode 100644 index 000000000..15a423785 --- /dev/null +++ b/doc/manuals/vty/sgsn_vty_reference.xml @@ -0,0 +1,1355 @@ +<vtydoc xmlns='urn:osmocom:xml:libosmocore:vty:doc:1.0'>
+ <node id='0'>
+ </node>
+ <node id='1'>
+ <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='list'>
+ <params>
+ <param name='list' doc='Print command list' />
+ </params>
+ </command>
+ <command id='exit'>
+ <params>
+ <param name='exit' doc='Exit current mode and down to previous mode' />
+ </params>
+ </command>
+ <command id='help'>
+ <params>
+ <param name='help' doc='Description of the interactive help system' />
+ </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='echo .MESSAGE'>
+ <params>
+ <param name='echo' doc='Echo a message back to the vty' />
+ <param name='.MESSAGE' doc='The message to echo' />
+ </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 log message to this terminal' />
+ <param name='enable' doc='Enables logging to this vty' />
+ </params>
+ </command>
+ <command id='logging disable'>
+ <params>
+ <param name='logging' doc='Configure log message to this terminal' />
+ <param name='disable' doc='Disables logging to this vty' />
+ </params>
+ </command>
+ <command id='logging filter all (0|1)'>
+ <params>
+ <param name='logging' doc='Configure log message to this terminal' />
+ <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 log message to this terminal' />
+ <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 log message to this terminal' />
+ <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 set-log-mask MASK'>
+ <params>
+ <param name='logging' doc='Configure log message to this terminal' />
+ <param name='set-log-mask' doc='Set the logmask of this logging target' />
+ <param name='MASK' doc='The logmask to use' />
+ </params>
+ </command>
+ <command id='logging set log mask MASK'>
+ <params>
+ <param name='logging' doc='Configure log message to this terminal' />
+ <param name='set' doc='Decide which categories to output.' />
+ <param name='log' doc='Log commands' />
+ <param name='mask' doc='Mask commands' />
+ <param name='MASK' doc='The logmask to use' />
+ </params>
+ </command>
+ <command id='logging level (all|mm|pag|meas|ref|gprs|ns|bssgp|llc|sndcp|lglobal|llapd|linp|lmux|lmi|lmib|lsms) (everything|debug|info|notice|error|fatal)'>
+ <params>
+ <param name='logging' doc='Configure log message to this terminal' />
+ <param name='level' doc='Set the log level for a specified category' />
+ <param name='all' doc='Global setting for all subsystems' />
+ <param name='mm' doc='Layer3 Mobility Management (MM)' />
+ <param name='pag' doc='Paging Subsystem' />
+ <param name='meas' doc='Radio Measurement Processing' />
+ <param name='ref' doc='Reference Counting' />
+ <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='llc' doc='GPRS Logical Link Control Protocol (LLC)' />
+ <param name='sndcp' doc='GPRS Sub-Network Dependent Control Protocol (SNDCP)' />
+ <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='everything' doc='Log simply everything' />
+ <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 noticable 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='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 sgsn'>
+ <params>
+ <param name='show' doc='Show running system information' />
+ <param name='sgsn' doc='Display information about the SGSN' />
+ </params>
+ </command>
+ <command id='show mm-context imsi IMSI [pdp]'>
+ <params>
+ <param name='show' doc='Show running system information' />
+ <param name='mm-context' doc='MM Context' />
+ <param name='imsi' doc='Identify by IMSI' />
+ <param name='IMSI' doc='IMSI of the MM Context' />
+ <param name='[pdp]' doc='Include PDP Context Information' />
+ </params>
+ </command>
+ <command id='show mm-context all [pdp]'>
+ <params>
+ <param name='show' doc='Show running system information' />
+ <param name='mm-context' doc='MM Context' />
+ <param name='all' doc='All MM Contexts' />
+ <param name='[pdp]' doc='Include PDP Context Information' />
+ </params>
+ </command>
+ <command id='show pdp-context all'>
+ <params>
+ <param name='show' doc='Show running system information' />
+ <param name='pdp-context' doc='Display information on PDP Context' />
+ <param name='all' doc='Show everything' />
+ </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 (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 log message to this terminal' />
+ <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='show bssgp'>
+ <params>
+ <param name='show' doc='Show running system information' />
+ <param name='bssgp' doc='Show information about the BSSGP protocol' />
+ </params>
+ </command>
+ <command id='show bssgp stats'>
+ <params>
+ <param name='show' doc='Show running system information' />
+ <param name='bssgp' doc='Show information about the BSSGP protocol' />
+ <param name='stats' doc='Include statistics' />
+ </params>
+ </command>
+ <command id='show bssgp nsei <0-65535> [stats]'>
+ <params>
+ <param name='show' doc='Show running system information' />
+ <param name='bssgp' doc='Show information about the BSSGP protocol' />
+ <param name='nsei' doc='Show all BVCs on one NSE' />
+ <param name='<0-65535>' doc='The NSEI' />
+ <param name='[stats]' doc='Include Statistics' />
+ </params>
+ </command>
+ <command id='logging filter bvc nsei <0-65535> bvci <0-65535>'>
+ <params>
+ <param name='logging' doc='Configure log message to this terminal' />
+ <param name='filter' doc='Filter log messages' />
+ <param name='bvc' doc='Filter based on BSSGP Virtual Connection' />
+ <param name='nsei' doc='NSEI of the BVC to be filtered' />
+ <param name='<0-65535>' doc='Network Service Entity Identifier (NSEI)' />
+ <param name='bvci' doc='BVCI of the BVC to be filtered' />
+ <param name='<0-65535>' doc='BSSGP Virtual Connection Identifier (BVCI)' />
+ </params>
+ </command>
+ <command id='show llc'>
+ <params>
+ <param name='show' doc='Show running system information' />
+ <param name='llc' doc='Display information about the LLC protocol' />
+ </params>
+ </command>
+ <command id='show sndcp'>
+ <params>
+ <param name='show' doc='Show running system information' />
+ <param name='sndcp' doc='Display information about the SNDCP protocol' />
+ </params>
+ </command>
+ </node>
+ <node id='2'>
+ </node>
+ <node id='3'>
+ <command id='help'>
+ <params>
+ <param name='help' doc='Description of the interactive help system' />
+ </params>
+ </command>
+ <command id='list'>
+ <params>
+ <param name='list' doc='Print command list' />
+ </params>
+ </command>
+ <command id='write terminal'>
+ <params>
+ <param name='write' doc='Write running configuration to memory, network, or terminal' />
+ <param name='terminal' doc='Write to terminal' />
+ </params>
+ </command>
+ <command id='write file'>
+ <params>
+ <param name='write' doc='Write running configuration to memory, network, or terminal' />
+ <param name='file' doc='Write to configuration file' />
+ </params>
+ </command>
+ <command id='write memory'>
+ <params>
+ <param name='write' doc='Write running configuration to memory, network, or terminal' />
+ <param name='memory' doc='Write configuration to the file (same as write file)' />
+ </params>
+ </command>
+ <command id='write'>
+ <params>
+ <param name='write' doc='Write running configuration to memory, network, or terminal' />
+ </params>
+ </command>
+ <command id='show running-config'>
+ <params>
+ <param name='show' doc='Show running system information' />
+ <param name='running-config' doc='running configuration' />
+ </params>
+ </command>
+ <command id='exit'>
+ <params>
+ <param name='exit' doc='Exit current mode and down to previous mode' />
+ </params>
+ </command>
+ <command id='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='echo .MESSAGE'>
+ <params>
+ <param name='echo' doc='Echo a message back to the vty' />
+ <param name='.MESSAGE' doc='The message to echo' />
+ </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 log message to this terminal' />
+ <param name='enable' doc='Enables logging to this vty' />
+ </params>
+ </command>
+ <command id='logging disable'>
+ <params>
+ <param name='logging' doc='Configure log message to this terminal' />
+ <param name='disable' doc='Disables logging to this vty' />
+ </params>
+ </command>
+ <command id='logging filter all (0|1)'>
+ <params>
+ <param name='logging' doc='Configure log message to this terminal' />
+ <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 log message to this terminal' />
+ <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 log message to this terminal' />
+ <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 set-log-mask MASK'>
+ <params>
+ <param name='logging' doc='Configure log message to this terminal' />
+ <param name='set-log-mask' doc='Set the logmask of this logging target' />
+ <param name='MASK' doc='The logmask to use' />
+ </params>
+ </command>
+ <command id='logging set log mask MASK'>
+ <params>
+ <param name='logging' doc='Configure log message to this terminal' />
+ <param name='set' doc='Decide which categories to output.' />
+ <param name='log' doc='Log commands' />
+ <param name='mask' doc='Mask commands' />
+ <param name='MASK' doc='The logmask to use' />
+ </params>
+ </command>
+ <command id='logging level (all|mm|pag|meas|ref|gprs|ns|bssgp|llc|sndcp|lglobal|llapd|linp|lmux|lmi|lmib|lsms) (everything|debug|info|notice|error|fatal)'>
+ <params>
+ <param name='logging' doc='Configure log message to this terminal' />
+ <param name='level' doc='Set the log level for a specified category' />
+ <param name='all' doc='Global setting for all subsystems' />
+ <param name='mm' doc='Layer3 Mobility Management (MM)' />
+ <param name='pag' doc='Paging Subsystem' />
+ <param name='meas' doc='Radio Measurement Processing' />
+ <param name='ref' doc='Reference Counting' />
+ <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='llc' doc='GPRS Logical Link Control Protocol (LLC)' />
+ <param name='sndcp' doc='GPRS Sub-Network Dependent Control Protocol (SNDCP)' />
+ <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='everything' doc='Log simply everything' />
+ <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 noticable 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='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 sgsn'>
+ <params>
+ <param name='show' doc='Show running system information' />
+ <param name='sgsn' doc='Display information about the SGSN' />
+ </params>
+ </command>
+ <command id='show mm-context imsi IMSI [pdp]'>
+ <params>
+ <param name='show' doc='Show running system information' />
+ <param name='mm-context' doc='MM Context' />
+ <param name='imsi' doc='Identify by IMSI' />
+ <param name='IMSI' doc='IMSI of the MM Context' />
+ <param name='[pdp]' doc='Include PDP Context Information' />
+ </params>
+ </command>
+ <command id='show mm-context all [pdp]'>
+ <params>
+ <param name='show' doc='Show running system information' />
+ <param name='mm-context' doc='MM Context' />
+ <param name='all' doc='All MM Contexts' />
+ <param name='[pdp]' doc='Include PDP Context Information' />
+ </params>
+ </command>
+ <command id='show pdp-context all'>
+ <params>
+ <param name='show' doc='Show running system information' />
+ <param name='pdp-context' doc='Display information on PDP Context' />
+ <param name='all' doc='Show everything' />
+ </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 (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 log message to this terminal' />
+ <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>
+ <command id='show bssgp'>
+ <params>
+ <param name='show' doc='Show running system information' />
+ <param name='bssgp' doc='Show information about the BSSGP protocol' />
+ </params>
+ </command>
+ <command id='show bssgp stats'>
+ <params>
+ <param name='show' doc='Show running system information' />
+ <param name='bssgp' doc='Show information about the BSSGP protocol' />
+ <param name='stats' doc='Include statistics' />
+ </params>
+ </command>
+ <command id='show bssgp nsei <0-65535> [stats]'>
+ <params>
+ <param name='show' doc='Show running system information' />
+ <param name='bssgp' doc='Show information about the BSSGP protocol' />
+ <param name='nsei' doc='Show all BVCs on one NSE' />
+ <param name='<0-65535>' doc='The NSEI' />
+ <param name='[stats]' doc='Include Statistics' />
+ </params>
+ </command>
+ <command id='logging filter bvc nsei <0-65535> bvci <0-65535>'>
+ <params>
+ <param name='logging' doc='Configure log message to this terminal' />
+ <param name='filter' doc='Filter log messages' />
+ <param name='bvc' doc='Filter based on BSSGP Virtual Connection' />
+ <param name='nsei' doc='NSEI of the BVC to be filtered' />
+ <param name='<0-65535>' doc='Network Service Entity Identifier (NSEI)' />
+ <param name='bvci' doc='BVCI of the BVC to be filtered' />
+ <param name='<0-65535>' doc='BSSGP Virtual Connection Identifier (BVCI)' />
+ </params>
+ </command>
+ <command id='show llc'>
+ <params>
+ <param name='show' doc='Show running system information' />
+ <param name='llc' doc='Display information about the LLC protocol' />
+ </params>
+ </command>
+ <command id='show sndcp'>
+ <params>
+ <param name='show' doc='Show running system information' />
+ <param name='sndcp' doc='Display information about the SNDCP protocol' />
+ </params>
+ </command>
+ </node>
+ <node id='4'>
+ <command id='help'>
+ <params>
+ <param name='help' doc='Description of the interactive help system' />
+ </params>
+ </command>
+ <command id='list'>
+ <params>
+ <param name='list' doc='Print command list' />
+ </params>
+ </command>
+ <command id='write terminal'>
+ <params>
+ <param name='write' doc='Write running configuration to memory, network, or terminal' />
+ <param name='terminal' doc='Write to terminal' />
+ </params>
+ </command>
+ <command id='write file'>
+ <params>
+ <param name='write' doc='Write running configuration to memory, network, or terminal' />
+ <param name='file' doc='Write to configuration file' />
+ </params>
+ </command>
+ <command id='write memory'>
+ <params>
+ <param name='write' doc='Write running configuration to memory, network, or terminal' />
+ <param name='memory' doc='Write configuration to the file (same as write file)' />
+ </params>
+ </command>
+ <command id='write'>
+ <params>
+ <param name='write' doc='Write running configuration to memory, network, or terminal' />
+ </params>
+ </command>
+ <command id='show running-config'>
+ <params>
+ <param name='show' doc='Show running system information' />
+ <param name='running-config' doc='running configuration' />
+ </params>
+ </command>
+ <command id='exit'>
+ <params>
+ <param name='exit' doc='Exit current mode and down to previous mode' />
+ </params>
+ </command>
+ <command id='end'>
+ <params>
+ <param name='end' doc='End current mode and change to enable mode.' />
+ </params>
+ </command>
+ <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='sgsn'>
+ <params>
+ <param name='sgsn' doc='Configure the SGSN' />
+ </params>
+ </command>
+ <command id='ns'>
+ <params>
+ <param name='ns' doc='Configure the GPRS Network Service' />
+ </params>
+ </command>
+ <command id='bssgp'>
+ <params>
+ <param name='bssgp' doc='Configure the GPRS BSS Gateway Protocol' />
+ </params>
+ </command>
+ </node>
+ <node id='7'>
+ <command id='help'>
+ <params>
+ <param name='help' doc='Description of the interactive help system' />
+ </params>
+ </command>
+ <command id='list'>
+ <params>
+ <param name='list' doc='Print command list' />
+ </params>
+ </command>
+ <command id='write terminal'>
+ <params>
+ <param name='write' doc='Write running configuration to memory, network, or terminal' />
+ <param name='terminal' doc='Write to terminal' />
+ </params>
+ </command>
+ <command id='write file'>
+ <params>
+ <param name='write' doc='Write running configuration to memory, network, or terminal' />
+ <param name='file' doc='Write to configuration file' />
+ </params>
+ </command>
+ <command id='write memory'>
+ <params>
+ <param name='write' doc='Write running configuration to memory, network, or terminal' />
+ <param name='memory' doc='Write configuration to the file (same as write file)' />
+ </params>
+ </command>
+ <command id='write'>
+ <params>
+ <param name='write' doc='Write running configuration to memory, network, or terminal' />
+ </params>
+ </command>
+ <command id='show running-config'>
+ <params>
+ <param name='show' doc='Show running system information' />
+ <param name='running-config' doc='running configuration' />
+ </params>
+ </command>
+ <command id='exit'>
+ <params>
+ <param name='exit' doc='Exit current mode and down to previous mode' />
+ </params>
+ </command>
+ <command id='end'>
+ <params>
+ <param name='end' doc='End current mode and change to enable mode.' />
+ </params>
+ </command>
+ <command id='logging filter all (0|1)'>
+ <params>
+ <param name='logging' doc='Configure log message to this terminal' />
+ <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 log message to this terminal' />
+ <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 log message to this terminal' />
+ <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 level (all|mm|pag|meas|ref|gprs|ns|bssgp|llc|sndcp|lglobal|llapd|linp|lmux|lmi|lmib|lsms) (everything|debug|info|notice|error|fatal)'>
+ <params>
+ <param name='logging' doc='Configure log message to this terminal' />
+ <param name='level' doc='Set the log level for a specified category' />
+ <param name='all' doc='Global setting for all subsystems' />
+ <param name='mm' doc='Layer3 Mobility Management (MM)' />
+ <param name='pag' doc='Paging Subsystem' />
+ <param name='meas' doc='Radio Measurement Processing' />
+ <param name='ref' doc='Reference Counting' />
+ <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='llc' doc='GPRS Logical Link Control Protocol (LLC)' />
+ <param name='sndcp' doc='GPRS Sub-Network Dependent Control Protocol (SNDCP)' />
+ <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='everything' doc='Log simply everything' />
+ <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 noticable 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 filter nsvc (nsei|nsvci) <0-65535>'>
+ <params>
+ <param name='logging' doc='Configure log message to this terminal' />
+ <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='logging filter bvc nsei <0-65535> bvci <0-65535>'>
+ <params>
+ <param name='logging' doc='Configure log message to this terminal' />
+ <param name='filter' doc='Filter log messages' />
+ <param name='bvc' doc='Filter based on BSSGP Virtual Connection' />
+ <param name='nsei' doc='NSEI of the BVC to be filtered' />
+ <param name='<0-65535>' doc='Network Service Entity Identifier (NSEI)' />
+ <param name='bvci' doc='BVCI of the BVC to be filtered' />
+ <param name='<0-65535>' doc='BSSGP Virtual Connection Identifier (BVCI)' />
+ </params>
+ </command>
+ </node>
+ <node id='8'>
+ <command id='help'>
+ <params>
+ <param name='help' doc='Description of the interactive help system' />
+ </params>
+ </command>
+ <command id='list'>
+ <params>
+ <param name='list' doc='Print command list' />
+ </params>
+ </command>
+ <command id='write terminal'>
+ <params>
+ <param name='write' doc='Write running configuration to memory, network, or terminal' />
+ <param name='terminal' doc='Write to terminal' />
+ </params>
+ </command>
+ <command id='write file'>
+ <params>
+ <param name='write' doc='Write running configuration to memory, network, or terminal' />
+ <param name='file' doc='Write to configuration file' />
+ </params>
+ </command>
+ <command id='write memory'>
+ <params>
+ <param name='write' doc='Write running configuration to memory, network, or terminal' />
+ <param name='memory' doc='Write configuration to the file (same as write file)' />
+ </params>
+ </command>
+ <command id='write'>
+ <params>
+ <param name='write' doc='Write running configuration to memory, network, or terminal' />
+ </params>
+ </command>
+ <command id='show running-config'>
+ <params>
+ <param name='show' doc='Show running system information' />
+ <param name='running-config' doc='running configuration' />
+ </params>
+ </command>
+ <command id='exit'>
+ <params>
+ <param name='exit' doc='Exit current mode and down to previous mode' />
+ </params>
+ </command>
+ <command id='end'>
+ <params>
+ <param name='end' doc='End current mode and change to enable mode.' />
+ </params>
+ </command>
+ <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>
+ </node>
+ <node id='11'>
+ <command id='help'>
+ <params>
+ <param name='help' doc='Description of the interactive help system' />
+ </params>
+ </command>
+ <command id='list'>
+ <params>
+ <param name='list' doc='Print command list' />
+ </params>
+ </command>
+ <command id='write terminal'>
+ <params>
+ <param name='write' doc='Write running configuration to memory, network, or terminal' />
+ <param name='terminal' doc='Write to terminal' />
+ </params>
+ </command>
+ <command id='write file'>
+ <params>
+ <param name='write' doc='Write running configuration to memory, network, or terminal' />
+ <param name='file' doc='Write to configuration file' />
+ </params>
+ </command>
+ <command id='write memory'>
+ <params>
+ <param name='write' doc='Write running configuration to memory, network, or terminal' />
+ <param name='memory' doc='Write configuration to the file (same as write file)' />
+ </params>
+ </command>
+ <command id='write'>
+ <params>
+ <param name='write' doc='Write running configuration to memory, network, or terminal' />
+ </params>
+ </command>
+ <command id='show running-config'>
+ <params>
+ <param name='show' doc='Show running system information' />
+ <param name='running-config' doc='running configuration' />
+ </params>
+ </command>
+ <command id='exit'>
+ <params>
+ <param name='exit' doc='Exit current mode and down to previous mode' />
+ </params>
+ </command>
+ <command id='end'>
+ <params>
+ <param name='end' doc='End current mode and change to enable mode.' />
+ </params>
+ </command>
+ <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) <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='<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='12'>
+ <command id='help'>
+ <params>
+ <param name='help' doc='Description of the interactive help system' />
+ </params>
+ </command>
+ <command id='list'>
+ <params>
+ <param name='list' doc='Print command list' />
+ </params>
+ </command>
+ <command id='write terminal'>
+ <params>
+ <param name='write' doc='Write running configuration to memory, network, or terminal' />
+ <param name='terminal' doc='Write to terminal' />
+ </params>
+ </command>
+ <command id='write file'>
+ <params>
+ <param name='write' doc='Write running configuration to memory, network, or terminal' />
+ <param name='file' doc='Write to configuration file' />
+ </params>
+ </command>
+ <command id='write memory'>
+ <params>
+ <param name='write' doc='Write running configuration to memory, network, or terminal' />
+ <param name='memory' doc='Write configuration to the file (same as write file)' />
+ </params>
+ </command>
+ <command id='write'>
+ <params>
+ <param name='write' doc='Write running configuration to memory, network, or terminal' />
+ </params>
+ </command>
+ <command id='show running-config'>
+ <params>
+ <param name='show' doc='Show running system information' />
+ <param name='running-config' doc='running configuration' />
+ </params>
+ </command>
+ <command id='exit'>
+ <params>
+ <param name='exit' doc='Exit current mode and down to previous mode' />
+ </params>
+ </command>
+ <command id='end'>
+ <params>
+ <param name='end' doc='End current mode and change to enable mode.' />
+ </params>
+ </command>
+ </node>
+ <node id='21'>
+ <command id='help'>
+ <params>
+ <param name='help' doc='Description of the interactive help system' />
+ </params>
+ </command>
+ <command id='list'>
+ <params>
+ <param name='list' doc='Print command list' />
+ </params>
+ </command>
+ <command id='write terminal'>
+ <params>
+ <param name='write' doc='Write running configuration to memory, network, or terminal' />
+ <param name='terminal' doc='Write to terminal' />
+ </params>
+ </command>
+ <command id='write file'>
+ <params>
+ <param name='write' doc='Write running configuration to memory, network, or terminal' />
+ <param name='file' doc='Write to configuration file' />
+ </params>
+ </command>
+ <command id='write memory'>
+ <params>
+ <param name='write' doc='Write running configuration to memory, network, or terminal' />
+ <param name='memory' doc='Write configuration to the file (same as write file)' />
+ </params>
+ </command>
+ <command id='write'>
+ <params>
+ <param name='write' doc='Write running configuration to memory, network, or terminal' />
+ </params>
+ </command>
+ <command id='show running-config'>
+ <params>
+ <param name='show' doc='Show running system information' />
+ <param name='running-config' doc='running configuration' />
+ </params>
+ </command>
+ <command id='exit'>
+ <params>
+ <param name='exit' doc='Exit current mode and down to previous mode' />
+ </params>
+ </command>
+ <command id='end'>
+ <params>
+ <param name='end' doc='End current mode and change to enable mode.' />
+ </params>
+ </command>
+ <command id='gtp local-ip A.B.C.D'>
+ <params>
+ <param name='gtp' doc='GTP Parameters' />
+ <param name='local-ip' doc='Set the IP address for the local GTP bind' />
+ <param name='A.B.C.D' doc='IPv4 Address' />
+ </params>
+ </command>
+ <command id='ggsn <0-255> remote-ip A.B.C.D'>
+ <params>
+ <param name='ggsn' doc='Configure the GGSN information' />
+ <param name='<0-255>' doc='GGSN Number' />
+ <param name='remote-ip' doc='IP information' />
+ <param name='A.B.C.D' doc='IPv4 Address' />
+ </params>
+ </command>
+ <command id='ggsn <0-255> gtp-version (0|1)'>
+ <params>
+ <param name='ggsn' doc='Configure the GGSN information' />
+ <param name='<0-255>' doc='GGSN Number' />
+ <param name='gtp-version' doc='GTP Version' />
+ <param name='0' doc='Version 0' />
+ <param name='1' doc='Version 1' />
+ </params>
+ </command>
+ <command id='imsi-acl (add|del) IMSI'>
+ <params>
+ <param name='imsi-acl' doc='Access Control List of foreign IMSIs' />
+ <param name='add' doc='Add IMSI to ACL' />
+ <param name='del' doc='Remove IMSI from ACL' />
+ <param name='IMSI' doc='IMSI of subscriber' />
+ </params>
+ </command>
+ <command id='auth-policy (accept-all|closed)'>
+ <params>
+ <param name='auth-policy' doc='Autorization Policy of SGSN' />
+ <param name='accept-all' doc='Accept all IMSIs (DANGEROUS' />
+ <param name='closed' doc='Accept only home network subscribers or those in ACL' />
+ </params>
+ </command>
+ </node>
+</vtydoc>
\ No newline at end of file |