CPS Operations Guide, Release 9.1.0 First Published: April 29, 2016 Last Modified: June 24, 2016
Total Page:16
File Type:pdf, Size:1020Kb
CPS Operations Guide, Release 9.1.0 First Published: April 29, 2016 Last Modified: June 24, 2016 Americas Headquarters Cisco Systems, Inc. 170 West Tasman Drive San Jose, CA 95134-1706 USA http://www.cisco.com Tel: 408 526-4000 800 553-NETS (6387) Fax: 408 527-0883 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. 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 use of actual IP addresses or phone numbers in illustrative content is unintentional and coincidental. Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: http:// www.cisco.com/go/trademarks. 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. (1110R) © 2016 Cisco Systems, Inc. All rights reserved. CONTENTS Preface Preface xix About this Guide xix Audience xix Additional Support xix Conventions (all documentation) xx Obtaining Documentation and Submitting a Service Request xxi CHAPTER 1 Cisco Policy Server Operations 1 Starting and Stopping 1 Starting VMs Using VMware GUI 2 Restarting the Cisco Policy Server 2 Restarting Database Services 2 Restarting QNS Services 3 Restarting All QNS Services 3 Restarting All QNS Services on a Specific VM 3 Restarting Individual QNS Services on a Specific VM 3 Restarting Services Managed by Monit 4 Restarting Other Services 4 Restarting Subversion 4 Restarting Policy Builder 4 Restarting Control Center 4 Restarting Services on Policy Director/Load Balancer (lb01 and lb02) 5 Shutting Down the Cisco Policy Server Nodes 5 lb or qns Nodes 5 pcrfclient Nodes 6 sessionmgr Nodes 6 Recovering After a Power Outage 7 CPS Operations Guide, Release 9.1.0 iii Contents Recovery Control 7 Cluster State Monitoring 7 Controlled Startup 8 Enable/Disable For All VMs in Cluster 9 Enable/Disable For Specific VM 9 Switching Active and Standby Load Balancers 9 Determining the Active Load Balancer 9 Switching Standby and Active Load Balancer 10 Multi-user Policy Builder 10 Create Users 11 Revert Configuration 11 Control Center Access 12 Add a Control Center User 12 Update Control Center Mapping 13 Multiple Concurrent User Sessions 14 Configure Session Limit 15 Configure Session Timeout 15 Important Notes 16 Backing Up and Restoring 16 Adding or Replacing Hardware 16 Adding a New Disk 17 Prerequisites 17 ESX Server Configuration 17 Target VM Configuration 18 Update the collectd process to use the new file system to store KPIs 18 Publishing Data 19 Export and Import Service Configurations 19 HAProxy 20 HAProxy Service Operations 21 Diagnostics 21 Service Commands 21 HAProxy Statistics 21 Changing HAProxy Log Level 21 Unified API Security: Access Privileges 22 Enable Authentication for Unified API 23 CPS Operations Guide, Release 9.1.0 iv Contents WSDL and Schema Documentation 24 Enabling Unified API Access on HTTP Port 8080 24 Enable SSL 27 Use of Audit 27 Audit History 28 Capped Collection 28 PurgeAuditHistoryRequests 28 AuditRequests 28 Operation 28 Initial Setup 29 Read Requests 29 APIs 30 Querying 30 Purging 30 Purge History 31 Control Center 31 PurgeAuditHistoryRequest 31 QueryAuditHistoryRequest 32 Policy Builder 33 Reporting 34 Audit Configuration 36 Pre-configured auditd 40 Policy Tracing and Execution Analyzer 41 Architecture 41 Administering Policy Traces 41 Managing Trace Rules using trace_ids.sh 41 Situations where traces are generated automatically 43 Managing Trace Results using trace.sh 43 Policy Trace Database 44 Configure Traces Database in Policy Builder 44 TACACS+ 45 Overview 45 TACACS+ Service Requirements 46 Caching of TACACS+ Users 47 Porting All-In-One Policy Builder Configuration to HA 48 CPS Operations Guide, Release 9.1.0 v Contents Prerequisites 48 Porting the Policy Builder Configuration 48 CHAPTER 2 Graphite and Grafana 51 Introduction 51 Graphite 51 Additional Graphite Documentation 52 Grafana 52 Additional Grafana Documentation 53 Configure Grafana Users using CLI 53 Add a User 53 Add Another User 53 Delete a User 54 Connect to Grafana 54 Grafana Administrative User 55 Log in as Grafana Admin User 55 Change Grafana Admin User Credentials 56 Add a Grafana User 57 Change the Role of Grafana User 59 Add an Organization 60 Move Grafana User to another Organization 62 Configure Grafana for First Use 62 Validate and Finalize Grafana Data Sources 63 Repair Data Sources 63 Migrate Existing Grafana Dashboards 64 Manual Dashboard Configuration using Grafana 66 Create a New Dashboard Manually 66 Configure Data Points for the Panel 68 Configure Useful Dashboard Panels 71 Updating Imported Templates 72 Copy Dashboards and Users to pcrfclient02 73 Configure Garbage Collector KPIs 73 Backend Changes 73 Frontend Changes 75 Export and Import Dashboards 76 CPS Operations Guide, Release 9.1.0 vi Contents Export Dashboard 77 Import Dashboard 78 Export Graph Data to CSV 80 Session Consumption Report 81 Introduction 81 Data Collection 81 Logging 82 Performance 82 Log Rotation 82 Sample Report 82 CHAPTER 3 Custom Reference Data REST API 85 Introduction 85 Limitations 85 Setup Requirements 86 Policy Server 86 Policy Builder 86 Architecture 91 MongoDB 91 Caching 91 API Endpoints and Examples 92 Query API 92 Create API 93 Update API 93 Delete API 94 Data Comparison API 94 Table Drop API 96 Export API 96 Import API 97 Snapshot POST API 97 Snapshot GET API 98 Revert API 98 Tips for Usage 99 View Logs 99 CPS Operations Guide, Release 9.1.0 vii Contents CHAPTER 4 CPS Statistics 101 Bulk Statistics Overview 101 Grafana 102 CPS Statistics 102 Overview 102 CPS Statistic Types 103 Diameter Statistics 103 LDAP Statistics 104 RADIUS Server Statistics 104 System Statistics 104 Engine Statistics 104 MOG API Statistics 104 Error Statistics Definitions 105 Bulk Statistics Collection 106 Configuring the CSV File Generation Interval 106 Retention of CSV Files 107 Configuring Logback.xml 107 Restarting the Collectd Service 107 Adding Realm Names to Diameter Statistics 107 Example CPS Statistics 108 Sample CSV Files 108 Sample Output 109 CHAPTER 5 Fault List 111 Overview 111 Configuration 112 Validation Steps 113 CHAPTER 6 Expanding an HA Deployment 115 Overview 115 Typical Scenarios When Expansion is Necessary 115 Hardware Approach to Expanding 116 High Availability Consequences 116 Adding a New Blade 116 CPS Operations Guide, Release 9.1.0 viii Contents Component (VM Node) Approach to Expanding 116 Adding Additional Component 117 CHAPTER 7 Cloning and Repartitioning sessionmgr Disks 119 Cloning and Disk Repartitioning of Sessionmgr01 VM 119 Clone Sessionmgr01 VM 119 Disk Repartitioning of Sessionmgr01 VM 120 Cloning and Disk Repartitioning of Sessionmgr02 VM 123 CHAPTER 8 CPS Commands 125 CPS Commands 126 about.sh 126 adduser.sh 126 auditrpms.sh 127 build_all.sh 127 build_etc.sh 129 build_set.sh 129 capture_env.sh 130 change_passwd.sh 130 cleanup_license.sh 131 copytoall.sh 131 diagnostics.sh 132 list_installed_features.sh 133 reinit.sh 135 restartall.sh 135 restartqns.sh 136 runonall.sh 136 service 136 session_cache_ops.sh 137 Syntax 137 Options 137 Executable on VMs 139 startall.sh 139 startqns.sh 140 statusall.sh 140 CPS Operations Guide, Release 9.1.0 ix Contents stopall.sh 142 stopqns.sh 142 summaryall.sh 143 syncconfig.sh 145 top_qps.sh 145 Diameter Synchronization Message Behavior 147 vm-init.sh 148 Glossary 149 3G systems 149 3GPP 149 4G System 149 A 149 AAA/AAR 149 ADC 149 ADN 149 AF 150 AF Session 150 AN Gateway 150 answer service template 150 API 150 application 150 Application Service Provider 150 ARAC-F 150 ARP 150 ASA 151 ASP 151 ASR 151 authorised QoS 151 AVP 151 B 151 BBERF 151 BBF