configure mobile-gateway system command descriptions

system

Syntax

system number

Context

[Tree] configure mobile-gateway system

Description

This command enables the context to configure mobile gateway profiles.

Parameters

number: Specifies a profile number identifier.; Values: 0 to 255

bng

Syntax

bng

Context

[Tree] configure mobile-gateway system bng

Description

Commands in this context configure BNG system parameters.

queries

Syntax

queries

Context

[Tree] configure mobile-gateway system bng queries

Description

Commands in this context configure queries to retrieve YANG state information of MAG-c sessions and subscribers.

session

Syntax

session name
no session name

Context

[Tree] configure mobile-gateway system bng queries session

Description

This command configures a query to retrieve YANG state information of MAG-c sessions.

The no form of this command removes the specified session query.

Parameters

name: Specifies the name of the session query, up to 32 characters.

acct-multi-session-id

Syntax

acct-multi-session-id identifier
no acct-multi-session-id

Context

[Tree] configure mobile-gateway system bng queries session acct-multi-session-id

Description

This command configures the accounting multi-session ID.

The no form of this command removes the configuration.

Default

no acct-multi-session-id

Parameters

identifier: Specifies the accounting multi-session ID, up to 25 characters.

acct-session-id

Syntax

acct-session-id identifier
no acct-session-id

Context

[Tree] configure mobile-gateway system bng queries session acct-session-id

Description

This command configures the accounting session ID.

The no form of this command removes the configuration.

Default

no acct-session-id

Parameters

identifier: Specifies the accounting session ID, up to 25 characters.

apn

Syntax

apn name
no apn

Context

[Tree] configure mobile-gateway system bng queries session apn

Description

This command configures the APN.

The no form of this command removes the configuration.

Default

no apn

Parameters

name: Specifies the APN name, up to 80 characters.

c-vlan

Syntax

c-vlan tag
no c-vlan

Context

[Tree] configure mobile-gateway system bng queries session c-vlan

Description

This command configures the customer VLAN (inner VLAN).

The no form of this command removes the configuration.

Default

no c-vlan

Parameters

tag: Specifies the customer VLAN tag.; Values: 0 to 4094

circuit-id

Syntax

circuit-id string cid-string
circuit-id hex binary cid
no circuit-id

Context

[Tree] configure mobile-gateway system bng queries session circuit-id

Description

This command configures the circuit ID.

The no form of this command removes the configuration.

Default

no circuit-id

Parameters

cid-string: Specifies the circuit ID string, up to 255 characters.
binary cid: Specifies the binary value of the circuit ID.; Values: 0x0 to 0xFFFFFFFF... (maximum 510 hex nibbles)

client-user-name

Syntax

client-user-name string
no client-user-name

Context

[Tree] configure mobile-gateway system bng queries session client-user-name

Description

This command configures the username of the client.

The no form of this command removes the configuration.

Default

no client-user-name

Parameters

string: Specifies the client username, up to 253 characters.

client-user-name-domain

Syntax

client-user-name-domain string
no client-user-name-domain

Context

[Tree] configure mobile-gateway system bng queries session client-user-name-domain

Description

This command configures the username domain of the client.

The no form of this command removes the configuration.

Default

no client-user-name-domain

Parameters

string: Specifies the username domain, up to 128 characters.

description

Syntax

description description-string
no description

Context

[Tree] configure mobile-gateway system bng queries session description

Description

This command configures a description for the session query.

The no form of this command removes the description.

Default

no description

Parameters

description-string: Specifies the description of the session query, up to 80 characters.

fate-sharing-group-id

imei

Syntax

imei number
no imei

Context

[Tree] configure mobile-gateway system bng queries session imei

Description

This command configures the IMEI.

The no form of this command removes the configuration.

Default

no imei

Parameters

number: Specifies the IMEI in 15 or 16 digits.

imsi

Syntax

imsi number
no imsi

Context

[Tree] configure mobile-gateway system bng queries session imsi

Description

This command configures the IMSI.

The no form of this command removes the configuration.

Default

no imsi

Parameters

number: Specifies the IMSI in 10 to 15 digits.

ip

Syntax

ip

Context

[Tree] configure mobile-gateway system bng queries session ip

Description

Commands in this context configure the IP match criteria.

address-stacks

Syntax

address-stacks

Context

