mobile-gateway command reference

Context

• [Tree] admin mobile-gateway

Description

Commands in this context configure group suspension.

Context

• [Tree] admin mobile-gateway group

Description

This command suspends the specified group.

Parameters

group-number

Specifies the mobile gateway group filter.

Values: 1 to 15

suspend

Keyword to administratively suspend this group for mobile gateway.

now

Keyword to force the suspend of this group with an active card.

Context

• [Tree] admin mobile-gateway max-suspend-duration

Description

This command configures the maximal duration for suspended groups.

Default

max-suspend-duration 30

Parameters

max-suspend-duration

Specifies the duration in minutes.

Values: 0 | 10 to 120, where 0 disables the duration

Default: 30

Context

• [Tree] clear mobile-gateway

Description

Commands in this context clear BNG and PDN gateway-related information.

Context

• [Tree] clear mobile-gateway bng

Description

Commands in this context clear BNG-related information.

Context

• [Tree] clear mobile-gateway bng error-history

Description

This command clears the BNG error history.

Context

• [Tree] clear mobile-gateway bng session

Description

This command deletes the specified BNG CUPS sessions. By default, the user is prompted to confirm the deletion and the sessions are removed gracefully.

Parameters

subscriber-name name

Specifies the subscriber name filter, up to 128 characters.

force

Keyword to specify the deletion of sessions without synchronization with any external server or the client.

Note: The number of sessions that can be deleted gracefully, that is, without the force keyword, is limited to 1000. With the force keyword, the number of sessions that can be deleted is unlimited.

confirm

Keyword to skip the CLI prompt for user confirmation.

l2-access-id string-64

Specifies the Layer 2 access ID filter, up to 64 characters.

c-vlan tag

Specifies the customer VLAN (inner VLAN) filter.

Values: 1 to 4095

s-vlan tag

Specifies the service VLAN (outer VLAN) filter.

Values: 1 to 4095

mac ieee-address

Specifies the MAC address filter.

Values: xx:xx:xx:xx:xx:xx | xx-xx-xx-xx-xx-xx, cannot be all zeros

up-ip ipv4-address | ipv6-address

Specifies the UP IP address filter.

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

up-group name

Specifies the UP group name, up to 32 characters.

ppp-username username

Specifies the PPP username, up to 253 characters.

Context

• [Tree] clear mobile-gateway bng session-lockout

Description

This command clears the locked-out state of the specified sessions. Add any optional parameter to filter specific sets of sessions.

Parameters

string-64

Specifies the Layer 2 access ID filter, up to 64 characters.

tag

Specifies the customer VLAN (inner VLAN) filter.

Values: 1 to 4096

s-vlan tag

Specifies the service VLAN (outer VLAN) filter.

Values: 1 to 4096

ieee-address

Specifies the MAC address filter.

Values: xx:xx:xx:xx:xx:xx or xx-xx-xx-xx-xx-xx, cannot be all zeros

ip-address | ipv6-address

specifies the UP IP address filter

Values:

• ip-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

Context

• [Tree] clear mobile-gateway bng wpp

Description

Commands in this context clear WPP statistics.

Context

• [Tree] clear mobile-gateway bng wpp statistics

Description

This command clears the statistics of the specified WPP portal or portal group.

Parameters

name

Specifies the WPP portal name.

portal-group name

Specifies the WPP portal group name.

Context

• [Tree] clear mobile-gateway pdn

Description

This command clears PDN gateway related information.

Parameters

gw-id

Specifies the gateway ID.

Values: 1 to 8

Context

• [Tree] clear mobile-gateway pdn bearer-context

Description

This command clears FWA bearers and sessions.

When the command is given:

• bearer and session deletion is initiated for all APNs if the APN is not specified
• the parameters used with the command to filter the sessions are matched against the whole UE; if they match, all UE sessions are deleted

A subsequent clear command is not accepted while another one is still ongoing, except in the following cases:

• the intent is to increase/decrease the deletion rate
• the intent is to clear all the sessions for the same entity (gateway or APN) given at the ongoing deletion

