Deployment Guide for Cisco Unified Presence Release 8.0 and 8.5
Configuring a Cisco Unified Presence Server for Deployment in the Network
Downloads: This chapterpdf (PDF - 500.0KB) The complete bookPDF (PDF - 3.88MB) | Feedback

Configuring a Cisco Unified Presence Server for Deployment in the Network

Table Of Contents

Configuring a Cisco Unified Presence Server for Deployment in the Network

About Configuration Changes and Service Restart Notifications

Service Restart Notifications

Cisco UP XCP Router Restart

Restarting the Cisco UP XCP Router Service

How to Configure the Cluster Topology on Cisco Unified Presence

About Subcluster, Node and User Management Recommendations

Node Creation and Movement Recommendations

Node Name Recommendations

User Assignment Mode Recommendations

Manual User Assignment Recommendations

User Redistribution

Creating Subclusters in System Topology

Creating, Assigning and Moving Nodes in System Topology

Configuring User Assignment in System Topology

About High Availability Cisco Unified Presence Deployments

Requirements for High Availability

High Availability in a Subcluster

Impact of Failover to Cisco Unified Presence Clients and Services

Automatic Failover Detection

Cisco UP Server Recovery Manager (SRM)

Manual Failover and Fallback

Important Note About High Availability and Intercluster Deployments

Node State Definitions

Node States, Causes and Recommended Actions

How To Configure High Availability Cisco Unified Presence Deployments

Turning On or Off High Availability for a Subcluster

Configuring the Advanced Service Parameters for the Server Recovery Manager

Performing a Manual Failover to Backup Node

Performing a Manual Fallback to Active Node

Performing a Manual Recovery of a Subcluster

How to Configure the Cluster-Wide Routing Information on Cisco Unified Presence

Configuring the Domain Value

Setting the Initial Domain Value in deployments where DNS in not configured

Modifying the Domain Value

About the Routing Communication Type

Routing Communication Recommendations

MDNS Routing and Cluster ID

Configuring the Routing Communication

Viewing or Configuring the Cluster ID

Configuring a Cluster-Wide Cisco Unified Presence Address

Configuring the Throttling Rate for Availability State Change Messages

Uploading the Licences on Cisco Unified Presence

How to Configure Static Routes on Cisco Unified Presence

Route Embed Templates

Configuring Route Embed Templates on Cisco Unified Presence

Configuring Static Routes on Cisco Unified Presence

How to Configure the Presence Gateway on Cisco Unified Presence

Presence Gateway Configuration Option

Configuring the Presence Gateway

How To Configure the Authorization Policy on Cisco Unified Presence

Automatic Authorization on Cisco Unified Presence

User Policy & Automatic Authorization

Configuring the Authorization Policy on Cisco Unified Presence

How To Configure the Availability Settings on Cisco Unified Presence

Turning On or Off Availability Sharing for a Cisco Unified Presence Cluster

Configuring the Do Not Disturb Settings on Cisco Unified Presence

Configuring the Temporary Presence Subscription Settings

Configuring the Maximum Contact List Size Per User

Configuring the Maximum Number of Watchers Per User

How to Configure the Instant Messaging Settings on Cisco Unified Presence

Turning On or Off Instant Messaging for a Cisco Unified Presence Cluster

Turning On or Off Offline Instant Messaging

Allowing Clients to Log Instant Message History

Configuring the SIP Publish Trunk on Cisco Unified Presence

Configuring the Proxy Server Settings

SIP Digest Authentication

How to Turn On the Cisco Unified Presence Services

Turning On the Sync Agent

Turning On the Cisco Unified Presence Services


Configuring a Cisco Unified Presence Server for Deployment in the Network


July 5, 2013

About Configuration Changes and Service Restart Notifications, page 6-1

Restarting the Cisco UP XCP Router Service, page 6-2

How to Configure the Cluster Topology on Cisco Unified Presence, page 6-3

About High Availability Cisco Unified Presence Deployments, page 6-11

How To Configure High Availability Cisco Unified Presence Deployments, page 6-20

How to Configure the Cluster-Wide Routing Information on Cisco Unified Presence, page 6-27

How to Configure Static Routes on Cisco Unified Presence, page 6-34

Uploading the Licences on Cisco Unified Presence, page 6-32

How to Configure the Presence Gateway on Cisco Unified Presence, page 6-38

How To Configure the Authorization Policy on Cisco Unified Presence, page 6-39

How To Configure the Availability Settings on Cisco Unified Presence, page 6-42

How to Configure the Instant Messaging Settings on Cisco Unified Presence, page 6-46

Configuring the SIP Publish Trunk on Cisco Unified Presence, page 6-48

Configuring the Proxy Server Settings, page 6-49

SIP Digest Authentication, page 6-49

How to Turn On the Cisco Unified Presence Services, page 6-50

About Configuration Changes and Service Restart Notifications

Service Restart Notifications, page 6-2

Cisco UP XCP Router Restart, page 6-2

Service Restart Notifications

If you make a configuration change in Cisco Unified Presence Administration that impacts a Cisco Unified Presence XCP service, you will need to restart XCP services for your changes to take effect. Cisco Unified Presence 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 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 Serviceability, where you can restart the required service.

The topics in this module indicate if you need to perform a service restart, however it is good practice to monitor the service restart popup window for these notifications, particularly if you make any configuration changes after you deploy Cisco Unified Presence in the network.

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

Related Topic

Cisco UP XCP Router Restart, page 6-2

Cisco UP XCP Router Restart

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

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

Related Topic

Restarting the Cisco UP XCP Router Service, page 6-2

Restarting the Cisco UP XCP Router Service

Procedure


Step 1 On Cisco Unified Presence, select Cisco Unified Serviceability > Tools > Control Center - Network Services.

Step 2 Select the server from the Server list box.

Step 3 Select Go.

Step 4 Select the radio button next to the Cisco UP XCP Router service in the CUP Services section.

Step 5 Select Restart.

Step 6 Select OK. when a message indicates that restarting may take a while.


Related Topics

Service Restart Notifications, page 6-2

Cisco UP XCP Router Restart, page 6-2

How to Configure the Cluster Topology on Cisco Unified Presence

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

Perform the system topology configuration on the Cisco Unified Presence publisher node.

Before configuring the system topology, read the multi-node planning and deployment information for best practice information on configuring this type of deployment.


Caution Only use the system topology interface to configure your local Cisco Unified Presence cluster. See the intercluster peer module for information on configuring intercluster peer relationships with remote Cisco Unified Presence clusters.

