Default Priority

Default priority to be assigned to an incoming message if no specific priority is defined in the Message Handling Rules table.

Default value is 0.

Message Sla Ms

Service Level Agreement (SLA) in milliseconds, defines the number of milliseconds that are associated with an incoming event or message within which Policy Director (load balancer) has to submit it to Policy Server (QNS) for processing. In case the configured duration times out, the Default Discard Behavior is applied.

Maximum time (in millisec) that a message has in an inbound message handling queue waiting for a worker thread. Configuring this value avoids processing a message to time out by a remote peer.

An SLA time that is too large can result in wasted processing on messages already timed out on a remote peer (i.e. PGW) and creation of stale sessions.

An SLA time that is too small can result in dropping the messages that could have been successfully processed.

Default value is 1500 ms.

If you have not selected Inbound Message Overload Handling check box under Diameter Configuration, you can define inboundMessageSlaMs and inboundMessageQueueSize in /etc/broadhop/qns.conf file. If inboundMessageSlaMs is not defined in qns.conf file, then default value of 9000 is used.

Example: -DinboundMessageSlaMs=2000

After modifying the configuration on Cluster Manager execute reinit.sh or copytoall.sh scripts for applying the changes on all VMs as described in the CPS Installation Guide for VMware for this release.

If you select Inbound Message Overload Handling check box under Diameter Configuration, then the value you configured in Policy Builder is used.

The "Message Sla Ms" time out configuration value should be less than the timeout value in PGW or PCSF.

Inbound Message Queue Size

Number of messages waiting to be processed before the inbound overload feature is activated.

Default value is 1000.

If Inbound Message Overload Handling check box is not selected under Diameter Configuration, define inboundMessageSlaMs and inboundMessageQueueSize in /etc/broadhop/qns.conf file. If inboundMessageQueueSize is not defined in qns.conf file, then default value of 1000 is used.

Example: -DinboundMessageQueueSize=5000

After modifying the configuration on Cluster Manager execute reinit.sh or copytoall.sh scripts for applying the changes on all VMs as described in the CPS Installation Guide for VMware for this release.

If InboundMessage Overload Handling check box is selected under Diameter Configuration, then the value you configured in Policy Builder is used.

Default Instance Rate Limit

Use this parameter to trigger the overload protection handling. If this is configured to value x TPS, then whenever x exceeds CPS applies message handling rules to additional requests. 0 (default) TPS indicates no limit.

Default value is 0.

Gx Emergency Message Priority

Default priority assigned to messages related to an emergency session.

This parameter categorizes Gx messages as emergency priority based on APN. Emergency priority messages are queued ahead of non-emergency service messages for quick servicing and prevent them from being dropped using overload controls.

If the queue is full, the lowest-priority message is dropped.

Recommended Value: Regex match of SOS APNs for emergency priority classification. Set emergency priority to highest for priority handling in Policy Server (QNS) Inbound Message Queue.

Default value is 1.

Default Discard Behavior

Default behavior to be applied to an incoming message if no specific priority is defined in the Message Handling Rules table.

• MESSAGE_DROP: Discards the request.

• DIAMETER_TOO_BUSY: Sends a response message having Result-Code AVP value set to DIAMETER_TOO_BUSY (3004)

Default value is MESSAGE_DROP.

Apply Discard Behavior For Emergency Messages

Indicates if Emergency Messages can be discarded under overload conditions.

Default value is not checked.

Rx Message Prioritization

Defines Rx eMPS message handling priority under overload condition based on Rx AAR MPS-Identifier and Reservation-Priority AVPs.

When Rx Message Prioritization is enabled and if MPS-Identifier and Reservation-Priority AVPs are available in Rx_AAR, then the messages are not dropped even in overload condition. Depending on the message Priority defined in table, the message can be moved to the front in the inbound queue.

This feature indicates that, the Rx_AAR is prioritized based on MPS-Identifier and Reservation-Priority AVPs configured only. If the inbound message doesn’t have these parameters included, the message is not prioritized. Prioritization of messages is only applicable to incoming request messages.

For more information on parameters, see Table 2.

Message Handling Rules

Defines specific inbound message overload handling rules based on different criteria. For more information, see Table 3.

MPS Identifier

MPS-Identifier indicates that an AF session relates to an MPS session. It contains the national variant for MPS service name.

MPS-Identifier value = <NS (National Security) Specific To Deployment>

Reservation Priority

The AF specifies the Reservation-Priority AVP at request level in the AA-Request in order to assign a priority to the AF session as well as specify the Reservation-Priority AVP at the media-component-description AVP level to assign a priority to the IP flow.

The Reservation-Priority AVP available at the request level only is used under Rx Message Prioritization table.

Range: Any number

Example: 10

Priority

A user defined priority based on MPS-Identifier and Reservation-Priority combination. Make sure that the Message priority defined in Rx Message Prioritization table and should be unique per row.

Higher Priority messages are processed first compared to lower priority messages.

Range: Any number (User priority)

Example: 10

INPUT

Diameter Client

(Optional) This field is used to configure different priorities for different clients based on realms. For more information, see Diameter Clients.

Protocol

Specific application id value to be used for scoring. This value is used to match Auth-Application-Id AVP value. For more information, see Table 4.

Command Code

Specific command code value to be used for scoring. This value is used to match the Command-Code field. These command codes map to different types of Diameter messages (CCR = 272 RAR = 258 etc).

Default value is 0.

Request Type

Specific request type value to be used for scoring. This value should match the value of the CC-Request-Type AVP for Gx CCR messages.

• 0: Request Type not used for scoring

• 1: INITIAL_REQUEST (1)

• 2: UPDATE_REQUEST (2)

• 3: TERMINATION_REQUEST (3)

Default value is 0.

Request type should match the value of the Rx-Request-Type AVP for Rx AAR messages.

• 0 INITIAL_REQUEST (0)

• 1 UPDATE_REQUEST (1)

Request type should match the value of SL-Request-Type AVP for Sy SLR messages. The possible values are:

• INITIAL_REQUEST (0)

