CISCO Release 14 Unity Connection Cluster User Guide

CISCO Release 14 Unity Connection Cluster

Product Information

Specifications

• Product Name: Cisco Unity Connection Cluster
• High availability voice messaging
• Two servers running the same versions of Unity Connection
• Publisher server and subscriber server

Product Usage Instructions

Task List for Configuring a Unity Connection Cluster

1. Gather Unity Connection cluster requirements.
2. Set up alert notifications for Unity Connection alerts.
3. Customize the cluster settings on the publisher server.

Configuring Cisco Unity Connection Cluster Settings on the Publisher Server

1. Sign in to Cisco Unity Connection Administration.
2. Expand System Settings > Advanced and select Cluster Configuration.
3. On the Cluster Configuration page, change the server status and select Save.

Administering a Unity Connection Cluster

To check the Unity Connection cluster status and ensure proper configuration:

Checking the Cluster Status from Web Interface

1. Sign in to Cisco Unity Connection Serviceability of either publisher or subscriber server.
2. Expand Tools and select Cluster Management.
3. On the Cluster Management page, check the server status.

Checking the Cluster Status from Command Line Interface (CLI)

1. Run the show cuc cluster status CLI command on the publisher server or subscriber server.

Managing Messaging Ports in a Cluster

In a Unity Connection cluster, the servers share the same phone system integrations. Each server handles a share of the incoming calls for the cluster.

Port Assignments

Depending on the phone system integration, each voice messaging port is either assigned to a specific server or used by both servers.

FAQ

• Q: How do I gather Unity Connection cluster requirements?
• A: For more information on gathering Unity Connection cluster requirements, refer to the System Requirements for Configuring Cisco Unity Connection Cluster documentation.
• Q: How do I set up alert notifications for Unity Connection alerts?
• A: Refer to the Cisco Unified Real-Time Monitoring Tool Administration Guide for instructions on setting up alert notifications for Unity Connection alerts.
• Q: How do I change the server status in a cluster?
• A: To change the server status in a cluster, sign in to Cisco Unity Connection Administration, expand System Settings > Advanced, select Cluster Configuration, and modify the server status on the Cluster Configuration page.
• Q: How do I check the Unity Connection cluster status?
• A: You can check the Unity Connection cluster status either using the web interface or the Command Line Interface (CLI). For detailed steps, refer to the “Checking the Cluster Status” section in the user manual.
• Q: How do I manage messaging ports in a cluster?
• A: The user manual provides information on managing messaging ports in a cluster. Please refer to the “Managing Messaging Ports in a Cluster” section for details.

Introduction

The Cisco Unity Connection cluster deployment provides high-availability voice messaging through the two servers that run the same versions of Unity Connection. The first server in the cluster is the publisher server and the second server is the subscriber server.

Task List for Configuring a Unity Connection Cluster

Do the following tasks to create a Unity Connection cluster:

1.  Gather Unity Connection cluster requirements. For more information, see System Requirements for Cisco Unity Connection Release 14 at
2.    https://www.cisco.com/c/en/us/td/docs/voice_ip_comm/connection/14/requirements/b_14cucsysreqs.html.
3. Install the publisher server. For more information, see the Installing the Publisher Server section.
4.  Install the subscriber server. For more information, see the Installing the Subscriber Server section.
5. Configure the Cisco Unified Real-Time Monitoring Tool for both publisher and subscriber servers to send notifications for the following Unity Connection alerts:

• * AutoFailbackFailed

  • AutoFailbackSucceeded
  • AutoFailoverFailed
  • AutoFailoverSucceeded
  •  NoConnectionToPeer
  • SbrFaile

For instructions on setting up alert notification for Unity Connection alerts, see the “Cisco Unified Real-Time Monitoring Tool” section of the Cisco Unified Real-Time Monitoring Tool Administration Guide for the required release, available at  http://www.cisco.com/c/en/us/support/unified-communications /unity-connection/products-maintenance-guides-list.html.

1.  (Optional) Do the following tasks to customize the cluster settings on the publisher server:

• Sign in to Cisco Unity Connection Administration.
• Expand System Settings > Advanced and select Cluster Configuration.
• On the Cluster Configuration page, change the server status and select Save. For more information on changing the server status in a cluster, see Help> This Page.

