configure mobile-gateway profile bng command descriptions

Context

• [Tree] configure mobile-gateway profile bng

Description

This command enables the context for configuring BNG parameters.

Default

bng

Context

• [Tree] configure mobile-gateway profile bng cp-nat-profile

Description

This command configures a BNG CUPS CP NAT profile. A CP NAT profile is a container for NAT specific parameters and is used to associate IPoE and PPPoE sessions with NAT.

The no form of this command removes the configuration.

Parameters

name

specifies the CP NAT profile name, up to 32 characters

Context

• [Tree] configure mobile-gateway profile bng cp-nat-profile 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 description from the configuration.

Default

no description

Parameters

description-string

Specifies 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 profile bng cp-nat-profile nat-access-mode

Description

No description found

Context

• [Tree] configure mobile-gateway profile bng cp-nat-profile nat-pool

Description

This command configures a NAT pool. A NAT pool is container that holds NAT parameters primarily concerned with outside IP addresses, port ranges, NAT mode of operation within the pool (1:1 or NAPT) and location (routing context) of the pool.

The no form of this command removes the configuration.

Parameters

pool-name

specifies the NAT pool name, up to 32 characters

Context

• [Tree] configure mobile-gateway profile bng cp-nat-profile nat-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 description from the configuration.

Default

no description

Parameters

description-string

Specifies 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 profile bng cp-nat-profile nat-pool laa-pool

Description

This command configures the local address assignment (LAA) pool for the NAT pool. The LAA pool determines the NAT prefixes from which an outside IP address and port block are selected in the configured NAT pool. The outside NAT prefix is installed in the outside routing context specified by the network-realm.

The no form of this command removes the configuration.

Parameters

reference

specifies the outside routing context for NAT; points to an existing network-realm; up to 80 characters

pool-name

specifies the name of an existing LAA pool; the NAT outside prefixes are defined in the configure mobile-gateway pdn local-address-assignment context

Context

• [Tree] configure mobile-gateway profile bng cp-nat-profile nat-pool mode

Description

This command configures the NAT mode of operation. The two modes are mutually exclusive in the same NAT pool.

Default

mode napt

Parameters

nat-mode

specifies the NAT mode

Values	one-to-one | napt
	one-to-one	inside and outside IP addresses are translated in 1:1 fashion; no port translation
	napt	each inside IP address is translated into an outside IP address and a port block range; allows sharing of the same outside IP address by multiple subscribers

Context

• [Tree] configure mobile-gateway profile bng cp-nat-profile nat-pool mode port-forwarding-range

Description

This command configures the end port of the shared port forwarding range.

Parameters

range-end

Specifies the end port of the port forwarding range.

Values: 1023 to 65535

Context

• [Tree] configure mobile-gateway profile bng cp-nat-profile nat-pool mode port-limits

Description

Commands in this context configure the forwarding of ports for a NAT session.

Context

• [Tree] configure mobile-gateway profile bng cp-nat-profile nat-pool mode port-limits forwarding

Description

This command configures the maximum number of ports that can be forwarded for a NAT session.

Parameters

limit

Specifies the maximum number of ports that can be forwarded for a NAT session.

Values: 1 to 64

Context

• [Tree] configure mobile-gateway profile bng cp-nat-profile nat-pool mode port-reservation

Description

This command configures the size of the port block. The port block size can be configured explicitly by specifying the number of ports in each port block, or implicitly by specifying the number of port ranges per outside IP address. This command can be configured only when the NAT mode equals NAPT.

Default

port-reservation ports 128

Parameters

ports-per-block

Specifies the number of ports per port block.

Values: 1 to 32256

num-block

Specifies the number of port blocks per outside IP address.

Values: 1 to 64512

Context

• [Tree] configure mobile-gateway profile bng cp-nat-profile nat-pool mode subscriber-limit

Description

This command specifies the maximum number of subscribers permitted per outside IP address. When the port-block extensions for a NAT subscriber are enabled, the port space for an outside IP address is divided as follows:

1. First is the well-known port range.
2. Following the well-known port range is the static port forwarding range, which is enabled by configuration.
3. Next is the port range reserved for the first (initial) port blocks of each subscriber. The configured number of NAT subscribers per an outside IP address multiplied by the configured size of the first (initial) port-block determines the size of the port partition reserved for initial port-blocks.
4. The final section of the port space is reserved for extended port blocks based on whatever is left after the previous three port ranges. The port partition reserved for extended port blocks begins at the end of the port partition reserved for the initial port blocks until the end of the ports space (port 65535).

Default

no subscriber-limit

Parameters

subscriber-limit

Specifies the maximum number of subscribers per outside IP address.

Values: 2 to 2000

Context

• [Tree] configure mobile-gateway profile bng cp-nat-profile nat-pool up-nat-policy

Description

This command references an existing up-nat-policy which is configured on the BNG-UP. The up-nat-policy defines NAT parameters associated with the subscribers, such as ALGs and protocol timers.

Default

no up-nat-policy

Parameters

name

specifies the name of the up-nat-policy defined on the BNG-UP; up to 32 characters

Context

• [Tree] configure mobile-gateway profile bng dhcp-profile

Description

This command configures a DHCP protocol profile.

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 profile bng dhcp-profile 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 description from the configuration.

Default

no description

Parameters

description-string

Specifies 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 profile bng dhcp-profile options

Description

This command enables the context for configuring options to include in DHCP messages that are sent toward a DHCP client.

Default

options

Context

• [Tree] configure mobile-gateway profile bng dhcp-profile options option

Description

This command configures the specified option. Specific option numbers cannot be set because they are controlled by the application. If for specific options (for example, DNS) specific per-session overrides exist, those overrides are signaled, and only the remaining DHCP profile options are signaled.

The no form of this command removes the configuration.

Parameters

option-number

specifies the action that is applied to a match

Values: 1 to 254

ip-address

specifies the IPv4 address, up to four IPv4 addresses can be specified

Values: a.b.c.d

ascii-string

specifies the ascii string, up to 127 characters

hex-string

specifies the hex value

Values: 0x0 to 0xFFFFFFFF (maximum of 254 hex nibbles)

Context

• [Tree] configure mobile-gateway profile bng dhcpv6-profile

Description

This command configures a DHCPv6 protocol profile.

The no form of this command removes the profile.

Parameters

name

specifies the DHCPv6 profile name, up to 32 characters

Context

• [Tree] configure mobile-gateway profile bng dhcpv6-profile 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 description from the configuration.

Default

no description

Parameters

description-string

Specifies 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 profile bng dhcpv6-profile options

Description

This command enables the context to configure the options to be included in the DHCPv6 messages that are sent to a DHCPv6 client.

Default

options

Context

• [Tree] configure mobile-gateway profile bng dhcpv6-profile options option

Description

This command configures a specific DHCPv6 option to be included in the DHCPv6 message with the specified content. If no content is provided the option is included as an empty option. This can be used to signal a flag to the client.

The no form of this command removes the option from the profile.

Parameters

option-number

identifies the number of the option

Values: 6 to 8 | 10 to 11 | 14 to 17 | 19 to 43 | 49 to 65535

ipv6-address

specifies the IPv6 address to be included in the option; up to four IPv6 addresses can be specified; addresses are sent in the order they are specified

Values: up to 64 characters

ascii-string

specifies the ASCII string

Values: up to 127 characters

hex-string

specifies the exact byte contents of the option as a hexadecimal string

Values: 0x0 to 0xFFFFFFFF... (maximum of 254 hex nibbles)

Context

• [Tree] configure mobile-gateway profile bng entry-point

Description

This command configures a BNG entry point or enters an existing BNG entry point. The entry point is the starting point of authentication process.

The no form of this command removes the configuration.

Parameters

name

specifies the BNG entry point name, up to 32 characters

Context

• [Tree] configure mobile-gateway profile bng entry-point 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 description from the configuration.

Default

no description

Parameters

description-string

Specifies 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 profile bng entry-point entry

Description

The no form of this command removes the configuration.

Parameters

name

specifies the BNG entry name, up to 32 characters

Context

• [Tree] configure mobile-gateway profile bng entry-point entry 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 description from the configuration.

Default

no description

Parameters

description-string

Specifies 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 profile bng entry-point entry ipoe

Description

This command enables the context for configuring IPoE parameters of the entry point entry.

Default

ipoe

Context

• [Tree] configure mobile-gateway profile bng entry-point entry ipoe authentication-flow

Description

This command enables the IPoE authentication flow context of the entry point entry.

Default

authentication-flow

Context

• [Tree] configure mobile-gateway profile bng entry-point entry ipoe authentication-flow adb

Description

This command configures the IPoE authentication flow that the system looks up in the specified authentication-databases; using the specified order for authenticating the IPoE session.

The no form of this command removes the configuration.

Parameters

adb-name

specifies from one to three ADB names, up to 32 characters each

Context

• [Tree] configure mobile-gateway profile bng entry-point entry ipoe ipoe-profile

Description

This command configures the IPoE profile that is used for creating new IPoE session.

The no form of this command removes the configuration.

Default

no ipoe-profile

Parameters

name

specifies the IPoE name, up to 32 characters

Context

• [Tree] configure mobile-gateway profile bng entry-point entry match

Description

Commands in this context configure the match attribute values for the entry.