• INTERMEDIATE_REQUEST (1)

It has to be configured to zero if the incoming message does not have a request type AVP. For example, Rx STR does not have a request type AVP or Rx-Request-Type AVP is unavailable in Rx AAR as it is not a mandatory AVP per 3GPP TS 29.214.

OUTPUT

Priority

Priority value assigned to the message. Higher numerical value has the higher priority.

Default value is 0.

For example, 10, 20, 100, 200, 300, 500 and so on.

Per Instance Tps

Transactions per second limit per process. This value is the TPS that these messages are limited to. Note that this is per CPS process so if there are 20 Policy Server VM's with 1 Policy Server java process the total TPS is this number x 20.

The actual system's transaction per second limit can be calculated using the following formula:

Per Instance Tps x Number of instances per VM x Number of VMs.

Default value is 0.

For example, 1000, 2000, 5000 and so on.

Discard Behavior

Behavior to be applied to an incoming message.

• MESSAGE_DROP: Discards the request.

• DIAMETER_TOO_BUSY: Sends a response message having Result-Code AVP value configured to DIAMETER_TOO_BUSY (3004).

Default value is MESSAGE_DROP.

GY_V8

Standard Gy application as per 3GPP TS 32.299

GX_SCE

Custom Gx implementation

RF_V10

Not supported

RF_VERIZON

Not supported

RX_TGPP

Standard Rx application as per 3GPP TS 29.214

SH_TGPP

Standard Sh application as per 3GPP TS 29.329

SY_V11

Standard Sy application as per 3GPP TS 29.219

SD_V11

Standard Sd application as per 3GPP TS 29.212

GX_TGPP (default)

Standard Gx application as per 3GPP TS 29.212

GXX_TGPP

Not supported

RX_CLIENT

Local MINE adapter

GY_V8_PROXY

Gy proxy implementation as per RFC 3588

GX_TGPP_PROXY

Gx proxy implementation as per RFC 3588

SY_TGPP_PROXY

Sy proxy implementation as per RFC 3588

SY_OCS

Sy Proxy from OAM (PCRF) end

GY_RECHARGE_WALLET

Support Gy client functionality with external OCS (ECUR model only)

SY_PRIME

Custom Sy implementation as per RFC 3588

RX_TGPP_PROXY

Rx proxy implementation as per RFC 3588

SY_OCS_SERVER

OCS Sy server endpoint conforming to 3GPP TS 29.219

End to End Sla Ms

Maximum time in milliseconds the CPS system must take for request processing. The request processing time for this value must be LB > QNS > DB > QNS > LB round trip.

Default: 2000 ms

Include Request LB queue time in QNS SLA

When checked, LB - QNS request queue time is considered in QNS SLA when enabled.

Default value is disabled.

Next Hop Realm

DRA realm name as received in Origin-Realm AVP in CER or CEA message.

Next Hop Hosts

DRA hosts name list as received in Origin-Host AVP in CER or CEA message.

Application Id

Diameter application id advertised as being supported by the DRA. It contains information that identifies the particular service that the service session belongs to.

Destination Realms Pattern

Actual destination realm name pattern as received in Origin-Realm AVP in AAR message. The pattern needs to follow the standard Java regular expression syntax described here.

Destination Host Pattern

Actual destination host name pattern as received in Origin-Host AVP in AAR message. The pattern needs to follow standard Java pattern conventions. The pattern needs to follow the standard Java regular expression syntax described here.

Application Id

The Diameter Application ID (Auth-Application-Id) on the message which is to be retired.

Default: 0

Command Code

The Diameter command code of the message which is to be retried.

Default: 0

Result Code

This is the result code received in the diameter response for which the user wants to retry. The values configured should be a valid diameter result code value or an experimental result code value. For example, 3002 (DIAMETER_UNABLE_TO_DELIVER) received in RAA.

Permanent failure result codes 5xxx and successful result codes 2xxx should not be configured (where, x denotes a valid number).

However, if configured, CPS retries for it.

Default: 0

Is Experimental

If this check-box is selected, it means that the value configured in the Result Code column is an Experimental-Result-Code value.

This is necessary because there are few values which are the same for both experimental-result-code and result-code.

Default: Not selected

Action

The action for the CPS platform to take after the Diameter Response is received. The options are Retry or None.

• Retry - CPS retries the request message identified by the value in the command code column depending on the retry count configured in Retry Count column.

• None - No retry.

Default: None

Action Timer (Ms)

Default: 0

Retry Count

The number of times to retry when the action is “Retry”.

Default: 1

Retry on Alternate Node

Configures CPS to retry on any alternate peer configured in Policy Builder.

Default: Not selected

Backoff Algorithm

The back-off algorithm used while determining the actual delay between retry attempts. Currently, only one option (CONSTANT_INTERVAL) is supported.

• LINEAR_INTERVAL: Causes the configured retry interval to increase linearity with each attempt using the formula retry interval = Action Timer (Ms) x current retry attempt number.

  For example, Action=Retry, Action Timer (Ms)=200, Retry Count=3, Backoff Algorithmm=LINEAR_INTERVAL will trigger the first retry after 200 x 1 = 200 ms, the second retry after 200x2 = 400 ms, the third retry after 200x3 = 600ms

• CONSTANT_INTERVAL: Causes the configured retry interval to be used (without any change) for delay for all retry attempts (other options like exponential back-off where retry interval increases exponentially are currently not supported/implemented).

Default: CONSTANT_INTERVAL

Application Id

The diameter interface in numeric format (Auth-Application-Id) on which the message is received. For example Sy (16777302) and Sd (16777303).

Currently only Sd and Sy interfaces are supported.

Default: 0

Command Code

The diameter message type. For example SLR (8388635) in case of Sy and RAR (258) in case of Sd.

Default: 0

Realm

New key added as Sy client realm. If the realm value is not specified, then the realm key is not be considered (CPS only performs action on key applicationid:commadcode:realm:requestType:resultcode ).

Request Type

