CPS User Data Convergence Guide, Release (2)

Transcription

1 CPS User Data Convergence Guide, Release (2) First Published: Last Modified: Americas Headquarters Cisco Systems, Inc. 170 West Tasman Drive San Jose, CA USA Tel: NETS (6387) Fax:

2 THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL STATEMENTS, INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS. THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT SHIPPED WITH THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY. The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB s public domain version of the UNIX operating system. All rights reserved. Copyright 1981, Regents of the University of California. NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED AS IS WITH ALL FAULTS. CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, THOSE OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE. IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING, WITHOUT LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. Cisco and the Cisco Logo are trademarks of Cisco Systems, Inc. and/or its affiliates in the U.S. and other countries. A listing of Cisco's trademarks can be found at Third party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any examples, command display output, network topology diagrams, and other figures included in the document are shown for illustrative purposes only. Any u se of actual IP addresses or phone numbers in illustrative content is unintentional and coincidental Cisco Systems, Inc. All rights reserved.

3 CONTENTS ABOUT USER DATA CONVERGENCE... 5 UDC OVERVIEW... 6 UDC ARCHITECTURE... 7 UDC FE Server... 7 INSTALLING UDC... 8 INSTALLING UDC IN OPENSTACK... 9 Post Installation Tasks for OpenStack INSTALLING UDC IN VMWARE Post Installation Tasks for VMware Installing License in UDC Admin Replica Set POST INSTALLATION TASKS Reinitializing VMs CONFIGURING UDC CONFIGURING SUBSCRIPTION SERVER NOTIFICATION CONFIGURING UDC LDAP WRITE LOOKUPS Configuring Policy Builder Configuring Control Center CONFIGURING UDC REFERENCE DATA Configuring UDC Contention Configurations UDC Contention Handling Configuring LDAP Write Server Configurations Domain Configuration Configuring UDC Configuring PCRF CONFIGURING UDC TIMER CONFIGURING SY SERVICE CONFIGURATION OBJECT NEW RETRIEVERS Bind to Subscriber AVP Code in CRD Sy OCS Service SubscriberId Identifier REFERENCE COUNTING ACROSS APNS FOR CNS NOTIFICATIONS Configuring Attribute Encoding Tables ADTMAttribute Service Configuration Object APPLICATION PARAMETERS UDC STATISTICS iii

4 Contents iv

5 About User Data Convergence This chapter includes the following topics: UDC Overview UDC Architecture 5

6 UDC Overview UDC Overview User Data Convergence (UDC) enables converged subscriber data access. It ensures the consistency of storage and data models as follows: Simplifies the overall network topology and interfaces by aggregating messaging to and from the UDR (Ud) and the OCS (Sy). Overcomes the data capacity bottleneck of a single entry point. Avoids data duplication and inconsistency across PCRF clusters within the same data center. UDC simplifies the creation of new services and facilitates service development and deployment through a common set of user data. It promotes service and network convergence to support the increasing number of new services including Internet services and UE applications. A new cache is provided in the UDC Frontend where the user data from the UDR is stored allowing for access from core and service network entities. For more information regarding other mobile configurations, see CPS Mobile Configuration Guide before referring to the CPS User Data Convergence Guide. 6

7 CPS User Data Convergence Guide UDC Architecture UDC Architecture This section describes the UDC architecture. 1. CPS receives an initiation for creation of Gx session from PCEF. 2. UDC Frontend (FE) queries the UDR attributes over LDAP messaging and fetches Sy counters from OCS Sy servers. 3. After successful user data fetch from UDC FE, CPS sends response to the Gx CCR-I request message. UDC FE Server UDC Frontend (FE) server is the new node developed as part of UDC FE implementation that can be added to the CPS clusters to interact with databases, external UDR caches, SY Diameter, Rest APIs, and SOAP interfaces when needed. UDC FE server offloads the processing of subscriber profiles from QNS nodes, stores, and maintains all profile attributes in a database cache. It communicates only over Redis messaging system to interact with QNS nodes, hence needs queues to be defined per UDC FE instance. The following two queues are added between QNS and UDC FE: UDC.FE Added on UDC FE Server to handle any incoming requests messages from the UDC Client plugin on QNS VM. UDC.<instanceId> Added to each QNS VM based on the unique instanceid it listens to on a Redis queue for incoming requests and responses from UDC FE VM. 7

8 UDC Architecture Installing UDC This chapter includes the following topics: Installing UDC in OpenStack Installing UDC in VMware Post- Installation Tasks 8

9 CPS User Data Convergence Guide Installing UDC in OpenStack Installing UDC in OpenStack Perform the following to install UDC in OpenStack: Step 1 Modify HEAT files by configuring the UDC node using the udcxx (For example, udc01, udc02 and so on.) convention as the alias and modify the NODE_TYPE field in /etc/broadhop.profile to the alias of the specific VM: udc01: type: OS::Nova::Server properties: availability_zone: { get_param: cps_az_5 } config_drive: "True" image: { get_param: base_vm_image_name } flavor: { get_param: udc_flavor_name } networks: - port: { get_resource: udc01_internal_port } user_data_format: RAW user_data: { get_resource: udc01_config } udc01_internal_port: type: OS::Neutron::Port properties: network: { get_param: internal_net_name } fixed_ips: [{ ip_address: { get_param: udc01_internal_ip }}] udc01_config: type: OS::Heat::CloudConfig properties: cloud_config: write_files: - path: /var/lib/cloud/instance/payload/launch-params 9