Parameters

msisdn

Specifies the MSISDN, up to 15 characters.

imei

Specifies an IMEI, up to 16 characters.

imsi

Specifies the IMSI, up to 15 characters.

local-only

Specifies an internal cleanup without signaling to peers.

name

Specifies the APN name, up to 80 characters.

bearer-id

Specifies the EPS Bearer Identifier of the specific UE.

Values: 5 to 15

cause-reactivation-req

Keyword to set the Request Cause of the release signaling to 8 (Reactivation Requested) in GTPv2. In 5G deployment, this keyword sets that SMF sends the 5GSM cause value #39 “reactivation requested” in the PDU SESSION RELEASE COMMAND message.

cancel

This option cancels an ongoing command. It is supported and can be used only in the commands shown in the syntax. The ongoing deletion instance to be canceled is identified by using the same set of parameters and their values that were used initially when the clear command was initiated.

ip-address

Specifies the IPv4 or IPv6 address of the peer server (an FWA-UP).

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

ipv4-address

Specifies the IPv4 address, up to 64 characters.

Values:  a.b.c.d

mask

Specifies the IPv4 address mask.

Values: 9 to 30

prefix-length

Specifies the IPv6 prefix length.

Values: 41 to 56

Context

• [Tree] clear mobile-gateway pdn bearer-context apn

Description

This command clears FWA bearers and sessions within the specified APN.

Parameters

name

Specifies the APN name, up to 80 characters.

pdn-type

Specifies the PDN type of the sessions to be deleted.

Values:

• ipv4 – clears the sessions with an IPv4 address
• ipv6 – clears the sessions with an IPv6 address
• ipv4ipv6 – clears the sessions with an IPv4, IPv6, or both types of addresses

cancel

Keyword to cancel an ongoing command. It can be used only in the command as shown in the syntax. To identify the ongoing command, use the same set of parameters and values that were used to initiate the clear command.

local-only

Keyword for an internal cleanup.

Context

• [Tree] clear mobile-gateway pdn bearer-context imei

Description

This command clears FWA bearers and sessions with the specified IMEI.

Parameters

imei

Specifies an IMEI, up to 16 characters.

name

Specifies the APN name, up to 80 characters.

local-only

Keyword for an internal cleanup.

bearer-id

Specifies the EPS Bearer Identifier of the specific UE.

Values: 5 to 15

cause-reactivation-req

Keyword to set the Request Cause of the release signaling to 8 (Reactivation Requested) in GTPv2. In 5G deployment, this keyword sets the SMF to send the 5GSM cause value #39 “reactivation requested” in the PDU SESSION RELEASE COMMAND message.

Context

• [Tree] clear mobile-gateway pdn bearer-context imsi

Description

This command clears FWA bearers and sessions with the specified IMSI.

Parameters

imsi

Specifies the IMSI, up to 15 characters; supported in PGW, SGW, and ePDG.

name

Specifies the APN name, up to 80 characters.

local-only

Keyword for an internal cleanup.

bearer-id

Specifies the EPS Bearer Identifier of the specific UE.

Values: 5 to 15

cause-reactivation-req

Keyword to set the Request Cause of the release signaling to 8 (Reactivation Requested) in GTPv2. In 5G deployment, this keyword sets the SMF to send the 5GSM cause value #39 “reactivation requested” in the PDU SESSION RELEASE COMMAND message.

Context

• [Tree] clear mobile-gateway pdn bearer-context msisdn

Description

This command clears FWA bearers and sessions with the specified MSISDN.

Parameters

msisdn

Specifies the MSISDN, up to 15 characters.

name

Specifies the APN name, up to 80 characters.

local-only

Keyword for an internal cleanup.

bearer-id

Specifies the EPS Bearer Identifier of the specific UE.

Values: 5 to 15

cause-reactivation-req

Keyword to set the Request Cause of the release signaling to 8 (Reactivation Requested) in GTPv2. In 5G deployment, this keyword sets the SMF to send the 5GSM cause value #39 “reactivation requested” in the PDU SESSION RELEASE COMMAND message.