About Subcluster, Node and User Management Recommendations, page 6-3

Creating Subclusters in System Topology, page 6-7

Creating, Assigning and Moving Nodes in System Topology, page 6-7

Configuring User Assignment in System Topology, page 6-10

About Subcluster, Node and User Management Recommendations

Node Creation and Movement Recommendations, page 6-3

Node Name Recommendations, page 6-4

User Assignment Mode Recommendations, page 6-5

Manual User Assignment Recommendations, page 6-5

User Redistribution, page 6-6

Node Creation and Movement Recommendations

When you create nodes in Cluster Topology you can:

Assign the nodes to a subcluster in Cisco Unified Presence, or allow the nodes to remain unassigned. These states are interchangeable.

Assign Cisco Unified 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.


NoteRemove 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.


Related Topics

Node Name Recommendations, page 6-4

User Assignment Mode Recommendations, page 6-5

Creating, Assigning and Moving Nodes in System Topology, page 6-7

Node Name Recommendations

By default, the name for a node is the hostname that you configure during the Cisco Unified Presence installation. For example, if the hostname of your Cisco Unified Presence 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 Cisco Unified Presence server, and Cisco Unified Personal Communicator client computers.

If either Cisco Unified Presence server 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 Cisco Unified Presence server, 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 Cisco Unified Presence hostname. Otherwise, you must enter the full IPv4 address of the Cisco Unified Presence server.

Related Topics

Node Creation and Movement Recommendations, page 6-3

Creating, Assigning and Moving Nodes in System Topology, page 6-7

Changing the IP Address and Hostname for Cisco Unified Presence Release 8.x

User Assignment Mode Recommendations

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

If set to Balanced, Cisco Unified 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, Cisco Unified Presence assigns all users only to the first node of a subcluster. If there is only a single node in the subcluster, Cisco Unified 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 Cluster Topology.


NoteIf 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.


Related Topics

Manual User Assignment Recommendations, page 6-5

Turning On the Sync Agent, page 6-50

Manual User Assignment Recommendations

If you choose to manually assign users in Cluster Topology, 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 UP Presence Engine is running on all nodes in your cluster, otherwise Cisco Unified 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 UP Presence Engine and Cisco UP SIP Proxy services offline when performing bulk operations. Note that taking these services offline will adversely impact performance.

Related Topics

User Assignment Mode Recommendations, page 6-5

Configuring User Assignment in System Topology, page 6-10

Turning On or Off High Availability for a Subcluster, page 6-20

User Redistribution, page 6-6

User Redistribution


NoteIf you turn on High Availability in a subcluster, be aware that Cisco Unified 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, refer to the High Availability Client Login Profiles, page B-1.


After adding or removing nodes, you can redistribute users using the Rebalance Users parameter in Cluster Topology. 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. Cisco Unified 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. Cisco Unified 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.

Related Topics

Node Creation and Movement Recommendations, page 6-3

Configuring User Assignment in System Topology, page 6-10

Creating Subclusters in System Topology

The system automatically assigns the first Cisco Unified Presence node that you install as the publisher node. After you install the publisher node, create the required subclusters and subsequent nodes in your Cisco Unified Presence cluster in Cluster Topology.

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


Note Perform this procedure on the publisher Cisco Unified Presence node.


Before You Begin

Plan your multi-node deployment model.

Procedure


Step 1 Select Cisco Unified 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 Tips

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

Related Topics

Planning a Cisco Unified Presence Multi-Node Deployment, page 4-1

About High Availability Cisco Unified Presence Deployments, page 6-11

What To Do Next

Creating, Assigning and Moving Nodes in System Topology, page 6-7

Creating, Assigning and Moving 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, Cisco Unified Presence associates the subsequent nodes with the publisher node.


NotePerform this procedure on the publisher Cisco Unified Presence node.

Perform this procedure before you install any of the subsequent Cisco Unified Presence nodes. If you assign a subsequent Cisco Unified 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.


Before You Begin

Create the required subclusters for your deployment.

Depending on how you plan to configure your node name, obtain the required value for your nodes (for example hostname, dotted IP address, FQDN or DNS-SRV).

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 Select Cisco Unified Presence Administration > System > Cluster Topology.

Step 2 Create the required subsequent nodes for your deployment:

a. Select Add New Node.

b. Define a unique name for the node.

c. Select Save.

Step 3 Perform one of these actions:

If you want to:
Action
Notes

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 UP Replication Watcher service is running on all nodes.

On the Network services screen in Cisco Unified Serviceability (on the subscriber node), verify that all Cisco Unified 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.



Troubleshooting Tips

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 Cisco Unified Presence 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.

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

Related Topics

Restarting the Cisco UP XCP Router Service, page 6-2

Creating Subclusters in System Topology, page 6-7

Node Name Recommendations, page 6-4

Node Creation and Movement Recommendations, page 6-3

About High Availability Cisco Unified Presence Deployments, page 6-11

Configuring a Cisco Unified Presence Intercluster Deployment, page 15-1

What To Do Next

Configuring User Assignment in System Topology, page 6-10

Configuring User Assignment in System Topology


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


In Cluster Topology, 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 Presence Administration > System > Topology.

Step 2 Perform one of these actions:

If you want to:
Action

Assign users

Select Assign Users.

Unassign or reassign users

Select 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:

Check the users that you wish to assign, and select Assign Selected Users.

Select all users, and select Assign All Users.

Step 5 Using the list boxes in the Change Assignment frame, specify your user assignment:

to a named node

to a named subcluster (auto-assigned)

to all subclusters (auto-assigned)

to nothing (unassigned)

Step 6 Select Save.


Troubleshooting Tips

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

Related Topics

Planning a Cisco Unified Presence Multi-Node Deployment, page 4-1

User Assignment Mode Recommendations, page 6-5

Turning On or Off High Availability for a Subcluster, page 6-20

For information on exporting users in bulk using BAT, see the Online Help in Cisco Unified Presence Administration.

About High Availability Cisco Unified Presence Deployments

High Availability in a Subcluster, page 6-11

Impact of Failover to Cisco Unified Presence Clients and Services, page 6-12

Automatic Failover Detection, page 6-12

Cisco UP Server Recovery Manager (SRM), page 6-14

Node State Definitions, page 6-15

Node States, Causes and Recommended Actions, page 6-16

Requirements for High Availability

The requirements for High Availability are:

You must be running Cisco Unified Presence release 8.5 (x), or a later 8.x release. Any earlier Cisco Unified Presence 8.0(x) releases do not support High Availability.

