configure mobile-gateway pdn command descriptions

Context

• [Tree] configure mobile-gateway

Description

Commands in this context configure a gateway instance.

Context

• [Tree] configure mobile-gateway pdn

Description

This command configures a generic Packet Data Network (PDN) gateway instance.

The no form of this command removes the gateway instance from the configuration.

Parameters

gw-id

specifies the gateway ID

Values: 1

Context

• [Tree] configure mobile-gateway pdn apn

Description

This command configures an Access Point Name (APN). Each APN represents a service provided by a service provider. APNs can be classified as consumer APNs such as Internet, IMS, and Walled Garden and corporate APNs.

• shutdown the APN
• clear all sessions from the APN
• delete the APN

Parameters

apn-name

Specifies an APN name, up to 80 characters.

unknown

Specifies a reserved APN name that serves unknown APNs.

Context

• [Tree] configure mobile-gateway pdn apn address-assignment-defaults

Description

This command enables the context to configure defaults for the APN when using ODSA as configured under config mobile pdn apn laa.

Context

• [Tree] configure mobile-gateway pdn apn address-assignment-defaults local-dynamic

Description

This command enables the context to configure the default pool for locally assigned IP addresses.

Default

local

Context

• [Tree] configure mobile-gateway pdn apn address-assignment-defaults local-dynamic ipv4-pool

Description

This command specifies the name of a pool to be used for the local address assignment if no address pool is explicitly returned during authentication.

Default

no ipv4-pool

Parameters

pool-name

Specifies the pool name, up to 32 characters.

Context

• [Tree] configure mobile-gateway pdn apn address-assignment-defaults local-dynamic ipv6-na-pool

Description

This command configures the IPV6 NA pool name for AAA or local address assignment if no pool is explicitly returned during session authentication.

The no form of this command removes the configuration.

Default

no ipv6-na-pool

Parameters

pool-name

Specifies the pool name, up to 32 characters.

Context

• [Tree] configure mobile-gateway pdn apn address-assignment-defaults local-dynamic ipv6-pd-pool

Description

This command configures the IPV6 PD pool name for AAA or local address assignment if no pool is explicitly returned during session authentication.

The no form of this command removes the configuration.

Default

no ipv6-pd-pool

Parameters

pool-name

Specifies the pool name, up to 32 characters.

Context

• [Tree] configure mobile-gateway pdn apn address-assignment-defaults local-dynamic ipv6-slaac-pool

Description

This command configures the IPV6 SLAAC pool name for AAA or local address assignment if no pool is explicitly returned during session authentication.

The no form of this command removes the configuration.

Default

no ipv6-slaac-pool

Parameters

pool-name

Specifies the pool name, up to 32 characters.

Context

• [Tree] configure mobile-gateway pdn apn address-assignment-defaults unmanaged

Description

This command enables the context to configure the default pool for AAA assigned IP addresses.

Default

unmanaged

Context

• [Tree] configure mobile-gateway pdn apn address-assignment-defaults unmanaged ipv4-pool

Description

This command specifies the name of a pool to be used for the local address assignment if no address pool is explicitly returned during authentication.

Default

no ipv4-pool

Parameters

pool-name

Specifies the pool name, up to 32 characters.

Context

• [Tree] configure mobile-gateway pdn apn address-assignment-defaults unmanaged ipv6-na-pool

Description

This command configures the IPV6 NA pool name for AAA or local address assignment if no pool is explicitly returned during session authentication.

The no form of this command removes the configuration.

Default

no ipv6-na-pool

Parameters

pool-name

Specifies the pool name, up to 32 characters.

Context

• [Tree] configure mobile-gateway pdn apn address-assignment-defaults unmanaged ipv6-pd-pool

Description

This command configures the IPV6 PD pool name for AAA or local address assignment if no pool is explicitly returned during session authentication.

The no form of this command removes the configuration.

Default

no ipv6-pd-pool

Parameters

pool-name

Specifies the pool name, up to 32 characters.

Context

• [Tree] configure mobile-gateway pdn apn address-assignment-defaults unmanaged ipv6-slaac-pool

Description

This command configures the IPV6 SLAAC pool name for AAA or local address assignment if no pool is explicitly returned during session authentication.

The no form of this command removes the configuration.

Default

no ipv6-slaac-pool

Parameters

pool-name

Specifies the pool name, up to 32 characters.

Context

• [Tree] configure mobile-gateway pdn apn aggr-rate-dl

Description

This command configures the APN aggregate downlink rate.

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

Parameters

aggregate-rate-downlink

specifies the APN aggregate downlink rate in kb/s

Values: 0 to 25000000

Default: 0

Context

• [Tree] configure mobile-gateway pdn apn aggr-rate-ul

Description

This command configures the APN aggregate uplink rate.

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

Parameters

aggregate-rate-uplink

specifies the APN aggregate uplink rate in kb/s

Values: 0 to 25000000

Default: 0

Context

• [Tree] configure mobile-gateway pdn apn description

Description

This command associates a text string with a configuration context to help identify the content in the configuration file.

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

Default

no description

Parameters

description-string

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

Context

• [Tree] configure mobile-gateway pdn apn dhcp-profile

Description

This command configures the DHCP profile for the session.

The no form of this command removes the configuration.

Parameters

name

Specifies the DHCP profile name, up to 32 characters.

Context

• [Tree] configure mobile-gateway pdn apn dhcpv4-server-ip

Description

TBD

Parameters

ip-address

Specifies the ip-address.

Values: a.b.c.d

Context

• [Tree] configure mobile-gateway pdn apn dhcpv6-profile

Description

This command configures the DHCPv6 profile to use for DHCPv6 messages sent in the context of this session. This profile is used if no profile is provided during session authentication.

The no form of this command removes the configuration.

Parameters

profile-name

Specifies the profile name, up to 32 characters.

Context

• [Tree] configure mobile-gateway pdn apn dhcpv6-server-duid

Description

This command configures the value included in the server ID option in DHCPv6 messages.

The no form of this command reverts to the default.

Parameters

hex-string

Specifies the hexadecimal value.

Values: 0x0 to 0xFFFFFFFF...(max 116 hex nibbles)

ascii-string

