perform command reference

perform hierarchy descriptions

This section provides the following perform hierarchy descriptions:

perform command descriptions

This section provides the following perform command descriptions:

tools perform command descriptions

mobile-gateway

Syntax
  • mobile-gateway
Context
  • [Tree] tools perform mobile-gateway
Description

Commands in this context execute mobile gateway performance commands.

pdn

Syntax
  • pdn gw-id
Context
  • [Tree] tools perform mobile-gateway pdn
Description

Commands in this context execute tools commands on a specific mobile gateway instance.

Parameters
gw-id
Specifies the gateway ID.
Values: 1 to 8

bng

Syntax
  • bng
Context
  • [Tree] tools perform mobile-gateway pdn bng
Description

Commands in this context execute tools commands specific to BNG CUPS functionality.

data-triggered-host

Syntax
  • data-triggered-host l2-access-id string-64 l2-access-id-mac ieee-address up-ip ip-address | ipv6-address [c-vlan tag] [s-vlan tag] ip ip-address | ipv6-address mac ieee-address [dot1q-etype hex-value] [qinq-etype hex-value]
Context
  • [Tree] tools perform mobile-gateway pdn bng data-triggered-host
Description

This command configures data-trigger options for IPoE sessions.

Parameters
string-64
Specifies the Layer 2 access ID filter, up to 64 characters.
l2-access-id-mac ieee-address
Specifies the Layer 2 MAC address ID filter.
Values: xx:xx:xx:xx:xx:xx or xx-xx-xx-xx-xx-xx
up-ip 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

c-vlan tag
Specifies the customer VLAN (inner VLAN) filter.
Values: 1 to 4094
s-vlan tag
Specifies the service VLAN (outer VLAN) filter.
Values: 1 to 4094
ip ip-address | ipv6-address
Specifies the 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

mac 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
dot1q-etype hex-value
Specifies the Dot1Q Ethernet type HEX value.
Values: 0x8100, 0x88a8, or 0x9100
qinq-etype hex-value
Specifies the QinQ Ethernet type HEX value.
Values: 0x8100, 0x88a8, or 0x9100

static-session

Syntax
  • static-session name action action-id
Context
  • [Tree] tools perform mobile-gateway pdn bng static-session
Description

This command configures options for static IPoE sessions.

Parameters
name
Specifies the name, up to 64 characters.
action-id
Specifies the action to perform.
Values: retry

up-resiliency

Syntax
  • up-resiliency
Context
  • [Tree] tools perform mobile-gateway pdn bng up-resiliency
Description

Commands in this context execute tools commands specific to UP Resiliency functionality.

lookup

Syntax
  • lookup up node-identifier l2-access-id id [s-vlan s-tag] [c-vlan c-tag]
Context
  • [Tree] tools perform mobile-gateway pdn bng up-resiliency lookup
Description

This command looks up the UP group and FSG to which a specific UP and Layer-2 access ID belongs . Optionally, an s-tag or c-tag can be provided if multiple UP groups are used for different VLAN ranges.

Parameters
node-identifier
Specifies the BNG-UP for which the lookup is performed , either by address or by FQDN. This is the value as passed in the Node ID Information Element in PFCP.
Values: ip-addr | fqdn
  • ip-addr – specifies the IPv4 or IPv6 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 a fully qualified domain name, up to 255 characters
id
Specifies the l2-access-id, up to 64 characters.
s-tag
Specifies the s-tag/s-vlan value.
Values: 0 to 4094
c-tag
Specifies the c-tag or c-vlan value.
Values: 0 to 4094
Output

The following output example shows a UP group and FSG lookup for a specific UP and Layer-2 access ID.

UP group and FSG lookup for a specific UP and Layer-2 access ID

/tools perform mobile-gateway pdn 1 bng up-resiliency lookup up "bng_east" l2-access-id "to_access"