Context

• [Tree] configure mobile-gateway profile bng entry-point entry match l2-access-id

Description

This command configures the value of the Layer 2 access ID that the entry-point entry expects to match when system matches the session to the entry. The value specified can be either an exact match or a partial match if the string-mask is configured in the entry-point match configuration.

The no form of this command removes the configuration.

Default

no l2-access-id

Parameters

string

specifies the Layer 2 access ID name, up to 64 characters

Context

• [Tree] configure mobile-gateway profile bng entry-point entry match up-group

Description

configure mobile-gateway profile bng entry-point match string-mask

configure mobile-gateway pdn bng up-group

The no form of this command removes the configuration.

Default

no up-group

Parameters

name

Specifies the UP group name, up to 32 characters.

Context

• [Tree] configure mobile-gateway profile bng entry-point entry match up-ip

Description

This command configures the value of the UP IP address that the entry-point entry expects to match when system matches the session to the entry.

The no form of this command removes the configuration.

Default

no up-ip

Parameters

ip-address

specifies the UP IP address

Values	ipv4-address	a.b.c.d
	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

Context

• [Tree] configure mobile-gateway profile bng entry-point entry match up-node-id

Description

configure mobile-gateway profile bng entry-point match string-mask

The no form of this command removes the configuration.

Default

no up-node-id

Parameters

node-id

Specifies the UP node ID as an IP address or a name, up to 255 characters.

Context

• [Tree] configure mobile-gateway profile bng entry-point entry match vlan

Description

This command enables the VLAN configuration context that the entry-point entry expects to match when system matches the session to the entry.

The no form of this command disables the VLAN configuration context.

Default

vlan

Context

• [Tree] configure mobile-gateway profile bng entry-point entry match vlan c-vlan

Description

This command configures a customer VLAN (inner VLAN) range for matching the entry-point entry. If the customer VLAN of a trigger packet falls within the specified range, a match occurs.

The no form of this command removes the configuration.

Default

no c-vlan

Parameters

start tag

specifies the start of the inner VLAN range

Values: 1 to 4096

end tag

specifies the end of the inner VLAN range

Values: 1 to 4096

Context

• [Tree] configure mobile-gateway profile bng entry-point entry match vlan s-vlan

Description

This command configures a service VLAN (outer VLAN) range for matching the entry-point entry. If the customer VLAN of a trigger packet falls within the specified range, a match occurs.

The no form of this command removes the configuration.

Default

no s-vlan

Parameters

start tag

specifies the start of the outer VLAN range

Values: 1 to 4096

end tag

specifies the end of the outer VLAN range

Values: 1 to 4096

Context

• [Tree] configure mobile-gateway profile bng entry-point entry multiple-sessions-per-mac

Description

This command configures a maximum limit for the number of session per MAC address and a discriminator to differentiate between different sessions from same MAC address.

The no form of this command removes the configuration and disallows multiple sessions per MAC address.

Default

no multiple-sessions-per-mac

Parameters

number

specifies the maximum number of sessions per MAC address

Values: 2 to 8191

attribute

specifies a discriminator for distinguishing between different sessions on the same MAC address

Values: circuit-id | remote-id

Context

• [Tree] configure mobile-gateway profile bng entry-point entry pppoe

Description

This command enables the context for configuring a PPPoE related configuration for the entry-point entry.

Default

pppoe

Context

• [Tree] configure mobile-gateway profile bng entry-point entry pppoe authentication-flow

Description

This command enables the context for configuring PPPoE authentication flow for the entry-point entry.

Default

authentication-flow

Context

• [Tree] configure mobile-gateway profile bng entry-point entry pppoe authentication-flow padi-adb

Description

This command configures the PPPoE PADI authentication flow that the system looks up in the specified authentication-databases; using the specified order upon receiving a PPPoE PADI packet.

The no form of this command removes the configuration.

Default

no padi-adb

Parameters

adb-name

specifies the ADB name, up to 32 characters, up to three ADB names can be specified

Context

• [Tree] configure mobile-gateway profile bng entry-point entry pppoe authentication-flow pap-chap-adb

Description

This command configures the PPPoE PAP/CHAP authentication flow that the system looks up in the specified authentication-databases; using the specified order for PPPoE PAP/CHAP authentication.

The no form of this command removes the configuration.

Default

no pap-chap-adb

Parameters

adb-name

specifies the ADB name, up to 32 characters; up to three ADB names can be specified

Context

• [Tree] configure mobile-gateway profile bng entry-point entry pppoe pppoe-profile

Description

This command configures the PPPoE profile.

The no form of this command removes the configuration.

Default

no pppoe-profile

Parameters

name

specifies the PPPOE profile name, up to 32 characters

Context

• [Tree] configure mobile-gateway profile bng entry-point entry pppoe session-id

Description

This command enables the context for configuring a PPPoE session ID for the entry-point entry.

Default

session-id

Context

• [Tree] configure mobile-gateway profile bng entry-point entry pppoe session-id allocation-scope

Description

This command configures the PPPoE session ID allocation scope. The allocated PPPoE session ID is unique within the specified scope.

The no form of this command removes the configuration.

Default

allocation-scope l2-circuit-mac

Parameters

scope

specifies the PPPoE session ID allocation scope type

Values: l2-circuit | l2-circuit-mac

Context

• [Tree] configure mobile-gateway profile bng entry-point entry pppoe session-id random

Description

This command configures the system to allocate PPPoE session IDs randomly within the specified scope.

The no form of this command configures the system to allocate PPPoE session IDs incrementally.

Default

no random

Context

• [Tree] configure mobile-gateway profile bng entry-point entry python-policy

Description

This command configures a Python policy for access protocols like PPPoE.

Default

no python-policy

Parameters

policy-name

Specifies the policy name, up to 32 characters.

Context

• [Tree] configure mobile-gateway profile bng entry-point entry session-limits

Description

This command enables the context to configure the maximum number of sessions within a specific scope.

Context

• [Tree] configure mobile-gateway profile bng entry-point entry session-limits per-l2-access-id

Description

This command configures the maximum number of sessions for each learned Layer 2 access ID.

Default

per-l2-access-id infinite

Parameters

number

specifies the maximum number of sessions

Values: 1 to 1048576

infinite

specifies that there is no limit for the number of sessions

Context

• [Tree] configure mobile-gateway profile bng entry-point entry session-limits per-l2-circuit

Description

This command configures the maximum number of sessions for each learned Layer 2 circuit.

Default

per-l2-circuit infinite

Parameters

number

specifies the maximum number of sessions

Values: 1 to 1048576

infinite

specifies that there is no limit for the number of sessions

Context

• [Tree] configure mobile-gateway profile bng entry-point entry session-lockout-profile

Description

This command references a session lockout profile. Session lockout is enabled for the sessions that match this BNG EP entry. The session-lockout-profile command in the configure mobile-gateway profile bng context specifies the session lockout profile.

The no form of this command removes the session lockout profile from the BNG EP entry. Session lockout is disabled for the sessions that match this BNG EP entry.

Default

no session-lockout-profile

Parameters

profile-name

specifies the name of the session lockout profile, up to 32 characters

Context

• [Tree] configure mobile-gateway profile bng entry-point entry 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 profile bng entry-point entry subscriber-identification

Description

This command configures how to identify a subscriber.

Default

subscriber-identification per-session

Parameters

per-session

specifies that every session is a different subscriber

multi-session

specifies that a subscriber could contain multiple sessions, according to the multi-session-key configuration

Context

• [Tree] configure mobile-gateway profile bng entry-point entry subscriber-identification multi-session-key

Description

This command configures the information that is included in the multi-session key. This information is used to group sessions into a subscriber.

The no form of this command removes the configuration.

Default

no multi-session-key

Context

• [Tree] configure mobile-gateway profile bng entry-point entry subscriber-identification multi-session-key c-vlan

Description

This command configures the multi-session-key to include the customer VLAN (inner VLAN).

The no form of this command removes the customer VLAN from the multi-session-key.

Default

no c-vlan

Context

• [Tree] configure mobile-gateway profile bng entry-point entry subscriber-identification multi-session-key circuit-id

Description

This command configures the multi-session-key to include the circuit ID.

The no form of this command removes the circuit ID from the multi-session-key.

Default

no circuit-id

Context

• [Tree] configure mobile-gateway profile bng entry-point entry subscriber-identification multi-session-key circuit-id string-mask

Description

This command enables the context for configuring an optional string mask for masking the circuit ID.

The no form of this command disables the context.

Default

no string-mask

Context

• [Tree] configure mobile-gateway profile bng entry-point entry subscriber-identification multi-session-key circuit-id string-mask prefix

Description

This command configures a prefix mask for the circuit ID.

The no form of this command removes the configuration.

Default

no prefix

Parameters

mask-length

specifies to remove the specified amount of bytes from beginning of the session's circuit ID

Values: 1 to 127

mask-string

specifies to remove the specified string if the beginning of the session's circuit ID matches, up to 127 characters

Note: For a string match, the wildcard character "*" can be used as a match criteria.

Context

• [Tree] configure mobile-gateway profile bng entry-point entry subscriber-identification multi-session-key circuit-id string-mask suffix

Description

This command configures a prefix mask for circuit ID.

The no form of this command removes the configuration.

