Oracle Communications Policy Management Policy Variables ... · PDF filePolicy Management Policy Variables Reference ... Oracle Communications Policy Management Policy Variables Reference,

Oracle® CommunicationsPolicy ManagementPolicy Variables Reference

Release 12.3

E85348 Revision 01

July 2017

Oracle Communications Policy Management Policy Variables Reference, Release 12.3Copyright © 2017, Oracle and/or its affiliates. All rights reserved.

This software and related documentation are provided under a license agreement containing restrictionson use and disclosure and are protected by intellectual property laws. Except as expressly permitted in yourlicense agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license,transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverseengineering, disassembly, or decompilation of this software, unless required by law for interoperability, isprohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free.If you find any errors, please report them to us in writing.

If this is software or related documentation that is delivered to the U.S. Government or anyone licensing iton behalf of the U.S. Government, then the following notice is applicable:

U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software,any programs installed on the hardware, and/or documentation, delivered to U.S. Government end usersare "commercial computer software" pursuant to the applicable Federal Acquisition Regulation andagency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptationof the programs, including any operating system, integrated software, any programs installed on thehardware, and/or documentation, shall be subject to license terms and license restrictions applicable to theprograms. No other rights are granted to the U.S. Government.

This software or hardware is developed for general use in a variety of information management applications.It is not developed or intended for use in any inherently dangerous applications, including applicationsthat may create a risk of personal injury. If you use this software or hardware in dangerous applications,then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures toensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused byuse of this software or hardware in dangerous applications.

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarksof their respective owners.

Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarksare used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD,Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of AdvancedMicro Devices. UNIX is a registered trademark of The Open Group.

This software or hardware and documentation may provide access to or information about content, products,and services from third parties. Oracle Corporation and its affiliates are not responsible for and expresslydisclaim all warranties of any kind with respect to third-party content, products, and services unless otherwiseset forth in an applicable agreement between you and Oracle. Oracle Corporation and its affiliates will notbe responsible for any loss, costs, or damages incurred due to your access to or use of third-party content,products, or services, except as set forth in an applicable agreement between you and Oracle.

Table of Contents

Chapter 1: Introduction.................................................................................6Introduction............................................................................................................................................7How This Document is Organized......................................................................................................7Scope and Audience..............................................................................................................................7Documentation Admonishments.........................................................................................................7Related Publications..............................................................................................................................8Locate Product Documentation on the Oracle Help Center Site.....................................................8Customer Training.................................................................................................................................9My Oracle Support (MOS)....................................................................................................................9Emergency Response.............................................................................................................................9

Chapter 2: Policy Variables Overview.....................................................11About Policy Rule Variables...............................................................................................................12

Chapter 3: Lists of Variables......................................................................14Basic Policy Rule Variables.................................................................................................................15

Selectable Policy Rule Variables.............................................................................................15Policy Rule Variables for Flows.........................................................................................................24

Rx Application Provisioning Flow Variables.......................................................................24PCC/ADC Flow Variables......................................................................................................26ADC Flow Variables................................................................................................................30

Policy Rule Variables for Rx Requests..............................................................................................30Policy Rule Variables for Sy Requests...............................................................................................33Policy Rule Variables for Quotas, Quota Conventions, and Quota Objects................................34

Quota Object Variables............................................................................................................35Quota and Quota Convention Variables..............................................................................36

Policy Rule Variables for User Quotas..............................................................................................36Policy Rule Variables for RADIUS....................................................................................................37

RADIUS Policy Rule TLV Variables......................................................................................38

iiiE85348 Revision 01, July 2017

List of Figures

Figure 1: Policy Rule Variables Basic List in Policy Wizard......................................................................15

ivE85348 Revision 01, July 2017

List of Tables

Table 1: Admonishments..................................................................................................................................7

vE85348 Revision 01, July 2017

Chapter

1Introduction

This chapter describes the content and structure ofthe manual, indicates how to obtain help, details

Topics:

• Introduction.....7 where to find related documentation, and providesother general information.• How This Document is Organized.....7

• Scope and Audience.....7• Documentation Admonishments.....7• Related Publications.....8• Locate Product Documentation on the Oracle Help

Center Site.....8• Customer Training.....9• My Oracle Support (MOS).....9• Emergency Response.....9

6E85348 Revision 01, July 2017

Introduction

This guide describes variables that can be used in policy rules. These variables provide informationabout the device, subscriber, or quota for which a policy rule is being executed.

How This Document is Organized

The information in this document is presented in the following order:

• Introduction provides general information about the organization of this document, about relateddocumentation, and how to get technical assistance.

• Policy Variables Overview explains the use of this document and the purpose of policy variables.• Lists of Variables lists available variables, their data types, and their descriptions.

Scope and Audience

This document is intended for the following trained and qualified service personnel who are responsiblefor Policy Management devices:

• Application administrators, who install and upgrade Policy Management applications and performadvanced system administration

• Operators, who monitor Policy Management systems daily and perform adjustments• System administrators, who control access to the CMP system• System architects, who design carrier network system architectures, including planning for Policy

Management systems• Network administrators, who manage carrier networks

Documentation Admonishments

Admonishments are icons and text throughout this manual that alert the reader to assure personalsafety, to minimize possible service interruptions, and to warn of the potential for equipment damage.

Table 1: Admonishments

DescriptionIcon

Danger:

(This icon and text indicate the possibility ofpersonal injury.)


Introduction

DescriptionIcon

Warning:

(This icon and text indicate the possibility ofequipment damage.)

Caution:

(This icon and text indicate the possibility ofservice interruption.)

Topple:

(This icon and text indicate the possibility ofpersonal injury and equipment damage.)

Related Publications

For information about additional publications related to this document, refer to the Oracle Help Centersite. See Locate Product Documentation on the Oracle Help Center Site for more information on relatedproduct publications.

Locate Product Documentation on the Oracle Help Center Site

Oracle Communications customer documentation is available on the web at the Oracle Help Center(OHC) site, http://docs.oracle.com. You do not have to register to access these documents. Viewing thesefiles requires Adobe Acrobat Reader, which can be downloaded at http://www.adobe.com.

1. Access the Oracle Help Center site at http://docs.oracle.com.2. Click Industries.3. Under the Oracle Communications subheading, click the Oracle Communications

documentation link.The Communications Documentation page appears. Most products covered by these documentationsets will appear under the headings “Network Session Delivery and Control Infrastructure” or“Platforms.”

4. Click on your Product and then the Release Number.A list of the entire documentation set for the selected product and release appears.

