2. Diameter Gy Interface Specification

Table 1 provides a summary of the Diameter Gy application messages.

Table 1: Diameter Gy Application Messages

2.1. Diameter Gy – Credit-Control-Request (CCR) command

This section describes the Diameter Gy CCR message format as defined in RFC 4006. Strikethrough formatted AVPs are not included in CCR. AVPs listed in italics appearing after [AVP] and are not defined in RFC 4006.

[ Destination-Host ] [ CC-Sub-Session-Id ] [ Acct-Multi-Session-Id ] [ Origin-State-Id ] [ Event-Timestamp ] *[ Subscription-Id ] [ Service-Identifier ] [ Termination-Cause ] [ Requested-Service-Unit ] [ Requested-Action ] *[ Used-Service-Unit ] [ Multiple-Services-Indicator ] *[ Multiple-Services-Credit-Control ] *[ Service-Parameter-Info ] [ CC-Correlation-Id ] [ User-Equipment-Info ] *[ Route-Record ] [ Framed-IP-Address ] [ Called-Station-Id ] [ Framed-IPv6-Prefix ] [ Delegated-IPv6-Prefix ] [ Alc-IPv6-Address ] [ 3GPP-Charging-Id ] [ 3GPP-GPRS-QoS-Negotiated-Profile ] [ 3GPP-GGSN-Address ] [ 3GPP-Session-Stop-Indicator ] [ 3GPP-Selection-Mode ] [ 3GPP-Charging-Characteristics ] [ 3GPP-GGSN-v6-Address ] [ 3GPP-RAT-Type ] [ 3GPP-User-Location-Info ] [ GGSN-Address ] [ Service-Information ] [ Charging-Rule-Base-Name ] [ PDP-Context-Type ]

2.1.1. Diameter Gy – CCR Message Top Level AVPs

Table 2 provides a detailed description of each top-level AVP present in a Diameter Gy CCR message. Unless mentioned 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 Diameter Gy – CCR Message Grouped AVPs.

Table 2: Diameter Gy CCR: Top Level AVP Description

RADIUS user name

AVP included if configured in the diameter application policy:

configure subscriber-mgmt diameter-application-policy application-policy-name gy include-avp radius-user-name

default: not included

The IP address of the IPv4 subscriber host that triggered the creation of the Diameter Gy session.

AVP included if configured in the diameter application policy:

configure subscriber-mgmt diameter-application-policy application-policy-name gy include-avp address-avp

Included at command level or embedded within [3GPP – 873] Service-Information / [3GPP – 874] PS-Information grouped AVPs when configured (gy include-avp ps-information) .

AVP included if configured in the diameter application policy:

configure subscriber-mgmt diameter-application-policy application-policy-name gy include-avp called-station-id string

Included at command level or embedded within [3GPP – 873] Service-Information / [3GPP – 874] PS-Information grouped AVPs when configured ( gy include-avp ps-information ).

value: string of max. 64 characters

default: no called-station-id

Timestamp when the request was generated

The IPv6 prefix of the SLAAC subscriber host that triggered the creation of the Diameter Gy session.

AVP included if configured in the diameter application policy:

configure subscriber-mgmt diameter-application-policy application-policy-name gy include-avp address-avp

Included at command level or embedded within [3GPP – 873] Service-Information / [3GPP – 874] PS-Information grouped AVPs when configured ( gy include-avp ps-information ).

The IPv6 prefix of the DHCPv6 IA-PD subscriber host that triggered the creation of the Diameter Gy session.

AVP included if configured in the diameter application policy:

configure subscriber-mgmt diameter-application-policy application-policy-name gy include-avp address-avp

Included at command level or embedded within [3GPP – 873] Service-Information / [3GPP – 874] PS-Information grouped AVPs when configured ( gy include-avp ps-information ).

Fixed value: 4 = Diameter Credit Control Application

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.

is the configured origin host are encoded as the Diameter initialization time (number of seconds since 1 January, 1970) are encoded as a sequentially increasing number starting at 1

Diameter Identity. As configured in the corresponding diameter-peer-policy

Initialized to the Diameter process startup time. Encoded as number of seconds since 1 January, 1970.

Diameter Identity. As configured in the corresponding diameter-peer-policy or learned from CCA/RAR.

Diameter Identity. As configured in the corresponding diameter-peer-policy or learned from CCA/RAR. Omitted in CCR-I if not configured.

Indicates the reason that the credit control session was terminated.

1 = Diameter Logout

4 = Diameter Administrative - a diameter session could not be created due to category mismatch or system resources

Diameter Identity. As configured in the corresponding diameter-peer-policy

Initial Request: 0

Update and Termination Request: sequence number

1 = Initial Request

2 = Update Request

