12.4. GTP Command Reference

12.4.1. Command Hierarchies

12.4.1.1. GTP Commands

config
max-held-sessions [sessions]
mgw-profile profile-name [create]
— no mgw-profile profile-name
home bit [bit...(up to 16 max)]
— no home
roaming bit [bit...(up to 16 max)]
— no roaming
description description-string
ggsn
qos
ambr down-link kbps up-link kbps
— no ambr
arp arp-value
— no arp
down-link gbr rate mbr rate
— no down-link
up-link gbr rate mbr rate
— no up-link
pgw
qos
ambr down-link kbps up-link kbps
— no ambr
arp arp-value
— no arp
down-link gbr rate mbr rate
— no down-link
qci qci-value
— no qci
up-link gbr rate mbr rate
— no up-link
interface-type {gn | s2a | s2b}
ip-ttl hops
— no ip-ttl
keep-alive [interval seconds] [retry-count value] [timeout retry-seconds]
— no keep-alive
message-retransmit [timeout timeout] [retry-count value]
python-policy name
rat-type {utran | geran | wlan | gan | hspa | eutran | virtual | id}
— no rat-type
session-hold-time remaining-lease-time
session-hold-time seconds
serving-network mcc mcc-value mnc mnc-value
configure
— router
apn apn
— no apn
address ip-prefix[/prefix-length] [mgw-profile profile-name]
— no address ip-prefix[/prefix-length]
pdn-type {ipv4 | ipv6 | ipv4v6}
— no pdn-type

12.4.1.2. GTP Service Commands

configure
— service
— vprn service-id/ies service-id
apn apn
— no apn
address ip-prefix[/prefix-length] [mgw-profile profile-name]
— no address ip-prefix[/prefix-length]
pdn-type {ipv4 | ipv6 | ipv4v6}
— no pdn-type

12.4.1.3. GTP Show Commands

show
gtp-session imsi imsi apn apn-string
gtp-session [mgw-address ip-address] [mgw-router router-instance] [remote-control-teid teid] [local-control-teid teid] [detail]
gtp-session imsi imsi

12.4.2. GTP Command Descriptions

12.4.2.1. GTP Commands

12.4.2.1.1. Generic Commands

description

Syntax 
description description-string
no description
Context 
config>subscr-mgmt>wlan-gw>mgw-profile
Description 

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.

Default 

no description

Parameters 
description-string—
A text string describing the entity. Allowed values are any string up to 80 characters long composed of printable, 7-bit ASCII characters excluding double quotes. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed within double quotes.

subscriber-mgmt

Syntax 
subscriber-mgmt
Context 
config
Description 

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.

Default 

n/a

12.4.2.1.2. GTP Commands

wlan-gw

Syntax 
wlan-gw
Context 
config>subscriber-mgmt
config>router
config>service>vprn
Description 

This command enables the context to configure WLAN Gateway parameters.

max-held-sessions

Syntax 
max-held-sessions [sessions]
no max-held-sessions
Context 
config>subscr-mgmt>wlan-gw
Description 

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

The no form of the command reverts to the default.

Default 

max-held-sessions 2000

Parameters 
sessions—
Specifies the maximum number of GTP sessions
Values—
0 to 262144

 

mgw-profile

Syntax 
mgw-profile profile-name [create]
no mgw-profile profile-name
Context 
config>subscr-mgmt>wlan-gw
Description 

This command creates a new mobile gateway profile or configures an existing mobile gateway profile.

Mobile gateway profile is used to configure signaling interface between WLAN-GW and mobile gateway (PGW or GGSN) and GTP related signaling parameters per mobile gateway.

The no form of the command removes the profile name from the configuration.

Default 

n/a

Parameters 
profile-name—
Specifies the Mobile Gateway profile up to 32 characters in length
create—
Keyword used to create a profile name. The create keyword requirement can be enabled/disabled in the environment>create context.

charging-characteristics

Syntax 
charging-characteristics
Context 
config>subscr-mgmt>wlan-gw>mgw-profile
Description 

This command enables the context to configure charging characteristics.

Default 

none

home