Administering a Unity Connection Cluster

You must check the Unity Connection cluster status to ensure that the cluster is correctly configured and working properly. It is also important to understand the different server status in a cluster and the effects of changing a server status in a cluster.

Checking the Cluster Status

You can check the Unity Connection cluster status either using the web interface or Command Line Interface (CLI). Steps to Check the Unity Connection Cluster Status from Web Interface

• Step 1 Sign into Cisco Unity Connection Serviceability of either publisher or subscriber server.
• Step 2 Expand Tools and select Cluster Management.
• Step 3 On the Cluster Management page, check the server status. For more information about server status, see the Server Status and its Functions in a Unity Connection Cluster section.

Steps to Check Unity Connection Cluster Status from Command Line Interface (CLI)

• Step 1 You can run the show cuc cluster status CLI command on the publisher server or subscriber server to check the cluster status.
• Step 2 For more information about server status and its related functions, see the Server Status and its Functions in a Unity Connection Cluster section.

Managing Messaging Ports in a Cluster

In a Unity Connection cluster, the servers share the same phone system integrations. Each server is responsible for handling a share of the incoming calls for the cluster (answering phone calls and taking messages).

Depending on the phone system integration, each voice messaging port is either assigned to a specific server or used by both servers. Managing Messaging Ports in a Cluster describes the port assignments.
Table 1: Server Assignments and Usage of Voice Messaging Ports in a Unity Connection Cluster

Integration Type| Server Assignments and Usage of Voice Messaging Ports
---|---
Integration by Skinny Client Control Protocol (SCCP) with Cisco Unified Communications Manager or Cisco Unified Communications Manager Express| •  The phone system is set up with twice the number of SCCP voices that are needed to handle the voice messaging traffic. (For example, voicemail port devices are needed to handle all voice messaging voicemail port devices must be set up on the phone system.)

•  In Cisco Unity Connection Administration, the voice messaging is configured so that half the number of the ports set up on the phon is assigned to each server in the cluster. (For example, each server i has 16 voice messaging ports.)

•  On the phone system, a line group, hunt list, and hunt group enable the subscriber server to answer most of the incoming calls fo

•  If one of the servers stops functioning (for example, when it is sh maintenance), the remaining server assumes responsibility for the incoming calls for the cluster.

•  When the server that stopped functioning is able to resume its nor and is activated, it resumes the responsibility of handling its share calls for the cluster.

Integration through a SIP Trunk with Cisco Unified Communications Manager or Cisco Unified Communications Manager Express| •  In Cisco Unity Connection Administration, half the number of VO ports that are needed to handle voice messaging traffic are assigned in the cluster. (For example, if 16 voice messaging ports are needed for all voice messaging traffic for the cluster, each server in the cluster has 8 voice messaging ports.)

•  On the phone system, a route group, route list, and route pattern a to distribute calls equally between both servers in the cluster.

•  If one of the servers stops functioning (for example, when it is sh maintenance), the remaining server assumes responsibility of the incoming calls for the cluster.

•  When the server that stopped functioning is able to resume its nor and is activated, it resumes the responsibility of handling its share of

for the cluster.

Integration Type| Server Assignments and Usage of Voice Messaging Ports
---|---
Integration through PIMG/TIMG units| •  The number of ports set up on the phone system is the same as the nu voice messaging ports on each server in the cluster so that the server has the voice messaging ports. (For example, if the phone system is set u with voice messaging ports, each server in the cluster must have the same messaging ports.)

•  On the phone system, a hunt group is configured to distribute calls eq both servers in the cluster.

•  The PIMG/TIMG units are configured to balance the voice messaging between the servers.

•  If one of the servers stops functioning (for example, when it is shut d maintenance), the remaining server assumes responsibility for handling incoming calls for the cluster.

•  When the server that stopped functioning is able to resume it is normal and is activated, it resumes the responsibility of handling its share of income for the cluster.

Other integrations that use SIP| •  In Cisco Unity Connection Administration, half the number of voice ports that are needed to handle voice messaging traffic are assigned to in the cluster. (For example, if 16 voice messaging ports are needed t all voice messaging traffic for the cluster, each server in the cluster has messaging ports.)

•  On the phone system, a hunt group is configured to distribute calls eq both servers in the cluster.