3 = Termination Request

Identifies the subscriber host or session.

Value as configured in the diameter application policy:

configure subscriber-mgmt diameter-application-policy application-policy-name gy avp-subscription-id [type ]

If no data is available for the specified origin, then the subscriber-id is used instead.

default: avp-subscription-id subscriber-id type private

For GTP access, the configured value is ignored and two Subscription-Id AVPs are included: IMSI (type imsi) and MSISDN (type e164) with the corresponding values learned from the GTP Create Session Request message.

Fixed value: 1 = MULTIPLE_SERVICES_SUPPORTED

Up to sixteen Multiple-Services-Credit-Control AVPs, each corresponding with a single rating group. A rating group maps to a category configured in a category-map:

configure subscriber-mgmt category-map category-map-name category category-name rating-group rating-group-id

(GTP access only)

AVP included if configured in the diameter application policy:

configure subscriber-mgmt diameter-application-policy application-policy-name gy include-avp user-equipment-info type imeisv

value: IMEI as signaled in the GTP Create Session Request message.

default: not included

AVP included if configured in the diameter application policy:

configure subscriber-mgmt diameter-application-policy application-policy-name gy include-avp service-context-id string

value: string of 32 characters maximum

default: no service-context-id

The IPv6 address of the DHCPv6 IA-NA subscriber host that triggered the creation of the Diameter Gy session.

AVP included if configured in the diameter application policy:

configure subscriber-mgmt diameter-application-policy application-policy-name gy include-avp address-avp

Included at command level or embedded within [3GPP – 873] Service-Information / [3GPP – 874] PS-Information grouped AVPs when configured ( gy include-avp ps-information ).

AVP included if configured in the diameter application policy:

configure subscriber-mgmt diameter-application-policy application-policy-name gy include-avp 3gpp-imsi

Included at command level or embedded within [3GPP – 873] Service-Information / [3GPP – 874] PS-Information grouped AVPs when configured ( gy include-avp ps-information ).

subscriber-id

default: included with value subscriber-id

AVP included if configured in the diameter application policy:

configure subscriber-mgmt diameter-application-policy application-policy-name gy include-avp 3gpp-charging-id

Included at command level or embedded within [3GPP – 873] Service-Information / [3GPP – 874] PS-Information grouped AVPs when configured ( gy include-avp ps-information ).

auto: defaults to esm-info for vendor-support three-gpp id: a unique 32 bit integer value per session

default: included with esm-info value (auto)

AVP included if configured in the diameter application policy:

configure subscriber-mgmt diameter-application-policy application-policy-name gy include-avp 3gpp-gprs-negotiated-qos-profile

Included at command level or embedded within [3GPP – 873] Service-Information / [3GPP – 874] PS-Information grouped AVPs when configured ( gy include-avp ps-information ).

value: the active SLA profile name

The local IPv4 address used to setup the diameter peer. AVP included if configured in the diameter application policy:

configure subscriber-mgmt diameter-application-policy application-policy-name gy include-avp 3gpp-ggsn-address

Included at command level or embedded within [3GPP – 873] Service-Information / [3GPP – 874] PS-Information grouped AVPs when configured ( gy include-avp ps-information ).

Use the configured IPv4 source address: configure aaa diameter-peer-policy peer-policy-name source-address ip-address If router = base or vprn service id: use the system interface IPv4 address else if router = management: use the active management port IP address configured in the BOF

AVP included if configured in the diameter application policy:

configure subscriber-mgmt diameter-application-policy application-policy-name gy include-avp 3gpp-nsapi

Included at command level or embedded within [3GPP – 873] Service-Information / [3GPP – 874] PS-Information grouped AVPs when configured ( gy include-avp ps-information ).

AVP included if configured in the diameter application policy:

configure subscriber-mgmt diameter-application-policy application-policy-name gy include-avp 3gpp-session-stop-indicator

Included at command level or embedded within [3GPP – 873] Service-Information / [3GPP – 874] PS-Information grouped AVPs when configured ( gy include-avp ps-information ).

Fixed value: 0x FF

AVP included if configured in the diameter application policy:

configure subscriber-mgmt diameter-application-policy application-policy-name gy include-avp 3gpp-selection-mode

Included at command level or embedded within [3GPP – 873] Service-Information / [3GPP – 874] PS-Information grouped AVPs when configured ( gy include-avp ps-information ).

Fixed value: 0x 00 00 00 00 (MS or network provided APN, subscribed verified)

AVP included if configured in the diameter application policy:

configure subscriber-mgmt diameter-application-policy application-policy-name gy include-avp 3gpp-charging-characteristics

Included at command level or embedded within [3GPP – 873] Service-Information / [3GPP – 874] PS-Information grouped AVPs when configured ( gy include-avp ps-information ).