10 Installing UDC in OpenStack - path: /etc/broadhop.profile content: "NODE_TYPE=udc01\n" - path: /etc/sysconfig/network-scripts/ifcfg-eth0 content: str_replace: template: DEVICE=eth0 BOOTPROTO=none NM_CONTROLLED=no IPADDR=$ip params: $ip: { get_param: udc01_internal_ip } runcmd: - str_replace: template: echo $ip installer >> /etc/hosts params: $ip: { get_param: cluman_internal_ip } - str_replace: template: ipcalc -m $cidr >> /etc/sysconfig/network-scripts/ifcfg-eth0 params: $cidr: { get_param: internal_net_cidr } - ifdown eth0 && ifup eth0 - echo HOSTNAME=udc-udc01 >> /etc/sysconfig/network - hostname udc-udc01 Step 2 Add the following configuration to the ENV files for each UDC VM: udc_flavor_name: udc udc01_internal_ip: XX.XX.XX.XX 10

11 CPS User Data Convergence Guide Installing UDC in OpenStack udc02_internal_ip: XX.XX.XX.XX Step 3 Add the following configuration to the YAML files for each UDC VM using udcxx (For example, udc01, udc02 and so on.) convention for the alias field: - name: "udc-udc01" alias: "udc01" interfaces: - network: "Internal" ipaddress: "XX.XX.XX.XX" Step 4 Deploy all VMs using the following command: heat stack-create --environment-file hot-cps.env --template-file hot-cps.hot cps For more information, see Create Heat Stack section in CPS Installation Guide for OpenStack. Step 5 Use the Orchestration API to apply configurations to all VMs. For more information, see Deploy CPS section in CPS Installation Guide for OpenStack. Step 6 Verify if the post installation is in SUCCESS state in /var/log/orchestration-api-server.log in cluman. NOTE: At this point most services are not up and some post installation steps might be in FAILURE state. Step 7 Verify if the replica sets created. NOTE: At this point the services are not up and diagnostics are not clean. For more information, see Validate CPS Deployment section in CPS Installation Guide for OpenStack. Step 8 Add UDC related configuration in the Policy Builder and publish the changes. For more information, see Configuring Policy Builder section. Step 9 Restart all the VMs by running the following script: restartall.sh If the post installation steps are in FAILURE state as mentioned in Step 6, you can continue and make the necessary changes using the Patch API. For example, if shard creation fails during installation, add shards using the Patch API. For more information, see Orchestration API chapter in CPS Installation Guide for Openstack. Step 10 Verify if the services are up and running by using the following scripts: diagnostics.sh about.sh list_installed_features.sh statusall.sh 11

12 Installing UDC in OpenStack hosts.sh Post Installation Tasks for OpenStack You need to add new replica sets as described below: Step 1 Create an additional Admin replica-set for UDC using PATCH API and ignore shards configuration in the YAML file. For more information creating a Admin replica-set using PATCH API, see Orchestration API chapter CPS Installation Guide for OpenStack. Step 2 Add a new cluster in Policy Builder with the new Admin replica-set configured. The default cluster name is cluster-udc and is also defined in /etc/broadhop/udc/qns.conf and /etc/broadhop/udc_diameter_endpoint/qns.conf. If you use a different cluster name after Admin replica-set is created, change the Policy Builder cluster name and -Dcom.broadhop.run.clusterId variable in the mentioned qns.conf files to the desired name of the cluster. Step 3 Create an additional Session replica-set for UDC using PATCH API and ignore shards configuration in the YAML file. For more information creating a Session replica-set using PATCH API, see Orchestration API chapter CPS Installation Guide for OpenStack. Step 4 The default port number for the UDC Session replica-set is defined in /etc/broadhop/udc/qns.conf and /etc/broadhop/udc_diameter_endpoint/qns.conf as If you are using a different port number or different seeds after the Session replica-set is created, change the following parameters in the mentioned qns.conf files to the desired values: -Dsession.db.init.1=sessionmgr01 -Dsession.db.init.2=sessionmgr02 -Dsession.db.init.port=37717 Step 5 Run the following commands if the parameters in /etc/broadhop/udc/qns.conf and /etc/broadhop/udc_diameter_endpoint/qns.conf were modified: /var/qps/install/current/scripts/build/build_all.sh /var/qps/install/current/scripts/upgrade/reinit.sh restartall.sh Step 6 Step 7 To bring the UDC services up, create the new cluster in Policy Builder with the new Admin replica-set configured and publish. To configure shards for UDC related DBs, see Step 7 in Post Installation Tasks for VMware. 12

