Cisco Unified Serviceability Administration Guide, Release 9.0(1)
Cisco Unified CM Tools
Downloads: This chapterpdf (PDF - 1.68MB) The complete bookPDF (PDF - 4.6MB) | Feedback

Cisco Unified CM Tools

Contents

Cisco Unified CM Tools

Services

This section provides a description of services/servlets, Service Activation, and Control Center.

Cisco Unified Serviceability service management includes working with feature and network services and servlets, which are associated with the Tomcat Java Webserver. Feature services allow you to use application features, such as Serviceability Reports Archive, while network services are required for your system to function.

If something is wrong with a service or servlet, an alarm gets written to an alarm monitor. After viewing the alarm information, you can run a trace on the service. Be aware that services and servlets display different trace levels in the Trace Configuration window.

Feature services

In Cisco Unified Serviceability, you can activate, start, and stop feature services. Activation turns on and starts the service. After you activate a service in the Service Activation window, you do not need to start it in the Control Center - Feature Services window. If the service does not start for any reason, you must start it in the Control Center - Features Services window.

After the system is installed, it does not automatically activate feature services, which are related services that are required if you want to use your configuration features; for example, the Serviceability Reports Archive feature.

Unified CM and Unified CM BE only: After you activate feature services, you can modify associated service parameters in Cisco Unified Communications Manager Administration.

Connection only: After you activate feature services, you can modify associated settings in Cisco Unity Connection Administration.

Unified CM only: If you are upgrading Cisco Unified Communications Manager, those services that you activated on the system prior to the upgrade automatically activate and start after the upgrade.

In the Service Activation window, Cisco Unified Serviceability categorizes feature services into the following groups:

In the Control Center - Feature Services window, Cisco Unified Serviceability categorizes services into the same groups that display in the Service Activation window.


Tip


For service activation recommendations, see the Service activation and the Activate feature services.


Database and admin services

This section describes the Database and Admin Services.

Locations Bandwidth Manager

A service that assembles a network model from configured Location and Link data in one or more clusters, determines the Effective Paths between pairs of Locations, determines whether to admit calls between a pair of Locations based on the availability of bandwidth for each type of call, and deducts (reserves) bandwidth for the duration of each call that is admitted.

Cisco AXL Web Service

The Cisco AXL Web Service allows you to modify database entries and execute stored procedures from client-based applications that use AXL.

In a Cisco Unified Communications Manager Business Edition 5000 system, this service supports both Cisco Unified Communications Manager and Cisco Unity Connection.

Cisco UXL Web Service

The TabSync client in Cisco IP Phone Address Book Synchronizer uses the Cisco UXL Web Service for queries to the Cisco Unified Communications Manager database, which ensures that Cisco IP Phone Address Book Synchronizer users have access only to end-user data that pertains to them. The Cisco UXL Web Service performs the following functions:

  • Conducts authentication checks by verifying the end user name and password when an end user logs in to Cisco IP Phone Address Book Synchronizer.
  • Conducts a user authorization check by only allowing the user that is currently logged in to Cisco IP Phone Address Book Synchronizer to perform functions such as listing, retrieving, updating, removing, and adding contacts.

Cisco Bulk Provisioning Service

This service does not support Cisco Unity Connection.

If your configuration supports clusters ( Cisco Unified Communications Manager only), you can activate the Cisco Bulk Provisioning Service only on the first server. If you use the Cisco Unified Communications Manager Bulk Administration Tool (BAT) to administer phones and users, you must activate this service.

In a Cisco Unified Communications Manager Business Edition 5000 system, this service supports Cisco Unified Communications Manager only.

Cisco TAPS Service

This service does not support Cisco Unity Connection.

The Cisco TAPS Service supports the Cisco Unified Communications Manager Auto-Register Phone Tool, which allows a user to upload a customized configuration on an auto registered phone after a user responds to Interactive Voice Response (IVR) prompts.

If your configuration supports clusters ( Cisco Unified Communications Manager only), you activate this service on the first server. When you want to create dummy MAC addresses for the tool, ensure that the Cisco Bulk Provisioning Service is activated on the same server.


Tip


The Cisco Unified Communications Manager Auto-Register Phone Tool relies on Cisco Customer Response Solutions (CRS). Before the tool can work as designed, verify that the CRS server is configured and running, as described in the CRS documentation.


In a Cisco Unified Communications Manager Business Edition 5000 system, this service supports Cisco Unified Communications Manager only.

Performance and monitoring services

This section describes the Performance Monitoring Services.

Cisco Serviceability Reporter

The Cisco Serviceability Reporter service generates the daily reports that are described in Serviceability Reports Archive.

If your configuration supports clusters ( Cisco Unified Communications Manager only), this service gets installed on all the Cisco Unified Communications Manager servers in the cluster. Reporter generates reports once a day based on logged information. You can access the reports that Reporter generates in Cisco Unified Serviceability from the Tools menu. Each summary report comprises different charts that display the statistics for that particular report. After you activate the service, report generation may take up to 24 hours.

In a Cisco Unified Communications Manager Business Edition 5000 system, this service supports Cisco Unified Communications Manager and Cisco Unity Connection.

Cisco CallManager SNMP Service

This service does not support Cisco Unity Connection.

This service, which implements the CISCO-CCM-MIB, provides SNMP access to provisioning and statistics information that is available for Cisco Unified Communications Manager.

If your configuration supports clusters ( Cisco Unified Communications Manager only), activate this service on all servers in the cluster.

In a Cisco Unified Communications Manager Business Edition 5000 system, this service supports Cisco Unified Communications Manager.

CM services

This section describes the CM Services and does not apply to Cisco Unity Connection.

Cisco CallManager

The Cisco CallManager service provides software-only call processing as well as signaling and call control functionality for Cisco Unified Communications Manager.


Tip


Unified CM clusters only: Before you activate this service, verify that the Cisco Unified Communications Manager server displays in the Find and List Cisco Unified CMs window in Cisco Unified Communications Manager Administration. If the server does not display, add the Cisco Unified Communications Manager server before you activate this service. For information on how to find and add the server, refer to the Cisco Unified Communications Manager Administration Guide.

Unified CM clusters only: If you deactivate the Cisco CallManager or CTIManager services in Service Activation, the Cisco Unified Communications Manager server where you deactivated the service no longer exists in the database, which means that you cannot choose that Cisco Unified Communications Manager server for configuration operations in Cisco Unified Communications Manager Administration because it does not display in the graphical user interface (GUI). If you then reactivate the services on the same Cisco Unified Communications Manager server, the database creates an entry for Cisco Unified Communications Manager again and adds a "CM_" prefix to the server name or IP address; for example, if you reactivate the Cisco CallManager or CTIManager service on a server with an IP address of 172.19.140.180, then CM_172.19.140.180 displays in Cisco Unified Communications Manager Administration. You can now choose the server, with the new "CM_" prefix, in Cisco Unified Communications Manager Administration.


The following services rely on Cisco CallManager service activation:

In a Cisco Unified Communications Manager Business Edition 5000 system, this service supports Cisco Unified Communications Manager only.

Cisco TFTP

Cisco Trivial File Transfer Protocol (TFTP) builds and serves files that are consistent with the trivial file transfer protocol, a simplified version of FTP. Cisco TFTP serves embedded component executable, ringer files, and device configuration files.

Unified CM only: A configuration file includes a list of Cisco Unified Communications Managers to which devices (telephones and gateways) make connections. When a device boots, the component queries a Dynamic Host Configuration Protocol (DHCP) server for its network configuration information. The DHCP server responds with an IP address for the device, a subnet mask, a default gateway, a Domain Name System (DNS) server address, and a TFTP server name or address. The device requests a configuration file from the TFTP server. The configuration file contains a list of Cisco Unified Communications Managers and the TCP port through which the device connects to those Cisco Unified Communications Managers. The configuration file contains a list of Cisco Unified Communications Managers and the TCP port through which the device connects to those Cisco Unified Communications Managers.

In a Cisco Unified Communications Manager Business Edition 5000 system, this service supports Cisco Unified Communications Manager only.

Cisco Messaging Interface

The Cisco Messaging Interface allows you to connect a simplified message desk interface (SMDI)-compliant external voice-messaging system with the Cisco Unified Communications Manager. The SMDI defines a way for a phone system to provide a voice-messaging system with the information that is needed to intelligently process incoming calls.

In a Cisco Unified Communications Manager Business Edition 5000 system, this service supports Cisco Unified Communications Manager only.

Cisco Unified Mobile Voice Access Service

The Cisco Unified Voice Access Service starts the mobile voice access capability within Cisco Unified Mobility; mobile voice access, which is an integrated voice response (IVR) system, allows Cisco Unified Mobility users to perform the following tasks:

  • Make calls from the cellular phone as if the call originated from the desk phone.
  • Turn Cisco Unified Mobility on.
  • Turn Cisco Unified Mobility off.

In a Cisco Unified Communications Manager Business Edition 5000 system, this service supports Cisco Unified Communications Manager only.

Cisco IP Voice Media Streaming App

The Cisco IP Voice Media Streaming Application service provides voice media streaming functionality for Cisco Unified Communications Manager for use with MTP, conferencing, music on hold (MOH), and annunciator. The Cisco IP Voice Media Streaming Application relays messages from Cisco Unified Communications Manager to the IP voice media streaming driver, which handles RTP streaming.

The Cisco IP Voice Media Streaming Application service does not generates the Call Management Record (CMR) files for call legs that involve any IP Voice Media Streaming App components like conference, MOH, Annunciator or MTP.

In a Cisco Unified Communications Manager Business Edition 5000 system, this service supports Cisco Unified Communications Manager only.

Cisco CTIManager

The Cisco CTI Manager contains the CTI components that interface with applications. This service allows applications to monitor/control phones and virtual devices to perform call control functionality.

Unified CM clusters only: With CTI Manager, applications can access resources and functionality of all Cisco Unified Communications Managers in the cluster and have improved failover capability. Although one or more CTI Managers can be active in a cluster, only one CTI Manager can exist on an individual server. An application (JTAPI/TAPI) can have simultaneous connections to multiple CTI Managers; however, an application can only use one connection at a time to open a device with media termination.

In a Cisco Unified Communications Manager Business Edition 5000 system, this service supports Cisco Unified Communications Manager only.

Cisco Extension Mobility

This service, which supports the Cisco Extension Mobility feature, performs the login and automatic logout functionality for the feature.

In a Cisco Unified Communications Manager Business Edition 5000 system, this service supports Cisco Unified Communications Manager.

Cisco Dialed Number Analyzer

The Cisco Dialed Number Analyzer service supports Cisco Unified Communications Manager Dialed Number Analyzer. When activated, this application consumes a lot of resources, so activate this service only during off-peak hours when minimal call-processing interruptions may occur.

Unified CM clusters only: Cisco does not recommend that you activate the service on all the servers in a cluster. Cisco recommends that you activate this service only on one of the servers of a cluster where call-processing activity is the least.

In a Cisco Unified Communications Manager Business Edition 5000 system, this service supports Cisco Unified Communications Manager only.

Cisco Dialed Number Analyzer Server

The Cisco Dialed Number Analyzer Server service along with The Cisco Dialed Number Analyzer service supports Cisco Unified Communications Manager Dialed Number Analyzer. This service needs to be activated only on the node that is dedicated specifically for the Cisco Dialed Number Analyzer service.

Unified CM clusters only: Cisco does not recommend that you activate the service on all the servers in a cluster. Cisco recommends that you activate this service only on one of the servers of a cluster where call-processing activity is the least.

In a Cisco Unified Communications Manager Business Edition system, this service supports Cisco Unified Communications Manager only.

Cisco DHCP Monitor Service

Cisco DHCP Monitor Service monitors IP address changes for IP phones in the database tables. When a change is detected, it modifies the /etc./dhcpd.conf file and restarts the DHCPD daemon.

In a Cisco Unified Communications Manager Business Edition 5000 system, this service supports Cisco Unified Communications Manager only.

Cisco Intercluster Lookup Service

The Intercluster Lookup Service (ILS) runs on a cluster-wide basis. ILS allows you to create networks of remote Cisco Unified Communications Manager clusters. The ILS cluster discovery feature allows Cisco Unified Communications Manager to connect to remote clusters without the need for an administrator having to manually configure connections between each cluster. The ILS URI Replication feature enables clusters in the ILS network with the ability to exchange directory URI catalogs with the other clusters in an ILS network. URI Replication provides support for intercluster URI dialing.

ILS can be activated from the ILS Configuration window that can be accessed in Cisco Unified CM Administration by selecting Advanced Features > ILS Configuration.

In a Cisco Unified Communications Manager Business Edition 5000 system, this service supports Cisco Unified Communications Manager only.

CTI services

This section describes the CTI Services and does not apply to Cisco Unity Connection.

Cisco IP Manager Assistant

This service supports Cisco Unified Communications Manager Assistant. After service activation, Cisco Unified Communications Manager Assistant enables managers and their assistants to work together more effectively. Cisco Unified Communications Manager Assistant supports two modes of operation: proxy line support and shared line support.

The feature comprises a call-routing service, enhancements to phone capabilities for the manager, and desktop interfaces that are primarily used by the assistant.

The service intercepts calls that are made to managers and routes them to selected assistants, to managers, or to other targets on the basis of preconfigured call filters. The manager can change the call routing dynamically; for example, by pressing a softkey on the phone, the manager can instruct the service to route all calls to the assistant and can receive status on these calls.

Cisco Unified Communications Manager users comprise managers and assistants. The routing service intercepts manager calls and routes them appropriately. An assistant user handles calls on behalf of a manager.