-------------------------------------------------------------------------------
Up-Group                               : basic_access
Up-Id                                  : bng_east (192.0.2.11)
Admin-State                            : enabled
S-Vlan Range                           : N/A
C-Vlan Range                           : N/A
FSG Id                                 : 1
FSG Role                               : Active
Locked                                 : no
-------------------------------------------------------------------------------
No of Up-Groups : 1

sync

Syntax
  • sync fsg fsg-id
  • sync up-group group-name
Context
  • [Tree] tools perform mobile-gateway pdn bng up-resiliency sync
Description

This command manually triggers a synchronisation of the FSG state and all sessions to the active and standby UP of an FSG. It does not trigger a re-selection of active and standby UPs. If an FSG change is already ongoing when this command is executed, the tools command does not trigger any action.

This command can be used as a last resort in any case where the UPs and CPs are potentially out of sync and the system does not automatically triggers another FSG re-selection.

Parameters
fsg-id
Specifies the FSG ID to synchronize.
Values: 1 to 4294967295
group-name
Specifies the name of the UP group to synchronize, up to 32 characters.

bearer-context

Syntax
  • bearer-context {imsi | imei | msisdn} string [local-only] [apn apn] [slave]
Context
  • [Tree] tools perform mobile-gateway pdn force-clear bearer-context
Description

This command forcefully clears the bearer context for a specific UE. The system clears all sessions of the UE at the PDN level when the APN option is not used. To apply rate limiting, the system accepts only 16 commands in parallel and allows only one command per second to proceed internally for execution.

Caution: This command performs an exhaustive search of the UE identity on all the cards or VMs of the mobile gateway. Use this command only if necessary and as instructed by Nokia technical support.
Parameters
string
Specifies the value of the address string for the UE key (IMEI, IMSI, or MSISDN) used to locate the bearer context, up to 15 digits for IMSI or MSISDN or 16 digits for IMEI.
apn
Specifies the name of the APN, up to 80 characters; when used, only the UE sessions on this APN are cleared.
local-only
Keyword to specify an internal cleanup.
slave
Keyword to clear the standby system in an ICR deployment.

nf-register

Syntax
  • nf-register
Context
  • [Tree] tools perform mobile-gateway pdn nf-register
Description

This command triggers an NF registration message toward the NRF as SMF.

pfcp-audit

Syntax
  • pfcp-audit [remote-peer ip-address | ipv6-address]
Context
  • [Tree] tools perform mobile-gateway pdn pfcp-audit
Description

This command performs a PFCP audit for all PFCP paths or for the paths of a specified PFCP peer.

Parameters
ip-address | ipv6-address
Specifies the IPv4 or IPv6 address of a remote PFCP peer.
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

profile

Syntax
  • [no] profile profile-id
Context
  • [Tree] tools perform mobile-gateway profile
Description

Commands in this context execute profile performance management commands.

Parameters
profile-id
Specifies a profile number identifier.
Values: 0 to 255

authentication-database

Syntax
  • authentication-database name
Context
  • [Tree] tools perform mobile-gateway profile authentication-database
Description

Commands in this context execute the tool commands for the ADB.

Parameters
name
Specifies the name of the ADB, up to 32 characters.

lookup

Syntax
  • lookup [circuit-id-string string-id] [remote-id-string string-id] [circuit-id-hex hex-id] [remote-id-hex hex-id] [l2-access-id string-id] [up-ip ip-address] [username username] [c-vlan vlan-id] [s-vlan vlan-id] [vendor-class-string string-id] [vendor-class-hex hex-id] [apn apn-name] [imsi-mcc mcc value] [imsi-mnc mnc value] [imei-tac tac value] [up-group name] [up-group-derive] [up-node-id fqdn] [mac ieee-address] [client-id-string cid-string] [client-id-hex binary-cid] [source-ip ip-address] [s-nssai-sst sst value] [s-nssai-sd sd hexh string] [pdn-type pdn-type]
Context
  • [Tree] tools perform mobile-gateway profile authentication-database lookup
Description

This command performs a lookup action within the authentication-database with the specified parameters and displays the resulting entry name.

