13.5. GTP Command Reference

This command creates a text description stored in the configuration file for a configuration context.

The description command associates a text string with a configuration context to help identify the context in the configuration file.

The no form of this command removes any description string from the context.

This command enables the context to configure subscriber management entities. A subscriber is uniquely identified by a subscriber identification string. Each subscriber can have several DHCP sessions active at any time. Each session is referred to as a subscriber host and is identified by its IP address and MAC address.

All subscriber hosts belonging to the same subscriber are subject to the same hierarchical QoS (HQoS) processing. The HQoS processing is defined in the sub-profile (the subscriber profile). A sub-profile refers to an existing scheduler policy (configured in the config>qos>scheduler-policy context) and offers the possibility to overrule the rate of individual schedulers within this policy.

Because all subscriber hosts use the same scheduler policy instance, they must all reside on the same complex.

This command enables the context to configure GTP parameters for the routing context.

This command enables GTP configuration related to S11 termination in this VRF.

This command activates GTP termination on the specified interface.

The no form of this command disables GTP termination on the specified interface, if there are no active sessions associated with the interface.

This command configures an Access Point Name (APN) policy for the S11 interface.

The no form of this command removes the APN policy.

This command configures a mapping of addresses and subnets to GTP peer profiles.

This command configures a mapping of an IP address or subnet to a peer profile. If one peer profile is used for the entire router, it is possible to map the entire IPv4 subnet using 0.0.0.0/0.

If no match is found, the default or default S11 peer profile is used.

The no form of this command removes the peer profile mapping, affecting only the setup of new peers.

This command enables GTP configuration related to a GTP uplink using the Gn, S2a, or S2b interface.

This command configures the Network Identifier part of the APN.

The no form of this command removes the string from the configuration.

This command configures the PDP type to be signaled in GTP, determining which addresses are requested from the P-GW/GGSN and which hosts are set up afterwards. This can be overridden by RADIUS. If the ipv4v6 keyword is used, the P-GW/GGSN can fall back to either IPv4 or IPv6.

The no form of this command reverts to the default configuration.

This command enables the context to configure box-wide GTP parameters and profiles.

This command configures an APN policy that defines parameters to be used when setting up a new incoming GTP connection. Each APN can be mapped to its own set of parameters.

The no form of this command removes the policy from the system. A policy can only be removed if it is not in use.

This command configures the parameters that should be applied to incoming connections with the APN specified. Multiple APN nodes can be defined per APN policy.

For each APN-policy, one unknown APN entry can be created. This APN is used by all connections not matching another APN.

The no form of this command removes the APN from the policy. Only new sessions are affected by the removal.

Mapping of an incoming APN-AMBR to SR OS QoS overrides.

When enabled, the downlink rate in the APN-AMBR IE in an incoming GTP message is interpreted as a rate override for the specified egress QoS object. For queues and policers, the PIR is overridden.

This override uses standard SR OS QoS overrides. Therefore, a subsequent Gx/RADIUS-based override removes this override.

The no form of this command disables the override mechanism.

When enabled, the uplink rate in the APN-AMBR IE in an incoming GTP message is interpreted as a rate override for the specified ingress QoS object. For queues and policers, the PIR is overridden.

This override uses standard SR OS QoS overrides. Therefore, a subsequent Gx/RADIUS-based override removes this override.

The no form of this command disables the override mechanism.

This command enables the context to configure default parameters for the GTP connection that can be used when the parameters are not returned in authentication.

This command configures the default group interface where the hosts of the GTP connection is enabled. The group interface must be of type gtp.

The no form of this command removes the default group interface. In this case, a group interface must be specified using authentication.

This command configures the Diameter authentication policy with which the GTP connection is authenticated.

The no form of this command removes the authentication policy. Only new session setups are affected.

This command configures the RADIUS authentication policy with which the GTP connection is authenticated.

The no form of this command removes the authentication policy. Only new session setups are affected.

This command enables the ability to skip IPv4 address assignment using a GTP session setup response when PCO "allocation via NAS" is not present in a GTP session creation request. Without this configuration, IPv4 address allocation is done using GTP session setup response, even in absence of the PCO "allocation via NAS" in a GTP session setup request.

The no form of this command reverts to IPv4 address allocation using GTP.

This command configures the LUDB with which the GTP connection is authenticated.

The no form of this command removes the user database for authentication with this APN. Only new session setups are affected.

This command configures the maximum number of GTP sessions to be held while their UE is disconnected.

The no form of this command reverts to the default.

This command creates a new peer profile.

This command specifies the value of the change reporting action IE sends to the peer in applicable messages. The peer needs to indicate support first using the appropriate flag in the indication IE.

This is overridden by AAA, if AAA explicitly request notification changes for either ECGI, TAI or both. If AAA does not request any notification changes or only the generic location change, the configured value is used.

The no form of this command indicates that the IE is not sent, unless specified by AAA.

This command enables the context to configure charging characteristics.

This command configures the charging characteristics for home UE.

This command configures the charging characteristics for roaming UE.

The no form of this command removes the bit value from the configuration.

This command specifies the number of end marker packets that are sent when it is certain no more packets will be sent over the corresponding GTP-U tunnel, such as after a completed mobility event.

