Selectable Policy Rule Variables
- Variable Name
- Description
- {Bandwidth}
- Any mode
- Replaced with the DOCSIS type of the flow for which the policy rule is being evaluated:
- {Conditions}
- Any mode
- Replaced with a list of (variable, value) tuples that lists the variables whose values were referenced in the conditions of the policy rule. The list is inserted with one variable per line in the following format: variable=value
- {Date}
- Any mode
- The date when the policy rule is executed, in the following format: MMM[mm]/dd[/yyyy]
where:
- MMM—Specifies the month. For example: Feb
- mm—Specifies the month numerically. For example: 02
- dd—Specifies the day of the month. For example: 09
- yyyy—Specifies the year. For example: 2017
- {Device}
- Any mode
- Replaced with the name of the device for which the policy rule is being evaluated.
- {DeviceId}
- Any mode
- Replaced with the ID of the device for which the policy rule is being evaluated.
- {Policy}
- Any mode
- Replaced with the name of the policy rule that is being executed.
- {Policy.Variable}
- Replaced with the name of the policy variable.
- {QosDir}
- Any mode
- Replaced with the direction of the flow for which the policy rule is being evaluated, either Up (uplink) or Down (downlink).
- {Time}
- Any mode
- Replaced with the time when the policy rule is executed, in the following format: hh:mm:ss.SSS
where:
- hh—Specifies the hour in 24-hour time.
- mm—Specifies the minutes.
- ss—Specifies the seconds.
- SSS—Specifies the fractional seconds.
- {Account.AccountId}
- Wireless
- Replaced with the account ID of the account associated with the request.
- {Account.DownstreamLimit}
- Wireless
- Replaced with the downstream bandwidth limit of the account associated with the request.
- {Account.StaticIpAddresses}
- Wireless
- Replaced with the static IP address of the account associated with the request.
- {Account.Tier.DownstreamLimit} {}
- Wireless
- Replaced with the downstream bandwidth limit of the tier of the account associated with the request.
- {AccountTier.Entitlements}
- Wireless
- Replaced with the entitlements of the tier of the account associated with the request.
- {Account.Tier.Name}
- Wireless
- Replaced with the name of the tier of the account associated with the request.
- {Account.Tier.UpstreamLimit}
- Wireless
- Replaced with the upstream bandwidth limit if the tier of the account associated with the request.
- {Account.UpstreamLimit}
- Wireless
- Replaced with the upstream bandwidth limit of the account associated with the request.
- {Application.HDThreshold}
- Wireless
- {Application.LatencySensitivity}
- Wireless
- {Application.Name}
- Wireless
- Replaced with the name of the application associated with the request.
- {DefaultEPSBearerQos.QoSClassIdentifier}
- {Device.DiameterRealm}
- Any device
- Replaced with the Diameter realm name for the device.
- {Device.FlowCount}
- Any device
- Replaced with the number of active flows for the device.
- {Device.Name}
- Any device
- Replaced with the name (as defined in the CMP database) of the device.
- {Element.DiameterRealm}
- Wireless
- Replaced with the Diameter realm of the network element associated with the current device.
- {Element.Name}
- Any device
- Replaced with the name (as defined in the CMP database) of the network element associated with the current device. If the device is a network element, then this is the same as {Device.Name}. However, if the device is contained within a network element (as is the case with Interfaces, Channels, and so forth), then this has a different value.
- {Flow.AFAppId}
- Wireless
- Replaced with a string, which can be used to identify the service being used on the flow associated with an Rx application (for example, voice or gaming).
- {Flow.ARP.PreemptionCapability}
- Wireless
- Replaced with an integer representing whether this service data flow or bearer can get resources that were already assigned to another service data flow with a lower priority level:
- 0 (PRE-EMPTION_CAPABILITY_ENABLED)—the service data flow or bearer is allowed to get resources
- 1 (PRE-EMPTION_CAPABILITY_DISABLED, the default, applied if this AVP is not supplied)—the service data flow or bearer is not allowed to get resources
- {Flow.ARP.PreemptionVulnerability}
- Wireless
- Replaced with an integer representing whether the resources assigned to this service data flow or bearer can be assigned to another service data flow with a higher priority level:
- 0 (PRE-EMPTION_VULNERABILITY_ENABLED, the default, applied if this AVP is not supplied)—the resources can be preempted and allocated to a service data flow or bearer with a higher priority
- 1 (PRE-EMPTION_VULNERABILITY_DISABLED)—the resources cannot be preempted and allocated to a service data flow or bearer with a higher priority
- {Flow.ARP.PriorityLevel}
- Wireless
- Replaced with an integer representing the priority of a resource request, from 1 (highest) to 15 (lowest).
- {Flow.BearerUsage}
- Wireless
- {Flow.Fax}
- Wireless
- Replaced with a boolean value representing whether or not the flow associated with an Rx application is transporting fax data.
- {Flow.FlowStatus}
- Wireless
- Replaced with an integer representing the status of the flow(s) associated with an Rx application:
- 0 (ENABLED-UPLINK)—associated uplink IP flows are enabled and associated downlink IP flows are disabled
- 1 (ENABLED-DOWNLINK)—associated downlink IP flows are enabled and associated uplink IP flows are disabled
- 2 (ENABLED)—associated IP flows in both directions are enabled
- 3 (DISABLED)—associated IP flows in both directions are disabled
- 4 (REMOVED)—all associated IP flows in both directions have been removed (and not taken into account when calculating QoS)
- {Flow.FlowUsage}
- Wireless
- {Flow.GuaranteedBitrateDownlink}
- Wireless
- {Flow.GuaranteedBitrateUplink}
- Wireless
- {Flow.IsDownstream}
- Wireless
- Replaced with a boolean value representing the flow direction associated with an Rx application, either true (IP flows are out) or false (IP flows are in).
- {Flow.IsPrimaryBearer}
- Wireless
- {Flow.MaxRequestedBandwidth}
- Wireless
- The default value is -1. Uses the original value of the AVP Max-Requested-Bandwidth-UL/Max-Requested-Bandwidth-DL within the MCD/MSC of Rx AAR message.
- {Flow.MaxRequestedBandwidthDownlink}
- Wireless
- {Flow.MaxRequestedBandwidthUplink}
- Wireless
- {Flow.MediaType}
- Wireless
- {Flow.MeteringMethod}
- Wireless
- Replaced with an integer representing how usage is metered for offline charging; -1 means that the PCEF uses a provisioned default value.
- {Flow.MinRequestedBandwidth}
- Wireless
- The default value is -1. Uses the original value of the AVP Min-Requested-Bandwidth-UL/Min-Requested-Bandwidth-DL within the MCD/MSC of Rx AAR message.
- {Flow.MonitoringKey}
- Wireless
- Replaced with an integer representing the unique identifier that associates this rule with a Monitoring-Key used in Gx quota.
- {Flow.Offline}
- Wireless
- Replaced with an integer representing whether offline charging for the associated PCC rule is enabled or disabled:
- -1—The PCEF uses a provisioned default value
- 0 (DISABLE_OFFLINE)—The offline charging server is disabled
- 1 (ENABLE_OFFLINE)—The offline charging server is enabled
- {Flow.Online}
- Wireless
- Replaced with an integer representing whether online charging for the associated PCC rule is enabled or disabled:
- -1—The PCEF uses a provisioned default value
- 0 (DISABLE_ONLINE)—The online charging server is disabled
- 1 (ENABLE_ONLINE)—The online charging server is enabled
- {Flow.Precedence}
- Wireless
- Replaced with an integer representing the PCC rule precedence.
- {Flow.QoSClassIdentifier}
- Wireless
- Replaced with an integer representing a QoS-Class-Identifier that indicates standardized characteristics defined in 3GPP TS 23.203(7):
- 1—QCI_1
- 2—QCI_2
- 3—QCI_3
- 4—QCI_4
- 5—QCI_5
- 6—QCI_6
- 7—QCI_7
- 8—QCI_8
- 9—QCI_9
- 65—QCI_65
- 66—QCI_66
- 69—QCI_69
- 70—QCI_70
- {Flow.RatingGroup}
- Wireless
- Replaced with the charging key for the PCC rule associated with this request.
- {Flow.ReportingLevel}
- Wireless
- Replaced with a value representing the requested level of usage reporting for the PCC rule associated with this request:
- 0 (SERVICE_IDENTIFIER_LEVEL)—Usage is reported on the service ID and rating group combination level, and is applicable when the Service-Identifier and Rating-Group AVPs have been provisioned within the Charging-Rule-Definition AVP
- 1 (RATING_GROUP_LEVEL)—Usage is reported on the rating group level, and is applicable when the Rating-Group AVP has been provisioned within the Charging-Rule-Definition AVP
- 2 (SPONSORED_CONNECTIVITY_LEVEL)—Applicable for offline charging, usage is reported on the sponsored identity and rating group combination level, and is applicable when the Sponsor-Identity, Application-Service-Provider-Identity, and Rating-Group AVPs have been provisioned within the Charging-Rule-Definition AVP
- {Flow.ReservationPriority}
- Wireless
- Replaced with an integer representing the priority of a flow associated with an Rx application, from 0 (lowest, the default) to 7 (highest).
- {Flow.RRBw}
- Wireless
- {Flow.RSBw}
- Wireless
- {Flow.RuleName}
- Wireless
- {Flow.RuleType}
- Wireless
- {Flow.ServiceFlowDetection}
- Wireless
- {Flow.ServiceIdentifier}
- Wireless
- Replaced with an integer representing the service associated with this request.
- {Quota.Limit.quotaname.ServiceSpecific}
- Wireless
- {Quota.Limit.quotaname.Time}
- Wireless
- {Quota.Limit.quotaname.Volume}
- Wireless
- {RAI.LAC}
- Wireless
- {RAI.MccMnc}
- Wireless
- {RAI.RAC}
- Wireless
- {Request.AFAppId}
- Wireless
- Replaced with the application function identifier of the application associated with the request.
- {Request.AppId}
- Wireless
- Replaced with the application identifier of the application associated with the request.
- {Request.CalledStationId}
- Wireless
- {Request.GatewayMccMnc}
- Wireless
- {Request.IPCANType}
- Wireless
- {Request.MobilityProtocol}
- Wireless
- {Request.MsgType}
- Wireless
- {Request.NetworkRequestSupport}
- Wireless
- {Request.Primary}
- Wireless
- {Request.QoSNegotiation}
- Wireless
- {Request.QoSUpgrade}
- Wireless
- {Request.RATType}
- Wireless
- {Request.Reason}
- Wireless
- {Request.ReservationPriority}
- Wireless
- {Request.ServiceInfoStatus}
- Wireless
- {Request.ServingGatewayAddress}
- Wireless
- {Request.ServingMccMnc}
- Wireless
- {Session.AFAppId}
- Wireless
- {Session.APNAggregateMaxBitrateDownlink}
- Wireless
- {Session.APNAggregateMaxBitrateUplink}
- Wireless
- {Session.AppId}
- Wireless
- {Session.CalledStationId}
- Wireless
- {Session.GatewayMccMnc}
- Wireless
- {Session.IMEI}
- Any device
- Replaced with the IMEI of the phone for the subscriber or for the equipment associated with the request.
- {Session.IMEISV}
- Any device
- Replaced with the IMEISV of the subscriber's phone or equipment associated with the request.
- {Session.IPCANType}
- Wireless
- {Session.IsPrimary}
- Wireless
- {Session.MobilityProtocol}
- Wireless
- {Session.NetworkRequestSupport}
- Wireless
- {Session.NextBillingDate}
- Wireless
- Replaced with the next monthly billing date, in the format MM[M]/dd/yyyy (for example, Oct/24/2017). The date format can be changed by specifying the new format within parentheses; for example, {Session.NextBillingDate (MM/dd)} could result in 10/24.
- {Session.RATType}
- Wireless
- {Session.Secondary}
- Wireless
- {Session.ServiceUrn}
- Wireless
- {Session.ServingMcc}
- Wireless
- Replaced with the serving Mobile Country Code associated with the request.
- {Session.ServingMccMnc}
- Wireless
- {Session.SupportedFeature}
- Wireless
- {Session.UserEquipmentInfo}
- Wireless
- {User.BillingDate}
- Wireless
- Replaced with the Billing Date value of the subscriber associated with the request.
- {User.BillingDay}
- Wireless
- Replaced with the Billing Day value of the subscriber associated with the request.
- {User.BillingType}
- Wireless
- Replaced with the Billing Type value of the subscriber associated with the request.
- {User.Custom}
- Wireless
- {User.DownstreamGuaranteed}
- Wireless
- {User.DownstreamLimit}
- Wireless
- {User.E164}
- Wireless
- Replaced with the E.164 phone number of the subscriber associated with the request.
- {User.Entitlement}
- Wireless
- Replaced with the Entitlement value of the subscriber associated with the request.
- {User.IMSI}
- Wireless
- Replaced with the IMSI of the subscriber associated with the request.
- {User.IP}
- Wireless
- Replaced with the IP address of the subscriber associated with the request.
- {User.MSISDN}
- Wireless
- Replaced with the mobile subscriber ISDN of the subscriber associated with the request.
- {User.NAI}
- Wireless
- {User.PoolId}
- Wireless
- Replaced with the ID of the pool for the subscriber.
- {User.Quota.quotaName.ServiceSpecific}
- Wireless
- Replaced with the total number of service-specific events for the subscriber from the quota quotaName. This variable applies to subscriber-level and pool-level quota defined on the MPE device.
- {User.Quota.quotaname.Time}
- Wireless
- Replaced with the total time in seconds consumed by the subscriber from the quota quotaname. This variable applies to subscriber-level and pool-level quota defined on the device.
- {User.Quota.quotaname.Volume}
- Wireless
- Replaced with the total volume in bytes consumed by the subscriber from the quota quotaname. This variable applies to subscriber-level and pool-level quota defined on the device.
- {User.SIP}
- Wireless
- Replaced with the SIP URI of the subscriber associated with the request.
- {User.Tier}
- Wireless
- Replaced with the Tier value of the subscriber associated with the request.
- {User.UpstreamGuaranteed}
- Wireless
- {User.UpstreamLimit}
- Wireless
- {VendorId}
- Wireless