Cisco Unified Presence supports High Availability at a subcluster level. Both nodes in the subcluster must be running the same version of Cisco Unified Presence 8.x software for High Availability to work.

High Availability in a Subcluster

Cisco Unified 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 Cisco Unified 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.

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


Caution Cisco Unified Presence does not perform an automatic fallback to the active node after failover. You must manually perform the fallback from the Cluster Topology interface, otherwise the failed over users will remain on the backup node.

To monitor and troubleshoot the status of the High Availability functionality on a subcluster, view the High Availability states that Cisco Unified Presence assigns to each node. See Table 6-1 and Table 6-2 for descriptions of these states and recommended actions if the subcluster is in a failed state. If a failover occurs, on the node detail screen, Cisco Unified Presence marks the users that have failed over to the backup node.

Related Topics

Automatic Failover Detection, page 6-12

Manual Failover and Fallback, page 6-14

How To Configure High Availability Cisco Unified Presence Deployments, page 6-20

Impact of Failover to Cisco Unified Presence Clients and Services

Cisco Unified Presence supports High Availability for Cisco Unified Personal Communicator Release 7.x and Release 8.5(x) and on.

During failover to the backup node, availability and instant messaging services are temporarily unavailable on client applications. Once 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 once 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

Cisco Unified 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 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 Presence Administration interface. These are the list of critical services that the node monitors:

Cisco DB (internal IDS database)

Cisco UP Presence Engine (if you activate this service)

Cisco UP XCP Router

Cisco UP Message Archiver (if you integrate Cisco Unified Presence with a third-party off-board database, and you activate this service)

Cisco UP SIP Proxy (if you configure SIP federation or you have an intercluster connection with a Cisco Unified Presence Release 7.x cluster, and you activate this service)

Cisco UP XCP SIP Federation Connection Manager (if you configure SIP federation or you have an intercluster connection with a Cisco Unified Presence Release 7.x cluster, and you activate this service)

You can view the critical services that Cisco Unified Presence monitors for failover on the node details screen on the Cluster Topology interface. The critical services that Cisco Unified Presence monitors are marked in the `Monitored' column in the services list.


NoteCisco Unified 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, Cisco Unified Presence generates alarms indicating that services are starting and stopping, and you can perform a manual failover on Cisco Unified Presence.

If you manually stop a critical service, and the service is stopped for longer than the permitted outage period, failover will occur.


If Cisco Unified Presence detects the situation where both nodes in the subcluster think that they own the same user, both nodes will go into a failed state, and you will need to perform a manual recovery from the Cluster Topology interface. After you perform the manual recovery, 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 Reporting Tool (CURT). The `Unified CUP Database Status' report displays a detailed status of the cluster.

Related Topics

Performing a Manual Failover to Backup Node, page 6-24

Configuring the Advanced Service Parameters for the Server Recovery Manager, page 6-22

Cisco UP Replication Watcher Service, page 5-1

Cisco UP Server Recovery Manager (SRM)

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

Once you turn on High Availability in a subcluster, the Cisco UP 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 once 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, 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, page B-1.

Related Topics

Node State Definitions, page 6-15

Configuring the Advanced Service Parameters for the Server Recovery Manager, page 6-22

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 UP 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 UP Server Recovery Manager restarts critical services on the active node and moves users back to the active 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, Cisco Unified Presence restarts the Cisco UP Server Recovery Manager service on both nodes in the subcluster.

Related Topics

Performing a Manual Failover to Backup Node, page 6-24

Performing a Manual Fallback to Active Node, page 6-25

Performing a Manual Recovery of a Subcluster, page 6-26

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 only runs on the publisher node in a cluster. If the publisher node fails (the whole node fails, not just services on the node), the Intercluster Sync Agent will stop running, meaning the other clusters will not receive the information that users have moved to a different node. This will cause IM and availability issues across the clusters. Users that have failed over will not receive availability information for remote users. Remote users will receive availability information and IMs from users that have failed over, but any IMs that they send to a failed over user are not delivered.

Node State Definitions

Table 6-1 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.


Table 6-1 Node State Descriptions

State
Description

Initializing

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

Idle

Cisco Unified Presence is in Idle state when failover occurs and services are stopped. In Idle state, the Cisco Unified 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 Cisco Unified 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 Cisco Unified 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 Cisco Unified Presence node is taking over for its peer node.

Failing Over

This is a transition state. The Cisco Unified Presence node is being taken over by its peer node.

Failed Over

This is a stable state. The Cisco Unified 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 Cisco Unified Presence node have either stopped or failed.

Falling Back

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

Taking Back

This is a transition state. The failed Cisco Unified 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.


Related Topic

Node States, Causes and Recommended Actions, page 6-16

Node States, Causes and Recommended Actions

Table 6-2 describes the node states, reasons, causes, and recommended actions for failed states.

Table 6-2 Node High Availability states, causes and recommended actions

Node 1
Node 2
Cause/Recommended Actions
State
Reason
State
Reason

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 node1 to node2.The manual failover is in progress.

Idle,

On Admin Request

Running in Backup Mode

On Admin Request

The manual failover from node1 to node2 (initiated by the administrator) is complete.

Taking Back

On Admin Request

Falling Back

On Admin Request

The administrator initiates a manual fallback from node2 to node1. The manual fallback is in progress.

Idle

Initialization

Running in Backup Mode

On Admin Request

The administrator restarts the SRM service on node1 while node1 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 node2 while node2 is running in backup mode, but before the heartbeat on node1 times out.

Failing Over

On Admin Request

Taking Over

Initialization

The administrator restarts the SRM service on node2 while node2 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 node1 while taking back, but before the heartbeat on node2 times out. After the taking back process is complete, both nodes are in Normal state.

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 node1, or

The administrator starts critical service(s) on node1 while node1 is in "Failed Over with Critical Services Not Running" state

When node1 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 node1. Cisco Unified Presence performs an automatic failover to node2.

Recommended Actions:

1. Check what critical services are down on node1, and try to start these services manually.

2. If the critical services on node1 do not start,, reboot node1.

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 node1. Cisco Unified Presence performs an automatic failover to node2.

Recommended Actions:

1. Reboot Node1.

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.

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

Running in Backup Mode

Peer Down

Node2 has lost its heartbeat with node1. Cisco Unified Presence performs an automatic failover to node2.

Recommended Action:

(If the node1 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)

1. Repair/Power up node1.

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

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

Running in Backup Mode

Peer Reboot

Cisco Unified Presence performs an automatic failover to node2 due to possible hardware failure/power down/restart /shutdown of Node1.

