qns.conf
qns.conf file is the main shared configuration file which is applied to all VMs (Virtual Machines) across CPS and is located in the path /etc/broadhop/qns.conf. The following example is a typical Policy Server (QNS) configuration file, however, certain parameters may vary from customer to customer.
-DclusterFailureDetectionMS=10000
-Dcom.broadhop.run.systemId=system-1
-Dcom.broadhop.run.clusterId=cluster-1
-Dcom.broadhop.config.url=http://pcrfclient01/repos/run/
-Dcom.broadhop.repository.credentials=broadhop/broadhop@lbvip02
-Dcom.broadhop.referencedata.local.location=/var/broadhop/checkout
-Denable.compression=true
-Denable.dictionary.compression=true
-DuseZlibCompression=true
-Dcom.broadhop.locking.autodiscovery=true
-DmessageSlaMs=9000
-Dcom.broadhop.diameter.log.success.responses=true
-DsendDiameterTooBusy=trueThe following table lists the common cluster-wide configuration parameters found in /etc/broadhop/qns.conf file:
 Note |
For any parameter change to take effect, you need to restart the process such as, qns, lb, and so on. |
|
Parameter |
Description |
||||
|---|---|---|---|---|---|
|
com.broadhop.run.clusterId |
Name of the cluster. This should match with the Policy Builder configuration within system configuration and can be used to define multiple cluster specially for a GR or HA deployment. Default: cluster-1 |
||||
|
com.broadhop.run.systemId |
Name of the system. This should match with the Policy Builder configuration under system configuration. We can define multiple systems such as UAT, IOT, Production and single policy builder instance can configure all instances of CPS servers. Default: system-1
|
||||
|
balanceLocalGeoSiteTag |
This parameter is applicable in GR deployments only. If primary member is not available, this parameter is used to read the records from available local or current site secondary members and perform the insert, update, and delete operations to the backup database on local (current) site. This parameter helps to reduce the response time for the operation in case of latency between the sites (avoid application to look into the remote site secondary members for the read). For this parameter to function as expected, make sure the tags are updated in the MongoDB balance replica-set configuration. For more information, refer to Balance Query Restricted to Local Site section in the CPS Geographic Redundancy Guide. Also, make sure the default read preference is configured in Policy Builder. Default read preference is configured in Policy Builder Example:
|
||||
|
clusterLBIF |
Application uses the configured interface assigned to this parameter to create the ZMQ TCP connection between local site Policy Director (LB) and remote site Policy Director (LB) VMs. Default: eth1 Example: |
||||
|
clusterLBIFIpv6 |
This parameter is applicable for GR only and depends on the value of Suppose
Example: Default: false Possible Values: true, false |
||||
|
clusterPeers |
This parameters needs to be configured when there are separate sessions and no replication across sites and provisioning event is needed to broadcast to other sites. By default, cross-site messaging does not happen until it is configured. Example:
|
||||
|
local.cluster.peer |
This parameter is used to specify the local cluster name and to create local cluster queue. This parameter is used with Example:
|
||||
|
broadcast.cluster.peers |
This parameter is used to specify all the clusters including local clusters to whom the LDAP search requests (received on the CPS LDAP Server) are broadcasted for session lookup and to create redisQ between local cluster and other clusters. Each cluster name must be separated with semicolon. Add all the clusters including local cluster name. Example:
|
||||
|
geoHASessionLookupType |
This parameter is used to specify the lookup type to be used in Active/Active GR deployments. For any incoming request, this parameter informs the application in which shard to look in. Session database is replicated across site. Session database of the site can be selected based on realm or host or local information. Example: Default: realm Possible Values: realm, host and local If When the lookup type is set to local, you need to configure When session lookup type is set to “local”, local session database is used to read/write session irrespective of site lookup configuration. For “local” session lookup type, site lookup configuration is not required. Even if it is configured, it is not used. Firstly, it searches the local site for every incoming request and if it doesn't find it, it looks in the remote site for session shard. You need to configure all the realms for all the interfaces (such as, Gx, Rx, and so on) here:
where, <SiteId> is the primary site ID. <LookupValue> is the realm value. For example, if you have multiple Gx and Gy clients connected to the CPS and the details for realms of clients are as follows: Client-1: pcef-1-Gx.cisco.com Client-2: pcef-1-Gy.cisco.com Client-3: pcef-2-Gx.cisco.com Client-4: pcef-2-Gy.cisco.com Let us consider, first two clients (Client-1 and Client-2) are connected to Site1 and Client-3 and Client-4 are connected to the Site2, then
|
||||
|
GeoSiteName |
Name defined to identify chassis/cluster for a given site. It should uniquely identify the name within entire cluster. It
is mandatory to configure this parameter if Example: |
||||
|
isGeoHAEnabled |
This parameter is used to enable the Active/Active GR. This parameter is applicable when Geo-HA bundle is installed. Example: Default: false Possible Values: true, false |
||||
|
migrateSessionToLocalSite |
When set to "true", sessions are migrated to local site while processing calls. Next request on same session would then be processed from local databases.
When set to "false", session is not migrated and continues to be fetched and updated from remote site database. Support for this parameter has been added in orchestration API also. Example: Default: false Possible Values: true, false
|
||||
|
RemoteGeoSiteName |
This parameter is applicable only for GR. When the session created on Site2 and SPR update or Rx call comes on Site1, CPS sends Gx RAR from Site1 and in response PCEF sends RAA and next CCR request to Site1. This leads to cross site call switches from Site2 to Site1. If there are lot of call switches, Site1 may get overloaded. By default, CPS does not prevent cross-site switching. To prevent cross-site switching, user needs to set
where, <sitename> is remote site name to be provided, and only to be added if you want to disable Gx-RAR switches from PCRF. It should match
with the name of Geo remote site ( Prerequisite is both remote site and local site Policy Server (QNS) should be able to communicate to Policy Director (lb) on same interfaces. To change interface, parameter For cross-site communtication, |
||||
|
RemoteSiteId |
Site ID to uniquely identify remote site chassis/cluster. RemoteSiteId belongs to other site means current site is communicating to other site in case of GR deployments. You need to specify site ID of other site here. Default: Site2 |
||||
|
sessionLocalGeoSiteTag |
This geo tagging is applicable only during database failover time period. In normal case, session database query/update always happens on primary member. This parameter is applicable in GR deployments only. If primary member is not available, this parameter makes sure that records are read from the available local or current site secondary members and perform the insert, update, and delete operations to the backup database on local (current) site. It helps to reduce the response time for the operation in case of latency between the sites (avoid application to look into the remote site secondary members for the read). For this parameter to function as expected, make sure the tags are updated in the MongoDB balance replica-set configuration. For more information, refer to Session Query Restribcted to Local Site during Failover in the CPS Geographic Redundancy Guide.
Example:
|
||||
|
SiteId |
Site ID is used to identify name for the current site. Default: Site1 |
||||
|
sprLocalGeoSiteTag |
SPR doesn't have backup database. By default, SPR lookup is secondary and preferred only if the primary is not available. It has a Policy Builder configuration to control if any transactions to read a subscriber data from SPR replica set for primary are not available. If sprLocalGeoSiteTag is not configured and select read preference as a secondary is set in PB, there is a chance to look into other remote secondary and can see a latency response time. To avoid latency in response time, this parameter must be configured on MongoDB replica set and qns.conf file so that the application tries to read/write from locally available member results. This parameter overrides the read preference configured in USuM Configuration in Policy Builder. Default read preference is configured in Policy Builder. Example: |
||||
|
migrateSessionToLocalSite AdditionalInterfaces |
This parameter is used to trigger the session migration if the network session is found on the remote site and the incoming message is Sy or Rx. Example: Default: GX_TGPP Possible Values: Sy_V11, SingleSyDeviceMgr, RX_TGPP, GX_TGPP
|
||||
|
com.broadhop.q.if |
This parameter is used to perform diameter message interprocess communication transfering between Policy Server (QNS) and Policy Director (LB) VMs. Both remote site and local site policy server (QNS) should be able to communicate to load balancer on same interfaces. To change the interface, Example: Default: eth0 |
||||
|
com.broadhop.q.if.ipv6 |
This parameter depends on the value of Suppose
Example: Default: false Possible Values: true, false |
||||
|
purgeUnusedQuota |
When this parameter is set to true, then application removes the empty quota entries from the balance records. The quota is removed only when all the credits in that particular quota have been removed. This parameter depends on the credits in the quota, even if the quota is not being used but credit details are still present then quota will not auto purge but wait till all the credits are removed from it. To maintain history of credits depends on 'retainCreditsDays' parameter value. This parameter is not applicable for purging 'Recurring Quotas'. Example: Default: false Possible Values: true, false |
||||
|
PCRF_Name |
For Legacy OCS server, you need to configure Example: This configures the PCRF name to be 11. |
||||
|
do.service.bundling.without.profiles |
Virtual service can be created with or without CRD profile. This parameter allows the creation of virtual-services without defining CRD bundle profiles. If the parameter is set to false which means bundle profile is required for virtual-services. Example: Default: false Possible Values: true, false |
||||
|
evaluate.session.on.service.expiration |
When set to true, CPS internally triggers a session evaluation when a particular virtual-service expires. On evaluation it skips the expired virtual-service and applies new policies accordingly. Example: Default: false Possible Values: true, false |
||||
|
virtualservice.optimize.crd |
When set to true, CPS only loads the CRD tables that are affected by the virtual service (virtual service name and its AVPs used as keys) while evaluating each virtual service. If any other CRD tables are dependent on the results of these tables, then they too are evaluated recursively. Example: Default: false Possible Values: true, false |
||||
|
enable.parallel.queries mongo.session.query.pool.size |
Queries to session database across multiple shards can now be parallel (instead of serial) thus reducing the overall time required to search a session (in case of large number of shards). The following additional parameters are required to enable parallel session queries for LDAP server and NAP notifications:
|
||||
|
db.full.scan.tps |
This parameter is used to restrict the TPS of full database scans per qns process. This parameter is optional. If this parameter is not configured in qns.conf file, default value 7 is used. To disable the full scan restriction to configured limit, in qns.conf file, set the value to 0. Example: Default: 7 (for HA setup); 4 (for GR setup) |
||||
|
com.broadhop.license.approach |
This parameter is used to configure/enable CPS to use the Cisco Smart Licensing model. Example: where, sl is used for Smart Licensing. If this parameter is not present, CPS uses the legacy SWIFT/LMGRD model. For more information, see CPS Managing CPS Licenses chapter in the CPS Operations Guide. Default: Not present/null
|
||||
|
com.broadhop.config.url |
The URL from which to pull the policy configuration. This URL should match with the publish URL defined in Policy Builder. Default: http://lbvip02/repos/run/ |
||||
|
com.broadhop.repository.credentials |
Username, password@hostname format is fixed and is used for SVN credential used to access the policy configuration. Default: qns-svn/3300901EA069E81CE29D4F 77DE3C85FA@lbvip02 You can use
|
||||
|
com.broadhop.repository. credentials.isEncrypted |
Enables or disables encryption of the runtime repository password. Default: true
|
||||
|
com.cisco.balance.compression |
This parameter is used to enable or disable balance compression. Default: true |
||||
|
com.cisco.balance.dbs |
This parameter is used to configured the number of shards for balance database at application level. Default: 1 |
||||
|
retainCreditsDays |
Property retainCreditsDays could be configured to control the number of days after which expired balance credits are removed. CPS calculates the age of expired credits whenever refresh happens to that quota and if age of expired credit greater than retainCreditsDays then it removes credit entry. For example, If the parameter is not specified, 99999 is used as default value.
|
||||
|
dbSocketTimeout |
The wait time in milliseconds for query/insert/update/delete on database, before it can be timed out. This timeout value is used at the timeout value for all other databases unless the specific timeout parameter for the database (such as balance, CDR, and so on) is configured. Default: 60000 Recommended: 1000 |
||||
|
dbSocketTimeout.balance |
The wait time in milliseconds for query/insert/update/delete on the balance database, before it can be timed out. If a value for this parameter is not defined, the value of Default: 60000 |
||||
|
dbSocketTimeout.cdr |
The socket timeout on the CDR database in milliseconds. If a value for this parameter is not defined, the value of Example: Default: 60000 |
||||
|
dbSocketTimeout.cdrrep |
The socket timeout in milliseconds on the reporting database. If a value for this parameter is not defined, the value of Example: Default: 60000
|
||||
|
dbSocketTimeout.remoteBalance |
The wait time in milliseconds for query/insert/update/delete on the balance database, before it can be timed out. If a value for this parameter is not defined, the value of Default: 60000 |
||||
|
dbSocketTimeout.remoteSpr |
The wait time in milliseconds for query/insert/update/delete on the SPR database, before it can be timed out. If a value for this parameter is not defined, the value of Default: 60000 |
||||
|
dbSocketTimeout.spr |
Configures a separate socket timeout for the SPR MongoDB. This helps the MongoDB regex search function operate as expected
for the Control Center GUI and is only viable when the SPR read preference is set to SecondaryPreferred. If the SPR read preference
is set to Primary like the Session DB, then Cisco highly recommends that the If a value for this parameter is not defined, the value of Default: 60000
|
||||
|
dbSocketTimeout.secondary_key |
MongoDB socket timeout in milliseconds. This parameter is used for SK database. Example: Default: 1000 |
||||
|
mongo.connections.per.host |
Number of concurrent application connections allowed to the MongoDB per host (qns process). If there are three session cache, then each cache can have five connections. If the value for this parameter is not defined, the value of Example: Default: 5
|
||||
|
mongo.connections.per.host.balance |
This parameter is used to specify the number of connections allowed per host (the pool size, per host) for the balance database. If the value for this parameter is not defined, the value of Example: Default: 100
|
||||
|
mongo.connections.per.host.cdr |
The number of connections on the CDR database allowed per host. If the value for this parameter is not defined, the value of Example: Default: 10 |
||||
|
mongo.connections.per.host.cdrrep |
The number of connections on the reporting database allowed per host. If the value for this parameter is not defined, the value of Example: Default: 10
|
||||
|
mongo.connections.per.host.reconcile |
This parameter is used to specify the number of connections allowed per host for the reconcile database. If the value for this parameter is not defined, the value of Default: 100
|
||||
|
mongo.connections.per.host.remoteBalance |
This parameter is used to specify the number of connections allowed per host (the pool size, per host) for the remote balance database (in case of GR). If the value for this parameter is not defined, the value of Example: Default: 100
|
||||
|
mongo.connections.per.host.remoteSpr |
This parameter is used to specify the number of connections allowed per host for the remote SPR database (in case of GR). If the value for this parameter is not defined, the value of Example: Default: 100
|
||||
|
mongo.connections.per.host.spr |
This parameter is used to specify the number of connections allowed per host for the SPR database. If the value for this parameter is not defined, the value of Example: Default: 100
|
||||
|
mongo.threads.allowed.to.wait. for.connection |
This parameter is a multiplier for connectionsPerHost that denotes the number of threads that are allowed to wait for connections
to become available if the pool is currently exhausted. If connectionsPerHost is 10, and Applicable for MongoDB connection. Example: Default: 5 |
||||
|
mongo.threads.allowed.to.wait. for.connection.balance |
This parameter is a multiplier for connectionsPerHost that denotes the number of threads that are allowed to wait for connections
to become available if the pool is currently exhausted. If connectionsPerHost is 10, and Applicable for balance database connection. Example: Default: 5
|
||||
|
mongo.threads.allowed.to.wait. for.connection.cdr |
Multiplier for connectionsPerHost for the number of threads that can be blocked. For example, if Example: Default: 10
|
||||
|
mongo.threads.allowed.to.wait. for. connection.cdrrep |
Multiplier for connectionsPerHost for the number of threads that can be blocked. For example, if Example: Default: 10
|
||||
|
mongo.threads.allowed.to.wait.for. connection.reconcile |
This parameter is a multiplier for connectionsPerHost that denotes the number of threads that are allowed to wait for connections
to become available if the pool is currently exhausted. If Example: Default: 5
|
||||
|
mongo.threads.allowed.to.wait.for. connection.remoteBalance |
This parameter is a multiplier for connectionsPerHost that denotes the number of threads that are allowed to wait for connections
to become available if the pool is currently exhausted. If connectionsPerHost is 10, and Applicable for remote balance database connection. Example:
Default: 5
|
||||
|
mongo.threads.allowed.to.wait. for. connection.remoteSpr |
This parameter is a multiplier for connectionsPerHost that denotes the number of threads that are allowed to wait for connections
to become available if the pool is currently exhausted. If connectionsPerHost is 10, and Applicable for remote SPR database connection. Example: Default: 5
|
||||
|
mongo.threads.allowed.to.wait. for.connection.spr |
This parameter is a multiplier for connectionsPerHost that denotes the number of threads that are allowed to wait for connections
to become available if the pool is currently exhausted. If connectionsPerHost is 10, and Applicable for SPR database connection. Example: Default: 5
|
||||
|
mongo.health.monitor.enabled |
This parameter is used to enable MongoDB health monitor for write operations. Example: Default: false Possible Value: true, false |
||||
|
mongo.health.monitor.scheduler.period |
This parameter used to configure how frequently to execute the MongoDB write operation health monitor thread. Example: - Default: 3000 milliseconds |
||||
|
mongo.monitor.write.update.threshold |
This parameter is used to configure number of MongoDB write operations to be performed on the database every time the thread executes. Example: Default: 50 |
||||
|
mongo.monitor.percentage.threshold |
This parameter is used to calculate the success threshold percentage rate for MongoDB write operations. If success result is less than configured threshold, then only MongoDB client rest operation is triggered. Example: Default: 80 |
||||
|
mongo.reset.scheduler.period |
This parameter is used to configure how frequently to execute the thread for checking the reset MongoDB client connections in case of write operations are breached the failure threshold. Example: Default: 4000 milliseconds |
||||
|
wait.time.after.reset |
This parameter is used to configure the time that thread for resetting MongoDB client connection should wait/sleep for after connection reset. Example: Default: 10000 milliseconds |
||||
|
mongo.reset.retry.counter |
This parameter is used to configure maximum retry attempts for resetting MongoDB client connections in case of previous reset failure. Example: Default: 2 |
||||
|
apirouterContextPath api.ua.context.path ua.context.path |
This parameter is checked if Some customer may have configured the URL at multiple places and do not want to change URL. To change the endpoint so that the API router uses /ua/soap, add the following parameters in /etc/broadhop/qns.conf file. This makes API router act as unified API.
New URLs are as follows:
|
||||
|
networkguard.tcp.local |
This enables the option to choose an explicit interface to handle the diameter processing on Policy Director (LB) VMs. This parameter is used to bring up the Diameter stack for the Diameter process on Director (LB) VMs.
Default: eth0 |
||||
|
networkguard.tcp.local.ipv6 |
This enables the option to choose an explicit interface to handle the diameter processing on Policy Director (LB) VMs. This parameter is used to bring up the Diameter stack for the Diameter process on Director (LB) VMs.
Example: Default: false Possible Values: true, false |
||||
|
diameter.default.timeout.ms |
Defines the end to end timeout in milliseconds for diameter messages. For example, a CCRi received at load balancer (Policy Director) and CCAi has to be sent by 1500 ms otherwise the message is marked as timed out. This default setting is used only if the Action Timer (Ms) parameter is not set under in Policy Builder. Default: 3000 |
||||
|
disableCdrReplication |
This parameter is used to specify whether the process should participate in doing CDR replication or not.
By default, this parameter is set as false. |
||||
|
enableRedisReporting |
This parameter helps the application to decide whether to use Redis or not, to store the generated reporting data. This parameter needs to be added in /etc/broadhop/qns.conf file. If this parameter is set to true, then application uses the Redis to store the generated reporting data. If the parameter is set to false, then MongoDB is used to store the generated reporting data. This parameter needs to be added on each Policy Server (qns) node and Policy Director (lbs). Example: Default: false Possible Values: true, false |
||||
|
dbPassword |
This parameter is used to enable authentication for MongoDB. Example: where, XXXX is encrypted admin database user's password for application. The following command is used to generate encrypted password from Cluster Manager: Also, if you modify/remove above parameter then you have to restart the application. This encrypted password for admin user is applicable only when
|
||||
|
com.broadhop.andsfurl.enable |
No longer used. |
||||
|
useVipInsteadOfHostnameForTrap |
This parameter contain list of interface names with VIP name separated by comma. When this parameter is configured, CPS uses VIP name instead of local VM hostname in trap key and event host. Example:
|
||||
|
useDiameterPeerIpForTrap |
This parameter can be used to include PeerIP in "diameter peer down" alarm message and key. When set to true, peer IP is included. Example: Default: false Possible Values: true, false |
||||
|
useDiameterInterfaceForTrap |
This parameter can be used to include interface name in "diameter peer down" alarm message and key. When set to true, the interface name is included. Example: Default: false Possible Values: true, false |
||||
|
use.ldap.vs.evaluation.order |
When set to true, this parameter enables the processing of a set of LDAP attributes and its corresponding Sy virtual-service consecutively in the order they were received by CPS. If this parameter is not added in qns.conf file, then by default this parameter is set to true. Example: Possible Values: true, false |
||||
|
jdiameter.accept.unknown_desthost |
This parameter is used to enable the processing of a request message received by CPS with an unknown Destination-Host. Example: Default: false Possible Values: true, false |
||||
|
jdiameter.replace.unknown_desthost |
This parameter is used to enable CPS to replace the unknown Destination-Host received in the message with its own advertised FQDN. Example: Default: false Possible Values: true, false
|
||||
|
message.buffer.early.processing.time |
The parameter can be configured in /etc/broadhop/diameter_endpoint/qns.conf file. This parameter is used to configure the time in milliseconds for early processing of the buffered messages if only one message is buffered or if there are no holes in the buffered messages. This value must always be less than the Buffer Timeout In Milliseconds defined in Policy Builder under . Example: Default: 5 ms |
||||
|
tcp.hold.timer.after.dpr |
The parameter is used to indicate the amount of time (ms) the TCP connection is held towards all the peers after sending/receiving DPR. Example: Default: 2000 ms Possible Range: 1 - 3000 ms
|
||||
|
gx.rulebasenames.delimiter |
This parameter is used to specify the delimiter with which to separate multiple rule base names in Gx session field. This parameter can be added in /etc/broadhop/pcrf/qns.conf file. Example: Default: "," Possible Values: String values |
||||
|
session.db.init.1 session.db.init.2 |
This parameter is used to create the entry in shards/sk_shards collection in sharding database for HA setup which is used to store secondary keys. By default, there are two members for a set of ring, where To change the mapping, you need to configure the values in qns.conf file. Example: |
||||
|
sendErrorOnSession CreateNotAllowed |
When set to true, creation of the sessions is not allowed in CPS. Instead, the application sends the error response for Diameter Gx request messages that are received after session limit is breached. Example:
Default: false Possible Values: true, false |
||||
|
diameter.resultCode OnSessionCreateNotAllowed |
This parameter is used to configure the diameter result-code to be sent for the error response when session creation is not allowed. This paramater must be combined with parameter Example:
Default: 5012 |
||||
|
StaleSession.SupportedErrorCodes |
When a session is successfully processed during RAR, session expiration time (expiryDate in session data) is immediately incremented irrespective of whether there is a RAA with error or there is no RAA from the peer. This parameter controls the behavior of incrementing session expiryDate in case there is a RAR failure. When configured with error codes, older expiryDate is retained for RAR failures for those errors. Semi-colon ";" separated list of RAR error codes must be configured to enable this feature for specific error codes. Example: To enable cleanup for Timeouts and Diameter-Too-busy, configure
Default: By default, if the parameter is not configured, previous behavior of clean-up based on 5002 and 5012 error codes is supported. |
||||
|
remoteSprCleanupEnabled |
This parameter is used to enable/disable remote SPR (subscriber records located on remote SPR Mongo databases) cleanup feature. Example: Default: true Possible Values: true, false The following parameters are also required to run the remoteSprCleanup feature:
|
||||
|
remoteSprDeleteFrequency |
This parameter is used to configure the interval in milliseconds before the subscriberCleanup database is queried and deletes are executed on the Remote SPR database cross-site. Example: Default: 5000 milliseconds |
||||
|
remoteSprCleanupTimeToLive |
This parameter is used to configure Time to Live for records held in subscriberCleanup database. Example: Default: 84600 (1 day) |
||||
|
sprCleanupQueueSize |
This parameter is used to configure the size of locally stored queue holding subscriber details before writing to subscriber cleanup database. Example: Default: 10000 |
||||
|
sprCleanupQueueDrainAmount |
This parameter is used to configure in memory queue record count to be drained at one time. Example: Default: 1000 |
||||
|
subscriberCleanupFetchAmount |
This parameter is used to configure the batch size of the records grabbed from subscriberCleanup database. Example: Default: 1000 |
||||
|
force.SySTR.onCCRT |
When Single Sy feature is enabled and Example: Default: false Possible Values: true, false |
||||
|
isSingleSy |
This boolean parameter is used to enable Single Sy feature in PCRF. Example: Default: false Possible Values: true, false |
||||
|
singleSyPrimaryKey |
The value for this parameter determines if we load SingleSySession based on imsi or msisdn of the parent GxSession as its primary key. Example: Default: msisdn Possible Values: imsi, msisdn |
||||
|
sk.db.init.1 |
Default SK DB shard member1 of the MongoDB replica. Example: Default: sessionmgr01 Possible Value: hostname |
||||
|
sk.db.init.2 |
Default SK DB shard member2 of the MongoDB replica. Example: Default: sessionmgr02 Possible Value: hostname |
||||
|
sk.db.init.port |
Default SK database shard port number. Example: Default: 27717 Possible Value: port number |
||||
|
sk.db.skipRemote |
This parameter is used to skip the remote SKDB queries if local SKDB queries fails. Example: Default: false Possible Value: true, false |
||||
|
sk.db.skipRemotePrimary |
This parameter is used to skip the remote SKDB primary preferred query if secondary preferred query fails. Example: Default: false Possible Value: true, false |
||||
|
sk.db.skipPrimary |
When Secondary Key (SK) in Rx session is trying to attach with Gx session, the key is checked-in Secondary DB in the replica set and then to Primary DB. If this parameter set to true, primary DB look-up is skipped. Example: Default: false Possible Value: true, false |
||||
|
diameter.errorOnSaveFailure |
This parameter is used when SK database or session database writes fails. If this parameter is configured “true”, then the diameter request is responded with diameter error response for Gx and Rx messages. If this parameter is configured “false”, then the diameter request is dropped and no error response is sent. Example: Default: false Possible Value: true, false |
||||
|
diameter.resultCode OnSessionFailure |
This parameter is used to configure error-code to be returned when SK database or Session database write fails and If SK database or Session database writes fail and Example: Default: 3004 Possible Value: 3001 to 5999 |
||||
|
allow.sessioncreation. license.periodic.check |
The value must be set to true so that the license is validated periodically but session creation will not be impacted.
Example: Default: false Possible Value: true, false |
||||
|
license.checkInterval |
This parameter is used to configure the time period (in seconds) after which the license manager validates the license. When session count exceeds license count, LicenseManagerProxy generates LicenseState.RATE_LIMITED. Diagnostics reports “CRITICAL” status. Default: 90 seconds This property is read at the time of service initialization only. |
||||
|
skipUnreachableShards |
The value must be set to true so that the alarms are generated:
Example: Default: false Possible Value: true, false |
||||
|
skipRemoteShardLookup |
When this parameter is set to true, it forces application to lookup in local session shards only (shards belonging to local site), and skip to lookup in remote session shards (shards belonging to other site). Example: Default: false Possible Value: true, false |
||||
|
fwdGxRAASyPSTA |
This parameter is used to forward the success Gx-RAA and SY-prime STA to QNS instance from Policy Director (LB) nodes to QNS instance running on Policy Server (QNS) VMs. This is useful to log response details in Engine logs generated from QNS instances. If the parameter is set to false, the success Gx-RAA and SY-prime STA gets handled only in Policy Director (LB) diameter nodes. Example: Default: false Possible Value: true, false |
||||
|
isMultiStackEnabled |
If you configure multiple Diameter Stacks for different application interfaces (for example, Gx, Rx, Sy) in Policy Builder, then the property isMultiStackEnabled must be set to true in qns.conf file. When set to true, CPS identifies the corresponding interface stack realm peers to process the corresponding interface inbound and outbound messages. When set to false, CPS cannot identify the corresponding peer and drop the message at Policy Director (LB) itself saying Peer is null. Example: Default: false Possible Value: true, false |
||||
|
maxRetryMongoExceptionAttempts |
This parameter is used to configure the Max Retry Attempts which MongoDB Client/CPS should do if MongoDB exception is being caught during the rebalance command. Example: Default: 3 Value Range: 3 - 10 |
||||
|
mail.socket.timeout |
Inactivity period for a socket after which it is closed. Example: Default: 30000 milliseconds |
||||
|
mail.socket.connection.timeout |
Timeout for connection to be established between CPS and SMTP server. Example: Default: 5000 milliseconds |
||||
|
sms.response.timeout |
Time period CPS should wait for the response from SMPP server. Example: Default: 2000 milliseconds |
||||
|
enable.memcache.on.tcp |
When this parameter is enabled (set to true), memcache is done using TCP sockets over default UDP sockets. Example: Default: false Possible Values: true, false |
||||
|
appInstanceIdListCapacity |
Used to decide the capacity of the AppInstanceIdList. The AppInstanceIdList contains the AppInstanceIds that are present in the subscriber session.
For new subscriber session records, the AppInstanceIdList will not grow beyond beyond the configured value for the AppInstanceIdList. CPS maintains only the latest AppInstanceIds in the list according to the list size capacity that is set in the configuration. Older entries are removed/ignored. Example: Default: 10 |
||||
|
ldap.profile.overload. refreshtime.mins |
This parameter is used to specify the LDAP provide overload refresh time.
Example: Default: 30 minutes |
||||
|
enable.send.receive.queue.ttl |
This parameter enables support for TTL based queues for processing diameter messages. Example: Default: false Possible Values: true, false |
||||
|
receive.peer.queue.ttl.ms |
This parameter is used to specify maximum duration (in millisecond) an inbound diameter message is stored before being discarded. Example: Default: 20 Possible Value: integer greater than 0 |
||||
|
send.peer.queue.ttl.ms |
This parameter is used to specify maximum duration (in millisecond) an outbound diameter message is stored before being discarded. Example: Default: 20 Possible Value: integer greater than 0 |
||||
|
max.discard.tps |
This parameter is used to specify maximum rate of diameter messages discarded before disconnecting with peer. Example: Default: 400 Possible Value: integer greater than 0 |
||||
|
max.tag.size |
Determines the size (number of characters) of each individual tag in the tag list. When configured, all the tags in the tag list are of the same size. This is a one-time configuration and user must choose the value for this parameter. The value configured here must be greater than max tag size observed in the system. Example: Default: 150 Possible Range: 100 to 300
|
||||
|
tag.padding.char |
This parameter is used to define the padding character to be used for tags and reserved tags. The value configured for this parameter is only applicable when the Tag padding feature is enabled. When feature is enabled but not configured, default value # is used. You must make sure that the character decided for padding is not part of any secondary key. Example: Default: #
|
||||
|
enable.primary.parallel.queries |
Enable parallel query operation on primary members of SK DB replica-sets on local and remote sites. To enable the parallel query the following configuration must be in qns.conf file. Example: Default: false Possible Values: true, false |
||||
|
mongo.skdb.query.pool.size |
Defines the executer thread pool size. If you have a thread pool size of 6 then at a time maximum 6 threads can be invoked. Default value is 0 and if it is defined as 0 then the parallel queries do not occur. Recommended value for this parameter is 2. Example: |
||||
|
mongo.skdb.query.thread.pool.queue.size |
Provides the queue size for threads which are working on the SK DB parallel query. When you have to configure the thread pool queue size as 20 then the qns.conf file configuration must be as follows: -Dmongo.skdb.query.thread.pool.queue.size=20Default: 10 Recommended value for this parameter is 4. |
||||
|
cisco.cdr.scheduler.intervalMs |
The interval at which the scheduler thread processes the reporting data and inserts them to database. Example: Default: 10 ms It is recommended to leave the scheduler interval at default. Range: 10 ms to 100 ms Maximum CDR insert rate per QNS = batchSize*1000/ cisco.cdr.scheduler.intervalMs |
||||
|
replicationDelayMs |
Delay in milliseconds to read CDR from MongoDB and convert them to CSV files. Utilized in offsetting time sync issues between nodes. The system tuning parameter is an added measure in rare conditions of clocks going out of sync (since the nodes in the clusters are expected to be in sync) and read write occurs at the same time. 2000 ms must handle smaller clock shifts in such rare scenarios. Example: Default: 0 Possible Range: 0 to 5000 |
||||
|
useMongoCLI |
When set to true, CRD export/import calls MongoDB CLI command to export/import CRD data. When set to false, CRD uses existing export/import logic.
Example: Default: false Possible Values: true, false |
||||
|
crd.mongo.credentials |
If MongoDB authentication is enabled, configure Use encrypted password for admin user (refer MongoDB Authenticaton section in the CPS Installation Guide for VMware) Example:
|
||||
|
realtimeNotification.socketTimeout |
This parameter is used to configure socket timeout (in milliseconds) of httpclient for realtime notifications to an external http or https server. Example: Default: 1000 ms |
||||
|
useRealmAndAppIdAsKey |
This parameter should be configured to stop the 3002 – DiameterAllPeersDown alarms generated every 5 minutes. Example: Default: false Possible Values: true, false |
||||
|
useRealmAndHostAsKey |
This parameter should be configured to stop the 3001 – DiameterPeersDown alarms generated every 5 minutes. Example: Default: false Possible Values: true, false |
||||
|
udc.msisdn.digit |
This parameter should be configured to set 15 and 11 Digit MSISDN, which is sent as part of the Gx session initiation request. By configuring this parameter:
|
||||
|
filterOutDisconnectedPeers |
This parameter should be configured to filter out disconnected peers. By enabling this parameter, DOWN status messages are filtered out. Example: Default: false Possible Values: true, false |
||||
|
postgreDriver |
This parameter is used to specify the postgresql driver to be used for replication to database. Configuration is applicable only for processes that have |
||||
|
oracleDriver |
This parameter is used to specify the oracle driver to be used for replication to database. Configuration is applicable only for processes that have |
||||
|
send.Rx.ASR.For.AdditionalErrorCodes |
This parameter is used to trigger Rx-ASR for error codes such as 3004, 3002, 5002. 3004. This is by default supported in the already released version, even if the configuration is not enabled explicitly. |
||||
|
node[x].actions.send.reinit.diameter_Sy_SLR.qns_stat.error |
Erred actions count, for reinitiated SLR messages. |
||||
|
node[x].actions.send.reinit.diameter_Sy_SLR.qns_stat.success |
Success actions count, for reinitiated SLR messages. |
||||
|
node[x].actions.send.reinit.diameter_Sy_SLR.qns_stat.total_time_in_ms |
Total milliseconds of successful actions, for reinitiated SLR messages. |
||||
|
node[x].actions.send.reinit.diameter_Sy_SLR.qns_stat.avg |
Rolling five minutes average of successful executed actions, for reinitiated SLR messages. |
||||
|
node[x].actions.send.diameter_Sy_SLR.qns_stat.error |
Erred actions count, for non-reinitiated SLR messages. |
||||
|
node[x].actions.send.diameter_Sy_SLR.qns_stat.success |
Success actions count, for non-reinitiated SLR messages. |
||||
|
node[x].actions.send.diameter_Sy_SLR.qns_stat.total_time_in_ms |
Total milliseconds of successful actions, for non-reinitiated SLR messages. |
||||
|
node[x].actions.send.diameter_Sy_SLR. qns_stat.avg |
Rolling five minutes average of successful executed actions, for non-reinitiated SLR messages. |
||||
|
node[x].counters.Sy_Action_Reinitiate.qns_count |
When congestion handling feature is enabled, the counter can also be considered as messages submitted to Re-initiation queue. |
Feedback