Configuration and Administration of the IM and Presence Service on Cisco Unified Communications Manager, Release 11.5(1) First Published: 2016-06-08 Last Modified: 2020-06-09 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 © 2020 Cisco Systems, Inc. All rights reserved. CONTENTS Revision History xvii PART I Deployment Planning 18 CHAPTER 1 IM and Presence Service Features and Functions 1 IM and Presence Service Components 1 Main Components 1 SIP Interface 2 AXL/SOAP Interface 3 LDAP Interface 3 XMPP Interface 3 CTI interface 4 Cisco IM and Presence Data Monitor 4 IM and Presence Service Feature Deployment Options 5 Deployment models 7 High Availability for Single-Node, Multiple-Node, and IM-Only Deployments 7 Presence Redundancy Groups and High Availability 7 Clustering Over WAN 8 User Assignment 8 End User Management 9 Availability and Instant Messaging 9 Chat 9 IM Forking 10 Offline IM 10 Broadcast IM 10 Chat Rooms on IM and Presence Service 10 Configuration and Administration of the IM and Presence Service on Cisco Unified Communications Manager, Release 11.5(1) iii Contents Chat Room Limits 11 File Transfer 11 Important Notes About IM and Presence Service and Chat 12 IM Compliance 12 Presence Data Overview 12 Manual Presence 12 System Determined Presence 13 Enterprise Groups 13 LDAP Integrations 14 Third-Party Integrations 15 Third-Party Client Integration 16 Supported Third-Party XMPP Clients 16 License Requirements for Third-Party Clients 17 XMPP Client Integration on Cisco Unified Communications Manager 17 LDAP Integration for XMPP Contact Search 17 DNS Configuration for XMPP Clients 17 IPv6 Support 18 IM Address Schemes and Default Domain 18 IM Address Using UserID@Default_Domain 19 IM Address Using Directory URI 19 IM Address Examples 20 IM Address Integration with Cisco Unified Communications Manager 20 UserID@Default_Domain Integration with Cisco Unified Communications Manager 20 Directory URI Integration with Cisco Unified Communications Manager 21 Multiple IM Domain Management 21 Security 21 SAML Single Sign-On 21 CHAPTER 2 Multinode Scalability and WAN Deployments 23 Multinode Scalability Feature 23 Multinode Scalability Requirements 23 Scalability Options for Deployment 23 Cluster-Wide DNS SRV 25 Local Failover 25 Configuration and Administration of the IM and Presence Service on Cisco Unified Communications Manager, Release 11.5(1) iv Contents Presence Redundancy Group Failure Detection 25 Method Event Routing 26 External Database Recommendations 26 Clustering Over WAN for Intracluster and Intercluster Deployments 26 Intracluster Deployments Over WAN 26 Multinode Configuration for Deployment Over WAN 27 Intercluster Deployments 27 Intercluster Deployments Over WAN 27 Intercluster Peer Relationships 27 Intercluster Router to Router Connections 28 Node Name Value for Intercluster Deployments 28 IM and Presence Default Domain Value for Intercluster Deployments 29 IM Address Scheme for Intercluster Deployments 29 Secure Intercluster Router to Router Connection 29 CHAPTER 3 IM and Presence Service Planning Requirements 31 Multinode Hardware Recommendations 31 Intercluster Hardware Recommendations 32 Supported End Points 32 LDAP Directory Servers Supported 33 WAN Bandwidth Requirements 33 WAN Bandwidth Considerations 33 Multinode Scalability and Performance 34 Multinode Scalability Requirements 34 Multinode Performance Recommendations 34 User License Requirements 34 DNS Domain and Default Domain Requirements 35 CHAPTER 4 Workflows 37 Basic Deployment with High Availability Workflow 37 Basic Deployment with High Availability and IP Phone Presence Workflow 39 Federation Deployment Workflow 42 PART II System Configuration 47 Configuration and Administration of the IM and Presence Service on Cisco Unified Communications Manager, Release 11.5(1) v Contents CHAPTER 5 Cisco Unified Communications Manager configuration for integration with IM and Presence Service 49 User and Device Configuration on Cisco Unified Communications Manager before Integration Task List 49 Configure Inter-Presence Group Subscription Parameter 51 SIP Trunk Configuration on Cisco Unified Communications Manager 52 Configure SIP Trunk Security Profile for IM and Presence Service 52 Configure SIP Trunk for IM and Presence Service 52 Configure Phone Presence for Unified Communications Manager Outside of Cluster 54 Configure TLS Peer Subject 54 Configure TLS Context 54 Verify Required Services Are Running on Cisco Unified Communications Manager 55 CHAPTER 6 IM and Presence Service Network Setup 57 Configuration changes and service restart notifications 57 Service Restart Notifications 57 Cisco XCP Router Restart 58 Restart Cisco XCP Router Service 58 Restarting Services with High Availability 58 DNS Domain Configuration 59 IM and Presence Service Clusters Deployed in Different DNS Domain or Subdomains 60 IM and Presence Service Nodes Within Cluster Deployed in Different DNS Domains or Subdomains 60 IM and Presence Service Nodes Within Cluster Deployed in DNS Domain That is Different Than the Associated Cisco Unified Communications Manager Cluster 61 Specify DNS Domain Associated with Cisco Unified Communications Manager Cluster 62 IM and Presence Service Default Domain Configuration 63 IM Address Configuration 64 IM Address Configuration Requirements 64 UserID@Default_Domain IM Address Interactions and Restrictions 65 Directory URI IM Address Interactions and Restrictions 65 Configure IM Address Task Flow 66 Stop Services 67 Configuration and Administration of the IM and Presence Service on Cisco Unified Communications Manager, Release 11.5(1) vi Contents Assign IM Addressing Scheme 68 Restart Services 69 Domain Management for IM and Presence Service Clusters 70 IM Domain Management Interactions and Restrictions 71 View IM Address Domains 71 Add or Update IM Address Domains 72 Delete IM Address Domains 73 Routing Information Configuration on IM and Presence Service 73 Routing Communication Recommendations 73 Configure MDNS Routing and Cluster ID 74 Configure Routing Communication 74 Configure Cluster ID 75 Configure Throttling Rate for Availability State Change Messages 76 IPv6 Configuration 76 IPv6 Interactions and Restrictions 77 Enable IPv6 on Eth0 for IM and Presence Service 78 Disable IPv6 on Eth0 for IM and Presence Service 79 Enable IPv6 Enterprise Parameter 79 Configure Proxy Server Settings 80 Services on IM and Presence Service 80 Turn On Services for IM and Presence Service 80 CHAPTER 7 IP Phone Presence Setup 83 Static Route Configuration on IM and Presence Service 83 Route Embed Templates 83 Configure Route Embed Templates on IM and Presence Service 84 Configure Static Routes on IM and Presence Service 85 Presence Gateway Configuration on IM and Presence Service 88 Presence Gateway Configuration Option 88 Configure Presence Gateway 88 Configure SIP Publish Trunk on IM and Presence Service 89 Configure Cluster-Wide DNS SRV Name for SIP Publish Trunk 89 CHAPTER 8 LDAP Directory Integration 91 Configuration and Administration of the IM and Presence Service on Cisco Unified Communications Manager, Release 11.5(1) vii Contents LDAP Server Name, Address, and Profile Configuration 91 LDAP Directory Integration with Cisco Unified Communications Manager Task List 91 Secure Connection Between Cisco Unified Communications Manager and LDAP Directory 92 Configure LDAP Synchronization for User Provisioning 92 Upload LDAP Authentication Server Certificates 94 Configure LDAP Authentication 94 Configure Secure Connection Between IM and Presence Service and LDAP Directory 95 Verify LDAP Directory Connection Using System Troubleshooter 96 LDAP Directory Integration for Contact Searches on XMPP Clients 96 LDAP Account Lock Issue 97 Configure LDAP Server Names and Addresses for XMPP Clients 97 Configure LDAP Search Settings for XMPP Clients 99 Turn On Cisco XCP Directory Service 101 CHAPTER 9 Security Configuration on IM and Presence Service 103 Security Setup Task List 103 Create Login Banner 105 Enhanced TLS Encryption on IM and Presence Service 105 RSA Security Certificate Support for Increased Key Lengths 107 Multi-Server Certificate Overview 107 IM and Presence Service Certificate Types 107 Certificate Exchange Configuration Between IM and Presence Service and Cisco Unified Communications Manager 110 Prerequisites for Configuring Security 110 Import Cisco Unified Communications Manager Certificate to IM and Presence Service 110 Restart SIP Proxy Service 111 Download Certificate from IM and Presence Service 111 Upload IM and Presence Service Certificate to Cisco Unified Communications Manager 112 Restart Cisco Unified Communications Manager Service 112 Multi-Server CA Signed Certificate Upload to IM and Presence Service 113 Single-Server CA Signed Certificate Upload to IM and Presence Service 113 CA-Signed Tomcat Certificate Task List 113 Upload Root Certificate and Intermediate Certificate of the Signing Certificate Authority 114 Restart Cisco Intercluster Sync Agent Service 114 Configuration and Administration of the IM and Presence Service on Cisco Unified Communications Manager, Release 11.5(1) viii Contents Verify CA Certificates Have Synchronized to Other Clusters 115 Upload Signed Certificate to Each IM and Presence Service Node 116 Restart Cisco Tomcat Service 116 Verify Intercluster Syncing 117 CA-Signed cup-xmpp Certificate Upload 117 Upload Root Certificate and Intermediate Certificate of the Signing Certificate Authority