Recommended Action:

1. Repair/Power up node1.

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

Node2 doesn't see Node1 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 UP Server Recovery Manager Take Over Users Failed

Running in Failed Mode

Cisco UP 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 UP Server Recovery Manager Take Back Users Failed

Running in Failed Mode

Cisco UP 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 doesn't resolve the issue, reboot the subcluster.


Related Topics

Performing a Manual Failover to Backup Node, page 6-24

Performing a Manual Fallback to Active Node, page 6-25

Performing a Manual Recovery of a Subcluster, page 6-26

How To Configure High Availability Cisco Unified Presence Deployments

Turning On or Off High Availability for a Subcluster, page 6-20

Configuring the Advanced Service Parameters for the Server Recovery Manager, page 6-22

Performing a Manual Failover to Backup Node, page 6-24

Performing a Manual Fallback to Active Node, page 6-25

Turning On or Off High Availability for a 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, page B-1.

You have to manually turn on High Availability in a subcluster; Cisco Unified 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 Cisco Unified Presence Release 8.5 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 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.

Cisco Unified Presence displays the following information about High Availability for the subcluster

Field
Description

Monitored Node

The node in the subcluster that Cisco Unified Presence is monitoring for failover detection.

Node State

The state of the node. See Node State Definitions, page 6-15for 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 Cisco Unified Presence restarts the SRM service on both nodes.



Troubleshooting Tips

When you turn on High Availability in a subcluster, Cisco Unified Presence restarts the Cisco UP Service Recovery Manager service and it begins to monitor for failover detection. To verify this service is running, select Cisco Unified 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 Cisco Unified Presence fails over to the backup node are homed to the backup node. Cisco Unified Presence will not move these users back to the active 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 Presence Administration > Diagnostics > System Troubleshooter.

Configuring the Advanced Service Parameters for the Server Recovery Manager

Procedure


Step 1 Cisco Unified Presence Administration > System > Service Parameters.

Step 2 Select a Cisco Unified Presence server from the Server menu.

Step 3 Select Cisco UP 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 UP Server Recovery Manager uses to communicate with its peer.

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

Admin RPC Port

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

If you modify this parameter, Cisco Unified Presence restarts the Cisco UP 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 Cisco Unified Presence initiates an automatic failover.

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

Enable Automatic Failover

This parameter turns on or off automatic failover on Cisco Unified Presence.

This parameter is on by default. Only turn this parameter off if you do not want automatic failover on Cisco Unified Presence and you only want to perform manual failover.

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 Cisco Unified 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.

 

Users Moved Per Iteration

This parameter specifies the number of users that Cisco Unified 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, page B-1.

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 Cisco Unified 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, page B-1 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 Cisco Unified 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, page B-1 for guidelines on defining the client re-login lower and upper limits.

Step 5 Select Save.


Related Topic

High Availability Client Login Profiles, page B-1

Performing a Manual Failover to Backup Node

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

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

Cisco UP SIP Proxy

Cisco UP Presence Engine

Cisco UP XCP Router (this causes all XCP processes to stop)

Cisco UP Client Profile Agent

The Cisco UP 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 UP XCP Connection Manager service

Cisco UP XCP Router

Cisco UP Presence Engine

Procedure


Step 1 Cisco Unified 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:

When the failover operation is in progress, the active 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 active node is in "Idle' state. If the failover is unsuccessful, and the nodes are in a failed state, see Table 6-2 for a recommended action.

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 active node.

On the node details screen, the `Failed Over' column indicates the users that have failed over to the backup node.


Related Topic

Node States, Causes and Recommended Actions, page 6-16

Performing a Manual Fallback to Active Node

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

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

Cisco UP SIP Proxy

Cisco UP Presence Engine

Cisco UP XCP Router

Any XCP services that were activated

Cisco UP Client Profile Agent

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

Restriction

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

Procedure


Step 1 Cisco Unified 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:

When fallback operation is in progress, the active 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, see Table 6-2 for a recommended action.

Check that the users have fallen back to the active node.

On the subcluster details screen, check that all users are now assigned to the active node, and no users are assigned to the backup node.

On the node details screen, the `Failed Over' column should be empty.


Related Topic

Node States, Causes and Recommended Actions, page 6-16

Performing a Manual Recovery of a Subcluster

When you perform a manual recovery of a subcluster, Cisco Unified Presence restarts the Cisco UP 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 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 See see Table 6-2 to verify the status of the subcluster after you perform the manual recovery.


Troubleshooting Tips

If Cisco Unified Presence detects the situation where both nodes in the subcluster think that they own the same user, both nodes will go into a failed state, and you will need to perform a manual recovery from the Cluster Topology interface. After you perform the manual recovery, 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

Related Topic

Node States, Causes and Recommended Actions, page 6-16

How to Configure the Cluster-Wide Routing Information on Cisco Unified Presence

Configuring the Domain Value, page 6-27

About the Routing Communication Type, page 6-28

Configuring the Routing Communication, page 6-30

Viewing or Configuring the Cluster ID, page 6-31

Configuring a Cluster-Wide Cisco Unified Presence Address, page 6-31

Configuring the Throttling Rate for Availability State Change Messages, page 6-32

Configuring the Domain Value

This procedure describes how to configure the domain value across al nodes in your Cisco Unified Presence cluster.

Setting the Initial Domain Value in deployments where DNS in not configured

If you are not using DNS in your network, the domain name value is set to "PROXY.DOMAIN.NOT.SET" by default on the installation of Cisco Unified Presence. You must replace this default value with the enterprise wide domain and also ensure the node names are configured as IP addresses or Cisco Unified Presence will not function correctly.

Please follow the procedure outlined below on all nodes in the cluster to configure a valid domain value.


Note If you are using DNS in your network, then the domain name value is set to the DNS domain of the node by default on the installation of Cisco Unified Presence and no further action is required.


Modifying the Domain Value

If you ever wish to modify the domain value on your Cisco Unified Presence deployment, please follow the same procedure outlined below on all nodes in the cluster. This procedure applies to both DNS and non-DNS Cisco Unified Presence deployments.

Procedure


Step 1 Stop the Cisco UP SIP Proxy, Presence Engine and XCP Router services on Cisco Unified Presence on a nodes in your cluster.

Step 2 On the publisher node, perform the following steps to configure the new domain value:

a. Select Cisco Unified Presence Administration > System > Cluster Topology.

b. In the right pane, select Settings.

c. Configure the Domain Name value with the new domain.