13 CPS User Data Convergence Guide Installing UDC in VMware Installing UDC in VMware Perform the following steps to install UDC in VMware: Step 1 Deploy Cluster Manager VM. NOTE: During installation, select the mobile option. Step 2 Modify CSV files for each UDC VM configured in /var/qps/config/deploy/csv/hosts.csv by changing the role to udc as shown below: Step 3 Add a new row for UDC VM in /var/qps/config/deploy/csv/vmspecification.csv with similar configuration as qps. The UDC VM Configuration should have the role udc as follows: Step 4 Deploy CPS and UDC VMs using the following scripts: /var/qps/install/current/scripts/import/import_deploy.sh /var/qps/install/current/scripts/build_all.sh /var/qps/install/current/scripts/deployer/deploy.sh $host For more information, see Import the Excel Information into the Cluster Manager VM section in CPS Installation Guide for VMware. Step 5 Step 6 Modify the /etc/broadhop/mongoconfig.cfg file to include the admin db and session db for udc. Create new replica sets for admin db and session db. 13

14 Installing UDC in VMware For more information, see Configure Session Manager for Database Replication section in CPS Installation Guide for VMware. Step 7 Verify and add appropriate license to the new Admin DB created: Run mongodump --host sessionmgr01 --port yyyyy --db sharding --collection licensedfeats Where yyyyy is the port number of the existing Admin DB. Run mongorestore --host sessionmgr01 --port xxxxx --db sharding --collection licensedfeats /root/dump/sharding/licensedfeats.bson Where xxxxx is the port number of the new Admin DB configured in mongoconfig.cfg. Step 8 Add UDC related configuration in the Policy Builder and publish the changes. For more information, see Configuring Policy Builder section. Step 9 Restart all the VMs by running the following script: restartall.sh Step 10 Verify if the services are up and running by using the following scripts: diagnostics.sh about.sh list_installed_features.sh statusall.sh hosts.sh Post Installation Tasks for VMware You need to add new replica sets as described below: Step 1 Create an additional Admin replica-set for UDC. For more information creating an Admin replica-set, see CPS Installation Guide for VMware. Step 2 Add a new cluster in Policy Builder with the new Admin replica-set configured. The default cluster name is cluster-udc and is also defined in /etc/broadhop/udc/qns.conf and /etc/broadhop/udc_diameter_endpoint/qns.conf. If you use a different cluster name after Admin replica-set is created, change the Policy Builder cluster name and -Dcom.broadhop.run.clusterId variable in the mentioned qns.conf files to the desired name of the cluster. Step 3 Create an additional Session replica-set for UDC. For more information creating a Session replica-set, see CPS Installation Guide for VMware. Step 4 The default port number for the UDC Session replica-set is defined in /etc/broadhop/udc/qns.conf and /etc/broadhop/udc_diameter_endpoint/qns.conf as If you are using a different port number or different seeds after the Session replica-set is created, change the following parameters in the mentioned qns.conf files to the desired values: 14

15 CPS User Data Convergence Guide Installing UDC in VMware -Dsession.db.init.1=sessionmgr01 -Dsession.db.init.2=sessionmgr02 -Dsession.db.init.port=37717 Step 5 Run the following commands if the parameters in /etc/broadhop/udc/qns.conf and /etc/broadhop/udc_diameter_endpoint/qns.conf were modified: /var/qps/install/current/scripts/build/build_all.sh /var/qps/install/current/scripts/upgrade/reinit.sh restartall.sh Step 6 Step 7 To bring the UDC services up, create the new cluster in Policy Builder with the new Admin replica-set configured and publish. Adding shards for UDC-related replica-sets should be done through OSGI commands. a) Verify CPS application is running on both the sites (pcrfclient01 and pcrfclient02) and without any application errors. By executing diagnostics.sh script you can get the diagnostics of application. The diagnostics.sh output should not contain any application errors b) Verify whether shard command is available in OSGI console. From pcrfclient01, login as root user into the OSGI console and run help. telnet udc osgi> help c) You will find the following shard command: addshard seed1[,seed2] port db-index For first session cache replica set, execute the following commands: telnet udc addshard sessionmgr01,sessionmgr addshard sessionmgr01,sessionmgr addshard sessionmgr01,sessionmgr rebalance migrate disconnect 15

16 Installing UDC in VMware y For second session cache replica set, execute the following commands: telnet udc addshard sessionmgr03,sessionmgr addshard sessionmgr03,sessionmgr addshard sessionmgr03,sessionmgr addshard sessionmgr03,sessionmgr rebalance migrate disconnect y For more information about creating new replica-sets, see CPS Installation Guide for VMware or CPS Installation Guide for OpenStack and to add license in the new Admin replica-set, see Installing License in UDC Admin Replica Set. Installing License in UDC Admin Replica Set Perform the following steps to install license in UDC Admin replica-set: Step 1 Step 2 Modify /etc/broadhop/qns.conf such that the -Dcom.broadhop.run.clusterId parameter value corresponds to the UDC-specific cluster (the default is cluster-udc). Run the following command to rebuild the /etc/broadhop folder in the Cluster Manager VM: /var/qps/install/current/scripts/build/build_all.sh Step 3 Run the following commands to push the license to the pcrfclient01/02 VMs: ssh pcrfclient01 /etc/init.d/vm-init and ssh pcrfclient02 /etc/init.d/vm-init Step 4 Run the following commands to restart the LMGRD process: killall -9 lmgrd 16