•  If one of the servers stops functioning (for example, when it is shut for maintenance), the remaining server assumes responsibility for handling incoming calls for the cluster.

•  When the server that stopped functioning can resume its normal it resumes responsibility of handling its share of incoming calls for th

Stopping All Ports from Taking New Calls

Follow the steps in this section to stop all the ports on a server from taking any new calls. Calls in progress continue until the callers hang up.

Tip  Use the Port Monitor page in the Real-Time Monitoring Tool (RTMT) to determine whether any port is currently handling calls for the server. For more information, see the Step Stopping All Ports from Taking New Calls
Stopping All Ports on a Unity Connection Server from Taking New Calls

• Step 1 Sign in to Cisco Unity Connection Serviceability.
• Step 2 Expand the Tools menu, and select Cluster Management.
• Step 3 On the Cluster Management page, under Port Manager, in the Change Port Status column, select Stop Taking Calls for the server.

Restarting All Ports to Take Calls

Follow the steps in this section to restart all the ports on a Unity Connection server to allow them to take calls again after they were stopped.

• Step 1 Sign in to Cisco Unity Connection Serviceability.
• Step 2 Expand the Tools menu, and select Cluster Management.
• Step 3 On the Cluster Management page, under Port Manager, in the Change Port Status column, select Take Calls for the server.

Server Status and its Functions in a Unity Connection Cluster

Each server in the cluster has a status that appears on the Cluster Management page of Cisco Unity Connection Serviceability. The status indicates the functions that the server is currently performing in the cluster, as described in Table 2: Server Status in a Unity Connection Cluster

Table 2: Server Status in a Unity Connection Cluste r

Server Status| Responsibilities of the Sever in a Unity Connection Cluster
---|---
Primary| •  Publishes the database and message store both of which are replicated to the other server

•  Receives replicated data from the other server.

•  Displays and accepts changes to the administrative interfaces, such as Unity Connection and Cisco Unified Operating System Administration. This data is replicated to the other cluster.

•  Answers phone calls and takes messages.

•  Sends message notifications and MWI requests.

•  Sends SMTP notifications and VPIM messages.

•  Synchronizes voice messages in Unity Connection and Exchange mailboxes if the Unifi feature is configured.

•  Connects with the clients, such as email applications and the web tools available through

__

Note **** A server with Primary status cannot be deactivated.

Server Status| Responsibilities of the Sever in a Unity Connection Cluster
---|---
Secondary| •  Receives replicated data from the server with Primary status. Data includes the database and store.

•  Replicates data to the server with Primary status.

•  Displays and accepts changes to the administrative interfaces, such as Unity Connection Adm and Cisco Unified Operating System Administration. The data is replicated to the server with a status.

•  Answers phone calls and takes messages.

•  Connects with the clients, such as email applications and the web tools available through Ci

__

Note **** Only a server with Secondary status can be deactivated.

Deactivated| •  Receives replicated data from the server with Primary status. Data includes the database and store.

•  Does not display the administrative interfaces, such as Unity Connection Administration an Unified Operating System Administration. The data is replicated to the server with the Primary

•  Does not answer phone calls or take messages.

•  Does not connect with the clients, such as email applications and the web tools available through Cisco PCA.

Not Functioning| •  Does not receive replicated data from the server with Primary status.

•  Does not replicate data to the server with Primary status.

•  Does not display the administrative interfaces, such as Unity Connection Administration an Unified Operating System Administration.

•  Does not answer phone calls or take messages.

__

Note **** A server with Not Functioning status is usually shut down.

Starting| •  Receives replicated database and message store from the server with Primary status.

•  Replicates data to the server with Primary status.

•  Does not answer phone calls or take messages.

•  Does not synchronize voice messages between Unity Connection and Exchange mailboxes inbox).

__

Note **** This status lasts only a few minutes, after which the server takes the applicable statu

Server Status| Responsibilities of the Sever in a Unity Connection Cluster
---|---
Replicating Data| •  Sends and receives data from the cluster.

•  Does not answer phone calls or take messages for some time.

•  Does not connect with clients, such as email applications and the web tools available thr Cisco PCA for some time.

__

Note **** This status lasts only a few minutes, after which the previous status resumes for

Split Brain Recovery ( After detecting two servers with Primary status)| • Updates the database and message store on the server that is determined to have Primary