The no form of this command reverts the value to the default.

This command enables the context to configure communication with a GGSN Mobile Gateway.

This command enables the context to configure QoS for a GGSN Mobile Gateway.

This command configures parameters specific to a Mobility Management Entity (MME) peer.

This command configures the Aggregated Maximum Bit Rate (AMBR) to be sent in the APN AMBR IE. The contents of this IE can be overridden by RADIUS or report-rate mechanisms. If those mechanisms specify a partial value, such as only specifying the down-link parameter, the other value is picked up from the ambr configuration.

For GTPv1, the no form of this command implies that the IE will not be sent. If a partial value is received from another source, the missing value will use the following defaults:

For GTPv2, the no form of this command reverts to the default of 10000 kb/s up-link and 20000 kb/s down-link.

The command configures the allocation and retention priority to be used in the GTP messages as QoS IE (for a Gn interface) or Bearer QoS (for GTPv2).

The no form of this command reverts to the default.

This command configures the down-link bitrate in kb/s to be used in the GTP messages.

The no form of this command reverts to the default.

This command configures the up-link bitrate in kb/s to be used in the GTP messages.

The no form of this command reverts to the default.

This command enables the context to configure communication with a Packet Data Network Gateway.

This command configures the QoS Class Identifier (QCI) to send in the Bearer Level QoS IE in GTPv2 messages.

The no form of this command reverts to the default.

This command specifies the interface applicable for communications to the peer. If the interface type does not match the given context in an uplink context, the peer setup will fail.

The no form of this command reverts to the default value.

This command configures the value to put in the IP header’s TTL field for GTP control messages.

The no form of this command reverts to the default value.

This command configures the value of the IPv4-MTU PCO sent in S11 GTP messages. This is the MTU a device should honor when sending data toward the SGW/PGW. For IPv6, this value is signaled in the RA message and which can be configured in the grp-if> ipv6>rtr-adv>mtu context.

The no form of this command resets the signaled IPv4 MTU to the default.

This command configures Echo-Request messages.

The no form of this command reverts to the default values.

This command configures the retry-count and response-timeout for GTP messages.

The no form of this command reverts to the default values.

This command configures the Information Element to use for the Protocol Configuration Options.

The no form of this command reverts to the default value.

This command specifies the Python policy for MGW profile packets sent/received on the group interface.

The no form of this command removes the policy name from the configuration.

This command configures the default Radio Access Type (RAT) signaled during GTP setup. RAT is the underlying physical connection method for a radio-based communication network. This can be overridden by RADIUS.

The no form of this command reverts to the default value.

This command enables reporting the WLAN location or cellular location of the UE in the signaling interface (S2a or Gn) between the WLAN GW and the mobile gateway (PGW or GGSN).

The no form of this command disables location reporting.

This command configures, in seconds, the time that a GTP session context is held after the corresponding UE is disconnected. If the same UE re-connects to this system before this time has elapsed, its GTP session context is re-used. When the timer expires, the GTP session context is cleared.

The no form of this command reverts to the default.

This command configures the Operator Identifier part (MCC and MNC) of the APN.

The no form of this command removes the values from the profile.

This command displays operational information related to GTP usage in the specified routing context.

This command displays GTP peer information.

This command displays the peer profile mapping that is used to connect to S11 peers.

This command displays operational information related to the usage of GTP uplink interfaces (Gn, S2a, S2b) in this routing context.

This command displays router operational GTP information.

This command displays GTP peer profile information.

This command displays information related to established S11 connections. Specific sessions can be selected based on IMSI, APN, or MME.

This command displays GTP statistics information.

This command displays a GTP system summary of information.

This command displays box-wide operational information related to the GTP uplink interfaces (Gn, S2a, S2b).

This command enables the context to clear GTP information in this routing context.

This command clears all states for a given peer in this routing context. The system no longer sends keep-alive messages to the peer, and all active sessions are terminated.

If the optional statistics parameter is specified, only the peer statistics are cleared and all sessions remain.

This command clears information related to the GTP uplink state for the routing context.

This command clears the DNS resolution cache for all APNs known in this router. After execution, every APN to address mapping is learned again using DNS.

This command clears box-wide GTP state information.

This command clears all GTP sessions matching the specified criteria. Associated objects, such as the ESM subscriber in a GTP uplink scenario are also removed.

This command clears all box-wide GTP statistics.

This command enables the context to configure debugging for GTP.

This command configures detailed debugging of all events in the GTP system.

The no form of this command disables event debugging.

This command restricts debugging to only data related to the specified IMSI. This command can be repeated multiple times, where only data for any of the specified IMSIs is debugged.

The no form of this command removes the filter for the specified IMSI. If the last IMSI filter is removed, all data is debugged again, but may be restricted by other filters.

This command enables debugging of GTP packets sent or received by the system’s control plane.

The no form of this command disables debugging of GTP packets.

This command restricts debugging to only data related to the specified GTP peer. This command can be repeated multiple times, where only data for any of the specified peers is debugged.

The no form of this command removes the restriction for the specified peer. When the last peer filter is removed, all data is debugged again, but may be restricted by other filters.