NE20E-S V800R022C00SPC600 Feature Description
Description of Associated AVPs
- AVP Format Convention
- Auth-Application-Id AVP
- CC-Output-Octets AVP
- CC-Request-Number AVP
- CC-Request-Type AVP
- CC-Time AVP
- CC-Total-Octets AVP
- Charging-Rule-Definition AVP
- Charging-Rule-Install AVP
- Charging-Rule-Name AVP
- Charging-Rule-Remove AVP
- Charging-Rule-Report AVP
- Destination-Host AVP
- Destination-Realm AVP
- Error-Message AVP
- Experimental-Result AVP
- Experimental-Result-Code AVP
- Event-Trigger AVP
- Feature-List AVP
- Feature-List-ID AVP
- Framed-IP-Address AVP
- Framed-IPv6-Prefix AVP
- Granted-Service-Unit AVP
- Guaranteed-Bitrate-DL AVP
- Guaranteed-Bitrate-UL AVP
- IP-CAN-Type AVP
- Max-Requested-Bandwidth-DL AVP
- Max-Requested-Bandwidth-UL AVP
- Monitoring-Key AVP
- Origin-Host AVP
- Origin-Realm AVP
- Origin-State-Id
- PCC-Rule-Status AVP
- QoS-Information AVP
- Re-Auth-Request-Type AVP
- Result-Code AVP
- Rule-Failure-Code AVP
- Session-Id AVP
- Session-Release-Cause AVP
- Subscription-Id AVP
- Subscription-Id-Data AVP
- Subscription-Id-Type AVP
- Supported-Features AVP
- Termination-Cause
- Usage-Monitoring-Information AVP
- Usage-Monitoring-Level AVP
- Usage-Monitoring-Report AVP
- User-Equipment-Info AVP
- User-Equipment-Info-Type AVP
- User-Equipment-Info-Value AVP
- Used-Service-Unit AVP
- Vendor-Id AVP
- Vendor-Specific-Application-Id AVP
- X-HW-User-Physical-Info-Value AVP
- X-HW-MS-Group-Name AVP
- X-HW-ACL-Group-Name AVP
- X-HW-Interim-Interval AVP
- X-HW-Service-Type AVP
AVP Format Convention
Format |
Description |
---|---|
<> |
The fixed position of the AVP is defined. |
{} |
The AVP must be present and can appear anywhere in a message. |
[] |
The AVP is optional and can appear anywhere in a message. The number of times that the AVP appears can be 0 or 1. |
*[] |
The AVP can appear anywhere in a message. |
Auth-Application-Id AVP
Description of AVP
AVP |
Description |
---|---|
Auth-Application-Id |
The Auth-Application-Id AVP (AVP Code 258) is of type Unsigned32 and is used to advertise support of the authentication and authorization of an application. The Auth-Application-Id must also be carried in all authentication and/or authorization messages that are defined in a separate Diameter specification and have an Application ID assigned. The maximum length of the Auth-Application-Id AVP supported by device is 127 bytes. NOTE:
On the device, the Auth-Application-Id AVP indicates the specific application of a Diameter message, and the value of Auth-Application-Id used by PCC on a Gx interface is 16777238. The Auth-Application-Id AVP is a sub-AVP, which is used in the group AVP vendor-specific-application-id. |
Reference Standards
RFC 3588 clause 6.8
CC-Output-Octets AVP
Description
AVP |
Description |
---|---|
CC-Output-Octets |
The code and type of the CC-Output-Octets AVP are 414 and Unsigned64, respectively. The AVP, with the maximum length of 8 bytes, indicates the total number of used downlink traffic bytes. This AVP is a sub-AVP and is used in the group AVP named Granted-Service-Unit. |
References
RFC 4006 clause 8.25
CC-Request-Number AVP
Description of AVP
AVP |
Description |
---|---|
CC-Request-Number |
The CC-Request-Number AVP (AVP Code 415) is of type Unsigned32 and identifies this request within one session. As Session-Id AVPs are globally unique, the combination of Session-Id and CC-Request-Number AVPs is also globally unique and can be used in matching credit-control messages with confirmations. An easy way to produce unique numbers is to set the value to 0 for a credit-control request of type INITIAL_REQUEST and EVENT_REQUEST and to set the value to 1 for the first UPDATE_REQUEST, to 2 for the second, and so on until the value for TERMINATION_REQUEST is one more than for the last UPDATE_REQUEST. NOTE:
On the device, the CC-Request-Number AVP identifies the sequence number of the CCR message. The count starts from 0 and the value does not change in retransmitted messages. This AVP is used independently. |
Reference Standards
RFC 4006 clause 8.2
CC-Request-Type AVP
Description of AVP
AVP |
Description |
---|---|
CC-Request-Type |
The CC-Request-Type AVP (AVP Code 416) is
of type Enumerated and contains the reason for sending the credit-control
request message. It must be present in all Credit-Control-Request
messages. The following values are defined for the CC-Request-Type
AVP:
NOTE:
This AVP is used independently. Currently, the device supports the following types of CC requests:
|
Reference Standards
RFC 4006 clause 8.3
CC-Time AVP
Description of AVP
AVP |
Description |
---|---|
CC-Time |
The CC-Time AVP (AVP Code 420) is of type Unsigned32 and indicates the length of the requested, granted, or used time in seconds. The CC-Time AVP is a sub-AVP, which is used in the group AVP Granted-Service-Unit. |
References
RFC 4006 clause 8.21
CC-Total-Octets AVP
Description
AVP |
Description |
---|---|
CC-Total-Octets |
The CC-Total-Octets AVP (AVP Code 421) is of type Unsigned64 and contains the total number of requested, granted, or used octets regardless of the direction (sent or received). The CC-Total-Octets AVP is a sub-AVP, which is used in the group AVP Granted-Service-Unit. |
References
RFC 4006 clause 8.23
Charging-Rule-Definition AVP
Description of AVP
AVP |
Description |
---|---|
Charging-Rule-Definition |
The Charging-Rule-Definition AVP (AVP code 1003) is of type Grouped, and it defines the PCC rule for a service flow sent by the PCRF to the PCEF. A Charging-Rule-Name AVP is generated by a PCRF and is globally unique. If a PCC rule needs to be deleted, add the value of the Charging-Rule-Name AVP in the Charging-Rule-Remove AVP. If optional AVPs within a Charging-Rule-Definition AVP are omitted, but corresponding information has been provided in previous Gx messages, the previous information remains valid. The Monitoring-Key AVP contains the monitoring key that can be applied to the PCC rule. Charging-Rule-Definition ::= < AVP Header: 1003 > { Charging-Rule-Name } [ QoS-Information ] [ Monitoring-Key ] [ X-HW-ACL-Group-Name ] [ X-HW-Interim-Interval ] *[ AVP ] NOTE:
The device receives but does not process *[AVP] in the AVP format description, that is, the device processes the AVPs listed in this document and ignores other AVPs. The Charging-Rule-Definition AVP is a sub-AVP, which is used in the group AVP charging-rule-install. The Charging-Rule-Definition AVP is also a group AVP, which contains the charging-rule-name, precedence, gx-x-hw-service-type, qos-information, and gx-r9-usage-monitoring-key sub-AVPs. |
Reference Standards
3GPP TS 29.212 V9.7.0 clause 5.3.4
Charging-Rule-Install AVP
Description of AVP
AVP |
Description |
---|---|
Charging-Rule-Install |
The Charging-Rule-Install AVP (AVP code 1001) is of type Grouped, and it is used to activate, install or modify PCC rules as instructed from the PCRF to the PCEF. For installing a new PCC rule or modifying a PCC rule already installed, Charging-Rule-Definition AVP shall be used. For activating a specific PCC rule predefined at the PCEF, Charging-Rule-Name AVP shall be used as a reference for that PCC rule. Charging-Rule-Install ::= < AVP Header: 1001 > *[ Charging-Rule-Definition ] *[ Charging-Rule-Name ] *[ AVP ] NOTE:
The device receives but does not process *[AVP] in the AVP format description, that is, the device processes the AVPs listed in this document and ignores other AVPs. The Charging-Rule-Install AVP is a group AVP, which contains the charging-rule-definition and charging-rule-name sub-AVPs. |
Reference Standards
3GPP TS 29.212 V9.7.0 clause 5.3.2
Charging-Rule-Name AVP
Description of AVP
AVP |
Description |
---|---|
Charging-Rule-Name |
The Charging-Rule-Name AVP (AVP code 1005) is of type OctetString, and it defines a name for PCC rule. For PCC rules provided by the PCRF it uniquely identifies a PCC rule within one IP CAN session. For PCC rules pre-defined at the PCEF it uniquely identifies a PCC rule within the PCEF. The maximum length of the Charging-Rule-Name AVP is 67 bytes. |
Reference Standards
3GPP TS 29.212 V9.7.0 clause 5.3.6
Charging-Rule-Remove AVP
Description of AVP
AVP |
Description |
---|---|
Charging-Rule-Remove |
The Charging-Rule-Remove AVP (AVP code 1002) is of type Grouped, and it is used to deactivate or remove PCC rules from an IP CAN session. Charging-Rule-Name AVP is a reference for a specific PCC rule at the PCEF to be removed or for a specific PCC rule predefined at the PCEF to be deactivated. AVP Format: Charging-Rule-Remove ::= < AVP Header: 1002 > *[ Charging-Rule-Name ] *[ AVP ] NOTE:
The device receives but does not process *[AVP] in the AVP format description, that is, the device processes the AVPs listed in this document and ignores other AVPs. |
Reference Standards
3GPP TS 29.212 V9.7.0 clause 5.3.3
Charging-Rule-Report AVP
Description of AVP
AVP |
Description |
---|---|
Charging-Rule-Report |
The Charging-Rule-Report AVP (AVP code 1018) is of type Grouped, and it is used to report the status of PCC rules.
AVP Format: Charging-Rule-Report ::= < AVP Header:1018 > *[Charging-Rule-Name] [PCC-Rule-Status] [Rule-Failure-Code] *[AVP] NOTE:
The device receives but does not process *[AVP] in the AVP format description, that is, the device processes the AVPs listed in this document and ignores other AVPs. The Charging-Rule-Report AVP is a group AVP, which contains the charging-rule-name, pcc-rule-status, rule-failure-code, and final-unit-indication sub-AVPs. |
Reference Standards
3GPP TS 29.212 V9.7.0 clause 5.3.18
Destination-Host AVP
Description of AVP
AVP |
Description |
---|---|
Destination-Host |
The Destination-Host AVP (AVP Code 293) is of type DiameterIdentity. The Destination-Host AVP may be carried in request messages, and must not be carried in response messages. The absence of the Destination-Host AVP will cause a request to be sent to any Diameter server that supports the application within the realm specified in Destination-Realm AVP. The Destination-Host AVP must be placed as close to the Diameter packet header as possible. |
Reference Standards
RFC 3588 clause 6.5
Destination-Realm AVP
Description of AVP
AVP |
Description |
---|---|
Destination-Realm |
The Destination-Realm AVP (AVP Code 283) is of type DiameterIdentity. The maximum length of the Destination-Realm AVP is 127 bytes. The Destination-Realm AVP must not be carried in response messages. The User-Name AVP needs to be added to a request sent by a Diameter client. Diameter servers initiate a request message using the value of the Origin-Realm AVP carried in a previous message that is sent from the target host. The Destination-Realm AVP is used to perform message routing decisions. The Destination-Realm AVP must be placed as close to the Diameter packet header as possible. |
Reference Standards
RFC 3588 clause 6.6
Error-Message AVP
Description of AVP
AVP |
Description |
---|---|
Error-Message |
The Error-Message AVP (AVP Code 281) is of type UTF8String, and it may accompany a Result-Code AVP as a readable error message. The Error-Message AVP cannot be parsed by NEs. |
Reference Standards
RFC 3588 clause 7.3
Experimental-Result AVP
Description of AVP
AVP |
Description |
---|---|
Experimental-Result |
The Experimental-Result AVP (AVP Code 297) is of type Grouped, and it indicates whether a particular vendor-specific request was completed successfully or whether an error occurred, and the vendor ID. AVP Format: Experimental-Result ::= < AVP Header:297 > { Vendor-Id } { Experimental-Result-Code } |
Reference Standards
RFC 3588 clause 7.6
Experimental-Result-Code AVP
Description of AVP
AVP |
Description |
---|---|
Experimental-Result-Code |
The Experimental-Result-Code AVP (AVP Code 298) is of type Unsigned32 and it contains a vendor-assigned value representing the result of processing the request. The maximum length is 4 bytes. |
Reference Standards
RFC 3588 clause 7.7
Event-Trigger AVP
Description of AVP
AVP |
Description |
---|---|
Event-Trigger |
The Event-Trigger AVP (AVP code 1006) is of type Enumerated. When sent from the PCRF to the PCEF the Event-Trigger AVP indicates an event that shall cause a re-request of PCC rules. When sent from the PCEF to the PCRF the Event-Trigger AVP indicates that the corresponding event has occurred at the gateway. Whenever one of these events occurs, the PCEF shall send the related AVP that has changed together with the event trigger indication. The following values are defined in 3GPP TS 29.212 V9.7.0:
NOTE:
The Event-Trigger AVP is used independently. The following values are supported for the Event-Trigger AVP on the device:
|
Reference Standards
3GPP TS 29.212 V9.7.0 clause 5.3.7
Feature-List AVP
Description
AVP |
Description |
---|---|
Feature-List |
The Feature-List AVP (AVP Code 630) is of type Unsigned32 and contains a bit mask indicating the supported features of an application. The Feature-List AVP is a sub-AVP, which is used in the group AVP Supported-Features. |
References
3GPP TS 29.212 V9.7.0 clause 5.4.1
3GPP TS 29.229 V8.7.0 clause 6.3.31
Feature-List-ID AVP
Description
AVP |
Description |
---|---|
Feature-List-ID |
The Feature-List-ID AVP (AVP Code 629) is of type Unsigned32 and contains the identity of a feature list. The Feature-List-ID AVP is a sub-AVP, which is used in the group AVP Supported-Features. |
References
3GPP TS 29.212 V9.7.0 clause 5.4.1
3GPP TS 29.229 V8.7.0 clause 6.3.30
Framed-IP-Address AVP
Description of AVP
AVP |
Description |
---|---|
Framed-IP-Address |
The Framed-IP-Address AVP (AVP Code 8) is of type OctetString and contains an IPv4 address of the type specified in the attribute value to be configured for the user. An IPv4 address and/or an IPv6 address must be carried in a CCR message. The Framed-IP-Address AVP length is 4 bytes. |
Reference Standards
RFC 4005 clause 6.11.1
Framed-IPv6-Prefix AVP
Description of AVP
AVP |
Description |
---|---|
Framed-IPv6-Prefix |
The Framed-IPv6-Prefix AVP (AVP Code 97) is of type OctetString and contains the IPv6 prefix to be configured for the user. An IPv6 prefix or an IPv4 address must be carried in a CCR message. The Framed-IPv6-Prefix AVP length is 18 bytes. The first byte is reserved and the second byte indicates the prefix length (the prefix length ranges from 0 to 128 bytes). The last 16 bytes constitute the prefix. Three IPv6 address formats are supported:
|
Reference Standards
RFC 4005 clause 6.11.6
Granted-Service-Unit AVP
Description of AVP
AVP |
Description |
---|---|
Granted-Service-Unit |
Granted-Service-Unit AVP (AVP Code 431) is of type Grouped and it indicates the quotas sent from the PCRF to users. AVP Format: Granted-Service-Unit ::= < AVP Header:431 > [ CC-Time ] [ CC-Total-Octets ] *[ AVP ] NOTE:
The device receives but does not process *[AVP] in the AVP format description, that is, the device processes the AVPs listed in this document and ignores other AVPs. |
Reference Standards
RFC 4006 clause 8.17
Guaranteed-Bitrate-DL AVP
Description of AVP
AVP |
Description |
---|---|
Guaranteed-Bitrate-DL |
The Guaranteed-Bitrate-DL AVP (AVP code 1025) is of type Unsigned32, and it indicates the guaranteed bit rate for a downlink service data flow, in bit/s. The Guaranteed-Bitrate-DL AVP length supported by device is 4 bytes. |
Reference Standards
3GPP TS 29.212 V9.7.0 clause 5.3.25
Guaranteed-Bitrate-UL AVP
Description of AVP
AVP |
Description |
---|---|
Guaranteed-Bitrate-UL |
The Guaranteed-Bitrate-UL AVP (AVP code 1026) is of type Unsigned32, and it indicates the guaranteed bit rate for an uplink service data flow, in bit/s. The Guaranteed-Bitrate-UL AVP length supported by device is 4 bytes. AVP format: |
Reference Standards
3GPP TS 29.212 V9.7.0 clause 5.3.26
IP-CAN-Type AVP
Description of AVP
AVP |
Description |
---|---|
IP-CAN-Type |
The IP-CAN-Type AVP (AVP code 1027) is of type Enumerated, and it shall indicate the type of Connectivity Access Network in which the user is connected. The IP-CAN-Type AVP shall always be present during the IP-CAN session establishment. This AVP is included in a CCR-Initial message. The following values
are defined in 3GPP TS 29.212:
NOTE:
For device, the value range of IP-CAN-Type AVP is as follows:
For WiFi users, the IP-CAN-Type AVP is set to WLAN. In other modes, the IP-CAN-Type AVP is set to XDSL. The PCRF determines a policy for users based on the IP-CAN-Type AVP. The policy used varies with the access mode. When the access mode changes, the PCEF sends a message carrying a new access mode and the IP_CAN_CHANGE trigger. The message requests that the PCRF deliver a relevant policy so that the PCEF can implement policy control based on the access mode. |
Reference Standards
3GPP TS 29.212 V9.7.0 clause 5.3.27
Max-Requested-Bandwidth-DL AVP
Description of AVP
AVP |
Description |
---|---|
Max-Requested-Bandwidth-DL |
The Max-Requested-Bandwidth-DL AVP (AVP code 515) is of type Unsigned32, and it indicates the maximum bandwidth for a downlink IP flow, in bit/s. The Max-Requested-Bandwidth-DL AVP length supported by device is 4 bytes. If the Max-Requested-Bandwidth-DL AVP is carried in CC-Request messages, it indicates the maximum requested bandwidth. If the Max-Requested-Bandwidth-DL AVP is carried in CC-Answer messages, it indicates the maximum requested bandwidth of the PCRF. |
Reference Standards
3GPP TS 29.214 V11.6.0 clause 5.3.14
Max-Requested-Bandwidth-UL AVP
Description of AVP
AVP |
Description |
---|---|
Max-Requested-Bandwidth-UL |
The Max-Bandwidth-UL AVP (AVP code 516) is of type Unsigned32, and it indicates the maximum requested bandwidth for an uplink IP flow, in bit/s. The Max -Bandwidth-UL AVP length supported by device is 4 bytes. If the Max-Requested-Bandwidth-UL AVP is carried in CC-Request messages, it indicates the maximum requested bandwidth. If the Max-Requested-Bandwidth-UL AVP is carried in CC-Answer messages, it indicates the maximum requested bandwidth of the PCRF. |
Reference Standards
3GPP TS 29.214 V11.6.0 clause 5.3.15
Monitoring-Key AVP
Description of AVP
AVP |
Description |
---|---|
Monitoring-Key |
The Monitoring-Key AVP (AVP code 1066) is of type OctetString. The Monitoring-Key AVP is an identifier of a quota monitoring instance and used for quota monitoring. The Usage-Monitoring-Information AVP is defined in messages. If the Monitoring-Key AVP appears in the Charging-Rule-Definition AVP, the Usage-Monitoring-Information AVP is associated based on the Monitoring-Key AVP. For the predefined rules, the value of the Monitoring-Key AVP must be configured on the PCEF. NOTE:
On the device, the value of the Monitoring-Key AVP is set to 9 for BOD services and must also be set to 9 on the PCRF for BOD services. The Monitoring-Key AVP is a sub-AVP, which is used in the group AVP Gx-R9-Usage-Monitoring-Info. |
Reference Standards
3GPP TS 29.212 V9.7.0 clause 5.3.59
Origin-Host AVP
Description of AVP
AVP |
Description |
---|---|
Origin-Host |
The Origin-Host AVP (AVP Code 264) is of type DiameterIdentity. The maximum length supported by device is 127 bytes. The host name configured on the PCEF is the Peer-Host for the PCRF. The Origin-Host AVP must be carried in all Diameter messages.
|
Reference Standards
RFC 3588 clause 6.3
Origin-Realm AVP
Description of AVP
AVP |
Description |
---|---|
Origin-Realm |
The Origin-Realm AVP (AVP Code 296) is of type DiameterIdentity and the maximum length is 127 bytes. The Origin-Realm AVP contains the realm that generates any Diameter message, and must be carried in all messages. This AVP SHOULD be placed as close to the Diameter header as possible. NOTE:
On the device, the Origin-Realm AVP indicates the domain name contained in Local Info that is configured on the PCEF, which is the peer domain for the PCRF. The Origin-Realm AVP is used independently. |
Reference Standards
RFC 3588 clause 6.4
Origin-State-Id
Description of AVP
AVP |
Description |
---|---|
Origin-State-Id |
The Origin-State-Id AVP (AVP Code 278) is of type Unsigned32 and the length is 4 bytes. The Origin-State-Id AVP is a monotonically increasing value that is used whenever a Diameter entity restarts with the loss of a previous status, for example upon reboot. The Origin-State-Id AVP can be carried in any Diameter message, including CER. Typically, Origin-State-Id is used by an access device that always starts up with no active sessions; that is, any session that is active before the restart will be lost. By carrying the Origin-State-Id AVP in a message, it allows other Diameter entities to infer that sessions associated with a lower Origin-State-Id are no longer active. If an access device does not intend for such inferences, the device must include the Origin-State-Id AVP in any message or set its value to 0. NOTICE:
The device can receives but does not process the Origin-State-Id AVP. |
Reference Standards
RFC 3588 clause 8.16
PCC-Rule-Status AVP
Description of AVP
AVP |
Description |
---|---|
PCC-Rule-Status |
The PCC-Rule-Status AVP (AVP code 1019) is of type Enumerated, and describes the status of one or a group of PCC Rules. The following values are defined for the PCC-Rule-Status AVP:
|
Reference Standards
3GPP TS 29.212 V9.7.0 clause 5.3.19
QoS-Information AVP
Description of AVP
AVP |
Description |
---|---|
QoS-Information |
The QoS-Information AVP (AVP code 1016) is of type Grouped. The QoS-Information AVP defines the QoS information of IP-CAN sessions and PCC rules. When the QoS-Information AVP is sent by the PCEF to the PCRF through a CCR-Initial message for requesting the PCRF to establish a session, this AVP indicates the initial QoS information of the users in an IP-CAN session. When the QoS-Information AVP is sent by the PCRF to the PCEF, this AVP indicates the total bandwidth of the users in an IP-CAN session or the authorized QoS parameter for a rule or service. AVP format: QoS-Information ::= < AVP Header: 1016> [ Max-Requested-Bandwidth-UL ] [ Max-Requested-Bandwidth-DL ] [ Guaranteed-Bitrate-UL ] [ Guaranteed-Bitrate-DL ] *[ AVP] NOTE:
The device receives but does not process *[AVP] in the AVP format description, that is, the device processes the AVPs listed in this document and ignores other AVPs. The device supports only the QoS-Information attribute as a sub-attribute of Charging-Rule-Definition for delivery. The QoS-Information AVP is a sub-AVP, which is used in the group AVP Charging-Rule-Definition. The QoS-Information AVP is also a group AVP, which contains the Qos-Class-Identifier, Max-Requested-Bandwidth-UL, Max-Requested-bandwidth-DL, Guaranteed-Bitrate-UL, and Guaranteed-Bitrate-DL sub-AVPs. |
Reference Standards
3GPP TS 29.212 V9.7.0 clause 5.3.16
Re-Auth-Request-Type AVP
Description of AVP
AVP |
Description |
---|---|
Re-Auth-Request-Type |
The Re-Auth-Request-Type AVP (AVP Code 285) is of type Enumerated and is carried in application-specific authentication responses to inform the client of the Authorization-Lifetime expiration. If the response message contains an Authorization-Lifetime AVP with a positive value, the Re-Auth-Request-Type AVP must be carried in a response message. The following values are defined for the Re-Auth-Request-Type AVP:
NOTE:
device does not support the AVP. |
Reference Standards
RFC 3588 clause 8.12
Result-Code AVP
Description of AVP
AVP |
Description |
---|---|
Result-Code |
The Result-Code AVP (AVP Code 268) is of type Unsigned32 and the length is 4 bytes. It indicates whether a particular request was completed successfully or whether an error occurred. This AVP is carried in a response message to indicate the result code of a request message. The Result-Code AVP and/or the Experimental-Result AVP must exist. After processing an RAR message successfully, the PCEF sends an RAA message in which the value of the Result-Code AVP is DIAMETER_SUCCESS. The PCRF checks whether a user is online. If the user is offline, the PCRF returns the Result-Code AVP whose value is DIAMETER_UNKNOWN_SESSION_ID. |
Reference Standards
RFC 3588 clause 7.1
Rule-Failure-Code AVP
Description of AVP
AVP |
Description |
---|---|
Rule-Failure-Code |
The Rule-Failure-Code AVP (AVP code 1031) is of type Enumerated, and it is sent by the PCEF to the PCRF and is used to specify the cause value of the error that occurs in the PCC rule during sending of the Charging-Rule-Report AVP. The following values are defined in RFC 3588:
In device, the following values are defined:
|
Reference Standards
3GPP TS 29.212 V9.7.0 clause 5.3.38
Session-Id AVP
Description of AVP
AVP |
Description |
---|---|
Session-Id |
The Session-Id AVP (AVP Code 263) is of type UTF8String and the maximum length is 139 bytes. It is used to identify a specific session. All messages pertaining to a specific session must include only one Session-Id AVP and the same value must be used throughout the life of a session. When present, the Session-Id should appear immediately following the Diameter Header. The Session-Id
must be globally and eternally unique, as it is meant to uniquely
identify a user session without reference to any other information,
and may be needed to correlate historical authentication information
with accounting information. The Session-Id includes a mandatory portion
and an implementation-defined portion; a recommended format for the
implementation-defined portion is outlined below.
The Session-Id AVP is created by the Diameter application initiating the session, which in most cases is done by the client. Note that a Session-Id may be used for both the authorization and accounting commands of a given application. NOTE:
The Session-Id AVP has a maximum of 127 bytes. This AVP is generated by the PCEF and must be unique on the entire network to avoid misoperation when resources are inconsistent. On an device, the format is:
|
Reference Standards
RFC 3588 clause 8.8
Session-Release-Cause AVP
Description of AVP
AVP |
Description |
---|---|
Session-Release-Cause |
The Session-Release-Cause AVP (AVP Code 1045) is of type Enumerated and it determines the reason of the IP-CAN session released by the PCRF. The following values are defined for the Session-Release-Cause AVP:
NOTICE:
For the release of an IP-CAN session initiated by the PCRF, 3GPP defines three different mechanisms successively. The first mechanism is based on Diameter based protocol (DBP) ASR/ASA messages; the second mechanism is based on the RAR messages (in which all deployed rules are removed) sent by the PCRF; the third mechanism is based on the RAR messages (carrying the Session-Release-Cause AVP) sent by the PCRF. The PCEF removes the deployed policies and sends a CCR-T message to the PCRF, requesting the PCRF to terminate an IP-CAN session. From the angle of interoperability and compatibility, the third mechanism is mandatory and the other two are optional. |
Reference Standards
3GPP TS 29.212 V9.7.0 clause 5.3.44
Subscription-Id AVP
Description of AVP
AVP |
Description |
---|---|
Subscription-Id |
The Subscription-Id AVP (AVP Code 443) is of type Grouped and it is used to identify the end user's subscription data. The Subscription-Id AVP consists of the Subscription-Id-Data AVP and the Subscription-Id-Type AVP. The Subscription-Id-Data AVP includes one ID and the Subscription-Id-Type AVP defines the ID type. It is defined as follows (per the grouped-avp-def of RFC 3588 [DIAMBASE]): Subscription-Id ::= <AVP Header: 443 > { Subscription-Id-Type } { Subscription-Id-Data } NOTE:
On the device, the Subscription-Id-Type AVP is set to END_USER_NAI (3) On an device, the Subscription-Id-Data AVP is set to a user name consisting of at most 253 bytes (such as 50ec931b0000@rm-3). The Subscription-Id AVP is a group AVP, which contains the Subscription-id-Type and Subscription-id-Data sub-AVPs. |
Reference Standards
RFC 4006 clause 8.46
Subscription-Id-Data AVP
Description of AVP
AVP |
Description |
---|---|
Subscription-Id-Data |
The Subscription-Id-Data AVP (AVP Code 444) is used to identify the end user and is of type UTF8String. The Subscription-Id-Type AVP defines which type of identifier is used. The Subscription-Id-Data AVP is a sub-AVP, which is used in the group AVP Subscription-Id. |
References
RFC 4006 clause 8.48
Subscription-Id-Type AVP
Description of AVP
AVP |
Description |
---|---|
Subscription-Id-Type |
The Subscription-Id-Type AVP (AVP Code 450) is of type Enumerated, and it is used to determine which type of identifier is carried by the Subscription-Id AVP. The values are as follows:
NOTE:
The device supports only END_USER_NAI(3). The Subscription-Id-Type AVP is a sub-AVP, which is used in the group AVP Subscription-ID. |
References
RFC 4006 clause 8.47
Supported-Features AVP
Description of AVP
AVP |
Description |
---|---|
Supported-Features |
The Supported-Features AVP (Code 628) is of type Grouped. If this AVP is present it may inform the destination host about the features that the origin host supports. The Feature-List AVP contains a list of supported features of the origin host. The Vendor-Id AVP and the Feature-List AVP shall together identify which feature list is carried in the Supported-Features AVP. AVP format: Supported-Features :: = < AVP Header: 628 10415 > { Vendor-Id } { Feature-List-ID } { Feature-List } *[ AVP] NOTE:
The device receives but does not process *[AVP] in the AVP format description, that is, the device processes the AVPs listed in this document and ignores other AVPs. The flag of the Supported-Features AVP in a CCR-Initial message is mandatory ("M"). The Supported-Features AVP is a group AVP, which contains the Vendor-ID, Feature-List-ID, and Feature-List sub-AVPs. |
Reference Standards
3GPP TS 29.212 V9.7.0 clause 5.4.1
3GPP TS 29.229 V8.7.0 clause 6.3.29
Termination-Cause
Description of AVP
AVP |
Description |
---|---|
Termination-Cause |
The Termination-Cause AVP (AVP Code 295) is of type Enumerated and it is used to indicate the reason of a session termination on an access device. The following values are defined in RFC 3588:
NOTE:
device supports only the following value:
|
Reference Standards
RFC 3588 clause 8.15
Usage-Monitoring-Information AVP
Description of AVP
AVP |
Description |
---|---|
Usage-Monitoring-Information |
Usage-Monitoring-Information AVP (AVP code 1067) is of type Grouped, and it contains quota monitoring information and identifies a usage monitoring event.
AVP format: Usage-Monitoring-Information ::= <AVP Header: 1067 > [ Monitoring-Key ] [ Usage-Monitoring-Level ] [ Granted-Service-Unit ] [ Used-Service-Unit ] [ Usage-Monitoring-Report ] *[ AVP ] NOTE:
The Usage-Monitoring-Information AVP is a group AVP, which contains the gx-r9-usage-monitoring-key, granted-service-unit, and gx-r9-usage-monitoring-level sub-AVPs. An device receives but does not process *[AVP] in the message format description. This means that the device processes the AVPs described in this document but ignores other AVPs. |
Reference Standards
3GPP TS 29.212 V9.7.0 clause 5.3.60
Usage-Monitoring-Level AVP
Description of AVP
AVP |
Description |
---|---|
Usage-Monitoring-Level |
The Usage-Monitoring-Level AVP (AVP code 1068) is of type Enumerated and it contains quota monitoring information and identifies a quota monitoring event. This AVP is included in an RAR or CCA message delivered by the PCRF. The following values are defined:
|
Reference Standards
3GPP TS 29.212 V9.7.0 clause 5.3.61
Usage-Monitoring-Report AVP
Description of AVP
AVP |
Description |
---|---|
Usage-Monitoring-Report |
The Usage-Monitoring-Report AVP (AVP code 1069) is of type Enumerated and it is used by the PCRF to indicate the accumulated usage to be reported by the PCEF, regardless of whether a usage threshold is reached for certain quota monitoring key. If no monitoring key is specified, the PCRF instructs the PCEF to report session-level usage. The following values are defined in 3GPP
TS 29.212:
NOTE:
On device, BOD service does not support this AVP. The Usage-Monitoring AVP is a sub-AVP, which is used in the group AVP gx-r9-usage-monitoring-info. |
Reference Standards
3GPP TS 29.212 V9.7.0 clause 5.3.62
User-Equipment-Info AVP
Description of AVP
AVP |
Description |
---|---|
User-Equipment-Info |
The User-Equipment-Info AVP (AVP Code 458) is of type Grouped and is used to report a user's MAC address. It is defined as follows (per the grouped-avp-def of RFC 3588 [DIAMBASE]): User-Equipment-Info ::= < AVP Header: 458 > { User-Equipment-Info-Type } { User-Equipment-Info-Value } NOTE:
The User-Equipment-Info AVP is a group AVP, which contains the user-equipment-info-type and user-equipment-info-value sub-AVPs. It is used by the device to report MAC addresses of users. |
Reference Standards
RFC 4006 clause 8.49
User-Equipment-Info-Type AVP
Description of AVP
AVP |
Description |
---|---|
User-Equipment-Info-Type |
The User-Equipment-Info-Type AVP is of type Enumerated (AVP Code 459) and defines the type of user equipment information contained in the User-Equipment-Info-Value AVP. This specification defines the following user equipment types.
NOTE:
The User-Equipment-Info-Type AVP is a sub-AVP, which is used in the group AVP user-equipment-info. The device uses the User-Equipment-Info-Type AVP to report MAC addresses of users. This AVP is permanently set to MAC (1). |
Reference Standards
RFC 4006 clause 8.50
User-Equipment-Info-Value AVP
Description of AVP
AVP |
Description |
---|---|
User-Equipment-Info-Value |
The User-Equipment-Info-Value AVP (AVP Code 460) is of type OctetString. The User-Equipment-Info-Type AVP defines which type of identifier is used. The maximum length supported is 6 bytes. |
Reference Standards
RFC 4006 clause 8.51
Used-Service-Unit AVP
Description of AVP
AVP |
Description |
---|---|
Used-Service-Unit |
The Used-Service-Unit AVP is of type Grouped (AVP Code 446) and it indicates the used quotas measured from the last report, which are sent from the PCEF to the PCRF. The Used-Service-Unit AVP is defined as follows (per the grouped-avp-def of RFC 3588 [DIAMBASE]): Used-Service-Unit ::= <AVP Header: 446> [ CC-Time ] [ CC-Total-Octets ] NOTE:
The Used-Service-Unit AVP is a sub-AVP, which is used in the group AVP gx-r9-usage-monitoring-info. The Used-Service-Unit AVP is also a group AVP, which contains the cc-time and cc-total-octets sub-AVPs. The PCEF reports upstream traffic and downstream traffic separately, and the PCRF is required to sum the traffic. The device supports duration reporting. An device receives but does not process *[AVP] in the message format description. This means that the device processes the AVPs described in this document but ignores other AVPs. |
Reference Standards
RFC 4006 clause 8.19
Vendor-Id AVP
Description of AVP
AVP |
Description |
---|---|
Vendor-Id |
The Vendor-Id AVP (AVP Code 266) is of type Unsigned32 and contains the IANA "SMI Network Management Private Enterprise Codes" [ASSIGNNO] value assigned to the vendor of the Diameter application. In combination with the Supported-Vendor-Id AVP, this may be used in order to know which vendor specific attributes may be sent to the peer. It is also envisioned that the combination of the Vendor-Id, Product-Name and the Firmware-Revision AVPs may provide very useful debugging information. A Vendor-Id value of zero in the CER or CEA messages is reserved and indicates that this field is ignored. NOTE:
The Vendor-Id AVP is a sub-AVP, which is used in the group AVP vendor-specific-application-id. |
Reference Standards
RFC 4006 clause 5.3.3
Vendor-Specific-Application-Id AVP
Description of AVP
AVP |
Description |
---|---|
Feature-List-ID AVP |
The Vendor-Specific-Application-Id AVP (AVP Code 260) is of type Grouped and is used to advertise support of a vendor-specific Diameter Application. Exactly one of the Auth-Application-Id and Acct-Application-Id AVPs MAY be present. This AVP MUST also be present as the first AVP in all experimental commands defined in the vendor-specific application. This AVP SHOULD be placed as close to the Diameter header as possible. AVP Format: <Vendor-Specific-Application-Id> ::=< AVP Header: 260 > 1*[ Vendor-Id ] 0*1{Auth-Application-Id } 0*1{ Acct-Application-Id } NOTE:
The Vendor-Specific-Application-Id AVP is a group AVP, which contains the vendor-id and auth-application-id sub-AVPs. |
References
RFC 3588 clause 6.11
X-HW-User-Physical-Info-Value AVP
Description of AVP
AVP |
Description |
---|---|
X-HW-User-Physical-Info-Value |
The X-HW-User-Physical-Info-Value AVP (Code 2025) is of type UTF8String and it indicates physical information such as slot ID, sub-slot ID, port ID, and VLAN ID. The HW-User-Physical-Info-Value AVP format is similar to that of the Diameter NAS-PORT-ID AVP. An example of the HW-User-Physical-Info-Value AVP is: {atm|eth|trunk} NAS_slot/NAS_subslot/NAS_port:XPI.XCI. This AVP is defined as follows: <avpEntry name="X-HW-User-Physical-Info-Value" code="2025" flag="May_M" vendorId="2011" datatype="UTF8String" avpname="240"/> |
Reference Standards
This AVP is a private AVP, so there are no reference standards.
X-HW-MS-Group-Name AVP
Description of AVP
AVP |
Description |
---|---|
X-HW-MS-Group-Name |
The X-HW-MS-Group-Name AVP (Code 2021) is of type UTF8String and the maximum length is 31 bytes. It indicates a multicast group name. The PCRF sends this AVP based on its configurations. This AVP is defined as follows: <avpEntry name="X-HW-MS-Group-Name" code="2021" flag="May_M" vendorId="2011" datatype="UTF8String" avpname="243"/> |
Reference Standards
This AVP is a private AVP, so there are no reference standards.
X-HW-ACL-Group-Name AVP
Description of AVP
AVP |
Description |
---|---|
X-HW-ACL-Group-Name |
The X-HW-ACL-Group-Name AVP (Code 2022) is of type UTF8String and the maximum length is 31 bytes. It indicates an ACL group name configured on the PCEF (device). An ACL user group can be modified to implement ACL-based traffic behaviors. This AVP is defined as follows: <avpEntry name="X-HW-ACL-Group-Name" code="2022" flag="May_M" vendorId="2011" datatype="UTF8String" avpname="244"/> |
Reference Standards
This AVP is a private AVP, so there are no reference standards.
X-HW-Interim-Interval AVP
Description of AVP
AVP |
Description |
---|---|
X-HW-Interim-Interval |
The X-HW-Interim-Interval AVP is of type Unsigned32 (Code 2023) and has a length of 4 bytes. The HW-Interim-Interval AVP indicates a real-time charging interval (in seconds) of the PCEF (device). Setting its value to more than or equal to 60 is recommended. The HW-Interim-Interval AVP value ranges from 0 to 3932100. The value 0 indicates that real-time charging is not required, and a value greater than 3932100 indicates that a user fails to go online. The PCRF sends this AVP based on its configurations. This AVP is defined as follows: <avpEntry name="X-HW-Interim-Interval" code="2023" flag="May_M" vendorId="2011" datatype="Unsigned32" avpname="245"/> |
Reference Standards
This AVP is a private AVP, so there are no reference standards.
X-HW-Service-Type AVP
Description of AVP
AVP |
Description |
---|---|
X-HW-Service-Type |
The X-HW-Service-Type AVP (Code 2024) is
of type Enumerated. The PCEF supports BOD, and DAA services. The X-HW-Service-Type
AVP is defined as follows:
This AVP is defined as follows: <avpEntry name="X-HW-Service-Type" code="2024" flag="M" vendorId="2011" datatype="Enumerated" avpname="246"> NOTE:
The name of a static policy must be unique on the PCEF, that is, the service can be identified according to the static policy name. The X-HW-Service-Type AVP is a sub-AVP, which is used in the group AVP charging-rule-definition. |
Reference Standards
This AVP is a private AVP, so there are no reference standards.
- AVP Format Convention
- Auth-Application-Id AVP
- CC-Output-Octets AVP
- CC-Request-Number AVP
- CC-Request-Type AVP
- CC-Time AVP
- CC-Total-Octets AVP
- Charging-Rule-Definition AVP
- Charging-Rule-Install AVP
- Charging-Rule-Name AVP
- Charging-Rule-Remove AVP
- Charging-Rule-Report AVP
- Destination-Host AVP
- Destination-Realm AVP
- Error-Message AVP
- Experimental-Result AVP
- Experimental-Result-Code AVP
- Event-Trigger AVP
- Feature-List AVP
- Feature-List-ID AVP
- Framed-IP-Address AVP
- Framed-IPv6-Prefix AVP
- Granted-Service-Unit AVP
- Guaranteed-Bitrate-DL AVP
- Guaranteed-Bitrate-UL AVP
- IP-CAN-Type AVP
- Max-Requested-Bandwidth-DL AVP
- Max-Requested-Bandwidth-UL AVP
- Monitoring-Key AVP
- Origin-Host AVP
- Origin-Realm AVP
- Origin-State-Id
- PCC-Rule-Status AVP
- QoS-Information AVP
- Re-Auth-Request-Type AVP
- Result-Code AVP
- Rule-Failure-Code AVP
- Session-Id AVP
- Session-Release-Cause AVP
- Subscription-Id AVP
- Subscription-Id-Data AVP
- Subscription-Id-Type AVP
- Supported-Features AVP
- Termination-Cause
- Usage-Monitoring-Information AVP
- Usage-Monitoring-Level AVP
- Usage-Monitoring-Report AVP
- User-Equipment-Info AVP
- User-Equipment-Info-Type AVP
- User-Equipment-Info-Value AVP
- Used-Service-Unit AVP
- Vendor-Id AVP
- Vendor-Specific-Application-Id AVP
- X-HW-User-Physical-Info-Value AVP
- X-HW-MS-Group-Name AVP
- X-HW-ACL-Group-Name AVP
- X-HW-Interim-Interval AVP
- X-HW-Service-Type AVP