The request type of the message for Sy interface. For example INITIAL_REQUEST (0) INTERMEDIATE_REQUEST (1). For Sd Request Type is not valid.

Default: 0

Result Code

The result-code received in the response for which the action over Gx and/or Sy/Sd is to be taken.

Default: 0

Is Experimental

If this check-box is selected, it means that the value configured in the Result Code column is an Experimental-Result-Code value.

This is necessary because there are few values which are the same for both experimental-result-code and result-code.

Default: Not selected

Action

The action to be taken over the Sy/Sd interface when the response is received. Possible actions are Continue/Terminate/Reinitiate.

• Continue (default) In case of Continue CPS just continues with the session and does not clear the session from the DB.

• Terminate (for Sd) In case of Terminate CPS removes the session from database after triggering a Session Removal RAR over Sd interface.

  Terminate (for Sy) In case of Terminate CPS removes the session from database after triggering a Session Removal STR over Sy interface.

• Reinitiate (for Sd) In case of Reinitiate CPS first triggers a Session Removal RAR over Sd interface. Once we receive Sd RAR response (any result-code) CPS removes the old session and triggers creation of a new session by sending out a TSR towards TDF.

  Reinitiate (for Sy) In case of Reinitiate CPS first triggers a Session Removal STR over Sy interface. Once we receive Sy STR response (any result-code) CPS removes the old session and triggers creation of a new session by sending out SLR towards OCS.

• Re-Initiate Action Timer (Ms): The amount of time in milliseconds for CPS to wait before performing a retry. It is the wait time between retries.

  Note	This configuration works in accordance with the Next Evaluation Timer. Hence, there will be a minute delay in Message generation. Default: 0

• Re-Initiate Retry Count: The number of times to retry when the action is ?Retry?.

  Note	The retry count does not include the initial attempt made by CPS. Default: 0

• Backoff Algorithm: The backoff algorithm is used for determining the actual delay between retry attempts. Currently, only one option (CONSTANT_INTERVAL) is supported.

• LINEAR_INTERVAL: Causes the configured retry interval to increase linearity with each attempt using the formula

  retry interval = Action Timer (Ms) x current retry attempt number

  For example, Action=Retry, Action Timer (Ms)=200, Retry Count=3, Backoff Algorithm=LINEAR_INTERVAL will trigger the first retry after 200 x 1 = 200 ms, the second retry after 200x2 = 400 ms, the third retry after 200x3 = 600ms.

• CONSTANT_INTERVAL: Causes the configured retry interval to be used (without any change) for delay for all retry attempts.

  Note	Other options such as exponential back-off where retry interval increases exponentially are currently not supported.

  Default: CONSTANT_INTERVAL

Action Over Gx

The action to be taken over the Gx interface when the response is received. Possible actions are None/Terminate/Reauthorize.

Currently Action over Gx is not supported for Sd RAR.

• None (default): No action would be taken on Gx interface.

• Terminate: In case of Terminate CPS would terminate the Gx session by sending a RAR with Session Release Cause. Also CPS would be sending STR which would then clear the corresponding Sy device session. If the action over Gx is TERMINATE the action over Sy does not matter as the Sy session would be terminated.

• Reauthorize: In case of Reauthorize CPS would mark the Sy session as waiting for action over Gx and would mark corresponding Gx session as needing action over Gx as Re-Auth.

The Gx Network Device Manager would then perform the ReAuthorization by sending RAR over Gx interface. On receiving RAA the action over Sy interface would then be performed. If the Gx session is stale and we receive DIAMTER_UNKNOWN_SESSION_ID the Sy session would then be automatically terminated irrespective of the action configured on Sy interface.

Buffer Timeout In Milliseconds

The time in milliseconds to hold the diameter messages in the buffer after the buffering has been triggered for a particular session ID.

Default value is 15 ms.

Max Buffered Messages Per session

Maximum number of messages that are held in the message buffer for a particular session ID.

Default value is 64.

Disable Early Processing

Disable the early processing of buffered message before the configured buffer-timeout (15 ms).

If the message buffering has started then CPS triggers an early timeout (after 5 ms) and check the buffer status. If the buffer has single message or contains messages without any holes (in correct sequence) then it sends the first message to Policy Server (qns) node for processing.

Default value is unchecked.

Allow Gaps In Buffer

Do not drop the messages from the message buffer when a hole/gap is detected while processing the buffered messages (i.e. after ordering the buffered message it detects that certain messages are missing).

Default value is unchecked.

Message Buffering Table

This table is used to specify the criteria for buffering the messages. CPS buffers only those messages that have a matching entry in this table. For more information on parameters, refer to Table 2.

Application Id

Application ID of the interface whose message are to be buffered. For example, 16777238 for Gx messages.

Command Code

Command code of the diameter message for the above application ID. For example, 272 for CCR messages.

Origin Realm Pattern

Origin-realm from the diameter request message to check for message buffering. It supports pattern matching as per the JAVA regular expression. This is an optional field and if not configured then CPS applies the configuration to any realm for the matching application ID and Command Code.

Origin Host Pattern

Origin-host from the diameter request message to check for message buffering. This is an optional field and if not configured then CPS applies the configuration to any host for the matching application ID and Command Code.

Buffer Start Avp Code

Diameter AVP code for the AVP that would trigger the start for buffering the messages. For example, 1006 is the diameter AVP code for Event-Trigger AVP.

CPS goes through all the rows one by one and verifies whether configured AVP exist in the incoming message and buffers the message accordingly.

Buffer Start Avp Type

A drop-down list to select the data-type of the AVP to trigger buffering of message. This is required for correctly extracting the AVP value.

Buffer Start Avp Value

The possible values for the diameter AVP for starting the buffering of message. List supported to configure multiple values.

Order Avp Code

The diameter AVP code for the AVP whose value can be used for sequencing/ordering the buffered message while sending them to Policy Server (qns) node for processing.

Order Avp Type

A drop-down list to select the type of the Order AVP for extracting its value.

CPS currently supports only numeric values for ordering the buffered messages.

Binding Db

When selected, it enables the feature.