Syntax 
home bit [bit ... (up to 16 max)]
no home
Context 
config>subscr-mgmt>wlan-gw>mgw-profile>charging
Description 

This command configures the charging characteristics for home UE.

Default 

no home

Parameters 
bit—
Specifies the bits to set in the Charging Characteristics Information Element (IE) for home UE, if not known by other means such as RADIUS.

roaming

Syntax 
roaming bit [bit ... (up to 16 max)]
no roaming
Context 
config>subscr-mgmt>wlan-gw>mgw-profile>charging
Description 

This command configures the charging characteristics for roaming UE.

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

Default 

no roaming

Parameters 
bit—
Specifies the bits to set in the Charging Characteristics Information Element (IE) for roaming UE, if not known by other means such as RADIUS

ggsn

Syntax 
ggsn
Context 
config>subscr-mgmt>wlan-gw>mgw-profile
Description 

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

Default 

n/a

qos

Syntax 
qos
Context 
config>subscr-mgmt>wlan-gw>mgw-profile>ggsn
Description 

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

Default 

n/a

ambr

Syntax 
ambr down-link kbps up-link kbps
no ambr
Context 
config>subscr-mgmt>wlan-gw>mgw-profile>ggsn>qos
Description 

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 the 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:

  1. 10000 kbps up-link
  2. 20000 kbps down-link

For GTPv2, the no form of the command reverts to the default of 10000 kbps up-link and 20000 kbps down-link.

Default 

no ambr

Parameters 
down-link kbps
Specifies the downlink Aggregated Maximum Bit Rate (AMBR)
Values—
0 to 10000000

 

up-link kbps
Specifies the uplink AMBR
Values—
0 to 10000000

 

arp

Syntax 
arp arp-value
no arp
Context 
config>subscr-mgmt>wlan-gw>mgw-profile>ggsn>qos
config>subscr-mgmt>wlan-gw>mgw-profile>pgw>qos
Description 

The command configures the allocation/retention priority to be used in the GTP messages as QOS IE (for a Gn interface) or Bearer QOS (for an S2a/S2b interface).

The no form of the command reverts to the default.

Default 

1

Parameters 
arp-value—
Specifies the Allocation/Retention Priority (ARP)
Values—
1 to 3

 

down-link

Syntax 
down-link gbr rate mbr rate
no down-link
Context 
config>subscr-mgmt>wlan-gw>mgw-profile>ggsn>qos
config>subscr-mgmt>wlan-gw>mgw-profile>pgw>qos
Description 

This command configures the down-link bitrate in Kbps to be used in the GTP messages.

The no form of the command reverts to the default.

Default 

down-link gbr 2000 mbr 2000

up-link

Syntax 
up-link gbr rate mbr rate
no up-link
Context 
config>subscr-mgmt>wlan-gw>mgw-profile>ggsn>qos
config>subscr-mgmt>wlan-gw>mgw-profile>pgw>qos
Description 

This command configures the up-link bitrate in Kbps to be used in the GTP messages.

The no form of the command reverts to the default.

Default 

up-link gbr 5000 mbr 5000

Parameters 
gbr rate
Specifies the uplink Guaranteed Bit Rate (GBR) to be used in the GTP messages as QOS IE (for a Gn interface) or Bearer QOS (for an S2a/S2b interface)
mbr rate
Specifies the uplink Maximum Bit Rate (MBR) to be used in the GTP messages as QOS IE (for a Gn interface) or Bearer QOS (for an S2a/S2b interface)

pgw

Syntax 
pgw
Context 
config>subscr-mgmt>wlan-gw>mgw-profile
Description 

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

Default 

none

qci

Syntax 
qci qci-value
no qci
Context 
config>subscr-mgmt>wlan-gw>mgw-profile>pgw>qos
Description 

This command configures the QoS Class Identifier (QCI) to send in the Bearer Level QoS IE in GTP messages on the S2a/S2b interface.

The no form of the command reverts to the default.

Default 

8

Parameters 
qci-value—
Specifies the QCI value to send
Values—
0 to 9

 

interface-type

Syntax 
interface-type {gn | s2a | s2b}
no interface-type
Context 
config>subscriber-mgmt>wlan-gw >mgw-profile
Description 

