Nokia-specific information elements

Get a description of the new and modified vendor-specific information elements required for the MAG-c.

Format of the information elements

A PFCP message may contain several IEs with support for TLV coded PFCP IEs and PFCP grouped IEs.

Table 1. IE format
Bits
Octets 8 7 6 5 4 3 2 1
1 to 2 Type = xxx (decimal)
3 to 4 Length = n
5 to 6 Enterprise ID
7 to (n+4) IE-specific data or content of a grouped IE

An IE has the following fields.

  • Type

    This field is mandatory and indicates the type of the information element. IE type values within the range of 0 to 32767 are reserved for IEs defined by 3GPP. IE type values within the range of 32768 to 65535 are used for vendor-specific IEs. The vendor controls the value allocation of vendor-specific IEs.

  • Length

    This field is mandatory and contains the length of the IE excluding the first four octets, which are common for all IEs (type and length). Bit 8 of the lowest numbered octet is the most significant bit and bit 1 of the highest numbered octet is the least significant bit.

  • Enterprise ID

    This field is optional. If the IE type value is within the range of 32768 to 65535, this field contains the IANA-assigned SMI Network Management Private Enterprise Codes value of the vendor defining the IE.

3GPP IE format describes the format of a 3GPP-defined IE. The range of the IE type is 0 to 32767.

Table 2. 3GPP IE format
Bits
Octets 8 7 6 5 4 3 2 1
1 to 2 Type = xxx (decimal)
3 to 4 Length = n
5 to (n+4) IE-specific data or content of a grouped IE

Vendor-specific IE format describes the format of a vendor-specific IE. The range of the IE type is 32768 to 65535.

Table 3. Vendor-specific IE format
Bits
Octets 8 7 6 5 4 3 2 1
1 to 2 Type = xxx (decimal)
3 to 4 Length = n
5 to 6 Enterprise ID
7 to (n+4) IE-specific data or content of a grouped IE
Note: If the last field of an IE contains the statement “Present only if explicitly specified”, the IE can be extended in a later version.

Nokia Detailed Error IE

Table 4. Nokia Detailed Error IE
Bits
Octets 8 7 6 5 4 3 2 1
1 to 2 Type = 32779 (decimal)
3 to 4 Length = n
5 to 6 Enterprise ID = 3729
7 to (n+4) Detailed Error

The BNG-UP sends this IE in response messages to the MAG-c when the Cause IE does not indicate success. The IE contains detailed error information in addition to the generic error indicated by the Cause IE.

The Detailed Error field is encoded as a printable ASCII string without zero-byte termination. The string length is derived from the IE length.

Nokia SAP Template IE

Table 5. Nokia SAP Template IE
Bits
Octets 8 7 6 5 4 3 2 1
1 to 2 Type = 32775 (decimal)
3 to 4 Length = n
5 to 6 Enterprise ID = 3729
7 to (n+4) SAP Template

The MAG-c sends this IE to the BNG-UP to indicate a SAP template. The BNG-UP uses the SAP template to construct a new internal SAP structure for the creation of a forwarding state.

The SAP Template field is encoded as a printable ASCII string without zero-byte termination. The string length is derived from the IE length.

Nokia Group Interface Template

Table 6. Nokia Group Interface Template IE
Bits
Octets 8 7 6 5 4 3 2 1
1 to 2 Type = 32776 (decimal)
3 to 4 Length = n
5 to 6 Enterprise ID = 3729
7 to (n+4) Group Interface Template

The MAG-c sends this IE to the BNG-UP to indicate the group interface template that needs to be used to create a forwarding state on the BNG-UP.

The Group Interface Template field is encoded as a printable ASCII string without zero-byte termination. The string length is derived from the IE length.

Nokia QoS Override IE

Table 7. Nokia QoS Override IE
Bits
Octets 8 7 6 5 4 3 2 1
1 to 2 Type = 32780 (decimal)
3 to 4 Length = n
5 to 6 Enterprise ID = 3729
7 to (n+4) QoS-Overrides