When unselected, the feature is disabled.

• Health Check Time Interval: Time interval in seconds when periodic AAR is sent.

  Note	The Health Check Time Interval and Revalidation Time under RevalidationTime service configuration should not be configured with the same value. For more information on Revalidation Time, refer to RevalidationTime in Service Configuration Objects chapter.

• Session Release T P S: Per Policy Server (QNS) Gx RAR (with session release cause) TPS when binding database is down.

  Default value is 0.

Alarm Config

When selected, it enables the generation of alarms or traps.

When unselected, the alarms are not generated.

• Primary Ip Address: Primary database IP address where the alarm information is stored.

  Whenever PolicyDRA binding database down is detected i.e., when AAA comes with error result code, CPS generates a trap/notification/alarm. The generation time of this alarm is stored in the database configured. After the Alarm Clearance Interval, the trap/notification/alarm is cleared by CPS. In between this duration, CPS does not generate trap/notification/alarm on detection of binding database failure. Only one trap/notification/alarm is generated by CPS.

• Secondary Ip Address: Secondary database IP address where the alarm information is stored.

• Port: Port number of the database.

  Default value is 0.

• Alarm Clearance Interval: Timer interval in seconds after which the alarm is cleared.

• Policy Dra Resultcode: AAA result-codes for which alarms are generated.

• Severity: Severity of the alarm.

  Default value is Critical.

Enable Proxy

When checked, it makes sure P-Bit is set and Destination-Host AVP is not set for the outgoing AAR messages for PAS Health check.

Default value is unchecked.

Diameter Interface

Diameter Interface DM for which the Session ID handling is required.

Input Regex

Provide an inverse regex to derive the new AVP.

Example: Consider the Session ID is pcef01.dstest01.2b4.gx;375030;1285311481;BB2001@MCC2001. To get the Gw_Version BB2001@MCC2001, write an inverse regex ".*;.*;.*;" which returns BB2001@MCC2001 as value.

Output Policy AVP Name

Policy derived AVP name to be stored.

Save to Session

Save the policy derived AVP to session.

Origin Realm

Origin-realm from the diameter request message to parse the session ID.

Origin Host

Origin-host from the diameter request message to parse the session ID.

-Dadmin.primary.host

VM name which hosts the primary member of the PCRF Admin replica-set.

Any sessionmgr VM names.

Default value is localhost.

Example: sessionmgr01

-Dadmin.secondary.host

VM name that hosts a secondary member of the PCRF Admin replica-set. If the primary Admin member fails, the Stale Session Cleaner tries to connect to this secondary member.

Any sessionmgr VM names.

Default value is localhost.

Example: sessionmgr02

-Dadmin.port

Port of the PCRF Admin replica-set.

Possible values can be Integers.

Default value is 27017.

Example: 27721

-Dmemcache.host

The Host on which memcache is running on.

Strings in the following format: <host>:<port>

Default value is localhost.

-Dmemcache.port

The Port number of memcache.

Possible values are Integers.

Default value is 11211.

-Dtps.per.shards

Maximum number of executions per second per shard.

Possible values are Integers.

Default value is 200.

-Dmongo.query.batch.size

Number of records in the results for each query to the Session replica-set.

Possible values are Integers.

Default value is 1000.

-Dfactor.count.audit.log

If the number of deleted sessions reaches a multiple of this parameter’s value, it performs audit log.

For example, if the parameter value is 100, then the deleted count is printed in the logs on 100 deletions, 200 deletions, 300 deletions, and so on.

Possible values are Integers.

Default value is 10000.

-Dsession.count.threshold

Specify the minimum count of session at which the utility triggers stale session cleanup.

Possible values are Integers.

Default value is 15000000.

-Dsession.threshold.timer

The frequency in minutes where utility monitors session threshold breach to start deletion of stale session.

Possible values are Integers.

Default value is 5.

-Dsession.cache.update.timer

The frequency in minutes where utility updates the latest session ID in the local cache. This parameter should be in the multiple of "session.threshold.timer."

Possible values are Integers.

Default value is 30.

-Dnumber.of.shards

Total number of shards for the Session replica-sets.

Possible values are Integers.

Default value is 80.

-Dlogback.configurationFile

The path to the log configuration file.

Any directory path with a logback file for the application.

Default value is /etc/broadhop/logback-stale-session-cleaner.xml.

-Dadmin.primary.host

VM name which hosts the primary member of the PCRF admin replica-set.

Any sessionmgr VM names.

Default value is localhost.

Example: -Dadmin.primary.host=sessionmgr01

Possible Values: Primary Admin database name

-Dadmin.secondary.host

VM name that hosts a secondary member of the PCRF admin replica-set. If connecting to primary admin member fails, the Stale Session Cleaner tries to connect to this secondary member.

Any sessionmgr VM names.

Default value is localhost.

Example: -Dadmin.secondary.host=sessionmgr02

Possible Values: Secondary Admin database name

-Dadmin.port

Port of the PCRF admin replica-set.

Default value is 27017.

Example: -Dadmin.port=27721

Possible Values: Integers (port number)

-Dmemcache.host

The hostnames on which memcache is running on.

Comma separated memcached server hostnames. Utility distributes memcached keys among the specified servers based on consistent hashing.

Default value is pcrclient01,pcrfclient02.

Example: -Dmemcache.host=pcrclient01,pcrfclient02

Possible Values: Strings in the following format: <hostName1>,<hostName2>

-Dmemcache.port

The port number of memcache.

Default value is 11211.

Example: -Dmemcache.port=11211

Possible Values: Integers

-Dtps.per.shards

The number of parallel tasks for scanning and cleaning the sessions.

Default value is 200.

Example: -Dtps.per.shards=200

Possible Values: Integers

-Dmongo.query.batch.size

The number of records to return in each batch of the response from the MongoDB instance.

Default value is 1000.

Example: -Dmongo.query.batch.size=1000

Possible Values: Integers

-Dfactor.count.audit.log

It prints the logs if the number of deleted sessions reaches a multiple of this parameter’s value.