Default

no suffix

Parameters

mask-length

specifies to remove the specified amount of bytes from end of the session's circuit ID

Values: 1 to 127

mask-string

specifies to remove the specified string if the end of the session's circuit ID matches, up to 127 characters

Note: For a string match, the wildcard character "*" can be used as a match criteria.

Context

• [Tree] configure mobile-gateway profile bng entry-point entry subscriber-identification multi-session-key l2-access-id

Description

This command configures the multi-session-key to include the Layer 2 access ID.

The no form of this command removes the Layer 2 access ID from the multi-session-key.

Default

no l2-access-id

Context

• [Tree] configure mobile-gateway profile bng entry-point entry subscriber-identification multi-session-key mac

Description

This command configures the multi-session-key to include the MAC address.

The no form of this command removes the MAC address from the multi-session-key.

Default

no mac

Context

• [Tree] configure mobile-gateway profile bng entry-point entry subscriber-identification multi-session-key remote-id

Description

This command configures the multi-session-key to include the remote ID.

The no form of this command removes the remote ID from the multi-session-key.

Default

no remote-id

Context

• [Tree] configure mobile-gateway profile bng entry-point entry subscriber-identification multi-session-key remote-id string-mask

Description

This command enables the context for configuring an optional string mask for masking the remote ID.

The no form of this command disables the context.

Default

no string-mask

Context

• [Tree] configure mobile-gateway profile bng entry-point entry subscriber-identification multi-session-key remote-id string-mask prefix

Description

This command configures a prefix mask for the remote ID.

The no form of this command removes the configuration.

Default

no prefix

Parameters

mask-length

specifies to remove the specified amount of bytes from beginning of the session's remote ID

Values: 1 to 127

mask-string

specifies to remove the specified string if the beginning of the session's remote ID matches, up to 127 characters

Note: For a string match, the wildcard character "*" can be used as a match criteria.

Context

• [Tree] configure mobile-gateway profile bng entry-point entry subscriber-identification multi-session-key remote-id string-mask suffix

Description

This command configures a prefix mask for remote ID.

The no form of this command removes the configuration.

Default

no suffix

Parameters

mask-length

specifies to remove the specified amount of bytes from end of the session's remote ID

Values: 1 to 127

mask-string

specifies to remove the specified string if the end of the session's remote ID matches, up to 127 characters

Note: For a string match, the wildcard character "*" can be used as a match criteria.

Context

• [Tree] configure mobile-gateway profile bng entry-point entry subscriber-identification multi-session-key s-vlan

Description

This command configures the multi-session-key to include the subscriber VLAN (outer VLAN).

The no form of this command removes the subscriber VLAN from the multi-session-key.

Default

no s-vlan

Context

• [Tree] configure mobile-gateway profile bng entry-point entry subscriber-identification session-limit

Description

This command configures the maximum number of sessions per subscriber.

Default

session-limit 256

Parameters

limit

specifies the maximum number of sessions

Values: 2 to 256

Context

• [Tree] configure mobile-gateway profile bng entry-point match

Description

This command configures one or more match attributes in the entry-point match configuration. An entry configuration must contain configurations for all non-optional match attributes to be a matched entry. Match attributes that are optional may be included or not in the matched entry configuration.

The no form of this command removes the specified match configuration.

Parameters

match-id

Specifies the match ID.

Values: 1 to 4

attr

Specifies a matching attribute.

Values:

• c-vlan – specifies the operator VLAN tag as a match attribute
• l2-access-id – specifies the Layer 2 access ID as a match attribute
• s-vlan – specifies the service VLAN tag as a match attribute
• up-ip – specifies the BNG-UP IP address as a match attribute
• up-group – specifies the UP group as a match attribute
• up-node-id – specifies the UP node ID as a match attribute

Context

• [Tree] configure mobile-gateway profile bng entry-point match optional

Description

This command configures the match attribute as optional. Match attributes that are optional may be included or not in a matched entry configuration.

The no form of this command removes the configuration.

Default

no optional

Context

• [Tree] configure mobile-gateway profile bng entry-point match string-mask

Description

This command enables an optional string mask for masking the match attribute.

The no form of this command disables the string-mask configuration for the match attribute.

Default

no string-mask

Context

• [Tree] configure mobile-gateway profile bng entry-point match string-mask prefix

Description

This command configures a prefix mask for the match attribute.

The no form of this command removes the configuration.

Default

no prefix

Parameters

mask-length

Specifies to remove the specified number of bytes from the start of the value before comparing it with the end of the match attribute's value.

Values: 1 to 127

mask-string

Specifies to remove the specified string from the start of the value before comparing it with the end of the match attribute's value, up to 127 characters.

Note: The wildcard character "*" can be used in the mask string.

Context

• [Tree] configure mobile-gateway profile bng entry-point match string-mask suffix

Description

This command configures a suffix mask for the match attribute.

The no form of this command removes the configuration.

Default

no suffix

Parameters

mask-length

Specifies to remove the specified number of bytes from the end of the session value before comparing the session value with the start of the match attribute's value.

Values: 1 to 127

mask-string

Specifies to remove the specified string from the end of the session value before comparing the session value with the start of the match attribute's value, up to 127 characters.

Note: The wildcard character "*" can be used in the mask string.

Context

• [Tree] configure mobile-gateway profile bng entry-point 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 profile bng fsg-profile

Description

This command creates a specific FSG profile. Commands in the specific FSG context configure the FSG behavior for the specified FSG profile name.

The no form of this command removes the specified FSG profile.

Parameters

name

Specifies the name, up to 32 characters. The first character in the name cannot be an underscore (_) or a number.

Context

• [Tree] configure mobile-gateway profile bng fsg-profile active-standby-selection

Description

Commands in this context configure the selection method for the active and standby BNG-UPs.

Context

• [Tree] configure mobile-gateway profile bng fsg-profile active-standby-selection active-change-without-failure

Description

configure mobile-gateway profile bng fsg-profile health-calculation failure-threshold

The no form of this command reverts to the default.

Default

active-change-without-failure always

Parameters

always

Specifies that the standby BNG-UP can always become active, even if the current active BNG-UP did not fail. This is known as the revertive mode, and is often combined with the following command:

configure mobile-gateway pdn bng up-group up preferred

initial-only [60..900]

Specifies a time in seconds during which the always mode applies. The timer starts after the PFCP association for the first BNG-UP is set up. When the timer expires, the never mode applies.

Values: 60 to 900

never

Specifies that the current active BNG-UP remains active until it fails. This is known as the non-revertive mode.

Context

• [Tree] configure mobile-gateway profile bng fsg-profile active-standby-selection failure-lockout

Description

This commands configures how long a BNG-UP is locked out after an FSG failure; for example, an explicit FSG create or modify error response or receiving an FSG oper down notification from the BNG-UP.

During lockout, a BNG-UP cannot become active or standby. If the BNG-UP has an active or standby role, the MAG-c removes that role from the BNG-UP. When the lockout time expires, the MAG-c removes the lockout state, which acts as a recovery trigger for FSG reselection.

The no form of this commands reverts to the default.

Default

failure-lockout 60

Parameters

seconds

Specifies the lockout timer in seconds.

Values: 30 to 3600

Default: 60

Context

• [Tree] configure mobile-gateway profile bng fsg-profile active-standby-selection hold-off-on-degradation

Description

This commands configures the hold timer before reselecting a BNG-UP after a degradation event. By default, the hold timer is disabled to immediately execute potential switchovers because of failure.

When a degradation event occurs while a hold timer is running because of another degradation or recovery event, the new hold timer is only applied if it is shorter than the already running one.

See "Active/standby selection triggers" in the MAG-c Control Plane Function Guide for more information about the timer and the degradation events that trigger an active/standby selection.

The no form of this commands reverts to the default.

Default

hold-off-on-degradation 0

Parameters

milliseconds

Specifies the hold timer for degradation events in milliseconds.

Values: 0 to 100000

Default: 0 (disabled)

Context

• [Tree] configure mobile-gateway profile bng fsg-profile active-standby-selection hold-off-on-recovery

Description

This command configures the hold timer before reselecting a BNG-UP after a recovery event.

When a degradation event occurs while a hold timer is running because of another degradation or recovery event, the new hold timer is only applied if it is shorter than the already running one.

The no form of this commands reverts to the default.

See "Active/standby selection triggers" in the MAG-c Control Plane Function Guide for more information about the timer and the recovery events that trigger an active/standby selection.

Default

hold-off-on-recovery 5000

Parameters

milliseconds

Specifies the hold timer for recovery events in milliseconds.

Values: 5000 to 300000

Default: 5000

Context

• [Tree] configure mobile-gateway profile bng fsg-profile default-standby-mode

Description

This command configures the default standby mode for the sessions in the FSG.

The no form of this commands reverts to the default.

Default

default-standby-mode hot

Parameters

warm | hot

Specifies the standby mode.

Values:

• warm – specifies that the MAG-c creates the sessions on the standby BNG-UP only after a switch-over happens
• hot – specifies that the MAG-c pre-creates the sessions on the standby BNG-UP

Default: hot

Context

• [Tree] configure mobile-gateway profile bng fsg-profile 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 profile bng fsg-profile health-calculation

Description