•  Replicates data to the other server.

•  Does not answer phone calls or take messages for some time.

•  Does not synchronize voice messages between Unity Connection and Exchange mailbox inbox is turned on for some time.

•  Does not connect with clients, such as email applications and the web tools available the Cisco PCA for some time.

__

Note **** This status lasts only a few minutes, after which the previous status resumes for

Changing Server Status in a Cluster and its Effects

The Unity Connection cluster status can be changed either automatically or manually. You can manually change the status of servers in a cluster in the following ways:

1.  A server with a Secondary status can be manually changed to a Primary status. See th e Manually Changing the Server Status from Secondary to Primary section.
2. A server with a Secondary status can be manually changed to a Deactivated status. See the Manually Activating Server with Deactivated Status.
3.  A server with a Deactivated status can be manually activated so that its status changes to Primary or Secondary, depending on the status of the other server. See the Manually Activating a Server with Deactivated Status section.

Manually Changing the Server Status from Secondary to Primary

• Step 1 Sign in to Cisco Unity Connection Serviceability.
• Step 2 From the Tools menu, select Cluster Management.
• Step 3 On the Cluster Management page, from the Server Manager menu, in the Change Server Status column of the server with Secondary status, select Make Primary.
• Step 4 When prompted to confirm the change in server status, select OK. The Server Status column displays the changed status when the change is complete.

Note The server that originally had Primary status automatically changes to Secondary status

• Step 1 Sign in to the Real-Time Monitoring Tool (RTMT).

• Step 2 From the Cisco Unity Connection menu, select Port Monitor. The Port Monitor tool appears in the right pane.

• Step 3 In the Node field, select the server with Secondary status.

• Step 4 In the right pane, select Start Polling. Note whether any voice messaging ports are currently handling calls for the server.

• Step 5 Sign in to Cisco Unity Connection Serviceability.

• Step 6 From the Tools menu, select Cluster Management.

• Step 7 If no voice messaging ports are currently handling calls for the server, skip to Manually Changing the Server Status from Secondary to Deactivated. If there are voice messaging ports that are currently handling calls for the server, on the Cluster Management page, in the Change Port Status column, select Stop Taking Calls for the server and then wait until RTMT shows that all ports for the server are idle.

• Step 8 On the Cluster Management page, from the Server Manager menu, in the Change Server Status column for the server
  with Secondary status, select Deactivate. Deactivating a server terminates all the calls that the ports for the server are handling.

• Step 9 When prompted to confirm the change in the server status, select OK. The Server Status column displays the changed status when the change is complete.

Manually Activating a Server with Deactivated Status

• Step 1 Sign in to Cisco Unity Connection Serviceability.
• Step 2 From the Tools menu, select Cluster Management.
• Step 3 On the Cluster Management page, in the Server Manager menu, in the Change Server Status column for the server with Deactivated status, select Activate.
• Step 4 When prompted to confirm the change in the server status, select OK. The Server Status column displays the changed status when the change is complete

Effect on Calls in Progress When Server Status Changes in a Unity Connection Cluster

When the status of a Unity Connection server changes, the effect on calls in progress depends upon the final status of the server that is handling a call and on the condition of the network. The following table describes

the effects:

Table 3: Effect on Calls in Progress When Server Status Changes in a Unity Connection Cluster

progress are not affected.

When the status change is automatic, the effect on calls in progress depends on the critical service that stopped.

Secondary to Primary| When the status change is initiated manually, calls in progress are not affected.

When the status change is automatic, the effect on calls in progress depends upon the critical service that stopped.

Secondary to Deactivated| Calls in progress are dropped.

To prevent dropped calls, on the Cluster Management page in Cisco Unity Connection Serviceability, select Stop Taking Calls for the server and wait until all the calls end and deactivate the server.

Primary or Secondary to Replicating Data| Calls in progress are not affected.
Primary or Secondary to Split Brain Recovery| Calls in progress are not affected.

If network connections are lost, then calls in progress may be dropped depending upon the nature of the network problem.

Effect on Unity Connection Web Applications When the Server Status Changes

The functioning of the following web applications is not affected when the server status changes:

• Cisco Unity Connection Administration
• Cisco Unity Connection Serviceability
• Cisco Unity Connection web tools accessed through the Cisco PCA—the Messaging Assistant, Messaging Inbox, and Personal Call Transfer Rules web tools
• Cisco Web Inbox
• Representational state transfer (REST) API clients