17 CPS User Data Convergence Guide Installing UDC in VMware service lmgrd start Step 5 Revert the -Dcom.broadhop.run.clusterId in /etc/broadhop/qns.conf to the previous value and run the following commands: /var/qps/install/current/scripts/build/build_all.sh /var/qps/install/current/scripts/upgrade/reinit.sh restartall.sh 17

18 Post Installation Tasks Post Installation Tasks You need to reinitialize all VMs after installing UDC VMs. Reinitializing VMs Perform the following steps to reinitialize all VMs to increase user process limits set by linux kernel: NOTE: Run the following commands from the installer/cluster manager (cluman). Step 1 Modify 'qns-nproc:soft': domain => 'qns', type => 'soft', item => 'nproc', value => 4096 from /etc/puppet/modules/qps/manifests/base.pp as follows: 'qns-nproc:soft': domain => 'qns', type => 'soft', item => 'nproc', value => 6144 Step 2 Run the following command to build images: /var/qps/install/current/scripts/build_all.sh Step 3 Run the following command to reinitialize all VMs: /var/qps/install/current/scripts/upgrade/reinit.sh NOTE: After applying the MoP, the value max user processes in lb01/lb02 are displayed as follows: # ssh lb01 "su -c 'ulimit -u' qns" 6144 Step 4 Run the following command to restart services: /var/qps/bin/control/restartall.sh NOTE: You need to reinitialize all VMs after following the procedures outlined in the UDC MoPs (CPS User Data Convergence Migration MoP for VMWare or CPS User Data Convergence Migration MoP for OpenStack.) In CPS , UDC Installation is supported on Openstack and VMWare. The In-Service and Out-of-service software upgrade will be supported in later releases. 18

19 CPS User Data Convergence Guide Post Installation Tasks Configuring UDC This chapter includes the following topics: Configuring Subscription Server Notification Configuring UDC LDAP Write Lookups Configuring UDC Reference Data 19

20 Configuring Subscription Server Notification Configuring Subscription Server Notification UDC communicates with Subscription Servers to read and modify subscriber information. In order to give the correct subscriber information to PCRF, the UDC server needs to know the changes in subscriber LDAP attributes in the subscription server. The UDC server can get this information through notifications from the subscription server. In order to enable these notifications, configure UD interface and add services for each subscriber. The UDC server will receive notifications from the subscription server for changes in the attributes configured in the service. Perform the following steps to configure UD interface with information about the subscription server to receive notifications: Step 1 Step 2 In Policy Builder, navigate to Reference Data. Under Plugin Configuration select U D Interface Configuration. Step 3 Enter the values in each field as described in the following table: Parameter Front End Host Original Entity Service Name D N Prefix for Subscription D N Description This string will be appended to the hostname of the UDC VM and become the Front End ID. Optional. Parameter included as per 3GPP specs. Optional. Parameter included as per 3GPP specs. Distinguished Name Prefix that is added in front of the Distinguished Name. For example, D N is ou=accounts,o=profile and the prefix is 20

21 CPS User Data Convergence Guide Configuring Subscription Server Notification Filter for Notification HTTP Server Status Code to Ignore The Retry Subscription Server mobileprefix. CPS adds MSISDN in Subscription message D N. The final DN is mobileprefix= ,ou=accounts,o=profile To load the UDC cache entry. For example, mobileprefix= ,ou=accounts,o=profile. The value is used to load the subscriber profile. NOTE: This is applicable in case of the notification message. UDC sends subscription message over HTTP. On receiving HTTP Status Code mentioned in the list, it will ignore to retry subscription message on next priority server. NOTE: CPS will not retry on 2xx status codes. List of different subscription servers with its priority level. UDC will first attempt to send a subscription message to the highest priority server. If the subscription server fails to send a message, UDC will try the server with the second highest priority, and so on. If UDC receives a message with a HTTP status code that is specified under the HTTP Server Status Code to Ignore The Retry field, it will not retry to send the message to any other subscription server. NOTE: CPS will not retry on 2xx status codes. The higher the number, the higher the priority. Step 4 Step 5 Step 6 Navigate to Services to configure subscription service. Add a Service Configuration named Subscription. Add the attribute names. 21

22 Configuring Subscription Server Notification While adding multiple attribute names separate each of them with commas. For example: accountstatus,paymenttpye,throttlestatus If there are any changes to these attributes in the subscription server, UDC server will get a notification from the subscription server regarding that change. As per the 3GPP specs T_129335, there are the following two types of notifications: notifysubscribingfe notifyanyfe The default value is notifysubscribingfe. As per the 3GPP specs T_129335, there are the following three types of Notification Condition: add delete modify In this release, only modify is supported. 22

