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

Cisco Unified Serviceability

Cisco Unified Serviceability

Introduction


Note


This document uses the following abbreviations to identify administration differences for these Cisco products:

Unified CM refers to Cisco Unified Communications Manager

Unified CM BE 5000 refers to Cisco Unified Communications Manager Business Edition 5000

Connection refers to Cisco Unity Connection


Overview

Cisco Unified Serviceability, a web-based troubleshooting tool, provides the following functionality:

  • Saves alarms and events for troubleshooting and provides alarm message definitions.
  • Saves trace information to various log files for troubleshooting.
  • Monitors real-time behavior of components through the Cisco Unified Real-Time Monitoring Tool (RTMT).
  • Unified CM and Unified CM BE only: Generates Cisco Unified Communications Manager reports for Quality of Service, traffic, and billing information through Cisco Unified Communications Manager CDR Analysis and Reporting (CAR).
  • Provides audit capability by logging any configuration changes to the system by a user or as a result of the user action. This functionality supports the Information Assurance feature of Cisco Unified Communications Manager and Cisco Unity Connection.
  • Provides feature services that you can activate, deactivate, and view through the Service Activation window.
  • Provides an interface for starting and stopping feature and network services.
  • Generates and archives daily reports; for example, alert summary or server statistic reports.
  • Allows Cisco Unified Communications Manager and Cisco Unity Connection to work as a managed device for SNMP remote management and troubleshooting.
  • Monitors the disk usage of the log partition on a server.
  • Monitors the number of threads and processes in the system; uses cache to enhance the performance.

Tip


Cisco RIS Data Collector provides Process and Thread statistic counters in the Cisco Unified Real-Time Monitoring Tool. To configure the maximum number of processes and threads that are allowed, so Cisco RIS Data Collector can provide these associated counters, access the Maximum Number of Threads and Process service parameter for the Cisco RIS Data Collector service in the administration interface for your configuration.

Unified CM and Unified CM BE: For information on configuring service parameters, refer to the Cisco Unified Communications Manager Administration Guide.

Connection: For information on configuring service parameters, refer to the System Administration Guide for Cisco Unity Connection.



Tip


Unified CM BE and Connection only: For Cisco Unity Connection, you must perform serviceability-related tasks in both Cisco Unified Serviceability and Cisco Unity Connection Serviceability; for example, you may need to start and stop services, view alarms, and configure traces in both applications to troubleshoot a problem.

Cisco Unified Serviceability supports the functionality that is described in the Cisco Unified Serviceability Administration Guide; for tasks that are specific to Cisco Unity Connection Serviceability, refer to the Cisco Unity Connection Serviceability Administration Guide.


Reporting tools

Cisco Unified Serviceability provides the following reporting tools:

  • Cisco Unified Real-Time Monitoring Tool (RTMT) - Monitors real-time behavior of components through RTMT; creates daily reports that you can access through the Serviceability Reports Archive. For more information, refer to the Cisco Unified Real-Time Monitoring Tool Administration Guide.
  • Serviceability Reports Archive - Archives reports that the Cisco Serviceability Reporter service generates.
  • Unified CM and Unified CM BE only: Cisco Unified Communications Manager CDR Analysis and Reporting (CAR) - Generates Cisco Unified Communications Manager reports for Quality of Service, traffic, and billing information through Cisco Unified Communications Manager CDR Analysis and Reporting (CAR). For more information, refer to the CDR Analysis and Reporting Administration Guide.
  • Unified CM and Unified CM BE only: Cisco Unified Communications Manager Dialed Number Analyzer - Allows you to test and diagnose a deployed Cisco Unified Communications Manager dial plan configuration, analyze the test results, and use the results to tune the dial plan. For more information on how to access and use Dialed Number Analyzer, refer to the Cisco Unified Communications Manager Dialed Number Analyzer Guide.
  • Unified CM and Unified CM BE only: Cisco Unified Reporting Web Application - Allows you to inspect or troubleshoot data for a standalone server or a cluster. This application, which is separate from Cisco Unified Serviceability, combines data by category from all accessible Cisco Unified Communications Manager servers in a cluster into one output view. Some reports run health checks to identify conditions that could impact server or cluster operations. If you are an authorized user, you access Cisco Unified Reporting in the main navigation menu in Cisco Unified Communications Manager Administration or with theFile > Cisco Unified Reporting link on the RTMT menu. Refer to the Cisco Unified Reporting Administration Guide for more information