Specifies the ASCII string, up to 58 characters.

system-name

Specifies to use the system name.

link-local

Specifies to use the BNG link-local address of the session.

Context

• [Tree] configure mobile-gateway pdn apn fixed-wireless-access

Description

Commands in this context configure the FWA functionality.

Context

• [Tree] configure mobile-gateway pdn apn fixed-wireless-access authentication-flow

Description

This command configures the ADB-based authentication flow to set up FWA sessions.

Context

• [Tree] configure mobile-gateway pdn apn fixed-wireless-access authentication-flow adb

Description

This command configures an ordered list of ADBs to authenticate FWA sessions.

The no form of this command removes the configuration.

Default

no adb

Parameters

adb-name

Specifies the session setup time, up to 32 characters.

Context

• [Tree] configure mobile-gateway pdn apn fixed-wireless-access default-ipv4-signaling-method

Description

This command configures whether to signal an allocated IPv4 address to the FWA RG using NAS or DHCP (deferred allocation) messaging. This value is used if no other method is provided during session setup; for example, by the ADB, RADIUS, or PCO.

Default

default-ipv4-signaling-method nas

Parameters

signaling-method

Specifies the method to signal allocated IPv4 addresses.

Values: nas | dhcp

Default: nas

Context

• [Tree] configure mobile-gateway pdn apn fixed-wireless-access shutdown

Description

This command administratively disables the entity. When disabled, an entity does not change, reset, or remove any configuration settings or statistics. Many entities must be explicitly enabled using the no shutdown command.

The operational state of the entity is disabled as well as the operational state of any entities contained within. Many objects must be shut down before they may be deleted.

Context

• [Tree] configure mobile-gateway pdn apn guard-timer

Description

This command enables the configuration of a session setup timer on the PGW. If the session setup is delayed because of no response from the peering nodes for an extended duration (AAA/RADIUS, PCRF, OCS/OFCS), the session state is cleaned up and the response is sent with a failure cause code. This command applies to real APN.

Parameters

guard-timer

specifies the session setup time, in seconds

Values: 4 to 120

Default: 0 (disabled)

Context

• [Tree] configure mobile-gateway pdn apn max-pdn-connections

Description

This command configures the maximum number of PDN connections for this APN on the gateway, and enables or disables alarms to be sent when the maximum PDN connections are reached or configures send alarms and to not accept any new PDN connections when the max-pdn-connections value has been reached. When the configured maximum number is reached, an alarm event is raised at the end of the pulling interval.

The no form of this command disables and removes the maximum connection limit and disables sending alarm even when the max-pdn-connections value is reached.

Parameters

max-pdn-connections

Specifies the maximum number of PDN connections.

Values: 1 to 20000000

Default: 0

alarm

Specifies sending an alarm even when max-pdn-connections has been reached.

Default: alarm

enforce

Specifies sending an alarm and not accept any new PDN connections when max-pdn-connections has been reached.

Context

• [Tree] configure mobile-gateway pdn apn max-session-attach

Description

This command configures the threshold of the maximum number of GTP-based attach requests per second. The limit is applied to the new PDN (GTPv2) and PDP (GTPv1) session attach requests received. By default, the emergency attach requests are excluded from the threshold. When this command is enabled, the alarm keyword specifies to raise an alarm when the maximum number of attaches is reached.

The no form of this command reverts to the default (no limit is applied to the number of attach requests).

Parameters

max-attach-limit

specifies the maximum number of attach requests per second

Values: 0 to 100000

Default: 0

alarm

specifies to raise an alarm when the maximum number of attach requests per second is reached

Default: disabled

include-emergency

specifies to include the emergency attach requests to the threshold

Default: disabled

Context

• [Tree] configure mobile-gateway pdn apn network-realm

Description

This command specifies the network-realm with which address pools used for local address assignment are associated. The network-realm command is configured in the configure mobile-gateway pdn local-address-assignment context.

Parameters

name

specifies the name of the associated network realm, up to 80 characters

Note: Only the following characters are permitted:

• alphabetic characters (A-Z and a-z)
• digits (0-9)
• hyphen (-)
• dot (.)

Context

• [Tree] configure mobile-gateway pdn apn pdn-type

Description

This command specifies the Packet Data Network (PDN) type. The PGW does not support a combination of static and dynamic addressing for PDN type IPv4v6. If the PGW receives a Create Session Request for PDP Type IPv4v6 and:

• there is a single IPv4 address in the PDN Address Allocation (PAA) IE, the PGW accepts and sets the PDN type to IPv4
• there is a single IPv6 address in the PAA IE, the PGW accepts and sets the PDN type to IPv6
• there are both an IPv4 and an IPv6 address in the PAA IE, the PGW accept and leaves the PDN type as IPv4v6

The PGW rejects requests for one static and one dynamic address when using PDN type IPv4v6.

The no form of this command reverts to the default.

Parameters

ipv4

specifies that IPv4 PDN sessions are supported by this APN

ipv6

specifies that IPv6 PDN sessions are supported by this APN

ipv4v6

specifies that IPv4v6 PDN sessions are supported by this APN

non-ip

specifies that non-IP PDN sessions are supported by this APN

Default: ipv4

Context

• [Tree] configure mobile-gateway pdn apn pdn-type-conversion

Description

This command allows the PGW to create a session if the requested PDN type is dual stack, and either IPv4 or IPv6 is blocked on a specific APN and MG group. To perform the session creation, the IP allocation method must be able to allocate a single stack.

The no form of this command signifies that the PDN type fallback is not allowed.

Context

• [Tree] configure mobile-gateway pdn apn pdn-type-preferred-ipv6

Description

This commands forces the use of an IPv6 address for the PDN connection when there is a UE-requested dual stack IPv4v6 address PDN type and the APN supports only IPv4 and IPv6 addresses.

The no form of this command reverts to the default.

Context

• [Tree] configure mobile-gateway pdn apn shutdown

Description

This command administratively disables the entity. When disabled, an entity does not change, reset, or remove any configuration settings or statistics. Many entities must be explicitly enabled using the no shutdown command.

The operational state of the entity is disabled as well as the operational state of any entities contained within. Many objects must be shut down before they may be deleted.