a. Select Cisco Unified Presence Administration > System > Service Parameters, and select the Cisco UP SIP Proxy service.

b. Configure the Federation Routing CUP FQDN with the new domain.

c. You will be prompted to confirm these configuration changes. Select OK for both prompts, and then select Save.

Step 3 (DNS deployments only, for non-DNS deployments proceed to step 4) 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 (DNS and non-DNS deployments) On all nodes in the cluster, manually start the Cisco UP Presence Engine and Cisco UP XCP Router services once the reboot is complete (if required).If you are not using DNS, you have completed the replacement of the default domain value.

Step 5 (DNS deployments only) Manually regenerate all certificates on the local Cisco Unified 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


Step 6 (DNS deployments only) 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 (DNS deployments only) Configure any XMPP clients with the new domain.

About the Routing Communication Type

Routing Communication Recommendations, page 6-28

MDNS Routing and Cluster ID, page 6-29

Routing Communication Recommendations

MDNS is the default mechanism for establishing the XCP route fabric on Cisco Unified Presence; the network automatically establishes router-to-router connections between all Cisco Unified Presence 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 select 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 select router-to-router communication for your deployment. In this case, Cisco Unified Presence dynamically configures all router-to-router connections between nodes in a cluster. Select this routing configuration type if all the nodes in your cluster are not in the same multicast domain. Note that when you select router-to-router communication:

Your deployment will incur the additional performance overhead while Cisco Unified Presence establishes the XCP route fabric.

If you are running Cisco Unified Presence Release 8.0(x), if you add a new node, you must restart the Cisco UP XCP Router on all nodes in your deployment. If you are running Cisco Unified Presence Release 8.5(x), you do not need to restart the Cisco UP 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 UP XCP Router on all nodes in your deployment when you add a new node.

Related Topics

MDNS Routing and Cluster ID, page 6-29

Configuring the Routing Communication, page 6-30

MDNS Routing and Cluster ID

At installation, the system assigns a unique cluster ID to the Cisco Unified Presence 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 Cisco Unified Presence cluster from establishing router-to-router connections with nodes in another standalone cluster. Standalone clusters should only communicate over intercluster peer connections.

Select Cisco Unified Presence Administration > Presence > 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 Cisco Unified Presence deployment.


Note If you deploy the Chat feature, Cisco Unified Presence uses the cluster ID value to define chat server aliases. There are certain configuration scenarios that may require you to change the cluster ID value. See the Group Chat module for details.


Related Topics

Routing Communication Recommendations, page 6-28

Viewing or Configuring the Cluster ID, page 6-31

Configuring the Routing Communication, page 6-30

Configuring Chat on Cisco Unified Presence, page 9-1

Configuring the 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 publisher node, and Cisco Unified Presence applies this routing configuration to all nodes in the cluster.

For single node Cisco Unified Presence 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 Cisco Unified Presence 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, select Cisco Unified Presence Administration > System > Cluster Topology, and click the edit link on a node. Perform this configuration after you install Cisco Unified Presence, and before you restart the Cisco UP XCP Router on all nodes.

Procedure


Step 1 Select Cisco Unified Presence Administration > System > Cluster Topology.

Step 2 In the right pane, select Settings.

Step 3 Select one of these Routing Communication Types from the menu:

Multicast DNS (MDNS)- Select Multicast DNS communication if the nodes in your cluster are in the same multicast domain. Multicast DNS communication is enabled by default on Cisco Unified Presence.

Router to Router - Select Router-to-Router communication if the nodes in your cluster are not in the same multicast domain.

Step 4 Select Save.

Step 5 Restart the Cisco UP XCP Router service on all nodes in your deployment.


Related Topics

Restarting the Cisco UP XCP Router Service, page 6-2

About the Routing Communication Type, page 6-28

Viewing or Configuring the Cluster ID, page 6-31

Configuring the Domain Value, page 6-27

Viewing or Configuring the Cluster ID

At installation, the system assigns a default unique cluster ID to the Cisco Unified Presence 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 select 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, Cisco Unified Presence uses the cluster ID value for chat server 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 publisher node, and the system replicates the new Cluster ID value to the other nodes in the cluster.

Procedure


Step 1 Select Cisco Unified Presence Administration > System > Cluster Topology.

Step 2 In the right pane, select Settings.

Step 3 View or edit the Cluster ID value.


Note By default, Cisco Unified Presence assigns the cluster ID value "StandaloneCluster" to a cluster.


Step 4 Select Save.


Troubleshooting Tips

Cisco Unified Presence Release 8.x does not permit the underscore character (_) in the Cluster ID value. If you perform an upgrade to Cisco Unified Presence Release 8.x, make user the Cluster ID value does not contain this character.

Related Topics

MDNS Routing and Cluster ID, page 6-29

Configuring Chat on Cisco Unified Presence, page 9-1

Configuring a Cluster-Wide Cisco Unified Presence Address

This procedure is only applicable if you are configuring a multi-node deployment. Configure the cluster-wide Cisco Unified Presence address on the publisher node, and Cisco Unified Presence will replicate the address on all nodes in the cluster.


Note When you configure a cluster-wide Cisco Unified Presence address, set the port of SRV to 5060.


Before You Begin

Read the cluster-wide DNS SRV topic.

Procedure


Step 1 Select Cisco Unified Presence Administration > System > Service Parameters.

Step 2 Select the Cisco Unified Presence server from the Server menu.

Step 3 Select Cisco UP 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 Select Save.


Related Topic

Scalability Options for Your Deployment, page 4-7

What To Do Next

Uploading the Licences on Cisco Unified Presence, page 6-32

Configuring the Throttling Rate for Availability State Change Messages

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

Procedure


Step 1 Select Cisco Unified Presence Administration > System > Service Parameters.

Step 2 Select the Cisco Unified Presence server from the Server menu.

Step 3 Select Cisco UP 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 Select Save.


Uploading the Licences on Cisco Unified Presence

Follow this procedure to upload the server license file, and the software version license to Cisco Unified Presence.


NoteThis topic is only applicable if you are configuring the Cisco Unified Presence publisher node. Only upload the Cisco Unified Presence server license file on the publisher node of a Cisco Unified Presence cluster. The license file contains the number of Cisco Unified Presence servers in a cluster that are licensed to the customer.

You can only upload a license file issued for a physical server to a physical server. Similarly, you can only upload a VMware license file to a VMware server.


Before You Begin

Read the Cisco Unified Presence License Requirements topic.

Upload the Cisco Unified Presence user licenses on Cisco Unified Communications Manager, and assign Cisco Unified Presence capabilities to these users.