The QoS-Overrides field is encoded as described in the 7450 ESS, 7750 SR, and VSR RADIUS Attributes Reference Guide for the VSA Alc-Subscriber-QoS-Override.

Nokia Create Filter Override

Table 8. Nokia Create Filter Override IE
Bits
Octets 8 7 6 5 4 3 2 1
1 to 2 Type = 32788 (decimal)
3 to 4 Length = n
5 to 6 Enterprise ID = 3729
7 Filter Type
8 to (n+4) Filter Override
The type of the Filter Type field is an enumeration of the following values:
  • 0: ingress IPv4 filter
  • 1: egress IPv4 filter
  • 2: ingress IPv6 filter
  • 3: egress IPv6 filter

If n = 3, the Filter Override field is not present. All filtering for the specified filter type is disabled.

If n > 3, the Filter Override field contains a filter name.

Nokia Delete Filter Override IE

Table 9. Nokia Delete Filter Override IE
Bits
Octets 8 7 6 5 4 3 2 1
1 to 2 Type = 32789 (decimal)
3 to 4 Length = n
5 to 6 Enterprise ID = 3729
7 Filter Type
8 to (n+4) Present only if explicitly specified

The type of the Filter Type field is the same enumeration as defined for the Nokia Create Filter Override IE.

This IE indicates that the filter override needs to be removed. The system falls back to the default filters configured for the session. This differs from an absent Filter Override field in the Nokia Create Filter Override IE (see Nokia Create Filter Override). The absent Filter Override field in the Nokia Create Filter Override IE explicitly disables all filtering, including the default filters.

Nokia Intermediate Destination IE

Table 10. Nokia Intermediate Destination IE
Bits
Octets 8 7 6 5 4 3 2 1
1 to 2 Type = 32790 (decimal)
3 to 4 Length = n
5 to 6 Enterprise ID = 3729
7 to (n+4) Intermediate Destination

The Intermediate Destination field is encoded as described in the 7450 ESS, 7750 SR, and VSR RADIUS Attributes Reference Guide for VSA Alc-Int-Dest-Id-Str.

Nokia Measurement Information IE

Table 11. Nokia Measurement Information IE
Bits
Octets 8 7 6 5 4 3 2 1
1 to 2 Type = 32781 (decimal)
3 to 4 Length = n
5 to 6 Enterprise ID = 3729
7 Spare DET
8 to (n+4) Present only if explicitly specified

This IE is an extension to the 3GPP Measurement Information IE. It defines how measurements are reported. The following additional bit is defined:

DET (7/1): includes detailed per queue and policer statistics in usage reports related to the URR for which this is signaled.

Nokia UP Function Features IE

Table 12. Nokia UP Function Features IE
Bits
Octets 8 7 6 5 4 3 2 1
1 to 2 Type = 32787 (decimal)
3 to 4 Length = n
5 to 6 Enterprise ID = 3729
7 Nokia-supported features
8 to (n+4) Present only if explicitly specified

The BNG-UP sends this IE to indicate the support for vendor-specific functions that are not available on each version of the Nokia BNG-UP.

The following Nokia UP function features are defined.

  • Bulk (7/1)

    The BNG-UP supports the bulk audit feature.

  • NAT (7/2)

    The BNG-UP supports Nokia-specific extensions to subscriber-aware NAT.

  • LAC (7/3)

    The BNG-UP supports the Nokia LAC implementation where the UP is responsible for L2TP control plane signaling.

  • SSSG (7/3)

    The BNG-UP supports shared subscriber subnet signaling (SSSG) with each session to announce in routing.

Nokia PFCPHB-Flags IE

Table 13. Nokia PFCPHB-Flags IE
Bits
Octets 8 7 6 5 4 3 2 1
1 to 2 Type = 32797 (decimal)
3 to 4 Length = n
5 to 6 Enterprise ID = 3729
7 Spare Aud-E Aud-S Aud-R
8 to (n+4) Present only if explicitly specified
The audit flags indicate the following.
  • Aud-R

    The BNG-UP sends this flag to the MAG-c to indicate a mass audit request on this path. This flag may only be set if the MAG-c indicated support for the bulk audit feature.

  • Aud-S

    The MAG-c sends this flag to the BNG-UP to indicate the start of mass audit on this path. This flag may only be set if the BNG-UP indicated support for the bulk audit feature.

  • Aud-E

    The MAG-c sends this flag to the BNG-UP to indicate the end of mass audit on this path. This flag may only be set if the BNG-UP indicated support for the bulk audit feature.