[Tree] configure mobile-gateway system bng queries session ip address-stacks

Description

Commands in this context configure the address stack match criteria.

ipv4

Syntax

ipv4 {false | true}
no ipv4

Context

[Tree] configure mobile-gateway system bng queries session ip address-stacks ipv4

Description

This command configures the IPv4 address stack criterion.

When configured to true, IPv4 sessions are included in the query.

When configured to false, IPv4 sessions are excluded in the query.

The no form of this command removes the IPv4 address stack criterion.

Default

no ipv4

ipv6-na

Syntax

ipv6-na {false | true}
no ipv6-na

Context

[Tree] configure mobile-gateway system bng queries session ip address-stacks ipv6-na

Description

This command configures the IPv6 NA address stack criterion.

When configured to true, IPv6 NA sessions are included in the query.

When configured to false, IPv6 NA sessions are excluded in the query.

The no form of this command removes the IPv6 NA address stack criterion.

Default

no ipv6-na

ipv6-pd

Syntax

ipv6-pd {false | true}
no ipv6-pd

Context

[Tree] configure mobile-gateway system bng queries session ip address-stacks ipv6-pd

Description

This command configures the IPv6 PD address stack criterion.

When configured to true, IPv6 PD sessions are included in the query.

When configured to false, IPv6 PD sessions are excluded in the query.

The no form of this command removes the IPv6 PD address stack criterion.

Default

no ipv6-pd

ipv6-slaac

Syntax

ipv6-slaac {false | true}
no ipv6-slaac

Context

[Tree] configure mobile-gateway system bng queries session ip address-stacks ipv6-slaac

Description

This command configures the IPv6 SLAAC address stack criterion.

When configured to true, IPv6 SLAAC sessions are included in the query.

When configured to false, IPv6 SLAAC sessions are excluded in the query.

The no form of this command removes the IPv6 SLAAC address stack criterion.

Default

no ipv6-slaac

prefix

Syntax

prefix ip-prefix/prefix-length
no prefix

Context

[Tree] configure mobile-gateway system bng queries session ip prefix

Description

This command configures the IP prefix and IP prefix length.

The no form of this command removes the configuration.

Default

no prefix

Parameters

ip-prefix

Specifies the IP address prefix.

Values:

IPv4: a.b.c.d, host bits must be 0
IPv6: 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

prefix-length

Specifies the IP prefix length.

Values:

IPv4: 0 to 32
IPv6: 0 to 128

l2-access-id

Syntax

l2-access-id string
no l2-access-id

Context

[Tree] configure mobile-gateway system bng queries session l2-access-id

Description

This command configures the Layer 2 access ID.

The no form of this command removes the configuration.

Default

no l2-access-id

Parameters

string: Specifies the L2 access ID, up to 64 characters.

mac-address

Syntax

mac-address ieee-address
no mac-address

Context

[Tree] configure mobile-gateway system bng queries session mac-address

Description

This command configures the MAC address.

The no form of this command removes the configuration.

Default

no mac-address

Parameters

ieee-address: Specifies the MAC address.; Values: xx:xx:xx:xx:xx:xx or xx-xx-xx-xx-xx-xx

msisdn

Syntax

msisdn number
no msisdn

Context

[Tree] configure mobile-gateway system bng queries session msisdn

Description

This command configures the MSISDN.

The no form of this command removes the configuration.

Default

no msisdn

Parameters

number: Specifies the MSISDN in 9 to 15 digits.

nat-profile

Syntax

nat-profile name
no nat-profile

Context

[Tree] configure mobile-gateway system bng queries session nat-profile

Description

This command configures the NAT profile name.

The no form of this command removes the configuration.

Default

no nat-profile

Parameters

name: Specifies the profile name, up to 32 characters.

network-realm

Syntax

network-realm name
no network-realm

Context

[Tree] configure mobile-gateway system bng queries session network-realm

Description

This command configures the name of the associated network realm.

The no form of this command removes the configuration.

Default

no network-realm

Parameters

name: Specifies the network realm name, up to 80 characters.

output-options

Syntax

output-options
no output-options

Context

[Tree] configure mobile-gateway system bng queries session output-options

Description

Commands in this context configure what information to include in the output.

The no form of this command removes the configuration.

Default

no output-options

charging

Syntax

charging [detailed-stats] [fetch-upf]
no charging