Restrictions

License files must have a .lic suffix.

Procedure


Step 1 Select Cisco Unified Presence Administration > System > Licensing > License File Upload.

Step 2 Select Upload License File.

Step 3 Locate the file on your local computer.

Step 4 Select Upload.

Step 5 Restart the Cisco UP Sync Agent service.


Troubleshooting Tips

Cisco Unified Presence only uploads the license file into the database if the version that the license file specifies is greater than or equal to the Cisco Unified Presence version that is running in the cluster. If the version check fails, Cisco Unified Presence generates an alarm, and you should get a new license file with the correct version. The system bases the version check only on major releases.

To verify that the license file uploads correctly, confirm the license file is listed in the existing licenses menu on the License File Upload window. Select the license file in the existing license file menu, and select View File.

Related Topics

Cisco Unified Presence License Requirements, page 2-1

Configuring the Licensing for this Integration, page 2-1

What To Do Next

How to Configure the Presence Gateway on Cisco Unified Presence, page 6-38

How to Configure Static Routes on Cisco Unified Presence

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, page 6-34

Configuring Route Embed Templates on Cisco Unified Presence, page 6-35

Configuring Static Routes on Cisco Unified Presence, page 6-35

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, Cisco Unified Presence will enable this set of static routes with embedded wildcards:

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, Cisco Unified Presence 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, Cisco Unified Presence will enable this set of static routes with embedded wildcards:

Destination Pattern
Next Hop Destination

471....34*

20.20.21.22

471...55*

21.21.55.79


With this template, Cisco Unified Presence 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)

Configuring Route Embed Templates on Cisco Unified Presence

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 Select Cisco Unified Presence Administration > System > Service Parameters.

Step 2 Select a Cisco Unified Presence server.

Step 3 Select the Cisco UP 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 Select Save.


What To Do Next

Configuring Static Routes on Cisco Unified Presence, page 6-35

Configuring Static Routes on Cisco Unified Presence

Procedure


Step 1 Select Cisco Unified Presence Administration > Routing > Static Routes.

Step 2 Select Add New.

Step 3 Configure these static route settings:

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, Cisco Unified Presence logs an error.

Wildcard Usage

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

Cisco Unified Presence 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 on 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.

Cisco Unified Presence 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.

Cisco Unified Presence 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 select User as the route type, Cisco Unified Presence uses the user-part value '19194762030' for routing SIP traffic. If you select the Domain as the route type, Cisco Unified Presence 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, Cisco Unified Presence 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, Cisco Unified Presence 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.


Step 4 Select Save.


Related Topics

Route Embed Templates, page 6-34

Configuring Route Embed Templates on Cisco Unified Presence, page 6-35

How to Configure the Presence Gateway on Cisco Unified Presence

Presence Gateway Configuration Option, page 6-38

Configuring the Presence Gateway, page 6-38

Presence Gateway Configuration Option

You must configure Cisco Unified Communications Manager as a Presence Gateway on Cisco Unified Presence to enable the SIP connection that handles the availability information exchange between Cisco Unified Communications Manager and Cisco Unified Presence. The Cisco Unified Presence server sends SIP subscribe messages to Cisco Unified Communications Manager over a SIP trunk which allows the Cisco Unified Presence server to receive availability information (for example, phone on/off hook status).

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

the FQDN address of the Cisco Unified Communications Manager publisher

a DNS SRV FQDN that resolves to the Cisco Unified Communications Manager subscriber nodes

the IP address of the Cisco Unified Communications Manager publisher

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

1. Configure the Presence Gateway on the Cisco Unified Presence server with a DNS SRV FQDN of the Cisco Unified Communications Manager subscriber nodes (equally weighted). This will enable Cisco Unified Presence to share availability messages equally among all the servers used for availability information exchange.

2. On Cisco Unified Communications Manager, configure the SIP trunk for the Cisco Unified Presence server with a DNS SRV FQDN of the Cisco Unified Presence publisher and subscriber.

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

Related Topic

How to Configure the SIP Trunk on Cisco Unified Communications Manager, page 3-3

Configuring the 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 server.

Procedure


Step 1 Select Cisco Unified Presence Administration > Presence > Gateways.

Step 2 Select Add New.

Step 3 Select 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 server in the Presence Gateway field.

Step 6 Select Save.


Related Topic

Presence Gateway Configuration Option, page 6-38

What To Do Next

Configuring the Authorization Policy on Cisco Unified Presence, page 6-41

How To Configure the Authorization Policy on Cisco Unified Presence

Automatic Authorization on Cisco Unified Presence, page 6-39

User Policy & Automatic Authorization, page 6-40

Configuring the Authorization Policy on Cisco Unified Presence, page 6-41

Automatic Authorization on Cisco Unified Presence

Cisco Unified Presence 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. Cisco Unified Presence 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 Cisco Unified Presence, and you cannot configure this behavior.

In the XMPP network, it is standard behavior for the server 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 Cisco Unified Presence 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 Cisco Unified Presence:

When you turn on automatic authorization, Cisco Unified Presence 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 Cisco Unified Presence.

When you turn off automatic authorization, Cisco Unified Presence only supports XMPP-based clients. For XMPP-based clients, Cisco Unified Presence 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 Cisco Unified Presence when you turn off automatic authorization.


Caution If you turn off automatic authorization, SIP-based clients such as Cisco Unified Personal Communicator Release 7.x 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.

Related Topics

User Policy & Automatic Authorization, page 6-40

Configuring the Authorization Policy on Cisco Unified Presence, page 6-41

Integration Guide for Configuring Cisco Unified Presence for Interdomain Federation

User Policy & Automatic Authorization

In addition to reading the automatic authorization policy, Cisco Unified Presence reads the policy settings for the user to determine how to handle presence subscription requests. Users configure the policy settings from either the client (Cisco Unified Personal Communicator) and the Cisco Unified 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 Presence User Options interface, the user can also select 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, Cisco Unified Presence 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 Cisco Unified Presence, and UserB is not in the Allowed or Blocked list for the UserA.

Cisco Unified Presence 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.

Cisco Unified Presence 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 (ii) `ask me' is selected.

If you deploy interdomain federation between a local Cisco Unified Presence enterprise and a supported external enterprise, Cisco Unified Presence 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, Cisco Unified Presence will only send the subscription request to the client application if the user selects `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 Cisco Unified Presence uses a common user policies for both availability and instant messages.


Related Topics

Automatic Authorization on Cisco Unified Presence, page 6-39

