Diameter Gy – Credit-Control-Answer (CCA) command
This section describes the Diameter Gy CCA message format as defined in RFC 4006. Strikethrough formatted AVPs should not appear or are ignored in CCA. Italic formatted AVPs listed after [AVP] are not defined in RFC 4006.
<Credit-Control-Answer> ::= < Diameter Header: 272, PXY >
< Session-Id >
{ Result-Code }
{ Origin-Host }
{ Origin-Realm }
{ Auth-Application-Id }
{ CC-Request-Type }
{ CC-Request-Number }
[ User-Name ]
[ CC-Session-Failover ]
[ CC-Sub-Session-Id ]
[ Acct-Multi-Session-Id ]
[ Origin-State-Id ]
[ Event-Timestamp ]
[ Granted-Service-Unit ]
*[ Multiple-Services-Credit-Control ]
[ Cost-Information]
[ Final-Unit-Indication ]
[ Check-Balance-Result ]
[ Credit-Control-Failure-Handling ]
[ Direct-Debiting-Failure-Handling ]
[ Validity-Time]
*[ Redirect-Host]
[ Redirect-Host-Usage ]
[ Redirect-Max-Cache-Time ]
*[ Proxy-Info ]
*[ Route-Record ]
*[ Failed-AVP ]
*[ AVP ]
[ Charging-Rule-Base-Name ]
Diameter Gy – CCA message top level AVPs
Diameter Gy CCA: top level AVP description provides a detailed description for each top level AVP present in a Diameter Gy CCA message. Unless mentioned different in the description, the AVP is present in Initial, Update and Terminate messages. Grouped AVPs are marked with ‟↳ (grouped AVP)”. The grouped AVP format and embedded AVP description and format are described in section Diameter Gy – CCA message grouped AVPs.
AVP code | AVP name | Description |
---|---|---|
258 |
Auth-Application-Id |
Fixed value: 4 = Diameter Credit Control Application |
263 |
Session-id |
A session is a logical concept at the application layer that exists between the Diameter client and the Diameter server; it is identified via the Session-Id AVP. Format: <DiameterIdentity>;<high 32 bits>;<low 32 bits>
Example: bng.nokia.com;1326398325;1 |
264 |
Origin-Host |
Diameter Identity. Used as destination host in the next Diameter message. Example: server.nokia.com |
268 |
Result-Code |
Values: 2001 = Diameter Success 3xxx = Protocol Errors 4001 = Diameter Authentication Rejected 4010 = Diameter End User Service Denied (CCA-U only) 4011 = Diameter Credit Control Not Applicable 4012 = Diameter Credit Limit Reached (CCA-U only) 5003 = Diameter Authorization Rejected 5030 = Diameter User Unknown 5031 = Diameter Rating Failed (CCA-U only) Values not listed result in a Diameter Session Failure and the Credit Control Failure Handling action is executed. |
278 |
Failed-AVP ↳ (grouped AVP) |
Provides debugging information when CCR is rejected or not fully processed because of unsupported AVP or AVP value. |
296 |
Origin-Realm |
Diameter Identity. Used as destination host in the next Diameter message. Example: nokia.com |
415 |
CC-Request-Number |
Values: CCA-Initial: 0 CCA-Update and CCA-Termination: sequence number |
416 |
CC-Request-Type |
Values: 1 = Initial Answer 2 = Update Answer 3 = Termination Answer |
418 |
CC-Session-Failover |
Specifies if a secondary peer should be attempted in case of Credit Control Failure Handling. Use the commands in the following context to override the configured failover value:
Values: 0 = Failover Not Supported 1 = Failover Supported |
427 |
Credit-Control-Failure-Handling |
Action to take when the Credit Control client does not receive a valid CCA message within the interval specified with tx-timer (default 10s). Use the following commands to override the configured failure handling:
Values: 0 = Terminate 1 = Continue 2 = Retry and terminate |
456 |
Multiple-Services-Credit-Control ↳ (grouped AVP) |
Up to sixteen Multiple-Services-Credit-Control AVPs, each corresponding to a rating group. A rating group maps to a category configured in a category-map:
|
3GPP – 1004 |
Charging-Rule-Base-Name |
(CCA-I only) Assigns the category-map or overrides the category-map obtained in authentication. value: category-map-name: the name of the category-map to be used for this session |
AVP code | AVP name | Standard | Data format | Flags |
---|---|---|---|---|
258 |
Auth-Application-Id |
RFC 6733/RFC 4006 |
Unsigned 32 |
M |
263 |
Session-id |
RFC 6733 |
UTF8 String |
M |
264 |
Origin-Host |
RFC 6733 |
Diameter Identity |
M |
268 |
Result-Code |
RFC 6733/RFC 4006 |
Unsigned 32 |
M |
278 |
Failed-AVP ↳ (grouped AVP) |
RFC 6733 |
Grouped |
M |
296 |
Origin-Realm |
RFC 6733 |
Diameter Identity |
M |
415 |
CC-Request-Number |
RFC 4006 |
Unsigned 32 |
M |
416 |
CC-Request-Type |
RFC 4006 |
Enumerated |
M |
418 |
CC-Session-Failover |
RFC 4006 |
Enumerated |
M |
427 |
Credit-Control-Failure-Handling |
RFC 4006 |
Enumerated |
M |
456 |
Multiple-Services-Credit-Control ↳ (grouped AVP) |
RFC 4006 |
Grouped |
M |
3GPP – 1004 |
Charging-Rule-Base-Name |
TS 29.212 |
Octet String |
V, M |
Diameter Gy – CCA message grouped AVPs
This section provides an overview of CCA message grouped AVPs.
Diameter Gy CCA – Failed-AVP grouped AVP
Grouped AVP format as defined in RFC 6733:
<Failed-AVP> ::= < AVP Header: 279 >
1* {AVP}
The failed-AVP AVP contains the entire AVP that could not be processed successfully.
Diameter Gy CCA – Multiple-Services-Credit-Control grouped AVP
Grouped AVP format as defined in RFC 4006: Strikethrough formatted AVPs should not appear or are ignored in CCA. Italic formatted AVPs listed after [AVP] are not defined in RFC 4006.
Multiple-Services-Credit-Control ::= < AVP Header: 456 >
[ Granted-Service-Unit ]
[ Requested-Service-Unit ]
*[ Used-Service-Unit ]
[ Tariff-Change-Usage ]
*[ Service-Identifier ]
[ Rating-Group ]
*[ G-S-U-Pool-Reference ]
[ Validity-Time ]
[ Result-Code ]
[ Final-Unit-Indication ]
*[ AVP ]
[ Time-Quota-Threshold ]
[ Volume-Quota-Threshold ]
[ Quota-Holding-Time ]
AVP code | AVP name | Description |
---|---|---|
268 |
Result-Code |
Values: 2001 = Diameter Success 4010 = Diameter End User Service Denied 4011 = Diameter Credit Control Not Applicable 4012 = Diameter Credit Limit Reached 5003 = Diameter Authorization Rejected 5031 = Diameter Rating Failed Values not listed result in a Diameter Session Failure and the Credit Control Failure Handling action is executed. |
430 |
Final-Unit-Indication ↳ (grouped AVP) |
This AVP indicates that the Granted-Service-Unit contains the final units for the service. When this quota is consumed, a final reporting is started (CCR-U or CCR-T) with reporting reason ‟Final”. The final reporting can be disabled with the following commands:
|
431 |
Granted-Service-Unit ↳ (grouped AVP) |
Amount of service units that the Diameter credit control client can provide to the end user until the service must be released or a new CCR message must be sent. |
432 |
Rating-Group |
Rating group for which the quota is allocated. The rating group corresponds with a category within a category-map defining the queues and policers and direction to monitor.
|
448 |
Validity-Time |
If the granted service units have not been consumed within the validity time, a CCR-U is triggered with Reporting Reason AVP set to 4 (Validity Time). Value in seconds |
3GPP – 868 |
Time-Quota-Threshold |
Threshold preventing time quota exhaustion before refreshing. When the used time quota exceeds the threshold, a CCR-U is triggered with Reporting Reason AVP set to 0 (Threshold). Value in seconds |
3GPP – 869 |
Volume-Quota-Threshold |
Threshold preventing volume quota exhaustion before refreshing. When the used volume quota exceeds the threshold, a CCR-U is triggered with Reporting Reason AVP set to 0 (Threshold). Value in octets |
3GPP – 871 |
Quota-Holding-Time |
Specifies an idle-timeout associated with the granted service units. If no traffic associated with the quota is observed for the time specified by the quota holding time, then a CCR-U is triggered with Reporting Reason AVP set to 1 (Quota Holding Time). The idle time is measured per sampling period. Value in seconds |
AVP code | AVP name | Standard | Data format | Flags |
---|---|---|---|---|
268 |
Result-Code |
RFC 6733/RFC 4006 |
Unsigned 32 |
M |
430 |
Final-Unit-Indication ↳ (grouped AVP) |
RFC 4006 |
Grouped |
M |
431 |
Granted-Service-Unit ↳ (grouped AVP) |
RFC 4006 |
Grouped |
M |
432 |
Rating-Group |
RFC 4006 |
Unsigned 32 |
M |
448 |
Validity-Time |
RFC 4006 |
Unsigned 32 |
M |
3GPP – 868 |
Time-Quota-Threshold |
TS 32.299 |
Unsigned 32 |
V, M |
3GPP – 869 |
Volume-Quota-Threshold |
TS 32.299 |
Unsigned 32 |
V, M |
3GPP – 871 |
Quota-Holding-Time |
TS 32.299 |
Unsigned 32 |
V, M |
Diameter Gy CCA – Final-Unit-Indication grouped AVP
Grouped AVP format as defined in RFC 4006: Strikethrough formatted AVPs should not appear or are ignored in CCA.
Final-Unit-Indication ::= < AVP Header: 430 >
{ Final-Unit-Action }
*[ Restriction-Filter-Rule ]
*[ Filter-Id ]
[ Redirect-Server ]
AVP code | AVP name | Description |
---|---|---|
443 |
Redirect-Server ↳ (grouped AVP) |
This AVP is included when the Final-Unit-Action AVP is set to
REDIRECT (1) and contains the URL to which the user must be
redirected. The URL overrides the URL specified with the
following commands:
The AVP is ignored when the out-of-credit action is different from change-service-level or when no http-redirect action with allow-override is configured. |
449 |
Final-Unit-Action |
If the value is Terminate, then the session is terminated and the corresponding subscriber host deleted. If the value is Redirect or Restrict Access, then the out-of-credit action as configured for that rating group (category) is executed using the following command:
Alternately, the following command can be used to configure out of credit action:
Values: 0 = Terminate 1 = Redirect 2 = Restrict Access |
AVP code | AVP name | Standard | Data format | Flags |
---|---|---|---|---|
443 |
Redirect-Server ↳ (grouped AVP) |
RFC 4006 |
Enumerated |
M |
449 |
Final-Unit-Action |
RFC 4006 |
Enumerated |
M |
Diameter Gy CCA - Redirect-Server grouped AVP
Grouped AVP format as defined in RFC 4006.
Redirect-Server ::= < AVP Header: 434 >
{ Redirect-Address-Type }
{ Redirect-Server-Address }
AVP code | AVP name | Description |
---|---|---|
433 |
Redirect-Address-Type |
Must be set to URL (2). The Redirect-Server-Address AVP is ignored when set to a different value. |
435 |
Redirect-Server-Address |
Contains the IPv4 HTTP redirect URL that is used when the Final-Unit-Action REDIRECT is triggered for the rating group that corresponds with the MSCC in which the Final-Unit-Indication AVP is included. The URL specified in the Redirect-Server-Address AVP is only used when all following conditions are met:
|
435 (continued) |
In all other cases, the Redirect-Server-Address AVP is ignored. The maximum URL length is 255 characters and can include the same macro substitutions such as $IP (customer's IP address), $MAC (customer's MAC address), $URL (original requested URL), as supported for a static configured HTTP redirect URL. |
AVP code | AVP name | Standard | Data format | Flags |
---|---|---|---|---|
433 |
Redirect-Address-Type |
RFC 4006 |
Enumerated |
M |
435 |
Redirect-Server-Address |
RFC 4006 |
Enumerated |
M |
Diameter Gy CCA – Granted-Service-Unit grouped AVP
Grouped AVP format as defined in RFC 4006. Strikethrough formatted AVPs should not appear or are ignored in CCA.
Granted-Service-Unit ::= < AVP Header: 431 >
[ Tariff-Time-Change ]
[ CC-Time ]
[ CC-Money ]
[ CC-Total-Octets ]
[ CC-Input-Octets ]
[ CC-Output-Octets ]
[ CC-Service-Specific-Units ]
*[ AVP ]
For a single rating group (category), either Volume or Time quota can be granted. Granting both time and volume quota for a single rating group is not supported and results in a Diameter Session Failure and the execution of the Credit Control Failure Handling action.
AVP code | AVP name | Description |
---|---|---|
420 |
CC-Time |
Amount of granted time Value: in seconds |
421 |
CC-Total-Octets |
Total number of octets regardless of the direction (quota can be consumed for ingress or egress) Value: in octets |
AVP code | AVP name | Standard | Data format | Flags |
---|---|---|---|---|
420 |
CC-Time |
RFC 4006 |
Unsigned 32 |
M |
421 |
CC-Total-Octets |
RFC 4006 |
Unsigned 64 |
M |