Context

[Tree] configure mobile-gateway system bng queries session output-options charging

Description

This command configures the charging information to display in the output.

The no form of this command removes the configuration.

Default

no charging

Parameters

detailed-stats: Displays the detailed charging statistics.
fetch-upf: Fetches the latest statistics from the BNG-UP.

count

Syntax

count
no count

Context

[Tree] configure mobile-gateway system bng queries session output-options count

Description

This command displays only the number of matching sessions without any additional data.

The no form of this command removes the configuration.

Default

no count

nat

Syntax

nat
no nat

Context

[Tree] configure mobile-gateway system bng queries session output-options nat

Description

This command displays information about the NAT pool of the CP NAT profile and the outside routing context for the sessions.

The no form of this command removes the configuration.

Default

no nat

pfcp

Syntax

pfcp

Context

[Tree] configure mobile-gateway system bng queries session pfcp

Description

Commands in this context configure the PFCP match criteria.

local-seid

Syntax

local-seid binary seid
no local-seid

Context

[Tree] configure mobile-gateway system bng queries session pfcp local-seid

Description

This command configures the PFCP local session ID.

The no form of this command removes the configuration.

Default

no local-seid

Parameters

binary seid: Specifies the local session ID.; Values: 0xFFFF... (exact 16 hex nibbles)

remote-seid

Syntax

remote-seid binary reid
no remote-seid

Context

[Tree] configure mobile-gateway system bng queries session pfcp remote-seid

Description

This command configures the PFCP remote session ID.

The no form of this command removes the configuration.

Default

no remote-seid

Parameters

binary reid: Specifies the remote session ID.; Values: 0xFFFF... (exact 16 hex nibbles)

remote-id

Syntax

remote-id string rid-string
remote-id hex binary rid
no remote-id

Context

[Tree] configure mobile-gateway system bng queries session remote-id

Description

This command configures the remote ID.

The no form of this command removes the configuration.

Default

no remote-id

Parameters

rid-string: Specifies the remote ID string, up to 255 characters.; Values: 0xFFFF... (exact 16 hex nibbles)
binary rid: Specifies the binary value for the remote ID.; Values: 0x0 to 0xFFFFFFFF... (maximum 510 hex nibbles)]

s-vlan

Syntax

s-vlan tag
no s-vlan

Context

[Tree] configure mobile-gateway system bng queries session s-vlan

Description

This command configures the service VLAN (outer VLAN).

The no form of this command removes the configuration.

Default

no s-vlan

Parameters

tag: Specifies the service VLAN tag.; Values: 0 to 4094

subscriber-name

Syntax

subscriber-name name
no subscriber-name

Context

[Tree] configure mobile-gateway system bng queries session subscriber-name

Description

This command configures the subscriber name.

The no form of this command removes the configuration.

Default

no subscriber-name

Parameters

name: Specifies the subscriber name, up to 128 characters.

up-ip

Syntax

up-ip ip-address | ipv6-address
no up-ip

Context

[Tree] configure mobile-gateway system bng queries session up-ip

Description

This command configures the UP IP address.

The no form of this command removes the configuration.

Default

no up-ip

Parameters

ip-address

Specifies the UP IPv4 address.

Values: a.b.c.d

ipv6-address

Specifies the UP IPv6 address.

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

user-access-type

Syntax

user-access-type access-type
no user-access-type

Context

[Tree] configure mobile-gateway system bng queries session user-access-type

Description

This command configures the user access type.

The no form of this command removes the configuration.

Default

no user-access-type

Parameters

access-type: Specifies the user access type.; Values: any | ipoe | pppoe | fixed-wireless-access

wpp-portal-group

Syntax

wpp-portal-group name
no wpp-portal-group

Context

[Tree] configure mobile-gateway system bng queries session wpp-portal-group

Description

This command configures the WPP portal group name.

The no form of this command removes the configuration.

Default

no wpp-portal-group

Parameters

name: Specifies the portal group name, up to 32 characters.

subscriber

Syntax

subscriber name
no subscriber name

Context

[Tree] configure mobile-gateway system bng queries subscriber

Description

This command configures a query to retrieve YANG state information of MAG-c subscribers.

The no form of this command removes the specified subscriber query.

Default

no subscriber

Parameters

name: Specifies the name of the subscriber query, up to 32 characters.