23 CPS User Data Convergence Guide Configuring UDC LDAP Write Lookups Configuring UDC LDAP Write Lookups UDC communicates to LDAP servers to read as well as modify (add, replace, delete) subscriber information. To set the conditions for each LDAP operation you must configure UDC LDAP Write Lookups. Configuring UDC LDAP Write Lookups includes the following tasks: Configuring Policy Builder Configuring Control Center Configuring Policy Builder Perform the following steps to configure Policy Builder: Step 1 Step 2 Step 3 In Policy Builder, navigate to Reference Data. Under Custom Reference Data Tables select Search Table Groups. Add a new search table group. The table must have the following columns: PreviousValue Previous value of the attribute. NewValue New value of the attribute. Operation LDAP Operation. An attribute name value The attribute to be changed by the LDAP operation. The values of the PreviousValue and NewValue columns depends on the LDAP operations. ADD Only fill in NewValue column with the value to be added for that attribute. DELETE Only fill in PreviousValue column with the value of the attribute that will be deleted. REPLACE Fill in both NewValue and PreviousValue columns (replace PreviousValue with NewValue). 23

24 Configuring UDC LDAP Write Lookups REPLACE_ALL Only fill in NewValue column. Step 4 Step 5 Under UDC Reference Data select Udc Ldap Write Lookups. Add a UDC LDAP Write Lookup configuration. Each row represents a Search Table Group and its columns. Configuring Control Center Perform the following steps to configure Control Center: Step 1 Step 2 In Control Center, navigate to Configuration. Add the values for the search table group that has been defined in Policy Builder. These values represent the mapping of an attribute name and value to the LDAP operation, in the case of those values. As described earlier, the values of the PreviousValue and NewValue columns depend on the LDAP operations. Refer to Step 3 in Configure Policy Builder for details. 24

25 CPS User Data Convergence Guide Configuring UDC Reference Data Configuring UDC Reference Data This section includes the following topics: Configuring UDC Contention Configurations Configuring LDAP Write Server Configurations Domain Configuration Configuring UDC Contention Configurations When two events come into the UDC server within a short period of time, they go into a contention state. The server must decide which event to execute. In order for the server to know which events to execute in a contention, priorities are assigned to the events. To set these event priorities during contention and non-contention scenarios, you need to add UDC Contention Configuration. Perform the following steps to configure UDC Contention Configuration: Step 1 Step 2 In Policy Builder, navigate to Reference Data. Under Udc Reference Data select Udc Contention Configuration. Step 3 Add a UDC Contention Configuration. NOTE: In the case when two events come into UDC within a short period of time (contention), the server must know which event will be executed. 25

26 Configuring UDC Reference Data Step 4 Enter the values in each field as described in the following tables: UDC Contention Configuration Parameters Parameter Event Contention Period in Minutes Priority Configuration During Non Contention Priority Configuration During Contention Description The period of time during which an event can be in contention. The default is duration is set to 15 minutes. Add priorities for events during a non-contention scenario. NOTE: If a message comes into the server and 16 minutes later another message comes into the server, they will not go into contention and the server then follows priorities defined under Priority Configuration During Non-Contention table. This example assumes a contention period of 15 minutes. Add priorities in the case of a contention. Add the priority for that Event under the Priority column. The priority can be any number. The lower the number, the higher the priority. Event Parameters Parameter UDR_READ UDR_NOTIFY SY_SLA SY_SNR Description LDAP read event from the LDAP Server. SOAP notification request for subscribed attributes from the subscription server. Spending limit answer from Sy OCS server. Spending status notification request from the Sy OCS server. UDC Contention Handling The UDC Contention table can be used as keys in CRD tables in QNS VM to derive event-based attributes and values. These derived attributes and values can then be used on PCRF (QNS VM) to configure multiple use cases. The QoS Throttling based on Contention Events is a use case described as follows: QoS Throttling Based on Contention Events In order to configure attributes and values that are derived from a contention event, you need to create a CRD that represents the mapping of the event to the attributes and values. The CRD is configured to have a UDC-EVENT column that is bound to the subscriber AVP code CURRENT_UDC_EVENT in order to get the event types that are reported by the UDC Server. These are the events which have been configured in the UDC Contention Configuration. CURRENT_UDC_EVENT is a policy-derived AVP which maps the current event reported by UDC. The other columns featured are Sy- and Ldap-Attribute. These will be the Sy counter and LDAP attribute that are used to derive the Cached Attribute and Cached Value. 26

27 CPS User Data Convergence Guide Configuring UDC Reference Data In Control Center, the value of the cached-attribute User_QoS is derived based on the events reported by the UDC server. The User_QoS value can be used as initiators for the conditions for throttling the QoS. This particular CRD allows CPS to throttle QoS based on the contention Events. Configuring LDAP Write Server Configurations The LDAP Write Server Configuration allows the UDC server to map requests to its corresponding LDAP Server. For a particular request, the LDAP server that UDC has to write to depends on the AVP APN names and values from the UE. To get the AVP APN names and values from the UE, a new Use Case Template is configured. Perform the following steps to map requests to configure LDAP Write Server Configurations: Step 1 Step 2 In Policy Builder, navigate to Reference Data. Under Udc Reference Data select Ldap Write Server Configurations. 27