Nokia PFCPSMReq-Flags IE

Table 14. Nokia PFCPSMReq-Flags IE
Bits
Octets 8 7 6 5 4 3 2 1
1 to 2 Type = 32783 (decimal)
3 to 4 Length = n
5 to 6 Enterprise ID = 3729
7 Spare Abs
8 to (n+4) Present only if explicitly specified

The Abs flag field indicates that the modification is absolute and not relative. Any rules or traffic endpoints that were not explicitly created in this message must be deleted. This flag may only be set if the BNG-UP indicated support for the bulk audit feature.

Nokia State ID IE

Table 15. Nokia State ID IE
Bits
Octets 8 7 6 5 4 3 2 1
1 to 2 Type = 32777 (decimal)
3 to 4 Length = n
5 to 6 Enterprise ID = 3729
7 to (n+4) State

The State field is an opaque value that is not interpreted by the BNG-UP but reflected as-is, in PFCP Session Modification Response and PFCP Session Report Request messages.

Nokia NAT ISA Members IE

Table 16. Nokia NAT ISA Members IE
Bits
Octets 8 7 6 5 4 3 2 1
1 to 2 Type = 32791 (decimal)
3 to 4 Length = n
5 to 6 Enterprise ID = 3729
7 Number of ISA members
8 to (n+4) Present only if explicitly specified

The BNG-UP sends this IE to indicate the number of ISA members in a NAT group. When not signaled, the Nokia MAG-c assumes the number to be 1.

Nokia format for QoS policy in the Activate Predefined Rules IE

To create BNG QoS profiles, Nokia formats the Activate Predefined Rules IE as follows:

qos_policy ::= (profile-name ':' value ';')+

where profile-name is slaprof or subprof. Each profile-name can occur at most one time.

  • slaprof

    This is an SLA profile as directly defined on the BNG-UP. No string-to-profile mappings are used.

  • subprof

    This is a subscriber profile as directly defined on the BNG-UP. No string-to-profile mappings are used.

Nokia L2TP Init Rx LCP Conf Request IE

Table 17. Nokia L2TP Init Rx LCP Conf Request IE
Bits
Octets 8 7 6 5 4 3 2 1
1 to 2 Type = 32800 (decimal)
3 to 4 Length = n
5 to 6 Enterprise ID = 3729
7 to n+4 LCP Configure Request message

This IE includes the first LCP Configure Request Message received by a LAC MAG-c. It is used to proxy to an LNS.

This IE is used to proxy PPP setup parameters from a LAC MAG-c to an LNS. For more details, see RFC 1661, section 4.4.5.

Nokia L2TP Last Tx LCP Conf Request IE

Table 18. Nokia L2TP Last Tx LCP Conf Request IE
Bits
Octets 8 7 6 5 4 3 2 1
1 to 2 Type = 32801 (decimal)
3 to 4 Length = n
5 to 6 Enterprise ID = 3729
7 to n+4 LCP Configure Request message

This IE includes the last LCP Configure Request Message received by a LAC MAG-c. It is used to proxy to an LNS.

This IE is used to proxy PPP setup parameters from a LAC MAG-c to an LNS. For more details, see RFC 1661, section 4.4.5.

Nokia L2TP Last Rx LCP Conf Request IE

Table 19. Nokia L2TP Last Rx LCP Conf Request IE
Bits
Octets 8 7 6 5 4 3 2 1
1 to 2 Type = 32802 (decimal)
3 to 4 Length = n
5 to 6 Enterprise ID = 3729
7 to n+4 LCP Configure Request message

This IE includes the last LCP Configure Request Message received by a LAC MAG-c. It is used to proxy to an LNS.