Commands in this context configure the calculation of per-BNG-UP and -FSG aggregate health.

Context

• [Tree] configure mobile-gateway profile bng fsg-profile health-calculation aggregation-mode

Description

The no form of this commands reverts to the default.

Default

aggregation-mode lowest

Parameters

mode

Specifies the aggregation mode.

Values:

• lowest – specifies to use the lowest monitored health value
• average – specifies to use the arithmetic mean of all monitored health values

Default: lowest

Context

• [Tree] configure mobile-gateway profile bng fsg-profile health-calculation failure-threshold

Description

This command configures the threshold to declare a BNG-UP failed. If the health of an active BNG-UP is below the threshold, the MAG-c tries to make another BNG-UP active even if non-revertive settings are applied.

The no form of this commands reverts to the default.

Default

failure-threshold 1

Parameters

[1..100]

Specifies the minimal health value to consider a BNG-UP not failed.

Values: 1 to 100

Default: 1

Context

• [Tree] configure mobile-gateway profile bng fsg-profile health-calculation include-l2-access-ids

Description

This command includes the Layer 2 access IDs in the aggregate health calculation. By default, the MAG-c includes all Layer 2 access IDs defined for the BNG-UP in the UP group from which the FSG is created.

The no form of this command excludes the Layer 2 access IDs from the aggregate health calculation.

Default

include-l2-access-ids

Context

• [Tree] configure mobile-gateway profile bng fsg-profile health-calculation network-realm

Description

This command configures to monitor the specified network realm. A network realm is also called a network instance and corresponds usually to a service name on a BNG-UP.

The no form of this command disables the monitoring of the specified network realm.

Parameters

realm

Specifies the name of the network realm to be monitored, up to 80 characters.

Context

• [Tree] configure mobile-gateway profile bng fsg-profile mac-prefix

Description

This command configures the MAC prefix from which a per-FSG MAC is derived.

The no form of this command reverts to the default.

Default

mac-prefix 02:00:5e:00

Parameters

mac-prefix

Specifies the MAC prefix.

Values: aa:bb:cc:dd (32 bits)

Default: 02:00:5e:00

Context

• [Tree] configure mobile-gateway profile bng fsg-profile upf-fsg-template

Description

This command configures the FSG template to apply on the BNG-UP.

The no form of this command removes the configuration.

Default

no upf-fsg-template

Parameters

name

Specifies the name of the BNG-UP FSG template, up to 32 characters.

Context

• [Tree] configure mobile-gateway profile bng ipoe-profile

Description

This command configures a profile for IPoE sessions.

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

Parameters

name

Specifies the IPoE profile name, up to 32 characters.

Context

• [Tree] configure mobile-gateway profile bng ipoe-profile 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 description from the configuration.

Default

no description

Parameters

description-string

Specifies 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 profile bng ipoe-profile dot1p

Description

This command configures the IEEE 802.1p priority value assigned to the control packets sent to the IPoE session.

Default

dot1p 7

Parameters

dot1p-priority

specifies the dot1p priority value.

Values: 0 to 7

Context

• [Tree] configure mobile-gateway profile bng ipoe-profile dscp

Description

This command configures the Ethernet dot1p value for any IPoE control plane messages sent by the BNG CPF, independent of the protocol.

Default

dscp nc2

Parameters

dscp-name

specifies a DSCP name

Values: be | ef | cp1 | cp2 | cp3 | cp4 | cp5 | cp6 | cp7 | cp9 | cs1 | cs2 | cs3 | cs4 | cs5 | nc1 | nc2 | af11 | af12 | af13 | af21 | af22 | af23 | af31 | af32 | af33 | af41 | af42 | af43 | cp11 | cp13 | cp15 | cp17 | cp19 | cp21 | cp23 | cp25 | cp27 | cp29 | cp31 | cp33 | cp35 | cp37 | cp39 | cp41 | cp42 | cp43 | cp44 | cp45 | cp47 | cp49 | cp50 | cp51 | cp52 | cp53 | cp54 | cp55 | cp57 | cp58 | cp59 | cp60 | cp61 | cp62 | cp63

Context

• [Tree] configure mobile-gateway profile bng ipoe-profile require-chaddr-same-as-l2

Description

This command enables the verification of the client MAC address in the DHCP chaddr field. The chaddr field is equal to the source Ethernet MAC address. This is only checked if the triggering packet for the session is DHCPv4, and it is not checked for any subsequent messages.

The no form of this command disables the verification of the client MAC address in the DHCP chaddr field.

Default

require-chaddr-same-as-l2

Context

• [Tree] configure mobile-gateway profile bng l2tp-group

Description

This command configures a group of L2TP tunnels for PPPoE LAC connectivity.

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

Parameters

name

Specifies the L2TP group name, up to 32 characters

Context

• [Tree] configure mobile-gateway profile bng l2tp-group avp-hiding

Description

This command configures whether the H bit in the header of L2TP AVPs must be set. If this is not configured, the BNG-UP chooses the hiding level.

The no form of this command removes the configuration.

Parameters

never

Specifies to never set the H bit.

sensitive

Specifies to set the H bit only for AVPs that contain sensitive information.

always

Specifies to set the H bit for all AVPs.

Context

• [Tree] configure mobile-gateway profile bng l2tp-group challenge

Description

This command configures whether the tunnel authentication (challenge-response) must be performed. If this is not configured, the BNG-UP chooses whether to perform the tunnel authentication.

The no form of this command removes the configuration.

Parameters

never

Specifies to never perform tunnel authentication.

always

Specifies to always perform tunnel authentication.

Context

• [Tree] configure mobile-gateway profile bng l2tp-group 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 description from the configuration.

Default

no description

Parameters

description-string

Specifies 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 profile bng l2tp-group destruct-timeout

Description

This command configures the time in seconds that operational data of a disconnected tunnel persists on the BNG-UP. If this is not configured, the BNG-UP chooses the time to keep operational data.

The no form of this command removes the configuration.

Parameters

seconds

Specifies the timeout in seconds.

Values: 60 to 86400

Context

• [Tree] configure mobile-gateway profile bng l2tp-group hello-interval

Description

This command configures the interval for sending Hello messages to the L2TP peer. If this is not configured, the BNG-UP chooses the interval.

The no form of this command removes the configuration.

Parameters

infinite

Specifies an infinite interval, that is, Hello messages are not sent.

seconds

Specifies the interval in seconds.

Values: 10 to 3600

Context

• [Tree] configure mobile-gateway profile bng l2tp-group idle-timeout

Description

This command configures the time in seconds before an established tunnel without active sessions is disconnected. If this is not configured, the BNG-UP chooses the timeout.

The no form of this command removes the configuration.

Parameters

infinite

Specifies an infinite timeout, that is, an established tunnel is held up and never disconnected.

seconds

Specifies the timeout in seconds.

Values: 0 to 3600

Context

• [Tree] configure mobile-gateway profile bng l2tp-group local-name

Description

This command configures the LAC hostname that the BNG-UP sends in L2TP messages. If this is not configured, the BNG-UP chooses the hostname.

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

Parameters

name

Specifies the LAC hostname, up to 64 characters.

Context

• [Tree] configure mobile-gateway profile bng l2tp-group max-retries-established

Description

This command configures the number of retries allowed for established tunnels before their control connection goes down. If this is not configured, the BNG-UP chooses the number of retries.

The no form of this command removes the configuration.

Parameters

max

Specifies the number of retries.

Values: 2 to 7

Context

• [Tree] configure mobile-gateway profile bng l2tp-group max-retries-non-established

Description

This command configures the number of retries allowed before a non-established tunnel is considered unreachable. If this is not configured, the BNG-UP chooses the number of retries.

The no form of this command removes the configuration.

Parameters

max

Specifies the number of retries.

Values: 2 to 7

Context

• [Tree] configure mobile-gateway profile bng l2tp-group password

Description

This command configures a shared, salt-encrypted secret for the tunnel authentication and the AVP hiding. If this is not configured, the BNG-UP chooses the password.

The no form of this command removes the configuration.

Parameters

password

Specifies the password, up to 64 characters.

hash | hash2

Specifies the version of the hash algorithm used for the encryption of the secret. If the hash or hash2 keyword is not used, the secret is assumed to be in an unencrypted clear text form.

Note: For security purposes, all keys are automatically stored in an encrypted hash form in the configuration. The configuration in the system>security>hash-control context defines the hash form when the password is configured in clear text format (that is, hash or hash2 is not specified).

Context

• [Tree] configure mobile-gateway profile bng l2tp-group receive-window-size

Description

This command configures the receive window size that is offered to the remote peer. The remote peer can send the specified number of control messages before waiting for an acknowledgment. If this is not configured, the BNG-UP chooses the window size.

The no form of this command removes the configuration.

Parameters

window

Specifies the receive window size.

Values: 4 to 1024

Context

• [Tree] configure mobile-gateway profile bng l2tp-group selection-algorithm

Description

This command configures how sessions are assigned within a set of tunnels with the same preference level. If this is not configured, the BNG-UP chooses the algorithm.

configure mobile-gateway profile bng l2tp-group tunnel preference

The no form of this command removes the configuration.

Parameters

type

Specifies the type of the selection algorithm.

Values:

• existing-first — Specifies to first attempt using an existing tunnel
• weighted — Specifies to equally distribute sessions using a fixed order, that is, when two tunnels have an equal number of sessions, a round-robin algorithm with a fixed internal order is used
• weighted-random — Specifies to equally distribute sessions in a random fashion, that is, when two tunnels have an equal number of sessions, a random tunnel is chosen

Context

• [Tree] configure mobile-gateway profile bng l2tp-group session-limit

Description

This command configures the maximum number of sessions that can be set up within the group. The limit is enforced on the BNG-UP. If this is not configured, the BNG-UP chooses the session limit.

The no form of this command removes the configuration.

Parameters

unlimited

Specifies that there is no explicit limit; the system level L2TP limits on the BNG-UP restrict the number of sessions.

limit

Specifies the session limit.

Values: 1 to 250000

Context

• [Tree] configure mobile-gateway profile bng l2tp-group tunnel

Description

This command configures an L2TP tunnel.

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

Parameters

name

Specifies the L2TP tunnel name, up to 32 characters.

Context

• [Tree] configure mobile-gateway profile bng l2tp-group tunnel avp-hiding

Description

This command configures whether the H bit in the header of L2TP AVPs must be set. If this is not configured, the BNG-UP chooses the hiding level.

The no form of this command removes the configuration.

Parameters

never

Specifies to never set the H bit.

sensitive

Specifies to set the H bit only for AVPs that contain sensitive information.

always

Specifies to set the H bit for all AVPs.

Context

• [Tree] configure mobile-gateway profile bng l2tp-group tunnel challenge

Description

This command configures whether the tunnel authentication (challenge-response) must be performed. If this is not configured, the BNG-UP chooses whether to perform the tunnel authentication.

The no form of this command removes the configuration.

Parameters

never

Specifies to never perform tunnel authentication.

always

Specifies to always perform tunnel authentication.

Context

• [Tree] configure mobile-gateway profile bng l2tp-group tunnel 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 description from the configuration.

Default

no description

Parameters

description-string

Specifies 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 profile bng l2tp-group tunnel destruct-timeout

Description

This command configures the time in seconds that operational data of a disconnected tunnel persists on the BNG-UP. If this is not configured, the BNG-UP chooses the time to keep operational data.

The no form of this command removes the configuration.

Parameters

seconds

Specifies the timeout in seconds.

Values: 60 to 86400

Context

• [Tree] configure mobile-gateway profile bng l2tp-group tunnel hello-interval

Description

This command configures the interval for sending Hello messages to the L2TP peer. If this is not configured, the BNG-UP chooses the interval.

The no form of this command removes the configuration.

Parameters

infinite

Specifies an infinite interval, that is, Hello messages are not sent.

seconds

Specifies the interval in seconds.

Values: 10 to 3600

Context

• [Tree] configure mobile-gateway profile bng l2tp-group tunnel idle-timeout

Description

This command configures the time in seconds before an established tunnel without active sessions is disconnected. If this is not configured, the BNG-UP chooses the timeout.

The no form of this command removes the configuration.

Parameters

infinite

Specifies an infinite timeout, that is, an established tunnel is held up and never disconnected.

seconds

Specifies the timeout in seconds.

Values: 0 to 3600

Context

• [Tree] configure mobile-gateway profile bng l2tp-group tunnel local-address

Description

This command configures the local IP address to initiate the tunnel.

The no form of this command removes the local address.

Parameters

ip-address

Specifies an IPv4 address.

Values: a.b.c.d

Context

• [Tree] configure mobile-gateway profile bng l2tp-group tunnel local-name

Description

This command configures the LAC hostname that the BNG-UP sends in L2TP messages. If this is not configured, the BNG-UP chooses the hostname.

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

Parameters

name

Specifies the LAC hostname, up to 64 characters.

Context

• [Tree] configure mobile-gateway profile bng l2tp-group tunnel max-retries-established

Description

This command configures the number of retries allowed for established tunnels before their control connection goes down. If this is not configured, the BNG-UP chooses the number of retries.

The no form of this command removes the configuration.

Parameters

max

Specifies the number of retries.

Values: 2 to 7

Context

• [Tree] configure mobile-gateway profile bng l2tp-group tunnel max-retries-non-established

Description

This command configures the number of retries allowed before a non-established tunnel is considered unreachable. If this is not configured, the BNG-UP chooses the number of retries.

The no form of this command removes the configuration.

Parameters

max

Specifies the number of retries.

Values: 2 to 7

Context

• [Tree] configure mobile-gateway profile bng l2tp-group tunnel password

Description

This command configures a shared, salt-encrypted secret for the tunnel authentication and the AVP hiding. If this is not configured, the BNG-UP chooses the password.

The no form of this command removes the configuration.

Parameters

password

Specifies the password, up to 64 characters.

hash | hash2

Specifies the version of the hash algorithm used for the encryption of the secret. If the hash or hash2 keyword is not used, the secret is assumed to be in an unencrypted clear text form.

Note: For security purposes, all keys are automatically stored in an encrypted hash form in the configuration. The configuration in the system>security>hash-control context defines the hash form when the password is configured in clear text format (that is, hash or hash2 is not specified).

Context

• [Tree] configure mobile-gateway profile bng l2tp-group tunnel preference

Description

This command configures the relative preference of the tunnel for selection purposes. The selection algorithm defines how to select tunnels with the same preference.

Parameters

value

Specifies the preference, with 0 indicating the highest preference.

Values: 0 to 16777215

Context

• [Tree] configure mobile-gateway profile bng l2tp-group tunnel receive-window-size

Description

This command configures the receive window size that is offered to the remote peer. The remote peer can send the specified number of control messages before waiting for an acknowledgment. If this is not configured, the BNG-UP chooses the window size.

The no form of this command removes the configuration.

Parameters

window

Specifies the receive window size.

Values: 4 to 1024

Context

• [Tree] configure mobile-gateway profile bng l2tp-group tunnel remote-address

Description

This command configures the remote IP address of the peer. The tunnel is initiated toward the configured peer.

The no form of this command removes the remote address.

Parameters

ip-address

Specifies an IPv4 address.

Values: a.b.c.d

Context

• [Tree] configure mobile-gateway profile bng l2tp-group tunnel remote-name

Description

This command configures the expected hostname of the L2TP peer. If the L2TP signaled value does not match the expected value, the setup fails. If this is not configured, the BNG-UP determines whether to perform a hostname check.

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

Parameters

name

Specifies the peer hostname, up to 64 characters.

Context

• [Tree] configure mobile-gateway profile bng l2tp-group tunnel session-limit

Description

This command configures the maximum number of sessions that can be set up within the tunnel. The limit is applied on the BNG-UP. If this is not configured, the BNG-UP chooses the session limit.

The no form of this command removes the configuration.

Parameters

unlimited

Specifies that there is no explicit limit; the system level L2TP limits on the BNG-UP restrict the number of sessions.

limit

Specifies the session limit.

Values: 1 to 65535

Context

• [Tree] configure mobile-gateway profile bng l2tp-group tunnel shutdown

Description

This command administratively disables the tunnel. Shutting down an L2TP tunnel excludes the tunnel from the grouped tunnels signaled in PFCP when setting up a LAC session (for example, the tunnel is excluded from the BNG-UP tunnel selection).

The no form of this command enables the tunnel.

Context

• [Tree] configure mobile-gateway profile bng l2tp-group tunnel use-df-bit

Description

This command configures whether the DF bit in the L2TP IP header is set. If this is not configured, the BNG-UP chooses whether to set the DF bit.

The no form of this command removes the configuration.

Parameters

set

Specifies whether to set the DF bit.

Values:

• true – specifies that the DF bit is set
• false – specifies that the DF bit is not set

Context

• [Tree] configure mobile-gateway profile bng l2tp-group use-df-bit

Description

This command configures whether the DF bit in the L2TP IP header is set. If this is not configured, the BNG-UP chooses whether to set the DF bit.

The no form of this command removes the configuration.

Parameters

set

Specifies whether to set the DF bit.

Values:

• true – specifies that the DF bit is set
• false – specifies that the DF bit is not set

Context

• [Tree] configure mobile-gateway profile bng pppoe-profile

Description

This command configures a BNG PPPoE profile.

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

Default

no pppoe-profile

Parameters

pppoe-profile-name

specifies the PPPoE profile name, up to 32 characters

Context

• [Tree] configure mobile-gateway profile bng pppoe-profile authentication

Description

This command enables the context to configure authentication for the PPP profile.

Context

• [Tree] configure mobile-gateway profile bng pppoe-profile authentication chap-challenge-length

Description

The command configures the length of the CHAP challenge that is sent to the PPPoE client which is chosen randomly between the configured minimum and maximum length.

Default

chap-challenge-length min 32 max 64

Parameters

minimum-length

specifies the minimum length of the CHAP challenge generated by the system

Values: 8 to 64

maximum-length

specifies the maximum length of the CHAP challenge generated by the system

Values: 8 to 64

Context

• [Tree] configure mobile-gateway profile bng pppoe-profile authentication method

Description

This command configures the authentication protocol to use to authenticate the session.

The no form of this command reverts to the default value.

Default

method pref-chap

Parameters

pap

specifies to only attempt authentication with PAP

chap

specifies to only attempt authentication with CHAP

pref-chap