Fixed value: “0000”

The local IPv6 address used to setup the diameter peer. AVP included if configured in the diameter application policy:

configure subscriber-mgmt diameter-application-policy application-policy-name gy include-avp 3gpp-ggsn-ipv6-address

Included at command level or embedded within [3GPP – 873] Service-Information / [3GPP – 874] PS-Information grouped AVPs when configured (gy include-avp ps-information ).

Use the configured IPv6 source address: c onfigure aaa diameter-peer-policy peer-policy-name ipv6-source-address ipv6-address If router = base or vprn service id: use the system interface IPv6 address else if router = management: use the active management port IP address configured in the BOF

default: not included

AVP included if configured in the diameter application policy:

configure subscriber-mgmt diameter-application-policy application-policy-name gy include-avp 3gpp-rat-type

Included at command level or embedded within [3GPP – 873] Service-Information / [3GPP – 874] PS-Information grouped AVPs when configured ( gy include-avp ps-information ).

default: not included

For GTP access, the RAT-Type value is learned from the GTP Create Session Request message. The configured value is used when the GTP learned value is unknown or invalid.

(GTP access only)

Provides UE location details

AVP included if configured in the diameter application policy:

configure subscriber-mgmt diameter-application-policy application-policy-name gy include-avp 3gpp-user-location-info

value: ULI learned from the GTP Create Session Request message.

default: not included

The local address used to setup the diameter peer.

AVP included if configured in the diameter application policy:

configure subscriber-mgmt diameter-application-policy application-policy-name gy include-avp ggsn-address

Either IPv4 or IPv6 address can be included.

Included at command level or embedded within [3GPP – 873] Service-Information / [3GPP – 874] PS-Information grouped AVPs when configured ( gy include-avp ps-information ).

Use the configured IP source address:

configure aaa diameter-peer-policy peer-policy-name ipv6-source-address ipv6-address | source-address ip-address

If router = base or vprn service id: use the system interface IP address else if router = management: use the active management port IP address configured in the BOF

default: not included

Grouped AVP containing the [3GPP – 874] PS-Information grouped AVP and embedding following AVPs:

[8] Framed-IP-Address [30] Called-Station-Id [97] Framed-IPv6-Prefix [123] Delegated-IPv6-Prefix [NOKIA – 99] Alc-IPv6-Address [3GPP – 1] 3GPP-IMSI [3GPP – 2] 3GPP-Charging-Id [3GPP – 5] 3GPP-GPRS-Negotiated-QoS-profile [3GPP – 7] 3GPP-GGSN-Address [3GPP – 10] GGSN-NSAPI [3GPP – 11] 3GPP-Session-Stop-Indicator [3GPP – 12] 3GPP-Selection-Mode [3GPP – 13] 3GPP-Charging-Characteristics [3GPP – 16] 3GPP-GGSN-IPv6-Address [3GPP – 21] 3GPP-RAT-Type [3GPP – 847] GGSN-Address [3GPP – 1004] Charging-Rule-Base-Name [3GPP – 1247] PDP-Context-Type

AVP included if configured in the diameter application policy:

configure subscriber-mgmt diameter-application-policy application-policy-name gy include-avp ps-information

When not configured the above listed AVPs are included at command level.

default: no ps-information

AVP included if configured in the diameter application policy:

configure subscriber-mgmt diameter-application-policy application-policy-name gy include-avp charging-rule-base-name

Included at command level or embedded within [3GPP – 873] Service-Information / [3GPP – 874] PS-Information grouped AVPs when configured ( gy include-avp ps-information ).

category-map-name: the name of the category-map in use for this session string: a string of max. 64 characters.

default: charging-rule-base-name category-map-name

AVP included if configured in the diameter application policy:

configure subscriber-mgmt diameter-application-policy application-policy-name gy include-avp pdp-context-type

Included at command level or embedded within [3GPP – 873] Service-Information / [3GPP – 874] PS-Information grouped AVPs when configured ( gy include-avp ps-information ).

Fixed value: 0 (primary)

Table 3: Diameter Gy CCR: Top Level AVP Format

RFC 2865 / RFC 6733

RFC 6733 / RFC 4006

RFC 6733 / RFC 4006

TS 29.061/ TS 32.299

TS 29.061/ TS 32.299

2.1.2. Diameter Gy – CCR Message Grouped AVPs

This section provides an overview of CCR message grouped AVPs.

2.1.2.1. Diameter Gy CCR – Subscription-Id grouped AVP

Grouped AVP format as defined in RFC 4006:

Subscription-Id ::= < AVP Header: 443 >
Table 4: Diameter Gy CCR: Subscription-Id Grouped AVP Description