This IE is used to proxy PPP setup parameters from a LAC MAG-c to an LNS. For more details, see RFC 1661, section 4.4.5.

Nokia L2TP Authentication Type IE

Table 20. Nokia L2TP Authentication Type IE
Bits
Octets 8 7 6 5 4 3 2 1
1 to 2 Type = 32803 (decimal)
3 to 4 Length = n
5 to 6 Enterprise ID = 3729
7 Authentication Type
8 to n+4 Present only if explicitly specified

This IE indicates which authentication method was used between the LAC MAG-c and the PPPoE client. The type of the Authentication Type field is an enumeration of the following values:

  • 0: CHAP
  • 1: PAP

This IE is used to proxy PPP setup parameters from a LAC MAG-c to an LNS. For more details, see RFC 1661, section 4.4.5.

Nokia L2TP Authentication Name IE

Table 21. Nokia L2TP Authentication Name IE
Bits
Octets 8 7 6 5 4 3 2 1
1 to 2 Type = 32804 (decimal)
3 to 4 Length = n
5 to 6 Enterprise ID = 3729
7 to n+4 Username

This IE includes the username used during authentication between the LAC MAG-c and the PPPoE Client.

This IE is used to proxy PPP setup parameters from a LAC MAG-c to an LNS. For more details, see RFC 1661, section 4.4.5.

Nokia L2TP Authentication ID IE

Table 22. Nokia L2TP Authentication ID IE
Bits
Octets 8 7 6 5 4 3 2 1
1 to 2 Type = 32805 (decimal)
3 to 4 Length = n
5 to 6 Enterprise ID = 3729
7 Authentication ID
8 to n+4 Present only if explicitly specified

This IE includes the ID used during authentication between the LAC MAG-c and the PPPoE client.

This IE is used to proxy PPP setup parameters from a LAC MAG-c to an LNS. For more details, see RFC 1661, section 4.4.5.

Nokia L2TP Authentication Challenge IE

Table 23. Nokia L2TP Authentication Challenge IE
Bits
Octets 8 7 6 5 4 3 2 1
1 to 2 Type = 32806 (decimal)
3 to 4 Length = n
5 to 6 Enterprise ID = 3729
7 to n+4 Challenge

This IE includes the challenge used during CHAP authentication between the LAC MAG-c and the PPPoE Client.

This IE is used to proxy PPP setup parameters from a LAC MAG-c to an LNS. For more details, see RFC 1661, section 4.4.5.

Nokia L2TP Authentication Response IE

Table 24. Nokia L2TP Authentication Response IE
Bits
Octets 8 7 6 5 4 3 2 1
1 to 2 Type = 32807 (decimal)
3 to 4 Length = n
5 to 6 Enterprise ID = 3729
7 to n+4 Challenge

This IE includes the challenge response or password used during the authentication between the LAC MAG-c and the PPPoE Client.

This IE is used to proxy PPP setup parameters from a LAC MAG-c to an LNS. For more details, see RFC 1661, section 4.4.5.

Nokia L2TP Client Endpoint IE

Table 25. Nokia L2TP Client Endpoint IE
Bits
Octets 8 7 6 5 4 3 2 1
1 to 2 Type = 32809 (decimal)
3 to 4 Length = 6
5 to 6 Enterprise ID = 3729
7 to 10 IPv4 address

The LAC BNG-UP uses the IP address in this IE to set up an L2TP tunnel.

Nokia L2TP Server Endpoint IE

Table 26. Nokia L2TP Server Endpoint IE
Bits
Octets 8 7 6 5 4 3 2 1
1 to 2 Type = 32810 (decimal)
3 to 4 Length = 6
5 to 6 Enterprise ID = 3729
7 to 10 IPv4 address

The LAC BNG-UP sets up an L2TP tunnel toward the IP address in this IE.

Nokia L2TP Client Auth ID IE

Table 27. Nokia L2TP Client Auth ID IE
Bits
Octets 8 7 6 5 4 3 2 1
1 to 2 Type = 32811 (decimal)
3 to 4 Length = n
5 to 6 Enterprise ID = 3729
7 to n+4 Name

