Cisco Unity Connection VKM Configuration Guide

Overview

Cisco Unity Connection is a feature-rich voice messaging platform that runs on the same Linux- based operating system used by the Cisco Unified Communications Manager (CUCM). Unity Connection provides a set of tools and APIs for administrating, monitoring, and troubleshooting the system; some of these tools are also used by the CUCM. They are designed to offer a consistent experience and streamline the ongoing management and operation of the system, including:

• Alarms
• Trace information
• Services that are common to the products/platform
• Perfmon counter
• Simple Network Management Protocol (SNMP) operations

About this Guide

This guide is designed to assist Nectar Unified Communications Management Platform (UCMP) users in the monitoring of Cisco Unity Connection alarms, including how to:

Configure the Nectar RIG

Configure Cisco Unity Connection

Configure Cisco Unity Connection VKM

Configure Alarms

Configure VKM Option

View Inventory

Manage Unity Clusters

Supported Software Versions

• Nectar UCMP v8.7
• Cisco Unity Connection v9.x, v10.x, v11.x, and v12.x

Configure the Nectar RIG

Configuring the Nectar RIG includes the following tasks:

Enable the Cisco Unity Module

Configure the receiver-module.properties File

Enable the Cisco Unity Module

Follow these steps to enable the Cisco Unity module:

1. Navigate to RIG > Module Configuration. The Module Configuration window appears.
2. Select Cisco Unity.

1. Click Apply.

Figure 2-1 Enable Cisco Unity

1. To restart the RIG and apply the changes:
   1. Navigate to RIG > Admin > Restart.
   2. When the following message appears, click Yes.

Figure 2-2 Restart

Configure the receiver-module.properties File

Follow these steps to locate, download, update, and save the receiver-module.properties

file, as needed:

1. Navigate to RIG > File Manager. The File Manager window appears.

Figure 2-3 Remote File System

1. Look for the Remote File System pane on the right; then navigate to

etc\server.properties configuration file in the RIG installation directory.

Figure 2-4 receiver-module.properties File

1. Right-click on the receiver-module.properties file and select Download.
2. Save the receiver-module.properties file to the local destination.
3. Navigate to the receiver-module.properties file.
4. Right-click on the receiver-module.properties file and select Open With.
5. Open the file using Notepad.

Enable Syslog.

1. Navigate to File > Save to save the changes.
2. Navigate to RIG > File Manager. The File Manager window appears.
3. Navigate to etc\receiver-module.properties configuration file in the RIG installation directory.
4. Right-click on the receiver-module.properties file and select Upload.
5. Browse to the updated receiver-module.properties file, select, and click Open. The Upload File window appears.
6. Click Upload.
7. To restart the RIG and apply the changes:
   1. Navigate to RIG > Admin > Restart.
   2. When the following message appears, click Yes.

Enable Syslog

Figure 2-5 Restart

To enable Syslog, add the following property and value:

Figure 2-6 syslog.enable

Configure Cisco Unity Connection

Configuring the Cisco Unity Connect includes the following tasks:

Configure SNMP

Configure Nectar User

Add Roles

Configure SNMP

Create the SNMP Community String

Follow these steps to create the SNMP community string:

1. Access Cisco Unified Serviceability using the drop-down; then click Go.

Figure 3-1 Cisco Unified Serviceability

1. Enter your Username and Password; then click Login.

Figure 3-2 Login

1. Navigate to SNMP > V1/V2 > Community String.

The SNMP Community String Configuration window appears.

Figure 3-3 SNMP Community String Configuration

1. Select a Server* using the drop-down; then click Find.

A list of community strings appears in the Search Results area.

Figure 3-4 Search Results/Community Strings

Note

You can also use the Find Community Strings where Name field to search for existing community strings.

1. To add a new community string, click Add New.

A new SNMP Community String Configuration window appears.

Figure 3-5 SNMP Community String Configuration

1. Enter the community string configuration settings using the following descriptions.

Table 3-1 Community String Configuration Settings

Note

You can also edit an existing community string:

1. Select a community string listed in the Search Results area.

2. When the SNMP Community String Configuration window appears, make

changes to the Access Privileges.

1. Click Apply To All Nodes to apply to all servers in the cluster.

Figure 3-6 Apply To All Nodes/Save

1. Click Save to save the new community string (or updates to an existing community string), restart the SNMP master agent service, and apply the changes.

Configure Nectar User

Follow these steps to configure the Nectar User to be used when you onboard a Cisco Unity Connection cluster:

1. Access Cisco Unity Connection Administration using the drop-down; then click Go.

Figure 3-7 Cisco Unity Connection Administration

1. Enter your Username and Password; then click Login.

Figure 3-8 Login

1. In the Cisco Unity Connection pane, click Users > Users. The Users pane appears to the right.

1. Click Add New.

Figure 3-9 Users

The New User window appears.

Figure 3-10 New User

1. Enter the following User information:

Table 3-2 New User

1. Click Save.

The Edit User Basics window appears.