5. To download a file to your location, right-click the PDF link, select Save target as (or similarcommand based on your browser), and save to a local folder.


Introduction

http://docs.oracle.com

http://www.adobe.com

http://docs.oracle.com

Customer Training

Oracle University offers training for service providers and enterprises. Visit our web site to view, andregister for, Oracle Communications training:

http://education.oracle.com/communication

To obtain contact phone numbers for countries or regions, visit the Oracle University Education website:

www.oracle.com/education/contacts

My Oracle Support (MOS)

MOS (https://support.oracle.com) is your initial point of contact for all product support and trainingneeds. A representative at Customer Access Support (CAS) can assist you with MOS registration.

Call the CAS main number at 1-800-223-1711 (toll-free in the US), or call the Oracle Support hotlinefor your local country from the list at http://www.oracle.com/us/support/contact/index.html. When calling,make the selections in the sequence shown below on the Support telephone menu:

1. Select 2 for New Service Request2. Select 3 for Hardware, Networking and Solaris Operating System Support3. Select one of the following options:

• For Technical issues such as creating a new Service Request (SR), Select 1• For Non-technical issues such as registration or assistance with MOS, Select 2

You will be connected to a live agent who can assist you with MOS registration and opening a supportticket.

MOS is available 24 hours a day, 7 days a week, 365 days a year.

Emergency Response

In the event of a critical service situation, emergency response is offered by the Customer AccessSupport (CAS) main number at 1-800-223-1711 (toll-free in the US), or by calling the Oracle Supporthotline for your local country from the list at http://www.oracle.com/us/support/contact/index.html. Theemergency response provides immediate coverage, automatic escalation, and other features to ensurethat the critical situation is resolved as rapidly as possible.

A critical situation is defined as a problem with the installed equipment that severely affects service,traffic, or maintenance capabilities, and requires immediate corrective action. Critical situations affectservice and/or system operation resulting in one or several of these situations:

• A total system failure that results in loss of all transaction processing capability• Significant reduction in system capacity or traffic handling capability• Loss of the system’s ability to perform automatic system reconfiguration


Introduction

http://education.oracle.com/pls/web_prod-plq-dad/ou_product_category.getFamilyPage?p_family_id=41&p_mode=Training&sc=WWOU14047594MPP002C005

http://education.oracle.com/pls/web_prod-plq-dad/db_pages.getpage?page_id=225

https://support.oracle.com

http://www.oracle.com/us/support/contact/index.html

http://www.oracle.com/us/support/contact/index.html

• Inability to restart a processor or the system• Corruption of system databases that requires service affecting corrective actions• Loss of access for maintenance or recovery operations• Loss of the system ability to provide any required critical or major trouble notification

Any other problem severely affecting service, capacity/traffic, billing, and maintenance capabilitiesmay be defined as critical by prior discussion and agreement with Oracle.


Introduction

Chapter

2Policy Variables Overview

This chapter provides an introduction to thevariables used in policy rules and tables and their

Topics:

• About Policy Rule Variables.....12 roles in Oracle Communications PolicyManagement.


About Policy Rule Variables

Under certain circumstances an MPE device can associate additional information with a request. Thisinformation can be obtained using policy rule variables and used during policy rule execution. Duringpolicy rule execution, variables are replaced with context-specific information. Each time a policy ruleis evaluated, the unique set of policy rule variable replacements is referred to as the policy context.

The availability of this information depends on:

• The carrier network environment (wireless, cable, or wireline) in which the MPE device is executing.Some variables are only meaningful in certain modes, while others are available in all modes.

• The device for which a policy rule is being executed. Some variables are only available for certaindevice types, while others are available for all devices.

• Whether the information is provisioned on the MPE device or, if present, a Subscriber ProfileRepository (SPR) database.

• The protocol in use and how much information is available in the request. Some protocols haveoptional information which, if specified, can be used to associate additional information.

The format of a policy rule variable is as follows:

{name[:default-value]}

The name can contain the following characters:

• A–Z• a–z• 0–9• underscore (_)• period (.)• backslash (\)

Note: When you create a policy rule, the format and validity of a variable is not checked.

The following are examples of policy rule variables:

{Bandwidth}

{Device.Name}

{Flow.ARP.PriorityLevel}

{Policy.Variable.RandVarf:2017-10-24T10:24:54}

The following are examples of policy variable use in conditions and actions:

• In a condition to evaluate the value of a policy context property: where the policy contextproperty {Request.DefaultEPSBearerQoS.QoSClassIdentifier} is numericallyequal to 8

• In an action to set a policy context property: set policy context property QCI to{Flow.QoSClassIdentifier}


Policy Variables Overview

• In an action to substitute textual information into a text message sent to a subscriber: send smsalert `You have reached 80%% of your quota {User.MSISDN}` to user

• In an action to substitute textual information into a logging message: send notification tosyslog with `{User.Name}: Allocated {User.Quota.WeekGold.volume}` andseverity `Info`

Policy rule variables are used in key columns of policy tables. The policy engine obtains the valuefrom the policy context when using the policy table to look up a row. When you define the key, youcan either select a basic policy variable from a list or directly enter the name of the variable you wantto use.


Policy Variables Overview

Chapter

3Lists of Variables

This chapter lists rule variables, their data types,and descriptions.

Topics:

• Basic Policy Rule Variables.....15• Policy Rule Variables for Flows.....24• Policy Rule Variables for Rx Requests.....30• Policy Rule Variables for Sy Requests.....33• Policy Rule Variables for Quotas, Quota

Conventions, and Quota Objects.....34• Policy Rule Variables for User Quotas.....36• Policy Rule Variables for RADIUS.....37


Basic Policy Rule Variables

When you build a policy table, the policy table wizard provides a selectable list of basic policy rulevariables when you define a key column. Figure 1: Policy Rule Variables Basic List in Policy Wizard showsan example of the basic list.

Figure 1: Policy Rule Variables Basic List in Policy Wizard

Selectable Policy Rule Variables describes the selectable policy rule variables.

Selectable Policy Rule Variables

DescriptionVariable NameAny mode{Bandwidth}Replaced with the DOCSIS type of the flow for whichthe policy rule is being evaluated:

• BES• NRTP• RTP• UGS• UGSAD

Any mode{Conditions}


Lists of Variables

DescriptionVariable NameReplaced with a list of (variable, value) tuples that liststhe variables whose values were referenced in theconditions of the policy rule. The list is inserted withone variable per line in the following format:variable=value

Any mode{Date}The date when the policy rule is executed, in thefollowing 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

Any mode{Device}Replaced with the name of the device for which thepolicy rule is being evaluated.

Any mode{DeviceId}Replaced with the ID of the device for which the policyrule is being evaluated.

Any mode{Policy}Replaced with the name of the policy rule that is beingexecuted.

Replaced with the name of the policy variable.{Policy.Variable}

Any mode{QosDir}Replaced with the direction of the flow for which thepolicy rule is being evaluated, either Up (uplink) orDown (downlink).

Any mode{Time}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.

Wireless{Account.AccountId}Replaced with the account ID of the account associatedwith the request.

Wireless{Account.DownstreamLimit}


Lists of Variables

DescriptionVariable NameReplaced with the downstream bandwidth limit of theaccount associated with the request.

Wireless{Account.StaticIpAddresses}Replaced with the static IP address of the accountassociated with the request.

Wireless{Account.Tier.DownstreamLimit} {}Replaced with the downstream bandwidth limit of thetier of the account associated with the request.

Wireless{AccountTier.Entitlements}Replaced with the entitlements of the tier of the accountassociated with the request.

Wireless{Account.Tier.Name}Replaced with the name of the tier of the accountassociated with the request.

Wireless{Account.Tier.UpstreamLimit}Replaced with the upstream bandwidth limit if the tierof the account associated with the request.

Wireless{Account.UpstreamLimit}Replaced with the upstream bandwidth limit of theaccount associated with the request.

Wireless{Application.HDThreshold}

Wireless{Application.LatencySensitivity}

Wireless{Application.Name}Replaced with the name of the application associatedwith the request.

{DefaultEPSBearerQos.QoSClassIdentifier}

Any device{Device.DiameterRealm}Replaced with the Diameter realm name for the device.

Any device{Device.FlowCount}Replaced with the number of active flows for the device.

Any device{Device.Name}Replaced with the name (as defined in the CMPdatabase) of the device.

Wireless{Element.DiameterRealm}Replaced with the Diameter realm of the networkelement associated with the current device.

Any device{Element.Name}Replaced with the name (as defined in the CMPdatabase) of the network element associated with thecurrent device. If the device is a network element, then


Lists of Variables

DescriptionVariable Namethis is the same as {Device.Name}. However, if thedevice is contained within a network element (as is thecase with Interfaces, Channels, and so forth), then thishas a different value.

Wireless{Flow.AFAppId}Replaced with a string, which can be used to identifythe service being used on the flow associated with anRx application (for example, voice or gaming).

Wireless{Flow.ARP.PreemptionCapability}Replaced with an integer representing whether thisservice data flow or bearer can get resources that werealready assigned to another service data flow with alower priority level:

• 0 (PRE-EMPTION_CAPABILITY_ENABLED) — theservice data flow or bearer is allowed to getresources

• 1 (PRE-EMPTION_CAPABILITY_DISABLED, thedefault, applied if this AVP is not supplied) — theservice data flow or bearer is not allowed to getresources

Wireless{Flow.ARP.PreemptionVulnerability}Replaced with an integer representing whether theresources assigned to this service data flow or bearercan be assigned to another service data flow with ahigher priority level:

• 0 (PRE-EMPTION_VULNERABILITY_ENABLED,the default, applied if this AVP is not supplied) —the resources can be preempted and allocated to aservice data flow or bearer with a higher priority

• 1 (PRE-EMPTION_VULNERABILITY_DISABLED)— the resources cannot be preempted and allocatedto a service data flow or bearer with a higher priority

Wireless{Flow.ARP.PriorityLevel}Replaced with an integer representing the priority of aresource request, from 1 (highest) to 15 (lowest).

Wireless{Flow.BearerUsage}

Wireless{Flow.Fax}Replaced with a boolean value representing whetheror not the flow associated with an Rx application istransporting fax data.

Wireless{Flow.FlowStatus}Replaced with an integer representing the status of theflow(s) associated with an Rx application:


Lists of Variables

DescriptionVariable Name• 0 (ENABLED-UPLINK) — associated uplink IP flows

are enabled and associated downlink IP flows aredisabled

• 1 (ENABLED-DOWNLINK) — associated downlinkIP flows are enabled and associated uplink IP flowsare disabled

• 2 (ENABLED) — associated IP flows in bothdirections are enabled

• 3 (DISABLED) — associated IP flows in bothdirections are disabled

• 4 (REMOVED) — all associated IP flows in bothdirections have been removed (and not taken intoaccount when calculating QoS)

Wireless{Flow.FlowUsage}

Wireless{Flow.GuaranteedBitrateDownlink}

Wireless{Flow.GuaranteedBitrateUplink}

Wireless{Flow.IsDownstream}Replaced with a boolean value representing the flowdirection associated with an Rx application, either true(IP flows are out) or false (IP flows are in).

Wireless{Flow.IsPrimaryBearer}

Wireless{Flow.MaxRequestedBandwidthDownlink}

Wireless{Flow.MaxRequestedBandwidthUplink}

Wireless{Flow.MediaType}

Wireless{Flow.MeteringMethod}Replaced with an integer representing how usage ismetered for offline charging; -1 means that the PCEFuses a provisioned default value.

Wireless{Flow.MonitoringKey}Replaced with an integer representing the uniqueidentifier that associates this rule with a Monitoring-Keyused in Gx quota.

Wireless{Flow.Offline}Replaced with an integer representing whether offlinecharging for the associated PCC rule is enabled ordisabled:

• -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

Wireless{Flow.Online}


Lists of Variables

DescriptionVariable NameReplaced with an integer representing whether onlinecharging for the associated PCC rule is enabled ordisabled:

• -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

Wireless{Flow.Precedence}Replaced with an integer representing the PCC ruleprecedence.

Wireless{Flow.QoSClassIdentifier}Replaced with an integer representing aQoS-Class-Identifier that indicates standardizedcharacteristics 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

Wireless{Flow.RatingGroup}Replaced with the charging key for the PCC ruleassociated with this request.

Wireless{Flow.ReportingLevel}Replaced with a value representing the requested levelof usage reporting for the PCC rule associated with thisrequest:

• 0 (SERVICE_IDENTIFIER_LEVEL) — Usage isreported on the service ID and rating groupcombination level, and is applicable when theService-Identifier and Rating-Group AVPs have beenprovisioned within the Charging-Rule-DefinitionAVP

• 1 (RATING_GROUP_LEVEL) — Usage is reportedon the rating group level, and is applicable when


Lists of Variables

DescriptionVariable Namethe Rating-Group AVP has been provisioned withinthe Charging-Rule-Definition AVP

• 2 (SPONSORED_CONNECTIVITY_LEVEL) —Applicable for offline charging, usage is reportedon the sponsored identity and rating groupcombination level, and is applicable when theSponsor-Identity,Application-Service-Provider-Identity, andRating-Group AVPs have been provisioned withinthe Charging-Rule-Definition AVP

Wireless{Flow.ReservationPriority}Replaced with an integer representing the priority of aflow associated with an Rx application, from 0 (lowest,the default) to 7 (highest).

Wireless{Flow.RRBw}

Wireless{Flow.RSBw}

Wireless{Flow.RuleName}

Wireless{Flow.RuleType}

Wireless{Flow.ServiceFlowDetection}

Wireless{Flow.ServiceIdentifier}Replaced with an integer representing the serviceassociated with this request.

Wireless{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}Replaced with the application function identifier of theapplication associated with the request.

Wireless{Request.AppId}Replaced with the application identifier of theapplication associated with the request.

Wireless{Request.CalledStationId}

Wireless{Request.GatewayMccMnc}

Wireless{Request.IPCANType}

Wireless{Request.MobilityProtocol}

Wireless{Request.MsgType}


Lists of Variables

DescriptionVariable NameWireless{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}

Any device{Session.IMEI}Replaced with the IMEI of the phone for the subscriberor for the equipment associated with the request.

Any device{Session.IMEISV}Replaced with the IMEISV of the subscriber's phone orequipment associated with the request.

Wireless{Session.IPCANType}

Wireless{Session.IsPrimary}

Wireless{Session.MobilityProtocol}

Wireless{Session.NetworkRequestSupport}

Wireless{Session.NextBillingDate}Replaced with the next monthly billing date, in theformat MM[M]/dd/yyyy (for example, Oct/24/2017).The date format can be changed by specifying the newformat within parentheses; for example,{Session.NextBillingDate (MM/dd)} could result in10/24.

Wireless{Session.RATType}

Wireless{Session.Secondary}

Wireless{Session.ServiceUrn}


Lists of Variables

DescriptionVariable NameWireless{Session.ServingMcc}Replaced with the serving Mobile Country Codeassociated with the request.

Wireless{Session.ServingMccMnc}

Wireless{Session.SupportedFeature}

Wireless{Session.UserEquipmentInfo}

Wireless{User.BillingDate}Replaced with the Billing Date value of the subscriberassociated with the request.

Wireless{User.BillingDay}Replaced with the Billing Day value of the subscriberassociated with the request.

Wireless{User.BillingType}Replaced with the Billing Type value of the subscriberassociated with the request.

Wireless{User.Custom}

Wireless{User.DownstreamGuaranteed}

Wireless{User.DownstreamLimit}

Wireless{User.E164}Replaced with the E.164 phone number of the subscriberassociated with the request.

Wireless{User.Entitlement}Replaced with the Entitlement value of the subscriberassociated with the request.

Wireless{User.IMSI}Replaced with the IMSI of the subscriber associatedwith the request.

Wireless{User.IP}Replaced with the IP address of the subscriberassociated with the request.

Wireless{User.MSISDN}Replaced with the mobile subscriber ISDN of thesubscriber associated with the request.

Wireless{User.NAI}

Wireless{User.PoolId}Replaced with the ID of the pool for the subscriber.

Wireless{User.Quota.quotaName.ServiceSpecific}Replaced with the total number of service-specificevents for the subscriber from the quota quotaName.


Lists of Variables

DescriptionVariable NameThis variable applies to subscriber-level and pool-levelquota defined on the MPE device.

Wireless{User.Quota.quotaname.Time}Replaced with the total time in seconds consumed bythe subscriber from the quota quotaname. This variableapplies to subscriber-level and pool-level quota definedon the device.

Wireless{User.Quota.quotaname.Volume}Replaced with the total volume in bytes consumed bythe subscriber from the quota quotaname. This variableapplies to subscriber-level and pool-level quota definedon the device.

Wireless{User.SIP}Replaced with the SIP URI of the subscriber associatedwith the request.

Wireless{User.Tier}Replaced with the Tier value of the subscriber associatedwith the request.

Wireless{User.UpstreamGuaranteed}

Wireless{User.UpstreamLimit}

Wireless{VendorId}

Policy Rule Variables for Flows

In addition to the basic policy rule variables, you can use the following flow-related variables definedfor the Diameter Rx protocol to get information on:

• Rx application provisioning• PCC/ADC-specific fields from Charging-Rule-Definition• ADC flows

Rx Application Provisioning Flow Variables defines policy rule variables that can be used with Rxapplication provisioning. PCC/ADC Flow Variables defines policy rule variables that can be used withPCC/ADC-specific fields. ADC Flow Variables defines policy rule variables that can be used with ADCflows.

Rx Application Provisioning Flow Variables

In addition to the basic policy rule variables, you can use the following variables to get flow informationfor Rx applications.

DescriptionVariable NameWireless{Flow.AFAppId}


Lists of Variables

DescriptionVariable NameReplaced with a string, which can be used to identifythe service being used on the flow associated with anRx application (for example, voice or gaming).

Wireless{Flow.ApplicationServiceProviderIdentity}Replaced with a string representing theApplication-Service-Provider-Identity AVP, used forsponsored data connectivity purposes as an identifierof the application service provider.

Wireless{Flow.BandwidthChangedByPolicy}Replaced with a boolean value indicating whether ornot the field MaxAdjustedRequestedBw was changedby a policy to limit the bandwidth on the flow.

Cable{Flow.ClassifierId}Replaced with an integer representing a classifer ID usedto match PCMM and Diameter classifiers.

Cable{Flow.CodecMediaType}Replaced with a string representing the codec mediatype (indicated by the "m" attribute within the receivedcodec).

Cable{Flow.CodecNameSet}Replaced with a hashset representing the codec namereceived in the codec data AVP.

Wireless{Flow.Fax}Replaced with a boolean value representing whether ornot the flow associated with an Rx application istransporting fax data.

Wireless{Flow.FlowNumber}Replaced with an integer representing the flow number.(This is the same for upstream and downstream flowsbelonging to the same media.)

Wireless{Flow.FlowStatus}Replaced with an integer representing the status of theflow(s) associated with an Rx application:

• 0 (ENABLED-UPLINK) — associated uplink IP flowsare enabled and associated downlink IP flows aredisabled

• 1 (ENABLED-DOWNLINK) — associated downlinkIP flows are enabled and associated uplink IP flowsare disabled

• 2 (ENABLED) — associated IP flows in bothdirections are enabled

• 3 (DISABLED) — associated IP flows in bothdirections are disabled


Lists of Variables

DescriptionVariable Name• 4 (REMOVED) — all associated IP flows in both

directions have been removed (and not taken intoaccount when calculating QoS)

Wireless{Flow.IsDownstream}Replaced with a boolean value representing the flowdirection associated with an Rx application, either true(IP flows are out) or false (IP flows are in).

Wireless{Flow.ReservationPriority}Replaced with an integer representing the priority of aflow associated with an Rx application, from 0 (lowest,the default) to 7 (highest).

Wireless{Flow.RequiredAccessInfo}Replaced with an integer representing theRequiredAccessInfo mask.

Wireless{Flow.ResourceAllocationNotification}Replaced with a boolean value representing whether ornot resource allocation notification is enabled. 0represents ENABLE_NOTIFICATION.

Wireless{Flow.SponsorIdentity}Replaced with a string representing the Sponsor-IdentityAVP, used for sponsored data connectivity purposes asan identifier of the sponsor.

Wireless{Flow.SuccessfulResourcesAllocationReported} Replaced with a boolean value representing whether or

not the MPE device reportedSUCCESSFUL_RESOURCES_ALLOCATION for thisflow.

PCC/ADC Flow Variables

In addition to the basic policy rule variables, you can use the following variables to get flow informationfrom Policy Charging and Control (PCC)- and Application Detection and Control (ADC)-specific fieldsin the Diameter Gx Charging-Rule-Definition AVP.

DescriptionVariable NameWireless{Flow.ApplicationIdentifier}Replaced with a string representing the application ID.

Wireless{Flow.ARP.PreemptionCapability}Replaced with an integer representing whether this servicedata flow or bearer can get resources that were alreadyassigned to another service data flow with a lower prioritylevel:


Lists of Variables

DescriptionVariable Name• 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 dataflow or bearer is not allowed to get resources

Wireless{Flow.ARP.PreemptionVulnerability}Replaced with an integer representing whether the resourcesassigned to this service data flow or bearer can be assignedto another service data flow with a higher priority level:

• 0 (PRE-EMPTION_VULNERABILITY_ENABLED, thedefault, applied if this AVP is not supplied) — theresources can be preempted and allocated to a service dataflow or bearer with a higher priority

• 1 (PRE-EMPTION_VULNERABILITY_DISABLED) — theresources cannot be preempted and allocated to a servicedata flow or bearer with a higher priority

Wireless{Flow.ARP.PriorityLevel}Replaced with an integer representing the priority of aresource request, from 1 (highest) to 15 (lowest).

Wireless{Flow.MeteringMethod}Replaced with an integer representing how usage is meteredfor offline charging; -1 means that the PCEF uses a provisioneddefault value.

Wireless{Flow.MonitoringKey}Replaced with an integer representing the unique identifierthat associates this rule with a Monitoring-Key used in Gxquota.

Wireless{Flow.MuteNotification}Replaced with an integer representing the value of theMute-Notification AVP, which mutes the notification to theMPE device of the detected application's start or stop for thespecific ADC rule(s). By default, start or stop notifications aresent for the detected application. 0 (MUTE_REQUIRED)indicates that the PCEF does not inform the MPE device whenthe application's start or stop for the specific ADC rule or rulesis detected.

Wireless{Flow.Offline}Replaced with an integer representing whether offlinecharging 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


Lists of Variables

DescriptionVariable NameWireless{Flow.Online}Replaced with an integer representing whether onlinecharging 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

Wireless{Flow.PCEFInfo}Replaced with an integer representing information that thePCEF applies to traffic, such as VLAN tagging and the nexthop gateway.

Wireless{Flow.Precedence}Replaced with an integer representing the PCC ruleprecedence.

Wireless{Flow.RatingGroup}Replaced with the charging key for the PCC rule associatedwith this request.

Wireless{Flow.RedirectAddressType}Replaced with a string representing the redirect server addresstype:

• -1 — UNKNOWN• 0 — IPV4_ADDRESS• 1 — IPV6_ADDRESS• 2 — URL• 3 — SIP_URI

Wireless{Flow.RedirectServerAddress}Replaced with a string representing the server address.

Wireless{Flow.RedirectSupport}Replaced with an integer representing whether redirect isenabled:

• -1 — UNKNOWN• 0 — DISABLED• 1 — ENABLED

Wireless{Flow.ReportingLevel}Replaced with a value representing the requested level ofusage reporting for the PCC rule associated with this request:

• 0 (SERVICE_IDENTIFIER_LEVEL) — Usage is reportedon the service ID and rating group combination level, andis applicable when the Service-Identifier and Rating-Group


Lists of Variables

DescriptionVariable NameAVPs have been provisioned within theCharging-Rule-Definition AVP

• 1 (RATING_GROUP_LEVEL) — Usage is reported on therating group level, and is applicable when theRating-Group AVP has been provisioned within theCharging-Rule-Definition AVP

• 2 (SPONSORED_CONNECTIVITY_LEVEL) — Applicablefor offline charging, usage is reported on the sponsoredidentity and rating group combination level, and isapplicable when the Sponsor-Identity,Application-Service-Provider-Identity, and Rating-GroupAVPs have been provisioned within theCharging-Rule-Definition AVP

Wireless{Flow.ReportingReasonMask}Replaced with an integer value representing the DiameterResult-Code provided in the Multiple-Services-Credit-ControlAVP. Only applicable for Granted units.

Wireless{Flow.RequiredAccessInfoMask}Replaced with an integer value representing therequiredAccessInfo.

Wireless{Flow.ServiceIdentifier}Replaced with an integer representing the service associatedwith this request.

Wireless{Flow.tdfApplicationIdentifier}Replaced with a string representing the TDF application ID.

Wireless{Flow.tdfRedirectAddressType}Replaced with a string representing the redirect TDF serveraddress type:

• -1 — UNKNOWN• 0 — IPV4_ADDRESS• 1 — IPV6_ADDRESS• 2 — URL• 3 — SIP_URI

Wireless{Flow.tdfRedirectServerAddress}Replaced with a string representing the TDF server redirectaddress.

Wireless{Flow.tdfRedirectSupport}Replaced with an integer representing whether TDF redirectis enabled:

• -1 — UNKNOWN• 0 — DISABLED• 1 — ENABLED


Lists of Variables

DescriptionVariable NameWireless{Flow.UsageReporting}Replaced with an integer representing whether usagereporting from the PCEF to the MPE device is enabled ordisabled.

ADC Flow Variables

In addition to the basic policy rule variables, you can use the following variables to get flow informationfrom Application Detection and Control (ADC) rules in the Diameter Sd interface.

DescriptionVariable NameWireless{AppDetectionFlow.FlowDirection}Replaced with an integer representing the flow direction:

• 0 (UNSPECIFIED) — This is unspecified• 1 (DOWNLINK) — IP flow(s) are sent to the user equipment• 2 (UPLINK) — IP flow(s) are sent from the user equipment• 3 (BIDIRECTIONAL) — All IP flow(s) to or from the user

equipment

Wireless{AppDetectionFlow.InstanceIDRuleName} Replaced by a string representing the list of dynamic PCC rules

installed for this TDF application instance.

Wireless{AppDetectionFlow.RuleName}Replaced by a string representing the list of dynamic PCC rulesinstalled for this flow.

Wireless{AppDetectionFlow.TDFAppId}Replaced with a string, which can be used to identify the servicebeing used on the flow (for example, voice or gaming).

Wireless{AppDetectionFlow.TDFAppInstanceId} Replaced with a string representing the TDF application instance

ID

Policy Rule Variables for Rx Requests

In addition to the basic policy rule variables, you can use the following request variables defined forthe Diameter Rx protocol to get charging-related information.

DescriptionVariable NameWireless{Request.ChargingCharacteristics}Replaced with a six-octet string containing (in octets 3–6) theapplication-based charging characteristics for the IP-CANbearer. Corresponds to the field3GPP-Charging-Characteristics of the 3GPP vendor-specific


Lists of Variables

DescriptionVariable Nameattribute defined in 3GPP TS 29.061. The AVP has the M bitcleared.

Wireless{Request.CreditManagementStatusMask} Replaced with an unsigned 32-bit mask representing the credit

management status for application-based charging.Corresponds to the field Credit-Management-Status definedin 3GPP TS 29.212. Bit 0 is the least significant bit. When set,the bit values indicate:

• 0 — END_USER_SERVICE_DENIED (0x1): The chargingsystem denied the service request (for example, toterminate a rating group) due to service restrictions orlimitations related to the end user (for example, theend-user's account could not cover the requested service).

• 1 — CREDIT_CONTROL_NOT_APPLICABLE (0x2): Thecharging system determined that the service can begranted to the end user but no further credit control isneeded for the service (for example, the service is free ofcharge or is treated for offline charging).

• 2 — AUTHORIZATION_REJECTED (0x4): The chargingsystem denied the service request in order to terminatethe service for which credit is requested.

• 3 — USER_UNKNOWN (0x8): The specified end usercould not be found in the charging system.

• 4 — RATING_FAILED (0x16): The charging system cannotrate the service request due to insufficient rating input,incorrect AVP combination, or an AVP value that is notrecognized or supported in rating.

• 5 — NO_GYN_SESSION_SERVICE_ALLOWED (0x20):The Gyn session was terminated (for example, because ofnetwork failure), but the OCS allowed the service tocontinue. Applicable only over Sd reference point.

• 6 — NO_GYN_SESSION_SERVICE_NOT_ALLOWED(0x40): The Gyn session was terminated (for example,because of network failure) and the OCS did not allow theservice to continue. Applicable only over Sd referencepoint.

Wireless{Request.DynamicAddressFlag}Replaced with an integer indicating whether the PDPcontext/PDN address is statically (0) or dynamically (1)allocated. Corresponds to the field Dynamic-Address-Flagdefined in 3GPP TS 32.299. If the AVP is not present, theaddress is statically allocated.

Wireless{Request.DynamicAddressFlagExtension} Replaced with a boolean value indicating whether the IPv4

PDN address is statically (0) or dynamically (1) allocated forthat particular IP-CAN bearer (PDN connection) of PDN typeIPv4v6. Corresponds to the field


Lists of Variables

DescriptionVariable NameDynamic-Address-Flag-Extension defined in 3GPP TS 32.299.If the address is in IPv6 format and dynamically allocated, itis indicated in Dynamic Address Flag. This field is missingif the IPv4 address is static.

Wireless{Request.GgsnAddress3GPP}Replaced with a six-octet value containing the GGSN addressin IPv4 format. Corresponds to the field 3GPP-GGSN-Addressdefined in 3GPP TS 29.061. The AVP has the M bit cleared.

Wireless{Request.GgsnIPv6Address3GPP}Replaced with an 18-octet value containing the GGSN addressin IPv6 format. Corresponds to the field3GPP-GGSN-IPv6-Address defined in 3GPP TS 29.061. TheAVP has the M bit cleared.

Wireless{Request.PdnConnectionChargingID}Replaced with an unsigned 32-bit value containing thecharging identifier to identify different records belonging tosame PDN connection. Includes the Charging ID of the firstIP-CAN bearer activated within the PDN connection (the EPSdefault bearer for GTP-based connectivity or the uniqueCharging ID for PMIP-based connectivity). Corresponds tothe field PDN-Connection-Charging-ID defined in 3GPP TS32.299. The AVP has the M bit cleared.

Wireless{Request.SelectionMode3GPP}Replaced with an integer representing whether this servicedata flow or bearer can get resources that were alreadyassigned to another service data flow with a lower prioritylevel:

• 0 — MS or network provided APN, subscription verified• 1 — MS provided APN, subscription not verified• 2 — Network provided APN, subscription not verified• 3 — Reserved for future use, not sent; if received

interpreted as 2

Corresponds to the field 3GPP-Selection-Mode defined in3GPP TS 29.061. The AVP has the M bit cleared.

Wireless{Request.UserCSGInformation.CSGAccessMode} Replaced with an integer representing information on how

the user is accessing a closed subscriber group cell:

• 0 — Closed mode• 1 — Hybrid mode

Corresponds to the AVP CSG-Access-Mode of the fieldUser-CSG-Information defined in 3GPP TS 32.299.

Wireless{Request.UserCSGInformation.CSGId}


Lists of Variables

DescriptionVariable NameReplaced with a value representing the user's closedsubscriber group identifier. Corresponds to the AVP CSG-Idof the field User-CSG-Information defined in 3GPP TS 32.299.

Wireless{Request.UserCSGInformation.CSGMembershipIndication} Replaced with an integer representing whether or not the

user is a member of a closed subscriber group cell in hybridmode:

• 0 — Not CSG member• 1 — CSG member

Corresponds to the AVP CSG-Membership-Indication of thefield User-CSG-Information defined in 3GPP TS 32.299.

Policy Rule Variables for Sy Requests

In addition to the basic policy rule variables, you can use the following request variables defined forthe Diameter Sy protocol to get policy counter-related information. This information is provided inan AVP by an offline charging server to an MPE device in an SLA message.

DescriptionVariable NameWireless{Sy.PolicyCounterId.identifier.

Current.CounterStatus} Replaced with a string representing the current statusof the policy counter identifier. Provided in an AVPPolicy-Counter-Status.

Wireless{Sy.PolicyCounterId.identifier.Pending.CounterStatus} Replaced with a string representing the pending

status of the policy counter identifier. Provided in anAVP Pending-Policy-Counter-Information. If multiplePending-Policy-Counter-Information AVPs arereceived, only the first one is applied.

Wireless{Sy.PolicyCounterId.identifier.Pending.pendingPolicyCounterChangeTime} Replaced with a long value representing the time

when the pending status of the policy counteridentifier in the AVP Pending-Policy-Counter-Information became the current status.Provided in an AVP Policy-Counter-Status. If multiplePending-Policy-Counter-Information AVPs arereceived, only the first one is applied.


Lists of Variables

Policy Rule Variables for Quotas, Quota Conventions, and Quota Objects

In addition to the basic policy rule variables, you can use the following variables to get quota-relatedinformation.

The format of a policy rule variable when used with a quota or quota convention is:

{object[.scope].attribute[.subAttribute[.divisor]]}

where:

An object described in Quota Object Variables.object

Used to narrow or expand the object. Possible values are:scope(optional) • lookupname — The next value is the name of the pass or plan to look up.

• lookupgroup — The next value is the group of the pass (groups are not definedfor plans).

• best — Selects only the current pass or top-up (if available).• next — Selects only the next pass or top-up after the best.

Possible values are:attribute(required) • name — Returns the current plan or pass name.

• group — Returns the current pass group (groups are not defined for plans).• expirationtime — Returns any defined expiration time for the best pass unless a

scope value of next has been used.• purchasetime — Returns any defined purchase time for the best pass (unless a

scope value of next has been used).• activationtime — Returns any defined activation time for the best pass (unless a

scope value of next has been used).• count — Returns the number of passes or top-ups in the current selection scope.• time — Returns the sum of the time attribute for the current passes or top-ups

scope. This value can have a sub-attribute.• volume — Returns the sum of the volume attribute for the current passes or

top-ups scope. This value can have a sub-attribute.• upvolume — Returns the sum of the input-volume (uplink-volume) attribute for

the current passes or top-ups scope. This value can have a sub-attribute.• downvolume — Returns the sum of the output-volume (downlink-volume)

attribute for the current passes or top-ups scope. This value can have asub-attribute.

• servicespecific — Returns the sum of the service specific attribute for the currentpasses or top-ups scope. This value can have a sub-attribute.

Allows limits/used/available to be specified for a counter. If a sub-attribute is defined,a divisor may also be defined. Possible values are:

subAttribute(required)

• limits — Returns the sum of all unit limits for all passes or top-ups in the currentscop.

• used — Returns the units used for the ACTIVE pass or top-up.


Lists of Variables

• available — Returns the sum of all units available for all passes or top-ups in thecurrent scope.

A number that tells the system to divide a result by a specified number. Allows valuesto be specified in higher-division units (days instead of seconds and megabytes insteadof bytes).

divisor

Quota Object Variables defines quota objects that can be used when creating policies that involve quotasand quota conventions.

Quota and Quota Convention Variables defines policy rule variables that can be used with quotas andquota conventions (passes, rollovers, and topups).

Quota Object Variables

DescriptionQuota ObjectThe number of seconds with which a pass, plan or top-up started.timelimit

The number of bytes of total volume with which a pass, plan or top-upstarted.

totalVolumeLimit

The number of bytes of input volume with which a pass, plan or top-upstarted.

inputVolumeLimit

The number of bytes of output volume with which a pass, plan ortop-up started.

outputVolumeLimit

The number of service-specific events with which a pass, plan or top-upstarted.

serviceSpecificLimit

The number of seconds currently consumed.timeConsumed

The number of bytes of total volume currently consumed.totalVolumeConsumed

The number of bytes of input volume currently consumed.inputVolumeConsumed

The number of bytes of output volume currently consumed.outputVolumeConsumed

The number of service specific units currently consumed.serviceSpecificConsumed

The date-time when the object became active. For plans, the value isnull. For roll-overs, the value is the time of the rollover calculation.

activationTime

The date-time when the MPE device will expire the object.expirationTime

The date-time when the object was purchased. For plans and roll-overs,the value is null.

purchaseTime

The next time the plan has a billing cycle reset. For passes, top-upsand rollovers, the value is null.

resetTime

The name of the pass or plan. For rollovers and top-ups, the name ofthe associated plan.

name

Passes support custom or unknown fields delivered by the SPR. Thisallows those fields to be accessed and used.

field[name]

For passes, all the passes that share the same name as the instance. Fortop-ups, all the top-ups associated with the plan with which that thetop-up is associated.

parent


Lists of Variables

DescriptionQuota ObjectThe pass or top-up that will be used after the current pass or top-upis exhausted or expired.

next

The best pass/top-up. See the CMP Wireless User's Guide for moreinformation.

best

The number of passes or top-ups in the defined collection that are inthe Active or Current state.

count

Returns a collection of passes/top-ups for the name of that pass orplan.

lookupName

Returns a collection of passes/top-ups for the group of that pass orplan.

lookupGroup

Quota and Quota Convention Variables

DescriptionVariable NameAll passes associated with a user.{allpasses}

The current set of passes selected by policy. The default is allpasses.

{currentPass}

The current set of top-ups for a user.{currentTopup}

All passes associated with a user.{passes}

All top-ups associated with a user.{topups}

Policy Rule Variables for User Quotas

In addition to the basic policy rule variables, you can use the following user quota variables definedfor the Diameter Gx protocol to get the current subscriber's quota usage for a specified quota profileand type.

The format of a policy rule variable when used with a user quota is as follows:

{User.Quota.profilename.type.[aggregate]}

where:

The name of a quota profile as defined in the CMP database.profilename

Specifies the quota type. Possible values are:type

• Time — Replaced with the total time in seconds consumed by the subscriberfrom the quota profile.

• Volume — Replaced with the total volume in bytes consumed by the subscriberfrom the quota profile.

• UpVolume — Replaced with the total upstream volume in bytes consumed bythe subscriber from the quota profile.

• DownVolume — Replaced with the total downstream volume in bytes consumedby the subscriber from the quota profile.


Lists of Variables

• ServiceSpecific — Replaced with the total number of service-specific events forthe subscriber from the quota profile.

Possible values are:aggregate(optional) • aggregate — If the quota is a quota plan with a quota convention, returns the

aggregate usage.• noaggregate (the default) — Returns the usage for the specified quota (without

aggregation).

For example, the variable {User.Quota.MonthlyQuota.Volume.aggregate} returns thesubscriber's aggregate volume usage, in bytes, from the quota plan named MonthlyQuota.

Policy Rule Variables for RADIUS

In addition to the basic policy rule variables, you can use the following variables defined for theRADIUS protocol to get TLVs or VSAs as strings.

The syntax of a TLV variable is as follows:

{RADIUS.REQUEST.TLV.tlv_name_or_id[.subfield]}

The syntax of a VSA variable is as follows:

{RADIUS.REQUEST.vsa.vendor_name_or_id.vendor_attribute_name_or_id[.subfield]}

where:

A TLV name (as defined in the RADIUS dictionary) or the unique TLVidentifier from the RADIUS standards.

tlv_name_or_id

A vendor’s name (as defined in the RADIUS dictionary) or the uniquevendor identifier (an integer).

vendor_name_or_id

A VSA name (as defined in the RADIUS dictionary) or the unique VSAidentifier defined by the vendor.

vendor_attribute_name_or_id

Either the nth field (in order) of the data, or a field name (if thecompound structure consists of name-value pairs).

subfield

The RADIUS standard does not define a way to support data structures in VSAs, but several vendorshave overloaded string definitions to implement CSVs or name-value pairs. (This is sometimes referredto as compound types.) You can use the subfield identifier to parse values out of compound types.

For example, consider the following compound structure from Vendor ID 9, attribute 33:

agordon;Pssw3RD!?;GoldPlan

The variable {RADIUS.REQUEST.vsa.9.33.2} returns the string Pssw3RD!? because Pssw3RD!?is the second field in the compound structure.

If the compound structure is defined as follows:

user=agordon,passwd=Pssw3RD!?,access=GoldPlan


Lists of Variables

The variable {RADIUS.REQUEST.vsa.9.33.user} returns the string agordon because agordonis associated with the field name.

See RADIUS Policy Rule TLV Variables for a list of the RADIUS policy rule variables that are availablewhen correlating a RADIUS session with a Gx Plus or Gx-Lite session.

RADIUS Policy Rule TLV Variables

DescriptionVariable NameThe name of the user account. A string value in UTF-8format.

{RADIUS.REQUEST.TLV.User-Name}

The port type used by the GGSN. An integer value greaterthan 0.

{RADIUS.REQUEST.TLV.NAS-Port-Type}

The unique identifier of the NAS that originated the request.A byte value.

{RADIUS.REQUEST.TLV.NAS-Identifier}

The IP address of the GGSN that is communicating withthe MPE device. A valid address in IPv4 format.

{RADIUS.REQUEST.TLV.NAS-IP-Address}

Mandatory field. The IP address of the user account. Avalid address in IPv4 format.

{RADIUS.REQUEST.TLV.Framed-IP-Address}

Mandatory field. The unique Accounting ID to make it easyto match start and stop record in a log file. The start and

{RADIUS.REQUEST.TLV.Acct-Session-Id}

stop records for a given session must have the sameAcct-Session-Id. An Accounting-Request packet must havean Acct-Session-Id. A string value in UTF-8 format.

The identifier for the target network (the APN). A bytevalue.

{RADIUS.REQUEST.TLV.Called-Station-Id}

The identifier for the MS (the MSISDN). A byte value.{RADIUS.REQUEST.TLV.Calling-Station-Id}

The IMSI for this user. A 15-byte value.{RADIUS.REQUEST.TLV.3GPP-IMSI}

The International Mobile Equipment ID (IMEI) and softwareversion.

{RADIUS.REQUEST.TLV.3GPP-IMEISV}

The Mobile Country Code (MCC) and Mobile NetworkCode (MNC) parsed from the user IMSI. A two- andthree-byte value.

{RADIUS.REQUEST.TLV.3GPP-IMSI-MCC-MNC}

The SGSN IP address. A valid address in IPv4 format.{RADIUS.REQUEST.TLV.3GPP-SGSN-Address}

The MCC and MNC parsed from the location informationof the SGSN. A two- and three-byte value.

{RADIUS.REQUEST.TLV.3GPP-SGSN-MCC-MNC}

The GGSN IP address. A valid address in IPv4 format.{RADIUS.REQUEST.TLV.3GPP-GGSN-Address}

The MCC and MNC parsed from the location informationof the GGSN. A two- and three-byte value.

{RADIUS.REQUEST.TLV.3GPP-GGSN-MCC-MNC}

The associated charging gateway (CG) IP address. A validaddress in IPv4 format.

{RADIUS.REQUEST.TLV.3GPP-CG-Address}


Lists of Variables

DescriptionVariable NameThe location information of the user equipment. A bytevalue.

{RADIUS.REQUEST.TLV.3GPP-User-Location-Info}

The QoS profile negotiated by the GGSN. A string value inUTF-8 format.

{RADIUS.REQUEST.TLV.3GPP-GPRS-Negotiated-QOS-Profile}

For a GGSN, the charging characteristics for this PDPcontext received in the Create PDP Context Request

{RADIUS.REQUEST.TLV.3GPP-Charging-Characteristics}

Message (in R99 and later releases). A two-character valuein UTF-8 format.

For a GGSN, the charging ID for this PDP context. This,together with the GGSN IP address, constitutes a uniqueidentifier for the PDP context. An unsigned integer value.

{RADIUS.REQUEST.TLV.3GPP-Charging-Id}

For a GGSN, the type of PDP context (IP or PPP). Anunsigned integer value.

{RADIUS.REQUEST.TLV.3GPP-PDP-Type}

Indicates with Radio Access Technology (RAT) type iscurrently serving the user equipment (UE). A byte value.

{RADIUS.REQUEST.TLV.3GPP-RAT-Type}

For a GGSN, the particular PDP context for the associatedPDN and MSISDN/IMSI from creation to deletion. Acharacter value in UTF-8 format.

{RADIUS.REQUEST.TLV.3GPP-NSAPI}

For a GGSN, the selection mode for this PDP contextreceived in the Create PDP Context Request message. Acharacter value in UTF-8 format.

{RADIUS.REQUEST.TLV.3GPP-Selection-Mode}

The offset between universal time and local time, in15-minute increments, of where the MS/UE currentlyresides.

{RADIUS.REQUEST.TLV.3GPP-MS-Timezone}


Lists of Variables

Documents

Oracle Communications Policy Management Policy Variables ... · PDF filePolicy Management Policy Variables Reference ... Oracle Communications Policy Management Policy Variables Reference,