Context

• [Tree] configure mobile-gateway pdn bng

Description

This command enables the context to configure BNG PDN parameters.

Context

• [Tree] configure mobile-gateway pdn bng radius-coa

Description

This command enables the context to configure RADIUS COA parameters for BNG.

Context

• [Tree] configure mobile-gateway pdn bng radius-coa ignore-unknown-attributes

Description

This command enables the system to ignore unknown attributes in RADIUS CoA/DM request messages.

The no form of this command causes the system to fail RADIUS CoA/DM if the request contains unknown attributes.

Context

• [Tree] configure mobile-gateway pdn bng radius-coa interface

Description

This command configures a local interface to use for communication with an external database.

The no form of this command removes the local interface association.

Parameters

router-instance

specifies the router instance, up to 32 characters

interface-name

specifies an interface name, up to 32 characters

Context

• [Tree] configure mobile-gateway pdn bng radius-coa python-policy

Description

This command specifies the Python policy used to modify a RADIUS CoA message sent or received by a RADIUS CoA client.

Parameters

name

Specifies the name of a configured Python policy, up to 32 characters.

Context

• [Tree] configure mobile-gateway pdn bng radius-coa secret

Description

This command specifies the RADIUS shared secret for a CoA/DM message

Parameters

secret

specifies the hash1 key or the hash2 key, up to 64 characters

hash | hash2

specifies if the secret key is entered in an encrypted form. If the hash parameter is not used, the key is assumed to be in a non-encrypted, clear text form. For security, all keys are stored in an encrypted format.

Context

• [Tree] configure mobile-gateway pdn bng up-group

Description

This commands configures a group of BNG-UPs that share a common aggregation network. Sessions can be moved between the BNG-UPs of a UP group; for example, to provide BNG-UP resiliency.

The no form of this command removes the specified UP group.

Default

no up-group

Parameters

name

Specifies the name of the UP group, up to 32 characters.

Context

• [Tree] configure mobile-gateway pdn bng up-group c-tag-range

Description

This command configures the default C-tag range for the UP group. See "BNG-UP resiliency" in the MAG-c Control Plane Function Guide for more information about the use cases for defining a C-tag range.

When a value of 0 is included in the range, sessions without a C-tag are included in the UP group and a per-BNG-UP override of the C-tag range is not possible.

Explicitly configuring a 0 to 4094 range does not make a functional difference. However, if a 0 to 4094 range is configured, a per-BNG-UP override is not allowed. If no range is configured, a per-BNG-UP override is allowed if each configured BNG-UP has an override (there is no default fallback).

The no form of this command removes the configuration.

Default

no c-tag-range

Parameters

from

Specifies the starting C-tag.

Values: 0 to 4094

to

Specifies the ending C-tag, greater than or equal to the starting C-tag.

Values: 0 to 4094

Context

• [Tree] configure mobile-gateway pdn bng up-group description

Description

This command associates a text string with a configuration context to help identify the content in the configuration file.

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

Default

no description

Parameters

description-string

Specifies the description string, up to 80 characters, composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed within double quotes.

Context

• [Tree] configure mobile-gateway pdn bng up-group fsg-profile

Description

configure mobile-gateway profile bng

The no form of this command removes the configuration.

Default

no fsg-profile

Parameters

name

Specifies the FSG profile name, up to 32 characters.

Context

• [Tree] configure mobile-gateway pdn bng up-group l2-access-id

Description

l2-access-id alpha beta

configure mobile-gateway pdn bng up-group up l2-access-id

The no form of this command removes the configuration.

Default

no l2-access-is

Parameters

id [id...(up to 32 max)]

Specifies the Layer 2 access ID, up to 64 characters, as provisioned on the BNG-UP and learned on the MAG-c through IBCP.

Context

• [Tree] configure mobile-gateway pdn bng up-group s-tag-range

Description

This command configures the default S-tag range for the UP group. See "BNG-UP resiliency" in the MAG-c Control Plane Function Guide for more information about the use cases for defining an S-tag range.

When a value of 0 is included in the range, sessions without an S-tag are included in the UP group and a per-BNG-UP override of the S-tag range is not possible.

Explicitly configuring a 0 to 4094 range does not make a functional difference. However, if a 0 to 4094 range is configured, a per-BNG-UP override is not allowed. If no range is configured, a per-BNG-UP override is allowed if each configured BNG-UP has an override (there is no default fallback).

The no form of this command removes the configuration.

Default

no s-tag-range

Parameters

from

Specifies the starting S-tag.

Values: 0 to 4094

to

Specifies the ending S-tag, greater than or equal to the starting S-tag.

Values: 0 to 4094

Context

• [Tree] configure mobile-gateway pdn bng up-group shutdown

Description

This command administratively disables the entity. When disabled, an entity does not change, reset, or remove any configuration settings or statistics.

The operational state of the entity is disabled as well as the operational state of any entities contained within. Most objects must be shut down before they may be deleted.

The no form of this command enables the entity. Most entities must be explicitly enabled using the no form of this command.

Default

shutdown

Context

• [Tree] configure mobile-gateway pdn bng up-group up

Description

This command configures a UP that is part of the UP group.

Parameters

ip-addr

Specifies the IP address, which must match what is signaled in PFCP as a Node ID.

Values:

• IPv4 address – a.b.c.d
• IPv6 address – x:x:x:x:x:x:x:x (eight 16-bit pieces) or x:x:x:x:x:x:d.d.d.d

  where

  x – [0..FFFF]H

  d – [0..255]D

fqdn

Specifies the fully qualified domain name, up to 255 characters, which must match what is signaled in PFCP as a Node ID.

Context

• [Tree] configure mobile-gateway pdn bng up-group up c-tag-range

Description

This command configures the C-tag range which connects the BNG-UP with the shared aggregation. See "BNG-UP resiliency" in the MAG-c Control Plane Function Guide for more information about the use cases for defining a C-tag range.

When a range at the UP group level is configured, the BNG-UP level must have the same size. If the UP group-level range includes the tag with value 0, configuring a range at the BNG-UP level is not allowed.

When no C-tag range is configured, the UP group-level configuration applies.

The no form of this command removes the configuration.

Default