28 Configuring UDC Reference Data The following table describes the Apn To LDAP Server Mapping parameters: Parameter Apn Avp Name Apn Avp Value LDAP Server Description Name of the AVP. Value of the AVP Specific LDAP server. This mapping maps an APN AVP Name and an APN AVP value to a specific LDAP Server. For example, if a particular request comes into the UDC FE from the UDC Client with APN AVP Name APN and APN AVP Value PHONE, the UDC FE needs to write to the LDAP Server named Sync. The LDAP Server should have been added under Ldap Server Sets. Step 3 Step 4 Step 5 Step 6 To configure base LDAP Write Server Base Dn, modify request message and enter the base DN value in Ldap Write Server Base Dn. Navigate to Services to create a new service for this mapping. Create a new Use Case Template. Go to the Actions tab. Step 7 Step 8 Add and select a new action SyncLocalAttributes. Enter Attribute Name and Attribute Value. The values are configured in the Use Case Template. The attribute value can also be pulled from values in the CRD by setting the Pull value from column to a CRD table. 28

29 CPS User Data Convergence Guide Configuring UDC Reference Data Domain Configuration Configuring Domain enables LDAP connections from UDC and includes the following tasks: Configuring UDC Configuring PCRF Configuring UDC Perform the following steps to configure UDC: Step 1 Step 2 In Policy Builder, navigate to Services. Select Domain. Step 3 Step 4 Step 5 Add a new domain. Go to the Additional Profile Data tab. Select Generic Ldap Search from the drop down. This will be the domain used by the UDC FE. NOTE: Under Profile Mappings table, the External Code can be any LDAP attribute or Sy. The Mapping Type that is supported by UDC currently is SubscriberAttribute (no other Mapping Type is supported). Configuring PCRF Perform the following steps to configure PCRF: Step 1 Step 2 In Policy Builder, navigate to Services. Select Domain. 29

30 Configuring UDC Reference Data Step 3 Step 4 Add a new domain. Go to the Additional Profile Data tab. Step 5 Select UDC Profile from the drop down. This will be the domain used by the PCRF part of CPS. NOTE: Similar to the Generic Ldap Search option, under Profile Mappings table, the External Code can be any LDAP attribute or Sy. The Mapping Type that is supported by UDC currently is SubscriberAttribute (no other Mapping Type is supported). 30

31 CPS User Data Convergence Guide Configuring UDC Timer Configuring UDC Timer You can configure UDC FE Configurations under Systems > Cluster > Plugin Configurations > UDC FE Configuration. The following table describes the parameters under UDC FE Configuration: Parameter Subscription Expiry Timer In Minute Session Hold on Timer In Minute Udc Stale Session Timer In Minute Failed Ldap Write Backoff Timer In Minute Description This is for the Subscription Notification Server. PCRF will send a "Subscription" request once every x minutes, where x is the subscription expiry timer. If the session is terminated in PCRF, PCRF will send an "Unsubscribe" (opposite of "Fetch") to UDC FE. This is between CPS and UDC FE. In the case that CPS sends an "Unsubscribe" to UDC FE, UDC FE will not delete the session for x minutes, where x is the hold on timer. If the session is refreshed (as in a new request comes for that particular subscriber), it will not be terminated. For each x mins, where x is the Udc Stale Session Timer. UDC sends update request to UDC FE. If Gx session is not available on UDC, UDC sends unsubscribe request to UDC FE. If UDC fails to send the LDAP Modify after exhausting all the retries configured, then UDC stores the failed LDAP Modify request message for future attempt to retry the operation. UDC waits for the amount of time configured in LDAP Backoff Timer before resending the stored LDAP Modify. Default value is

32 Configuring Sy Service Configuration Object Configuring Sy Service Configuration Object CPS provides the following configurable options in SpendingLimitReport Sy service: Configurable option to send periodic keep-alive SLR-Intermediate messages o o Update the keep-alive timer upon reception of an Sy message Disregard a Sy Message and send SLR-Intermediate at set intervals Ability to send specific counters (or no counters) in o o o SLR-Initial SLR-Intermediate Unknown learned counters Configurable option to specify the Subscription-Id AVP in any Sy Message o IMSI, MSISDN, IMSI and MSISDN Ability to receive an Unknown in a SNR that was not initially exchanged during Sy Session establishment Configure the SpendingLimitReport Sy service configuration object. For more information about SpendingLimitReport service configuration object, see CPS Mobile Configuration Guide. 32

33 CPS User Data Convergence Guide New Retrievers New Retrievers The new retrievers have been added to the following options: Bind to Subscriber AVP Code in CRD Sy OCS Service SubscriberId Identifier Bind to Subscriber AVP Code in CRD The following three new retrievers can be used for the Bind to Session/Policy State Field binding in the Custom Reference Data tables: UDC APN Retriever UDC IMSI Retriever UDC MSISDN Retriever Sy OCS Service SubscriberId Identifier In the Sy OCS Service, MSISDN and IMSI can be retrieved using the following on UDC VM and UDC FE: UDC MSISDN Retriever UDC IMSI Retriever 33

34 New Retrievers 34