In a Cisco Unified Communications Manager Business Edition 5000 system, this service supports Cisco Unified Communications Manager only.

Cisco WebDialer Web Service for Cisco Unified Communications Manager Systems

Cisco Web Dialer provides click-to-dial functionality. It allows users inside a Cisco Unified Communications Manager cluster to initiate a call to other users inside or outside the cluster by using a web page or a desktop application. Cisco Web Dialer provides a web page that enables users to call each other within a cluster. Cisco Web Dialer comprises two components: Web Dialer servlet and Redirector servlet.

The Redirector servlet provides the ability for third-party applications to use Cisco Web Dialer. The Redirector servlet finds the appropriate Cisco Unified Communications Manager cluster for the Cisco Web Dialer user and redirects the request to the Cisco Web Dialer in that cluster. The Redirector functionality only applies for HTTP/HTML-based Web Dialer client applications because it is not available for Simple Object Access Protocol (SOAP)-based Web Dialer applications.

Cisco WebDialer Web Service for Cisco Unified Communications Manager Business Edition 5000 Systems

Cisco Web Dialer, which is used in conjunction with Cisco Unified Communications Manager, allows Cisco Unified IP Phone users to make calls from web and desktop applications. For example, Cisco Web Dialer uses hyperlinked telephone numbers in a company directory to allow users to make calls from a web page by clicking on the telephone number of the person that they are trying to call.

This service supports Cisco Unified Communications Manager.

CDR services

This section describes the CDR Services and does not apply to Cisco Unity Connection.

Cisco SOAP - CDRonDemand Service

The Cisco SOAP - CDRonDemand Service, a SOAP/HTTPS-based service, runs on the CDR Repository server.It receives SOAP requests for CDR file name lists that are based on a user-specified time interval (up to a maximum of 1 hour) and returns a list of file names that fit the time duration that is specified in the request. This service also receives requests for delivery of a specific CDR/CMR file with the file name and the transfer method (SFTP/FTP, server name, login info, directory) that is specified in the request.

If you are using a third-party billing application that accesses CDR data via an HTTPS/SOAP interface, activate this service.

CAR Web Service

The Cisco CAR Web Service loads the user interface for CAR, a web-based reporting application that generates either CSV or PDF reports by using CDR data.

Security services

This section describes the Security Services and does not apply to Cisco Unity Connection.

Cisco CTL Provider

Unified CM only: The Cisco CTL Provider service, which runs with local system account privileges, works with the Cisco CTL Provider Utility, a client-side plug-in, to change the security mode for the cluster from nonsecure to mixed mode. When you install the plug-in, the Cisco CTL Provider service retrieves a list of all Cisco Unified Communications Manager and Cisco TFTP servers in the cluster for the CTL file, which contains a list of security tokens and servers in the cluster. You must install and configure the Cisco CTL Client and activate this service for the clusterwide security mode to change from nonsecure to secure.

Unified CM BE only: The Cisco CTL Provider service, which runs with local system account privileges, works with the Cisco CTL Provider Utility, a client-side plug-in, to change the clusterwide security mode for the server from nonsecure to mixed mode. You must install and configure the Cisco CTL Client and activate this service for the security mode to change from nonsecure to secure.

After you activate the service, the Cisco CTL Provider service reverts to the default CTL port, which is 2444. If you want to change the port, refer to the Cisco Unified Communications Manager Security Guide for more information.

In a Cisco Unified Communications Manager Business Edition 5000 system, this service supports Cisco Unified Communications Manager only.

Cisco Certificate Authority Proxy Function (CAPF)

Working in conjunction with the CAPF application, the Cisco Certificate Authority Proxy Function (CAPF) service can perform the following tasks, depending on your configuration:

  • Issue locally significant certificates to supported Cisco Unified IP Phone models.
  • Using SCEP, request certificates from third-party certificate authorities on behalf of supported Cisco Unified IP Phone models.
  • Upgrade existing certificates on the phones.
  • Retrieve phone certificates for troubleshooting.
  • Delete locally significant certificates on the phone.

Note


Unified CM only: When you view real-time information in RTMT, the Cisco Certificate Authority Proxy Function (CAPF) service displays only for the first server.


In a Cisco Unified Communications Manager Business Edition 5000 system, this service supports Cisco Unified Communications Manager.

Directory services

This section describes the Directory Services.

Cisco DirSync

Cisco Unified Communications Manager Business Edition 5000: This service displays in Cisco Unified Serviceability, but the system does not save the configuration for the activation; after you attempt to activate the service, a message displays in the Service Activation window to tell you that you cannot activate this service for Cisco Unified Communications Manager Business Edition 5000.

Unified CM: The Cisco DirSync service ensures that the Cisco Unified Communications Manager database stores all user information. If you use an integrated corporate directory, for example, Microsoft Active Directory or Netscape/iPlanet Directory, with Cisco Unified Communications Manager, the Cisco DirSync service migrates the user data to the Cisco Unified Communications Manager database. The Cisco DirSync service does not synchronize the passwords from the corporate directory.

Cisco Unity Connection: When Connection is integrated with an LDAP directory, the Cisco DirSync service synchronizes a small subset of user data (first name, last name, alias, phone number, and so on) in the Cisco Unified CM database on the Connection server with the corresponding data in the LDAP directory. Another service (CuCmDbEventListener) synchronizes data in the Connection user database with data in the Cisco Unified CM database. When a Connection cluster is configured, the Cisco DirSync service runs only on the publisher server.

Voice quality reporter services

This section describes the Voice Quality Reporter Services and does not apply to Cisco Unity Connection.

Cisco Extended Functions

The Cisco Extended Functions service provides support for Cisco Unified Communications Manager voice-quality features, including Quality Report Tool (QRT). For more information about individual features, refer to the Cisco Unified Communications Manager System Guide and the Cisco Unified IP Phone Administration Guide for Cisco Unified Communications Manager.

In a Cisco Unified Communications Manager Business Edition 5000 system, this service supports Cisco Unified Communications Manager only.

Network services

Installed automatically, network services include services that the system requires to function; for example, database and platform services. Because these services are required for basic functionality, you cannot activate them in the Service Activation window. If necessary, for example, for troubleshooting purposes, you may need to stop and start (or restart) a network service in the Call Control - Network Services window.

After the installation of your application, network services start automatically, as noted in the Call Control - Network Services window. In the Control Center - Network Services window, Cisco Unified Serviceability categorizes services into the following groups:

Performance and monitoring services

This section describes the Performance and Monitoring Services.

Cisco CallManager Serviceability RTMT

The Cisco CallManager Serviceability RTMT servlet supports the Cisco Unified Real-Time Monitoring Tool (RTMT), which allows you to collect and view traces, view performance monitoring objects, work with alerts, and monitor devices, system performance, CTI applications, and so on.

In a Cisco Unified Communications Manager Business Edition 5000 system, this service supports both Cisco Unified Communications Manager and Cisco Unity Connection.

Cisco RTMT Reporter Servlet

The Cisco RTMT Reporter servlet allows you to publish reports for RTMT.

In a Cisco Unified Communications Manager Business Edition 5000 system, this service supports both Cisco Unified Communications Manager and Cisco Unity Connection.

Cisco Log Partition Monitoring Tool

The Cisco Log Partition Monitoring Tool service supports the Log Partition Monitoring feature, which monitors the disk usage of the log partition on a server (or all servers in the cluster) by using configured thresholds and a polling interval.

In a Cisco Unified Communications Manager Business Edition 5000 system, this service supports both Cisco Unified Communications Manager and Cisco Unity Connection.

Cisco Tomcat Stats Servlet

The Cisco Tomcat Stats Servlet allows you to monitor the Tomcat perfmon counters by using RTMT or the Command Line Interface. Do not stop this service unless you suspect that this service is using too many resources, such as CPU time.

In a Cisco Unified Communications Manager Business Edition 5000 system, this service supports both Cisco Unified Communications Manager and Cisco Unity Connection.

Cisco RIS Data Collector

The Real-time Information Server (RIS) maintains real-time information such as device registration status, performance counter statistics, critical alarms generated, and so on. The Cisco RIS Data Collector service provides an interface for applications, such as the Cisco Unified Real-Time Monitoring Tool (RTMT), SOAP applications, and so on, to retrieve the information that is stored in the RIS server (or in all RIS servers in the cluster).

In a Cisco Unified Communications Manager Business Edition 5000 system, this service supports both Cisco Unified Communications Manager and Cisco Unity Connection.

Cisco AMC Service

Used for the Cisco Unified Communications Manager Cisco Unified Real-Time Monitoring Tool (RTMT), this service, Alert Manager and Collector service, allows RTMT to retrieve real-time information that exists on the server (or on all servers in the cluster).

In a Cisco Unified Communications Manager Business Edition 5000 system, this service supports both Cisco Unified Communications Manager and Cisco Unity Connection.

Cisco Audit Event Service

The Cisco Audit Event Service monitors and logs any configuration change to the Cisco Unified Communications Manager system by a user or as a result of the user action.

In a Cisco Unified Communications Manager Business Edition 5000 system, this service supports both Cisco Unified Communications Manager and Cisco Unity Connection.

Cisco RisBean Library

Cisco RisBean Library comprises a library that some webapps use to communicate with other internal services.

You should leave trace settings at default level unless you are instructed by TAC to change them to debug an issue.

Backup and restore services

This section describes the Backup and Restore Services.

Cisco DRF Master

The CiscoDRF Master Agent service supports the DRF Master Agent, which works with the Disaster Recovery System graphical user interface (GUI) or command line interface (CLI) to schedule backups, perform restorations, view dependencies, check status of jobs, and cancel jobs, if necessary. The Cisco DRF Master Agent also provides the storage medium for the backup and restoration process.

In a Cisco Unified Communications Manager Business Edition 5000 system, this service supports both Cisco Unified Communications Manager and Cisco Unity Connection.

Cisco DRF Local

The Cisco DRF Local service supports the Cisco DRF Local Agent, which acts as the workhorse for the DRF Master Agent. Components register with the Cisco DRF Local Agent to use the disaster recovery framework. The Cisco DRF Local Agent executes commands that it receives from the Cisco DRF Master Agent. Cisco DRF Local Agent sends the status, logs, and command results to the Cisco DRF Master Agent.

In a Cisco Unified Communications Manager Business Edition 5000 system, this service supports both Cisco Unified Communications Manager and Cisco Unity Connection.

System services

This section describes the System Services.

Cisco CallManager Serviceability

The Cisco CallManager Serviceability service supports Cisco Unified Serviceability, the web application/interface that you use to troubleshoot issues and manage services. This service, which is installed automatically, allows you access to the Cisco Unified Serviceability graphical user interface (GUI). If you stop this service, you cannot access the Cisco Unified Serviceability GUI when you browse into that server.

In a Cisco Unified Communications Manager Business Edition 5000 system, this service supports both Cisco Unified Communications Manager and Cisco Unity Connection.

Cisco CDP

Cisco CDP advertises the voice application to other network management applications, so the network management application, for example, SNMP or CiscoWorks Lan Management Solution, can perform network management tasks for the voice application.

In a Cisco Unified Communications Manager Business Edition 5000 system, this service supports both Cisco Unified Communications Manager and Cisco Unity Connection

Cisco Trace Collection Servlet

The Cisco Trace Collection Servlet, along with the Cisco Trace Collection Service, supports trace collection and allows users to view traces by using RTMT. If you stop this service on a server, you cannot collect or view traces on that server.

For SysLog Viewer and Trace and Log Central to work in RTMT, the Cisco Trace Collection Servlet and the Cisco Trace Collection Service must run on the server.

In a Cisco Unified Communications Manager Business Edition 5000 system, this service supports both Cisco Unified Communications Manager and Cisco Unity Connection.

Cisco Trace Collection Service

The Cisco Trace Collection Service, along with the Cisco Trace Collection Servlet, supports trace collection and allows users to view traces by using the RTMT client. If you stop this service on a server, you cannot collect or view traces on that server.

For SysLog Viewer and Trace and Log Central to work in RTMT, the Cisco Trace Collection Servlet and the Cisco Trace Collection Service must run on the server.


Tip


If necessary, Cisco recommends that, to reduce the initialization time, you restart the Cisco Trace Collection Service before restarting Cisco Trace Collection Servlet.


In a Cisco Unified Communications Manager Business Edition 5000 system, this service supports both Cisco Unified Communications Manager and Cisco Unity Connection.

Platform services

This section describes the Platform Services.

A Cisco DB

A Cisco DB service supports the Progres database engine.

In a Cisco Unified Communications Manager Business Edition 5000 system, this service supports both Cisco Unified Communications Manager and Cisco Unity Connection.

A Cisco DB Replicator

Unified CM only: The A Cisco DB Replicator service ensures database configuration and data synchronization between the first and subsequent servers in the cluster.

Cisco Tomcat

The Cisco Tomcat service supports the web server.

In a Cisco Unified Communications Manager Business Edition 5000 system, this service supports both Cisco Unified Communications Manager and Cisco Unity Connection.

SNMP Master Agent

This service, which acts as the agent protocol engine, provides authentication, authorization, access control, and privacy functions that relate to SNMP requests.


Tip


After you complete SNMP configuration in Cisco Unified Serviceability, you must restart the SNMP Master Agent service in the Control Center - Network Features window.


In a Cisco Unified Communications Manager Business Edition 5000 system, this service supports both Cisco Unified Communications Manager and Cisco Unity Connection.

MIB2 Agent