specifies that the first CHAP is negotiated followed by PAP upon failure

pref-pap

specifies that the first PAP is negotiated followed by CHAP upon failure

Context

• [Tree] configure mobile-gateway profile bng pppoe-profile 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 description from the configuration.

Default

no description

Parameters

description-string

Specifies 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 profile bng pppoe-profile discovery

Description

This command enables the context to configure PPPoE discovery signaling.

Default

discovery

Context

• [Tree] configure mobile-gateway profile bng pppoe-profile discovery ac-name

Description

This command configures the Access Concentrator (AC) name that is sent in PPPoE Active Discovery Offer (PADO) messages.

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

Default

no ac-name

Parameters

name

specifies the AC name, up to 128 characters

Context

• [Tree] configure mobile-gateway profile bng pppoe-profile discovery generate-ac-cookie

Description

This command enables the use of AC-Cookie tags during the PPPoE discovery phase that is included in PADO messages.

The no form of this command disables the generation of AC-Cookie tags.

Default

generate-ac-cookie

Context

• [Tree] configure mobile-gateway profile bng pppoe-profile dot1p-value

Description

This command configures the Ethernet dot1p value for any PPPoE control plane messages sent by the CPF. The no form of this command reverts to the default value.

Default

dot1p-value 7

Parameters

dot1p-value

specifies the Ethernet dot1p value for any PPPoE control plane messages

Values: 0 to 7

Context

• [Tree] configure mobile-gateway profile bng pppoe-profile lcp

Description

This command enables the context to configure PPPoE LCP signaling.

Context

• [Tree] configure mobile-gateway profile bng pppoe-profile lcp keep-alive

Description

This command enables the context to handle LCP keepalive parameters. These parameters are sent to the UP in case LCP Keepalive Offload is enabled.

Context

• [Tree] configure mobile-gateway profile bng pppoe-profile lcp keep-alive ignore-magic-numbers

Description

This command disables checking the Magic-Number field in the LCP Echo-Request and skips Echo-Reply messages.

The no form of this command enables checking the Magic-Number field.

Default

no ignore-magic-numbers

Context

• [Tree] configure mobile-gateway profile bng pppoe-profile lcp keep-alive interval

Description

This command configures the interval at which keepalive messages are sent to the PPPoE client.

The no form of this command disables the interval, that is, the BNG receives periodic LCP keepalives.

Default

interval 30

Parameters

seconds

specifies the time interval, in seconds, at which keepalives are transmitted

Values: 4 to 300

Context

• [Tree] configure mobile-gateway profile bng pppoe-profile lcp keep-alive tries

Description

This command configures the number LCP keepalive messages that are tried before the client is considered down.

The no form of this command reverts to the default value.

Default

tries 3

Parameters

tries

specifies the number of keepalive messages that are tried before the related client is considered down

Values: 1 to 5

Context

• [Tree] configure mobile-gateway profile bng pppoe-profile lcp max-mtu

Description

This command configures the maximum MTU that to be installed on the BNG-UP. This is combined with the Maximum Receive Unit (MRU) received from the PPPoE Client. If the Client's MRU is smaller than or equal to the MTU byes then that value is installed as the UP MTU. If the value is larger, the configured value is installed as the UP MTU.

The no form of this command reverts to the default value.

Default

max-mtu 1492

Parameters

mtu-bytes

specifies the maximum MTU size, in bytes

Values: 512 to 9154

Context

• [Tree] configure mobile-gateway profile bng pppoe-profile lcp mru

Description

This command configures the MRU that is signaled toward the PPPoE client.

The no form of this command reverts to the default value.

Default

mru 1492

Parameters

mru-bytes

specifies the MRU, in bytes

Values: 512 to 9154

Context

• [Tree] configure mobile-gateway profile bng pppoe-profile lcp renegotiation

Description

This command specifies whether LCP renegotiation messages are silently ignored or terminate the PPPoE session. The no form of this command reverts to the default value.

Default

renegotiation terminate-pppoe-session

Parameters

ignore

specifies that LCP renegotiation messages are ignored

terminate-pppoe-session

specifies that LCP renegotiation messages terminate the PPPoE session

Context

• [Tree] configure mobile-gateway profile bng pppoe-profile lcp require-max-payload-tag

Description

This command enables the max-payload-tag as a requirement to send or accept MRUs larger than 1492.

The no form of this command disables the requirement.

Default

require-max-payload-tag

Context

• [Tree] configure mobile-gateway profile bng pppoe-profile padi-removes-existing-session

Description

This command enables an incoming PADI to remove an existing conflicting PPPoE session.

The no form of this command does not remove the existing session.

Default

padi-removes-existing-session

Context

• [Tree] configure mobile-gateway profile bng ra-profile

Description

This command enables the specified RA profile.

The no form of this command removes the profile name.

Parameters

name

specifies the RA profile name, up to 32 characters

Context

• [Tree] configure mobile-gateway profile bng ra-profile advertisement-interval

Description

This command enables the context for configuring the minimum and maximum advertisement interval for RA messages. Messages are periodically sent with an interval chosen randomly between the minimum and maximum.

Context

• [Tree] configure mobile-gateway profile bng ra-profile advertisement-interval max

Description

This command sets the maximum advertisement interval.

Parameters

seconds

specifies the interval in seconds

Values: 4 to 1800

Default: 600

Context

• [Tree] configure mobile-gateway profile bng ra-profile advertisement-interval min

Description

This command sets the minimum advertisement interval either to a fixed value or to a percentage of the maximum advertisement interval.

Default

min auto

Parameters

auto

sets the minimum interval to 33% of the maximum interval

seconds

specifies the interval in seconds

Values: 4 to 1800

Context

• [Tree] configure mobile-gateway profile bng ra-profile 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 description from the configuration.

Default

no description

Parameters

description-string

Specifies 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 profile bng ra-profile force-unicast-mac

Description

This command enables sending of RA messages to the unicast MAC address of the session.

The no form of this command disables sending of RA messages to the unicast MAC address of the session. In this case, RA messages are sent to the all-nodes multicast MAC address (33:33:00:00:00:01).

Default

force-multicast-mac

Context

• [Tree] configure mobile-gateway profile bng ra-profile options

Description

This command enables the context for configuring options to include in RA messages to the IPv6 client.

Context

• [Tree] configure mobile-gateway profile bng ra-profile options hop-limit

Description

This command specifies the value of the Hop Limit field of the IPv6 header of the outgoing RA message.

Parameters

limit

specifies the value of the hop limit

Values: 1 to 255

Default: 255

Context

• [Tree] configure mobile-gateway profile bng ra-profile options mtu

Description

This command specifies whether to include the MTU option in the RA message, and if included, what value it contains.

Default

mtu not-included

Parameters

bytes

specifies the MTU value in bytes

Values: 1280 to 9212

Context

• [Tree] configure mobile-gateway profile bng ra-profile options on-link

Description

This command specifies whether to set the on-link flag in any SLAAC prefix included in the RA message.

Default

no on-link

Context

• [Tree] configure mobile-gateway profile bng ra-profile options other-configuration

Description

This command specifies whether to set the other-configuration flag in the RA message.

Default

no other-configuration

Context

• [Tree] configure mobile-gateway profile bng ra-profile options reachable-time

Description

This command specifies the reachable time included in the RA message. A zero value means that the router does not specify a value, and that the client can choose a value based on local configurations.

Parameters

milliseconds

the time in milliseconds for a node to assume that a neighbor is reachable, after receiving a reachability confirmation

Values: 0 to 3600000

Default: 0

Context

• [Tree] configure mobile-gateway profile bng ra-profile options retransmit-timer

Description

This command specifies the retransmit timer included in the RA message. A zero value means that the router does not specify a value, and that the client can choose a value based on local configurations.

Parameters

milliseconds

retransmission time between NS messages

Values: 0 to 1800000

Default: 0

Context

• [Tree] configure mobile-gateway profile bng ra-profile options router-lifetime

Description

This command specifies the router lifetime to include in the RA message. The router lifetime defines the validity period of the default router after receiving the RA message. It can be set either to a fixed value in seconds, or automatically to three times the maximum router advertisement interval.

Default

router-lifetime auto

Parameters

seconds

specifies the router lifetime in seconds

Values: 4 to 9000

Context

• [Tree] configure mobile-gateway profile bng radius-authentication-profile

Description

This command enables the specified RADIUS authentication profile. The RADIUS authentication profile defines system behavior when using the RADIUS server to authenticate BNG sessions.

The no form of this command removes the profile name.

Parameters

name

specifies the RADIUS authentication profile name, up to 32 characters

Context

• [Tree] configure mobile-gateway profile bng radius-authentication-profile apn-format

Description

This command specifies the APN format in RADIUS messages. The format applies to all attributes that reflect the APN; for example, Called-Station-Id and User-Name.

The no form of this command reverts to the default.

Default

apn-format selected

Parameters

form

Specifies the APN format.

Values:

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

Context

• [Tree] configure mobile-gateway profile bng radius-authentication-profile 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 string 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 profile bng radius-authentication-profile ignore-unknown-attributes

Description

No description found

Context

• [Tree] configure mobile-gateway profile bng radius-authentication-profile include-attribute

Description

This command enables RADIUS attributes to be included in the RADIUS Access-Request message. The no form of this command reverts to the default.