Effect of Stopping a Critical Service on a Unity Connection Cluster

Critical services are necessary for the normal functioning of the Unity Connection system. The effects of stopping a critical service depends upon the server and its status described in the following table:

Table 4: Effects of Stopping a Critical Service on a Unity Connection Cluster

in Cisco Unity Connection Serviceability causes the server status to change to Secondary and degrades the ability of the server to function normally.

The status of the subscriber server changes to Primary if it does not have the Disabled or Not Functioning status.

•  When the server has Secondary status, stopping a critical service in Cisco Unity Connection Serviceability degrades the ability of the server to function normally. The status of the servers does not change.

Subscriber| When the server has Primary status, stopping a critical service in Cisco Unity Connection Serviceability degrades the ability of the server to function normally. The status of the servers does not change.

Shutting Down a Server in a Cluster

When a Unity Connection server has Primary or Secondary status, it handles voice messaging traffic and cluster data replication. We do not recommend you to shut down both servers in a cluster at the same time to avoid abrupt termination of the calls and replication that are in progress. Consider the following points when you want to shutdown a server in a Unity Connection cluster:

• Shut down the server during nonbusiness hours when voice messaging traffic is low.

• Change the server status from Primary or Secondary to Deactivated before shutting down.

• Step 1 On the server that does not shut down, sign in to Cisco Unity Connection Serviceability.

• Step 2 From the Tools menu, select Cluster Management.

• Step 3 On the Cluster Management page, locate the server that you want to shut down.

• Step 4 If the server that you want to shut down has a Secondary status, skip to

• Step 5. If the server that you want to shut down has Primary status, change the status:

  • In the Change Server Status column for the server with Secondary status, select Make Primary.
  • When prompted to confirm the change in the server status, select OK.
  • Confirm that the Server Status column indicates that the server has Primary status now and that the server you want to shut down has Secondary status

• Step 5 On the server with Secondary status (the one you want to shut down), change the status:

  • Sign in to the Real-Time Monitoring Tool (RTMT).

  • From the Cisco Unity Connection menu, select Port Monitor. The Port Monitor tool appears in the right pane.

  • In the Node field, select the server with Secondary status.

  • In the right pane, select Start Polling.

  • Note whether any voice messaging ports are currently handling calls for the server.

  • If no voice messaging ports are currently handling calls for the server, skip to Step5g.. If there are voice messaging ports that are currently handling calls for the server, on the Cluster Management page,
    in the Change Port Status column, select Stop Taking Calls for the server and then wait until RTMT shows that all ports for the server are idle.

  • On the Cluster Management page, from the Server Manager menu, in the Change Server Status column for the server with Secondary status, select Deactivate. Caution Deactivating a server terminates all calls that the ports for the server are handling

  • When prompted to confirm the change in the server status, select OK.

  • Confirm that the Server Status column indicates that the server now has Deactivated status.

• Step 6 Shut down the server that you deactivated:

  • Sign in to Cisco Unity Connection Serviceability.
  •  Expand Tools and select Cluster Management.
  •  Make sure that the Server Status column shows the Not Functioning status for the server that you shutdown

Replacing Servers in a Cluster

Follow the steps in the given sections to replace publisher or subscriber server in a cluster:

• To replace the publisher server, see the Replacing a Publisher Server section.
• To replace the subscriber server, see the Replacing a Subscriber Server section.

How a Unity Connection ClusterWorks
The Unity Connection cluster feature provides high-availability voice messaging through two Unity Connection servers that are configured in a cluster. The Unity Connection cluster behavior when both the servers are active:

• The cluster can be assigned a DNS name that is shared by the Unity Connection servers.
• Clients, such as email applications and the web tools available through the Cisco Personal Communications Assistant (PCA) can connect to either of the Unity Connection servers.
• Phone systems can send calls to either of the Unity Connection servers.
• Incoming phone traffic load is balanced between the Unity Connection servers by the phone system, PIMG/TIMG units, or other gateways that are required for the phone system integration.

Each server in a cluster is responsible for handling a share of the incoming calls for the cluster (answering phone calls and taking messages). The server with Primary status is responsible for the following functions:

• Homing and publishing the database and message store that are replicated to the other server.
• Sending message notifications and MWI requests (the Connection Notifier service is activated).
• Sending SMTP notifications and VPIM messages (the Connection Message Transfer Agent service is activated).
• Synchronizing voice messages between Unity Connection and Exchange mailboxes, if the unified messaging feature is configured (the Unity Connection Mailbox Sync service is activated).

When one of the servers stops functioning (for example, when it is shut down for maintenance), the remaining server resumes the responsibility of handling all the incoming calls for the cluster. The database and message store are replicated to the other server when its functionality is restored. When the server that stopped functioning is able to resume its normal functions and is activated, it resumes responsibility of handling its share of incoming calls for the cluster.

Note

It is recommended to perform provisioning only on the Publisher server in Active-Active mode and on Subscriber (Acting Primary) in case of cluster failover. The password change and password setting modification for the User PIN/Web application should be provisioned on the Publisher server in Active- Active mode. To monitor the server status, the Connection Server Role Manager service runs in Cisco Unity Connection Serviceability on both servers. This service performs the following functions:

• Starts the applicable services on each server, depending on server status.
• Determines whether critical processes (such as voice message processing, database replication, voice message synchronization with Exchange, and message store replication) are functioning normally.
• Initiates changes to server status when the server with Primary status is not functioning or when critical services are not running.

Note the following limitations when the publisher server is not functioning:

• If the Unity Connection cluster is integrated with an LDAP directory, directory synchronization does not occur, although authentication continues to work when only the subscriber server is functioning. When the publisher server is resumes functioning, directory synchronization also resumes.
• If a digital or HTTPS network includes the Unity Connection cluster, directory updates do not occur, although messages continue to be sent to and from the cluster when only the subscriber server is functioning. When the publisher server is functioning again, directory updates resume.

The Connection Server Role Manager service sends a keep-alive event between the publisher and subscriber servers to confirm that the servers are functioning and connected. If one of the servers stops functioning or the connection between the servers is lost, the Connection Server Role Manager service waits for the keep-alive events and may require 30 to 60 seconds to detect that the other server is not available. While the Connection Server Role Manager service is waiting for the keep-alive events, users signing in to the server with Secondary status are not able to access their mailbox or send messages, because the Connection Server Role Manager service has not yet detected that the server with Primary status (which has the active message store) is unavailable. In this situation, callers who attempt to leave a message may hear dead air or may not hear the recording beep.

Note It is recommended to import and delete the LDAP users from the publisher node only.

Effects of Split Brain Condition in a Unity Connection Cluster

When both the servers in a Unity Connection cluster have Primary status at the same time (for example, when the servers have lost their connection with each other), both servers handle the incoming calls (answer phone calls and take messages), send message notifications, send MWI requests, accept changes to the administrative interfaces (such as Unity Connection Administration), and synchronize voice messages in Unity Connection and Exchange mailboxes if single inbox is turned on

• However, the servers do not replicate the database and message store to each other and do not receive replicated data from each other.
  When the connection between the servers is restored, the status of the servers temporarily changes to Split Brain Recovery while the data is replicated between the servers and MWI settings are coordinated. During the time when the server status is Split Brain Recovery, the Connection Message Transfer Agent service and the Connection Notifier service (in Cisco Unity Connection Serviceability) are stopped on both servers, so Unity Connection does not deliver any messages and does not send any message notifications.

• The Connection Mailbox Sync service is also stopped, so Unity Connection does not synchronize voice messages with Exchange (single inbox). The message stores are also briefly dismounted, so that Unity Connection tells users who are trying to retrieve their messages at this point that their mailboxes are temporarily unavailable.
  When the recovery process is complete, the Connection Message Transfer Agent service and the Connection Notifier service are started on the publisher server. Delivery of the messages that arrived while during the recovery process may take additional time, depending on the number of messages to be delivered. The Connection Message Transfer Agent service and the Connection Notifier service are started on the subscriber server. Finally, the publisher server has Primary status and the subscriber server has Secondary status. At this point, the Connection Mailbox Sync service is started on the server with Primary status, so that Unity Connection can resume synchronizing voice messages with Exchange if a single inbox is turned on.

Read User Manual Online (PDF format)

Download This Manual (PDF format)

Download this manual  >>