The Name field in this ID identifies the hostname of the LAC.

Nokia L2TP Server Auth ID IE

Table 28. Nokia L2TP Server Auth ID IE
Bits
Octets 8 7 6 5 4 3 2 1
1 to 2 Type = 32812 (decimal)
3 to 4 Length = n
5 to 6 Enterprise ID = 3729
7 to n+4 Name

The Name field in this ID identifies the hostname of the LNS.

Nokia L2TP Password IE

Table 29. Nokia L2TP Password IE
Bits
Octets 8 7 6 5 4 3 2 1
1 to 2 Type = 32813 (decimal)
3 to 4 Length = n
5 to 6 Enterprise ID = 3729
7 to n+4 Password

This IE includes the password used for tunnel authentication.

Nokia L2TP Assignment ID IE

Table 30. Nokia L2TP Assignment ID IE
Bits
Octets 8 7 6 5 4 3 2 1
1 to 2 Type = 32814 (decimal)
3 to 4 Length = n
5 to 6 Enterprise ID = 3729
7 to n+4 Name

This IE includes a name for a tunnel or a group of tunnels.

Nokia L2TP Private Group ID IE

Table 31. Nokia L2TP Private Group ID IE
Bits
Octets 8 7 6 5 4 3 2 1
1 to 2 Type = 32815 (decimal)
3 to 4 Length = n
5 to 6 Enterprise ID = 3729
7 to n+4 Group ID

An LNS can use the Group ID in this IE to correlate a group of customers.

Nokia L2TP Parameters IE

Table 32. Nokia L2TP Parameters IE
Bits
Octets 8 7 6 5 4 3 2 1
1 to 2 Type = 32816 (decimal)
3 to 4 Length = n
5 to 6 Enterprise ID = 3729
7 to 11 Parameter Inclusion Flags
12 to n+4 Parameters

This IE contains a set of fixed-width parameters that influence tunnel set up. The Parameter Inclusion Flags field contains a list of flags that indicates whether a specific parameter is present or not.

The following table lists for all supported parameters the name, the description, the flag number (1 to 32), and the number of bytes used by the parameter. The flag number correlates to a bit in the Parameter Inclusion Flags field, that is, flag 1 corresponds with 0x00000001 and flag 32 with 0x80000000. The parameters that are flagged for inclusion are included in the Parameters field in order of flag number.

Table 33. L2TP parameters
Parameter Description Flag Number of bytes
Algorithm

The algorithm for tunnel selection:

  • 1: weighted-access
  • 2: existing-first
  • 3: weighted-random
1 1
AVP Hiding

The level of AVP hiding:

  • 1: nothing
  • 2: sensitive-only
  • 3: all
2 1
Challenge

Indicates whether to use L2TP tunnel authentication:

  • 1: never
  • 2: always
3 1
DF BIT

Indicates whether the LAC clears the DF bit:

  • 0: clr-lac-data
  • 1: set-lac-data
4 1
Preference The relative preference of the tunnel 5 3
Session Limit The maximum number of sessions per tunnel or group of tunnels 6 3
Idle Timeout The time for which a tunnel without sessions is kept after removal of the last session 7 3
Hello Interval The interval between sending Hello messages 8 3
Destruct Timeout The time during which the tunnel data is operationally kept on the BNG-UP after a tunnel is disconnected 9 3
Max Retries Established The maximum number of times a message (for example, ICRQ) can be retried on an established tunnel before the peer is declared unreachable and the tunnel is disconnected 10 3
Max Retries Not Established The maximum number of times a message (for example, SCCRQ) can be retried on a not yet established tunnel before the peer is declared unreachable 11 3
Rx Window Size The maximum number of outstanding messages the L2TP peer may send 12 3

Nokia Access Line Parameters IE

Table 34. Nokia Access Line Parameters IE
Bits
Octets 8 7 6 5 4 3 2 1
1 to 2 Type = 32822 (decimal)
3 to 4 Length = n
5 to 6 Enterprise ID = 3729
7 to 11 Parameter Inclusion Flags
12 to n+4 Parameters