Context

• [Tree] clear mobile-gateway pdn bearer-context ue-location

Description

This command clears FWA bearers and sessions with the specified location.

Parameters

ue-location

Specifies the location type, can currently only be set to tracking-area-code.

Values: tracking-area-code

name

Specifies the APN name, up to 80 characters.

ue-location-id

Specifies the Tracking Area Code

Values: 4 digit hexadecimal number

Context

• [Tree] clear mobile-gateway pdn bearer-context up-peer

Description

This command clears FWA bearers and sessions active on the specified UPF.

Parameters

ipv4-address | ipv6-address

Specifies the IP address.

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

mask

Specifies the IPv4 address mask.

Values: 9 to 30

prefix-length

Specifies the IPv6 prefix length.

Values: 41 to 56

cancel

Keyword to cancel an ongoing command. It can be used only in the command as shown in the syntax. To identify the ongoing command, use the same set of parameters and values that were used to initiate the clear command.

Context

• [Tree] clear mobile-gateway pdn call-flow-stats

Description

This command clears call flow statistics.

Parameters

group-number

Specifies the group number.

Values: 1 to 8

slot-number

Specifies the card slot number.

Values: 1 to 10 | A | B

local-only

Specifies an internal cleanup.

Context

• [Tree] clear mobile-gateway pdn path-mgmt-stats

Description

This command clears path management statistics.

Parameters

s11 | sx-n4 | n9

Specifies the reference point type.

ref-point-name

Specifies the reference point name.

ip-address

Specifies an existing peer IP address.

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 (per label max 63).

port

Specifies a port ID.

Values: 1 to 65535

Context

• [Tree] clear mobile-gateway pdn ref-point-stats

Description

This command clears reference point statistics.

Parameters

s11 sx-n4 n9

Specifies the reference point type.

ip-address

Specifies an existing peer IP address or FQDN

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.

port

Specifies a port ID.

Values: 1 to 65535

group-number

Specifies the group number.

Values: 1 to 8

slot-number

Specifies the card slot number.

1 to 10 | A | B

ref-point-name

Specifies the reference point name.

radius

Specifies the RADIUS reference point.

radius-group

Specifies the RADIUS group.

ibcp

Specifies to clear the BNG IBCP statistics.

Context

• [Tree] clear mobile-gateway pdn statistics

Description

This command clears statistics for each card.

Parameters

group-number

Specifies the group number.

Values: 1 to 15

attach-failure-statistics

Clears the attach failure statistics.

ga-buffered-cdrs

Clears the counter for Ga buffered CDR files.

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.

Context

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

Description

configure mobile-gateway pdn local-address-assignment

Context

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

Description

Commands in this context 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

Commands in this context 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 del-bearer-reactivation-req-cause

Description