no c-tag-range

Parameters

from

Specifies the starting C-tag.

Values: 1 to 4094

to

Specifies the ending C-tag, greater than or equal to the starting C-tag.

Values: 1 to 4094

Context

• [Tree] configure mobile-gateway pdn bng up-group up drain

Description

This command enables sessions to be drained from the BNG-UP. The MAG-c avoids selecting a BNG-UP in drain mode as the active BNG-UP for an FSG. When enabled, this command forces the internal BNG-UP health to -1 (unavailable). Changing the drain configuration acts as an FSG active/standby reselection trigger.

The no form of this command disables the drain mode and resets the BNG-UP health to the calculated aggregate value.

Default

no drain

Context

• [Tree] configure mobile-gateway pdn bng up-group up l2-access-id

Description

This command configures the Layer 2 access ID that connects the BNG-UP with the shared aggregation.

configure mobile-gateway pdn bng up-group l2-access-id

When no Layer 2 access ID is configured, the UP group level configuration applies.

The no form of this command removes the configuration.

Default

no l2-access-is

Parameters

id

Specifies the Layer 2 access ID, up to 64 characters, as provisioned on the BNG-UP and learned on the MAG-c through IBCP.

Context

• [Tree] configure mobile-gateway pdn bng up-group up preferred

Description

This command configures the BNG-UP as the preferred active BNG-UP. If all BNG-UP healths are equal, the MAG-c prefers this BNG-UP above others when selecting an active BNG-UP. Only one BNG-UP per UP group can be preferred.

The no form of this command removes the configuration.

Default

no preferred

Context

• [Tree] configure mobile-gateway pdn bng up-group up s-tag-range

Description

This command configures the S-tag range that connects the BNG-UP with the shared aggregation. See "BNG-UP resiliency" in the MAG-c Control Plane Function Guide for more information about the use cases for defining an S-tag range.

When a range at the UP group level is configured, the range at the BNG-UP level must have the same size. If the range at the UP group level includes the tag with value 0, a range at the BNG-UP level is not allowed.

When no S-tag range is configured, the UP group level configuration applies.

The no form of this command removes the configuration.

Default

no s-tag-range

Parameters

from

Specifies the starting S-tag.

Values: 1 to 4094

to

Specifies the ending S-tag, greater than or equal to the starting S-tag.

Values: 1 to 4094

Context

• [Tree] configure mobile-gateway pdn bng wpp

Description

Commands in this context configure WPP parameters.

Context

• [Tree] configure mobile-gateway pdn bng wpp interface

Description

TBD

Parameters

service-id

Specifies the service name, up to 64 characters, or the service ID.

Values: 1 to 2148278386 | name

interface-name

Specifies the name of the IP interface, up to 32 characters.

Context

• [Tree] configure mobile-gateway pdn cdbx

Description

This command enables the context to configure cloud database profile parameters.

Context

• [Tree] configure mobile-gateway pdn cdbx cloud-db-profile

Description

This command associates a cloud database profile to use as an interface to an external database.

The no form of this command removes the association.

Parameters

profile-name

Specifies the profile name, up to 32 characters.

Context

• [Tree] configure mobile-gateway pdn cdbx interface

Description

This command configures a local interface to use for communication with an external database.

The no form of this command removes the local interface association.

Parameters

router-instance

specifies the virtual router name or service ID

Values	router-name | service-id
	router-name	Base
	service-id	1 to 2147483647

Default: Base

interface-name

specifies an interface name, up to 32 characters and must start with a letter

Context

• [Tree] configure mobile-gateway pdn cdbx mss

Description

This command configures the MSS size of the packets that the SM-VM forwards to the DB-VM. Nokia recommends increasing the MSS size based on the capabilities of the MTU interface.

Parameters

mss-value

specifies the MSS size

Values: 1460 to 8960

Default: 1460 (disabled)

Context

• [Tree] configure mobile-gateway pdn epc-node

Description

This command configures the EPC node name.

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

Parameters

name

specifies the EPC node name, up to 31 characters

Syntax: <MCC>.<MNC>.<SGW|PGW|ePDG|TWAG>.<Region tring>.<Group Id>.<Node Id>

Context

• [Tree] configure mobile-gateway pdn instance-type

Description

This command configures the PDN instance as a 3GPP Control and User Plane Separation (CUPS) function.

The no form of this command removes the instance from being configured as a CUPS instance.

Parameters

instance-type-value

specifies the function (control or user plane) of the gateway

Values	control	specifies the PDN instance as control plane function
	user	specifies the PDN instance as user plane function

Context

• [Tree] configure mobile-gateway pdn local-address-assignment

Description

This command enables the context to configure local address assignment parameters.

Default

local-address-assignment

Context

• [Tree] configure mobile-gateway pdn local-address-assignment network-realm

Description

This command specifies the network-realm with which address pools used for local address assignment are associated.

Parameters

realm-name

specifies the name of the associated network realm, up to 80 characters

Note: Only the following characters are permitted:

• alphabetic characters (A-Z and a-z)
• digits (0-9)
• hyphen (-)
• dot (.)

Context

• [Tree] configure mobile-gateway pdn local-address-assignment network-realm description

Description

This command associates a text string with a configuration context to help identify the content in the configuration file.

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

Parameters

description-string

Specifies the description string, up to 80 characters, composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed within double quotes.

Context

• [Tree] configure mobile-gateway pdn local-address-assignment network-realm pool

Description

This command configures an address pool associated with the network-realm.

Parameters

name

Specifies the pool name, up to 32 characters.

application

dhcp-relay

Context

• [Tree] configure mobile-gateway pdn local-address-assignment network-realm pool dedicated

Description

This command configures the pool as dedicated. In other words, no micro-nets are carved out from the pool prefix but addresses are directly assigned from the pool.

The no form of this command disables the dedicated mode and allows micronetting over multiple user plane devices.

Context

• [Tree] configure mobile-gateway pdn local-address-assignment network-realm pool description

Description

This command enables 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 content in the configuration file.

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

Parameters

description-string

The description character string; allowed values are any string up to 80 characters long composed of printable, 7-bit ASCII characters; if the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed within double quotes.

Context