For example, if the parameter value is 100, then the deleted count is printed in the logs on 100 deletions, 200 deletions, 300 deletions, and so on.

Default value is 10000.

Example: -Dfactor.count.audit.log=10000

Possible Values: Integers

-Dsession.count.threshold

Session clean up is kicked in after total active session count is greater than session.count.threshold value.

Default value is 15000000.

Example: -Dsession.count.threshold=15000000

Possible Values: Value must always be greater than total active sessions

-Dsession.threshold.timer

The frequency in minutes where utility monitors session threshold breach to start deletion of stale session.

Default value is 5.

Example: -Dsession.threshold.timer=5

Possible Values: Integers

-Dsession.cache.update.timer

The frequency in minutes where utility updates the latest session ID in the local cache. This parameter should be in the multiple of session.threshold.timer value.

Default value is 30.

Example: -Dsession.cache.update.timer=30

Possible Values: Integers

-Dnumber.of.shards

Total number of shards for the session replica-sets.

Default value is 80.

Example: -Dnumber.of.shards=80

Possible Values: Integers

-Dlogback.

configurationFile

The path to the log configuration file.

Default value is /etc/broadhop/logback-stale-session-cleaner.xml.

Example: -Dlogback.configurationFile=

/etc/broadhop/logback-stale-session-cleaner.xml

Possible Values: Any directory path with a logback file for the application.

-DdbPassword

Configure the database password if MongoDB Authentication is enabled.

Example:

Make sure to restart the Stale session utility after mongo db password change procedure.

For more information on MongoDB Authentication, see:

• MongoDB Authentication section in the CPS Installation Guide for VMware

• MongoDB Authentication Process section in the CPS Installation Guide for OpenStack

User Uri As Fqdn

Sets the Origin-Host AVP value in CER/CEA to the user URI value instead of FQDn value.

Default value is not set.

Stop Timeout Ms

Sets the timeout duration for a stack to wait till all the resources stop. The delay is in milliseconds.

Default value is 10000.

Cea Timeout Ms

Sets the CER or CEA exchange timeout duration in case of no response. The delay is in milliseconds.

Default value is 10000.

Iac Timeout Ms

Sets the timeout duration for a waiting stack before retrying the communication with a peer that has stopped answering DWR messages. The delay is in milliseconds.

Default value is 5000.

Dwa Timeout Ms

Sets the DWR or DWA exchange timeout duration in case of no response. The delay is in milliseconds.

Default value is 10000.

Dpa Timeout Ms

Sets the DPR or DPA exchange timeout duration in case of no response. The delay is in milliseconds.

Default value is 5000.

Rec Timeout Ms

Sets the timeout duration for reconnection procedure. The delay is in milliseconds.

Default value is 10000.

Peers

Defines which peer names are allowed to initiate connections towards PCRF.

Local Host Name

Identifies the local host name of the Policy Director (load balancer) that identifies and allows an incoming connection from the Peer.

Instance Number

Indicates the assigned number of the Policy Server (QNS) process that initiates a connection with the Outbound Peer.

Default value is 0.

Rating

Priority assigned to this peer for delivering a PCRF initiated request. The higher the rating value the higher is the priority assigned to the peer.

Default value is 1.

Port Range

Should be specified only when the underlying transport connection Is SCTP and not required when the same is TCP.

Response Timeout

Cisco recommends not to use this parameter.

Name Pattern

Origin-Host AVP value in CER needs to validate against this pattern in order for the connection to be established. If that does not happen the CER is silently discarded and the TCP connection is reset by PCRF.

Name pattern check does not happen if Accept Undefined Peer option described in Diameter Stack Configuration is checked.

The Name Pattern needs to follow the standard Java regular expression syntax described here.

Realms

Defines which peer realms are allowed to initiate connections towards PCRF.

Peer Type

Not used with inbound realms.

Processing Protocol

Mapping between the realm name and the specific PCRF logic that should be applied for the message. For more information on processing protocol refer to Table 4.

Rating

Priority assigned to this realm for delivering a PCRF initiated request. This is only used with SY_PRIME processing protocol.

Default value is 0.

Stats Alias

Whatever the statistics that gets generated for the respective realm gets the name that is configured in “Stats Alias” appended to those statistics.

This is applicable for com.broadhop.message mbean statistics only.

Name Pattern

Origin-Realm AVP value in CER needs to validate against this pattern in order for the incoming message to be processed. If that does not happen the message is silently discarded and the TCP connection is reset by PCRF.

The Name Pattern needs to follow the standard Java regular expression syntax described here.

Peers

Defines the peers to which CPS can initiate connections.

Local Host Name

Identifies the local host name of the Policy Director (load balancer) that initiates a connection with the said Peer.

Instance Number

Indicates the assigned number of the Policy Server (QNS) process that allows an incoming connection from the Peer.

Default: 0

Rating

Priority assigned to this peer for delivering a PCRF initiated request. The higher the rating value the higher is the priority assigned to the peer.

Default: 1

Port Range

Should be specified only when the underlying transport connection is SCTP and not required when the same is TCP. However in mixed mode where both SCTP and TCP co-exist then it is mandatory to provide port range values for both TCP and SCTP peers in order to avoid any conflicts on using local ports on same host.

Response Timeout

Cisco recommends not to use this parameter.

Name

Peer host name. Peer host name needs to be mapped to a valid IP address or the diameter connection is not initiated. By default the connection is initiated on the standard diameter port (3868). If a different port needs to be used than the peer name shall be defined using the host:port format.

Default value is “default”.

Transport Protocol

Allows you to select either 'TCP' or 'SCTP' for the selected diameter stack instance. Default value is TCP.

Multi Homing Hosts

This is a comma separated IP addresses list that CPS uses to start the client connections towards external diameter peer. If either TCP/SCTP or both TCP and SCTP are configured in the Outbound Peers (Peers) table then client connections to the peers are initiated based on whether the PD instance is started as a ‘SCTP’ or ‘TCP’ stack. Mixed mode of client and stack running on both ‘TCP’ and ‘SCTP’ is not currently supported by diameter.

