Deployment Guide for IM and Presence Service on Cisco Unified Communications Manager, Release 9.0(1)
IM and Presence server configuration for deployment in network
Downloads: This chapterpdf (PDF - 1.78MB) The complete bookPDF (PDF - 6.21MB) | The complete bookePub (ePub - 1.26MB) | Feedback

IM and Presence server configuration for deployment in network

Contents

IM and Presence server configuration for deployment in network

Configuration changes and service restart notifications

Service Restart Notifications

If you make a configuration change in Cisco Unified CM IM and Presence Administration that impacts an IM and Presence XCP service, you will need to restart XCP services for your changes to take effect. IM and Presence Service notifies you of exactly which node the configuration change impacts and of any service that you must restart. An Active Notifications popup window displays on each page of Cisco Unified CM IM and Presence Administration to serve as a visual reminder that you must restart services. Use your mouse to hover over the dialog bubble icon to see the list of active notifications (if any) and associated severity levels. From the list of active notifications you can go directly to Cisco Unified IM and Presence Serviceability, where you can restart the required service.

It is good practice to monitor the service restart popup window for service restart notifications, particularly if you make configuration changes after you deploy IM and Presence Service in the network. Most tasks in the accompanying documentation indicate if service restarts are required.

See the Online Help topic on Service Restart Notifications for information about the types of service notifications, and the service notification security levels.

Cisco XCP Router Restart

The Cisco XCP Router must be running for all availability and messaging services to function properly on IM and Presence Service. This applies to both SIP-based and XMPP-based client messaging. If you restart the Cisco XCP Router, IM and Presence Service automatically restarts all active XCP services.

The topics in this module indicate if you need to restart the Cisco XCP Router following a configuration change. Note that you must restart the Cisco XCP Router, not turn off and turn on the Cisco XCP Router. If you turn off the Cisco XCP Router, rather than restart this service, IM and Presence Service stops all other XCP services. Subsequently when you then turn on the XCP router, IM and Presence Service will not automatically turn on the other XCP services; you need to manually turn on the other XCP services.

Restart Cisco XCP Router Service