Figure 3-11 Edit User Basics

Notice the Status: Created User(s).

Add Roles

Follow these steps to add roles to the new user:

1. In the Edit User Basics window, navigate to Edit > Roles.

The Edit Roles window appears.

Figure 3-12 Edit > Roles

Figure 3-13 Edit Roles

1. If the System Administrator role appears in the Assigned Roles pane, then click the down arrow to remove this role from the Assigned Roles.
2. Select each of the following roles in the Available Roles pane; then click the up arrow to add as Assigned Roles:

Audit Administrator

Technician

1. Click Save.

Figure 3-14 Assigned Roles

The following Edit Roles window appears.

Notice the Status: Updated Role(s).

4. Configure Cisco Unity Connection VKM

Unity Connection supports a two-server active/active cluster to provide high availability and redundancy. If two servers are deployed, one is designated as a Publisher and the other is a Subscriber node.

Follow these steps to add a Cisco Unity Connection Cluster.

1. Navigate to Modules > Cisco > Unity.

Figure 4-1 Modules > Cisco > Unity

The Cisco Unity Setup window appears.

1. Click Add.

Figure 4-2 Cisco Unity Setup

The Add Cisco Unity - General window appears.

Figure 4-3 Add Cisco Unity - General

1. Enter the following information; then click Next.

Table 4-1 Add Cisco Unity

The Add Cisco Unity - SNMP window appears.

Figure 4-4 Add Cisco Unity - SNMP

1. Enter the following SNMP information; then click Next.

Table 4-2 Add Cisco Unity - SNMP

Table 4-2 Add Cisco Unity - SNMP

Note

For more information, see Configure SNMP.

The Add Cisco Unity - API window appears.

Figure 4-5 Add Cisco Unity - API

1. Enter the following API User information.

Table 4-3 Add Cisco Unity - API

1. Click Finish.

Table 4-3 Add Cisco Unity - API

Figure 4-6 Cisco Unity Connection Cluster

The new Unity Connection cluster is displayed on the Cisco Unity Setup window. The VKM collection processes and Nectar monitoring are also initiated. For more information, see View Collections.

Configure Alarms

Cisco Unity Connection cluster alarms provide information on runtime status and the state of the system. Unity Connection can be configured to send alarms to the Nectar RIG(s) via remote Syslog. The alarms send error conditions to the Unity Connection VKM.

Event level/severity settings provide a filtering mechanism for the alarms and messages that the system collects. The system forwards only alarms and messages that exceed the configured threshold.

This section explains how to:

Configure Cisco Unity Connection Alarms

Configure Cisco Syslog Agent Enterprise Parameters

Note

The Cisco Unity Connection system should be onboarded successfully before being configured to send alarms to the RIG.

For additional information on configuring Cisco Unity Connection alarms, see:

https://www.cisco.com/c/en/us/td/docs/voice_ip_comm/connection/12x/ serv_administration/b_12xcucservag/b_12xcucservag_chapter_01.html#ID-2383- 00000016

Configure Cisco Unity Connection Alarms

Follow these steps to enable Cisco Unity alarms and specify the severity level of the alarms that will be forwarded to the RIG (remote Syslog server).

1. Access Cisco Unity Connection Serviceability using the drop-down; then click Go.

Figure 5-1 Cisco Unified Serviceability

1. Enter your Username and Password; then click Login.

1. Navigate to Alarm > Configurations.

Figure 5-2 Login

The Alarm Configuration window appears.

Figure 5-3 Alarm Configuration

1. In the Select Server area, use the drop-down to select a server, if not already selected; then click Go.
2. Click the Enable Alarm check box, if not selected.

This enables the system to log the alarms in the Application Logs area of the Syslog Viewer.

1. In the Alarm Event Level field, use the drop-down to select the severity level that you want; in this case, WARNING.
2. Click Save.
3. Repeat Steps 3 through 7 for each server in the Select Server list.

Configure Cisco Syslog Agent Enterprise Parameters

Follow these steps to configure the CUCM to forward all alarms that meet or exceed the configured severity to the RIG (remote Syslog server):

1. Access Cisco Unity Connection Administration using the drop-down; then click Go.

Figure 5-4 Cisco Unity Connection Administration

1. Enter your Username and Password; then click Login.

Figure 5-5 Login

1. Navigate to System Settings > Enterprise Parameters.

The Enterprise Parameters window appears.

Figure 5-6 Enterprise Parameters

1. Scroll down to the Cisco Syslog Agent area.

Figure 5-7 Cisco Syslog Agent

1. Enter the following information:

1. Click Save.

Table 5-1 Parameters

Figure 5-8 Save

Note

By default, Local Syslogs is enabled, and the associated Alarm Event Level is

Error.

When you configure the Enterprise Remote Syslog Server(s) and set the Syslog Severity for Remote Syslog Messages to Warning, the RIG receives any Warning level or above alarms from all services.

6.Configure VKM Option

Follow these steps to configure this VKM option for the Cisco Unity:

1. Navigate to Modules > Cisco > Unity.

