Working with Voice Application Systems and Software
The following topics describe hardware-specific and version-specific tasks and behavior:
•Configuring Voice Application Systems and Software for Use with Operations Manager
•Changing the Cisco Unified Communications Manager Cluster Name
•Configuring CDR Forwarding on Cisco Unified Communications Managers
•Setting a Media Server's SNMP Services Community String Rights
•Configuring Syslog Receiver on Cisco Unified Communications Manager
•Configuring Syslog Receiver on Cisco Unity Connection
•Configuring the Event Monitoring Service
•Configuring RTMT on Cisco Unified Communications Manager
•Setting HTTP Credentials on Cisco Unified Communications Manager
•Activating Events in Operations Manager
•Verifying Unified Communications Manager DNS Settings
Note See Cisco Unified Communications Manager Compatibility Matrix on Cisco.com for complete up-to-date information about Cisco Unified Communications Manager versions and support.
Configuring Voice Application Systems and Software for Use with Operations Manager
Table F-1 lists tasks that you must perform before Cisco Unified Operations Manager (Operations Manager) can successfully monitor Cisco voice application software.
Changing the Cisco Unified Communications Manager Cluster Name
Note You must use this procedure only if you are running a media server with Cisco Unified Communications Manager 3.3 or later.
Operations Manager cannot manage two clusters with the same name. If you are managing multiple Cisco Unified Communications Manager clusters, you must change the default cluster name. Cisco Unified Communications Manager starting with 3.3 use the default cluster name StandAloneCluster.
For detailed instructions on configuring Cisco Unified Communications Manager, see the Cisco Unified Communications Manager documentation.
Step 1 To change the Cisco Unified Communications Manager cluster name:Open the Cisco Unified Communications Manager Administration page.
Step 2 From the menu bar, select System, and choose Enterprise Parameters.
The Enterprise Configuration page appears.
Step 3 In the Cluster ID field, enter a new cluster name.
Step 4 Click Update.
Configuring CDR Forwarding on Cisco Unified Communications Managers
You can monitor Call Detail Record (CDR) trunk utilization on your Unified CMs using Operations Manager.
You must add Service Monitor as a UC management application monitored by Operations Manager. For details, see Accessing a Service Monitor Server, page 20-2.
You must also enable polling in Operations Manager. For details, see Editing Polling Parameters, page 18-14.
To monitor CDR-based trunk data using Operations Manager and Service Monitor:
Step 1 On the Unified Communications Manager, select Administration.
Step 2 Go to the Service Parameters Configuration page by selecting System > Service Parameters.
Step 3 Set parameters for:
•CDR Enabled Flag by scrolling down to System and selecting True.
•Call Diagnostics Enabled by scrolling down to Cluster wide Parameters (Device - General) and selecting Set to Enable Only When CDR Enabled Flag is True.
Step 4 To add Operations Manager as a Billing Server in the Cisco Unified CM:
a. Select Tools > CDR Management.
b. Scroll down to Billing Applications Server Parameters and click Add New.
c. Enter the following
–Host Name/IP Address—IP address of the system where Operations Manager is installed.
–User Name—Enter smuser'
–Password—Default password is smuser
d. Select the SFTP Protocol.
e. Directory path—Enter /home/smuser
f. Select the Resend on failure check box.
Step 5 Click Add.
Setting a Media Server's SNMP Services Community String Rights
Note Use this procedure on media servers running voice application software. Operations Manager installation ensures that the SNMP service is installed and enabled on that server.
Operations Manager cannot monitor supported voice applications running on a media server if community string rights for SNMP services are set to none. The SNMP queries will not succeed unless the rights for the community string are changed to read-only, read-write, or read-create.
Step 1 On the media server system, select Start > Settings > Control Panel > Administrative Tools > Services.
The Services window opens.
Step 2 Double-click SNMP Service.
The SNMP Services Properties window opens.
Step 3 Select the Security tab.
Step 4 Select Community String and click Edit.
Step 5 Change the rights from NONE to READ ONLY.
Operations Manager requires read-only rights. You are not required to set the rights to read-write or read-create.
Configuring Syslog Receiver on Cisco Unified Communications Manager
To successfully receive Cisco Unified Communications Manager syslog messages, you must add the syslog receiver from the device's serviceability web page. Use the following procedure to perform the necessary steps.
Syslog processing detects the following registered entities on the Unified CM cluster:
•Any registration changes on phones, voice mail endpoints, gateways, and so on.
•Any new phones provisioned in the cluster.
New phones provisioned are discovered if they are provisioned to an existing device pool. If the phone is part of a new device pool added to the cluster after the last cluster device discovery, you must use Run Now to view these phones in Operations Manager.
For additional details on what syslog events map to Unified Communications Manager releases, see Table E-2.
To configure syslog receiver on Cisco Unified Communications Manager:
Step 1 On your Cisco Unified Communications Manager, select Cisco Unified Serviceability from the Navigation drop-down in the top-right corner of the device's home screen.
Step 2 Select Alarm > Configuration.
Do not use the CCM enterprise service parameter to configure the syslog receiver for Operations Manager syslog integration. When the enterprise parameter is enabled, all syslog messages (with matching severity levels) are sent regardless of whether or not they are intended to be processed by Operations Manager.
Step 3 Select the correct alarm configuration elements for your particular machine and click Go:
For This Unified Communications Manager Version...
Select These Alarm Configuration Elements...
•Server > Service > Cisco AMC Service
•Server > Service > Cisco CDR Agent
•Server > Service > Cisco CDR Repository Manager
•Server > Service > Cisco CallManager
•Server > Service > Cisco Database Layer Monitoring
•Server > Service > Cisco DRF Client
•Server > Service > Cisco DRF Master
6.x and later
•Service Group > CM Services > Service > Cisco CallManager
•Service Group > CDR Service > Cisco CDR Agent and Cisco CDR Repository Manager
•Service Group > Database and Admin Services > Cisco Database Layer Monitoring
•Service Group > Performance and Monitoring Services > Cisco AMC Service
•Service Group > Backup and Restore > Cisco DRF Client and Cisco DRF Master
Step 4 Click on the Enable Alarm check box, select proper Alarm Event Level
See the Alarm Configuration Settings in Cisco Unified Serviceability Administration Guide for Cisco Unified Communications Manager on Cisco.com.
Step 5 Enter Operations Manager server name/address in Server Name text box.
Step 6 Set the alarm event level to Error.
Step 7 Enter any necessary information based on your Unified Communications Manager. For device cluster discovery, set the alarm event level to Informational.
Check Apply to all nodes. (See Figure F-1 for an example of a serviceability page. The serviceability web page may differ depending on the device version you are configuring.
Figure F-1 Cisco Unified Serviceability Page for Version 6.0
Step 8 Click Save.
Syslog messages have a limitation of 1,024 characters (including the heading). Any syslog-based event details may not contain the full information due this syslog limitation. If the syslog message exceeds this limit, it is truncated to 1,024 characters by the syslog sender.
Configuring Syslog Receiver on Cisco Unity Connection
To successfully receive Cisco Unity Connection syslog messages, you must add the syslog receiver from the device's serviceability web page.
To configure syslog receiver on Cisco Unity Connection:
Step 1 On your Cisco Unity Connection, select Cisco Unity Connection Serviceability from the Navigation drop-down in the top-right corner of the device's home screen.
Step 2 Select Alarm > Configurations.
Step 3 Select the correct alarm configuration elements for your particular machine:
•For Unity Connection 8.x:
–Enable Informational Alarms for Local syslogs.
–Enable Informational Alarms Remote Syslogs and enter the Server name as CUOM Server IP address.
Step 4 Save the configuration to complete syslog configuration.
Configuring the Event Monitoring Service
The Event Monitoring Service (EMS) should already be installed along with the Remote Serviceability Kit.
Configure the Event Monitoring Service to support these events in Operations Manager:
•OutOfDiskSpace—Event Source: ESE, Event ID: 482.
•HardDiskError—Event Source: Cissesrv, Event ID: 24600.
•ExchangeLoginFailed—Event Source: CiscoUnity_Doh, Event ID: 32013.
For details on these events, see Supported Events, page E-3.
To configure the Event Monitoring Service:
Step 1 Open the Tools Depot on the Desktop and navigate to Diagnostic Tools > Event Monitoring Service.
Step 2 Double-click to run.
Step 3 Create a recipient to receive notifications by selecting File > New > Recipient or, select the Recipients node in the navigation tree and click Create New Recipient.
Step 4 Enter a Recipient Name to identify a single recipient (or a group as there can be multiple email addresses under SMTP).
Step 5 Select the desired notification method tabs.
•The SNMP trap tabs works with the Remote Serviceability Kit to send traps to a destination (defined under windows SNMP service properties).
•The Syslog tab allows entry of a Syslog server address for the event.
•The failover tab is not a notification, but can force a failover upon receipt of a specified event.
The Test button at the top of the page sends a test event to the defined recipients. These can be:
•Event Source: EMSTest
•Description: Event Monitoring Service Test Message
Step 6 Create a monitored event by selecting File > New> Event, or, select the Monitored Events node in the navigation tree and click Create New Event.
If the event exists currently in the Windows Event Viewer, to populate the event information in the Add New Event dialog:
•Select the event in Windows Event Viewer.
•Select Copy Event to Clipboard.
•Use Import Event From Clipboard in the Add New Event dialog.
Step 7 To manually add the event:
•Event Source from the pulldown menu
•Select a specific Event ID and enter the desired ID. All Event Ids could also be used to obtain all events from a specified event source.
•Select Type to filter what level notifications should be sent for.
•Select Errors, Warnings, and Informational for all level events or if the Type is unknown.
•Enter Notes that will be included with the notification, such as troubleshooting steps.
The content section allows you to record a custom WAV for the event used along with the Recipient Voicemail option.
The Email Subject and Body can be used to customize the formatting of the messages sent to Recipient Email and SMTP notification methods. If no customization is desired, leave default fields as is.
Step 8 Select OK after adding the new event.
Step 9 To activate the new event, one or more Recipients need to be added to it. Select the newly added event and click on the Add Recipients icon. The Recipients and notification methods can be further defined with check boxes here.
Step 10 Check the Active check box and Apply to activate the event. You may also perform this step from the Monitored Events node in the navigation tree.
You can also exclude or ignore events that pass the other criteria by selecting File > New > Exclusion, or, select the Exclusions node in the navigation tree and click Create New Exclusion.
If the event exists currently in the Windows Event Viewer, you can populate the event information in the Add Exclusion dialog by selecting the event in Windows Event Viewer and clicking Copy Event to Clipboard. Then use Import Event From Clipboard in the Add Exclusion dialog.
Step 11 To manually exclude the event:
a. Select the event Source from the pulldown.
b. Select Specific Event Id and enter the desired ID. All Event Ids could also be used to obtain all events from a specified event Source.
c. Select OK when finished adding the new exclusion.
Configuring RTMT on Cisco Unified Communications Manager
Operations Manager uses the same polling rate and threshold settings as RTMT. In normal operation, you do not need to do anything. The defaults will work properly.
Note This impacts Unified Communications Manager performance and Operations Manager.
If you want to have a lower polling rate, increase the polling rate to monitor in real-time, and then update the parameter settings on Cisco Unified Communications Manager, do the following:
•To update the polling and threshold parameter settings, go to the Unified Communications Manager Administration page.
•To change polling rates for CallManager 6.x and later, select System > Service Parameter > publisher > Cisco AMC Service, then change the Data Collection Polling rate value.
•To change threshold parameters, install and launch RTMT, select AlarmCentral, then select a specific alert and right-click to launch Alert Property.
Setting HTTP Credentials on Cisco Unified Communications Manager
Operations Manager uses the AVVID XML Layer (AXL) API in addition to SNMP to manage Cisco Communications Manager. This means that Operations Manager makes SOAP calls over HTTP via the AXL interface to collect fault and performance information from Cisco Unified Communications Manager. Operations Manager requires the HTTP username and password in order to execute these queries.
The username and password do not need to have administrator privileges. You only need credentials with read-level access to http://server-name/ccmadmin.
Activating Events in Operations Manager
Most device events will display in the user interface after the device has been added to the Operations Manager database. However, several events will not be displayed in Operations Manager out of the box. You must activate the following events in order for Operations Manager to display them.
•Number Of Registered Gateways Increased
•Number Of Registered Gateways Decreased
•Number Of Registered MediaDevices Increased
•Number Of Registered MediaDevices Decreased
These events are raised at the cluster level, therefore individual device information may not be available in the event description.
To access individual device information use the RTMT Tool. Select Filter > Devices > MediaDevices or Gateway, then select the check box for all states and generate the report. This report will point out all the registered and unregistered media devices or gateways.
To activate these event pairs:
Step 1 Open the NMSROOT\conf\seg\sysLogConfig.xml file.
Step 2 Remove the comment for Syslog by removing the lines marked.
Step 3 Restart the SEGServer process.
Verifying Unified Communications Manager DNS Settings
Operations Manager is unable to collect the correct monitoring information if it cannot use domain name service (DNS) to resolve the Unified CM name.
Verify the Unified CM can be resolved (both forward and backward).
Note the following about DNS:
•If the Unified CM is configured with the IP address only, the DNS setting is not a problem.
•If the Unified CM is configured with a DNS name, then it can be resolved from the Unified CM Server.
•The Unified CM should also be configured to send syslogs to Operations Manager server. For detailed steps, see Configuring Syslog Receiver on Cisco Unified Communications Manager.