Configuring the Authorization Policy on Cisco Unified Presence, page 6-41

For information on the Cisco Unified Presence User Options interface, see the User Guide for Cisco Unified Presence at this URL:

http://www.cisco.com/en/US/products/ps6837/products_user_guide_list.html

For information on the interdomain federation integration for Cisco Unified Presence, see the Integration Guide for Configuring Cisco Unified Presence for Interdomain Federation at this URL:

http://www.cisco.com/en/US/products/ps6837/products_installation_and_configuration_guides_list.html

Configuring the Authorization Policy on Cisco Unified Presence

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

Procedure


Step 1 Select Cisco Unified Presence Administration > Presence > Settings.

Step 2 Configure the authorization setting as follows:

If You Want To...
Do This

Turn on automatic authorization so that Cisco Unified Presence automatically authorizes all presence subscription requests it receives from both XMPP-based clients and SIP-based in the local enterprise.

Check Allow users to view the availability of other users without being prompted for approval.

Turn off automatic authorization so that Cisco Unified Presence 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.

Uncheck Allow users to view the availability of other users without being prompted for approval.


Step 3 Select Save.

Step 4 Restart the Cisco UP XCP Router service.


Related Topics

Restarting the Cisco UP XCP Router Service, page 6-2

Automatic Authorization on Cisco Unified Presence, page 6-39

Configuring Chat on Cisco Unified Presence, page 9-1

What To Do Next

Configuring the SIP Publish Trunk on Cisco Unified Presence, page 6-48

How To Configure the Availability Settings on Cisco Unified Presence

Turning On or Off Availability Sharing for a Cisco Unified Presence Cluster, page 6-42

Configuring the Do Not Disturb Settings on Cisco Unified Presence, page 6-43

Configuring the Temporary Presence Subscription Settings, page 6-44

Configuring the Maximum Contact List Size Per User, page 6-45

Configuring the Maximum Number of Watchers Per User, page 6-46

Turning On or Off Availability Sharing for a Cisco Unified Presence Cluster

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

Availability sharing is turned on by default on Cisco Unified Presence.

Procedure


Step 1 Select Cisco Unified Presence Administration > Presence > Settings.

Step 2 Configure the availability setting as follows:

If You Want To...
Do This

Turn on availability sharing in the Cisco Unified Presence cluster. If you turn on this setting, Cisco Unified Presence 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 client (Cisco Unified Personal Communicator) and the Cisco Unified Presence User Options interface.

Check Enable availability sharing.

Turn off availability sharing for all clients in the Cisco Unified Presence cluster. If you turn off this setting, Cisco Unified Presence does not share any availability to other users in the Cisco Unified Presence cluster, nor does it share availability information it receives from outside the cluster. Users can only view their own availability status.

Uncheck Enable availability sharing.


Step 3 Select Save.

Step 4 Restart the following services:

Cisco UP XCP Router

Cisco UP Presence e 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.

Configuring the Do Not Disturb Settings on Cisco Unified Presence

You can configure global administrator-level Do Not Disturb (DND) availability states as an alternative to the Busy state for phone calls and meetings. Cisco Unified Presence 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:

Cisco Unified Presence 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 Cisco Unified Presence, the DND settings only impact users when they view their own availability.

Procedure


Step 1 Select Cisco Unified Presence Administration > Presence > Settings.

Step 2 Configure the administrator-level DND setting as follows:

If You Want...
Do This

Cisco Unified Presence to display an availability status of DND when users are on the phone. If you turn off (uncheck) this setting, Cisco Unified Presence displays a status of Busy when users are on the phone.

By default, this setting is turned off.

Check Use DND status when user is on the phone.

Cisco Unified Presence to display an availability status of DND when users are in a meeting. If you turn off (uncheck) this setting, Cisco Unified Presence displays a status of Busy when users are in a meeting.

By default, this setting is turned off.

Check Use DND status when user is in a meeting.


Step 3 Select Save.


Related Topic

Do Not Disturb Behavior of Cisco Unified Personal Communicator, page 13-11

Configuring the Temporary Presence Subscription Settings


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


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

Procedure


Step 1 Select Cisco Unified Presence Administration > Presence > Settings.

Step 2 Check Enable ad-hoc presence subscriptions to turn on temporary presence subscriptions for Cisco Unified Personal Communicator Release users.

Step 3 Configure the maximum number of active temporary subscriptions that Cisco Unified Presence permits at one time. If you configure a value of zero, Cisco Unified Presence permits an unlimited number of active temporary subscriptions.

Step 4 Configure the time-to-live value (in seconds) for the temporary presence subscriptions.

When this time-to-live value expires, Cisco Unified Presence drops any temporary 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 temporary presence subscription, the availability status that displays may not be current.


Step 5 Select Save.


Troubleshooting Tips

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

Configuring the 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 client applications such as Cisco Unified Personal Communicator, and on third-party client applications.


Note 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.


Procedure


Step 1 Select Cisco Unified 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 Select Save.

Step 4 Restart the Cisco UP XCP Router service.


Troubleshooting Tips

If you upgrade from Cisco Unified Presence Release 7.0(x) to Release 8.x, check that the contact list size for users has not reached the maximum value. The System Troubleshooter in Cisco Unified Presence Administration indicates if there are users who have reached the contact list limit.

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, Cisco Unified Presence does not add the surplus contacts. For example, if the maximum contact list size on Cisco Unified Presence is 200. A user has 195 contacts and attempts to add 6 new contacts to the list, Cisco Unified Presence adds five contacts and does not add the sixth contact.

Related Topics

Configuring the Maximum Number of Watchers Per User, page 6-46

Restarting the Cisco UP XCP Router Service, page 6-2

How to Perform Intercluster Upgrades, page 15-7

Configuring the 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 clients such as Cisco Unified Personal Communicator, and on third-party clients.

Procedure


Step 1 Select Cisco Unified Presence Administration > Presence > Settings.

Step 2 Edit the value of the Maximum Watchers (per user) setting.

The default value is 200.

Step 3 Select Save.

Step 4 Restart the Cisco UP XCP Router service.


How to Configure the Instant Messaging Settings on Cisco Unified Presence

Turning On or Off Instant Messaging for a Cisco Unified Presence Cluster, page 6-46

Turning On or Off Offline Instant Messaging, page 6-47

Allowing Clients to Log Instant Message History, page 6-48

Turning On or Off Instant Messaging for a Cisco Unified Presence Cluster

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


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

Procedure


Step 1 Select Cisco Unified Presence Administration > Messaging > Settings.