Procedure
    Step 1   On IM and Presence Service, choose Cisco Unified IM and Presence Serviceability > Tools > Control Center - Network Services.
    Step 2   Choose the node from the Server list box and select Go.
    Step 3   Click the radio button next to the Cisco XCP Router service in the IM and Presence Service section.
    Step 4   Click Restart.
    Step 5   Click OK when a message indicates that restarting may take a while.

    Cluster topology configuration on IM and Presence

    This module is only applicable if you are deploying the multinode feature. When you configure the multinode feature, note the following:

    • Perform the system topology configuration on the IM and Presence publisher node.
    • Before configuring the system topology, read the multinode planning and deployment information for best practice information about configuring this type of deployment.

    Caution


    Only use the system topology interface to configure your local IM and Presence cluster. See the intercluster peer module for information about configuring intercluster peer relationships with remote IM and Presence clusters.


    Subcluster, node and user management recommendations

    Node creation and movement recommendations

    When you create nodes in the system topology management GUI you can:

    • Assign the nodes to a subcluster in IM and Presence, or allow the nodes to remain unassigned. These states are interchangeable.
    • Assign IM and Presence users to the nodes, or allow the nodes to remain without any user assignments.
    • Turn on or off High Availability on a subcluster. See the section about configuring High Availability deployments later in this chapter.
    • Move a node from one subcluster to another if the node is assigned, has no users and high- availability is turned off in the subcluster.
    • Move a node from one subcluster to another if the node is assigned and has no users.
    • Configure real pingable nodes, or logical nodes which can be installed later and which remain inaccessible until that time.

    To move nodes with users assigned, perform one of the following actions:

    • Unassign the users, move the node, and then reassign the users to the node. Note that when you unassign the users, they will lose service.
    • Create a logical node and move the users to the logical node. Move the node, reassign the users to the node, and remove the logical node.
    • Remove all users from a node before you unassign or move it.
    • Turn off High Availability in the subcluster before you unassign or move a node in that subcluster.
    • We strongly recommend that you perform any node movements that involve unassigning or moving a large numbers of users at off peak times. Such large operations can adversely impact performance.

    Node Name Recommendations

    By default, the name for a node is the hostname that you configure during IM and Presence Service installation. For example, if the hostname of your IM and Presence Service node is called "cup1", the node name is "cup1". You can change the node name to the dotted IP address or the FQDN, for example, "192.168.0.1" or "cup1.acme.com". If you change the default name for the node, note the following:

    • You must be able to resolve the hostname or the FQDN from the IM and Presence Service node, and Cisco Unified Personal Communicator client computers.
    • If either IM and Presence Service node or the Cisco Unified Personal Communicator client computer cannot resolve the hostname or the FQDN, configure the IP address for the node name value.
    • To test the name resolution from the IM and Presence Service node, use the command utils network ping <node_name>
    • To test the name resolution from the Cisco Unified Personal Communicator client computer, use the command ping <node_name>
    • If your network uses DNS that can map to IPv4 addresses, you can enter the IM and Presence Service hostname. Otherwise, you must enter the full IPv4 address of the IM and Presence Service node.
    Attention:

    When using the Cisco Jabber client, certificate warning messages can be encountered if the IP address is configured as the IM and Presence Service node name. To prevent Cisco Jabber from generating certificate warning messages, the FQDN should be used as the node name.

    User assignment mode recommendations

    You can manually or automatically assign users in an IM and Presence deployment. Use the User Assignment Mode parameter on the Sync Agent to manage user assignment on IM and Presence:

    • If set to Balanced, IM and Presence divides all users equally across all nodes in all subclusters. Use this user assignment mode for the Balanced Mode Non-Redundant High Availability and the Balanced Mode Redundant High Availability deployment options.
    • If set to Active/Standby, IM and Presence assigns all users only to the first node of a subcluster. If there is only a single node in the subcluster, IM and Presence uses this node for assignment regardless of the location of the node within the subcluster.
    • If set to None, you must manually assign your users to nodes in system topology management GUI.
    • If all the hardware in your cluster is of the same generation and has the same capacity, set the User Assignment Mode to Balanced.
    • If you have hardware of mixed generations and capacities in a node, set the User Assignment Mode to None. Manually assign your users making sure that each server is not loaded beyond capacity.

    Manual user assignment recommendations

    If you choose to manually assign users in system topology management GUI, note the following:

    • You can manually unassign, assign or reassign users. You can assign users to a single node, and you can also distribute groups of users across the node, or nodes, in a cluster, or a given subcluster.
    • If you assign a user to one of the nodes in a subcluster, the other node in the subcluster can become the backup (redundant) node for the user if you turn on High Availability for the subcluster. If you do not configure a backup node in the subcluster, and you do not turn on High Availability for the subcluster, the user does not have High Availability failover protection.
    • Users who are assigned may be reassigned, that is, moved to another subcluster, or to a specific node. You can move users individually or in bulk.
    • Users can remain unassigned. Unassigned users do not receive availability information.

    Note


    We recommend that you only reassign a user (assign a user that was previously unassigned) if the Cisco Presence Engine is running on all nodes in your cluster, otherwise IM and Presence will not reestablish the presence subscriptions to and from this user.


    When you are assigning users, note the following:

    • You can only assign users if they are licensed.
    • Unassigning or reassigning users results in termination of active sessions. In such instances, clients must reconnect to the new location.
    • You can export users in bulk using the Bulk Administration Tool (BAT). You can also use BAT to perform bulk user reassignment from one node to another.

    Generally we recommend that you take the Cisco Presence Engine and Cisco SIP Proxy services offline when performing bulk operations. Note that taking these services offline will adversely impact performance.

    User redistribution


    Note


    • If you turn on High Availability in a subcluster, be aware that IM and Presence does not redistribute users to nodes that are in a failover states; the valid node states that support user redistribution are Normal and Running in Backup Mode.
    • If you rebalance your users, you must reconfigure the upper and lower client re-login limit values based on the HA login profile tables, see High Availability client login profiles.

    After adding or removing nodes, you can redistribute users using the Rebalance Users parameter in system topology management GUI. This parameter redistributes users based on the configured User Assignment mode. These are examples of how you can use the Rebalance Users parameter with the User Assignment mode to manage user assignment:

    • Scenario A: The customer has a subcluster with two nodes, and each node contains 5000 users. The User Assignment mode is set to Balanced. The customer then adds a second subcluster with two nodes, and sets the Rebalance Users parameter. IM and Presence distributes the users evenly to the four nodes so that each node now has 2500 users.
    • Scenario B: The customer has a subcluster with two nodes, and each node contains 2500 users. The User Assignment mode is set to Balanced. The customer wants to add a second subcluster with two nodes, but also wants to change the User Assignment mode to Active/Standby. The customer changes the mode to Active/Standby, whereby all 5000 users are redistributed to the first node in the subcluster. The customer then adds a second subcluster with two nodes, and sets the Rebalance Users parameter. IM and Presence evenly distributes the users across both first nodes in each subcluster. Each first node now has 2500 users.

    We strongly recommend that you perform any node movements that involve unassigning or moving a large numbers of users at off peak times. Such large operations can adversely impact performance.

    Create subclusters in system topology

    The system automatically assigns the first IM and Presence node that you install as the publisher node. After you install the publisher node, create the required subclusters and subsequent nodes in your IM and Presence cluster in system topology management GUI.

    Repeat this procedure for each subcluster that you require for your deployment.


    Note


    Perform this procedure on the publisher IM and Presence node.


    Before You Begin

    Plan your multinode deployment model.

    Procedure
      Step 1   Select Cisco Unified Communications Manager IM and Presence Administration > System > Cluster Topology.
      Step 2   Select Add New Subcluster.
      Step 3   Define a unique name for the subcluster.
      Step 4   Select Save.

      Troubleshooting Tip

      To update a subcluster, or view the status of a subcluster, select the edit link on the subcluster.


      What to Do Next

      Manage Nodes in System Topology

      Manage Nodes in System Topology

      Create the required subsequent nodes for your deployment. By creating the subsequent nodes in the topology view of the publisher node, IM and Presence Service associates the subsequent nodes with the publisher node.

      Before You Begin

      Note


      • Perform this procedure on the publisher IM and Presence Service node.
      • Perform this procedure before you install any of the subsequent IM and Presence Service nodes. If you assign a subsequent IM and Presence node to a subcluster prior to installing it, users in remote clusters will not receive availability information. An availability outage will occur until the node is installed.

      Depending on how you plan to configure your node name, obtain the required value for your nodes (for example FQDN, hostname or dotted IP address). Note the following restrictions:

      • If you wish to change the default node name, there are certain node name restrictions. Read the node name recommendations topic.
      • You can only move a node from one subcluster to another if the node is assigned and has no users.
      • You must turn off High Availability in a subcluster before you move or unassign a node in that subcluster.
      Procedure
        Step 1   Create the required subclusters for your deployment.
        Step 2   Select Cisco Unified CM IM and Presence Administration > System > Cluster Topology.
        Step 3   Create the required subsequent nodes for your deployment:
        1. Select Add New Node.
        2. Define a unique name for the node.
        3. Select Save.
        Step 4   Perform one of the following actions:
        • To assign a node to a subcluster, drag the node into the empty slot in the subcluster.
          • Do not assign the subsequent node to a subcluster until after you install it, and you have checked the status of the node.
          • Before you assign a node to a subcluster, check the following
            • From System troubleshooter page, verify that the Cisco Replication Watcher service is running on all nodes.
            • On the Network services screen in Cisco Unified IM and Presence Serviceability (on the subscriber node), verify that all IM and Presence services are running on the assigned node.
        • To move a previously assigned node, drag the node from the subcluster and drop it into the empty slot of the peer subcluster.
          • Turn off high-availability in the subcluster before you move the node.
          • Unassign all users from the node before you move it.
        Step 5   Select Cisco Unified CM IM and Presence Administration > Diagnostics > System Troubleshooter to verify the status of your topology configuration.
        Tip   
        To update a node, or view the status of a node, select the edit link on the node to view the Node Detail screen. From the edit window, you can:
          • View the total users assigned to the node.
          • Verify the status of the node.
        • If you turn on High Availability in the subcluster, the critical services that IM and Presence Service monitors on the node for failover are marked in the "Monitored" column.
        • If you turn on High Availability, you can also view the High Availability state of the node, and the reason for this state.

        What to Do Next

        Proceed to configure user assignments in System Topology.

        Configure User Assignment in System Topology


        Note


        This topic is only applicable if you have chosen to manually assign your users.


        In system topology management GUI, you can manually unassign, assign or reassign users. You can assign users to a single node, and you can also distribute groups of users across the node, or nodes, in a cluster, or a given subcluster.

        Before You Begin
        • Read the user assignment recommendations topic.
        • You may want to export users in bulk. Use the Bulk Administration Tool (BAT) to perform this procedure. Restriction
        • You can only assign licensed users.
        • If you turn on High Availability in a subcluster, note that you can only assign or move users to nodes in that subcluster that are not in a failover state. Valid node states are Normal and Running in Backup Mode.
        Procedure
          Step 1   Select Cisco Unified CM IM and Presence Administration > System > Topology.
          Step 2   Perform one of the following actions:
          • To assign users, choose Assign Users.
          • To unassign or reassign users, choose All Assigned Users in the left pane of the system topology interface.
          Step 3   Use the Find User Assignment window to find and display users.
          Step 4   Perform one of the following actions:
          1. Check the users that you wish to assign, and select Assign Selected Users.
          2. Select all users, and select Assign All Users.
          Step 5   Using the list boxes in the Change Assignment frame, specify your user assignment:
          1. to a named node
          2. to a named subcluster (auto-assigned)
          3. to all subclusters (auto-assigned)
          4. to nothing (unassigned)
          Step 6   Select Save.
          Tip   

          Select Cisco Unified CM IM and Presence Administration > Diagnostics > System Troubleshooter to verify the status of your topology configuration.


          High Availability IM and Presence deployments

          High Availability requirements

          The IM and Presence Service supports High Availability at a subcluster level. Both nodes in the subcluster must be running the same version of IM and Presence software for High Availability to work.

          High Availability subcluster

          IM and Presence supports High Availability in a subcluster meaning if a node in the subcluster fails, the Instant Message and Availability services from that node can failover to the second node in the subcluster.

          You must manually turn on High Availability in a subcluster on the Cluster Topology interface on IM and Presence Administration interface. On the main Cluster Topology interface, the subcluster icon indicates that you have turned on High Availability on the subcluster.

          A green tick beside the High Availability icon indicates that High Availability in the subcluster is running normally. A red "x" beside the High Availability icon indicates that the subcluster is in a failed state.

          IM and Presence automatically detects failover in a subcluster by monitoring the heartbeat and monitoring the critical services on the peer node. When IM and Presence detects failover, it automatically moves all users to the backup node and supports automatic fallback to the primary node. From the Cisco Unified CM IM and Presence Administration interface, you can initiate a manual fallback to the primary node.


          Note


          IM and Presence performs an automatic fallback when the backup activated node fails due to a critical service failure and the peer node is in the "Failed Over" state and supports the automatic recovery fallback.


          To monitor and troubleshoot the status of the High Availability functionality on a subcluster, view the High Availability states that IM and Presence assigns to each node. If a failover occurs, on the node detail screen, IM and Presence marks the users that have failed over to the backup node.

          Impact of failover to IM and Presence clients and services

          The IM and Presence Service supports High Availability for Cisco Unified Personal Communicator Release 8.5(x) and later.

          During failover to the backup node, availability and instant messaging services are temporarily unavailable on client applications. After failover is complete, the availability and instant messaging services become available on the client again when the client signs back in. Similarly, if fallback occurs, availability and instant messaging services are temporarily unavailable on client applications until fallback completes and the client signs back in. Cisco Unified Personal Communicator signs users back in automatically.

          The impact of failover on temporary adhoc chat messages depends on the particular client application. On Cisco Unified Personal Communicator, any adhoc chat windows that were open before failover should display again after the failover is complete. However, if all of the users in a chat room automatically exit the chat room as part of a failover or fallback process, or if the adhoc chat room is hosted on a failed node, the adhoc chat windows will not display again after failover and a message is displayed explaining that the chat room was deleted. On all clients, any persistent chat rooms that users create on the failed node cannot be accessed again until recovery.

          If Cisco Unified Personal Communicator is operating in softphone mode (the user is on a voice call) during failover, the voice call is not disconnected.

          Automatic failover detection

          IM and Presence uses these methods to automatically detect if a node fails:

          • Peer Heartbeat - In a subcluster, each node sends heartbeat intervals to the other node to check if the node is up and running. If a node detects a loss of heartbeat in the peer node, the node initiates a failover. You can configure the heartbeat interval and the heartbeat timeout from the Service Parameters page on Cisco Unified CM IM and Presence Administration interface.
          • Monitor Critical Services - Each node monitors a list of critical services. If the node detects that any critical service is not running for a configurable outage period (ninety seconds is the default value), it instructs the peer node to initiate a failover. You can configure this critical service delay from the Service Parameters page on Cisco Unified CM IM and Presence Administration interface. These are the list of critical services that the node monitors:
            • Cisco DB (internal IDS database)
            • Cisco Presence Engine (if you activate this service)
            • Cisco XCP Router
            • Cisco Message Archiver (if you integrate IM and Presence with a third-party off-board database, and you activate this service)
            • Cisco SIP Proxy (if you configure SIP federation or you enable Partitioned Intradomain Federation and you activate this service)
            • Cisco XCP SIP Federation Connection Manager (if you configure SIP federation, or enable Partitioned Intradomain Federation, and you activate this service)
            • Cisco Presence Datastore
            • Cisco Route Datastore (if you configure SIP federation or you enable Partitioned Intradomain Federation and you activate this service)

          You can view the critical services that IM and Presence monitors for failover on the node details screen on the Cluster Topology interface. The critical services that IM and Presence monitors are marked in the "Monitored" column in the services list.


          Note


          • IM and Presence only detects a failover if a critical service is not running for the duration of the outage period. It does not detect a failover in the case where one or more critical services are not running during the outage period, but not for the duration of the outage period, for example, a rolling outage. In this case, IM and Presence generates alarms indicating that services are starting and stopping, and you can perform a manual failover on IM and Presence.
          • If you manually stop a critical service, and the service is stopped for longer than the permitted outage period, failover will occur.

          Prior to Release 8.6, if IM and Presence detects the situation where both nodes in the subcluster think they own the same user, both nodes go into a failed state, and you need to perform a manual recovery from the Cluster Topology interface. In IM and Presence Release 9.0(1) and later, manual recovery is not required. When the network issue is resolved, auto-recovery occurs without administrator intervention.

          If manual recovery is required for another reason, you may experience IDS replication delays.

          To check the status of the IDS replication on a node either:

          • Use this CLI command: utils dbreplication runtimestate
          • Use the Cisco Unified IM and Presence Reporting Tool. The "IM and Presence Database Status" report displays a detailed status of the cluster.

          Automatic fallback

          IM and Presence supports automatic fallback to the primary node after a failover. Automatic fallback is the process of moving users back to the primary node after a failover without manual intervention. You can enable automatic fallback with the Enable Automatic Fallback service parameter on the Cisco Unified CM IM and Presence Administration interface.

          Automatic fallback occurs in the following scenarios:

          • A critical service on Node A fails—A critical service (for example, the Presence Engine) fails on Node A. Automatic failover occurs and all users are moved to Node B. Node A is in a state called "Failed Over with Critical Services Not Running." When the critical service recovers, the node state changes to "Failed Over." When this occurs Node B tracks the health of Node A for 30 minutes. If no heartbeat is missed in this timeframe and the state of each node remains unchanged, automatic fallback occurs.
          • Node A is rebooted—Automatic failover occurs and all users are moved to Node B. When Node A returns to a healthy state and remains in that state for 30 minutes automatic fallback will occur.
          • Node A loses communications with Node B—Automatic failover occurs and all users are moved to Node B. When communications are re-established and remain unchanged for 30 minutes automatic fallback will occur.

          If failover occurs for a reason other than one of the three scenarios listed here, you must recover the node manually. If you do not want to wait 30 minutes before the automatic fallback, you can perform a manual fallback to the primary node.

          Cisco Server Recovery Manager (SRM)

          The Cisco Server Recovery Manager (SRM) on IM and Presence manages the failover between nodes in a subcluster. The Cisco Server Recovery Manager manages all state changes in a node; state changes are either automatic or initiated by the administrator (manual).

          After you turn on High Availability in a subcluster, the Cisco Server Recovery Manager on each node establishes heartbeat connections with the peer node, and begins to monitor the critical processes.

          The SRM is responsible for the user move operations after it detects that failover has occurred. It is the SRM on the peer node, not on the failed node, that performs the user move operation. For example, if node A fails, the SRM on node B performs the user move operation. The SRM throttles the number of users moved to the peer node, it moves the users in batches or iterations. You can configure the number of users that the SRM moves per iteration (the default value is 25). On failover, the SRM will move users that are signed in first, and then move users that are not signed in. Note that if you initiate a fallback or if an automatic fallback occurs, users that are not signed in are moved first, and then users that are signed in.

          If the SRM is not turned on, it does not monitor any critical processes, nor does it monitor the heartbeat connections with the peer node.


          Caution


          Before you turn on High Availability in a subcluster, you must configure the SRM service parameters to properly reflect your deployment, see High Availability client login profiles.


          Related References

          Manual failover and fallback

          From the Cluster Topology interface, you can perform the following procedures:

          • Initiate a manual failover for a subcluster. When you initiate a manual failover, the Cisco Server Recovery Manager stops the critical services on the failed node, and moves all users to the backup node.
          • Initiate a manual fallback from the Cluster Topology interface, where the Cisco Server Recovery Manager restarts critical services on the primary node and moves users back to the primary node.
          • Perform a manual recovery for a subcluster (when both nodes in the subcluster are in a failed state). When you perform a manual recovery, IM and Presence restarts the Cisco Server Recovery Manager service on both nodes in the subcluster.

          Important note about High Availability and intercluster deployments

          When failover occurs, the Intercluster Sync Agent is responsible for communicating the user move information to other clusters. The Intercluster Sync Agent runs on both the publisher and subscriber nodes in a cluster. In an Active-Standby configuration, if the publisher node fails or the Intercluster Sync Agent on the publisher node fails, the Intercluster Sync Agent on the subscriber node becomes Active and resumes synchronization, meaning the other clusters will continue to receive the information that users have moved to a different node. Intercluster presence and IM continue to work. Users that have failed over will receive availability information for remote users. Remote users continue to receive availability information and IMs from users that have failed over, and all IMs they send to a failed over user are delivered. When the publisher node recovers, the publisher falls back to Active mode and the subscriber returns to Standby mode.

          Node state definitions

          The following table describes the different node states, and associated reasons. You can view the state of an existing node by either viewing the node details or the subcluster details on the Cluster Topology interface.


          Note


          These fields are only displayed on the Cluster Topology interface if you turn on High Availability in a subcluster.


          State

          Description

          Initializing

          This is the initial (transition) state when the Cisco Server Recovery Manager service starts; it is a temporary state.

          Idle

          IM and Presence is in Idle state when failover occurs and services are stopped. In Idle state, the IM and Presence node does not provide any availability or Instant Messaging services. In Idle state, you can manually initiate a fallback to this node from the Cluster Topology interface.

          Normal

          This is a stable state. The IM and Presence node is operating normally. In this state, you can manually initiate a failover to this node from the Cluster Topology interface.

          Running in Backup Mode

          This is a stable state. The IM and Presence node is acting as the backup for its peer node. Users have moved to this (backup) node.

          Taking Over

          This is a transition state. The IM and Presence node is taking over for its peer node.

          Failing Over

          This is a transition state. The IM and Presence node is being taken over by its peer node.

          Failed Over

          This is a stable state. The IM and Presence node has failed over, but no critical services are down. In this state, you can manually initiate a fallback to this node from the Cluster Topology interface.

          Failed Over with Critical Services Not Running

          This is a stable state. Some of the critical services on the IM and Presence node have either stopped or failed.

          Falling Back

          This is a transition state. The system is falling back to this IM and Presence node from the node running in Backup Mode.

          Taking Back

          This is a transition state. The failed IM and Presence node is taking back over from its peer.

          Running in Failed Mode

          An error occurs during the transition states or Running in Backup Mode state.

          Unknown

          State unknown.

          Node states, causes and recommended actions

          The following table describes the node states, reasons, causes, and recommended actions for failed states.

          Table 1 Node High Availability states, causes and recommended actions

          Node 1

          Node 2

          State

          Reason

          State

          Reason

          Cause/Recommended Actions

          Normal

          Normal

          Normal

          Normal

          High Availability is running on both nodes in the subcluster.

          Subcluster is running normally (it is in non failover mode). The critical services on both nodes in the subcluster are running.

          Failing Over

          On Admin Request

          Taking Over

          On Admin Request

          The administrator initiates a manual failover from node 1 to node 2. The manual failover is in progress.

          Idle

          On Admin Request

          Running in Backup Mode

          On Admin Request

          The manual failover from node 1 to node 2 (initiated by the administrator) is complete.

          Taking Back

          On Admin Request

          Falling Back

          On Admin Request

          The administrator initiates a manual fallback from node 2 to node 1. The manual fallback is in progress.

          Idle

          Initialization

          Running in Backup Mode

          On Admin Request

          The administrator restarts the SRM service on node 1 while node 1 is in Idle state.

          Idle

          Initialization

          Running in Backup Mode

          Initialization

          The administrator restarts both nodes in the subcluster, or restarts the SRM service on both nodes in the subcluster, while the subcluster was in manual failover mode (failover initiated by the administrator).

          Idle

          On Admin Request

          Running in Backup Mode

          Initialization

          The administrator restarts the SRM service on node 2 while node 2 is running in backup mode, but before the heartbeat on node 1 times out.

          Failing Over

          On Admin Request

          Taking Over

          Initialization

          The administrator restarts the SRM service on node 2 while node 2 is taking over, but before the heartbeat on node1 times out.

          Taking Back

          Initialization

          Falling Back

          On Admin Request

          The administrator restarts the SRM service on node 1 while taking back, but before the heartbeat on node 2 times out. After the taking back process is complete, both nodes are in Normal state.

          Taking Back Automatic Fallback Falling Back Automatic Fallback Automatic Fallback has been initiated from node 2 to node 1 and is currently in progress.

          Failed Over

          Initialization or Critical Services Down

          Running in Backup Mode

          Critical Service Down

          Node 1 transitions to Failed Over state when:

          • Critical service(s) come back up due to reboot of node 1, or
          • The administrator starts critical service(s) on node 1 while node 1 is in "Failed Over with Critical Services Not Running" state When node 1 transitions to Failed Over state the node is ready for the administrator to perform a manual fallback to restore the nodes in the subcluster to Normal state.

          Failed Over with Critical Services not Running

          Critical Service Down

          Running in Backup Mode

          Critical Service Down

          A critical service is down on node 1. IM and Presence performs an automatic failover to node 2.

          Recommended Actions:

          1. Check what critical services are down on node 1, and try to start these services manually.
          2. If the critical services on node 1 do not start, reboot node 1.
          3. After the reboot and when all the critical services are running, perform a manual fallback to restore the nodes in the subcluster to Normal state.

          Failed Over with Critical Services not Running

          Database Failure

          Running in Backup Mode

          Database Failure

          A database service is down on node 1. IM and Presence performs an automatic failover to node 2.

          Recommended Actions:

          1. Reboot Node 1.
          2. After the reboot and when all the critical services are running, perform a manual fallback to restore the nodes in the subcluster to Normal state.

          Running in Failed Mode

          Start of Critical Services Failed

          Running in Failed Mode

          Start of Critical Services Failed

          Critical services fail to start while a node in subcluster is taking back from the other node.

          Recommended Actions: (on the node that is taking back)

          1. Check what critical services are down on the node. To start these services manually, select Recovery on the subcluster details screen.
          2. If the critical services do not start, reboot the node.
          3. After the reboot and when all the critical services are running, perform a manual fallback to restore the nodes in the subcluster to Normal state.

          Running in Failed Mode

          Critical Service Down

          Running in Failed Mode

          Critical Service Down

          Critical services go down while a node in subcluster is running in backup mode for the other node.

          Recommended Actions:

          1. Check what critical services are down on backup node. To start these services manually, select Recovery on the subcluster details screen.
          2. If the critical services do not start, reboot the subcluster.

          Node 1 is down due to loss of network connectivity or the SRM service is not running.

          Running in Backup Mode

          Peer Down

          Node 2 has lost its heartbeat with node 1. IM and Presence performs an automatic failover to node 2.

          Recommended Action:

          (If node 1 is up)

          1. Check and repair the network connectivity between nodes in the subcluster. When you reestablish the network connection between the nodes, the node may go into a failed state. Select Recovery on the subcluster details screen to restore the nodes in the subcluster to Normal state.
          2. Start the SRM service, and perform manual fallback to restore the nodes in the subcluster to Normal state. (If the node is down)
          3. Repair/Power up node 1.
          4. When node is up and all critical services are running, perform manual fallback to restore the nodes in the subcluster to Normal state.

          Node 1 is down (due to possible power down, hardware failure, shutdown, reboot)

          Running in Backup Mode

          Peer Reboot

          IM and Presence performs an automatic failover to node 2 due to possible hardware failure/power down/restart /shutdown of Node 1.

          Recommended Action:

          1. Repair/Power up node 1.
          2. When node is up and all critical services are running, perform manual fallback to restore the nodes in the subcluster to Normal state.

          Failed Over with Critical Services not Running OR Failed Over

          Initialization

          Backup Mode

          Peer Down During Initialization

          Node 2 does not see Node 1 during startup.

          Recommended Action:

          When node1 is up and all critical services are running, perform manual fallback to restore the nodes in the subcluster to Normal state.

          Running in Failed Mode

          Cisco Server Recovery Manager Take Over Users Failed

          Running in Failed Mode

          Cisco Server Recovery Manager Take Over Users Failed

          User move fails during taking over process.

          Recommended Action:

          Possible database error. Select Recovery on the subcluster details screen. If that doesn't resolve the issue, reboot the subcluster.

          Running in Failed Mode

          Cisco Server Recovery Manager Take Back Users Failed

          Running in Failed Mode

          Cisco Server Recovery Manager Take Back Users Failed

          User move fails during falling back process.

          Recommended Action:

          Possible database error. Select Recovery on the subcluster details screen. If that doesn't resolve the issue, reboot the subcluster.

          Running in Failed Mode

          Unknown

          Running in Failed Mode

          Unknown

          The SRM on a node restarts while the SRM on the other node is in a failed state, or an internal system error occurs.

          Recommended Action:

          Select Recovery on the subcluster details screen. If that does not resolve the issue, reboot the subcluster.

          Backup Activated

          Auto Recover Database Failure

          Failover Affected Services

          Auto Recovery Database Failure.

          The Database goes down on the backup node. The peer node is in failover mode and can take over for all users in the subcluster. Auto-recovery operation automatically occurs and all users are moved over to the primary node.

          Backup Activated

          Auto Recover Database Failure

          Failover Affected Services

          Auto Recover Critical Service Down

          A critical service goes down on the backup node. The peer node is in failover mode and can take over for all users in the subcluster. Auto-recovery operation automatically occurs and all users are moved over to the peer node.

          High Availability IM and Presence deployments configuration

          Turn on or off High Availability for subcluster


          Caution


          Before you turn on High Availability in a subcluster, you must configure the SRM service parameters to properly reflect your deployment, see High Availability client login profiles.


          You have to manually turn on High Availability in a subcluster; IM and Presence does not turn on High Availability in a subcluster by default. You can turn on High Availability in a subcluster when:

          • there are two nodes in the subcluster, and
          • both nodes have IP addresses that are resolvable addresses, and
          • both nodes are running IM and Presence Release 9.0 or higher.

          You can either assign users to the nodes in the subcluster before or after you turn on High Availability for the subcluster.

          Before You Begin
          • Configure the subclusters and nodes in your network, and assign nodes to the subclusters.
          • Make sure critical services are running on both nodes in the subcluster before you turn on high- availability in a subcluster. If one or more critical services are not running on a node, when you turn on High Availability, that node will failover to the backup node. When one or more critical services are not running on one node in a subcluster, but all critical services are running on the second node, the subcluster will go into a failed state after you turn on High Availability. Restriction

          You can only turn on High Availability in a subcluster when there are two nodes assigned to that subcluster. The High Availability checkbox does not display when there are no nodes, or one node, assigned to the subcluster.

          Procedure
            Step 1   Cisco Unified Communications Manager IM and Presence Administration > System > Cluster Topology.
            Step 2   Select the edit link on the appropriate subcluster.
            Step 3   Check Enable High Availability.
            Note   

            To turn off High Availability for the sublcluster, uncheck Enable High Availability.

            Step 4   Select Save.

            IM and Presence displays the following information about High Availability for the subcluster

            Field

            Description

            Monitored Node

            The node in the subcluster that IM and Presence is monitoring for failover detection.

            Node State

            The state of the node. See Node state definitionsfor definitions of the states.

            Node Reason

            The reason for the node state.

            Node Action

            The action you can take to change the state of the node:

            • Fallback - This option is displayed for nodes that are in Idle or Failed Over states. Select to manually initiate a fallback to this node.
            • Failover - This option is displayed for nodes that are in Normal state. Select to manually initiate a failover to this node.
            • Recovery - This option is displayed if both nodes in the subcluster are in a failed state. Select to manually initiate a recovery of the subcluster where IM and Presence restarts the SRM service on both nodes.

            Troubleshooting Tips

            • When you turn on High Availability in a subcluster, IM and Presence restarts the Cisco Service Recovery Manager service and it begins to monitor for failover detection. To verify this service is running, select Cisco Unified IM and Presence Serviceability > Tools > Control Center - Network Services.
            • You can turn off High Availability in a subcluster, so the two nodes in the subcluster act as standalone nodes. You can only turn off High Availability when the nodes in the subcluster are not in a transition state (Failing Over, Falling Back). If you turn off High Availability in a subcluster when either node is in a failed over scenario (Failed Over, Failed), users that IM and Presence fails over to the backup node are homed to the backup node. IM and Presence will not move these users back to the primary node, they remain on the backup node.
            • The System Troubleshooter indicates if there are any two node subclusters without High Availability turned on. Select Cisco Unified Communications Manager IM and Presence Administration > Diagnostics > System Troubleshooter.

            Configure advanced service parameters for Server Recovery Manager

            Procedure
              Step 1   Cisco Unified Communications Manager IM and Presence Administration > System > Service Parameters.
              Step 2   Select an IM and Presence server from the Server menu.
              Step 3   Select Cisco Server Recovery Manager from the Service menu.
              Step 4   Configure these service parameters:

              Parameter

              Description

              Additional Information

              Service Port

              This parameter specifies the port that Cisco Server Recovery Manager uses to communicate with its peer.

              If you modify this parameter, IM and Presence restarts the Cisco Server Recovery Manager on all nodes in the cluster.

              Admin RPC Port

              This parameter specifies the port that Cisco Server Recovery Manager uses to provide admin RPC requests.

              If you modify this parameter, IM and Presence restarts the Cisco Server Recovery Manager on all nodes in the cluster.

              Critical Service Down Delay

              This parameter determines the duration a critical service can be down before IM and Presence initiates an automatic failover.

              If you change this value, this affects how long a critical service can be down before IM and Presence initiates an automatic failover.

              Enable Automatic Fallback This parameter turns automatic fallback on or off on IM and Presence. This parameter is off by default.

              Initialization Keep Alive (Heartbeat) Timeout

              This parameter specifies the duration that the heartbeat is lost with the peer node (SRM) when the peer SRM restarts and is in the initialization state.

              We recommend that you configure this value to at least twice the value of the Keep Alive (Heartbeat) Timeout in order to avoid unnecessary failovers.

              Keep Alive (Heartbeat) Timeout

              This parameter specifies the duration that the heartbeat is lost with the peer node (SRM) before IM and Presence initiates an automatic failover.

              We recommend that you configure this value to at least twice the value of KeepAliveInterval value. If this value is too close to the KeepAliveInterval value, this can cause a failover to occur.

              Keep Alive (Heart Beat) Interval

              This parameter specifies the interval between keep alive (heartbeat) messages sent to the peer node.

              N/A

              Users Moved Per Iteration

              This parameter specifies the number of users that IM and Presence moves for each iteration when it performs a failover or a fallback. There is a delay of one second between each iteration.

              Increasing this value will shorten the failover time at the expense of CPU. Lowering the value will lengthen failover time, but have less impact on the CPU.

              Caution   

              Before you configure the Users Moved Per Iteration parameter value, refer to the High Availability client login profiles.

              Client Re-Login Lower Limit

              This parameter specifies the minimum number of seconds which Cisco Unified Personal Communicator will wait before attempting to re-login to this IM and Presence server. This waiting time occurs due to the failure of a node or a critical service on a node.

              Note   

              This parameter is per node.

              This parameter only applies to Cisco Unified Personal Communicator Release 8.5 or higher 8.x releases.

              Caution   

              Refer to the High Availability client login profiles for guidelines on defining the client re-login lower and upper limits.

              Client Re-Login Upper Limit

              This parameter specifies the maximum number of seconds which Cisco Unified Personal Communicator will wait before attempting to re-login to this IM and Presence server. This waiting time occurs due to the failure of a node or a critical service on a node.

              Note   

              This parameter is per node.

              This parameter only applies to Cisco Unified Personal Communicator Release 8.5 or higher 8.x releases.

              Caution   

              Refer to the High Availability client login profiles for guidelines on defining the client re-login lower and upper limits.

              Step 5   Select Save.

              Perform manual failover to backup node

              You can perform a manual failover to the backup node in the subcluster using the Cluster Topology interface. When you initiate a manual failover, the Cisco Server Recovery Manager stops the critical services on that node, and moves all users to the backup node.

              The Cisco Server Recovery Manager stops the following critical services on the node:

              • Cisco SIP Proxy
              • Cisco Presence Engine
              • Cisco XCP Router (this causes all XCP processes to stop)
              • Cisco Client Profile Agent

              The Cisco Server Recovery Manager then move all users to the backup node

              Restriction

              You can only initiate a failover for a node that is in "Normal" state.

              Before You Begin

              Make sure that these services are running on the Failing Over node:

              • Cisco XCP Connection Manager service
              • Cisco XCP Router
              • Cisco Presence Engine
              Procedure
                Step 1   Cisco Unified Communications Manager IM and Presence Administration > System > Cluster Topology.
                Step 2   Select the edit link on the appropriate subcluster.
                Step 3   Select Failover in the Node Action column.
                Step 4   Select Ok to confirm the failover operation.
                Step 5   To verify the failover operation is complete and successful:
                1. When the failover operation is in progress, the primary node should be in the "Failing Over" state, and the backup node should be in the "Taking Over" state. When the failover operation is complete, check that the backup node is in the state "Running in Backup Mode", and the primary node is in "Idle" state. If the failover is unsuccessful, and the nodes are in a failed state.
                2. Check that the users have failed over to the backup node:
                  • On the subcluster details screen, check that all users are now assigned to the backup node, and no users are assigned to the primary node.
                  • On the node details screen, the "Failed Over" column indicates the users that have failed over to the backup node.

                Perform manual fallback to primary node

                You can perform a manual fallback to the primary node in the Cluster Topology interface. When you initiate a manual fallback, the Cisco Server Recovery Manager restarts any critical services that are not already running on the primary node, and moves the failed over users back to the primary node.

                When you manually initiate a fallback, the Cisco Server Recovery Manager restarts the following services on the primary node (if they are not already running):

                • Cisco SIP Proxy
                • Cisco Presence Engine
                • Cisco XCP Router
                • Any XCP services that were activated
                • Cisco Client Profile Agent

                The Cisco Server Recovery Manager then moves all failed over users back to the primary node.

                Restriction

                You can only initiate fallback for a node that is in ‘Idle’ or ‘Failed Over’ state.

                Procedure
                  Step 1   Cisco Unified Communications Manager IM and Presence Administration > System > Cluster Topology.
                  Step 2   Select the edit link on the appropriate subcluster.
                  Step 3   Select Fallback in the Node Action column.
                  Step 4   Select Ok to confirm the fallback operation.
                  Step 5   To verify the fallback operation is complete and successful:
                  1. When fallback operation is in progress, the primary node should be in the "Taking Back" state, and the backup node should be in the "Falling Back" state. When the fallback operation is complete, check that both nodes are in ‘Normal’ state. If the fallback is unsuccessful, and the nodes are in a failed state.
                  2. Check that the users have fallen back to the primary node.
                    • On the subcluster details screen, check that all users are now assigned to the primary node, and no users are assigned to the backup node.
                    • On the node details screen, the "Failed Over" column should be empty.

                  Perform manual recovery of subcluster

                  When you perform a manual recovery of a subcluster, IM and Presence restarts the Cisco Server Recovery Manager service on both nodes in the subcluster.

                  Restriction

                  You can only initiate a recovery for a subcluster if both nodes are in a failed state.

                  Procedure
                    Step 1   Cisco Unified Communications Manager IM and Presence Administration > System > Cluster Topology.
                    Step 2   Select the edit link on the appropriate subcluster.
                    Step 3   Select Recovery in the Node Action column.
                    Step 4   Verify the status of the subcluster after you perform the manual recovery.

                    Troubleshooting Tips

                    In prior releases, if two nodes in the subcluster think that they own the same user, both nodes will go into a failed state, and you had to perform a manual recovery from the Cluster Topology interface. In this release manual recovery is not required. When the network issue is resolved, auto-recovery occurs without administrator intervention.

                    If manual recovery is required for another reason, you may experience IDS replication delays. You can check the status of the IDS replication on a node using this CLI command:

                    Utils dbreplication runtimestate

                    Cluster-wide routing information configuration on IM and Presence

                    Domain value configuration

                    Replace default domain value

                    The domain name specifies the DNS domain name of the IM and Presence server. IM and Presence automatically defaults to the domain name DOMAIN.NOT.SET. You must replace this default domain name with the DNS domain name in order for the SRM to initialize correctly in a High Availability deployment. If you are not using DNS in your network, and you did not set the domain at install, you must replace this default value with the enterprise wide domain and ensure the node names are configured as IP addresses or IM and Presence will not function correctly.

                    Perform this configuration on all nodes in your IM and Presence cluster.

                    Procedure
                      Step 1   Perform the following steps to configure the new domain value:
                      1. Select Cisco Unified CM IM and Presence Administration > System > Cluster Topology.
                      2. In the right pane, select Settings.
                      3. Configure the Domain Name value with the new domain.
                      4. Select Cisco Unified CM IM and Presence Administration > System > Service Parameters, and select the Cisco SIP Proxy service.
                      5. Configure the Federation Routing CUP FQDN with the new domain.
                      6. You will be prompted to confirm these configuration changes. Select OK for both prompts, and then select Save.
                      Step 2   Use this CLI command to set the new domain: set network domain <new_domain>

                      This CLI command invokes a reboot of the server.

                      Step 3   Manually regenerate all certificates on the local IM and Presence server.
                      Note   

                      When you regenerate the Tomcat certificate, you must restart Tomcat. You can restart Tomcat after you regenerate all of the certificates on the local server. Use this CLI command to restart Tomcat: utils service restart Cisco Tomcat


                      Change domain value

                      Follow this procedure if you want to change the domain value (from one valid domain value to another valid IP proxy domain value).

                      This procedure is applicable if you have a DNS or non-DNS deployment.


                      Note


                      It is highly recommended that you use a DNS deployment. In order to be considered valid, the domain value must match the DNS domain name. Using a valid domain name ensures that the SRM initializes correctly in a High Availability deployment.


                      Procedure
                        Step 1   Stop the Cisco SIP Proxy, Presence Engine and XCP Router services on IM and Presence on all nodes in your cluster.
                        Step 2   On the publisher node, perform the following steps to configure the new domain value:
                        1. Select Cisco Unified CM IM and Presence Administration > System > Cluster Topology.
                        2. In the right pane, select Settings.
                        3. Configure the Domain Name value with the new domain.
                        4. Select Cisco Unified CM IM and Presence Administration > System > Service Parameters, and select the Cisco SIP Proxy service.
                        5. Configure the Federation Routing IM and Presence FQDN with the new domain.
                        6. You will be prompted to confirm these configuration changes. Select OK for both prompts, and then select Save.
                        Step 3   On all nodes in the cluster, use this CLI command to set the new domain: set network domain <new_domain>

                        This CLI command invokes a reboot of the servers

                        Step 4   On all nodes in the cluster, manually start the Cisco Presence Engine and Cisco XCP Router services after the reboot is complete (if required).
                        Step 5   Manually regenerate all certificates on each node in the cluster.
                        Note   

                        When you regenerate the Tomcat certificate, you must restart Tomcat. You can restart Tomcat after you regenerate all of the certificates on the local server. Use this CLI command to restart Tomcat: utils service restart Cisco Tomcat

                        Step 6   If you use DNS in your network, update the DNS configuration for the new domain. Update any host records and any DNS SRV records that you require for the new domain
                        Step 7   Configure any XMPP clients with the new domain.

                        Routing communication type

                        Routing Communication Recommendations

                        MDNS is the default mechanism for establishing the XCP route fabric on IM and Presence Service; the network automatically establishes router-to-router connections between all IM and Presence Service nodes in a cluster. A requirement for MDNS routing is that all nodes in the cluster are in the same multicast domain. We recommend MDNS routing because it can seamlessly support new XCP routers joining the XCP route fabric.

                        If you choose MDNS as the routing communication, you must have multicast DNS enabled in your network. In some networks multicast is enabled by default, or enabled in a certain area of the network, for example, in an area that contains the nodes that form the cluster. In these networks, you do not need to perform any additional configuration in your network to use MDNS routing. When multicast DNS is disabled in the network, MDNS packets cannot reach the other nodes in a cluster. If multicast DNS is disabled in your network, you must perform a configuration change to your network equipment to use MDNS routing.

                        Alternatively, you can choose router-to-router communication for your deployment. In this case, IM and Presence Service dynamically configures all router-to-router connections between nodes in a cluster. Choose this routing configuration type if all the nodes in your cluster are not in the same multicast domain. Note that when you choose router-to-router communication:

                        • Your deployment will incur the additional performance overhead while IM and Presence Service establishes the XCP route fabric.
                        • You do not need to restart the Cisco XCP Router on all nodes in your deployment when you add a new node.
                        • If you delete or remove a node, you must restart the Cisco XCP Router on all nodes in your deployment.

                        Configure MDNS Routing and Cluster ID

                        At installation, the system assigns a unique cluster ID to the IM and Presence database publisher node. The systems distributes the cluster ID so that all nodes in your cluster share the same cluster ID value. The nodes in the cluster use the cluster ID to identify other nodes in the multicast domain using MDNS. A requirement for MDNS routing is that the cluster ID value is unique to prevent nodes in one standalone IM and Presence Service cluster from establishing router-to-router connections with nodes in another standalone cluster. Standalone clusters should only communicate over intercluster peer connections.

                        Choose Cisco Unified CM IM and Presence Administration > System > Cluster Topology > Settings to view or configure the cluster ID value for a cluster. If you change the cluster ID value, make sure that the value remains unique to your IM and Presence Service deployment.


                        Note


                        If you deploy the Chat feature, IM and Presence Service uses the cluster ID value to define chat node aliases. There are certain configuration scenarios that may require you to change the cluster ID value. See the Group Chat module for details.


                        Configure Routing Communication

                        To allow the nodes in a cluster to route messages to each other, you must configure the routing communication type. This setting determines the mechanism for establishing router connections between nodes in a cluster. Configure the routing communication type on the IM and Presence database publisher node, and IM and Presence Service applies this routing configuration to all nodes in the cluster.

                        For single node IM and Presence Service deployments, we recommend that you leave the routing communication type at the default setting.


                        Caution


                        You must configure the routing communication type before you complete your cluster configuration and start to accept user traffic into your IM and Presence Service deployment.


                        Before You Begin
                        • If you want to use MDNS routing, confirm that MDNS is enabled in your network.
                        • If you want to use router-to-router communication, and DNS is not available in your network, for each node you must configure the IP address as the node name in the cluster topology. To edit the node name, choose Cisco Unified CM IM and Presence Administration > System > Cluster Topology, and click the edit link on a node. Perform this configuration after you install IM and Presence Service, and before you restart the Cisco XCP Router on all nodes.
                        Attention:

                        When using the Cisco Jabber client, certificate warning messages can be encountered if the IP address is configured as the IM and Presence Service node name. To prevent Cisco Jabber from generating certificate warning messages, the FQDN should be used as the node name.

                        Procedure
                          Step 1   Choose Cisco Unified CM IM and Presence Administration > System > Cluster Topology.
                          Step 2   In the right pane, choose Settings.
                          Step 3   Choose one of these Routing Communication Types from the menu:
                          • Multicast DNS (MDNS) - Choose Multicast DNS communication if the nodes in your cluster are in the same multicast domain. Multicast DNS communication is enabled by default on IM and Presence Service.
                          • Router to Router - Choose Router-to-Router communication if the nodes in your cluster are not in the same multicast domain.
                          Step 4   Click Save.
                          Step 5   Restart the Cisco XCP Router service on all nodes in your deployment.

                          Configure Cluster ID

                          At installation, the system assigns a default unique cluster ID to the IM and Presence database publisher node. If you configure multiple nodes in the cluster, the systems distributes the cluster ID so that each node in your cluster shares the same cluster ID value.

                          We recommend that you leave the cluster ID value at the default setting. If you do change the cluster ID value, note the following:

                          • If you choose MDNS routing, all nodes must have the same cluster ID to allow them to identify other nodes in the multicast domain.
                          • If you are deploying the Group Chat feature, IM and Presence Service uses the cluster ID value for chat node alias mappings, and there are certain configuration scenarios that may require you to change the cluster ID value. See the Group Chat module for details.

                          If you change the default Cluster ID value, you only need to make this change on the IM and Presence database publisher node, and the system replicates the new Cluster ID value to the other nodes in the cluster.

                          Procedure
                            Step 1   Choose Cisco Unified CM IM and Presence Administration > System > Cluster Topology.
                            Step 2   In the right pane, choose Settings.
                            Step 3   View or edit the Cluster ID value.
                            Note   

                            By default, IM and Presence Service assigns the cluster ID value "StandaloneCluster" to a cluster.

                            Step 4   Click Save.
                            Tip   

                            IM and Presence Service does not permit the underscore character (_) in the Cluster ID value. Ensure the Cluster ID value does not contain this character.


                            Configure Cluster-Wide DNS SRV Name for SIP Publish Trunk

                            When you configure the cluster-wide IM and Presence Service address on the IM and Presence database publisher node, IM and Presence Service replicates the address on all nodes in the cluster.

                            Set the SRV port value to 5060 when you configure a cluster-wide IM and Presence Service address.


                            Note


                            Do not use this procedure to change the SRV Cluster Name value if the IM and Presence Service default domain is used in the cluster-wide DNS SRV record. No further action is needed.


                            Before You Begin

                            Read the cluster-wide DNS SRV topic.

                            Procedure
                              Step 1   Choose Cisco Unified CM IM and Presence Administration > System > Service Parameters.
                              Step 2   Choose the IM and Presence Service node from the Server menu.
                              Step 3   Choose Cisco SIP Proxy from the Service menu.
                              Step 4   Edit the SRV Cluster Name field in the General Proxy Parameters (Clusterwide) section.

                              By default this parameter is empty.

                              Step 5   Click Save.

                              Configure Throttling Rate for Availability State Change Messages

                              To prevent an overload of the on IM and Presence Service, you can configure the rate of availability (presence) changes sent to the Cisco XCP Router in messages per second. When you configure this value, IM and Presence Service throttles the rate of availability (presence) changes back to meet the configured value.

                              Procedure
                                Step 1   Choose Cisco Unified CM IM and Presence Administration > System > Service Parameters.
                                Step 2   Choose the IM and Presence Service node from the Server menu.
                                Step 3   Choose Cisco Presence Engine from the Service menu.
                                Step 4   In the Clusterwide Parameters section, edit the Presence Change Throttle Rate parameter. This parameter defines the number of presence updates per second.
                                Step 5   Click Save.

                                Static Route Configuration on IM and Presence Service

                                If you configure a static route for SIP proxy server traffic, consider the following:

                                • A dynamic route represents a path through the network that is automatically calculated according to routing protocols and routing update messages.
                                • A static route represents a fixed path that you explicitly configure through the network.
                                • Static routes take precedence over dynamic routes.

                                Route Embed Templates

                                You must define a route embed template for any static route pattern that contains embedded wildcards. The route embed template contains information about the leading digits, the digit length, and location of the embedded wildcards. Before you define a route embed template, consider the sample templates we provide below.

                                When you define a route embed template, the characters that follow the "." must match actual telephony digits in the static route. In the sample route embed templates below, we represent these characters with "x".

                                Sample Route Embed Template A

                                Route embed template: 74..78xxxxx*

                                With this template, IM and Presence Service will enable this set of static routes with embedded wildcards:

                                Table 2 Static Routes Set with Embedded Wildcards - Template A

                                Destination Pattern

                                Next Hop Destination

                                74..7812345*

                                1.2.3.4:5060

                                74..7867890*

                                5.6.7.8.9:5060

                                74..7811993*

                                10.10.11.37:5060

                                With this template, IM and Presence Service will not enable these static route entries:

                                • 73..7812345* (The initial string is not ‘74’ as the template defines)
                                • 74..781* (The destination pattern digit length does not match the template)
                                • 74…7812345* (The number of wildcards does not match the template)

                                Sample Route Embed Template B

                                Route embed template: 471….xx*

                                With this template, IM and Presence Service will enable this set of static routes with embedded wildcards:

                                Table 3 Static Routes Set with Embedded Wildcards - Template B

                                Destination Pattern

                                Next Hop Destination

                                471….34*

                                20.20.21.22

                                471…55*

                                21.21.55.79

                                With this template, IM and Presence Service will not enable these static route entries:

                                • 47…344* (The initial string is not ‘471’ as the template defines)
                                • 471…4* (The string length does not match template)
                                • 471.450* (The number of wildcards does not match template)

                                Configure Route Embed Templates on IM and Presence Service

                                You can define up to five route embed templates. However, there is no limit to the number of static routes that you can define for any route embed template.

                                A static route that contains an embedded wildcard must match at least one of the route embed templates.

                                Procedure
                                  Step 1   Choose Cisco Unified CM IM and Presence Administration > System > Service Parameters.
                                  Step 2   Choose an IM and Presence Service node.
                                  Step 3   Choose the Cisco SIP Proxy service.
                                  Step 4   Define a route embed templates in the RouteEmbedTemplate field in the Routing Parameters (Clusterwide) section. You can define up to five route embed templates.
                                  Step 5   Choose Save.

                                  What to Do Next

                                  Proceed to configure static routes on IM and Presence Service.

                                  Configure Static Routes on IM and Presence Service

                                  The following table lists the static route parameter settings that you can configure for IM and Presence Service.

                                  Table 4 Static Route Parameters Settings for IM and Presence Service

                                  Field

                                  Description

                                  Destination Pattern

                                  This field specifies the pattern of the incoming number, up to a maximum of 255 characters.

                                  The SIP proxy allows only 100 static routes to have an identical route pattern. If you exceed this limit, IM and Presence Service logs an error.

                                  Wildcard Usage

                                  You can use "." as a wildcard for a single character and "*" as a wildcard for multiple characters.

                                  IM and Presence Service supports embedded '.' wildcard characters in static routes. However, you must define route embed templates for static routes that contain embedded wildcards. Any static route that contains an embedded wildcard must match at least one route embed template. See the route embed template topic (referenced in the Related Topics section below) for information about defining route embed templates.

                                  For phones:

                                  • A dot can exist at the end of the pattern, or embedded in a pattern. If you embed the dot in a pattern, you must create a route embed template to match the pattern.
                                  • An asterisk can only exist at the end of the pattern.

                                  For IP addresses and host names:

                                  • You can use an asterisk as part of the a host name.
                                  • The dot acts as a literal value in a host name.

                                  An escaped asterisk sequence, \*, matches a literal * and can exist anywhere.

                                  Description

                                  Specifies the description of a particular static route, up to a maximum of 255 characters.

                                  Next Hop

                                  Specifies the domain name or IP address of the destination (next hop) and can be either a Fully Qualified Domain Name (FQDN) or dotted IP address.

                                  IM and Presence Service supports DNS SRV-based call routing. To specify DNS SRV as the next hop for a static route, set this parameter to the DNS SRV name.

                                  Next Hop Port

                                  Specifies the port number of the destination (next hop). The default port is 5060.

                                  IM and Presence Service supports DNS SRV-based call routing. To specify DNS SRV as the next hop for a static route, set the next hop port parameter to 0.

                                  Route Type

                                  Specifies the route type: User or Domain. The default value is user.

                                  For example, in the SIP URI "sip:19194762030@myhost.com" request, the user part is "19194762030", and the host part is "myhost.com". If you choose User as the route type, IM and Presence Service uses the user-part value "19194762030" for routing SIP traffic. If you choose the Domain as the route type, IM and Presence Service uses "myhost.com" for routing SIP traffic.

                                  Protocol Type

                                  Specifies the protocol type for this route, TCP, UDP, or TLS. The default value is TCP.

                                  Priority

                                  Specifies the route priority level. Lower values indicate higher priority. The default value is 1.

                                  Value range: 1-65535

                                  Weight

                                  Specifies the route weight. Use this parameter only if two or more routes have the same priority. Higher values indicate which route has the higher priority.

                                  Value range: 1-65535

                                  Example: Consider these three routes with associated priorities and weights:

                                  • 1, 20
                                  • 1, 10
                                  • 2, 50

                                  In this example, the static routes are listed in the correct order. The priority route is based on the lowest value priority, that is 1. Given that two routes share the same priority, the weight parameter with the highest value decides the priority route. In this example, IM and Presence Service directs SIP traffic to both routes configured with a priority value of 1, and distributes the traffic according to weight; The route with a weight of 20 receives twice as much traffic as the route with a weight of 10. Note that in this example, IM and Presence Service will only attempt to use the route with priority 2, if it has tried both priority 1 routes and both failed.

                                  Allow Less-Specific Route

                                  Specifies that the route can be less specific. The default setting is On.

                                  In Service

                                  Specifies whether this route has been taken out of service.

                                  This parameter allows the administrator to effectively take a route out of service (versus removing it completely and re-adding it).

                                  Block Route Check Box

                                  Check to block the static route. The default setting is Unblocked.

                                  Procedure
                                    Step 1   Choose Cisco Unified CM IM and Presence Administration > Routing > Static Routes.
                                    Step 2   Click Add New.
                                    Step 3   Configure the static route settings.
                                    Step 4   Click Save.

                                    Presence Gateway configuration on IM and Presence

                                    Presence Gateway Configuration Option

                                    You must configure Cisco Unified Communications Manager as a Presence Gateway on IM and Presence Service to enable the SIP connection that handles the availability information exchange between Cisco Unified Communications Manager and IM and Presence Service.

                                    When configuring the Presence Gateway, specify the FQDN (Fully Qualified Domain Name) or the IP address of the associated Cisco Unified Communications Manager node. Depending on your network this value can be one of the following:

                                    • the FQDN address of the Cisco Unified Communications Manager database publisher node
                                    • a DNS SRV FQDN that resolves to the Cisco Unified Communications Manager subscriber nodes
                                    • the IP address of the Cisco Unified Communications Manager database publisher node

                                    If DNS SRV is an option in your network, configure the following:

                                    1. Configure the Presence Gateway on the IM and Presence Service node with a DNS SRV FQDN of the Cisco Unified Communications Manager subscriber nodes (equally weighted). This will enable IM and Presence Service to share availability messages equally among all the nodes used for availability information exchange.
                                    2. On Cisco Unified Communications Manager, configure the SIP trunk for the IM and Presence Service node with a DNS SRV FQDN of the IM and Presence Service database publisher and subscriber nodes.

                                    If DNS SRV is not an option in your network, and you are using the IP address of the associated Cisco Unified Communications Manager node, you cannot share presence messaging traffic equally across multiple subscriber nodes because the IP address points to a single subscriber node.

                                    Configure Presence Gateway

                                    Before You Begin
                                    • Read the Presence Gateway configuration options topic.
                                    • Depending on your configuration requirements, obtain the FQDN, DNS SRV FQDN, or the IP address of the associated Cisco Unified Communications Manager node.
                                    Procedure
                                      Step 1   Choose Cisco Unified CM IM and Presence Administration > Presence > Gateways.
                                      Step 2   Click Add New.
                                      Step 3   Choose CUCM for the Presence Gateway Type.
                                      Step 4   Enter a description of the presence gateway in the Description field.
                                      Step 5   Specify the FQDN, DNS SRV FQDN, or the IP address of the associated Cisco Unified Communications Manager node in the Presence Gateway field.
                                      Step 6   Click Save.

                                      What to Do Next

                                      Proceed to configure the authorization policy on IM and Presence Service.

                                      Authorization policy configuration on IM and Presence

                                      Automatic Authorization On IM and Presence Service

                                      IM and Presence Service authorizes all presence subscription requests that it receives from SIP-based clients in the local enterprise. A local user running a SIP-based client automatically receives the availability status for contacts in the local enterprise, without being prompted to authorize these subscriptions on the client. IM and Presence Service only prompts the user to authorize the subscription of a contact in the local enterprise if the contact is on the blocked list for the user. This is the default authorization behavior for SIP-based clients on IM and Presence Service, and you cannot configure this behavior.

                                      In the XMPP network, it is standard behavior for the node to send all presence subscriptions to the client, and the client prompts the user to authorize or reject the subscription. To allow enterprises to deploy IM and Presence Service with a mix of SIP-based and XMPP-based clients (to align the authorization policy for both client types), Cisco provides the following automatic authorization setting on IM and Presence Service:

                                      • When you turn on automatic authorization, IM and Presence Service automatically authorizes all presence subscription requests it receives from both XMPP-based clients and SIP-based in the local enterprise. This is the default setting on IM and Presence Service.
                                      • When you turn off automatic authorization, IM and Presence Service only supports XMPP-based clients. For XMPP-based clients, IM and Presence Service sends all presence subscriptions to the client, and the client prompts the user to authorize or reject the presence subscription. SIP-based clients will not operate correctly on IM and Presence when you turn off automatic authorization.

                                      Caution


                                      If you turn off automatic authorization, SIP-based clients are not supported. Only XMPP-based clients (Cisco Unified Personal Communicator Release 8.0 and third-party XMPP clients) are supported when you turn off automatic authorization.


                                      User Policy and Automatic Authorization

                                      In addition to reading the automatic authorization policy, IM and Presence Service reads the policy settings for the user to determine how to handle presence subscription requests. Users configure the policy settings from either the Cisco Unified Personal Communicator client and the Cisco Unified CM IM and Presence User Options interface. A user policy contains the following configuration options:

                                      • Blocked list - a list of local and external (federated) users that will always see the availability status of the user as unavailable regardless of the true status of the user. The user can also block a whole federated domain.
                                      • Allowed list - a list of local and external users that the user has approved to see their availability. The user can also allow a whole external (federated) domain.
                                      • Default policy - the default policy settings for the user. The user can set the policy to block all users, or allow all users.

                                      On the Cisco Unified CM IM and Presence User Options interface, the user can also choose an "ask me" setting so that the user is prompted to set their own Allow/Block policy for external contacts (except those external contacts that a user explicitly adds to their Allowed/Blocked list).

                                      Note that if you turn off automatic authorization, IM and Presence Service automatically authorizes subscription requests a user that is on the contact list of another user. This applies to users in the same domain, and users in different domains (federated users). For example:

                                      • UserA wishes to subscribe the view the availability status of UserB. Automatic authorization is off on IM and Presence Service, and UserB is not in the Allowed or Blocked list for the UserA.
                                      • IM and Presence Service sends the presence subscription request to the client application of UserB, and the client application prompts userB to accept or reject the subscription.
                                      • UserB accepts the presence subscription request, and UserB is added to the contact list of UserA.
                                      • UserA is then automatically added to the contact list for UserB without being prompted to authorize the presence subscription.

                                      IM and Presence Service will automatically add UserA to the contact list of UserB even if the policy for UserB (i) blocks the external domain, or (ii) the default policy for the user is block all, or (iii) "ask me" is chosen.

                                      If you deploy interdomain federation between a local IM and Presence Service enterprise and a supported external enterprise, IM and Presence Service does not apply the automatic authorization setting to presence subscription requests received from external contacts, unless the user has applied a policy on that external contact or domain. On receipt of a presence subscription request from an external contact, IM and Presence Service will only send the subscription request to the client application if the user chooses "ask me" to be prompted to set their own Allow/Block policy for external contacts, and if the external contact or domain is not in either the Allowed or Blocked list for the user. The client application prompts the user to authorize or reject the subscription.


                                      Note


                                      IM and Presence Service uses common user policies for both availability and instant messages.


                                      Configure Authorization Policy on IM and Presence Service

                                      You can turn on automatic authorization so that IM and Presence Service automatically authorizes all presence subscription requests it receives from both XMPP-based clients and SIP-based in the local enterprise. If you turn off automatic authorization, IM and Presence Service only supports XMPP-based clients and sends all presence subscriptions to the client where the user is prompted to authorize or reject the presence subscription.


                                      Tip


                                      See the Online Help topic in the Cisco Unified CM IM and Presence Administration interface for a definition of all the parameters on this window.


                                      Procedure
                                        Step 1   Choose Cisco Unified CM IM and Presence Administration > Presence > Settings.
                                        Step 2   Configure the authorization policy. Perform one of the following actions:
                                        • To turn on automatic authorization, check Allow users to view the availability of other users without being prompted for approval.
                                        • To turn off automatic authorization, uncheck Allow users to view the availability of other users without being prompted for approval..
                                        Step 3   Click Save.
                                        Step 4   Restart the Cisco XCP Router service.

                                        What to Do Next

                                        Proceed to configure the SIP publish trunk on IM and Presence Service.

                                        Bulk Export User Contact Lists

                                        The IM and Presence Service Bulk Administration Tool (BAT) allows you to export the contact lists of users who belong to a particular node or subcluster to a CSV data file. You can then use BAT to import the user contact lists to another node or subcluster in a different cluster. The BAT user contact list export and import features facilitate the moving of users between clusters. See topics related to bulk imports of user contact lists for more information.

                                        BAT allows you to find and choose the users whose contact lists you want to export. The user contact lists are exported to a CSV file with the following format:

                                        <User ID>,<User Domain>,<Contact ID>,<Contact Domain>,<Nickname>,<Group Name>

                                        The following table describes the parameters in the export file.

                                        Parameter Description
                                        User ID The user ID of the IM and Presence Service user.
                                        User Domain The Presence domain of the IM and Presence Service user.
                                        Contact ID The user ID of the contact list entry.
                                        Contact Domain The Presence domain of the contact list entry.
                                        Nickname

                                        The nickname of the contact list entry.

                                        If the user has not specified a nickname for a contact, the Nickname parameter will be blank.

                                        Group Name

                                        The name of the group to which the contact list entry is to be added.

                                        If a user’s contacts are not sorted into groups, the default group name will be specified in the Group Name field.

                                        The following is a sample CSV file entry:

                                        userA,example.com,userB,example.com,buddyB,General

                                        Complete the following procedure to export user contact lists with BAT and download the export file.

                                        Procedure
                                          Step 1   Choose Cisco Unified CM IM and Presence Administration > Bulk Administration > Contact List > Export.
                                          Step 2   Use the selection criteria to find the users whose contact lists you want to export. See the Online Help topic in the Cisco Unified CM IM and Presence Administration interface for more information about finding and selecting users.
                                          Step 3   Click Next.
                                          Step 4   In the File Name field, enter a name for the CSV file.
                                          Step 5   Choose one of the following:
                                          • Click Run Immediately to execute the Bulk Administration job immediately.
                                          • Click Run Later to schedule a time to execute the Bulk Administration job. For more information about scheduling jobs in BAT, see the Online Help in Cisco Unified CM IM and Presence Administration.
                                          Step 6   Click Submit. If you chose to run the job immediately, the job runs after you click Submit.
                                          Step 7   To download the export file after the job has run, choose Cisco Unified CM IM and Presence Administration > Bulk Administration > Upload/Download Files.
                                          Step 8   Find and choose the export file that you want to download.
                                          Step 9   Click Download Selected.

                                          Bulk Import Of User Contact Lists

                                          You can use the IM and Presence Service Bulk Assignment Tool (BAT) to import user contact lists into IM and Presence Service. With this tool, you can prepopulate contact lists for new IM and Presence Service client users or add to existing contact lists. To import user contact lists, you must provide BAT with an input file that contains the user contact lists.

                                          The input file must be a CSV file in the following format:

                                          <User ID>,<User Domain>,<Contact ID>,<Contact Domain>,<Nickname>,<Group Name>

                                          The following is a sample CSV file entry:

                                          userA,example.com,userB,example.com,buddyB,General

                                          The following table describes the parameters in the input file.

                                          Table 5 Description of Input File Parameters

                                          Parameter

                                          Description

                                          User ID

                                          This is a mandatory parameter.

                                          The user ID of the IM and Presence Service user. It can have a maximum 132 characters.

                                          User Domain

                                          This is a mandatory parameter.

                                          The Presence domain of the IM and Presence Service user. It can have a maximum of 128 characters.

                                          Contact ID

                                          This is a mandatory parameter.

                                          The user ID of the contact list entry. It can have a maximum of 132 characters.

                                          Contact Domain

                                          This is a mandatory parameter.

                                          The Presence domain of the contact list entry. The following restrictions apply to the format of the domain name:

                                          • Length must be less than or equal to 128 characters
                                          • Contains only numbers, upper- and lowercase letters, and hyphens (-)
                                          • Must not start or end with hyphen (-)
                                          • Length of label must be less than or equal to 63 characters
                                          • Top-level domain must be characters only and have at least two characters

                                          Nickname

                                          The nickname of the contact list entry. It can have a maximum of 255 characters.

                                          Group Name

                                          This is a mandatory parameter.

                                          The name of the group to which the contact list entry is to be added. It can have a maximum of 255 characters.


                                          Note


                                          If you are moving users to another node or subcluster in a different cluster, you can use BAT to generate the CSV file for chosen users. See topics related to bulk exports of user contact lists for more information.


                                          Complete the following steps to import user contact lists into IM and Presence Service:

                                          • Check the maximum contact list size.
                                          • Upload the input file using BAT.
                                          • Create a new bulk administration job.
                                          • Check the results of the bulk administration job.

                                          Before You Begin

                                          Before you import the user contact lists, you must complete the following:

                                          1. Provision the users on Cisco Unified Communications Manager.
                                          2. Ensure that the users are licensed on Cisco Unified Communications Manager for the IM and Presence Service.

                                          Note


                                          The default contact list import rate is based on the server hardware type. You can change the contact list import rate by choosing Cisco Unified CM IM and Presence Administration > System > Service Parameters > Cisco Bulk Provisioning Service. However, if you increase the default import rate, this will result in higher CPU and memory usage on IM and Presence Service.


                                          Check Maximum Contact List Size

                                          Before you import contact lists to IM and Presence Service, check the Maximum Contact List Size and Maximum Watchers settings. The system default value is 200 for Maximum Contact List Size and 200 for Maximum Watchers.

                                          Cisco recommends that you set the Maximum Contact List Size and Maximum Watchers settings to Unlimited while importing user contact lists to IM and Presence Service. This ensures that each migrated user contact list is fully imported. After all users have migrated, you can reset the Maximum Contact List Size and Maximum Watchers settings to the preferred values.


                                          Note


                                          It is possible to exceed the maximum contact list size without losing data when importing contact lists using BAT; however, Cisco recommends temporarily increasing the Maximum Contact List Size setting or setting the value to Unlimited for the import. You can reset the maximum value after the import is complete.


                                          You only need to check the maximum contact list size on those clusters that contain users for whom you wish to import contacts. When you change Presence settings, the changes are applied to all nodes in the cluster; therefore you only need to change these settings on the IM and Presence database publisher node within the cluster.

                                          What To Do Next

                                          Upload the input file using BAT.

                                          Upload Input File Using BAT

                                          The following procedure describes how to upload the CSV file using BAT.

                                          Procedure
                                            Step 1   Choose Cisco Unified CM IM and Presence Administration > Bulk Administration > Upload/Download Files.
                                            Step 2   Click Add New.
                                            Step 3   Click Browse to locate and choose the CSV file.
                                            Step 4   Choose Contact Lists as the Target.
                                            Step 5   Choose Import Users’ Contacts – Custom File as the Transaction Type.
                                            Step 6   Click Save to upload the file.

                                            What to Do Next

                                            Create a new bulk administration job.

                                            Create New Bulk Administration Job

                                            The following procedure describes how to create a new bulk administration job in Cisco Unified CM IM and Presence Administration.

                                            Procedure
                                              Step 1   Choose Cisco Unified CM IM and Presence Administration > Bulk Administration > Contact List > Update.
                                              Step 2   From the File Name drop-down list, choose the file to import.
                                              Step 3   In the Job Description field, enter a description for this Bulk Administration job.
                                              Step 4   Choose one of the following:
                                              • Click Run Immediately to execute the Bulk Administration job immediately.
                                              • Click Run Later to schedule a time to execute the Bulk Administration job. For more information about scheduling jobs in BAT, see the Online Help in Cisco Unified CM IM and Presence Administration.
                                              Step 5   Click Submit. If you chose to run the job immediately, the job runs after you click Submit.

                                              What to Do Next

                                              Check the results of the bulk administration job.

                                              Check Results of Bulk Administration Job

                                              When the Bulk Administration job is complete, the IM and Presence Service BAT tool writes the results of the contact list import job to a log file. The log file contains the following information:

                                              • The number of contacts that were successfully imported.
                                              • The number of internal server errors that were encountered while trying to import the contacts.
                                              • The number of contacts that were not imported (ignored). The log file lists a reason for each ignored contact at the end of the log file. The following are the reasons for not importing a contact:
                                                • Invalid format - invalid row format, for example, a required field is missing or empty
                                                • Invalid contact domain - the contact domain is in an invalid format. See topics related to bulk import of user contact lists for the valid format of the contact domain
                                                • Cannot add self as a contact - you cannot import a contact for a user if the contact is the user
                                                • User’s contact list is over limit - the user has reached the maximum contact list size and no more contacts can be imported for that user
                                                • User is not assigned to local node - the user is not assigned to the local node
                                              • The number of contacts in the CSV file that were unprocessed due to an error that caused the BAT job to finish early. This error rarely occurs.

                                              Complete the following procedure to access this log file.

                                              Procedure

                                              Procedure
                                                Step 1   Choose Cisco Unified CM IM and Presence Administration > Bulk Administration > Job Scheduler.
                                                Step 2   Click Find and choose the job ID of the contact list import job.
                                                Step 3   Click the Log File Name link to open the log.

                                                Availability settings configuration on IM and Presence

                                                Turn On or Off Availability Sharing for IM and Presence Service Cluster

                                                This procedure describes how to turn on or off availability sharing for all client applications in a IM and Presence Service cluster.

                                                Availability sharing is turned on by default on IM and Presence Service.

                                                Procedure
                                                  Step 1   Choose Cisco Unified CM IM and Presence Administration > Presence > Settings.
                                                  Step 2   Configure the availability setting. Perform one of the following actions:
                                                  • To turn on availability sharing in the IM and Presence Service cluster, check Enable availability sharing.. If you turn on this setting, IM and Presence Service shares availability information for a user amongst all users in the cluster, based on the policy settings for that user. The default policy setting for a user is to allow all other users view their availability. Users configure their policy settings from either the Cisco Unified Personal Communicator client and the Cisco Unified CM IM and Presence User Options interface.
                                                  • To turn off availability sharing for all clients in the IM and Presence Service cluster, uncheck Enable availability sharing.. If you turn off this setting, IM and Presence Service does not share any availability to other users in the IM and Presence Service cluster, nor does it share availability information it receives from outside the cluster. Users can only view their own availability status.
                                                  Step 3   Click Save.
                                                  Step 4   Restart the following services:
                                                  1. Cisco XCP Router
                                                  2. Cisco Presence Engine

                                                    Troubleshooting Tips

                                                    • When you turn off availability sharing, a user can view their own availability status on the client application; the availability status for all other users are greyed out.
                                                    • When you turn off availability sharing, when a user enters a chat room, their availability status shows a status of "Unknown" with a green icon.

                                                  Configure Do Not Disturb Settings On IM and Presence Service

                                                  You can configure global administrator-level Do Not Disturb (DND) availability states as an alternative to the Busy state for phone calls and meetings. IM and Presence Service then sets global administrator-level Do Not Disturb (DND) availability states on all instant message client applications.

                                                  Note the following behavior for the DND feature:

                                                  • IM and Presence Service does not pass the administrator-level DND status to associated devices for the user.
                                                  • The administrator-level DND settings impact future calls and meetings, not those calls and meetings in progress at the time that you configure the DND setting.

                                                  If you turn off availability sharing on IM and Presence Service, the DND settings only impact users when they view their own availability.

                                                  Procedure
                                                    Step 1   Choose Cisco Unified CM IM and Presence Administration > Presence > Settings.
                                                    Step 2   Configure the administrator-level DND setting as follows:
                                                    • To display an availability status of DND when users are on the phone, check Use DND status when user is on the phone. This setting is turned off by default.
                                                      Tip   

                                                      If you turn off (uncheck) this setting, IM and Presence displays a status of Busy when users are on the phone.

                                                    • To display an availability status of DND when users are in a meeting, check Use DND status when user is in a meeting. This setting is turned off by default.
                                                      Tip   

                                                      If you turn off (uncheck) this setting, IM and Presence displays a status of Busy when users are in a meeting.

                                                    Step 3   Click Save.

                                                    Configure Ad-Hoc Presence Subscription Settings


                                                    Note


                                                    This section only applies if you deploy Cisco Unified Personal Communicator Release 8.5 or higher with IM and Presence Service.


                                                    These settings allow Cisco Unified Personal Communicator users to initiate ad-hoc presence subscriptions to users that are not on their contact list.

                                                    Procedure
                                                      Step 1   Choose Cisco Unified CM IM and Presence Administration > Presence > Settings.
                                                      Step 2   Check Enable ad-hoc presence subscriptions to turn on ad-hoc presence subscriptions for Cisco Unified Personal Communicator users.
                                                      Step 3   Set the maximum number of active ad-hoc subscriptions that IM and Presence Service permits at one time. If you configure a value of zero, IM and Presence Service permits an unlimited number of active ad-hoc subscriptions.
                                                      Step 4   Set the time-to-live value (in seconds) for the ad-hoc presence subscriptions.

                                                      When this time-to-live value expires, IM and Presence Service drops any ad-hoc presence subscriptions and no longer temporarily monitors the availability status for that user.

                                                      Note   

                                                      If the time-to-live value expires while the user is still viewing an instant message from a ad-hoc presence subscription, the availability status that displays may not be current.

                                                      Step 5   Click Save.

                                                      You do not have to restart any services on IM and Presence Service for this setting, however Cisco Unified Personal Communicator users will have to sign out, and sign back in to retrieve the latest ad-hoc presence subscriptions settings on IM and Presence Service.


                                                      Configure Maximum Contact List Size Per User

                                                      You can configure the maximum contact list size for a user; this is the number of contacts the user can add to their contact list. This setting applies to the contact list on Cisco Unified Personal Communicator client applications and on third-party client applications.

                                                      Users who reach the maximum number of contacts are unable to add new contacts to their contact list, nor can other users add them as a contact. If a user is close to the maximum contact list size, and the user adds a group of contacts that pushes the contact list over the maximum number, IM and Presence Service does not add the surplus contacts. For example, if the maximum contact list size on IM and Presence Service is 200. A user has 195 contacts and attempts to add 6 new contacts to the list, IM and Presence Service adds five contacts and does not add the sixth contact.


                                                      Tip


                                                      The System Troubleshooter in Cisco Unified CM IM and Presence Administration indicates if there are users who have reached the contact list limit.


                                                      If you are migrating users to IM and Presence Service, Cisco recommends that you set the Maximum Contact List Size and Maximum Watchers settings to Unlimited while importing user contact lists. This ensures that each migrated user contact list is fully imported. After all users have migrated, you can reset the Maximum Contact List Size and Maximum Watchers settings to the preferred values.

                                                      Procedure
                                                        Step 1   Choose Cisco Unified CM IM and Presence Administration > Presence > Settings.
                                                        Step 2   Edit the value of the Maximum Contact List Size (per user) setting.

                                                        The default value is 200.

                                                        Step 3   Click Save.
                                                        Step 4   Restart the Cisco XCP Router service.

                                                        Configure Maximum Number of Watchers Per User

                                                        You can configure the number of watchers for a user, specifically the maximum number of people that can subscribe to see the availability status for a user. This setting applies to the contact list on Cisco Unified Personal Communicator clients and on third-party clients.

                                                        If you are migrating users to IM and Presence Service, Cisco recommends that you set the Maximum Contact List Size and Maximum Watchers settings to Unlimited while importing user contact lists. This ensures that each migrated user contact list is fully imported. After all users have migrated, you can reset the Maximum Contact List Size and Maximum Watchers settings to the preferred values.

                                                        Procedure
                                                          Step 1   Choose Cisco Unified CM IM and Presence Administration > Presence > Settings.
                                                          Step 2   Edit the value of the Maximum Watchers (per user) setting.

                                                          The default value is 200.

                                                          Step 3   Click Save.
                                                          Step 4   Restart the Cisco XCP Router service.

                                                          Instant messaging settings configuration on IM and Presence

                                                          Turn On or Off Instant Messaging for IM and Presence Service Cluster

                                                          This procedure describes how to turn on or off instant message capabilities for all client applications in a IM and Presence Service cluster. Instant message capabilities is turned on by default on IM and Presence Service.


                                                          Caution


                                                          When you turn off instant message capabilities on IM and Presence Service, all group chat functionality (adhoc and persistent chat) will not work on IM and Presence Service. We recommend that you do not turn on the Cisco XCP Text Conference service or configure an external database for persistent chat on IM and Presence Service.


                                                          Procedure
                                                            Step 1   Choose Cisco Unified CM IM and Presence Administration > Messaging > Settings.
                                                            Step 2   Configure the instant messaging setting. Do one of the following actions:
                                                            • To turn on instant message capabilities for client applications in the IM and Presence Service cluster, check Enable instant messaging.. If you turn on this setting, local users of client applications can send and receive instant messages.
                                                            • To turn off instant message capabilities for client applications in the IM and Presence Service cluster, uncheck Enable instant messaging.. If you turn off this setting, local users of client applications cannot send and receive instant messages. Users can only use the instant messaging application for availability and phone operations. If you turn off this setting, users do not receive instant messages from outside the cluster.
                                                            Step 3   Click Save.
                                                            Step 4   Restart the Cisco XCP Router service.

                                                            Turn On or Off Offline Instant Messaging

                                                            By default IM and Presence Service stores (locally) any instant messages that are sent to a user when they are offline, and IM and Presence Service delivers these instant messages to the user the next time they sign in to the client application. You can turn off (suppress) this feature so IM and Presence Service does not store offline instant messages. For example, in large deployments this feature could require significant message storage, so you may want to suppress offline instant messages to increase performance.

                                                            Procedure
                                                              Step 1   Choose Cisco Unified CM IM and Presence Administration > Messaging > Settings.
                                                              Step 2   Configure the offline instant messaging. Perform one of the following actions:
                                                              • To turn off the storage of offline instant messages on IM and Presence Service, check Suppress Offline Instant Messaging.. If you check this setting, any instant messages that are sent to a user when they are offline, IM and Presence Service does not deliver these instant messages to the user the next time they sign in to the client application.
                                                              • To turn on the storage of offline instant messages on IM and Presence Service, uncheck Suppress Offline Instant Messaging.. If you uncheck this setting, any instant messages that are sent to a user when they are offline, IM and Presence Service delivers these instant messages to the user the next time they sign in to the client application.
                                                              Step 3   Click Save.

                                                              Allow Clients to Log Instant Message History

                                                              You can prevent or allow users to log instant message history locally on their computer. On the client side, the application must support this functionality; it must enforce the prevention of instant message logging.

                                                              Procedure
                                                                Step 1   Choose Cisco Unified CM IM and Presence Administration > Messaging > Settings.
                                                                Step 2   Configure the log instant message history setting as follows:
                                                                • To allow users of client applications to log instant message history on IM and Presence Service, check Allow clients to log instant message history (on supported clients only).
                                                                • To prevent users of client applications from logging instant message history on IM and Presence Service, uncheck Allow clients to log instant message history (on supported clients only).
                                                                Step 3   Click Save.

                                                                Allow Cut and Paste in Instant Messages

                                                                You can prevent or allow users to log instant message history locally on their computer. On the client side, the application must support this functionality; it must enforce the prevention of instant message logging.

                                                                Procedure
                                                                  Step 1   Choose Cisco Unified CM IM and Presence Administration > Messaging > Settings.
                                                                  Step 2   Configure the cut and paste in instant messages setting as follows:
                                                                  • To allow users of client applications to cut and paste in instant messages, check Allow cut & paste in instant messages.
                                                                  • To prevent users of client applications from cutting and pasting in instant messages, uncheck Allow cut & paste in instant messages.
                                                                  Step 3   Click Save.

                                                                  Configure SIP Publish Trunk on IM and Presence Service

                                                                  When you turn on this setting, Cisco Unified Communications Manager publishes phone presence for all line appearances that are associated with users licensed on Cisco Unified Communications Manager for IM and Presence Service.

                                                                  This procedure is the same operation as assigning a SIP trunk as the CUP PUBLISH trunk in Cisco Unified Communications Manager service parameters.

                                                                  Procedure
                                                                    Step 1   Choose Cisco Unified CM IM and Presence Administration > Presence > Settings.
                                                                    Step 2   Choose a SIP Trunk from the CUCM SIP Publish Trunk drop-down list.
                                                                    Step 3   Click Save.

                                                                    Configure Proxy Server Settings

                                                                    Procedure
                                                                      Step 1   Choose Cisco Unified CM IM and Presence Administration > Presence > Routing > Settings.
                                                                      Step 2   Choose On for the Method/Event Routing Status.
                                                                      Step 3   Choose Default SIP Proxy TCP Listener for the Preferred Proxy Server.
                                                                      Step 4   Click Save.

                                                                      Services on IM and Presence Service

                                                                      Configure Sync Agent Settings

                                                                      Before You Begin
                                                                      • Configure the topology for your deployment before starting the Sync Agent.
                                                                      • If you deploy the Cisco Unified Personal Communicator client with IM and Presence Service, and you configure system-wide default application profiles, configure and enable the default profiles before you activate the Sync Agent.
                                                                      Procedure
                                                                        Step 1   Choose Cisco Unified CM IM and Presence Administration > System > Service Parameters.
                                                                        Step 2   Choose the IM and Presence Service node from the Server menu.
                                                                        Step 3   Choose Cisco Sync Agent from the Service menu.
                                                                        Step 4   Choose a value for the User Assignment Mode as follows:
                                                                        1. If set to Balanced, the Sync Agent synchronizes user information to IM and Presence Service, and then assigns the users to each node in an attempt to balance the user assignment evenly across all nodes.
                                                                          • If set to Active/Standby, the Sync Agent synchronizes user information to IM and Presence Service, and assigns the total number of users to the first node of a subcluster only. If there is only a single node in the subcluster, the Sync Agent uses this node for assignment regardless of the location of the node within the subcluster.
                                                                        2. If set to None, the Sync Agent synchronizes user information to IM and Presence Service but does not assign any users. You must manually assign your users to nodes using the system topology interface
                                                                        Step 5   Choose Save.

                                                                        Turn On Services for IM and Presence Service

                                                                        The following procedure lists the services that you must turn on when you deploy a basic IM and Presence Service configuration. Turn on these services on each node in your IM and Presence Service cluster.

                                                                        You may need to turn on other optional services depending on the additional features that you deploy on IM and Presence Service. See the IM and Presence Service documentation relating to those specific features for further details. If you have manually stopped any services so that you could configure certain system components or features, use this procedure to manually restart those services.

                                                                        The Cisco XCP Router service must be running for a basic IM and Presence Service deployment. IM and Presence Service turns on the Cisco XCP Router by default. Verify that this network service is on by choosing Cisco Unified IM and Presence Serviceability > Control Center - Network Services.

                                                                        Procedure
                                                                          Step 1   Choose Cisco Unified IM and Presence Serviceability > Tools > Service Activation.
                                                                          Step 2   Choose the IM and Presence Service node from the Server menu.
                                                                          Step 3   For a basic IM and Presence Service deployment, turn on the following services:
                                                                          • Cisco SIP Proxy
                                                                          • Cisco Presence Engine
                                                                          • Cisco Sync Agent
                                                                          • Cisco XCP Connection Manager
                                                                          • Cisco XCP Authentication Service
                                                                          Step 4   Click Save.