Note


On Cisco Unified Communications Manager Business Edition 5000 servers, the Cisco Unified Reporting application captures data for Cisco Unified Communications Manager only. Due to size constraints, the application does not capture data for Cisco Unity Connection. On these servers, you can use this tool to gather important information about your Cisco Unified Communications Manager installation.


Remote serviceability tools


Note


The content in this section does not apply to Cisco Unity Connection.


To supplement the management and administration of the Cisco Unified Communications Manager system, you can use remote serviceability tools. Using these tools, you can gather system and debug information for diagnostic help or remote troubleshooting. The tools can process and report on a collection of local or remote Cisco Unified Communications Manager configuration information. With customer permission, technical support engineers log on to a Cisco Unified Communications Manager server and get a desktop or shell that allows them to perform any function that could be done from a local logon session.

Cisco Unified Communications Manager supports the following capabilities for remote serviceability:

  • Simple Network Management Protocol (SNMP) - Provides remote management for managed devices such as Cisco Unified Communications Manager
  • Show Command Line Interface - Displays Cisco Unified Communications Manager system data.
  • CiscoWorks Lan Management Solution - Purchased separately from Cisco Unified Communications Manager, supports maintenance of Cisco networks and devices. The following features, which serve as examples only, show how you can use CiscoWorks Lan Management Solution to manage Cisco Unified Communications Manager operations: Path Analysis defines Cisco Unified Communications Manager system paths in the form of maps, trace logs, or discovery tables. Path Analysis, which traces connectivity between two specified points in your network, requires that you enable CDR logging in Cisco Unified Communications Manager Administration. Syslog Analysis tools monitor and manage a wide range of events and error messages concurrently on each Cisco Unified Communications Manager server and other Cisco devices at your site. Cisco Discovery Protocol (CDP) enables discovery of Cisco Unified Communications Manager servers and management of those servers by CiscoWorks Lan Management Solution. After you use the CDP cache MIB of the direct neighboring device to discover Cisco Unified Communications Manager, you can use CiscoWorks Lan Management Solution to query other Cisco Unified Communications Manager-supported MIBs for provisions or statistics information about topology services, user tracking, path analysis, and other network management services. When you use CiscoWorks Lan Management Solution, you must keep the CDP driver enabled at all times to discover Cisco Unified Communications Manager.

Log-on message

You can upload a text file that contains a customized log-on message that appears on the initial Cisco Unified Serviceability window.

For more information and the procedure for uploading your customized log-on message, refer to the Cisco Unified Communications Operating System Administration Guide.

Browser support

Cisco supports these browsers with Cisco Unified Serviceability:

Table 1 Supported Browsers and Operating Systems

You can access Cisco Unified Communications Manager with this browser...

...if you use one of these operating systems

Microsoft Internet Explorer 7

Microsoft Windows XP SP3

Microsoft Internet Explorer 8

  • Microsoft Windows XP SP3
  • Microsoft Windows Vista SP2

Mozilla Firefox 3.x

  • Microsoft Windows XP SP 3
  • Microsoft Windows Vista SP
  • Apple Mac OS X

Safari 4.x

Apple Mac OS X

To access Cisco Unified Serviceability, you must browse to the application from a machine that runs the supported browser.


Note


Cisco Unified Communications Manager CDR Analysis and Reporting, which is a Cisco Unified Serviceability tool, supports these same browsers. Cisco Unified Real-Time Monitoring Tool, a separate plug-in, supports a different set of browsers. Refer to the Cisco Unified Real-Time Monitoring Tool Administration Guide for more information.