This IE contains a set of fixed-width access line parameters; for example, the access line characteristics as defined in BBF TR-101 and signaled in DHCP, DHCPv6 or PPPoE discovery. The Parameter Inclusion Flags field contains a list of flags that indicates whether a specific parameter is present or not. These values are signaled to be reflected in other BNG-UP specific protocols such as L2TP.

The following table lists for all supported parameters the name, the description, the flag number (1 to 32), and the number of bytes used by the parameter. The flag number correlates to a bit in the Parameter Inclusion Flags field, that is, flag 1 corresponds with 0x00000001 and flag 32 with 0x80000000. The parameters that are flagged for inclusion are included in the Parameters field in order of flag number.

Table 35. Access line parameters
Parameter Description Flag Number of bytes
Actual Data rate Upstream The actual upstream data rate of an access line, in Kbps 1 4
Actual Data rate Downstream The actual downstream data rate of an access line, in Kbps. 2 4
Minimum Data rate Upstream The minimum upstream data rate at which an access line is set to operate, in Kbps 3 4
Minimum Data rate Downstream The minimum downstream data rate at which an access line is set to operate, in Kbps 4 4
Attainable Data rate Upstream The maximum upstream data rate that can be achieved, in Kbps 5 4
Attainable Data rate Downstream The maximum downstream data rate that can be achieved, in Kbps 6 4
Maximum Data rate Upstream The maximum upstream data rate at which an access line is set to operate, in Kbps 7 4
Maximum Data rate Downstream The maximum downstream data rate at which an access line is set to operate, in Kbps 8 4
Minimum Data rate Upstream in low power state The minimum upstream data rate at which an access line is set to operate in low power state, in Kbps 9 4
Minimum Data rate Downstream in low power state The minimum downstream data rate at which an access line is set to operate in low power state, in Kbps 10 4
Maximum interleaving delay upstream The maximum one-way interleaving delay, in milliseconds 11 4
Actual interleaving delay upstream The actual one-way interleaving delay, in milliseconds 12 4
Maximum interleaving delay downstream The maximum one-way interleaving delay, in milliseconds 13 4
Actual interleaving delay upstream The actual one-way interleaving delay, in milliseconds 14 4
Access Loop Encapsulation The encapsulation type of the access link, as defined in BBF TR 101 15 3
IWF Session Indicates whether the IWF function was performed for this session to carry PPPoA traffic over PPPoE
Note: This field does not contain data, setting the flag in the Parameter Inclusion Flags indicates IWF.
16 0

Nokia L2TP IDs IE

Table 36. Nokia L2TP IDs IE
Bits
Octets 8 7 6 5 4 3 2 1
1 to 2 Type = 32817 (decimal)
3 to 4 Length = n
5 to 6 Enterprise ID = 3729
7 to 8 Local Tunnel ID
9 to 10 Remote Tunnel ID
11 to 12 Local Session ID
13 to 14 Remote Session ID
15 to 18 Call Serial Number
19 to n+4 Present only if explicitly specified

This IE contains identifiers that are negotiated during L2TP setup.

Nokia Access Line Circuit ID IE

Table 37. Nokia Access Line Circuit ID IE
Bits
Octets 8 7 6 5 4 3 2 1
1 to 2 Type = 32820 (decimal)
3 to 4 Length = n
5 to 6 Enterprise ID = 3729
7 to n+4 Circuit ID

This IE includes the circuit ID as learned from the access connection protocols such as DHCP, PPPoE discovery, and DHCPv6.

Nokia Access Line Remote ID IE

Table 38. Nokia Access Line Remote ID IE
Bits
Octets 8 7 6 5 4 3 2 1
1 to 2 Type = 32821 (decimal)
3 to 4 Length = n
5 to 6 Enterprise ID = 3729
7 to n+4 Remote ID

This IE includes the remote ID as learned from the access connection protocols such as DHCP, PPPoE discovery, and DHCPv6.