Realms

Defines the realms to which CPS can initiate connections.

Peer Type

This indicates which diameter server to use when there are multiple target servers for the same protocol. This is only used with SY_PRIME processing protocol.

Processing Protocol

Mapping between the realm name and the specific PCRF logic that should be applied for the message. For more information on processing protocol refer to Table 4.

Rating

Priority assigned to this realm for delivering a PCRF initiated request. This is only used with SY_PRIME processing protocol.

Default value is 0.

Stats Alias

Whatever the statistics that gets generated for the respective realm gets the name that is configured in “Stats Alias” appended to those statistics.

This is applicable for com.broadhop.message mbean statistics only.

Name

Origin-Realm AVP value in CER needs to validate against this pattern in order for the incoming message to be processed. If that doesn't happen the message is silently discarded and the TCP connection is reset by PCRF.

The Name Pattern needs to follow the standard Java regular expression syntax described here.

Name

The client name that is going to be used to reference this particular client in the service configuration object.

Realm Pattern

The pattern that peer realm name should match in order for this diameter client to be used. The pattern needs to follow the standard Java regular expression syntax described here.

The first choice for Realm Pattern value should always be the exact peer realm name whenever possible.

Extract Avps

See Extract Avps

Override Supported Features

Currently, not supported.

Copy Current Diameter Client

This action creates a new diameter client that is an exact copy of the current diameter client. The only difference between the original and the copy is that “-Copy” is appended to the name of the copy.

The Copy action works exactly the same for all types of diameter clients.

Session Binding Attribute

Allows the Rx sessions initiated by this client to bind to the Gx session by other attribute than the IP address as per 3GPP TS 29.214. For more information refer to Table 2.

Flow Description Source Ip Evaluation

• None: When selected, CPS does not take any action on source IP.

• Replace with 'any': When selected, CPS replaces the flow description source IP with ‘any’.

• Replace with UE IP: When selected, CPS replaces flow description source IP with UE framed IP.

STA Hold Time Ms

This parameter is used to define the timer by which the STA is held back. Once the timer expires even if the CCR-U is not received, STA is sent to the AF and the rxSession is removed.

Default value is 4000 milliseconds.

CCR-U Wait Time (in seconds)

CCR-U Timer is the time to wait for CCR-U from PGW when the AF started a request and Specific-Action CUSTOM_DPCC_STATUS_REPORT was armed in AAR.

CCR-U timer is started for every request (default bearer boost/spawning of dedicated bearer) from AF if the CCR-U is configured in Policy Builder and CUSTOM_DPCC_STATUS_REPORT(200) is armed in AAR request. There is a separate timer event for different Rx client.

This timer is stopped by PCRF when CCR-U is received from P-GW. Also in case when P-GW does not respond to Gx-RAR then CCR-U timer is stopped on receiving internal Gx-RAA (result-code=7000) message.

CCR-U timer is helpful in informing AF if the QoS requested through AF is updated on P-GW. In case of default bearer QoS boost/throttle request from AF, there is no notification sent by the P-GW to PCRF. In this case PCRF internally runs this CCR-U time which on expiry sends an update (through Rx_RAR having DPCC-Status AVP) to AF that QoS request is served.

There is no default value for this timer. If you want to start CCR-U timer, then you need to configure through Policy Builder. The maximum value is 15 seconds.

Sending Delayed Message Wait Time Ms

This parameter is used to configure wait timer for sending delayed messages.

Default value is 500 milliseconds.

In case of multiple Media-Component-Descriptions being received in an AAR message by CPS, where one of them is rejected after evaluating for Rx Authorization, CPS sends a successful AAA for the accepted Media-Component-Descriptions and also creates a scheduled event for sending a delayed Rx RAR for rejected Media component.

This Rx RAR is sent to AF based on Sending Delayed Message Wait Time configured.

Emergency URN List

The list of URNs that are used to indicate that a AF session relates to emergency traffic as per procedures described in 3GPP TS 29.214. For more information refer to Wildcard URN. See Emergency URN List.

Override AF App Id with URN for Emergency sessions

When selected, CPS overrides the AF-Application-Identifier AVP value with the Service-URN AVP value for emergency calls. This option is provided in order to overcome the lack of AF-Application-Identifier AVP value in Rx AAR in case of IMS emergency calls.

The default setting is unchecked.

Validate Flow-Description AVP Value

When selected, CPS validates the Flow-Description AVP values received as part of Media-Sub-Component based on restrictions provided in the 3GPP 29.214 Release 11 specification. If the Flow-Description value does not comply with the format specified then the AAR request is rejected with FILTER_RESTRICTIONS (5062) value in Experimental-Result-Code.

When unchecked, CPS does not validate the Flow-Description AVP value and simply forwards it is as is to PCEF as part of generated rules.

The default setting is unchecked.

29.213 standard QoS for preliminary service

When checked, CPS supports the QoS handling for Preliminary Service Status. So, on receiving Service-Info-Status AVP as preliminary service information from AF, CPS generates the dynamic PCC rule and assign QCI and ARP values of the default bearer to these PCC rule to avoid signaling to the UE.

When unchecked, CPS ignores the Service-Info-Status AVP value and derive the ARP and QCI values as per the QoS derivation algorithm defined in 3GPP TS 29.213 specification.

The default setting is unchecked.

NetLoc: Report ANI on rule failure

When checked, CPS always sends the ANI to AF on receiving ANI event from the PCEF. So, in case of bearer release that is either in Rx_RAR (when few rules are impacted) or in Rx_STA when all the rules are impacted, PCRF adds the ANI (access network information) towards AF.

When unchecked, CPS does not report ANI to the AF every time the ANI event is received from PCEF.

In case of Rx session termination by PCRF that is, when PCRF sends Rx ASR to the AF; PCRF sends the ANI in the Rx STA message even if AF has not asserted the Required-Access-Info AVP for ANI in the Rx STR message.

The default setting is unchecked.

Hold STA if RAN-NAS-Cause enabled