This command forces the Cause code in Delete Bearer messages to be set to Reactivation Request (value #8) for the specified deletion scenarios.

The no form of this command indicates that no Cause code is signaled for these scenarios.

Default

no del-bearer-reactivation-req-cause

Parameters

all

Keyword to enable the reactivation Cause code for all listed deletion scenarios.

session-timeout

Keyword to trigger a deletion by a session timeout.

pdn-connection-clear

Keyword to trigger a deletion by an explicit clear command, or when removing a session after a session audit.

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

This command configures the DHCP Server IP address when the MAG-c generates DHCP packets. If not configured, the MAG-c uses the default gateway IP of the session as the DHCP Server IP instead.

The no form of this command removes the configuration.

Default

no dhcpv4-server-ip

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 functionality related to FWA sessions.

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 max-pdn-connections

Description

This command configures the maximum number of PDN connections for this APN on the MAG-c, 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 FWA 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 FWA 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 FWA 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 FWA session attach requests received. 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

Context

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

Description

configure mobile-gateway pdn local-address-assignment

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 pcf-selection

Description

Commands in this context configure PCF selection options.

Context

• [Tree] configure mobile-gateway pdn apn pcf-selection dnn-format

Description

This command configures the DNN format used when sending the DNN to PCF.

The no form of this command reverts to the default.

Default

dnn-format selected

Parameters

form

Specifies the DNN format.

Values:

• real – specifies use of the real, unmodified DNN as signaled during the FWA session setup, including the OI if it is present
• real-ni-only – specifies use of the real DNN as signaled during the FWA session setup, but without the OI if it is present
• selected – specifies use of the selected DNN as is (returned after initial authentication); if no selected DNN is available, the system falls back to the real-ni-only option.

Context

• [Tree] configure mobile-gateway pdn apn pcf-selection exclude-gpsi

Description

This command configures whether GPSI is used in the query criteria when the MAG-c discovers the PCF using the NRF.

The no form of this command configures the use of GPSI in the query criteria.

Default

Context

• [Tree] configure mobile-gateway pdn apn pcf-selection exclude-snssais

Description

This command configures whether S-NSSAIs are used in the query criteria when the MAG-c discovers the PCF using the NRF.

The no form of this command reverts to the default.

Default

exclude-snssais inherit

Parameters

enable

Keyword to use S-NSSAIs in the query criteria.

disable

Keyword to not use S-NSSAIs in the query criteria.

inherit

Keyword to inherit the configuration specified under configure mobile-gateway pdn 1 sba-client-services nrf-client nnrf-disc exclude-snssais.

Context

• [Tree] configure mobile-gateway pdn apn pcf-selection exclude-supi

Description

This command configures whether SUPI is used in the query criteria when the MAG-c discovers the PCF using the NRF.

The no form of this command configures that SUPI is used in the query criteria.

Default

no exclude-supi

Context

• [Tree] configure mobile-gateway pdn apn pcf-selection nf-id-list

Description

This command specifies an NF ID list for PCF selection. This list is used in the following cases:

• NRF-based discovery only returns a list of NF Instances without IP/FQDN, in which case the specified NF Instance IDs must be present in the NF ID list.
• NRF-based discovery fails (for example returns an empty list or times out).
• NRF-based discovery is disabled.

The no form of this command removes the NF ID list from the configuration.

Default

no nf-id-list

Parameters

list-name

Specifies the NF ID list name, up to 32 characters. Refers to a list configured using the configure mobile-gateway profile list nf-id-list command.

Context

• [Tree] configure mobile-gateway pdn apn pcf-selection pcf-id

Description

This command configures whether the PCF NF Instance ID received from AMF is used in the target-nf-instance-id query parameter when the MAG-c discovers the PCF using the NRF.

The no form of this command reverts to the default

Default

pcf-id use-as-target

Parameters

use-as-target

Keyword to use the NF Instance ID in the target-nf-instance-id query parameter.

ignore

Keyword to not use the NF Instance ID when generating the query.

Context

• [Tree] configure mobile-gateway pdn apn pcf-selection pcf-profile

Description

This command specifies the PCF profile used to communicate with the PCF.

The no form of this command removes the PCF profile from the configuration and default settings will be used.

Default

no pcf-profile

Parameters

profile-name

Specifies the PCF profile name, up to 32 characters. Refers to a profile configured using the configure mobile-gateway profile pcf-profile command.

Context

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

Description

This command specifies the Packet Data Network (PDN) type. If the MAG-c receives a Create Session Request for a PDN type that is not in this list, it rejects the session unless the related pdn-type-conversion command is enabled. In the latter case, a session setup that signals pdn-type IPv4v6 downgrades to IPv4 or IPv6 if either of those is configured. If both IPv4 and IPv6 are configured, IPv4 is chosen unless the pdn-type-preferred-ipv6 command is configured.

The no form of this command reverts to the default.

Parameters

ipv4

Specifies that IPv4 FWA sessions are supported by this APN.

ipv6

Specifies that IPv6 FWA sessions are supported by this APN.

ipv4v6

Specifies that IPv4v6 FWA sessions are supported by this APN.

Default: ipv4

Context

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

Description

This commands forces the use of an IPv6 address for session when PDN type fall back is enabled via the pdn-type-conversion configuration.

The no form of this command forces the use of an IPv4 address.

Context

• [Tree] configure mobile-gateway pdn apn qci-policy

Description

This command configures the QCI policy for the uplink or downlink direction , or both. This policy is used to map QCI/5QI and ARP values to other QoS parameters , such as DSCP.

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

Default

no qci-policy

Parameters

qci-policy-name

Specifies the QCI policy name, up to 32 characters. The QCI policy is configured using the following command.

configure mobile-gateway profile policy-options qci-policy

Context

• [Tree] configure mobile-gateway pdn apn qfi-mapping-profile

Description

This command configures an optional QoS flow binding profile. The QoS parameters specified within the profile are used for QoS flow binding. When this optional profile is not configured here or on PDN level, the QFI is generated dynamically in the range 1 to 64 using 5QI/ARP as key.

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

Default

no qfi-mapping-profile

Parameters

profile-name

Specifies the QFI mapping profile name, up to 32 characters. The QFI mapping profile is configured using the following command.

configure mobile-gateway profile qfi-mapping-profile

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 apn slices

Description

Commands in this context configure a slice list that the MAG-c supports for this DNN/APN and will signal to the NRF when registering itself. Additionally a default slice can be provisioned that will be used for sessions that are not associated with a slice.

Context

• [Tree] configure mobile-gateway pdn apn slices default-slice

Description

This command configures the default slice of this APN/DNN. When the MAG-c, acting as combined PGW-C/SMF, cannot retrieve the UE subscribed S-NSSAIs from the UDM, the SMF uses the locally configured default S-NSSAI for this APN/DNN. The slice-name must also be configured in a slice list that is applied in either of the following contexts:

configure mobile-gateway pdn slices slice-list
configure mobile-gateway pdn apn slices slice-list

When the default slice is not configured, no fallback is used and session setup fails.

The no form of this comment removes the default slice.

Default

no default-slice

Parameters

slice-name

Specifies the name of the slice, up to 32 characters.

Context

• [Tree] configure mobile-gateway pdn apn slices slice-list

Description

This command configures the list of slices or a single slice for this APN/DNN, which marks the APN as specific to this slice list. The APN is included under the configured slices during registration to the NRF.

The no form of this command removes the configuration, and the slice-list configured at the PDN level applies to this APN.

Default

no slice-list

Parameters

list-name

Specifies the name of the slice list, up to 32 characters. The slice list is configured using the following command.

configure mobile-gateway profile list slice-list

Context

• [Tree] configure mobile-gateway pdn apn udm-options

Description

Commands in this context enable APN/DNN-specific behavior when communicating with the UDM. Note that for the get operation of the Nudm_SubscriberDataManagement, this only uses configuration under the DNN signaled in session setup messages and not configuration under the selected DNN, as this operation is called before an alternative DNN can be selected.

Context

• [Tree] configure mobile-gateway pdn apn udm-options dnn-format

Description

This command configures the DNN format that will be used when sending the DNN to the UDM.

The no form of this command reverts to the default.

Default

dnn-format real

Parameters

form

Specifies the DNN format.

Values: real | real-ni-only

• real – specifies to use the real, unmodified DNN as signaled during the FWA session setup, including the OI if it is present
• real-ni-only – specifies to use the real DNN as signaled during the FWA session setup, but without the OI if it is present

Context

• [Tree] configure mobile-gateway pdn bng

Description

Commands in this context configure BNG PDN parameters.

Context

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

Description

Commands in this context 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 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 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 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

This command configures an interface to send and receive WPP packets. Multiple interfaces can be configured.

The no form of this command removes the configuration.

Parameters

service-id

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

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

Commands in this context 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 dns-client

Description

Commands in this context configure the MAG-c DNS client.

Context

• [Tree] configure mobile-gateway pdn dns-client dns-interface

Description

This command configures the source interface to use with the DNS profile for DNS lookup on the MAG-c.

The no form of this command removes the configuration

Default

no dns-interface

Parameters

interface-name

Specifies an interface name that must start with a letter, up to 32 characters .

router-instance

Specifies the virtual router name or service ID.

Values: router-name | vprn-svc-id

• router-name – Base | management
• vprn-svc-id – 1 to 2147483647

Default: Base

Context

• [Tree] configure mobile-gateway pdn dns-client dns-profile

Description

This command configures a DNS profile used for all DNS lookups related to MAG-c session management functionality.

The no form of this command removes the DNS-profile.

Default

no dns-profile

Parameters

profile-name

Specifies the name of the DNS profile, up to 32 characters. Profiles are configured using the configure mobile-gateway profile dns-profile command.

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 home-plmn-list

Description

Parameters

list-name

Specifies the name of the referenced PLMN list, up to 32 characters; the PLMN list names are configured using the configure mobile-gateway profile list plmn command.

Context

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

Description

This command must always be set to control.

Parameters

instance-type-value

Specifies the role of the PDN.

Values:

• control – Enables MAG-c as control plane.
• user – Not supported for MAG-c.

Context

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

Description

Commands in this context 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

Commands in this context 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

Commands in this context 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

Commands in this context configure IPv6 address pools.

Context

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

Description

Commands in this context 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

Commands in this context 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

Commands in this context 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

Commands in this context 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

Commands in this context 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 configures a threshold for free micro-nets within the prefix. An event is generated when the number of free micro-nets in the pool becomes smaller than the minimum-free threshold or exceeds the sum of the minimum-free threshold and the rising-threshold value.

The no form of this command removes the configuration.

Default

no minimum-free

Parameters

number

Specifies the minimum number of free micro-nets.

Values: 1 to 255

value

Specifies the value for the rising threshold.

Values: 1 to 50

percent

Keyword to specify the number and value parameters in percent.

Context

• [Tree] configure mobile-gateway pdn nf-profile-attributes

Description

Attributes defining properties of the MAG-c as a 5G core Network Function.

Context

• [Tree] configure mobile-gateway pdn nf-profile-attributes capacity

Description

This command configures the capacity value that is used in the NF profile during NF registration and in the NF update to the NRF. When the keyword factor is specified, the signaled capacity is multiplied by the number of configured SM-VMs.

The no form of this command removes the configuration, and the capacity value will not be populated during NF registration and update procedures.

Default

no capacity

Parameters

factor

Keyword to specify that the capacity value is the capacity of a single SM-VM, which is calculated by multiplying the given value with the number of active SM-VMs.

total

Keyword to specify that the capacity value is the total capacity of the NF instance.

capacity-value

Specifies the capacity value.

Values: 0 to 65535

Context

• [Tree] configure mobile-gateway pdn nf-profile-attributes exclude-ip-endpoints

Description

configure mobile-gateway pdn sba-server-services

The no form of this command indicate that the local IP addresses will be registered with the NRF.

Default

no exclude-ip-endpoints

Context

• [Tree] configure mobile-gateway pdn nf-profile-attributes fqdn

Description

This command configures the FQDN of the MAG-c that is used in the NF profile during NF registration and in the NF update to the NRF.

The no form of this command removes the configuration, and the FQDN attribute will not be populated during NF registration and update procedures.

Default

no fqdn

Parameters

fqdn

Specifies the FQDN string, up to 255 characters.

Context

• [Tree] configure mobile-gateway pdn nf-profile-attributes locality

Description

This command configures the locality that the SMF registers to the NRF. The locality can be a geographical description, data-center location, and so on.

The no form of this command removes the configuration, and the locality attribute will not be populated during NF registration and update procedures.

Default

no locality

Parameters

locality

Specifies the arbitrarily-defined location string, such as the data center location or geographic location, up to 64 characters.

Context

• [Tree] configure mobile-gateway pdn nf-profile-attributes nf-instance-id

Description

This command registers the UUID to the NRF in the NFProfile as the NFInstanceId. The UUID cannot be changed for an active registration.

The no form of this command specifies that an auto-generated value is used.

Default

no nf-instance-id

Parameters

uuid

Specifies the NF instance ID in UUIDv4 canonical textual representation.

Values: xxxxxxxx-xxxx-4xxx-xxxx-xxxxxxxxxxxx

x: [0..F]H

Context

• [Tree] configure mobile-gateway pdn nf-profile-attributes priority

Description

This command configures the priority value that is used in the NF profile during NF registration and in the NF update to the NRF.

The no form of this command removes the configuration, and the priority attribute will not be populated during NF registration and update procedures.

Default

no priority

Parameters

priority-value

Specifies the priority as an integer, where a lower value means higher priority.

Values: 0 to 65535

Context

• [Tree] configure mobile-gateway pdn nf-profile-attributes tai-list

Description

This command configures the TAI list or TAI range list that the SMF covers and registers to the NRF.

The no form of this command removes the configuration, and the TAI range list will not be signaled during NF registration and update procedures, indicating that all TAIs are supported.

Default

no tai-list

Parameters

list-name

Specifies the name of the referenced TAI list, up to 32 characters. The TAI list names are configured using the following command.

configure mobile-gateway profile list tai-lai-list

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 PFCP 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 changed 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 qfi-mapping-profile

Description

This command configures an optional QoS flow binding profile. The QoS parameters specified within the profile are used for QoS flow binding. When this optional profile is not configured here or at the APN level, the QFI is generated dynamically in the range 1 to 64 using 5QI/ARP as key.

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

Parameters

profile-name

Specifies the QFI mapping profile name, up to 32 characters. The QFI mapping profile is configured using the following command.

configure mobile-gateway profile qfi-mapping-profile

Context

• [Tree] configure mobile-gateway pdn radius

Description

This command enables the context to configure parameters for communication to RADIUS servers.

Context

• [Tree] configure mobile-gateway pdn radius radius-accounting-on-off

Description

This command enables the context to control RADIUS accounting ON and OFF messaging.

Context

• [Tree] configure mobile-gateway pdn radius radius-accounting-on-off messages-sent

Description

This command specifies whether the MAG-c sends both RADIUS accounting ON and OFF messages, only RADIUS accounting ON messages, or no RADIUS accounting ON/OFF messages.

The no form of this command reverts to the default.

Default

messages-sent on-off

Parameters

{none | on | on-off}

Specifies which RADIUS accounting messages are sent.

• none – no radius accounting on or off messages are sent
• on – only radius accounting on messages are sent
• on-off – both radius accounting on or off messages are sent

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 MAG-c to allow peering with MME. A single S11 interface configured on the gateway can form peering with multiple MME nodes.

Default: default

Context

• [Tree] configure mobile-gateway pdn s11 interface

Description

Commands in this context 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.

s1-u-realm-name

Specifies the associated realm name for the 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 routing instance on the user plane and is communicated in the Network-Instance IE part of the PFCP interface session establishment/modification process.

Context

• [Tree] configure mobile-gateway pdn s11 signaling

Description

Commands in this context configure signaling for the S11 interface.

Context

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

Description

Commands in this context configure GTP-C signaling for the S11 signaling interface.

Context

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

Description

This command configures the Downlink Data Notification (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 profile

Description

configure mobile-gateway profile gtp

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

Default

no profile

Parameters

profile-name

Specifies the profile name, up to 32 characters.

Context

• [Tree] configure mobile-gateway pdn s5

Description

Commands in this context configure the S5 interface. This interface is not used externally by the MAG-c, but the configured interface IP must match the "PGW S5/S8 Address for Control Plane or PMIP” address that is signaled in the GTP Create Session Request.

Parameters

sig-ref-point-name

Specifies the S5 interface name, up to 32 characters.

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 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 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 set the same as the S1-u GTP-u realm configured under the s11 context. and is communicated in the Network-Instance IE part of the PFCP interface session establishment/modification process.

Note:

Context

• [Tree] configure mobile-gateway pdn s5 signaling

Description

Commands in this context configure signaling for the S11 interface.

Context

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

Description

Commands in this context configure GTP-C signaling for the S5 signaling interface.

Context

• [Tree] configure mobile-gateway pdn sba-client-services

Description

Commands in this context provide configuration options for MAG-c SBA services acting as the NF consumer.

Context

• [Tree] configure mobile-gateway pdn sba-client-services addressing-priority

Description

This command configures the addressing method used for accessing the discovered services of peer NF producers when the discovered NF profiles contain both FQDN and IP endpoints.

The no form of this command reverts to the default.

Default

addressing-priority ip-endpoint

Parameters

addressing-priority

Values:

• fqdn: specifies to use the FQDN if present. If not present, the IP endpoint is used.
• ip-endpoint: specifies to always use the IP endpoint.
• ip-endpoint-fallback: specifies to use the FQDN if present. If not present, the IP endpoint is used. If the FQDN is used and IP resolution fails, the IP endpoint is used as a fallback.

Context

• [Tree] configure mobile-gateway pdn sba-client-services amf-client

Description

Commands in this context configure the MAG-c client-side options when the MAG-c consumes AMF services.

Context

• [Tree] configure mobile-gateway pdn sba-client-services amf-client namf-comm

Description

This command configures an instance of the Namf_Communication service. At least one service instance must be configured to allow peering with the AMF.

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

Parameters

service-instance

Specifies the service instance name, up to 32 characters.

Context

• [Tree] configure mobile-gateway pdn sba-client-services amf-client namf-comm amf-profile

Description

This command associates an AMF profile with the service instance. This profile specifies transmission and error handling behavior.

The no form of this command removes the AMF profile and reverts all behavior to default values.

Default

no amf-profile

Parameters

profile-name

Specifies the name of the AMF profile, up to 32 characters. AMF profiles are configured using the following command.

configure mobile-gateway profile amf-profile

Context

• [Tree] configure mobile-gateway pdn sba-client-services amf-client namf-comm fqdn

Description

This command configures the FQDN which is used by the MAG-c when it needs to construct a hostname for this client, for example for creating a callback URI.

A single FQDN can be configured for all client services in the configure mobile-gateway pdn sba-client-services context or per client service instance.

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

Default

no fqdn

Parameters

fqdn-sni-string

Specifies the FQDN name string, up to 255 characters.

Context

• [Tree] configure mobile-gateway pdn sba-client-services amf-client namf-comm http2-profile

Description

This command configures an HTTP/2 profile, using the configure mobile-gateway profile http2 command, to the client service. A single HTTP/2 profile can be configured for all client services in the configure mobile-gateway pdn sba-client-services context or per client service instance.

The no form of this command removes the HTTP/2 profile from the configuration.

Default

no http2-profile

Parameters

http2-profile-name

Specifies the name of the HTTP/2 profile, up to 32 characters.

Context

• [Tree] configure mobile-gateway pdn sba-client-services amf-client namf-comm interface

Description

This command configures the interface in which the HTTP/2 connections are established.

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

Default

no interface

Parameters

interface-name

Specifies an existing interface name up to 32 characters, which must start with a letter.

router-instance

Specifies the router instance.

Values: router-name | service-id

• router-name – Base
• service-id – 1 to 2147483647

Default: Base

Context

• [Tree] configure mobile-gateway pdn sba-client-services amf-client namf-comm n1-profile

Description

This command configures an N1 profile with the service instance. This profile specifies N1 messaging parameters when sending N1 messages via the Namf_Communication service.

The no form of this command removes the N1 profile from the service instance.

Default

no n1-profile

Parameters

profile-name

Specifies the name of the N1 profile, up to 32 characters. N1 profiles are configured using the configure mobile-gateway profile n1-profile command.

Context

• [Tree] configure mobile-gateway pdn sba-client-services amf-client namf-comm nf-id-list

Description

The no form of this command removes the NF ID list from the configuration.

Default

no nf-id-list

Parameters

list-name

Specifies the NF ID list name, up to 32 characters. NF ID lists are configured using the configure mobile-gateway profile list nf-id-list command.