acct-session-id

Syntax

acct-session-id identifier
no acct-session-id

Context

[Tree] configure mobile-gateway system bng queries subscriber acct-session-id

Description

This command configures the accounting session ID.

The no form of this command removes the configuration.

Default

no acct-session-id

Parameters

identifier: Specifies the accounting session ID, up to 25 characters.

apn

Syntax

apn name
no apn

Context

[Tree] configure mobile-gateway system bng queries subscriber apn

Description

This command configures the APN.

The no form of this command removes the configuration.

Default

no apn

Parameters

name: Specifies the APN name, up to 80 characters.

description

Syntax

description description-string
no description

Context

[Tree] configure mobile-gateway system bng queries subscriber description

Description

This command configures a description for the subscriber query.

The no form of this command removes the description.

Default

no description

Parameters

description-string: Specifies the description, up to 80 characters.

fate-sharing-group-id

l2-access-id

Syntax

l2-access-id string
no l2-access-id

Context

[Tree] configure mobile-gateway system bng queries subscriber l2-access-id

Description

This command configures the Layer 2 access ID.

The no form of this command removes the configuration.

Default

no l2-access-id

Parameters

string: Specifies the L2 access ID, up to 64 characters.

network-realm

Syntax

network-realm name
no network-realm

Context

[Tree] configure mobile-gateway system bng queries subscriber network-realm

Description

This command configures the name of the associated network realm.

The no form of this command removes the configuration.

Default

no network-realm

Parameters

name: Specifies the network realm name, up to 80 characters.

output-options

Syntax

output-options
no output-options

Context

[Tree] configure mobile-gateway system bng queries subscriber output-options

Description

Commands in this context configure the information to include in the output.

The no form of this command removes the configuration.

Default

no output-options

charging

Syntax

charging {detailed-stats] [fetch-upf]
no charging

Context

[Tree] configure mobile-gateway system bng queries subscriber output-options charging

Description

This command configures what charging information to display in the output.

The no form of this command removes the configuration.

Default

no charging

Parameters

detailed-stats: Displays the detailed charging statistics.
fetch-upf: Fetches the latest statistics from the BNG-UP.

count

Syntax

count
no count

Context

[Tree] configure mobile-gateway system bng queries subscriber output-options count

Description

This command displays only the number of matching sessions without any further data.

The no form of this command removes the configuration.

Default

no count

nat

Syntax

nat
no nat

Context

[Tree] configure mobile-gateway system bng queries subscriber output-options nat

Description

This command displays information about the NAT pool of the CP NAT profile and the outside routing context for the sessions.

The no form of this command removes the configuration.

Default

no nat

subscriber-id

Syntax

subscriber-id identifier
no subscriber-id

Context

[Tree] configure mobile-gateway system bng queries subscriber subscriber-id

Description

This command configures the subscriber ID.

The no form of this command removes the configuration.

Default

no subscriber-id

Parameters

identifier: Specifies the ID.; Values: 1 to 4294967295

subscriber-name

Syntax

subscriber-name name
no subscriber-name

Context

[Tree] configure mobile-gateway system bng queries subscriber subscriber-name

Description

This command configures the subscriber name.

The no form of this command removes the configuration.

Default

no subscriber-name

Parameters

name: Specifies the name, up to 128 characters.

up-ip

Syntax

up-ip ip-address | ipv6-address
no up-ip

Context

[Tree] configure mobile-gateway system bng queries subscriber up-ip

Description

This command configures the UP IPv4 or IPv6 address.

The no form of this command removes the configuration.

Default

no up-ip

Parameters

ip-address

Specifies the UP IPv4 address.

Values: a.b.c.d

ipv6-address

Specifies the UP IPv6 address.

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

call-insight

Syntax

call-insight

Context

[Tree] configure mobile-gateway system call-insight

Description

This command enables the context to configure global call trace settings.

location

Syntax

location location

Context

[Tree] configure mobile-gateway system call-insight location

Description

This command configures the location of the Compact Flash (CF) call trace storage.

Parameters

location: Specifies the location of the call trace storage.; Values: cf1 | cf2; Default: cf1

disable

Syntax

[no] disable

Context

[Tree] configure mobile-gateway system call-insight location disable

Description

This command enables or disables the specified storage location for call trace files.

Default

no disable

limit

Syntax