Parameters
circuit-id-string string-id
Specifies the circuit ID string filter, up to 64 characters.
remote-id-string string-id
Specifies the remote ID string filter, up to 64 characters.
circuit-id-hex hex-id
Specifies the circuit ID binary value filter.
Values: 0x0 to 0xFFFFFFFF...(max 128 hex nibbles)
remote-id-hex hex-id
Specifies the remote ID binary value filter.
Values: 0x0 to 0xFFFFFFFF...(max 128 hex nibbles)
l2-access-id string-id
Specifies the Layer 2 access ID filter, up to 64 characters.
up-ip ip-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

username
Specifies the PPP username filter, up to 253 characters.
c-vlan vlan-id
Specifies the customer VLAN (inner VLAN) filter.
Values: 1 to 4096
s-vlan vlan-id
Specifies the service VLAN (outer VLAN) filter.
Values: 1 to 4096
vendor-class-string string-id
Specifies the DHCP vendor class option ASCII string, up to 64 characters.
vendor-class-hex hex-id
Specifies the DHCP vendor class option hexadecimal string.
Values: 0x0 to 0xFFFFFFFF...(max 128 hex nibbles)
apn-name
Specifies the APN filter, up to 80 characters.
mcc value
Specifies the filter on the IMSI-based MCC value.
Values: 000 to 999 (three-digit number)
mnc value
Specifies the filter on the IMSI-based MNC value.
Values: 00 to 999 (two- or three-digit number)
tac value
Specifies the filter on the IMEI-based TAC value.
Values: eight-digit number
name
Specifies the UP group filter, up to 32 characters.
up-group-derive
Keyword to derive the UP group filter automatically based on the up-node-id, l2-access-id, and optionally s-vlan or c-vlan parameters. The parameter values are used to do a lookup in all configured UP groups, and the result is automatically used as if up-group was passed directly.
fqdn
Specifies the UP node ID filter, up to 255 characters.
ieee-address
Specifies the MAC address filter.
Values: xx:xx:xx:xx:xx:xx or xx-xx-xx-xx-xx-xx
cid-string
Specifies the client ID filter, up to 255 characters.
binary-cid
Specifies the binary client ID filter.
Values: 0x0 to 0xFFFFFFFF... (maximum of 510 hex nibbles)
source-ip ip-address
Specifies the source 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

sst value
Specifies the S-NSSAI SST filter.
Values: 0 to 255
sd hex string
Specifies the S-NSSAI SD filter.
Values: 000000 to FFFFFF
pdn-type
Specifies the PDN type filter.
Values: ipv4 | ipv6 | ipv4v6

bng

Syntax
  • bng
Context
  • [Tree] tools perform mobile-gateway profile bng
Description

Commands in this context execute the tool commands for BNG CUPS.

entry-point

Syntax
  • entry-point entry-point-name
Context
  • [Tree] tools perform mobile-gateway profile bng entry-point
Description

Commands in this context execute the tool commands for BNG CUPS entry points.

Parameters
entry-point-name
Specifies the name of the BNG entry point, up to 32 characters.

lookup

Syntax
  • lookup [l2-access-id string-64] [up-ip ip-address] [c-vlan vlan-id] [s-vlan vlan-id] [up-group name] [up-group-derive] [up-node-id fqdn]
Context
  • [Tree] tools perform mobile-gateway profile bng entry-point lookup
Description

This command performs a lookup action within the entry point with the specified parameters. It displays the matching entry name.

Parameters
string-64
Specifies the Layer 2 access ID filter, up to 64 characters.
ip-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

c-vlan vlan-id
Specifies the customer VLAN (inner VLAN) filter.
Values: 1 to 4096
s-vlan vlan-id
Specifies the service VLAN (outer VLAN) filter.
Values: 1 to 4096
name
Specifies the UP group filter, up to 32 characters.
up-group-derive
Keyword to derive the UP group filter automatically based on the up-node-id, l2-access-id, and optionally s-vlan or c-vlan parameters. The parameter values are used to do a lookup in all configured UP groups, and the result is automatically used as if up-group was passed directly.
fqdn
Specifies the UP node ID filter, up to 255 characters.