35 CPS User Data Convergence Guide Reference Counting Across APNs for CNS Notifications Reference Counting Across APNs for CNS Notifications CPS is enhanced to support tracking of services which are activated per subscriber across multiple data centers through encoded LDAP attributes. Configuring Attribute Encoding Tables The Attribute Encoding Table specifies the encoding of the encoded LDAP Attributes. Perform the following steps to configure the Attribute Encoding Table: Step 1 Step 2 Step 3 In Policy Builder, navigate to Reference Data. Navigate to Udc Reference Data. Create a new Attribute Encoding Tables configuration. The Attribute Field Size Configuration table specifies the bit length size for each attribute field of the encoded LDAP Attribute value. You can configure the following fields: 1. Acknowledged Mode Bearer QCI 2. Un Acknowledged Mode Bearer QCI The following table describes the supported attributes: Supported Attributes Field Default Bit Length Size Configurable FrontEndID 8 Yes LogicalApn 8 Yes 35

36 Reference Counting Across APNs for CNS Notifications AckMode 3 Yes UnAckMode 3 Yes ServiceInitiator 8 Yes AutoIncrServiceNumber 8 No Adtm_active No All the above attribute values are combined into the encoded LDAP Attribute value and sent to the LDAP server on an LDAP Write operation. The Front End Id table specifies the different Front End Ids/unique site names for the encoded LDAP Attribute value. The number of Front End Ids that can be configured depending on the bit size specified in the FrontEndID row in the Attribute Field Size Configuration table. For example, if the bit length size of Front End Id is 8, there can be 2 8 possible Front End Ids specified in the Front End Id table. The Logical Apn table specifies the different Logical APN values for the encoded LDAP Attribute value. Similar to the Front End Id table, the number of Logical APN values that can be configured depends on the bit size specified in the LogicalApn row in the Attribute Field Size Configuration table. For example, if the bit length size of Logical APN is 8, there can be 2 8 possible Logical APN values specified in the Logical Apn table. The Service Initiator table specifies each of the services that are initiated and its corresponding encoded LDAP Attribute value. The allowed values PCEF, MOG, and SD for each Service Initiator are all in the power of two. For example, if the PCEF encoded value is 1, the binary value is when the bit size for Service Initiator is 8 bits. If the MOG encoded value is 2, the binary value is If both the PCEF and MOG services are initiated, then the final Service Initiator encoded value is which is a combination of the two. If both PCEF and SD services are initiated, the final Service Initiator encoded value is If the bit length size of Service Initiator is 8 bits, there can be eight possible services configured in this table. The Service Initiators values are derived internally. The AutoIncrServiceNumber value is derived internally and is only sent if the MOG and SD services are enabled. 36

37 CPS User Data Convergence Guide Reference Counting Across APNs for CNS Notifications For example: If only one MOG service is enabled, the AutoIncrServiceNumber is 1. If two MOG services are enabled, the AutoIncrServiceNumber is 2. If two MOG services and one SD service are enabled, the AutoIncrServiceNumber value is 3. This number does not increment on any PCEF services. ADTMAttribute Service Configuration Object The ADTMAttribute service configuration object enables encoding of LDAP attributes. The following table describes ADTMAttribute service configuration parameters: Service Initiator Value Attribute Name Logical Apn Front End Id Description Attribute name for the specific service. Specifies the different Logical APN values for the encoded LDAP Attribute value. Specifies the different Front End Ids/unique site names for the encoded LDAP Attribute value. 37

38 Application Parameters Application Parameters The following table describes the application parameters. These parameters can be added inside the qns.conf file. Parameter udcsubscriptionrequesttimeout udc.sy.gx.result.code.based.action=true subscription.backoff.time.mins=<mins> udc.delay.slri.update=50 shard.monitor.semaphore=udc.session.count.index Description Read time-out for subscription server (time is in milliseconds). Enable the Sy result code based action if true. If UDC fails to send the Subscription request, then it will wait for this much time to resend subscription again. Default value is 10 minutes. The example configuration adds a delay of 50 ms in sending UDC update message to PCRF after Sy SLA response from OCS. If this parameter is not configured, then no delay is added in sending UDC update message to PCRF. Defines the semaphore to be used between UDC VMs deployed to query sharding db for generation of statistics related to number of UDC_FE sessions currently active. This parameter should be configured in /etc/broadhop/udc/qns.conf. 38

39 CPS User Data Convergence Guide Application Parameters UDC Statistics The following table describes the UDC statistics: Statistics Name Description Source UDC_FE_FETCH_REQ Number of CCR-I leads to one subscribe request. Stats UDC_UNSUBSCRIBE_REQ Number of CCR-T leads to one unsubscribe request. Stats UDC_MODIFIY_REQ Number of LDAP Write operation. Stats UdcUnSubscribeRequestMessage Number of UDC unsubscribe profile request on UDC. Stats UdcFeRequestMessage Number of UDC fetch profile request. Stats UdcFeUpdateRequestMessage Number of UDC FE update request. Stats UdcAPIRequest Number of UDC API calls. Stats UdcQuery Number of queries to UDC VM. Stats UDC_FE_NOTIFICATION_REQ Number of notification request. UDC_FE_SUBSCRIPTION_SUB_REQ UDC_FE_UPDATE_REQ UDC_FE_SUBSCRIPTION_UN_SUBREQ Number of subscription subscribe requests to the subscription server. Number of counter update request from UDC FE to UDC Client. Number of subscription unsubscribe request to the subscription server. UDC_SESSION_DELETE Number of UDC session deletion. UDC_FIRST_LOOK_UP_SUCCESSFUL UDC_FIRST_LOOK_UP_NO_ENTRY_FOUN D This counter gets incremented when subscriber finds existing UDC session. This counter gets incremented when subscriber cannot find existing UDC session. UDC_SESSION_CREATE Number of UDC sessions created. DROP_EVENT_*_DURING_CONTENTION The counter to indicate the number of dropped events during contention. The asterisk ( * ) in this counter represents the different types of events: DROP_EVENT_ UDR_READ _DURING_CONTENTION DROP_EVENT_ UDR_NOTIFY _DURING_CONTENTION 39