Default

no include-attribute

Context

• [Tree] configure mobile-gateway profile bng radius-authentication-profile include-attribute access-loop-options

Description

This command includes access loop information such as BBF access loop characteristics, DSL line state, and DSL type. The BBF access loop characteristics are returned as BBF-specific RADIUS attributes, where DSL line state and DSL type are returned as Nokia-specific RADIUS VSAs.

The no form of this command reverts to the default.

Default

no access-loop-options

Context

• [Tree] configure mobile-gateway profile bng radius-authentication-profile include-attribute acct-multi-session-id

Description

This command includes the Acct-Multi-Session-Id in the Access-Request message.

The no form of this command reverts to the default.

Default

no acct-multi-session-id

Context

• [Tree] configure mobile-gateway profile bng radius-authentication-profile include-attribute acct-session-id

Description

This command includes the Acct-Session-Id in the Access-Request message.

The no form of this command reverts to the default value.

Default

no acct-session-id

Context

• [Tree] configure mobile-gateway profile bng radius-authentication-profile include-attribute called-station-id

Description

This command includes the APN as the Called-Station-Id attribute in the Access Request message for FWA sessions.

The no form of this command reverts to the default.

Default

no called-station-id

Context

• [Tree] configure mobile-gateway profile bng radius-authentication-profile include-attribute calling-station-id

Description

This command includes the Calling-Station-Id in the Access-Request message.

The no form of this command reverts to the default.

Default

no calling-station-id

Parameters

type

Specifies to include the string that is put in the RADIUS Calling-Station-Id attribute, if included in RADIUS authentication request messages.

Values: l2-circuit | mac-address | remote-id

Context

• [Tree] configure mobile-gateway profile bng radius-authentication-profile include-attribute circuit-id

Description

This command includes the Agent-Circuit-Id in the Access-Request message.

The no form of this command reverts to the default.

Default

no circuit-id

Context

• [Tree] configure mobile-gateway profile bng radius-authentication-profile include-attribute dhcp-options

Description

This command passes DHCPv4 options from the received DHCPv4 messages on the access ingress to the RADIUS server in the Access-Request message. The DHCPv4 options are carried in the ALU VSA Alc-ToServer-Dhcp-Options.

The no form of this command reverts to the default.

Default

no dhcp-options

Context

• [Tree] configure mobile-gateway profile bng radius-authentication-profile include-attribute dhcp-vendor-class-id

Description

This command includes the DHCP Vendor Class Identification option in the received DHCP packet, as Alc-DHCP-Vendor-Class-Id in the Access-Request message.

The no form of this command reverts to the default.

Default

no dhcp-vendor-class-id

Context

• [Tree] configure mobile-gateway profile bng radius-authentication-profile include-attribute dhcp6-options

Description

This command passes DHCPv6 options from the received DHCPv6 messages on the access ingress, to the RADIUS server in the Access-Request message. The DHCPv6 options are carried in the ALU VSA Alc-ToServer-Dhcp6-Options.

The no form of this command reverts to the default.

Default

no dhcp6-options

Context

• [Tree] configure mobile-gateway profile bng radius-authentication-profile include-attribute gprs-negotiated-qos-profile

Description

This command includes the HSS/UDM QoS values received in FWA setup messages as the 3GPP-GPRS-Negotiated-QoS-Profile attribute in the Access-Request message.

The no form of this command reverts to the default.

Default

no gprs-negotiated-qos-profile

Context

• [Tree] configure mobile-gateway profile bng radius-authentication-profile include-attribute imeisv

Description

This command includes the IMEI value received in FWA setup messages as the 3GPP-IMEISV attribute in the Access-Request message.

The no form of this command reverts to the default.

Default

no imeisv

Context

• [Tree] configure mobile-gateway profile bng radius-authentication-profile include-attribute imsi

Description

This command includes the IMSI received in FWA setup messages as the 3GPP-IMSI attribute in the Access-Request message.

The no form of this command reverts to the default.

Default

no imsi

Context

• [Tree] configure mobile-gateway profile bng radius-authentication-profile include-attribute ipoe-hostname

Description

This command includes the DHCPv4 option Host Name as Alc-IPoE-Hostname in the Access-Request message.

The no form of this command reverts to the default.

Default

no ipoe-hostname

Context

• [Tree] configure mobile-gateway profile bng radius-authentication-profile include-attribute mac-address

Description

This command includes the session MAC address as the Alc-Client-Hardware-Addr in the Access-Request message.

The no form of this command reverts to the default.

Default

no mac-address

Context

• [Tree] configure mobile-gateway profile bng radius-authentication-profile include-attribute nas-identifier

Description

This command includes the Nas-Identifier in the Access-Request message.

The no form of this command reverts to the default.

Default

no nas-identifier

Context

• [Tree] configure mobile-gateway profile bng radius-authentication-profile include-attribute nas-port-id

Description

This command includes the Nas-Port-Id in the Access-Request message.

The no form of this command reverts to the default.

Default

no nas-port-id

Parameters

string

specifies that a user configurable string is added to the RADIUS NAS port attribute, up to eight characters

suffix-option

specifies the suffix type to be added to the RADIUS NAS port attribute

Values: circuit-id | remote-id

suffix

specifies the string, up to 64 characters, added as a suffix

Context

• [Tree] configure mobile-gateway profile bng radius-authentication-profile include-attribute nas-port-type

Description

This command includes the Nas-Port-Type in the Access-Request message. The no form of this command reverts to the default.

Default

no nas-port-type

Parameters

type

specifies the integer value for the Nas-Port-Type AVP

Values: 0 to 255

Context

• [Tree] configure mobile-gateway profile bng radius-authentication-profile include-attribute pppoe-service-name

Description

This command includes the PPPoE session's service name as the Alc-PPPoE- Service-Name in the Access-Request message.

The no form of this command reverts to the default.

Default

no pppoe-service-name

Context

• [Tree] configure mobile-gateway profile bng radius-authentication-profile include-attribute rat-type

Description

This command includes the RAT value received in FWA setup messages as the 3GPP-RAT-Type attribute in the Access-Request message.

The no form of this command reverts to the default.

Default

no rat-type

Context

• [Tree] configure mobile-gateway profile bng radius-authentication-profile include-attribute remote-id

Description

This command includes the Agent-Remote-Id in the Access-Request message. The no form of this command reverts to the default.

Default

no remote-id

Context

• [Tree] configure mobile-gateway profile bng radius-authentication-profile include-attribute up-group

Description

This command includes the UP group in the authentication message.

The no form of this command reverts to the default.

Default

no up-group

Context

• [Tree] configure mobile-gateway profile bng radius-authentication-profile include-attribute up-info

Description

This command includes various UP informational attributes such as source IP and Node ID in the authentication message.

The no form of this command reverts to the default.

Default

no up-info

Context

• [Tree] configure mobile-gateway profile bng radius-authentication-profile include-attribute user-location-info

Description

This command includes the user location information received in FWA setup messages as the 3GPP-User-Location-Info attribute in the Access-Request message.

The no form of this command reverts to the default.

Default

no user-location-info

Context

• [Tree] configure mobile-gateway profile bng radius-authentication-profile password

Description

This command includes the specified password as the User-Password in the access-request message.

The no form of this command removes reverts to the default.

Default

no password

Parameters

secret

specifies a text string, up to 64 characters, containing the password

hash

Specifies that the key is entered in an encrypted form. If the hash or hash2 parameter is not used, the key is assumed to be in an unencrypted, clear text form. For security, all keys are stored in encrypted form in the configuration file with the hash or hash2 parameter specified.

hash2

Specifies that the key is entered in a more complex encrypted form that involves more variables than the key value alone, meaning that the hash2 encrypted variable cannot be copied and pasted. If the hash or hash2 parameter is not used, the key is assumed to be in an unencrypted, clear text form. For security, all keys are stored in encrypted form in the configuration file with the hash or hash2 parameter specified.

Context

• [Tree] configure mobile-gateway profile bng radius-authentication-profile radius-group

Description

This command configures the RADIUS group to use for the radius-authentication-profile.

The no form of this command removes the RADIUS group configuration.

Default

no radius-group

Parameters

radius-group

specifies the RADIUS group name, up to 32 characters

Context

• [Tree] configure mobile-gateway profile bng radius-authentication-profile user-name-format

Description

Commands in this context configure how a user is represented to the RADIUS server.

Context

• [Tree] configure mobile-gateway profile bng radius-authentication-profile user-name-format ascii-converted-circuit-remote-id

Description

This command converts the Agent-Circuit-Id and Agent-Remote-Id contained in the User-Name to an ASCII format as hex digits for transmission to the RADIUS server.

The no form of this command disables the conversion.

Default

no ascii-converted-circuit-remote-id

Context

• [Tree] configure mobile-gateway profile bng radius-authentication-profile user-name-format domain-operation

Description

This command configures an optional domain name action for the User-Name format.

The no form of this command disables the domain operation.

Default

no domain-operation

Parameters

operation

specifies a domain name

Values	append	appends the specified domain name to the User-Name
	default	appends the specified domain name to the User-Name if there is no existing one
	replace	replaces the existing domain name in User-Name with the specified one
	strip	removes the existing domain-name in User-Name