• [Tree] configure mobile-gateway pdn local-address-assignment network-realm pool hold-time

Description

This command configures the time for which a lease is held for the subscriber session after it has been released, that is, the address is not re-assigned for this duration.

Parameters

minutes

specifies the hold time, in minutes

Values: 0 to 5

seconds

specifies the hold time, in seconds

Values: 0 to 59

Context

• [Tree] configure mobile-gateway pdn local-address-assignment network-realm pool ipv4

Description

This command enables the context to configure IPv4 parameters for the address pool.

Default

ipv4

Context

• [Tree] configure mobile-gateway pdn local-address-assignment network-realm pool ipv4 default-gateway

Description

This command configures the option to use the first or last address of the micro-net used for address allocation as the default-gateway IPv4 address for the client.

Parameters

choice

specifies the default gateway choice

Values: first-address | last-address

Context

• [Tree] configure mobile-gateway pdn local-address-assignment network-realm pool ipv4 dns

Description

This command enables the context to configure the IPv4 DNS server addresses associated with the pool.

Default

dns

Context

• [Tree] configure mobile-gateway pdn local-address-assignment network-realm pool ipv4 dns primary-dns

Description

This command specifies the primary DNS server IP address associated with the pool.

Parameters

ip-address

specifies the address of the primary DNS for the IPv4 network-realm pool

Values: a.b.c.d

Context

• [Tree] configure mobile-gateway pdn local-address-assignment network-realm pool ipv4 dns secondary-dns

Description

This command specifies the secondary DNS server IP address associated with the pool.

Default

no secondary-dns

Parameters

ip-address

specifies the address of the secondary DNS for the IPv4 network-realm pool

Values: a.b.c.d

Context

• [Tree] configure mobile-gateway pdn local-address-assignment network-realm pool ipv4 micro-net-length

Description

This command specifies the length of IPv4 micro-nets that are used from the pool and assigned on-demand to a specific context (for example, UP) to allocate addresses to subscriber sessions associated with that context.

Default

no micro-net-length

Parameters

length

specifies the micro-net length

Values: 9 to 28

Context

• [Tree] configure mobile-gateway pdn local-address-assignment network-realm pool ipv4 prefix

Description

This command configures the IPv4 prefix from which micro-nets are allocated if the dedicated mode is disabled. Addresses are subsequently allocated from individual micro-nets, or directly from the prefix if dedicated mode is disabled.

Parameters

ip-prefix

specifies the IP address prefix

Values: a.b.c.d, host bits must be 0

length

specifies the IP address length

Values: 9 to 28

Context

• [Tree] configure mobile-gateway pdn local-address-assignment network-realm pool ipv4 prefix drain

Description

This command enables the mode where no new micro-nets are allocated from the prefix and existing leases in the associated micro-nets are cleaned up on renew or rebind.

Context

• [Tree] configure mobile-gateway pdn local-address-assignment network-realm pool ipv4 prefix exclude-addresses

Description

This command specifies a range of IP addresses that are excluded from allocation to subscriber sessions.

Parameters

ip-address

specifies the start of the IP addresses to exclude

Values: a.b.c.d

end ip-address

specifies the end of the IP addresses to exclude

Values: a.b.c.d

Context

• [Tree] configure mobile-gateway pdn local-address-assignment network-realm pool ipv4 subnet-allocation

Description

This command enables the allocation of subnets instead of single /32 addresses.

The no form of this command disables the subnet allocation, that is, only single /32 addresses are allocated from the pool.

Default

no subnet-allocation

Context

• [Tree] configure mobile-gateway pdn local-address-assignment network-realm pool ipv4 subnet-allocation length

Description

This command configures the subnet length.

If a variable subnet allocation is configured (see the variable command in the same context) and no per-session length is provisioned, this command configures the default subnet length. The length must be within the limits configured by the variable command.

If variable subnet allocation is disabled, this command configures the only supported subnet length. Any per-session length provisioning must match this value.

The no form of this command disables the subnet allocation, irrespective of the values for the variable subnet allocation.

Default

no length

Parameters

bits

specifies the length of the subnet to be allocated

Values: 16 to 32

Context

• [Tree] configure mobile-gateway pdn local-address-assignment network-realm pool ipv4 subnet-allocation variable

Description

This command configures the minimum and the maximum length of the subnet to be allocated. The session setup fails if a per-session length is outside these limits.

The length command must be configured within these limits. It defines the default length if no per-session length is provisioned.

The no form of this command disables the variable subnet allocation.

Default

no variable

Parameters

bits

specifies the minimum length of the subnet to be allocated

Values: 16 to 31

maximum bits

specifies the maximum length of the subnet to be allocated

Values: 17 to 32

Context

• [Tree] configure mobile-gateway pdn local-address-assignment network-realm pool ipv6

Description

This command enables the context to configure IPv6 address pools.

Context

• [Tree] configure mobile-gateway pdn local-address-assignment network-realm pool ipv6 dns

Description

This command enables the context to configure the IPv6 DNS server addresses associated with the pool.

Context

• [Tree] configure mobile-gateway pdn local-address-assignment network-realm pool ipv6 dns primary-dns

Description

This command specifies the IP address of the primary IPv6 DNS server associated with the pool.

Parameters

ipv6-address

a unicast IPv6 address, up to 64 characters

Context

• [Tree] configure mobile-gateway pdn local-address-assignment network-realm pool ipv6 dns secondary-dns

Description

This command specifies the IP address of the secondary IPv6 DNS server associated with the pool.

Default

no secondary-dns

Parameters

ipv6-address

a unicast IPv6 address, up to 64 characters

Context

• [Tree] configure mobile-gateway pdn local-address-assignment network-realm pool ipv6 na

Description

This command enables the context to configure NA parameters for the address pool.

Context

• [Tree] configure mobile-gateway pdn local-address-assignment network-realm pool ipv6 na micro-net-length

Description

This command specifies the length of IPv6 NA micro-nets that are used from the pool and assigned on-demand to a specific context (for example, UP) to allocate addresses to subscriber sessions associated with that context.

Parameters

length

specifies the micro-net length

Values: 105 to 124

Context

• [Tree] configure mobile-gateway pdn local-address-assignment network-realm pool ipv6 na prefix