Cisco Unified Serviceability uses HTTPS to establish secure connections.


Tip


Cisco Unified Serviceability does not support the buttons in your browser. Do not use the browser controls, for example, the Back button, when you perform configuration tasks.


Installation

Access

You can access the Serviceability application

  • by entering https://<server name or IP address>:8443/ccmservice/ in a browser window and then entering a valid username and password.
  • by choosing Cisco Unified Serviceability in the Navigation menu in the Cisco Unified Communications Manager Administration console.
  • by choosingApplication > Serviceability Webpage in the Real-Time Monitoring Tool (RTMT) menu and then entering a valid username and password
  • by choosing Cisco Unified Serviceability in the Navigation menu in Cisco Unity Connection.

Tip


After you log in to Cisco Unified Serviceability, you can access all administrative applications that display in the Navigation menu, except for Cisco Unified OS Administration and Disaster Recovery System, without logging in again. The web pages that you can access within Cisco Unified Serviceability depend on your assigned roles and privileges. Cisco Unified OS Administration and Disaster Recovery System require a separate authentication procedure.


The system uses the Cisco Tomcat service to authenticate users before allowing access to the web application.


Tip


Unified CM and Unified CM BE only: Any user who has the "Standard CCM Admin Users" role assigned can access Cisco Unified Serviceability. For information on how to assign this role to a user, refer to the Cisco Unified Communications Manager Administration Guide.



Tip


Connection only: Any user who has the System Administrator role or Technician role assigned can access Cisco Unified Serviceability. For information on how to assign this role to a user, refer to the User Moves, Adds, and Changes Guide for Cisco Unity Connection.


If you get a security alert that the site is not trusted, this indicates that the server certificate has not yet downloaded.

To access Cisco Unified Serviceability, perform the following procedure:

Procedure
    Step 1   In a supported browser, browse to the server where the Cisco Unified Serviceability service runs.
    Tip   

    In the supported browser, enter https://<server name or IP address>:8443/ccmservice/, where server name or IP address equals the server where the Cisco Unified Serviceability service runs and 8443 equals the port number for HTTPS.

    Tip   

    If you enter http://<server name or IP address>:8080 in the browser, the system redirects you to use HTTP. HTTP uses the port number, 8080.

    Step 2   If the system prompts you about certificates, see topics related to installing the server certificate.
    Step 3   Enter a valid username and password; click Login.

    To clear the username and password, click Reset.


    Install server certificate


    Note


    For additional information about using HTTPS with Cisco Unified Communications Manager, refer to Cisco Unified Communications Manager Security Guide.


    Hypertext Transfer Protocol over Secure Sockets Layer (SSL), which secures communication between the browser client and the Tomcat web server, uses a certificate and a public key to encrypt the data that is transferred over the internet. HTTPS, which ensures the identity of the server, supports applications, such as Cisco Unified Serviceability. HTTPS also ensures that the user login password transports securely via the web.


    Note


    Due to the way IE 7 handles certificates, this browser displays an error status after you import the server certificate. This status persists if you reenter the URL or refresh or relaunch the browser and does not indicate an error. Refer to the Install Internet Explorer 7 certificate for more information.


    HTTPS

    On the first attempt to access Cisco Unified Serviceability, a Security Alert dialog box, which indicates that the server is not trusted because the server certificate does not exist in the trusted folder, displays. When the dialog box displays, perform one of the following tasks:

    • By clicking Yes, you choose to trust the certificate for the current web session only. If you trust the certificate for the current session only, the Security Alert dialog box displays each time that you access the application: that is, until you install the certificate in the trusted folder.
    • By clicking View Certificate > Install Certificate, you indicate that you intend to perform certificate installation tasks, so you always trust the certificate. If you install the certificate in the trusted folder, the Security Alert dialog box does not display each time that you access the web application.
    • By clicking No, you cancel the action. No authentication occurs, and you cannot access the web application.

    Note


    The system issues the certificate by using the hostname. If you attempt to access a web application by using the IP address, the Security Alert dialog box displays, even though you installed the certificate.


    Install Internet Explorer 7 certificate

    Internet Explorer 7 adds security features that change the way that the browser handles Cisco certificates for website access. Because Cisco provides a self-signed certificate for the Cisco Unified Communications Manager or Cisco Unity Connection server, Internet Explorer 7 flags the Cisco Unified Communications Manager Administration or Cisco Unity Connection website as untrusted and provides a certificate error, even when the trust store contains the server certificate.


    Note


    Internet Explorer 7, which is a Windows Vista feature, also runs on Windows XP Service Pack 2 (SP2), Windows XP Professional x64 Edition, and Windows Server 2003 Service Pack 1 (SP1). Java Runtime Environment (JRE) must be present to provide Java-related browser support for IE.


    Be sure to import the Cisco Unified Communications Manager or Cisco Unity Connection certificate to Internet Explorer 7 to secure access without having to reload the certificate every time that you restart the browser. If you continue to a website that has a certificate warning and the certificate is not in the trust store, Internet Explorer 7 remembers the certificate for the current session only.

    After you download the server certificate, Internet Explorer 7 continues to display certificate errors for the website. You can ignore the security warnings when the Trusted Root Certificate Authority trust store for the browser contains the imported certificate.

    The following procedure describes how to import the Cisco Unified Communications Manager or Cisco Unity Connection certificate to the root certificate trust store for Internet Explorer 7.

    Procedure
      Step 1   Browse to application on the Tomcat server by entering the hostname (server name) or IP address in the browser.

      The browser displays a Certificate Error: Navigation Blocked message to indicate that this website is untrusted.

      Step 2   To access the server, click Continue to this website (not recommended)

      The administration window displays, and the browser displays the address bar and Certificate Error status in red.

      Step 3   To import the server certificate, click the Certificate Error status box to display the status report. Click the View Certificates link in the report.
      Step 4   Verify the certificate details.

      The Certification Path tab displays "This CA Root certificate is not trusted because it is not in the Trusted Root Certification Authorities store."

      Step 5   Select the General tab in the Certificate window and click Install Certificate.

      The Certificate Import Wizard launches.

      Step 6   To start the Wizard, click Next.

      The Certificate Store window displays.

      Step 7   Verify that the Automatic option, which allows the wizard to select the certificate store for this certificate type, is selected and click Next.
      Step 8   Verify the setting and click Finish.

      A security warning displays for the import operation.

      Step 9   To install the certificate, click Yes.

      The Import Wizard displays "The import was successful."

      Step 10   Click OK. The next time that you click the View certificates link, the Certification Path tab in the Certificate window displays "This certificate is OK."
      Step 11   To verify that the trust store contains the imported certificate, click Tools > Internet Options in the Internet Explorer toolbar and select the Content tab. Click Certificates and select the Trusted Root Certifications Authorities tab. Scroll to find the imported certificate in the list.

      After importing the certificate, the browser continues to display the address bar and a Certificate Error status in red. The status persists even if you reenter the hostname or IP address or refresh or relaunch the browser.


      Serviceability interface

      In addition to performing troubleshooting and service-related tasks in Cisco Unified Serviceability, you can perform the following tasks:

      • Unified CM and Unified CM BE only: To access Dialed Number Analyzer to test and diagnose a deployed Cisco Unified Communications Manager dial plan configuration, analyze the test results and use the results to tune the dial plan, activate the Cisco Dialed Number Analyzer service by choosing Tools > Service Activation and choosing Tools > Dialed Number Analyzer. The Cisco Dialed Number Analyzer Server service needs to be activated along with The Cisco Dialed Number Analyzer service by choosing Tools > Service Activation and choosing Tools > Dialed Number Analyzer Server. This service needs to be activated only on the node that is dedicated specifically for the Cisco Dialed Number Analyzer service. For more information on how to use the Dialed Number Analyzer, refer to the Cisco Unified Communications Manager Dialed Number Analyzer Guide.
      • Unified CM and Unified CM BE only: To access Cisco Unified Communications Manager CDR Analysis and Reporting from Tools > CDR Analysis and Reporting, perform the required procedures, as described in the CDR Analysis and Reporting Administration Guide.

        Note


        You cannot access the Cisco Unified Communications Manager CDR Analysis and Reporting tool unless you are a member of the Cisco CAR Administrators user group. Refer to the "Configuring the CDR Analysis and Reporting Tool" chapter in the CDR Analysis and Reporting Administration Guide for information on how to become a member of the Cisco CAR Administrators user group.


      • To display documentation for a single window, choose Help > This Pagein Cisco Unified Serviceability.
      • To display a list of documents that are available with this release (or to access the online help index), choose Help > Contentsin Cisco Unified Serviceability.
      • To verify the version of Cisco Unified Serviceability that runs on the server, choose Help > About or click the About link in the upper, right corner of the window.
      • To go directly to the home page in Cisco Unified Serviceability from a configuration window, choose Cisco Unified Serviceability from the Navigation drop-down list box in the upper, right corner of the window.

        Note


        In some scenarios, you cannot access the Cisco Unified Serviceability from Cisco Unified OS Administration. A "Loading, please wait" message displays indefinitely. If the redirect fails, log out from Cisco Unified OS Administration, select Cisco Unified Serviceability from the navigation menu, and log in to Cisco Unified Serviceability.


      • To access other application GUIs, choose the appropriate application from the Navigation drop-down list box in the upper, right corner of the window; then, click Go.
      • To log out of Cisco Unified Serviceability, click the Logout link in the upper, right corner of the Cisco Unified Serviceability window.
      • In each Cisco Unified Serviceability configuration window, configuration icons display that correspond to the configuration buttons at the bottom of the window; for example, you can either click the Save icon or the Save button to complete the task.

      Tip


      Cisco Unified Serviceability does not support the buttons in your browser. Do not use the browser buttons, for example, the Back button, when you perform configuration tasks.



      Tip


      When a session has been idle for more than 30 minutes, the Cisco Unified Serviceability user interface allows you to make changes before indicating that the session has timed out and redirecting you to the login window. After you log in again, you may have to repeat those changes. This behavior occurs in the Alarm, Trace, Service Activation, Control Center, and SNMP windows. If you know that the session has been idle for more than 30 minutes, log out by using the Logout button before making any changes in the user interface.


      Accessibility features

      Cisco Unified Serviceability provides functionality for users that allows them to access buttons on the window without using a mouse. These navigation shortcuts assist visually impaired or blind attendants to use the application.

      Use Table 1 as a guide for navigating the interface by using keyboard shortcuts.

      Table 2 Navigation Shortcuts for Cisco Unified Serviceability

      Keystroke

      Action

      Alt

      Moves focus to the browser menu bar.

      Enter

      Chooses the item with focus (menu option, button, and so on.)

      Alt, arrow keys

      Moves between browser menus.

      Alt+underlined letter

      Takes you to the menu; for example, Alt+A moves you to the Alarms menu.

      Spacebar

      Toggles control; for example, checks and unchecks a check box.

      Tab

      Moves focus to the next item in the tab order or to next control group.

      Shift+Tab

      Moves focus to the previous item or group in the tab order.

      Arrow keys

      Moves among controls within a group.

      Home

      Moves to the top of the window if more than one screenful of information exists. Also, moves to the beginning of a line of user-entered text.

      End

      Moves to the end of a line of user-entered text.

      Moves to the bottom of the window if more than one screenful of information exists.

      Page Up

      Scrolls up one screen.

      Page Down

      Scrolls down one screen.