clear mobile-gateway command descriptions

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 bearer-context information.

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

The rate configured under the config mobile pdn session-deletion-rate command is used if a value is not specified in the command. This rate is treated by the system as the maximum rate to be applied, not as an enforced rate for the session deletion.

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. If more than one bearers exist with the same EBI (for example, for S2b and S5), both bearers are deleted. If the specified EBI is the default bearer, all bearers are deleted.

Values: 5 to 15

cause-reactivation-req

Keyword to set the Request Cause of the release signaling to 8 (Reactivation Requested) in GTPv2 and to 6 (Reactivation Requested) in GTPv1. 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 the bearer-context APN name.

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 either IPv4 or IPv6, or both types of addresses.

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.

data-packet-trigger

Specifies that the sessions, included to the selected entity (apn, group) and to the specific pdn-type are deleted when an uplink data packet is being received for these sessions.

local-only

Keyword for an internal cleanup.

Context

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

Description

This command clears the bearer-context 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. If more than one bearers exist with the same EBI (for example, for S2b and S5), both bearers are deleted. If the specific EBI is the default bearer, all bearers are deleted.

Values: 5 to 15

cause-reactivation-req

Keyword to set the Request Cause of the release signaling to 8 (Reactivation Requested) in GTPv2 and to 6 (Reactivation Requested) in GTPv1. 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 the bearer-context 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. If more than one bearers exist with the same EBI (for example, for S2b and S5), both bearers are deleted. If the specific EBI is the default bearer, all bearers are deleted.

Values: 5 to 15

cause-reactivation-req

Keyword to set the Request Cause of the release signaling to 8 (Reactivation Requested) in GTPv2 and to 6 (Reactivation Requested) in GTPv1. 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 the bearer-context IMSI.

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. If more than one bearers exist with the same EBI (for example, for S2b and S5), both bearers are deleted. If the specific EBI is the default bearer, all bearers are deleted.

Values: 5 to 15

cause-reactivation-req

Keyword to set the Request Cause of the release signaling to 8 (Reactivation Requested) in GTPv2 and to 6 (Reactivation Requested) in GTPv1. 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 up-peer

Description

This command clears the bearer-context UE location.

Parameters

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

ipv6-address

Specifies the IPv6 address.

Values	ipv6 address	x:x:x:x:x:x:x:x (eight 16-bit pieces)
		x:x:x:x:x:x:d.d.d.d
		x - [0..FFFF]H
		d - [0..255]D

prefix-length

Specifies the IPv6 prefix length.

Values: 41 to 56

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.

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 | fqdn

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 – FQDN, up to 255 characters

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 | fqdn

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 – FQDN

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