This service provides SNMP access to variables, which are defined in RFC 1213, that read and write variables; for example, system, interfaces, IP, and so on.

In a Cisco Unified Communications Manager Business Edition 5000 system, this service supports Cisco Unified Communications Manager and Cisco Unity Connection.

Host Resources Agent

This service provides SNMP access to host information, such as storage resources, process tables, device information, and installed software base. This service implements the HOST-RESOURCES-MIB.

In a Cisco Unified Communications Manager Business Edition 5000 system, this service supports both Cisco Unified Communications Manager and Cisco Unity Connection.

Native Agent Adaptor

This service, which supports vendor MIBs, allows you to forward SNMP requests to another SNMP agent that runs on the system.

In a Cisco Unified Communications Manager Business Edition 5000 system, this service supports both Cisco Unified Communications Manager and Cisco Unity Connection.

System Application Agent

This service provides SNMP access to the applications that are installed and executing on the system. This implements the SYSAPPL-MIB.

In a Cisco Unified Communications Manager Business Edition 5000 system, this service supports both Cisco Unified Communications Manager and Cisco Unity Connection.

Cisco CDP Agent

This service uses the Cisco Discovery Protocol to provide SNMP access to network connectivity information on the Cisco Unified Communications Manager or Cisco Unity Connection server. This service implements the CISCO-CDP-MIB.

In a Cisco Unified Communications Manager Business Edition 5000 system, this service supports both Cisco Unified Communications Manager and Cisco Unity Connection.

Cisco Syslog Agent

This service supports gathering of syslog messages that various components generate. This service implements the CISCO-SYSLOG-MIB.

In a Cisco Unified Communications Manager Business Edition 5000 system, this service supports both Cisco Unified Communications Manager and Cisco Unity Connection.


Caution


Stopping any SNMP service may result in loss of data because the network management system no longer monitors the network. Do not stop the services unless the your technical support team tells you to do so.


Cisco Certificate Expiry Monitor

This service periodically checks the expiration status of certificates that the system generates and sends notification when a certificate gets close to its expiration date. You manage the certificates that use this service in Cisco Unified Operating System Administration.

In a Cisco Unified Communications Manager Business Edition 5000 system, this service supports both Cisco Unified Communications Manager and Cisco Unity Connection.

Cisco License Manager

This service is not supported by Cisco Unity Connection.

Cisco License Manager keeps track of the Cisco Unified Communications Manager-related licenses that a customer purchases and uses. It controls license checkins and checkouts, and it takes responsibility for issuing and reclaiming Cisco Unified Communications Manager-related licenses. For Cisco Unified Communications Manager, Cisco License Manager manages the Cisco Unified Communications Manager application and the number of IP phone unit licenses. When the number of phones exceeds the number of licenses, it issues alarms.

Unified CM clusters only: This service runs on all the servers, but the service on the first server has the responsibility for issuing and reclaiming licenses.

In a Cisco Unified Communications Manager Business Edition 5000 system, this service supports Cisco Unified Communications Manager only.


Tip


Unified CM BE only: For information on issuing Cisco Unity Connection licenses, refer to the Cisco Unified Communications Manager System Guide .


Security services

This section describes the Security Services.

Cisco Trust Verification Service

Cisco Trust Verification Service is a service running on a CallManager server or a dedicated server, that authenticates certificates on behalf of phones and other endpoints. It associates a list of roles for the owner of the certificate. A certificate or the owner can be associated with one or many roles.

The protocol between phones and Trust Verification Service allows phones to request for verification. Trust Verification Service validates the certificate and returns a list of roles associated with it. The protocol allows Trust Verification Service to authenticate a request and conversely, a phone to authenticate the response from Trust Verification Service. The protocol protects the integrity of the request and the response. Confidentiality of the request and the response is not required.

Multiples instances of Cisco Trust Verification Service run on different servers in the cluster to provide scalability. These servers may or may not be the same as the ones hosting the Cisco Unified CallManager. Phones obtain a list of Trust Verification Services in the network and connect to one of them using a selection algorithm (example: Round Robin). If the contacted Trust Verification Service does not respond, the phone switches to the next Trust Verification Service in the list.

DB services

This section describes the DB Services.

Cisco Database Layer Monitor

The Cisco Database Layer Monitor service monitors aspects of the database layer. This service takes responsibility for change notification and monitoring.

In a Cisco Unified Communications Manager Business Edition 5000 system, this service supports both Cisco Unified Communications Manager and Cisco Unity Connection.


Note


Cisco Unified CM uses Automatic Update Statistics, an intelligent statistics update feature that monitors the changes made in the database tables and updates only tables that need statistic updates. This feature saves considerable bandwidth, especially on VMware deployments of Cisco Unified CM. Automatic Update Statistics is the default indexing method.


SOAP services

This section describes the SOAP Services.

Cisco SOAP-Real-Time Service APIs

The Cisco SOAP-Real-Time Service APIs allow you to collect real-time information for devices and CTI applications. This service also provides APIs for activating, starting, and stopping services.

In a Cisco Unified Communications Manager Business Edition 5000 system, this service supports both Cisco Unified Communications Manager and Cisco Unity Connection.

Cisco SOAP-Performance Monitoring APIs

The Cisco SOAP-Performance Monitoring APIs service allows you to use performance monitoring counters for various applications through SOAP APIs; for example, you can monitor memory information per service, CPU usage, performance monitoring counters, and so on.

In a Cisco Unified Communications Manager Business Edition 5000 system, this service supports both Cisco Unified Communications Manager and Cisco Unity Connection.

Cisco SOAP-Log Collection APIs

The Cisco SOAP-Log Collection APIs service allows you to collect log files and to schedule collection of log files on a remote SFTP server. Examples of log files that you can collect include syslog, core dump files, Cisco application trace files, and so on.

In a Cisco Unified Communications Manager Business Edition 5000 system, this service supports both Cisco Unified Communications Manager and Cisco Unity Connection.

CM services

This section describes the CM Services and does not apply to Cisco Unity Connection.

Cisco CallManager Personal Directory

The Cisco CallManager Personal Directory service supports Cisco Personal Directory.

In a Cisco Unified Communications Manager Business Edition 5000 system, this service supports Cisco Unified Communications Manager only.

Cisco Extension Mobility Application

The Cisco Extension Mobility Application service allows you to define login settings such as duration limits on phone configuration for the Cisco Extension Mobility feature.

Unified CM only: The Cisco Extension Mobility feature allows users within a Cisco Unified Communications Manager cluster to temporarily configure another phone in the cluster as their own phone by logging in to that other phone. After a user logs in, the phone adopts the personal phone number(s), speed dials, services links, and other user-specific properties of the user. After logout, the phone adopts the original user profile.

In a Cisco Unified Communications Manager Business Edition 5000 system, this service supports Cisco Unified Communications Manager only.

Cisco CallManager Cisco IP Phone Services

The Cisco CallManager Cisco IP Phone Service initializes the service URLs for the Cisco Unified IP Phone services that you configured in Cisco Unified Communications Manager Administration.

In a Cisco Unified Communications Manager Business Edition 5000 system, this service supports Cisco Unified Communications Manager only.

CDR services

This section describes the CDR Services and does not apply to Cisco Unity Connection.

Cisco CDR Repository Manager

This service maintains and moves the generated CDRs that are obtained from the Cisco CDR Agent service. In a system that supports clusters ( Cisco Unified Communications Manager only), the service exists on the first server.

In a Cisco Unified Communications Manager Business Edition 5000 system, this service supports Cisco Unified Communications Manager only.

Cisco CDR Agent


Note


Cisco Unified Communications Manager supports Cisco CDR Agent in Cisco Unified Communications Manager and Cisco Unified Communications Manager Business Edition 5000 systems. This service does not support Cisco Unity Connection.


This service does not support Cisco Unity Connection.

The Cisco CDR Agent service transfers CDR and CMR files that are generated by Cisco Unified Communications Manager from the local host to the CDR repository server, where the CDR Repository Manager service runs over a SFTP connection.

This service transfers CDR and CMR files generated from the local host to the CDR repository server in a cluster. The CDR Agent in the CDR Repository Node/Standalone server (Files generated in the Standalone server itself) transfers the files to the Cisco CDR Repository Manager, over a SFTP connection, which maintains /moves the files.

For this service to work, activate the Cisco CallManager service on the server and ensure that it is running. If your configuration supports clusters ( Cisco Unified Communications Manager only), activate the Cisco CallManager service on the first server.

In a Cisco Unified Communications Manager Business Edition 5000 system, this service supports Cisco Unified Communications Manager only.

Cisco CAR Scheduler

This service does not support Cisco Unity Connection.

The Cisco CAR Scheduler service allows you to schedule CAR-related tasks; for example, you can schedule report generation or CDR file loading into the CAR database.

In a Cisco Unified Communications Manager Business Edition 5000 system, this service supports Cisco Unified Communications Manager only.

Admin services

This section describes the Admin Services and does not apply to Cisco Unity Connection.

Cisco CallManager Admin

The Cisco CallManager Admin service supports Cisco Unified Communications Manager Administration, the web application/interface that you use to configure Cisco Unified Communications Manager settings. After the Cisco Unified Communications Manager installation, this service starts automatically and allows you to access the graphical user interface (GUI). If you stop this service, you cannot access the Cisco Unified Communications Manager Administration graphical user interface when you browse into that server.

In a Cisco Unified Communications Manager Business Edition 5000 system, this service supports Cisco Unified Communications Manager only.

Service activation

You can activate or deactivate multiple feature services or choose default services to activate from the Service Activation window in Cisco Unified Serviceability.


Note


Starting with Cisco Unified Communications Manager Release 6.1.1, end users can no longer access Cisco Unified Serviceability to start and stop services.


Cisco Unified Serviceability activates feature services in automatic mode and checks for service dependencies. When you choose to activate a feature service, Cisco Unified Serviceability prompts you to select all the other services, if any, that depend on that service to run. When you click the Set Default button, Cisco Unified Serviceability chooses those services that are required to run on the server.

Unified CM only: Even in a configuration that supports clusters, this process is based on a single-server configuration.

Activating a service automatically starts the service. You start/stop services from Control Center.

Control center

From Control Center in Cisco Unified Serviceability, you can view status and start and stop one service at a time. In a cluster configuration ( Cisco Unified Communications Manager only), you can perform these functions for one server in the cluster. To perform these tasks, Cisco Unified Serviceability provides two Control Center windows. To start, stop, and restart network services, access the Control Center - Network Services window. To start, stop, and restart feature services, access the Control Center - Feature Services window.


Tip


Use the Related Links drop-down list box and the Go button to navigate to Control Center and Service Activation windows.


Unified CM only: Starting and stopping a feature service causes all Cisco Unified IP Phones and gateways that are currently registered to that service to fail over to their secondary service. Devices and phones need to restart only if they cannot register with their secondary service. Starting and stopping a service may cause other installed applications (such as a conference bridge or Cisco Messaging Interface) that are homed to that Cisco Unified Communications Manager to start and stop as well.


Caution


Unified CM and Unified CM BE only: Stopping a service also stops call processing for all devices that the service controls. When a service is stopped, calls from an IP phone to another IP phone stay up; calls in progress from an IP phone to a Media Gateway Control Protocol (MGCP) gateway also stay up, but other types of calls drop.


Set up services

The following steps provide information about working with services.