Description

This command configures the IPv6 prefix for the micro-nets if the dedicated mode is disabled. NA addresses are subsequently allocated from the individual micro-nets, or directly from the prefix if the dedicated mode is disabled.

Parameters

ip-address

specifies the IP address prefix, host bits must be zero

prefix-length

specifies the IP address length

Values: 105 to 124

Context

• [Tree] configure mobile-gateway pdn local-address-assignment network-realm pool ipv6 na prefix drain

Description

This command enables the mode that does not allow to allocate new micro-nets or NA addresses from the prefix. Existing allocations are not automatically removed, only when the session is removed.

Default

no drain

Context

• [Tree] configure mobile-gateway pdn local-address-assignment network-realm pool ipv6 na prefix exclude-addresses

Description

This command specifies a range of IPv6 addresses that are excluded from allocation to subscriber sessions.

Parameters

ipv6-address

specifies the start of the IPv6 addresses to exclude, up to 64 characters

end ipv6-address

specifies the end of the IP addresses to exclude, up to 64 characters

Context

• [Tree] configure mobile-gateway pdn local-address-assignment network-realm pool ipv6 pd

Description

This command enables the context to configure IPv6 PD parameters for the address pool.

Context

• [Tree] configure mobile-gateway pdn local-address-assignment network-realm pool ipv6 pd delegated-prefix

Description

This command enables the context to configure IPv6 PD DPL parameters for the address pool.

Context

• [Tree] configure mobile-gateway pdn local-address-assignment network-realm pool ipv6 pd delegated-prefix length

Description

This command specifies the fixed length for the delegated prefixes allocated from the pool.

Parameters

bits

specifies the DPL

Values: 48 to 64

Default: 56

Context

• [Tree] configure mobile-gateway pdn local-address-assignment network-realm pool ipv6 pd delegated-prefix variable

Description

This command enables a variable delegated prefix and specifies the minimum and maximum length for the delegated prefixes allocated from the pool.

Default

no variable

Parameters

bits

specifies the minimum or maximum DPL

Values: 48 to 64

Context

• [Tree] configure mobile-gateway pdn local-address-assignment network-realm pool ipv6 pd micro-net

Description

This command specifies the length of IPv6 PD micro-nets that are used from the pool and assigned on-demand to a specific context (for example, UP) to allocate addresses to subscriber sessions associated with that context. The micro-net length can be fixed or variable. A variable micro-net length is only possible when a variable delegated prefix length is used. In this case, the micro-net length automatically adapts to the delegated prefix length.

Default

no micro-net

Parameters

length

specifies the fixed micro-net length

Values: 37 to 60

min

specifies the minimum micro-net length

Values: 37 to 60

max

specifies the maximum micro-net length

Values: 37 to 60

Context

• [Tree] configure mobile-gateway pdn local-address-assignment network-realm pool ipv6 pd prefix

Description

This command configures the IPv6 prefix for the micro-nets if the dedicated mode is disabled. PD prefixes are subsequently allocated from the individual micro-nets, or directly from the prefix if the dedicated mode is disabled.

Parameters

ip-address

specifies the IP address prefix, host bits must be zero

prefix-length

specifies the prefix length

Values: 37 to 60

Context

• [Tree] configure mobile-gateway pdn local-address-assignment network-realm pool ipv6 pd prefix drain

Description

This command enables the mode that does not allow to allocate new micro-nets or PD addresses from the prefix. Existing allocations are not automatically removed, only when the session is removed.

Default

no drain

Context

• [Tree] configure mobile-gateway pdn local-address-assignment network-realm pool ipv6 pd prefix exclude-prefixes

Description

This command specifies a range of IPv6 prefixes that are excluded from allocation to subscriber sessions.

Parameters

ip-address/prefix-length

specifies the start of the IPv6 prefixes to exclude; the host bits of ip-address must be zero; prefix-length must equal the DPL (see the length command)

end ip-address/prefix-length

specifies the end of the IPv6 prefixes to exclude; the host bits of ip-address must be zero; prefix-length must equal the DPL (see the length command)

Context

• [Tree] configure mobile-gateway pdn local-address-assignment network-realm pool ipv6 slaac

Description

This command enables the context to configure IPv6 SLAAC parameters for the address pool.

Context

• [Tree] configure mobile-gateway pdn local-address-assignment network-realm pool ipv6 slaac micro-net-length

Description

This command specifies the length of IPv6 SLAAC micro-nets that are used from the pool and assigned on-demand to a specific context (for example, UP) to allocate addresses to subscriber sessions associated with that context.

Parameters

length

specifies the micro-net length

Values: 41 to 60

Context

• [Tree] configure mobile-gateway pdn local-address-assignment network-realm pool ipv6 slaac prefix

Description

This command configures the IPv6 prefix for the micro-nets if the dedicated mode is disabled. SLAAC prefixes are subsequently allocated from the individual micro-nets, or directly from the prefix if the dedicated mode is disabled.

Parameters

ip-address

specifies the IP address prefix, host bits must be zero

prefix-length

specifies the prefix length

Values: 41 to 60

Context

• [Tree] configure mobile-gateway pdn local-address-assignment network-realm pool ipv6 slaac prefix drain

Description

This command enables the mode that does not allow to allocate new micro-nets or SLAAC addresses from the prefix. Existing allocations are not automatically removed, only when the session is removed.

Context

• [Tree] configure mobile-gateway pdn local-address-assignment network-realm pool ipv6 slaac prefix exclude-prefixes

Description

This command specifies a range of IPv6 prefixes that are excluded from allocation to subscriber sessions.

Parameters

ip-address/prefix-length

specifies the start of the IPv6 prefixes to exclude; the host bits of ip-address must be zero; prefix-length must equal to 64

end ip-address/prefix-length

specifies the end of the IPv6 prefixes to exclude; the host bits of ip-address must be zero; prefix-length must equal to 64

Context

• [Tree] configure mobile-gateway pdn local-address-assignment network-realm pool minimum-free

Description

This command specifies a number or percentage of free micro-nets within the prefix, which when met, a trap is generated.

Parameters

number

specifies the minimum free number

Values: 1 to 255