40 Application Parameters DROP_EVENT_*_DURING_NON_CONTENT ION Udc_Get_Profile_Reponse_400 Udc_Get_Profile_Reponse_500 Udc_Get_Profile_Reponse_200 Udc_Get_Profile_Reponse_xxx Udc_Delete_Profile_Reponse_400 Udc_Delete_Profile_Reponse_500 Udc_Delete_Profile_Reponse_200 Udc_Delete_Profile_Reponse_xxx Udc_Sync_Profile_Reponse_200 Udc_Sync_Profile_Reponse_xxx Udc_Sync_Ocs_Reponse_200 DROP_EVENT_SY_SLA_DURING_CONTENTIO N DROP_EVENT_ SY_SNR _DURING_CONTENTION The counter to indicate the number of dropped events during non-contention. The asterisk ( * ) in this counter represents the different types of events: DROP_EVENT_ UDR_READ _DURING_NON_CONTENTION DROP_EVENT_ UDR_NOTIFY _DURING_NON_CONTENTION DROP_EVENT_SY_SLA_DURING_NON_CONT ENTION DROP_EVENT_ SY_SNR _DURING_NON_CONTENTION Number of UDC GET Profile responses with a Bad Request Error Code. Number of UDC GET Profile responses with a Command Failed Error Code. Number of UDC GET Profile responses with a Success Code. This means the operation is successful. Number of UDC GET Profile responses with xxx HTTP Status Code. Number of UDC DELETE Profile responses with a Bad Request Error Code. Number of UDC DELETE Profile responses with a Command Failed Error Code. Number of UDC DELETE Profile responses with a Success Code. Number of UDC DELETE Profile responses with xxx HTTP Status Code. Number of UDC SYNC UDC Profile responses with a Success Code. Number of UDC SYNC UDC Profile responses with xxx HTTP Status Code. Number of UDC SYNC OCS Profile responses with a Success Code. Udc_Sync_Ocs_Reponse_xxx Number of UDC SYNC UDC Profile responses with 40

41 CPS User Data Convergence Guide Application Parameters Udc_Soap_UnSubscribe_Request_400 Udc_Soap_UnSubscribe_Request_500 Udc_Soap_UnSubscribe_Request_200 Udc_Soap_UnSubscribe_Request_xxx Udc_Soap_Subscribe_Response_400 Udc_Soap_Subscribe_Response_500 Udc_Soap_Subscribe_Response_200 Udc_Soap_Subscribe_Response_xxx UDC_FE_SUBSCRIPTION_SUB_REQ_TIME OUT UDC_FE_SUBSCRIPTION_SUB_REQ_FAILE D UDC_FE_SUBSCRIPTION_UN_SUBREQ_TI MEOUT UDC_FE_SUBSCRIPTION_UN_SUBREQ_FAI LED UD_SN_SUBSCRIPTION_REQ_FAILED_<IP> _<PORT> UD_SN_SUBSCRIPTION_REQ_SUCCESSFU L_<IP>_<PORT> UD_SN_SUBSCRIPTION_REQ_FAILED_<IP> _<PORT>_<STATUS CODE> set_<set number of admin db>_session_type_udc_fe.records a xxx HTTP Status Code. Number of SOAP Unsubscribe request with Bad Request Error Code. Number of SOAP Unsubscribe request with Command Failed Error Code. Number of SOAP Unsubscribe request with Success Code. Number of SOAP Unsubscribe request with xxx HTTP Status Code. Number of SOAP Subscribe request with Bad Request Error Code. Number of SOAP Subscribe request with Command Error Code. Number of SOAP Subscribe request with Success Code. Number of SOAP Subscribe request with xxx HTTP Status Code. Number of timed-out Subscription Subscribe request to the Subscription Server. Number of failed Subscription Subscribe request to the Subscription Server. Number of timed-out Subscription Unsubscribe request to the Subscription Server. Number of failed Subscription Unsubscribe request to the subscription server. Failed Subscription Transaction counter on IP address and port due to time-out or network unreachability. Successful Subscription Transaction counter on IP address and port. Failed Subscription Transaction counter on IP address and port due to time-out or network unreachability, with Error Status Code. Count of session type UDC_FE in active session DB partition per admin set. This is generated in pcrfclient. 41