Procedure
    Step 1   Activate the feature services that you want to run.
    Step 2   Configure the appropriate service parameters.
    Step 3   If necessary, troubleshoot problems by using the Cisco Unified Serviceability trace tools.

    Related Information

    Serviceability Reports Archive

    The Cisco Serviceability Reporter service generates daily reports in Cisco Unified Serviceability. Each report provides a summary that comprises different charts that display the statistics for that particular report. Reporter generates reports once a day on the basis of logged information.


    Note


    Unified CM clusters only: Because the Cisco Serviceability Reporter is only active on the first server, at any time, Reporter generates reports only on the first server, not the other servers.


    You view reports from Cisco Unified Serviceability > Tools > Serviceability Reports Archive. You must activate the Cisco Serviceability Reporter service before you can view reports. After you activate the service, report generation may take up to 24 hours.

    The reports contain 24-hour data for the previous day. A suffix that is added to the report names shows the date for which Reporter generated them; for example, AlertRep_mm_dd_yyyy.pdf. The Serviceability Reports Archive window uses this date to display the reports for the relevant date only. The reports generate from the data that is present in the log files, with the timestamp for the previous day. The system considers log files for the current date and the previous two days for collecting data. For cluster configurations ( Cisco Unified Communications Manager only), this takes into account the time zone differences between the server locations.

    The time that is shown in the report reflects the server "System Time." In cluster configurations ( Cisco Unified Communications Manager only), the time that is shown in the report reflects the first server "System Time." If the first server and subsequent server(s) are in different time zones, the first server "System Time" shows in the report.


    Note


    You can pick up log files from the server while you are generating reports, or in a cluster configuration ( Cisco Unified Communications Manager only), from all servers in the cluster.



    Note


    The Cisco Unified Reporting web application provides snapshot views of data into one output and runs data checks. In a cluster configuration ( Cisco Unified Communications Manager only), this includes cluster data from all accessible servers. The application also allows you to archive generated reports. See the Cisco Unified Reporting Administration Guide for more information.


    Serviceability reporter service parameters

    Cisco Serviceability Reporter uses the following service parameters:

    • RTMT Reporter Designated Node - Specifies the designated node on which RTMT Reporter runs. This default equals the IP address of the server on which the Cisco Serviceability Reporter service is first activated. Unified CM only: Because the Serviceability Reporter service is CPU intensive, Cisco recommends that you specify a non-call processing node.
    • Report Generation Time - Specifies the number of minutes after midnight. Reports generate at this time for the most recent day. The minimum value equals 0 and the maximum value equals 1439.
    • Report Deletion Age - Specifies the number of days that the report must be kept on the disk. The system deletes reports that are older than the specified age. The minimum value equals 0, and the maximum value equals 30.

    Tip


    You can disable reports by setting the service parameter Report Deletion Age to a value of 0.


    For more information about service parameter configuration, refer to the following guides:

    • Unified CM and Unified CM BE only: Cisco Unified Communications Manager Administration Guide
    • Connection only: System Administration Guide for Cisco Unity Connection

    Note


    Unified CM only: If a node gets removed completely from the network (the node should be removed from the network and also from the list of servers in Cisco Unified Communications Manager Administration), Reporter does not consider this node while it is generating reports, even if the log file contains the data for that node.


    Device statistics report

    The Device Statistics Report does not apply to Cisco Unity Connection.

    The Device Statistics Report provides the following line charts:

    In a Cisco Unified Communications Manager Business Edition 5000 system, the Device Statistics Report supports Cisco Unified Communications Manager only.

    Number of Registered Phones per Server

    A line chart displays the number of registered phones for each Cisco Unified Communications Manager server (and cluster in a Cisco Unified Communications Manager cluster configuration). Each line in the chart represents the data for a server for which data is available, and one extra line displays the clusterwide data ( Cisco Unified Communications Manager clusters only). Each data value in the chart represents the average number of phones that are registered for a 15-minute duration. If a server shows no data, Reporter does not generate the line that represents that server. If no data exists for the server (or for all servers in a Cisco Unified Communications Manager cluster configuration), for registered phones, Reporter does not generate the chart. The message "No data for Device Statistics report available" displays.

    Figure 1. Line Chart That Depicts Number of Registered Phones Per Server. This figure shows an example of a line chart representing the number of registered phones per Cisco Unified Communications Manager server in a Cisco Unified Communications Manager cluster configuration.



    Number of MGCP Gateways Registered in the Cluster

    A line chart displays the number of registered MGCP FXO, FXS, PRI, and T1CAS gateways. Each line represents data only for the Cisco Unified Communications Manager server (or cluster in a Cisco Unified Communications Manager cluster configuration); so, four lines show server (or clusterwide) details for each gateway type. Each data value in the chart represents the average number of MGCP gateways that are registered for a 15-minute duration. If no data exists for a gateway for the server (or all the servers in a cluster), Reporter does not generate the line that represents data for that particular gateway. If no data exists for all gateways for the server (or for all servers in a cluster), Reporter does not generate the chart.

    Figure 2. Line Chart That Depicts Number of Registered Gateways Per Cluster. This figure shows an example of a line chart representing the number of registered gateways per cluster, in a Cisco Unified Communications Manager cluster configuration.



    Number of H.323 Gateways in the Cluster

    A line chart displays the number of H.323 gateways. One line represents the details of the H.323 gateways (or the clusterwide details in a Cisco Unified Communications Manager cluster configuration). Each data value in the chart represents the average number of H.323 gateways for a 15-minute duration. If no data exists for H.323 gateways for the server (or for all servers in a cluster), Reporter does not generate the chart.

    Figure 3. Line Chart That Depicts Number of Registered H.323 Gateways Per Cluster. This figure shows an example line chart representing the number of H.323 gateways per cluster in a Cisco Unified Communications Manager cluster configuration.



    Number of Trunks in the Cluster

    A line chart displays the number of H.323 and SIP trunks. Two lines represent the details of the H.323 trunks and SIP trunks (or the clusterwide details in a Cisco Unified Communications Manager cluster configuration). Each data value in the chart represents the average number of H.323 and SIP trunks for a 15-minute duration. If no data exists for H.323 trunks for the server (or for all servers in a cluster), Reporter does not generate the line that represents data for the H.323 trunks. If no data exists for SIP trunks for the server (or for all servers in the cluster), Reporter does not generate the line that represents data for SIP trunks. If no data exists for trunks at all, Reporter does not generate the chart.

    Figure 4. Line Chart That Depicts Number of Trunks Per Cluster. This figure shows an example line chart representing the number of trunks per cluster in a Cisco Unified Communications Manager cluster configuration.



    The server (or each server in the cluster) contains log files that match the file name pattern DeviceLog_mm_dd_yyyy_hh_mm.csv. The following information exists in the log file:

    • Number of registered phones on the server (or on each server in a Cisco Unified Communications Manager cluster)
    • Number of registered MGCP FXO, FXS, PRI, and T1CAS gateways on the server (or on each server in a Cisco Unified Communications Manager cluster)
    • Number of registered H.323 gateways on the server (or on each server in a Cisco Unified Communications Manager cluster)
    • Number of SIP trunks and H.323 trunks

    Server statistics report

    The Server Statistics Report provides the following line charts:

    In a Cisco Unified Communications Manager Business Edition 5000 system, the Server Statistics Report supports both Cisco Unified Communications Manager and Cisco Unity Connection.

    Percentage of CPU per Server

    A line chart displays the percentage of CPU usage for the server (or for each server in a Cisco Unified Communications Manager cluster). The line in the chart represents the data for the server (or one line for each server in a Cisco Unified Communications Manager cluster) for which data is available. Each data value in the chart represents the average CPU usage for a 15-minute duration. If no data exists for the server (or for any one server in a Cisco Unified Communications Manager cluster), Reporter does not generate the line that represents that server. If there are no lines to generate, Reporter does not create the chart. The message "No data for Server Statistics report available" displays.

    Figure 5. Line Chart That Depicts the Percentage of CPU Per Server. This figure shows a line chart example representing the percentage of CPU usage per server in a Cisco Unified Communications Manager cluster configuration.



    Percentage of Memory Usage per Server

    A line chart displays the percentage of Memory Usage for the Cisco Unified Communications Manager server (%MemoryInUse). In a Cisco Unified Communications Manager cluster configuration, there is one line per server in the cluster for which data is available. Each data value in the chart represents the average memory usage for a 15-minute duration. If no data exists, Reporter does not generate the chart. If no data exists for any server in a Cisco Unified Communications Manager cluster configuration, Reporter does not generate the line that represents that server.

    Figure 6. Line Chart That Depicts Percentage of Memory Usage Per Server. This figure shows a line chart example representing the percentage of memory usage per Cisco Unified Communications Manager server in a Cisco Unified Communications Manager cluster configuration.



    Percentage of Hard Disk Usage of the Largest Partition per Server

    A line chart displays the percentage of disk space usage for the largest partition on the server (%DiskSpaceInUse), or on each server in a Cisco Unified Communications Manager cluster configuration. Each data value in the chart represents the average disk usage for a 15-minute duration. If no data exists, Reporter does not generate the chart. If no data exists for any one server in a cluster configuration, Reporter does not generate the line that represents that server.

    Figure 7. Line Chart That Depicts Percentage of Hard Disk Usage of the Largest Partition Per Server. This figure shows a line chart example representing the percentage of hard disk usage for the largest partition per server in a Cisco Unified Communications Manager cluster configuration.



    The server (or each server in a Cisco Unified Communications Manager cluster configuration) contains log files that match the file name pattern ServerLog_mm_dd_yyyy_hh_mm.csv. The following information exists in the log file:

    • % CPU usage on the server (or each server in a Cisco Unified Communications Manager cluster)
    • % Memory usage (%MemoryInUse) on the server (or on each server in a Cisco Unified Communications Manager cluster)
    • % Hard disk usage of the largest partition (%DiskSpaceInUse) on the server (or on each server in a Cisco Unified Communications Manager cluster)

    Service Statistics Report

    The Service Statistics Report does not support Cisco Unity Connection.

    The Service Statistics Report provides the following line charts:

    In a Cisco Unified Communications Manager Business Edition 5000 system, the Service Statistics Report supports Cisco Unified Communications Manager only.

    Cisco CTI Manager: Number of Open Devices

    A line chart displays the number of CTI Open Devices for the CTI Manager (or for each CTI Manager in a Cisco Unified Communications Manager cluster configuration). Each line chart represents the data for the server (or on each server in a Cisco Unified Communications Manager cluster) on which service is activated. Each data value in the chart represents the average number of CTI open devices for a 15-minute duration. If no data exists, Reporter does not generate the chart. If no data exists for any one server in a Cisco Unified Communications Manager cluster configuration, Reporter does not generate the line that represents that server. The message "No data for Service Statistics report available" displays.

    Figure 8. Line Chart That Depicts Cisco CTI Manager: Number of Open Devices. This figure shows a line chart example representing the number of open devices per Cisco CTI Manager in a Cisco Unified Communications Manager cluster configuration.



    Cisco CTI Manager: Number of Open Lines

    A line chart displays the number of CTI open lines for the CTI Manager (or per CTI Manager in a Cisco Unified Communications Manager cluster configuration). A line in the chart represents the data for the server (or one line for each server in a Cisco Unified Communications Manager cluster configuration) where the Cisco CTI Manager service is activated. Each data value in the chart represents the average number of CTI open lines for a 15-minute duration. If no data exists, Reporter does not generate the chart. If no data exists for any one server in a Cisco Unified Communications Manager cluster configuration, Reporter does not generate the line that represents that server.

    Figure 9. Line Chart That Depicts Cisco CTI Manager: Number of Open Lines. This figure shows a line chart example representing the number of open lines per Cisco CTI Manager in a Cisco Unified Communications Manager cluster configuration.



    Cisco TFTP: Number of Requests

    A line chart displays the number of Cisco TFTP requests for the TFTP server (or per TFTP server in a Cisco Unified Communications Manager cluster configuration). A line in the chart represents the data for the server (or one line for each server in a Cisco Unified Communications Manager cluster) where the Cisco TFTP service is activated. Each data value in the chart represents the average number of TFTP requests for a 15-minute duration. If no data exists, Reporter does not generate the chart. If no data exists for any one server in a Cisco Unified Communications Manager cluster configuration, Reporter does not generate the line that represents that server.

    Figure 10. Line Chart That Depicts Cisco TFTP: Number of Requests. This figure shows a line chart example representing the number of Cisco TFTP requests per TFTP server.



    Cisco TFTP: Number of Aborted Requests

    A line chart displays the number of Cisco TFTP requests that were aborted for the TFTP server (or per TFTP server in a Cisco Unified Communications Manager cluster configuration). A line in the chart represents the data for the server (or one line for each server in a Cisco Unified Communications Manager cluster) where the Cisco TFTP service is activated. Each data value in the chart represents the average of TFTP requests that were aborted for a 15-minute duration. If no data exists, Reporter does not generate the chart. If no data exists for any one server in a Cisco Unified Communications Manager cluster configuration, Reporter does not generate the line that represents that server.

    Figure 11. Line Chart That Depicts Cisco TFTP: Number of Aborted Requests. This figure shows a line chart example that represents the number of Cisco TFTP requests that were aborted per TFTP server.



    The server (or each server in a Cisco Unified Communications Manager cluster) contains log files that match the file name pattern ServiceLog_mm_dd_yyyy_hh_mm.csv. The following information exists in the log file:

    • For each CTI Manager - Number of open devices
    • For each CTI Manager - Number of open lines
    • For each Cisco TFTP server - TotalTftpRequests
    • For each Cisco TFTP server - TotalTftpRequestsAborted

    Call activities report

    The Call Activities Report does not support Cisco Unity Connection.

    The Call Activities Report provides the following line charts:

    In a Cisco Unified Communications Manager Business Edition 5000 system, the Server Statistics Report supports Cisco Unified Communications Manager only.

    Cisco Unified Communications Manager Call Activity for the Cluster

    A line chart displays the number of Cisco Unified Communications Manager calls that were attempted and calls that were completed. In a Cisco Unified Communications Manager cluster configuration, the line chart displays the number of calls attempted and completed for the entire cluster. The chart comprises two lines, one for the number of calls that were attempted and another for the number of calls that were completed. For a Cisco Unified Communications Manager cluster configuration, each line represents the cluster value, which is the sum of the values for all the servers in the cluster (for which data is available). Each data value in the chart represents the total number of calls that were attempted or calls that were completed for a 15-minute duration.

    If no data exists for Cisco Unified Communications Manager calls that were completed, Reporter does not generate the line that represents data for the calls that were completed. If no data exists for Cisco Unified Communications Manager calls that were attempted, Reporter does not generate the line that represents data for the calls that were attempted. In a Cisco Unified Communications Manager cluster configuration, if no data exists for a server in the cluster, Reporter does not generate the line that represents calls attempted or completed on that server. If no data exists for Cisco Unified Communications Manager call activities at all, Reporter does not generate the chart. The message "No data for Call Activities report available" displays.

    Figure 12. Line Chart That Depicts Cisco Unified Communications Manager Call Activity for a Cluster. This figure shows a line chart representing the number of attempted and completed calls for a Cisco Unified Communications Manager cluster.



    H.323 Gateways Call Activity for the Cluster

    A line chart displays the number of calls that were attempted and calls that were completed for H.323 gateways. In a Cisco Unified Communications Manager cluster configuration, the line chart displays the number of calls attempted and completed for the entire cluster. The chart comprises two lines, one for the number of calls that were attempted and another for the number of calls that were completed. For a Cisco Unified Communications Manager cluster configuration, each line represents the cluster value, which equals the sum of the values for all the servers in the cluster (for which data is available). Each data value in the chart represents the total number of calls that were attempted or calls that were completed for a 15-minute duration. If no data exists for H.323 gateways calls that were completed, Reporter does not generate the line that represents data for calls that were completed. If no data exists for H.323 gateways calls that were attempted, Reporter does not generate the line that represents data for calls that were attempted. In a Cisco Unified Communications Manager cluster configuration, if no data exists for a server in the cluster, Reporter does not generate the line that represents calls attempted or completed on that server. If no data exists for H.323 gateways call activities at all, Reporter does not generate the chart.

    Figure 13. Line Chart That Depicts H.323 Gateways Call Activity for the Cluster. This figure shows a line chart representing the H.323 gateway call activity for a Cisco Unified Communications Manager cluster.



    MGCP Gateways Call Activity for the Cluster

    A line chart displays the number of calls that were completed in an hour for MGCP FXO, FXS, PRI, and T1CAS gateways. In a Cisco Unified Communications Manager cluster configuration, the chart displays the number of calls that were completed for the entire Cisco Unified Communications Manager cluster. The chart comprises four lines at the most, one for the number of calls that were completed for each of the gateway types (for which data is available). Each data value in the chart represents the total number of calls that were completed for a 15-minute duration. If no data exists for a gateway, Reporter does not generate the line that represents data for calls that were completed for a particular gateway. If no data exists for all gateways, Reporter does not generate the chart.

    Figure 14. Line Chart That Depicts MGCP Gateways Call Activity for the Cluster. This figure shows a line chart representing the MGCP gateways call activity for a Cisco Unified Communications Manager cluster.



    MGCP Gateways

    A line chart displays the number of Ports In Service and Active Ports for MGCP FXO, FXS gateways and the number of Spans In Service or Channels Active for PRI, T1CAS gateways. For a Cisco Unified Communications Manager cluster configuration, the chart displays the data for the entire Cisco Unified Communications Manager cluster. The chart comprises eight lines, two lines each for the number of Ports In Service for MGCP FXO and FXS, and two lines each for the number of Active Ports for MGCP FXO and FXS. Four more lines for the number of Spans In Service and Channels Active for PRI and T1CAS gateways exist. For a Cisco Unified Communications Manager cluster configuration, each line represents the cluster value, which is the sum of the values for all servers in the cluster (for which data is available). Each data value in the chart represents the total Number of Ports In Service, Number of Active Ports, Spans In Service or Channels Active for a 15-minute duration. If no data exists for the number of Spans In Service or the Channels Active for a gateway (MGCP PRI, T1CAS) for all servers, Reporter does not generate the line that represents data for that particular gateway.

    Figure 15. Line Chart That Depicts MGCP Gateways. This figure shows a line chart representing the MGCP gateways.



    Trunk Call Activity for the Cluster

    A line chart displays the number of calls that were completed and calls that were attempted in an hour for SIP trunk and H.323 trunk. For a Cisco Unified Communications Manager cluster configuration, the chart displays the number of calls that were completed and calls that were attempted for the entire Cisco Unified Communications Manager cluster. The chart comprises four lines, two for the number of calls that were completed for each SIP and H.323 trunk (for which data is available) and two for the number of calls that were attempted. For a Cisco Unified Communications Manager cluster configuration, each line represents the cluster value, which is the sum of the values for all nodes in the cluster (for which data is available). Each data value in the chart represents the total number of calls that were completed or number of calls that were attempted for a 15-minute duration. If no data exists for a trunk, Reporter does not generate the line that represents data for the calls that were completed or the calls that were attempted for that particular trunk. If no data exists for both trunk types, Reporter does not generate the chart.

    Figure 16. Line Chart That Depicts Trunk Call Activity for the Cluster. This figure shows a line chart representing the trunk call activity for a Cisco Unified Communications Manager cluster.



    The server (or each server in a Cisco Unified Communications Manager cluster configuration) contains log files that match the file name pattern CallLog_mm_dd_yyyy_hh_mm.csv. The following information exists in the log file:

    • Calls that were attempted and calls that were completed for Cisco Unified Communications Manager (or for each server in a Cisco Unified Communications Manager cluster)
    • Calls that were attempted and calls that were completed for the H.323 gateways (or for the gateways in each server in a Cisco Unified Communications Manager cluster)
    • Calls that were completed for the MGCP FXO, FXS, PRI, and T1CAS gateways (or for the gateways in each server in a Cisco Unified Communications Manager cluster)
    • Ports in service, active ports for MGCP FXO and FXS gateways and spans in service, channels active for PRI, and T1CAS gateways (in each server in a Cisco Unified Communications Manager cluster)
    • Calls that were attempted and calls that were completed for H.323 trunks and SIP trunks

    Alert summary report

    The Alert Summary Report provides the details of alerts that are generated for the day. The Alert report comprises the charts shown.

    In a Cisco Unified Communications Manager Business Edition 5000 system, the Server Statistics Report supports both Cisco Unified Communications Manager and Cisco Unity Connection.

    Number of Alerts per Server

    Unified CM only: A pie chart provides the number of alerts per Cisco Unified Communications Manager node. The chart displays the serverwide details of the alerts that are generated. Each sector of the pie chart represents the number of alerts generated for a particular server in the Cisco Unified Communications Manager cluster. The chart includes as many number of sectors as there are servers (for which Reporter generates alerts in the day) in the cluster. If no data exists for a server, no sector in the chart represents that server. If no data exists for all servers, Reporter does not generate the chart. The message "No alerts were generated for the day" displays.

    Unified CM BE and Connection only: A pie chart provides the number of alerts for the server. The chart displays the serverwide details of the alerts that are generated. If no data exists for the server, Reporter does not generate the chart. The message “No alerts were generated for the day” displays.

    The following chart shows a pie chart example that represents the number of alerts per server in a Cisco Unified Communications Manager cluster.

    Figure 17. Pie Chart That Depicts Number of Alerts Per Server



    Number of Alerts per Severity for the Cluster

    A pie chart displays the number of alerts per alert severity. The chart displays the severity details of the alerts that are generated. Each sector of the pie chart represents the number of alerts that are generated of a particular severity type. The chart provides as many number of sectors as there are severities (for which Reporter generates alerts in the day). If no data exists for a severity, no sector in the chart represents that severity. If no data exists, Reporter does not generate the chart.

    The following chart shows a pie chart example that represents the number of alerts per severity for a Cisco Unified Communications Manager cluster.

    Figure 18. Pie Chart That Depicts Number of Alerts Per Severity for the Cluster



    Top 10 Alerts in the Cluster

    A bar chart displays the number of alerts of a particular Alert Type. The chart displays the details of the alerts that are generated on the basis of the alert type. Each bar represents the number of alerts for an alert type. The chart displays details only for the first 10 alerts based on the highest number of alerts in descending order. If no data exists for a particular alert type, no bar represents that alert. If no data exists for any alert type, RTMT does not generate the chart.

    The following chart shows a bar chart example that represents the top 10 alerts in a Cisco Unified Communications Manager cluster.

    Figure 19. Bar Chart That Depicts Top 10 Alerts in the Cluster



    The server (or each server in a Cisco Unified Communications Manager cluster) contains log files that match the file name pattern AlertLog_mm_dd_yyyy_hh_mm.csv. The following information exists in the log file:

    • Time - Time at which the alert occurred
    • Alert Name - Descriptive name
    • Node Name - Server on which the alert occurred
    • Monitored object - The object that is monitored
    • Severity - Severity of this alert

    Performance protection report

    The Performance Protection Report does not apply to Cisco Unity Connection.

    The Performance Protection Report provides a summary that comprises different charts that display the statistics for that particular report. Reporter generates reports once a day on the basis of logged information.

    The Performance Protection Report provides trend analysis information on default monitoring objects for the last seven that allows you to track information about Cisco Intercompany Media Engine. The report includes the Cisco IME Client Call Activity chart that shows the total calls and fallback call ratio for the Cisco IME client.

    The Performance Protection report comprises the following charts:

    For a Cisco Unified Communications Manager Business Edition 5000 system, the Server Statistics Report supports Cisco Unified Communications Manager only.

    Cisco Unified Communications Manager Call Activity

    A line chart displays the hourly rate of increase or decrease for number of calls that were attempted and calls that were completed as the number of active calls. For a Cisco Unified Communications Manager cluster configuration, the data is charted for each server in the cluster. The chart comprises three lines, one for the number of calls that were attempted, one for the calls that were completed, and one for the active calls. If no data exists for call activity, Reporter does not generate the chart.

    Number of registered phones and MGCP gateways

    A line chart displays the number of registered phones and MGCP gateways. For a Cisco Unified Communications Manager cluster configuration, the chart displays the data for each server in the cluster.The chart comprises two lines, one for the number of registered phones and another for the number of MGCP gateways. If no data exists for phones or MGCP gateways, Reporter does not generate the chart.

    System Resource Utilization

    A line chart displays the CPU load percentage and the percentage of memory that is used (in bytes) for the server (or for the whole cluster in a Cisco Unified Communications Manager cluster configuration). The chart comprises two lines, one for the CPU load and one for the memory usage. In a Cisco Unified Communications Manager cluster, each line represents the cluster value, which is the average of the values for all the servers in the cluster (for which data is available). If no data exists for phones or MGCP gateways, Reporter does not generate the chart.

    Device and Dial Plan Quantities

    Two tables display information from the Cisco Unified Communications Manager database about the numbers of devices and number of dial plan components. The device table shows the number of IP phones, Unity connection ports, H.323 clients, H.323 gateways, MGCP gateways, MOH resources, and MTP resources. The dial plan table shows the number of directory numbers and lines, route patterns, and translation patterns.

    Set up serviceability reports archive

    The following steps provide information for configuring the serviceability report archive feature.

    Procedure
      Step 1   Activate the Cisco Serviceability Reporter service.
      Step 2   Configure the Cisco Serviceability Reporter service parameters.
      Step 3   View the reports that the Cisco Serviceability Reporter service generates.

      Related Tasks
      Related Information

      Configuring services

      This section provides information on configuring services.

      Activate feature services

      You activate and deactivate feature services in the Service Activation window in Cisco Unified Serviceability. Services that display in the Service Activation window do not start until you activate them.

      Cisco Unified Serviceability allows you to activate and deactivate only features services (not network services). You may activate or deactivate as many services as you want at the same time. Some feature services depend on other services, and the dependent services get activated before the feature service activates.


      Tip


      Unified CM only: Before you activate services in the Service Activation window, review Cluster service activation recommendations.


      To activate or deactivate feature services in Cisco Unified Serviceability, perform the following procedure:

      Procedure
        Step 1   Choose Tools > Service Activation.

        The Service Activation window displays.

        Step 2   From the Server drop-down list box, choose the server where you want to activate the service; then, click Go.

        For the server that you chose, the window displays the service names and the activation status of the services.

        Step 3   To activate all services in the Service Activation window, check the Check All Services check box.
        Step 4   You can choose all services that are required to run on a single server by clicking the Set Default button. This action not only chooses all required services but also checks for service dependencies. To activate services for a single-server configuration, click the Set Default button or activate the services that you want to use.
        Step 5   Unified CM only: For a cluster configuration, review Cluster service activation recommendations for service activation recommendations; then, check the check boxes next to the services that you want to activate.
        Step 6   After you check the check boxes for the services that you want to activate, click Save.
        Tip   

        To deactivate services that you activated, uncheck the check boxes next to the services that you want to deactivate; then, click Save.

        Tip   

        To obtain the latest status of the services, click the Refresh button.


        Cluster service activation recommendations

        This section does not apply to Cisco Unified Communications Manager Business Edition 5000 or Cisco Unity Connection.

        Before you activate services in a cluster, review Table 1, which provides service recommendations for multiserver configurations.

        Table 1 Service Activation Recommendations

        Service/Servlet

        Activation Recommendations

        CM Services

        Cisco CallManager

        This service supports Cisco Unified Communications Manager.

        In the Control Center - Network Services, ensure that the Cisco RIS Data Collector service and Database Layer Monitor service are running on the node.

        Tip    Before you activate this service, verify that the Cisco Unified Communications Manager server displays in the Cisco Unified Communications Manager Find/List window in Cisco Unified Communications Manager Administration. If the server does not display, add the Cisco Unified Communications Manager server before you activate this service. For information on how to add the Cisco Unified Communications Manager server, refer to the Cisco Unified Communications Manager Administration Guide.

        Cisco Messaging Interface

        Activate only if using an SMDI integration to a 3rd party Voicemail system using a server-attached USB-to-serial adapter.

        Cisco Unified Mobile Voice Access Service

        For mobile voice access to work, you must activate this service on the first node in the cluster after you configure the H.323 gateway to point to the first VXML page. In addition, make sure that the Cisco CallManager and the Cisco TFTP services run on one server in the cluster, not necessarily the same server where the Cisco Unified Mobile Voice Access Service runs.

        Cisco IP Voice Media Streaming App

        If you have more than one node in the cluster, activate on one or two servers per cluster. You may activate on a node that is dedicated specifically for music on hold. This service requires that you activate Cisco TFTP on one node in the cluster. Do not activate this service on the first node or on any nodes that run the Cisco CallManager service.

        Cisco CTIManager

        Activate on each node to which JTAPI/TAPI applications will connect. CTIManager activation requires the Cisco CallManager service also to be activated on the node. See the CM services for more information on CTIManager and Cisco CallManager services interaction.

        Cisco Extension Mobility

        Activate on all nodes in the cluster.

        Cisco Extended Functions

        Activate this service, which supports the Quality Report Tool (QRT), on one or more servers that run the Cisco RIS Data Collector. Make sure that you activate the Cisco CTIManager service on a node in the cluster.

        Cisco DHCP Monitor Service

        When the DHCP Monitor service is enabled, it detects changes in the database that affect IP addresses for the IP phones, modifies the /etc/dhcpd.conf file, and stops and restarts the DHCPD daemon with the updated configuration file. Activate this service on the node that has DHCP enabled.

        Cisco Dialed Number Analyzer Server

        If you have more than one node in the cluster, activate this service on one node that is dedicated specifically for the Cisco Dialed Number Analyzer service.

        Cisco Dialed Number Analyzer

        If you are planning to use Cisco Unified Communications Manager Dialed Number Analyzer, activate this service. This service may consume a lot of resources, so only activate this service on the node with the least amount of call-processing activity or during off-peak hours.

        Cisco TFTP

        If you have more than one node in the cluster, activate this service on one node that is dedicated specifically for the Cisco TFTP service. Configure Option 150 if you activate this service on more than one node in the cluster.

        CTI Services

        Cisco IP Manager Assistant

        If you are planning to use Cisco Unified Communications Manager Assistant, activate this service on any two servers (Primary and Backup) in the cluster. Ensure that Cisco CTI Manager service is activated in the cluster. Refer to Cisco Unified Communications Manager Features and Services Guide for other recommendations.

        Cisco WebDialer Web Service

        Activate on one node per cluster.

        CDR Services

        Cisco SOAP-CDRonDemand Service

        You can activate the Cisco SOAP-CDROnDemand Service only on the first server, and it requires that the Cisco CDR Repository Manager and Cisco CDR Agent services are running on the same server.

        Cisco CAR Web Service

        You can activate the Cisco CAR Web Service only on the first server, and it requires that the Cisco CAR Scheduler service is activated and running on the same server and that the CDR Repository Manager service also is running on the same server.

        Database and Admin Services

        Cisco AXL Web Service

        Activate on the first node only. Failing to activate this service causes the inability to update Cisco Unified Communications Manager from client-based applications that use AXL.

        Cisco Bulk Provisioning Service

        You can activate the Cisco Bulk Provisioning Service only on the first node. If you use the Bulk Administration Tool (BAT) to administer phones and users, you must activate this service.

        Cisco TAPS Service

        Before you can use the Cisco Unified Communications Manager Auto-Register Phone Tool, you must activate this service on the first node. When you create dummy MAC addresses for the Cisco Unified Communications Manager Auto-Register Phone Tool, ensure that the Cisco Bulk Provisioning Service is activated on the same node.

        Performance and Monitoring Services

        Cisco Serviceability Reporter

        Activate on only the first node.

        Note   

        The service only generates reports on the first node even if you activate the service on other nodes.

        Cisco CallManager SNMP Service

        If you use SNMP, activate this service on all servers in the cluster.

        Security Services

        Cisco CTL Provider

        Activate on all servers in the cluster.

        Cisco Certificate Authority Proxy Function (CAPF)

        Activate on only the first node.

        Directory Services

        Cisco DirSync

        Activate only on the first node.

        Set up status of services

        Unified CM only: Control Center in Cisco Unified Serviceability allows you to view status, refresh the status, and to start, stop, and restart feature and network services.

        Unified CM only: Starting, stopping, or restarting a service causes all Cisco Unified IP Phones and gateways that are currently registered to that service to fail over to their secondary Cisco CallManager service. Devices and phones need to restart only if they cannot register with another service.

        Unified CM and Unified CM BE only: Starting, stopping, or restarting a service causes other installed applications (such as conference bridge or Cisco Messaging Interface) that are homed to the Cisco Unified Communications Manager to start and stop as well.


        Note


        Unified CM only: If you are upgrading Cisco Unified Communications Manager, those services that were already started on your system automatically start after the upgrade.



        Caution


        Unified CM and Unified CM BE only: Stopping a service also stops call processing for all devices that the service controls. When a service is stopped, calls from an IP phone to another IP phone stay up; calls in progress from an IP phone to a Media Gateway Control Protocol (MGCP) gateway also stay up, and other types of calls get dropped.


        Perform the following procedure to start, stop, restart, or view the status of services for a server (or for a server in a cluster in a Cisco Unified Communications Manager cluster configuration). You can start, stop, or refresh only one service at a time. Be aware that when a service is stopping, you cannot start it until after the service is stopped. Likewise, when a service is starting, you cannot stop it until after the service is started.

        Procedure
          Step 1   Depending on the service type that you want to start/stop/restart/refresh, perform one of the following tasks:
          1. Choose Tools > Control Center - Feature Services.
            Tip   

            Before you can start/stop/restart a feature service, it must be activated. To activate a service, see the Activate feature services.

          2. Choose Tools > Control Center - Network Services.
          Step 2   From the Server drop-down list box, choose the server; then, click Go.

          The window displays the following items:

          1. The service names for the server that you chose.
          2. The service group.
          3. The service status; for example, Started, Running, Not Running, and so on. (Status column)
          4. The exact time that the service started running. (Start Time column)
          5. The amount of time that the service has been running. (Up Time column)
          Step 3   Perform one of the following tasks:
          1. Click the radio button next to the service that you want to start and click the Start button.

            The Status changes to reflect the updated status.

          2. Click the radio button next to the service that you want to stop and click the Stop button.

            The Status changes to reflect the updated status.

          3. Click the radio button next to the service that you want to restart and click the Restart button.

            A message indicates that restarting may take a while. Click OK.

          4. To get the latest status of the services, click the Refresh button.
          5. To go to the Service Activation window or to the other Control Center window, choose an option from the Related Links drop-down list box and click Go.

          Command line interface

          You can start and stop some services through the Command Line Interface (CLI). For a list of services that you can start and stop through the CLI and for information on how to perform these tasks, refer to the Command Line Interface Reference Guide for Cisco Unified Solutions.


          Tip


          You must start and stop most services from Control Center in Cisco Unified Serviceability.


          Set up Serviceability Reports Archive

          The Cisco Serviceability Reporter service generates daily reports in Cisco Unified Serviceability. Each report provides a summary that comprises different charts that display the statistics for that particular report. Reporter generates reports once a day on the basis of logged information.

          This section describes how to use the Serviceability Reports Archive window.

          Before You Begin

          Activate the Cisco Serviceability Reporter service, which is CPU intensive. After you activate the service, report generation may take up to 24 hours.

          Unified CM only: Cisco recommends that you activate the service on a non-callprocessing server.

          Procedure
            Step 1   Choose Tools > Serviceability Reports Archive.

            The Serviceability Reports Archive window displays the month and year for which the reports are available.

            Step 2   From the Month-Year pane, choose the month and year for which you want to display reports.

            A list of days that correspond to the month displays.

            Step 3   To view reports, click the link that corresponds to the day for which reports were generated.

            The report files for the day that you chose display.

            Step 4   To view a particular PDF report, click the link of the report that you want to view.
            Tip   

            If you browsed into Cisco Unified Serviceability by using the server name, you must log in to Cisco Unified Serviceability before you can view the report.

            If your network uses Network Address Translation (NAT) and you are trying to access serviceability reports inside the NAT, enter the IP address for the private network that is associated with the NAT in the browser URL. If you are trying to access the reports outside the NAT, enter the public IP address, and NAT will accordingly translate/map to the private IP address.

            To view PDF reports, you must install Acrobat Reader on your machine. To download Acrobat Reader, click the link at the bottom of the Serviceability Reports Archive window.

            A window opens and displays the PDF file of the report that you chose.


            CDR Repository Manager

            Use the CDR Management Configuration window to set the amount of disk space to allocate to call detail record (CDR) and call management record (CMR) files, configure the number of days to preserve files before deletion, and configure up to three billing application server destinations for CDRs. The CDR repository manager service repeatedly attempts to deliver CDR and CMR files to the billing servers that you configure in the CDR Management Configuration window until it delivers the files successfully, until you change or delete the billing application server on the CDR Management Configuration window, or until the files fall outside the preservation window and are deleted.

            Unified CM BE only: The CDR and CMR files get offloaded to the external billing application servers by using the time interval that you have previously specified in the CDR File Time Interval enterprise parameter in Cisco Unified Communications Manager. After the Communications Manager generates the files, the CDR Agent and CDR Repository Manager take over. On each Communications Manager server, the CDR agent pushes the CDR flat files to the publisher. The CDR Repository Manager pushes the files to the external billing application servers.


            Note


            To access the Enterprise Parameters Configuration window, open Cisco Unified Communications Manager Administration and choose System > Enterprise Parameters. The CDR File Time Interval parameter specifies the time interval for collecting CDR data. For example, if this value is set to 1, each file will contain 1 minute of CDR data (CDRs and CMRs, if enabled). The external billing server and CAR database will not receive the data in each file until the interval has expired, so consider how quickly you want access to the CDR data when you decide what interval to set for this parameter. For example, setting this parameter to 60 means that each file will contain 60 minutes worth of data, but that data will not be available until the 60-minute period has elapsed, and the records are written to the CAR database. and the CDR files are sent to the configured billing server(s). The default value equals 1. The minimum value specifies 1, and the maximum value specifies 1440. The unit of measure for this required field represents a minute.


            Both the CDR Agent and the CDR Repository Manager process files with an interval that is independent of the CDR File Time Interval. The CDR Repository Manager sends all existing CDR files to the billing application servers, sleeps for 6 seconds before checking the new files to send, and continues that 6-second interval. If the destination (the external billing application servers) does not respond, the system attempts the process again by using a doubled length of the sleep interval (12 seconds). Each delivery failure results in double the sleep time (6, 12, 24, 48,and so on, seconds) until 2 minutes occurs, then stays at 2-minute intervals until successful delivery occurs. After successful delivery, the 6-second interval automatically resumes.

            Users cannot configure the 6-second processing time, with the sleep time interval doubling in case of failure. Users can configure only the CDR File Time Interval enterprise parameter. No alert gets sent after the first file delivery failure. By default, the system generates the CDRFileDeliveryFailed alert after the second delivery failure of the Cisco CDR Repository Manager service to deliver files to any billing application server. You can configure the alert to send you an e-mail or to page you. For information on configuring alerts, see the "Working with Alerts" chapter in the Cisco Unified Real-Time Monitoring Tool Administration Guide.

            The system generates the CDRFileDeliveryFailureContinues syslog alarm upon subsequent failures to deliver the files to the billing application servers.

            The CDR Agent behaves in almost the same manner. First, it sends all the existing CDR files to the publisher. If no additional files to send exist, the CDR Agent sleeps for 6 seconds before checking for new files. Each delivery failure results in the immediate change of the sleep interval to 1 minute, then says at 1-minute intervals until successful delivery. After the first successful delivery of files, the 6-second interval resumes.

            The system sends no alert after the first file delivery failure by the CDR Agent. By default, the system generates the CDRAgentSendFileFailed alert after the second delivery failure of the CDR Agent. You can configure the alert to send you an e-mail or to page you. For information on configuring alerts, see the "Working with Alerts" chapter in the Cisco Unified Real-Time Monitoring Tool Administration Guide

            The system generates the CDRAgentSendFileFailedContinues syslog alarm upon subsequent failures to deliver the files.

            If you need to start or restart the file transfer timer for any reason, you can restart the Cisco CDR Repository Manager or CDR Agent process by going to the Cisco Unified Serviceability window and selecting Tools > Control Center > Network Services.

            When you enable the file deletion based on high water mark parameter, the CDR repository manager service monitors the amount of disk space that CDR and CMR files use. If disk usage exceeds the high water mark that you configure, the system purges the CDR and CMR files that have been successfully delivered to all destinations and loaded into the CAR database (if CAR is activated) until the disk space reaches the low water mark or the system deletes all successfully delivered files. If disk usage still exceeds the high water mark after the system deletes all successfully delivered files, it does not delete any more files, unless the disk usage still exceeds the disk allocation that you configure. If the disk usage still exceeds the disk allocation that you configure, the system purges files beginning with the oldest, regardless of whether the files fall within the preservation window or have been successfully delivered, until the disk usage falls below the high water mark.


            Note


            Regardless of whether you enable the deletion of files based on the high water mark parameter, if disk usage exceeds the disk allocation that you configure, the CDR repository manager service deletes CDR and CMR files, beginning with the oldest files, until disk utilization falls below the high water mark.


            The Cisco Log Partition Monitoring Tool service monitors the disk usage of CDR and CMR flat files that have not been delivered to the CDR repository manager.

            Unified CM only: If the disk usage of the log partition on a server exceeds the configured limit and the service has deleted all other log and trace files, the log partition monitor service deletes CDR/CMR files on the subsequent nodes that have not been delivered to the CDR repository manager.

            For more information on log partition monitoring, refer to the Cisco Unified Real-Time Monitoring Tool Administration Guide.

            Set up general parameters

            To set disk utilization and file preservation parameters for CDRs, perform the following procedure:

            Procedure
              Step 1   Choose Tools > CDR Management.

              The CDR Management window displays.

              Step 2   Click the CDR Manager general parameter value that you want to change.
              Step 3   Enter the appropriate parameters, as described in Table 1.
              Step 4   Click Update.
              Tip   

              At any time, you can click Set Default to specify the default values. After you set the defaults, click Update to save the default values.


              General parameter settings

              The following table describes the available settings in the General Parameters section of the CDR Management Configuration window.

              Table 2 CDR Repository Manager General Parameter Settings
              Field Description

              Disk Allocation (MB)

              Choose the number of megabytes that you want to allocate to CDR and CMR flat file storage.

              The default disk allocation and range vary depending on the size of the server hard drive.

              Note   

              The maximum CAR database size equals 6 GB for a Cisco Unified Communications Manager server and 3 GB for a Cisco Unified Communications Manager Business Edition 5000 server.

              If disk usage exceeds the allocated maximum disk space for CDR files, the system generates the CDRMaximumDiskSpaceExceeded alert and deletes all successfully processed files (those delivered to billing servers and loaded to CAR). If disk usage still exceeds the allocated disk space, the system deletes undelivered files and files within the preservation duration, starting with the oldest, until disk utilization falls below the high water mark.

              If you have a large system and do not allocate enough disk space, the system may delete the CDR and CMR files before the CAR Scheduler loads the files into the CAR database. For example, if you configure the CAR Scheduler to run once a day and you set the disk allocation to a value that is not large enough to hold the CDR and CMR files that are generated in a day, the system will delete the files before they are loaded into the CAR database.

              High Water Mark (%)

              This field specifies the maximum percentage of the allocated disk space for CDR and CMR files. For example, if you choose 2000 megabytes from the Disk Allocation field and 80% from the High Water Mark (%) field, the high water mark equals 1600 megabytes. In addition to the high water mark percentage, the number of CDRs in the CAR database cannot exceed two million records for a Cisco Unified Communications Manager server and one million records for a Cisco Unified Communications Manager Business Edition 5000 server.

              When the disk usage exceeds the percentage that you specify, or the total number of CDRs is exceeded, and the Disable CDR/CMR Files Deletion Based on HWM check box is unchecked, the system automatically purges all successfully processed CDR and CMR files (those delivered to billing servers and loaded to CAR) beginning with the oldest files to reduce disk usage to the amount that you specify in the Low Water Mark (%) drop-down list box.

              If the disk usage still exceeds the low water mark or high water mark, the system does not delete any undelivered or unloaded files, unless the disk usage exceeds the disk allocation.

              If you check the Disable CDR/CMR Files Deletion Based on HWM check box, the system does not delete CDRs and CMRs based on the percentage that you specify in this field.

              Note   

              If CDR disk space exceeds the high water mark, the system generates the CDRHWMExceeded alert.

              Low Water Mark (%)

              This field specifies the percentage of disk space that is allocated to CDR and CMR files that is always available for use. For example, if you choose 2000 megabytes from the Disk Allocation field and 40% from the Low Water Mark (%) field, the low water mark equals 800 megabytes.

              CDR / CMR Files Preservation Duration (Days)

              Choose the number of days that you want to retain CDR and CMR files. The CDR Repository Manager deletes files that fall outside the preservation window.

              Note   

              If you continuously receive the CDRMaximumDiskSpaceExceeded alarm, you either must increase the disk allocation or lower the number of preservation days.

              Disable CDR/CMR Files Deletion Based on HWM

              Note   

              Regardless of whether you enable the deletion of files based on the high-water mark parameter, if disk usage exceeds the disk allocation that you configure, the maximum database size, or the maximum number of records for your installation, the CDR repository manager service deletes CDR and CMR files, beginning with the oldest files, until disk utilization falls below the high water mark.

              If you do not want to delete CDRs and CMRs even if disk usage exceeds the percentage that you specify in the High Water Mark (%) field, check this check box. By default, this check box remains unchecked, so the system deletes CDRs and CMRs if disk usage exceeds the high water mark.

              CDR Repository Manager Host Name

              This field lists the host name of the CDR repository manager server.

              CDR Repository Manager Host Address

              This field lists the IP address of the CDR repository manager server.

              Set up application billing servers

              Use the following procedure to configure application billing servers to which you want to send CDRs. You can configure up to three billing servers.

              Procedure
                Step 1   Choose Tools > CDR Management Configuration.

                The CDR Management Configuration window displays.

                Step 2   Perform one of the following tasks:
                1. To add a new application billing server, click the Add New button.
                2. To update an existing application billing server, click the server host name/IP address.
                Step 3   Enter the appropriate settings, as described in Table 1.
                Step 4   Click Add or Update.

                Application billing server parameter settings

                The following table describes the available settings in the Billing Application Server Parameters section of the CDR Management Configuration window.

                Table 3 Application Billing Server Parameter Settings
                Field Description

                Host Name/IP Address

                Enter the host name or IP address of the application billing server to which you want to send CDRs.

                If you change the value in this field, a prompt asks whether you want to send the undelivered files to the new destination.

                Perform one of the following tasks:
                • To deliver the files to the new server, click Yes.
                • To change the server host name/IP address without sending undelivered files, click No. The CDR Management service marks the CDR and CMR files as successfully delivered.

                User Name

                Enter the user name of the application billing server.

                Protocol

                Choose the protocol, either FTP or SFTP, that you want to use to send the CDR files to the configured billing servers.

                Directory Path

                Enter the directory path on the application billing server to which you want to send the CDRs. You should end the path that you specify with a "/" or "\", depending on the operating system that is running on the application billing server.

                Note   

                Make sure the FTP user has write permission to the directory.

                Password

                Enter the password that is used to access the application billing server.

                Resend on Failure

                When you check the Resend on Failure box, this option informs CDRM to send outdated CDR and CMR files to the billing server after the FTP or SFTP connection is restored. When the box is checked, the Resend on Failure flag is set to True. When the box is not checked, the Resend on Failure flag is set to False.1

                Generate New Key

                Click on the Reset button to generate new keys and reset the connection to the SFTP server.

                1
                There are several different scenarios that can occur. When the billing server Resend on Failure flag is set to True, all CDR files get moved to the billing server. When the Resend On Failure flag is set to False, CDR files that get generated during shutdown of the billing server get moved to the processed folder, but do not get moved to the billing server. When the Resend on Failure flag gets set to True at the beginning, and then gets changed several times, the result is that the CDR files get moved to the billing server whenever the Resend on Failure box gets checked.

                Delete application billing servers

                Use the following procedure to delete an application billing server.

                Procedure
                  Step 1   Choose Tools > CDR Management.

                  The CDR Management Configuration window displays.

                  Step 2   Check the check box next to the application billing server that you want to delete and click Delete Selected.

                  A message displays that indicates that if you delete this server, any CDR or CMR files that have not been sent to this server will not be delivered to this server and will be treated as successfully delivered files.

                  Tip   

                  When you delete a server, the system does not generate the CDRFileDeliveryFailed alert for the files that are not sent to that server.

                  Step 3   To complete the deletion, click OK.

                  Audit logs

                  With audit logging, configuration changes to the Cisco Unified Communications Manager or Cisco Unity Connection system get logged in separate log files for auditing.

                  Audit logging

                  With audit logging, configuration changes to the Cisco Unified Communications Manager or Cisco Unity Connection system get logged in separate log files for auditing. The Cisco Audit Event Service, which displays under Control Center - Network Services in Cisco Unified Serviceability, monitors and logs any configuration change to the Cisco Unified Communications Manager or Cisco Unity Connection system by a user or as a result of the user action. For a Cisco Unified Communications Manager Business Edition 5000 system, this service supports both Cisco Unified Communications Manager and Cisco Unity Connection.

                  You access the Audit Log Configuration window in Cisco Unified Serviceability to configure the settings for the audit logs.

                  Audit logging contains the following parts:

                  • Audit logging framework - The framework comprises an API that uses an alarm library to write audit events into audit logs. An alarm catalog that is defined as GenericAlarmCatalog.xml applies for these alarms. Different Cisco Unified Communications Manager or Cisco Unity Connection components provide their own logging. The following example displays an API that a Cisco Unified Communications Manager component can use to send an alarm:
                    User ID: CCMAdministratorClient IP Address: 172.19.240.207
                    Severity: 3
                    EventType: ServiceStatusUpdated
                    ResourceAccessed: CCMService
                    EventStatus: Successful
                    Description: CallManager Service status is stopped
                    
                  • Audit event logging - An audit event represents any event that is required to be logged. The following example displays a sample audit event:
                    CCM_TOMCAT-GENERIC-3-AuditEventGenerated: Audit Event Generated UserID:CCMAdministrator Client IP Address:172.19.240.207 Severity:3 EventType:ServiceStatusUpdated ResourceAccessed: CCMService EventStatus:Successful Description: Call Manager Service status is stopped App ID:Cisco Tomcat Cluster ID:StandAloneCluster Node ID:sa-cm1-3
                    

                  Tip


                  Be aware that audit event logging is centralized and enabled by default. An alarm monitor called Syslog Audit writes the logs. By default, the logs are configured to rotate. If the AuditLogAlarmMonitor cannot write an audit event, the AuditLogAlarmMonitor logs this failure as a critical error in the syslog file. The Alert Manager reports this error as part of a SeverityMatchFound alert. The actual operation continues even if the event logging fails. All audit logs get collected, viewed and deleted from Trace and Log Central in the Cisco Unified Real-Time Monitoring Tool.


                  Cisco Unified Serviceability logs the following events:

                  • Activation, deactivation, start, or stop of a service.
                  • Changes in trace configurations and alarm configurations.
                  • Changes in SNMP configurations.
                  • Changes in CDR management. ( Cisco Unified Communications Manager only)
                  • Review of any report in the Serviceability Reports Archive. This log gets viewed on the reporter node. ( Cisco Unified Communications Manager only) Cisco Unified Real-Time Monitoring Tool

                  Cisco Unified Real-Time Monitoring Tool logs the following events with an audit event alarm:

                  • Alert configuration.
                  • Alert suspension.
                  • E-mail configuration.
                  • Set node alert status.
                  • Alert addition.
                  • Add alert action.
                  • Clear alert.
                  • Enable alert.
                  • Remove alert action.
                  • Remove alert. Cisco Unified Communications Manager CDR Analysis and Reporting

                  Cisco Unified Communications Manager CDR Analysis and Reporting (CAR) creates audit logs for these events:

                  • Loader scheduling.
                  • Daily, weekly, and monthly reports scheduling.
                  • Mail parameters configuration.
                  • Dial plan configuration.
                  • Gateway configuration.
                  • System preferences configuration.
                  • Autopurge configuration.
                  • Rating engine configurations for duration, time of day, and voice quality.
                  • QoS configurations.
                  • Automatic generation/alert of pregenerated reports configurations.
                  • Notification limits configuration. Cisco Unified Communications Manager Administration

                  The following events get logged for various components of Cisco Unified Communications Manager Administration:

                  • User logging (user logins and user logouts).
                  • User role membership updates (user added, user deleted, user role updated).
                  • Role updates (new roles added, deleted, or updated).
                  • Device updates (phones and gateways).
                  • Server configuration updates (changes to alarm or trace configurations, service parameters, enterprise parameters, IP addresses, host names, Ethernet settings, and Cisco Unified Communications Manager server additions or deletions). Command-Line Interface

                  All commands issued via the command-line interface are logged (for both Cisco Unified Communications Manager and Cisco Unity Connection).

                  Cisco Unity Connection Administration

                  Cisco Unity Connection Administration logs the following events:

                  • User logging (user logins and user logouts).
                  • All configuration changes, including but not limited to users, contacts, call management objects, networking, system settings, and telephony.
                  • Task management (enabling or disabling a task).
                  • Bulk Administration Tool (bulk creates, bulk deletes).
                  • Custom Keypad Map (map updates) Cisco Personal Communications Assistant (Cisco PCA)

                  The Cisco Personal Communications Assistant client logs the following events:

                  • User logging (user logins and user logouts).
                  • All configuration changes made via the Messaging Assistant. Cisco Unity Connection Serviceability

                  Cisco Unity Connection Serviceability logs the following events:

                  • User logging (user logins and user logouts).
                  • All configuration changes.
                  • Activating, deactivating, starting or stopping services. Cisco Unity Connection Clients that Use the Representational State Transfer APIs

                  Cisco Unity Connection clients that use the Representational State Transfer (REST) APIs log the following events:

                  • User logging (user API authentication).
                  • API calls that utilize Cisco Unity Connection Provisioning Interface (CUPI).

                  Set up audit log

                  To configure the audit log, perform the following procedure:

                  Procedure
                    Step 1   In Cisco Unified Serviceability, choose Tools > Audit Log Configuration.

                    The Audit Log Configuration window displays.

                    Step 2   Configure the settings in Table 1.
                    Step 3   Click Save.
                    Tip   

                    At any time, you can click Set to Default to specify the default values. After you set the defaults, click Save to save the default values.


                    Audit log configuration settings

                    Table 1 describes the settings that you can configure in the Audit Log Configuration window in Cisco Unified Serviceability.

                    Before You Begin

                    Be aware that only a user with an audit role can change the audit log settings. By default, for Cisco Unified Communications Manager, the CCMAdministrator possesses the audit role after fresh installs and upgrades. The CCMAdministrator can assign any user that has auditing privileges to the Standard Audit Users group in the User Group Configuration window in Cisco Unified Communications Manager Administration. If you want to do so, you can then remove CCMAdministrator from the Standard Audit Users group.

                    For Cisco Unity Connection, the application administration account that was created during installation has the Audit Administrator role and can assign other administrative users to the role. You can also remove the Audit Administrator role from this account.

                    The Standard Audit Log Configuration role in Cisco Unified Communications Manager provides the ability to delete audit logs and to read/update access to Cisco Unified Real-Time Monitoring Tool, Trace Collection Tool, RTMT Alert Configuration, Control Center - Network Services in Cisco Unified Serviceability, RTMT Profile Saving, Audit Configuration in Cisco Unified Serviceability, and a resource that is called Audit Traces.

                    The Audit Administrator role in Cisco Unity Connection provides the ability to view, download and delete audit logs in Cisco Unified Real-Time Monitoring Tool.

                    For information on roles, users, and user groups in Cisco Unified Communications Manager, refer to the Cisco Unified Communications Manager Administration Guide. For information on roles and users in Cisco Unity Connection, refer to the User Moves, Adds, and Changes Guide for Cisco Unity Connection.

                    Table 4 Audit Log Configuration Settings

                    Field

                    Description

                    Select Server

                    Server

                    Choose the server where you want to configure audit logs; then, click Go.

                    Apply to All Nodes

                    If you want to apply the audit log configuration to all nodes in the cluster, check the Apply to all Nodes box.

                    Application Audit Log Settings

                    Enable Audit Log

                    When you enable this check box, an audit log gets created for the application audit log.

                    For Cisco Unified Communications Manager, the application audit log supports configuration updates for Cisco Unified Communications Manager graphical user interfaces (GUIs), such as Cisco Unified Communications Manager Administration, Cisco Unified Real-Time Monitoring Tool, Cisco Unified Communications Manager CDR Analysis and Reporting, and Cisco Unified Serviceability.

                    For Cisco Unity Connection, the application audit log supports configuration updates for Cisco Unity Connection graphical user interfaces, including Cisco Unity Connection Administration, Cisco Unity Connection Serviceability, Cisco Personal Communications Assistant, and clients that use the Connection REST APIs.

                    This setting displays as enabled by default.

                    Enable Purging

                    The Log Partition Monitor (LPM) looks at the Enable Purging option to determine whether it needs to purge audit logs. When you check this check box, LPM purges all the audit log files in RTMT whenever the common partition disk usage goes above the high water mark; however, you can disable purging by unchecking the check box.

                    If purging is disabled, the number of audit logs continues to increase until the disk is full. This action could cause a disruption of the system. A message that describes the risk of disabling the purge displays when you uncheck the Enable Purging check box. Be aware that this option is available for audit logs in an active partition. If the audit logs reside in an inactive partition, the audit logs get purged when the disk usage goes above the high water mark.

                    You can access the audit logs by choosing Trace and Log Central > Audit Logsin RTMT.

                    Enable Log Rotation

                    The system reads this option to determine whether it needs to rotate the audit log files or it needs to continue to create new files. The maximum number of files cannot exceed 5000. When the Enable Rotation option is checked, the system begins to overwrite the oldest audit log files after the maximum number of files gets reached.

                    Tip    When log rotation is disabled (unchecked), audit log ignores the Maximum No. of Files setting.

                    Maximum No. of Files

                    Enter the maximum number of files that you want to include in the log. The default setting specifies 250. The maximum number specifies 5000.

                    Maximum File Size

                    Enter the maximum file size for the audit log. The file size value must remain between 1 MB and 10 MB. You must specify a number between 1 and 10.

                    Database Audit Log Filter Settings

                    Enable Audit Log

                    When you enable this check box, an audit log gets created for the Cisco Unified Communications Manager and Cisco Unity Connection databases. Use this setting in conjunction with the Debug Audit Level setting, which allows you create a log for certain aspects of the database.

                    Debug Audit Level

                    This setting allows you to choose which aspects of the database you want to audit in the log. From the drop-down list box, choose one of the following options. Be aware that each audit log filter level is cumulative.

                    • Schema - Tracks changes to the setup of the audit log database (for example, the columns and rows in the database tables).
                    • Administrative Tasks - Tracks all administrative changes to the Cisco Unified Communications Manager system (for example, any changes to maintain the system) plus all Schema changes.
                      Tip    Most administrators will leave the Administrative Tasks setting disabled. For users who want auditing, use the Database Updates level.
                    • Database Updates - Tracks all changes to the database plus all schema changes and all administrative tasks changes.
                    • Database Reads - Tracks every read to the Cisco Unified Communications Manager system, plus all schema changes, administrative tasks changes, and database updates changes.
                      Tip    Choose the Database Reads level only when you want to get a quick look at the Cisco Unified Communications Manager or Cisco Unity Connection system. This level uses significant amounts of system resources and only should be used for a short time.

                    Enable Audit Log Rotation

                    The system reads this option to determine whether it needs to rotate the database audit log files or it needs to continue to create new files. When the Audit Enable Rotation option is checked, the system begins to overwrite the oldest audit log files after the maximum number of files gets reached.

                    When this setting is unchecked, audit log ignores the Maximum No. of Files setting.

                    Maximum No. of Files

                    Enter the maximum number of files that you want to include in the log. Ensure that the value that you enter for the Maximum No. of Files setting is greater than the value that you enter for the No. of Files Deleted on Log Rotation setting.

                    You can enter a number from 4 (minimum) to 40 (maximum).

                    No. of Files Deleted on Log Rotation

                    Enter the maximum number of files that the system can delete when database audit log rotation occurs.

                    The minimum that you can enter in this field is 1. The maximum value is 2 numbers less than the value that you enter for the Max No. of Files setting; for example, if you enter 40 in the Maximum No. of Files field, the highest number that you can enter in the No. of Files Deleted on Log Rotation field is 38.

                    Locations

                    This section explains the Locations feature (Tools > Locations) in Cisco Unified Serviceability. This feature enables an administrator to view details of the configured locations in an enterprise, understand the link and intra-location discrepancies, view effective path between the two locations, and identify disconnected groups of locations.

                    Locations Topology

                    Cisco Unified Serviceability Locations Topology provides details of configured locations in your enterprise. Location Topology refers to a modeled topology representing the flow of media in a network.

                    Listed below are some commonly used terms and their definitions:

                    Assertion

                    An assertion refers to the location and link bandwidth and weight values configured in a cluster. Asserted values may be replicated to another cluster.

                    Discrepancy

                    A discrepancy occurs if there is a difference in the location bandwidth values or link bandwidth and weight values asserted across various clusters.

                    Effective Path

                    An Effective Path is a sequence of intermediate locations connecting two end locations, with weight assigned to each link between each adjacent pair of locations. The Effective Path, as determined by the least cumulative weight, is the only path used for bandwidth deductions between any two end locations.

                    View locations topology

                    Cisco Unified Serviceability Locations Topology helps an administrator view the graphical locations topology in a tabular format. The administrator can filter required location names using the Find filter. The locations topology data includes the intralocation details and link details for a selected location.

                    This section describes how to search and view location topology in Cisco Unified Serviceability.

                    Procedure
                      Step 1   In Cisco Unified Serviceability, choose Tools > Locations > Topology

                      The Locations Topology window appears.

                      Step 2   From the Find Locations Where Location Name drop-down box, choose the filter criteria.
                      Step 3   Enter the search string in the Find Locations Where Location Name field and then click Find.
                      Note   

                      The Find Locations Where Location Name field is not case-sensitive.

                      The list of locations is displayed for the chosen filter criteria.

                      Step 4   In the list, click to expand any location to view its intralocation details and link details.

                      The intralocation details include audio, video, and immersive bandwidth whereas the link details contain the details of the link connecting two locations such as its weight, audio, video and immersive bandwidth.

                      Tip   

                      If the list of locations is long, it may run into multiple pages. To view another page, click the appropriate navigation button at the bottom of the Locations Topology window or enter a page number in the Page field. To change the number of locations that display in the window, choose a different value from the Rows Per Page drop-down box.

                      Tip   

                      If a location is highlighted by a Caution symbol, this indicates a discrepancy. To view the details of this discrepancy, click View Assertion Details link.

                      Step 5   To view the assertion details of any location, click View Assertion Details link at the bottom of the expanded details section.

                      The Assertion Details window appears.

                      Step 6   To return to the Locations Topology window, click Close.
                      Note   

                      To download the locations topology data in xml format, click Download Topology at the bottom of the Locations Topology window or Download Topology icon in the toolbar at the top.

                      For more information about the topology data in xml format, refer Cisco Unified Communications Manager XML Developers Guide.


                      View assertion details

                      The following details are displayed when you click the View Assertion Details link in Locations Topology screen (Tools > Locations > Locations Topology).

                      • Intra-location configuration assertions—Includes the intra-location assertion details such as Asserted by Cluster, Audio, Video and Immersive bandwidth. Asserted by Cluster column lists the names of all the clusters that assert a particular location.
                      • Link assertions—Includes the assertion details of the link connecting two locations such as Asserted by Cluster, Weight, Audio, Video and Immersive bandwidth.
                      Procedure

                      Locations discrepancy

                      The Locations Discrepancy screen displays the conflicts in assertions for various locations configurations.

                      The following details are displayed:

                      • Link Configuration Discrepancy—Includes the discrepancy details of the link connecting two locations such as Weight, Audio, Video and Immersive bandwidth.
                      • Intra-Location Configuration Discrepancy—Includes intra-location discrepancy details such as Audio, Video, and Immersive bandwidth.

                      View locations discrepancy

                      This section describes how to view a location discrepancy in Cisco Unified Serviceability.
                      Procedure
                        Step 1   In Cisco Unified Serviceability, choose Tools > Locations > Discrepancy.

                        The Location Discrepancy window appears.

                        Step 2   The list of link configuration discrepancies and intralocation configuration discrepancies is displayed.
                        Note   

                        The Link Configuration Discrepancy section lists only those link names where discrepancy has been detected. Link names are listed in the format <Location Name 1> <--> <Location Name 2>. The Intralocation Configuration Discrepancy section lists only those location names where such discrepancy has been detected. The elements in the list are sorted in lexical order.

                        If no discrepancies are found, the following status message is displayed:

                        No discrepancies found
                        Step 3   In the list, click on a link name or location name to expand and view its configuration details as asserted by different clusters, in a tabular view.

                        The bottom row displays the effective values considered for audio, video, and immersive bandwidth pools and weight (in the case of links). The values that do not match with the effective values are highlighted in red.

                        Note   

                        The Effective Value is the least of the values in a particular column. For example, the Effective Value of audio bandwidth is the minimum value in the Audio Bandwidth column.


                        Effective path

                        The Cisco Unified Serviceability Effective Path screen provides details of the effective path that media takes for audio, video, or immersive calls made between two locations provided by the administrator. This screen displays the Available bandwidth and the Configured bandwidth across each link and intra-location in the effective path. An administrator can use this report to determine bandwidth availability across a link and intra-location when there are bandwidth issues in making calls. Cisco Unified Serviceability Effective Path can also be used to troubleshoot bandwidth issues in making calls and find out where the bandwidth availability is low.

                        The Cisco Unified Serviceability Effective Path screen displays the following details between two selected locations:

                        • Quick Path Overview —Displays the cumulative weight and the least of the configured and available Audio, Video and Immersive Bandwidth values across the effective path.
                        • Detailed Path View—Displays the weight and bandwidth values (Available and Configured) for Audio, Video and Immersive calls for locations and links constituting the effective path, in a tabular view ordered from source location at top to the destination location at bottom.

                        Note


                        The Available bandwidth values displayed in the report are the value at the time of viewing the Effective Path. You can view the real time values in the Cisco Unified Real-Time Monitoring Tool.


                        View effective path

                        Procedure
                          Step 1   In Cisco Unified Serviceability, choose Tools > Locations > Effective Path.

                          The Effective Path window appears.

                          Step 2   From the Location drop-down boxes, select any two locations between which effective path is required and then click Find.

                          Alternatively, start typing the location name in the input box to shortlist the matching location names and then click Find.

                          The Effective path details which include the Quick Path Overview and Detailed Path View sections are displayed. If there is no path between the two selected locations, the following status message is displayed:

                          No path exists between <From_Location> and <To_Location>.


                          Disconnected groups

                          Cisco Unified Serviceability Disconnected Groups screen enables an administrator to view and analyze any disconnect between the locations that are part of the topology. It displays a list of disconnected groups of locations which helps an administrator understand which locations need to be connected.

                          The disconnect in the topology can occur when a link between two locations is not configured or a shared location name is misspelled.


                          Note


                          The Disconnected Groups screen only displays and compares disconnected groups of locations. For information on connecting locations, refer "Location Configuration" chapter in Cisco Unified Communications Manager Administration Guide.


                          View disconnected groups

                          This section describes how to view disconnected groups in Cisco Unified Serviceability.

                          Procedure
                          In Cisco Unified Serviceability, choose Tools > Locations > Disconnected Groups.

                          The Disconnected Groups screen appears.


                          The following table describes the settings displayed on the Disconnected Groups screen.

                          Table 5 Settings on the Disconnected Groups screen
                          Setting Description

                          List of Disconnected Groups

                          Select

                          Check this box to select a disconnected group to be compared with another disconnected group.

                          Caution   

                          You can select only two groups for comparison.

                          Group ID

                          Auto-generated unique identification number of the selected group is displayed here.

                          Description

                          The names of the first and last location (as per the alphabetical order) in the group are displayed here.

                          Note   

                          If a disconnected group has only one node, only the name of that node is displayed here.

                          No of Locations

                          The number of locations in a group is displayed here.

                          Compare Selected Groups

                          Click this button to display and compare the selected groups. After you click this button, the details pertaining to the selected groups are displayed.

                          For every group you select, names of the locations that are part of that group and the corresponding clusters that assert a location are displayed. See Comparison view for the selected groups below.

                          Comparison view for the selected groups

                          Location Name

                          The names of all the locations that are part of a group are listed in this column.

                          Asserted by Cluster

                          The names of all the clusters that assert a particular location are listed in this column.

                          If there are no disconnected groups of locations, the following status message is displayed:

                          No disconnected groups of locations found


                          Note


                          The List of Disconnected Groups can be sorted by any column. By default, the groups are sorted by the No of Locations column.