When RAN-NAS-Cause feature is enabled, CPS sends access network information and RAN-NAS-Release-Cause to AF in STA. So, when this check box is selected, CPS waits for this information from the PCEF and does not send STA till it receives the CCR-U from the PCEF.

The default setting is checked (TRUE).

Auto Increment Precedence Avp

When selected, CPS automatically increments the precedence AVP value by 1 for every Rx charging rule that is installed as part of any Rx session that is using this Rx client within the same Gx session. For example, Gx session (Gx1) has one Rx session (Rx1). When Rx1 is created, two charging rules are installed and they are assigned precedence values 1 and 2. A second Rx session (Rx2) starts for Gx1 and also installs two Rx charging rules. These rules are assigned precedence values 3 and 4.

The precedence values are stored in the Gx session in the rxPrecedenceCounter attribute.

Using this option overrides any other Rx charging rule precedence settings (for example, any that may have been configured for the RxSponsoredDataChargingParameters service option).

You can use the Precedence Start Value and Precedence End Value options to set lower and upper limits for the precedence AVP values. If you do not set these options, the starting precedence value is set to 1 and is incremented to 9223372036854775807.

The default setting is unchecked.

Remove Rule On Rule Deactivation

When selected, CPS manages the expiration of Rule-Deactivation time triggers. On expiration of the installed Rule-Deactivation time, CPS initiates removal of the inactive dynamic rules and tear-down of the existing Rx session.

The default setting is unchecked (false).

Authorize Sponsor Data Connectivity

When selected, CPS validates the sponsor ID received in AAR request. If the received sponsor ID is unauthorized, CPS returns UNAUTHORIZED_SPONSORED_DATA_CONNECTIVITY (5067) code in AAA.

The default setting is unchecked (false).

Enforce Unique AF-Charging-Identifier

When selected, CPS enforces a unique AF-Charging-Identifier across all Rx sessions within a given subscriber or network session. During an Rx session establishment, if there is already an Rx session (within the subscriber or network session) containing the same AF-Charging-Identifier value, CPS rejects the new Rx session with DUPLICATED_AF_SESSION (5064) experimental result code.

The default setting is unchecked.

Prefer command level AF-Application-Identifier

The AF-Application-Identifier AVP present in the AAR message indicates the particular service that the AF session belongs to. This AVP can be present at the command level and within the Media-Component-Description AVP.

When selected, and if the AF-Application-Identifier is sent both at command level and within the Media-Component-Description AVP, the AF-Application-Identifier AVP value present at the command level is considered.

The default setting is unchecked, that is, the AF-Application Identifier provided within the Media-Component-Description AVP is considered.

Send timezone and location info

When selected, CPS sends time zone and location information in Rx AAA, STA, and Rx RAR response messages provided that 3GPP-MS-TimeZone AVP and 3GPP-User-Location-Info AVP are already received in the CCR message.

To receive the updated time zone and location information in the messages, CPS should arm the UE_TIME_ZONE_CHANGE event trigger and USER_LOCATION_CHANGE event trigger in the service option under Event-Trigger configuration.

Trigger RAR when all rules fail (for SRVCC)

When selected, CPS can trigger RAR instead of ASR when all rules fail with rule failure code PS_TO_CS_HANDOVER.

The default setting is unchecked.

Reject AAR with Invalid Service Info for missing Media-Type

When selected, if Media-Type is found to be missing in any Media-Component-Descriptions in Rx_AAR, CPS rejects the Rx_AAR with Experimental-Result-Code= INVALID_SERVICE_INFORMATION (5061).

The default setting is unchecked.

Precedence Avp Lower And Upper

Precedence Start Value

When selected, CPS automatically increments the precedence AVP value by 1 for every Rx charging rule that is installed as part of any Rx session using this Rx Client, within the same Gx session. The precedence values are stored in the Gx session in the rxPrecedenceCounter attribute.

This value is optional, but when used, must be greater than 0 and less than the Precedence End Value.

Precedence End Value

The upper limit of the precedence values for Rx charging rules that are installed. When this value is reached, the rxPrecedenceCounter is reset to the Precedence Start Value.

This value is required when using the Precedence Start Value. It must be greater than the start value.

Netloc Access Not Supported Configuration

See Netloc Access Not Supported Configuration.

Session Binding Overriding

See Table 2.

Rule Failure Mapping Table

By default, the table is empty and unchecked (for backward compatibility) but if you want to override the default behavior, then you need to configure all the error codes received over Gx via CCR-U or RAA message for which Rx RAR needs to be sent.

You can create two tables for mapping rule-failure-code to specific-action (for sending in Rx RAR) and rule-failure-code to abort-cause (for sending in Rx ASR).

If you have checked Rule Failure Mapping Table checkbox and did not configure any mappings then neither default Specific Action nor Abort Cause is applied for any of the Failure Code.

If you have not checked Rule Failure Mapping Table checkbox then default Specific Action and Abort Cause is applied.

• For mapping rule-failure-code to specific-action:

  Table Name: Gx Rule Failure To Rx Specific Action Mapping

• For mapping rule-failure-code to abort-cause:

  Table Name: Gx Rule Failure To Rx Abort Cause Mapping

Request Gx RAA for Event-Triggers

By default, the table is empty and unchecked (for backward compatibility). This configuration is used to determine the Gx event triggers that CPS should subscribe in Gx RAR (dummy RAR) before it processes the media information that it has received in Rx AAR message.

The event triggers are determined based on a CRD table (dummy RAR table) whose input columns are bound to Rx media details (for example, Media-Type, AF-Application-Id, and so on) and output columns specify the event-trigger numbers that are to be subscribed/enabled on PCEF.

The evaluation of this CRD table per media (Media-Component-Description) is defined through Rx STG lookup binding configuration under Rx Profile. The Rx CRD AVP names to extract Event-Triggers list is used to specify the Rx CRD AVP names. These Rx CRD AVPs are created based on the output column mapping defined for the CRD table (dummy RAR table) under Rx STG lookup binding (AVP name defined under Output column AVP pairs).