radius

Syntax
  • radius
Context
  • [Tree] tools perform mobile-gateway profile bng radius
Description

Commands in this context execute the tool commands for BNG CUPS RADIUS profiles.

coa

Syntax
  • coa
  • no coa
Context
  • [Tree] tools perform mobile-gateway profile bng radius coa
Description

This command creates a RADIUS CoA test action.

The action can send a CoA request to a specified destination using the following context. 
tools perform mobile-gateway profile bng radius coa deliver-request
The CoA request can be customized using the following the context.
tools perform mobile-gateway profile bng radius coa
For example, using the attribute command to include specific RADIUS attributes in the request.

The no form of this command removes the CoA test action.

attribute

Syntax
  • no attribute attribute-name
  • attribute attribute-name hex hex-string [tag tag-number]
  • attribute attribute-name ip-address ip-address | ipv6-address [tag tag-number]
  • attribute attribute-name ip-prefix ip-prefix/ip-prefix-length [tag tag-number]
  • attribute attribute-name mac-address ieee-address [tag tag-number]
  • attribute attribute-name number num [tag tag-number]
  • attribute attribute-name string ascii-string [tag tag-number]
Context
  • [Tree] tools perform mobile-gateway profile bng radius coa attribute
Description

This command adds an attribute to the CoA test message.

The no form of this command removes the specified attribute from the CoA test message.

Parameters
attribute-name
Specifies the name of a RADIUS attribute, must be a supported CoA attribute, up to 64 characters.
hex-string
Specifies a hexadecimal string.
Values: 0x0 to 0xFFFFFFFF...(max 506 hex nibbles)
tag-number
Specifies the RADIUS attribute tag.
Values: 1 to 31
ip-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

ip-prefix/ip-prefix-length
Specifies the IP prefix.
  • ipv4-prefix – a.b.c.d (host bits must be 0)
  • ipv4-prefix-length – 0 to 32
  • ipv6-prefix – x:x:x:x:x:x:x:x (eight 16-bit pieces)

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

    where

    x - [0..FFFF]H

    d - [0..255]D

  • ipv6-prefix-length – 0 to 128
ieee-address
Specifies the MAC address.
Values: xx:xx:xx:xx:xx:xx or xx-xx-xx-xx-xx-xx
num
Specifies a number.
Values: 0 to 4294967295
ascii-string
Specifies an ASCII string, up to 253 characters.

debug

Syntax
  • debug
  • no debug
Context
  • [Tree] tools perform mobile-gateway profile bng radius coa debug
Description

This command enables debugging for the CoA test.

The no form of this command disables the debugging.

deliver-request

Syntax
  • deliver-request
Context
  • [Tree] tools perform mobile-gateway profile bng radius coa deliver-request
Description

This command sends the CoA request.

destination-ip

Syntax
  • destination-ip ip-address | ipv6-address
  • no destination-ip
Context
  • [Tree] tools perform mobile-gateway profile bng radius coa destination-ip
Description

This command sets the destination IP address for the CoA request.

The no form of this command removes the destination IP address.

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

info

Syntax
  • info
Context
  • [Tree] tools perform mobile-gateway profile bng radius coa info
Description

This command displays the configuration of the CoA test message; for example, the router, the destination IP address, the attributes.

router

Syntax
  • no router
  • router router-instance
Context
  • [Tree] tools perform mobile-gateway profile bng radius coa router
Description

This command specifies the router instance to which the request is sent.

The no form of this command sets the router instance to Base.

Parameters
router-instance
Specifies the router instance.
Values: router-name | vprn-svc-id
  • router-name - Base | management
  • vprn-svc-id - 1 to 2147483647

source-ip

Syntax
  • no source-ip
  • source-ip ip-address | ipv6-address
Context
  • [Tree] tools perform mobile-gateway profile bng radius coa source-ip
Description

This command sets the source IP address for the CoA request.

The no form of this command sets the source IP address to [::]

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