Step 2 Configure the instant messaging setting as follows:

If You Want To...
Do This

Turn on instant message capabilities for client applications in the Cisco Unified Presence cluster. If you turn on this setting, local users of client applications can send and receive instant messages.

Check Enable instant messaging.

Turn off instant message capabilities for client applications in the Cisco Unified Presence cluster.

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.

Uncheck Enable instant messaging.


Step 3 Select Save.

Step 4 Restart the Cisco UP XCP Router service.


Turning On or Off Offline Instant Messaging

By default Cisco Unified Presence stores (locally) any instant messages that are sent to a user when they are offline, and Cisco Unified Presence 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 Cisco Unified Presence 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 Select Cisco Unified Presence Administration > Messaging > Settings.

Step 2 Configure the offline instant messaging setting as follows:

If You Want To...
Do This

Turn off the storage of offline instant messages on Cisco Unified Presence. If you check this setting, any instant messages that are sent to a user when they are offline, Cisco Unified Presence does not deliver these instant messages to the user the next time they sign in to the client application.

Check Suppress Offline Instant Messaging.

Turn on the storage of offline instant messages on Cisco Unified Presence If you uncheck this setting, any instant messages that are sent to a user when they are offline, Cisco Unified Presence delivers these instant messages to the user the next time they sign in to the client application.

Uncheck Suppress Offline Instant Messaging.


Step 3 Select Save.


Allowing 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 Select Cisco Unified Presence Administration > Messaging > Settings.

Step 2 Configure the log instant message history setting as follows:

If You Want To...
Do This

Allow users of client applications to log instant message history on Cisco Unified Presence.

Check Allow clients to log instant message history (on supported clients only).

Prevent users of client applications from logging instant message history on Cisco Unified Presence.

Uncheck Allow clients to log instant message history (on supported clients only).


Step 3 Select Save.


Configuring the SIP Publish Trunk on Cisco Unified Presence

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

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 Select Cisco Unified Presence Administration > Presence > Settings.

Step 2 Check Enable SIP Publish on CUCM.

Step 3 Select a SIP Trunk from the CUCM SIP Publish Trunk menu.

Step 4 Select Save.


Configuring the Proxy Server Settings

Procedure


Step 1 Select Cisco Unified Presence Administration > Presence > Routing > Settings.

Step 2 Select On for the Method/Event Routing Status.

Step 3 Select Default SIP Proxy TCP Listener for the Preferred Proxy Server.

Step 4 Select Save.


What To Do Next

How to Configure Cisco IP PhoneMessenger on Cisco Unified Presence, page 10-3, or

About Configuring Cisco Unified Personal Communicator on Cisco Unified Presence, page 11-19

SIP Digest Authentication

Digest Authentication is enabled by default on Cisco Unified Presence SIP interfaces.

Therefore any user that is using Cisco Unified Personal Communicator 7, must have digest credentials configured on CUCM.

Cisco Unified Personal Communicator will then retrieve these credentials through the Cisco Unified Presence SOAP APIs prior to connecting over the SIP interface.

To configure Digest Authentication credentials for a user:


Step 1 From the CUCM Administration GUI, navigate to the User Management > End User.

Step 2 Select the user from the find list.

Step 3 Enter the credentials in the Digest Credentials text box.

Step 4 Confirm by re-entering the Confirm Digest Credentials text box.

Step 5 Click Save.



Note The CUCM Bulk Administration tool (From the CUCM Administration GUI, navigate to Bulk Administration > Users > Update Users) allows for digest credentials to be updated in bulk for a set of users.


An alternative to configuring digest credentials is to add specific Access Control List (ACL) entries for each Client Machine on which Cisco Unified Personal Communicator is running.

Having an ACL entry for the client machine ensures that digest authentication is bypassed.

ACL entries are added on the Cisco Unified Presence Admin GUI by:


Step 1 Navigate to System > Security > Incoming ACL.

Step 2 Click Add New.

Step 3 Enter the IP address in Address Pattern.

Step 4 Optionally enter in a Description value.

Step 5 Click Save.



Note Bypassing Digest Authentication is not the Cisco recommended approach as the configuration is static and does not allow for deployments where IP addresses are not statically provisioned to machines.


How to Turn On the Cisco Unified Presence Services

Turning On the Sync Agent, page 6-50

Turning On the Cisco Unified Presence Services, page 6-51

Turning On the Sync Agent

We recommend that you turn on the Sync Agent on all Cisco Unified Presence nodes in the cluster.

Before You Begin

Configure the topology for your deployment before starting the Sync Agent.

If you deploy the Cisco Unified Personal Communicator client with Cisco Unified Presence, and you configure system-wide default application profiles (LDAP, CTI Gateway, Voicemail, Conferencing profiles) for your users, configure and enable the default profiles before you activate the Sync Agent.

Procedure


Step 1 Select Cisco Unified Presence Administration > System > Service Parameters.

Step 2 Select the Cisco Unified Presence server from the Server menu.

Step 3 Select Cisco UP Sync Agent server from the Service menu.

Step 4 Select a value for the User Assignment Mode as follows:

If set to Balanced, the Sync Agent synchronizes user information to Cisco Unified Presence, 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 Cisco Unified Presence, 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.

If set to None, the Sync Agent synchronizes user information to Cisco Unified Presence but does not assign any users. You must manually assign your users to nodes using the system topology interface

Step 5 Select Save.


Related Topics

How to Configure the Cluster Topology on Cisco Unified Presence, page 6-3

Configuring Basic Features for Cisco Unified Personal Communicator, page 11-1

Turning On the Cisco Unified Presence Services, page 6-51

Turning On the Cisco Unified Presence Services

The procedure below lists out the services that you need to turn on when you deploy a basic Cisco Unified Presence configuration. You need to turn on these services on each node in your Cisco Unified Presence cluster.

There are other optional Cisco Unified Presence services that you may need to turn on depending on the additional features that you deploy on Cisco Unified Presence. See the Cisco Unified Presence documentation relating to those specific features for further details.

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

Procedure


Step 1 Select Cisco Unified Presence Serviceability > Tools > Service Activation.

Step 2 Select the Cisco Unified Presence server from the Server menu.

Step 3 For a basic Cisco Unified Presence deployment, turn on the following services:

Cisco UP SIP Proxy

Cisco UP Presence Engine

Cisco UP Sync Agent

Cisco UP XCP Counter Aggregator

Step 4 Select Save.


Related Topics

Serviceability Configuration and Maintenance Guide for Cisco Unified Presence

Turning On the Sync Agent, page 6-50