percent

specifies the minimum free as a percentage

Context

• [Tree] configure mobile-gateway pdn pfcp-node-id-type

Description

This command configures the PFCP node ID as an FQDN or IPv4/IPv6 address type.

The no form of this command specifies to use the default node ID type for the Sx/N4 interface.

Parameters

fqdn

specifies the PFCP node ID as an FQDN type and the FQDN to be sent is the one configured under the configure mobile-gateway pdn epc-node command

ip

specifies the PFCP node ID as an IP address type and the IP address to be sent is the one configured for the Sx/N4 interface

Default: fqdn

ipv4

specifies to use the IPv4 address for the PFCP node ID when dual stack is configured on the Sx-N4 reference point interface

ipv6

specifies to use the IPv6 address for the PFCP node ID when dual stack is configured on the Sx-N4 reference point interface

Default: ipv4

Note: If dual stack is configured on the Sx-N4 reference point interface and the pfcp-node-id-type is set with IP address, then the IPv4 or IPv6 address must also be configured.

Caution:

• The pfcp-node-id-type command must not be executed on a live system.
• Use the shutdown command in the configure mobile-gateway pdn context before changing the node ID type for the Sx/N4 interface. Use the no shutdown command under the same context to apply the change.

Context

• [Tree] configure mobile-gateway pdn s11

Description

This command configures the s11 reference point name.

Parameters

sig-ref-point-name

specifies a signaling reference point name up to 32 characters

At least one S11 interface must be configured on the gateway to allow peering with MME. A single S11 interface configured on the gateway can form peering with multiple MME nodes. Optionally, multiple S11 interfaces can be configured on the SGW. If a signaling reference point name is not specified, the default instance of S11 interface is created.

Each S11 interface must be associated with an S1u interface, configured using the configure mobile-gateway pdn s11 interface gtp-c command. If no S1-u interface is provided during the S11 interface configuration, the S11 interface is associated with the default S1-u interface.

The S1-u interface is bound to an A11 interface to form a signaling group. For example, the default instance of the S1-u interface is selected and assigned TEID on receiving a Create Session Request over the default instance of the S11 interface.

group-specific

specifies an MG group-specific reference point interface for GTP-U redirection; it is used when associating the reference point interface with an MG system group via an override profile

Context

• [Tree] configure mobile-gateway pdn s11 interface

Description

This command enables the context to configure the s11 interface.

Context

• [Tree] configure mobile-gateway pdn s11 interface gtp-c

Description

This command configures the GTP-C profile parameters for the S11 interface.

Parameters

router-instance

specifies the virtual router name or service ID

Values	router-name | service-id
	router-name	Base
	service-id	1 to 2147483647

Default: Base

interface-name

specifies an interface name up to 32 characters, which must start with a letter

binding-ref-point-name

specifies an S1-u interface signaling reference point name to bind, up to 32 characters

s11-u-realm-name

specifies the associated realm name for the virtual routing instance that has the S11/S1 GTP-U interface on the user plane function, up to 32 characters

Note: Only the following characters are permitted:

• alphabetic characters (A-Z and a-z)
• digits (0-9)
• hyphen (-)
• dot (.)

The realm name must be unique for a specific virtual routing instance on the user plane and is communicated in the Network-Instance IE part of the PFCP interface session establishment/modification process.

Note: This parameter is only used when the gateway is configured as a CP function using the mobile config pdn instance-type command.

binding-realm-name

specifies the associated realm name for the S1-U interface, up to 32 characters; relevant if the S1-U and the S11-U use different network realms

Context

• [Tree] configure mobile-gateway pdn s11 signaling

Description

This command enables the context to configure signaling for the S11 interface.

Context

• [Tree] configure mobile-gateway pdn s11 signaling gtp-c

Description

This command enables the context to configure GTP-C signaling for the S11 signaling interface.

Context

• [Tree] configure mobile-gateway pdn s11 signaling gtp-c ddn-damp-timer

Description

This command configures the DDN dampening timer interval.

The no form of this command removes the dampening timer from the configuration.

Parameters

ddn-damp-timer

specifies a dampening timer interval, in seconds

Values: 0 | 10 to 3600

Default: 0

Context

• [Tree] configure mobile-gateway pdn s11 signaling gtp-c ddn-extended-buffering-time

Description

This command defines the maximum time for the extended buffering. If the value received from the MME is less than the configured value, the value received from the MME is used, otherwise the configured value defines how long the extended buffering is applied. If the maximum time is 0, the extended buffering is not supported. Buffering lasts always at least 30 seconds.

The no form of this command removes the extended buffering timer from the configuration.

Parameters

ddn-extended-buffering-time

specifies the maximum time for extended buffering, in seconds

Values: 0 | 30 to 86400

Default: 0

Context

• [Tree] configure mobile-gateway pdn s11 signaling gtp-c ddn-throttling-arp-threshold

Description

This command configures the DDN ARP threshold.

The no form of this command removes the ARP threshold from the configuration.

Parameters

ddn-throttling-arp-threshold

specifies a DDN ARP threshold

Values: 0 to 15

Context

• [Tree] configure mobile-gateway pdn s11 signaling gtp-c ue-inactivity-timer

Description

This command configures a timer to detect active status of UE after path management session on S11 reference point to a peer restarts without the peering node restarting. If the UE is idle for configured time after the path management session has restarted, the SGW deletes the PDN connection. This is done to remove stale sessions that may not be valid as they have moved to alternate SGW during SGW restoration procedure executed on MME.

The no form of this command disables UE inactivity timer configuration.

Parameters

minutes

specifies time interval, in minutes

Values: 0 | 30 to 2880

Default: 0

Context

• [Tree] configure mobile-gateway pdn s5

Description

This command enables the context to configure the S5 interface. S5 provides user plane tunneling and tunnel management between the SGW and the PGW. It is used for SGW relocation because of UE mobility and if the SGW needs to connect to a non-colocated PGW for the required PDN connectivity. The S5 is based on GTP protocol. The PMIP variant of the S5 interface is described in TS 23.402. Redundancy support on S5 reference points must be taken into account.

Parameters

sig-ref-point-name

specifies the S5 interface name, up to 32 characters