Value as configured in the diameter application policy:

configure subscriber-mgmt diameter-application-policy application-policy-name gy avp-subscription-id [type ]

e164: identifier in international E.164 format (ITU-T E.164) imsi: identifier in international IMSI format (ITU-T E.212) nai: identifier in the form of a Network Access Identifier (RFC 2486) private: a credit control server private identifier

default: type private

For GTP access, the configured value is ignored and the type is set to imsi and msisdn respectively for each of the two included Subscription-Id AVPs.

Value as configured in the diameter application policy:

configure subscriber-mgmt diameter-application-policy application-policy-name gy avp-subscription-id [type ]

Note that there is no check if the provided data is in the format of the configured type.

subscriber-id

default: avp-subscription-id subscriber-id

For GTP access, the Subscription ID data is learned from GTP and contains the IMSI and MSISDN.

Table 5: Diameter Gy CCR: Subscription-Id grouped AVP format

2.1.2.2. Diameter Gy CCR – Multiple-Services-Credit-Control grouped AVP

Grouped AVP format as defined in RFC 4006. Strikethrough formatted AVPs are not included in CCR. 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 ] [ Reporting-Reason ]
Table 6: Diameter Gy CCR: Multiple-Services-Credit-Control grouped AVP description

Rating group for which the quota is requested and/or reported. Corresponds with a category within a category-map defining the queues/policers and direction to monitor.

configure subscriber-mgmt category-map category-map-name category category-name rating-group rating-group-id

(CCR-I and CCR-U only)

When included, the Requested-Service-Unit AVP has an empty data field in all CCR Initial/Update messages.

(CCR-U and CCR-T only)

Amount of used service units measured for a given category or rating group to a given quota type .

The Used-Service-Unit AVP is not present in CCR-U when all contained AVP values are zero and the Reporting-Reason = Validity Time (4) or Forced Reauthorisation (7).

Specifies the reason for which the Used-Service-Units are reported. CCR-U and CCR-T only.

0 (Threshold) – used quota reached time or volume threshold value (threshold value different from zero)

1 (Quota Holding Time) – expiration of the Quota Holding Time 2 (Final) – Diameter session termination; can be client or server initiated. 3 (Quota Exhausted) – no threshold or threshold is zero and quota exhausted 4 (Validity Time) – expiration of the Validity Time 5 (Other Quota Type) – not supported 6 (Rating Condition Change) – not supported 7 (Forced Reauthorisation) – Reception of a RAR message 8 (Pool Exhausted) – not supported
Table 7: Diameter Gy CCR: Multiple-Services-Credit-Control grouped AVP format

2.1.2.3. Diameter Gy CCR – Requested-Service-Unit grouped AVP

Grouped AVP format as defined in RFC 4006. Strikethrough formatted AVPs are not included in CCR.

Requested-Service-Unit ::= < AVP Header: 437 > [ CC-Total-Octets ] [ CC-Input-Octets ] [ CC-Output-Octets ] [ CC-Service-Specific-Units ]

The Requested-Service-Unit AVP has an empty data field in all CCR Initial/Update messages and is not present in a CCR Terminate message.

2.1.2.4. Diameter Gy CCR – Used-Service-Unit grouped AVP

Grouped AVP format as defined in RFC 4006. Strikethough formatted AVPs are not included in CCR.

Used-Service-Unit ::= < AVP Header: 446 > [ Tariff-Change-Usage ] [ CC-Total-Octets ] [ CC-Input-Octets ] [ CC-Output-Octets ] [ CC-Service-Specific-Units ]
Table 8: Diameter Gy CCR: Used-Service-Unit Grouped AVP Description

Number of ingress bytes forwarded via queues or policers that are monitored in ingress direction for this rating group. ( configure subscriber-mgmt category-map category-map-name category category-name queue | policer id ingress-only | ingress-egress )

Value equals zero when credit type is time or when no queues/policers are monitored in ingress direction.

Number of egress bytes forwarded via queues or policers that are monitored in egress direction for this rating group. ( configure subscriber-mgmt category-map category-map-name category category-name queue | policer id egress-only | ingress-egress )

Value equals zero when credit type is time. Or when no queues/policers are monitored in egress direction.

Total number of seconds during which activity is detected for queues or policers that are monitored for this rating group. ( configure subscriber-mgmt category-map category-map-name category category-name queue | policer id ingress-only | egress-only | ingress-egress ).

Only sampling periods exceeding the configured activity-threshold are counted ( configure subscriber-mgmt category-map category-map-name activity-threshold kilobits-per-second )

Value equals zero when credit type is volume.

Total number of bytes used for this rating-group. Corresponds with the sum of CC-Input-Octets and CC-Output-Octets.

Value equals zero when credit type is time.