The Cisco Unity Setup - Configurations window appears.

1. Click the VKM Options tab.

The Cisco Unity Setup - VKM Options window appears with the following parameter:

Table 6-1 VKM Option

1. To change this value, right-click on the VKM option and select Edit. The Edit VKM Option window appears.

Figure 6-1 Edit VKM Option

1. Enter the new value; then click Update.

The new value appears for the parameter in the VKM Options list.

1. To change a value, right-click on the VKM option and select Edit. The Edit VKM Option window appears for that option/parameter.

Figure 6-2 Edit VKM Option

1. Enter the new value for the parameter; then click Update.

The new value appears for the parameter in the VKM Options list.

View Inventory

Follow these steps to view inventory data for a specific Unity Connection cluster or all clusters.

1. Navigate to Reports > Inventory > Cisco > Unity.

Figure 7-1 Reports > Inventory > Cisco > Unity

The Cisco Unity Inventory window appears.

Figure 7-2 Cisco Unity Inventory

1. Select an inventory category, such as Cluster Server.

The Listing pane appears to the right along with information about the cluster server(s) for the Unity Connection. In this example, there is a Publisher (Primary) cluster and a Subscriber (Secondary) cluster.

Figure 7-3 Example

1. Notice the Unity Connections drop-down.

You can click the drop-down to select a specific Unity Connection cluster when there are more than one onboarded clusters to filter the list.

Manage Unity Clusters

This section explains several tasks that can be used to manage the Unity clusters, including:

Edit a Cisco Unity Connection Cluster

Manage Collections

View Dependency Tree

Edit a Cisco Unity Connection Cluster

Follow these steps to edit a Unity Connection cluster, as needed:

1. Navigate to Modules > Cisco > Unity. The Cisco Unity Setup window appears.

Figure 8-1 Cisco Unity Setup

1. Select an existing Unity Connection cluster that you want to edit.
2. Click Edit.

The Edit Cisco Unity window appears.

Figure 8-2 Edit Cisco Unity

1. Click one of the following tabs:

General

SNMP

API

1. Edit the Unity Connection cluster, as needed.

Note

The Name of the cluster under the General tab cannot be edited.

1. Click OK.

The updated Unity Connection cluster is displayed on the Cisco Unity Setup window.

Remove or Offboard a Unity Connection Cluster

Follow these steps to remove or offboard a Unity Connection cluster, as needed:

1. Navigate to Modules > Cisco > Unity. The Cisco Unity Setup window appears.

Figure 8-3 Cisco Unity Setup

1. Select an existing Unity Connection cluster that you want to remove or offboard.
2. Click Remove.
3. When the following message appears, click Yes.

Figure 8-4 Remove

The Unity Connection cluster is removed and no longer listed on the Cisco Unity Setup

window.

Manage Collections

Managing collections includes the following tasks:

View Collections

Enable a Collection

Disable a Collection

Change a Collection Schedule

Execute a Collection

View Collections

Follow these steps to view a list of collections for the Cisco Unity Connection cluster:

1. Navigate to Modules > Cisco > Unity. The Cisco Unity Setup window appears.
2. Select the new Unity Connection cluster; then click View Collections.

Figure 8-5 View Collections

The Collections window appears.

Figure 8-6 Collections

1. Notice that the status of the Collection changes from Executing to Success.

When the status of all Collections shows Success, the cluster is onboarded and being monitored.

1. Right-click on a collection and select one of the following:

Figure 8-7 Collections

1. For more information, see:

Enable a Collection

Disable a Collection

Change a Collection Schedule

Execute a Collection

Enable a Collection

Follow these steps to enable a collection for a particular Unity Connection cluster:

1. Select a collection you want to enable.
2. Right-click and select Enable.

The Enabled column for the collection changes to Yes.

Disable a Collection

Follow these steps to disable a collection for a particular Unity Connection cluster:

1. Select a collection you want to disable.
2. Right-click and select Disable.

The Enabled column for the collection changes to No.

Change a Collection Schedule

Follow these steps to change the collection schedule for a particular Unity Connection cluster:

1. Select a collection you want to change.
2. Right-click and select Change Cron String.

The Update Cron String window appears.

Figure 8-8 Update Cron String

1. Enter the new collection schedule using a Cron expression.
2. Click OK.

The updated collection schedule appears in the Cron column.

Execute a Collection

Follow these steps to execute a collection:

1. Select a collection you want to execute.
2. Right-click and select Execute Now.

The collection executes. The Status column changes to Executing; then changes to Success

when completed.

View Dependency Tree

Follow these steps to view the dependency tree for an event:

1. Navigate to Health > Events.
2. Filter on Cisco Unity.
3. Select the Cisco Unity event.
4. Right-click and select Goto Dependency. The View Dependency window appears.

Figure 8-9 View Dependency

The Cisco Unity Agent is now being monitored.

You can incorporate the Dependency Tree element into your Dashboard. You can also set or modify thresholds on any of the pollers within the Cisco Unity Agent.