group-specific

specifies an MG group-specific reference point interface for GTP-U redirection; it is used when associating the reference-point interface with an MG system group via an override profile

Context

• [Tree] configure mobile-gateway pdn s5 interface

Description

The command enables the context to configure interface parameters.

Context

• [Tree] configure mobile-gateway pdn s5 interface gtp-c

Description

This command configures the GTP-C profile parameters for an S5 or S8 interface.

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

Parameters

router-instance

specifies the virtual router name or service ID

Values	router-name | service-id
	router-name	Base
	service-id	1 to 2147483647

Default: Base

interface-name

specifies an interface name, up to 32 characters

s5-u-realm-name

specifies the associated realm name for the virtual routing instance that has the S5 GTP-U interface on the user plane function, up to 32 characters

Note: Only the following characters are permitted:

• alphabetic characters (A-Z and a-z)
• digits (0-9)
• hyphen (-)
• dot (.)

The realm name must be unique for a specific virtual routing instance on the user plane and is communicated in the Network-Instance IE part of the PFCP interface session establishment/modification process.

Note:

This parameter is only used when the gateway is configured as a CP function using the mobile config pdn instance-type command.

Context

• [Tree] configure mobile-gateway pdn shutdown

Description

This command administratively disables the entity. When disabled, an entity does not change, reset, or remove any configuration settings or statistics. Many entities must be explicitly enabled using the no shutdown command.

The operational state of the entity is disabled as well as the operational state of any entities contained within. Many objects must be shut down before they may be deleted.

Context

• [Tree] configure mobile-gateway pdn signaling gtp-c

Description

This command specifies the GPRS Tunneling Protocol-Control plane (GTP-C) profile name. The GTP-C profile provides GTP-C signaling related configuration.

Context

• [Tree] configure mobile-gateway pdn signaling gtp-c profile

Description

This command specifies the GTP-C profile name.

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

Default

no profile

Parameters

profile-name

specifies the GTP-C profile name

Context

• [Tree] configure mobile-gateway pdn sx-n4

Description

This command enables the context to configure the Sx/N4 interface parameters.

Parameters

ref-point-name

specifies a name to associate with this reference point, up to 32 characters

Context

• [Tree] configure mobile-gateway pdn sx-n4 enforced-pfcp-association-list

Description

This command enables the PFCP to accept only PFCP association setup from a peer that is configured in the PFCP association list (using the pfcp-association-list command).

The no form of this command reverts to the default, which accepts and dynamically adds PFCP association requests from a peer that is not configured in the PFCP association list.

Context

• [Tree] configure mobile-gateway pdn sx-n4 interface

Description

This command enables the context to configure GTP-U and Packet Forwarding Control Protocol (PFCP) parameters for the Sx/N4 interface.

Context

• [Tree] configure mobile-gateway pdn sx-n4 interface ibcp

Description

This command configures the binding Sx-N4 binding interface for In-Band Control Protocol (IBCP).

The no form of this command removes the configuration.

Parameters

router-instance

specifies the router instance, up to 32 characters

interface-name

specifies the interface name, up to 32 characters

Context

• [Tree] configure mobile-gateway pdn sx-n4 interface pfcp

Description

This command configures the Packet Forwarding Control Plane (PFCP) profile parameters for the Sx/N4 interface.

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

Parameters

router-instance

specifies the router instance, up to 32 characters

interface-name

specifies an interface name, up to 32 characters

Context

• [Tree] configure mobile-gateway pdn sx-n4 pfcp-association-list

Description

This command links the PFCP association peer list to the PDN (configured as CP or UP function using the mobile config pdn instance-type command).

If the gateway is configured as a CP function, the command links the PFCP association peer list of the UP function peers that are to be associated with this Sx/N4 interface.

If the gateway is configured as a UP function, the command links the PFCP association peer list of the CP function peers that are to be associated with this Sx/N4 interface.

Parameters

list-name

specifies the name of the PFCP association peer list defined in the configure mobile-gateway profile pfcp context, up to 32 characters

Context

• [Tree] configure mobile-gateway pdn sx-n4 signaling

Description

This command enables the context to configure the signaling parameters of the Sx/N4 interface.

Context

• [Tree] configure mobile-gateway pdn sx-n4 signaling ibcp

Description

This command enables the context to configure IBCP signaling parameters.

Context

• [Tree] configure mobile-gateway pdn sx-n4 signaling ibcp bng-entry-point

Description

This command configures the BNG entry point name, which are used to start authenticating control plane packets received over the default IBCP tunnel.

Parameters

name

specifies the BNG entry point name, up to 32 characters

Context

• [Tree] configure mobile-gateway pdn sx-n4 signaling ibcp ip-dscp

Description

This command configures the IPv4 DSCP or IPv6 Traffic Class DS value that is used in the outer IP header of outgoing IBCP messages.

Parameters

ip-dscp-value

specifies the value of the IPv4 DSCP or IPv6 Traffic Class DS

Values: 0 to 63

Default: 56

Context

• [Tree] configure mobile-gateway pdn sx-n4 signaling ibcp ip-ttl

Description

This command configures the TTL value that is used in the outer IP header of outgoing IBCP messages.

Parameters

ip-ttl-value

specifies the value of the TTL used in the outer IP header

Values: 0 to 255

Default: 255

Context

• [Tree] configure mobile-gateway pdn sx-n4 signaling ibcp triggers

Description

This command specifies the type of control packets that are sent over the default IBCP tunnel.

The no form of this command disables the default IBCP tunnel.

Parameters

pppoe-discovery

enables the PPPoE discover trigger

ipoe-dhcp

enables the DHCP IPoE trigger

ipoe-dhcpv6

enables the DHCPv6 IPoE trigger

ipoe-router-solicit

enables the RS IPoE trigger

Context

• [Tree] configure mobile-gateway pdn sx-n4 signaling pfcp

Description

This command enables the context to configure PFCP signaling parameters.

Context

• [Tree] configure mobile-gateway pdn sx-n4 signaling pfcp profile

Description

This command configures the PFCP profile for use in the Sx/N4 interface.

The no form of this command removes the association.

Parameters

profile-name

specifies a policy base profile name, up to 32 characters