This command specifies the signaling interface between the WLAN-GW and the mobile gateway (PGW or GGSN).

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

Default 

s2a

Parameters 
gn—
Signaling interface between the WLAN-GW and the mobile gateway is Gn as specified in 3GPP TS 29.060
S2a—
Signaling interface between the WLAN-GW and the mobile gateway is S2a as specified in SAMOG
S2b—
Signaling interface between the WLAN-GW and the mobile gateway is S2b as specified in 3GPP TS 29.274

ip-ttl

Syntax 
ip-ttl hops
no ip-ttl
Context 
config>subscr-mgmt>wlan-gw>mgw-profile
Description 

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

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

Default 

255

Parameters 
hops—
Specifies the IP TTL
Values—
1 to 255

 

keep-alive

Syntax 
keep-alive [interval seconds] [retry-count value] [timeout retry-seconds]
no keep-alive
Context 
config>subscr-mgmt>wlan-gw>mgw-profile
Description 

This command configures Echo-Request messages.

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

Default 

keep-alive interval 60 retry-count 5 timeout 5

Parameters 
seconds
Specifies, in seconds, the interval between keep-alive Echo-Request messages towards the same peer
Values—
0, 60 to 180

 

Default—
60
value
Specifies, in seconds, the interval between keep-alive Echo-Request messages towards the same peer
Values—
1 to 15

 

Default—
4
retry-seconds
Specifies the retry timeout, in seconds
Values—
1 to 20

 

Default—
5

message-retransmit

Syntax 
message-retransmit [timeout timeout] [retry-count value]
no message-retransmit
Context 
config>subscr-mgmt>wlan-gw>mgw-profile
Description 

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

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

Default 

message-retransmit timeout 5 value 3

Parameters 
timeout—
Specifies the interval, in seconds, between retransmission of signaling request messages towards the same peer Mobile Gateway.
Values—
1 to 30

 

Default—
5
value—
Specifies the number of times a signaling request message is transmitted towards the same peer Mobile Gateway.
Values—
1 to 8

 

Default—
3

protocol-configuration-options

Syntax 
protocol-configuration-options {apco | pco}
no protocol-configuration-options
Context 
config>subscr-mgmt>wlan-gw>mgw-profile
Description 

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

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

Default 

pco

Parameters 
apco—
Specifies that the system uses the Protocol Configuration Options Information Element
pco—
Specifies that the system uses the Additional Protocol Configuration Options Information Element

python-policy

Syntax 
python-policy name
no python-policy
Context 
config>subscr-mgmt>wlan-gw>mgw-profile
Description 

This command specified the python-policy for MGW profile packets sent/received on the group interface

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

Default 

none

Parameters 
name—
Specifies an existing Python policy name up to 32 characters in length

rat-type

Syntax 
rat-type {utran | geran | wlan | gan | hspa | eutran | virtual | id}
no rat-type
Context 
config>subscr-mgmt>wlan-gw>mgw-profile
Description 

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 the command reverts to the default value.

Default 

rat-type wlan

Parameters 
utran—
Specifies the signaled RAT type is UTRAN (1)
geran—
Specifies the signaled RAT type is GERAN (2)
wlan—
Specifies the signaled RAT type is WLAN (3)
gan—
Specifies the signaled RAT type is GAN (4)
hspa—
Specifies the signaled RAT type is HSPA Evolution (5)
eutran—
Specifies the signaled RAT type is EUTRAN (6)
virtual—
Specifies the signaled RAT type is virtual (7)
id—
Specifies the numeric RAT type value
Values—
0 to 255

 

report-wlan-location

Syntax 
[no] report-wlan-location
Context 
config>subscr-mgmt>wlan-gw>mgw-profile
Description 

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

The no form of the command disables location reporting.

Default 

no report-wlan-location

session-hold-time

Syntax 
session-hold-time remaining-lease-time
session-hold-time seconds
no session-hold-time
Context 
config>subscr-mgmt>wlan-gw>mgw-profile
Description 

This command configures , in seconds, the time that a GTP session context is held after the corresponding User Equipment is disconnected. If the same User Equipment 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 the command reverts to the default.

Default 

30