domain-string

specifies the domain string, up to 128 characters

Context

• [Tree] configure mobile-gateway profile bng radius-authentication-profile user-name-format fixed-wireless-access

Description

Commands in this context configure the username formatting for FWA users.

Context

• [Tree] configure mobile-gateway profile bng radius-authentication-profile user-name-format fixed-wireless-access format

Description

This command specifies the username format for the FWA sessions. If a PAP/CHAP username is signaled during setup, this configuration is ignored and the signaled username is used.

Default

format imsi-apn

Parameters

form

Specifies the username format for FWA users.

Values:

• imsi – specifies to use a text representation of the IMSI as username
• imsi-apn – specifies to use a text representation of the IMSI and APN as username, separated by an @ character
• msisdn – specifies to use a text representation of the MSISDN as username
• msisdn-apn – specifies to use a text representation of the MSISDN and APN as username, separated by an @ character

Default: imsi-apn

Context

• [Tree] configure mobile-gateway profile bng radius-authentication-profile user-name-format ipoe

Description

This command enables the context to configure username formatting for IPoE users.

Context

• [Tree] configure mobile-gateway profile bng radius-authentication-profile user-name-format ipoe format

Description

This command specifies the User-Name format for the IPoE session.

Default

format mac-address

Parameters

form

specifies the username format for IPoE users

Values	circuit-id	Circuit-Id as User-Name
	client-vendor-options	<Client-Id option>@<Vendor-Class option> as User-Name
	mac-address	session MAC address as User-Name
	mac-circuit-id	<MAC-Address>::<Circuit-id> as User-Name
	remote-id	Remote-Id as User-Name

Context

• [Tree] configure mobile-gateway profile bng radius-authentication-profile user-name-format ipoe mac-format

Description

This command specifies the format of the MAC address in User-Name of IPoE session.

Default

mac-format "aa:"

Parameters

mac-format

specifies the expected MAC address format

Values: only when the match is equal to, for example

	ab	for 00:0c:f1:99:85:b8
	or XY-	for 00-0C-F1-99-85-B8
	or mmmm.	for 0002.03aa.abff
	or xx	for 000cf19985b8

Context

• [Tree] configure mobile-gateway profile bng radius-authentication-profile user-name-format pppoe

Description

This command enables the context to configure username formatting for PPPoE users.

Context

• [Tree] configure mobile-gateway profile bng radius-authentication-profile user-name-format pppoe padi

Description

This command enables the context to configure PPPoE PADI authentication User-Name formats.

Context

• [Tree] configure mobile-gateway profile bng radius-authentication-profile user-name-format pppoe padi format

Description

This command specifies the User-Name format for the PPPoE session.

Default

format mac-address

Parameters

form

specifies the User-Name format for PPPoE users

Values	circuit-id	Circuit-Id as User-Name
	mac-address	session MAC address as User-Name
	remote-id	Remote-Id as User-Name

Context

• [Tree] configure mobile-gateway profile bng radius-authentication-profile user-name-format pppoe padi mac-format

Description

This command specifies the format of the MAC address in User-Name of PPPoE PADI session.

Default

mac-format "aa:"

Parameters

mac-format

specifies the MAC address format

Values: only when match is equal to, for example

	ab	for 00:0c:f1:99:85:b8
	or XY-	for 00-0C-F1-99-85-B8
	or mmmm.	for 0002.03aa.abff
	or xx	for 000cf19985b8

Context

• [Tree] configure mobile-gateway profile bng session-lockout-profile

Description

This command specifies a session lockout profile that can be used to block a client after a specified number of session setup failures and established session disconnections (failed-attempts) within a specified time window (attempt-window). If a client is in the locked-out state, the BNG CPF drops all packets coming from the client. A locked-out client is unblocked when the specified block timer (block) expires or by using the session-lockout command in the clear mobile bng context.

The no form of this command removes the specified session lockout profile.

Parameters

profile-name

specifies the profile name, up to 32 characters

Context

• [Tree] configure mobile-gateway profile bng session-lockout-profile attempt-window

Description

This command specifies the time window in which the BNG CPF monitors the number of session setup failures and established session disconnections for a client. The client is blocked if that number exceeds the threshold (failed-attempts) within this time window.

Default

attempt-window 300

Parameters

seconds

specifies the time window in seconds

Values: 30 to 3600

Context

• [Tree] configure mobile-gateway profile bng session-lockout-profile block

Description

This command defines the time during which a locked-out client stays in locked-out state. The BNG CPF drops all packets coming from the client during this time.

Default

block 600

Parameters

seconds

specifies the time in seconds

Values: 60 to 86400

Context

• [Tree] configure mobile-gateway profile bng session-lockout-profile 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 description from the configuration.

Default

no description

Parameters

description-string

Specifies 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 profile bng session-lockout-profile failed-attempts

Description

This command defines the number of session setup failures and established session disconnections within a specified time window (attempt-window) before the client is blocked.

Default

failed-attempts 3

Parameters

number

specifies the number of session setup failures

Values: 2 to 16

Context

• [Tree] configure mobile-gateway profile bng wpp

Description

This command enables the context to configure interface-related WPP parameters.

Context

• [Tree] configure mobile-gateway profile bng wpp portal

Description

This command configures a WPP portal.

The no form of this command removes the configuration.

Parameters

name

specifies the name of the WPP portal, up to 32 characters

Context

• [Tree] configure mobile-gateway profile bng wpp portal ack-auth-retry-count

Description

This command configures the number of retransmissions of an ACK_AUTH message.

The no form of this command reverts to the default.

Default

no ack-auth-retry-count

Parameters

number

specifies the number of ACK_AUTH retransmissions

Values: 0 to 5

Default: 5

Context

• [Tree] configure mobile-gateway profile bng wpp portal address

Description

This command configures the IP address of the portal.

The no form of this command removes the configuration.

Default

no address

Parameters

ip-address | ipv6-address

specifies an IPv4 or IPv6 unicast address

Values	ip-address	a.b.c.d
	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

Context

• [Tree] configure mobile-gateway profile bng wpp portal 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 description from the configuration.

Default

no description

Parameters

description-string

Specifies 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 profile bng wpp portal ntf-logout-retry-count

Description

This command configures the number of retransmissions of an NTF_LOGOUT message.

The no form of this command reverts to the default.

Default

no ntf-logout-retry-count

Parameters

number

specifies the number of NTF_LOGOUT retransmissions

Values: 0 to 5

Default: 5

Context

• [Tree] configure mobile-gateway profile bng wpp portal retry-interval

Description

This command configures the time interval, in number of seconds, between two consecutive retransmissions.

The no form of this command reverts to the default.

Default

no retry-interval

Parameters

seconds

specifies the time interval in seconds

Values: 1 to 20

Default: 2

Context

• [Tree] configure mobile-gateway profile bng wpp portal router

Description

This command configures the routing instance through which the portal is reachable. This is a mandatory configuration for the portal.

The no form of this command removes the configuration.

Default

no router

Parameters

router-instance

specifies the routing instance, up to 32 characters

Context

• [Tree] configure mobile-gateway profile bng wpp portal secret

Description

This command configures the secret that is used by WPPv2 to authenticate the messages between the portal and the BRAS.

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

Default

no secret

Parameters

password

specifies the secret, up to 64 characters

hash | hash2

specifies the version of the hash algorithm used for the encryption of the secret. If the hash or hash2 keyword is not used, the secret is assumed to be in an unencrypted clear text form.

Context

• [Tree] configure mobile-gateway profile bng wpp portal 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 profile bng wpp portal source-address

Description

This command configures the source IP address for sending WPP messages to the portal. The specified IP address must be an interface IP address in the routing instance (see router). This is a mandatory configuration for the portal.

The no form of this command removes the configuration.

Default

no source-address

Parameters

ip-address | ipv6-address

specifies an IPv4 or IPv6 address

Values	ip-address	a.b.c.d
	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

Context

• [Tree] configure mobile-gateway profile bng wpp portal version

Description

This command configures the WPP protocol version that the portal uses.

The no form of this command reverts to the default.

Default

no version

Parameters

version

specifies the WPP protocol version

Values: 1 to 2

Default: 2

Context

• [Tree] configure mobile-gateway profile bng wpp portal-group

Description

This command configures a WPP portal group.

The no form of this command removes the configuration.

Parameters

name

specifies the name of the portal group, up to 32 characters

Context

• [Tree] configure mobile-gateway profile bng wpp portal-group 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 description from the configuration.

Default

no description

Parameters

description-string

Specifies 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 profile bng wpp portal-group portal

Description

This command adds a WPP portal to the portal group. The portal is defined using the portal command in the configure mobile-gateway profile bng wpp context (see portal). Multiple instances of this command are allowed.

The no form of this command removes the specified portal from the portal group.

Parameters

name

specifies the name of the portal, up to 32 characters

Context

• [Tree] configure mobile-gateway profile bng wpp portal-group realm

Description

This command specifies the network realm on the BNG-UP. BNG sessions within the realm are authenticated by the portals in the portal group. This is a mandatory configuration.

The no form of this command removes the configuration.

Parameters

realm

specifies the name of the network realm on the BNG-UP, up to 32 characters

Context

• [Tree] configure mobile-gateway profile bng wpp portal-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 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.