Extract Avps

See Extract Avps.

Override Supported Features

See Override Supported Features.

IP Address (default)

Attempts to bind by

• 1 Framed-IP-Address

• 2 Framed-IPv6-Prefix

IMSI and APN

IMSI value and APN value from incoming request.

MSISDN and APN

MSISDN value and APN value from incoming request.

IMSI And IP Address

IMSI value, IP address value, and IPv6-Prefix value from incoming request.

On receiving Rx session request, keys are generated for IMSI and IP Address or IMSI and IPv6-Prefix combination to load the session based on these keys.

Load By Realm And User Id

If checked attempts to load the session by realm (Origin-Realm AVP value) and User Id.

Default value is unchecked.

Load By Apn And User Id

If checked attempts to load the session by APN (Called-Station-Id AVP value) and User Id.

Default value is unchecked.

Gy As Primary

This check box controls whether you want to run the Gy as primary (for example, for Gy only call model) or secondary (for example, Gx + Gy call model).

gyAsPK parameter in qns.conf file is also used to run Gy as primary or secondary. This flag is system wide parameter. In case you want to run Gy only call model and Gx + Gy call model both on the same system, the qns.conf parameter cannot be used.

The new check box field added under Gy Client is backward compatible with qns.conf parameter settings. For example, if -DgyAsPK=true parameter is configured in qns.conf file, the check box is overwritten with the value configured in qns.conf file.

To run both Gy only and Gx + Gy call model on same system:

• First delete the parameter (-DgyAsPK=true) if it is already configured in qns.conf file.

• In Policy Builder, create separate Gy Clients for primary Gy and secondary Gy.

• Next check the "Gy As Primary" check box in this Gy Client, if you want Gy as primary.

• Uncheck the "Gy As Primary" check box in this Gy client, if you do not want Gy as primary.

Extract Avps

See Extract Avps

Override Supported Features

Currently, not supported.

IMSI

Subscription-Id-Data AVP value under Subscription-Id grouped AVP where Subscription-Id-Type AVP value is END_USER_IMSI (1)

MSISDN

Subscription-Id-Data AVP value under Subscription-Id grouped AVP where Subscription-Id-Type AVP value is END_USER_E164 (0)

NAI

Subscription-Id-Data AVP value under Subscription-Id grouped AVP where Subscription-Id-Type AVP value is END_USER_NAI (3)

Name

The client name that is going to be used to reference this particular client in the service configuration object.

Realm Pattern

The pattern that peer realm name should match in order for this diameter client to be used. The pattern needs to follow the standard Java regular expression syntax described here.

The first choice for Realm Pattern value should always be the exact peer realm name whenever possible.

Counter Lookahead Interval

Dynamic calculation of policy counters events that are subjected to an update for the interval specified. If the look ahead interval is specified, CPS evaluates all policy counters and if a policy counter is about to expire before the interval, CPS sends the policy-counter-stats.

Default value is 180 minutes.

Extract Avps

See Extract Avps

Input

Gx CCR-i

Gx Realm

Origin-Realm

Gx Host Pattern

Origin-Host

Output

Sd TSR

TDF Realm

Destination-Realm

TDF Host

Destination-Host

Push Pre Configured Rule Options

Controls whether the configured default bearer QoS will be installed on the default bearer or on the secondary bearers.

• PushOnDefaultBearerQoS (default)
• PushWithUpgradedDefaultBearerQoS

Logical Apn

Allows for a default APN name to be defined. This APN name is going to be further used as an input into the AF Application Id Validation feature described below. The APN value will be set based on the available data and the priorities described below.

• 1 - A policy derived AVP having the same value as the Logical Apn
• 2 - Called-Station-Id AVP from incoming Rx AAR
• 3 - Called-Station-Id AVP from Gx session

Gx Client QoS Exclusion List

Gx client names that are allowed not to have a default bearer QoS installed. In case a default bearer QoS has not been configured in the policy and the Gx client name has not been added to this list an error response will be sent to the PCEF containing the Result-Code AVP value DIAMETER_ERROR_BEARER_NOT_AUTHORIZED (5143).

Grant Requested QoS

Controls whether the requested QoS should be granted or not as the default bearer QoS.

Default value is unchecked.

Grant Requested Qos Over Global Qos

If this option is selected then the requested QoS should be granted even if the global QoS is provisioned. There are three type of QoS first is taken from service second is from default QoS and third one is from request. If this flag is checked then requested QoS will take priority over default QoS.

Default value is unchecked.

Global Default Granted QoS

Qci

The QoS class identifier identifies a set of IP-CAN specific QoS parameters that define QoS excluding the applicable bitrates and ARP. It is applicable both for uplink and downlink direction. The QCI values 0 10 – 255 are divided for usage as follows

• 0 - Reserved
• 10-127 - Reserved
• 128-254 - Operator specific
• 255 - Reserved

Max Req Bandwidth UL

It defines the maximum bit rate allowed for the uplink direction.

Max Req Bandwidth DL

It defines the maximum bit rate allowed for the downlink direction.

Guaranteed Bit Rate UL

It defines the guaranteed bit rate allowed for the uplink direction.

Guaranteed Bit Rate DL

It defines the guaranteed bit rate allowed for the downlink direction.

Apn Agg Max Bit Rate UL

It defines the total bandwidth usage for the uplink direction of non-GBR QCIs at the APN.

Apn Agg Max Bit Rate DL

It defines the total bandwidth usage for the downlink direction of non-GBR QCIs at the APN.

Enable Pending Policy Evaluation

When selected, pending policy calculation is enabled for one look ahead in advance.

Default value is unchecked.

Ims Apn

List of IMS APNs for which the MPS feature is supported.

This field can accommodate several Ims Apn that are used to match with the incoming service request for priority service. The values that are received by the Default Bearer QoS are looked up for a suitable Ims Apn match. If the APN value of a Gx session request matches IMS APN IMS signaling priority from EMPS service is used as priority level.

Mps QoS

For information on parameters under Mps QoS refer to ARP Parameters.