limit limit
no limit

Context

[Tree] configure mobile-gateway system call-insight location limit

Description

This command limits the total captured call trace files size per CF.

Parameters

limit: Specifies the total captured call trace files size in megabytes.; Values: 0 to 65536 (0 means unlimited); Default: 1000

primary

Syntax

[no] primary

Context

[Tree] configure mobile-gateway system call-insight location primary

Description

This command sets the primary CF. The other CF is automatically set to be secondary.

max-files-number

Syntax

max-files-number max-files-number
no max-files-number

Context

[Tree] configure mobile-gateway system call-insight max-files-number

Description

This command configures the maximum number of files for call trace output.

Parameters

max-files-number: Specifies the maximum call trace files.; Values: 0 to 1024; Default: 200

group

Syntax

group group-number [resource-pool resource-pool-id]
no group group-number

Context

[Tree] configure mobile-gateway system group

Description

This command configures the mobile-gateway system group with one or more SM-VMs for N:K redundant systems.

The no form of this command removes the specified group row entry, when the group is in shutdown.

Note: The resource pool must be configured before configuring the system group; see the resource-pool command.

Parameters

group-number: Specifies a mobile-gateway system group.; Values: 1 to 15
resource-pool-id: Specifies the ID of the resource pool.; Values: 1 to 4
Note: Configure the resource pool before the mobile-gateway system group; see the resource-pool command.

protect-active-delay

Syntax

protect-active-delay protect-active-delay

Context

[Tree] configure mobile-gateway system group protect-active-delay

Description

This command specifies the time to wait for the working card to come online before a standby card becomes active.

Parameters

protect-active-delay: Specifies the wait time in seconds.; Values: 1 to 30; Default: 10

shutdown

Syntax

[no] shutdown

Context

[Tree] configure mobile-gateway system group 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 shutdown command administratively disables an entity. 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.

resource-pool

Syntax

resource-pool resource-pool-id redundancy type gateway gw-id
no resource-pool resource-pool-id

Context

[Tree] configure mobile-gateway system resource-pool

Description

This command configures a resource pool consisting of SM-VMs on the MAG-c platform and the redundancy method to use when the resource pool is associated with a mobile-gateway system group. Currently this command supports configuration of N:K (many-to-many) redundant systems. The resource pool must also be associated with a mobile-gateway system group when configuring N:K redundancy. For more details, see the group command.

Note: For N:K redundant systems, this configuration includes all VMs (cards) to be used across multiple mobile-gateway system groups. The cards in this context must not be configured as active (working) or standby (protect); see the card command.

Parameters

resource-pool-id: Specifies the ID of the resource pool.; Values: 1 to 4
type: Specifies the redundancy method.; Values: many-to-many
gw-id: Specifies the ID of the mobile gateway to which the resource pool belongs.; Values: 1 to 8

card

Syntax

card slot-number
no card slot-number

Context

[Tree] configure mobile-gateway system resource-pool card

Description

This command configures the VM, for the mobile-gateway system group or resource pool contexts. Depending on the failure scenario, either VM can be in an active or standby state.

Note: An N:K redundant system does not use an active (working) or a standby (protect) VM. These undocumented parameters are present because of legacy reasons and must not be configured.

Parameters

slot-number: Specifies the VM slot number.; Values: 1 to 20

protect-active-delay

Syntax

protect-active-delay

Context

[Tree] configure mobile-gateway system resource-pool protect-active-delay

Description

No description found

thresholds

Syntax

thresholds

Context

[Tree] configure mobile-gateway system thresholds

Description

This command enables the context to configure monitoring thresholds.

system-mg-ism

Syntax

system-mg-ism group-number
no system-mg-ism

Context

[Tree] configure mobile-gateway system thresholds system-mg-ism

Description

This command configures monitoring thresholds for ISM-MG (SM-VM).

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

Parameters

group-number: Specifies group number.; Values: 1 to 8

interval

Syntax

interval minutes

Context

[Tree] configure mobile-gateway system thresholds system-mg-ism interval

Description

This command configures the interval values for ISM-MG.

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

Parameters

minutes: Specifies group number.; Values: 5 to 60; Default: 5

shutdown

Syntax

[no] shutdown

Context

[Tree] configure mobile-gateway system thresholds system-mg-ism 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 shutdown command administratively disables an entity. 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.