Parameters 
remaining-lease-time—
Specifies that the timer is equal to the User Equipment’s DHCP remaining lease time
seconds—
Specifies the time, in seconds, to hold a GTP session after its UE is disconnected
Values—
0 to 3600

 

serving-network

Syntax 
serving-network mcc mcc-value mnc mnc-value
no serving-network
Context 
config>subscr-mgmt>wlan-gw
config>subscr-mgmt>wlan-gw>gtp
Description 

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

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

Default 

no serving-network

Parameters 
mcc-value—
Specifies the Mobile Country Code (MCC) portion of the Serving Network
Values—
2 digits

 

mnc-value—
Specifies the Mobile Network Code (MNC) portion of the Serving Network
Values—
2 or 3 digits

 

apn

Syntax 
apn apn
no apn
Context 
config>router>wlan-gw
config>service>vprn>wlan-gw
Description 

This command configures the Network Identifier part of the APN.

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

Default 

no apn

Parameters 
apn—
Specifies the Access Point Name (APN) used for this IMSI to connect to this Mobile Gateway up to 80 characters in length

mgw-map

Syntax 
mgw-map ip-prefix [/prefix-length] mgw-profile profile-name
no mgw-map
Context 
config>router>wlan-gw
config>service>vprn>wlan-gw
Description 

This command configures the mappings of MGW IP address and GTP profile.

Default 

no mgw-map

Parameters 
ip-prefix[/prefix-length]
Specifies the IP prefix and prefix length
Values—
ip-prefix a.b.c.d (host bits must be 0)
length 0 to 32

 

profile-name—
Specifies the profile associated with this address prefix
Values—
32 characters max

 

address

Syntax 
address ip-prefix[/prefix-length] [mgw-profile profile-name]
no address ip-prefix[/prefix-length]
Context 
config>router>wlan-gw>mgw-map
config>service>vprn>wlan-gw>mgw-map
Description 

This command specifies the address.

The no form of the command removes the parameters from the configuration.

Default 

no address

Parameters 
ip-prefix[/prefix-length—
Specifies the IP prefix and prefix length of the subnet
Values—
ip-prefix a.b.c.d (host bits must be 0)
length 0 to 32

 

profile-name—
Specifies the Mobile Gateway profile associated with this address prefix up to 32 characters in length

pdn-type

Syntax 
pdn-type {ipv4 | ipv6 | ipv4v6}
no pdn-type
Context 
config>router>wlan-gw
config>service>vprn>wlan-gw
Description 

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 the command reverts to the default configuration.

Default 

ipv4

Parameters 
ipv4—
The GTP connection requests an IPv4 address
ipv6—
The GTP connection requests an IPv6 address
ipv4v6—
The GTP connection requests both an IPv4 and an IPv6 address

12.4.2.1.3. GTP Show Commands

gtp-session

Syntax 
gtp-session imsi imsi apn apn-string
gtp-session [mgw-address ip-address] [mgw-router router-instance][remote-control-teid teid] [local-control-teid teid] [detail]
gtp-session imsi imsi
 
Context 
show>subscr-mgmt>wlan-gw
Description 

This command displays GTP session information.

Parameters 
imsi—
Specifies the International Mobile Subscriber Identity (IMSI) of this UE.
Values—
A string of digits between 9 and 15 long

 

apn-string—
Specifies the access point name (APN) up to 100 characters in length
ip-address—
Specifies of the IP address of the Mobile Gateway, that is the source IP address in the tunnel header of received packets
Values—

ipv4-address: a.b.c.d

ipv6-address: x:x:x:x:x:x:x:x (eight 16-bit pieces)

x:x:x:x:x:x:d.d.d.d

x [0 to FFFF]H

d [0 to 255]D

prefix-length [1 to 128]

 

router-instance—
Specifies the identifier of the virtual router instance where the GTP tunnel is terminated
teid—
Specifies the remote control plane Tunnel Endpoint Identifier (TEID).
Values—
1 to 4294967295

 

detail—
Displays detailed information for the GTP session

gtp-statistics

Syntax 
gtp-statistics
Context 
show>subscr-mgmt>wlan-gw
Description 

This command displays GTP statistics information.