Cisco Intercompany Media Engine Installation and Configuration Guide, Release 9.0(1)
Cisco Intercompany Media Engine and RTMT
Downloads: This chapterpdf (PDF - 502.0KB) The complete bookPDF (PDF - 3.19MB) | Feedback

Cisco Intercompany Media Engine and RTMT

Cisco Intercompany Media Engine and RTMT

RTMT provides a set of default monitoring objects that assist you in monitoring the health of the Cisco Intercompany Media Engine product. You monitor the Cisco Intercompany Media Engine product on the Cisco IME server and on the Cisco Unified Communications Manager server. The objects on the Cisco Unified Communications Manager contain information about learned routes and call activities. The objects on the Cisco IME server contain information about network and server activity.

The system logs data every five minutes for predefined counters.

Install RTMT

A single copy of RTMT that is installed on your computer lets you monitor only one server or one cluster at a time. For example, you can monitor either of the following entities:
  • A Cisco Unified Communications Manager product on one server
  • A server on a cluster to monitor the health of the cluster

To monitor a product on a different server, such as the Cisco Intercompany Media Engine product on the Cisco IME server, you must first log off the server before you can log on to the other server.


Note


When you install RTMT on a Windows Vista platform, the following User Account Control pop-up message displays: "An unidentified program wants to access your computer." Click Allow to continue working with RTMT. Also, when you launch RTMT, log into the same product type from which you downloaded the RTMT client application. If you log into a different product type, RTMT will not launch nor work properly.


To install RTMT from the Cisco IME server, perform the following procedure:

Before You Begin
Consider the following, before you install RTMT:
  • On a client machine, you can install RTMT client downloaded from only one product type such as Cisco Unified Communications Manager or Cisco Intercompany Media Engine. Installing RTMT client from different product types on the same client machine is not supported.
  • The current RTMT download may not support earlier releases of Cisco Unified Communications Manager. Some releases of Cisco Unified Communications Manager may require different versions of RTMT to be installed on your computer (one version per Cisco Unified Communications Manager release). Verify that the RTMT version that you install is compatible with the Cisco Unified Communications Manager that you are monitoring. If the RTMT version that you are using is not compatible with the server that you want to monitor, the system prompts you to download the compatible version.
  • Your computer stores the user preferences, such as the IP address and RTMT frame size, from the RTMT client that last exits.
Procedure
    Step 1   In the address bar of a web browser, enter the following case-sensitive URL:

    https://<Cisco IME-server-name>:{8443}/ast/rtmtinstaller.jsp

    Where <Cisco IME-server-name> equals the name or IP address of the Cisco IME server. You can optionally specify a port number.

    Note   

    Microsoft Internet Explorer has a known bug, which does not let you download IME RTMT from an IME server. You can use other browsers like FireFox, Safari, and so forth.

    A Security Alert dialog box displays.
    Step 2   Enter the administrator username and password that you specified during installation.
    Step 3   Do one of the following:
    • If you are planning to install the RTMT tool on a computer that is running the Microsoft Windows operating system, click the RTMT Windows Installer link.
    • If you are planning to install the RTMT tool on a computer that is running the Linux operating system, click the RTMT Linux Installer link.
    Step 4   Download the executable to the preferred location on your client.
    Step 5   Complete one of the following steps to install the RTMT on your operating system:
    • To install the Windows version, double-click the RTMT icon that displays on the desktop or locate the directory where you downloaded the file and run the RTMT installation file.
    • To install the Linux version, ensure that the file has execute privileges; for example, enter the following command, which is case sensitive: chmod +x CcmServRtmtPlugin.bin.
    The extraction process begins.
    Step 6   After the RTMT welcome window displays, click Next.
    Step 7   To accept the license agreement, click I accept the terms of the license agreement and click Next.
    Step 8   Choose the location where you want to install RTMT and click Next.
    Default installation paths specify the following:
    • Windows - C:\Program Files\Cisco\Unified-Communications-Manager Serviceability\JRtmt
    • Linux - /opt/Cisco/Unified-Communications-Manager_Serviceability/JRtmt
    Step 9   To begin the installation, click Next. The Setup Status window displays. Do not click Cancel.
    Step 10   To complete the installation, click Finish.

    Uninstall RTMT

    Perform the following procedures to uninstall the RTMT from your oeprating system.

    • On a Windows client, you uninstall RTMT through Add/Remove Programs in the Control Panel. Click Start > Settings > Control Panel > Add/Remove Programs.

      Note


      When you uninstall RTMT on a Windows Vista machine, the following User Account Control pop-up message displays: An unidentified program wants to access your computer. Click Allow to continue working with the RTMT.


    • To uninstall RTMT on a Hat Linux with the KDE or Gnome client, click Start > Accessories > Uninstall Real-time Monitoring tool from the task bar.

    Launch RTMT

    Perform the following tasks to launch the RTMT on your operating system.


    Note


    When you use RTMT on a Windows Vista machine, the following User Account Control pop-up message displays: An unidentified program wants to access your computer. Click Allow to continue working with the RTMT.


    Procedure
      Step 1   After you install the plug-in, perform one of the following tasks:
      • From your Windows desktop, double-click the Real-Time Monitoring Tool icon.
      • Choose Start > Programs > Cisco > Unified-Communications-Manager Serviceability > Real-Time Monitoring Tool > Real-Time Monitoring Tool.
      The Real-Time Monitoring Tool Login window displays.
      Step 2   In the Host IP Address field, enter either the IP address or host name of the server or (if applicable) first server in a cluster.
      Step 3   In the User Name field, enter the administrator username for the application.
      Step 4   In the Password field, enter the administrator password that you established for the username. If the authentication fails or if the server is unreachable, the tool prompts you to re-enter the server and authentication details; or, you can click the Cancel button to exit the application. After the authentication succeeds, RTMT launches the monitoring module from local cache or from a remote server, when the local cache does not contain a monitoring module that matches the backend version.
      Step 5   Enter the port that the application will use to listen to the server.

      The default setting specifies 8443.

      The Trace and Log Central tool in RTMT uses the port number that you specify to communicate with all the nodes in a cluster. If your system uses port mapping and all Cisco Intercompany Media Engine nodes do not map to the same port number, some RTMT tools can not connect to those nodes. The tools that will fail to connect include Trace and Log Central, Job Status, SyslogViewer, Perfmon Log Viewer, and FTP/SFTP Configuration.

      Step 6   Select the Secure Connection checkbox.
      Step 7   Click OK.
      Step 8   When prompted, add the certificate store by clicking Yes. Real-Time Monitoring Tool RTMT starts.

      RTMT window components

      The RTMT window contains the following main components:
      Menu Bar
      Includes some or all of the following menu options, depending on your configuration:
      • File - Allows you to save, restore, and delete existing RTMT profiles, monitor Java Heap Memory Usage, go to the Serviceability Report Archive window in Cisco Unified Serviceability, log off, or exit RTMT.

        Note


        The RTMT menu option File > Cisco Unified Reporting lets you access Cisco Unified Reporting from RTMT. You can use the Cisco Unified Reporting application to snapshot Cisco Unified Communications Manager cluster data for inspection or troubleshooting. Refer to the Cisco Unified Reporting Administration Guide for more information.


      • System - Allows you to monitor system summary, monitor server resources, work with performance counters, work with alerts, collect traces, and view syslog messages.
      • Communications Manager - Allows you to view Cisco Unified Communications Manager summary information on the server; monitor call-processing information; and view and search for devices, monitor services, and CTI.
      • Unity Connection - Allows you to view the Port Monitor tool.
      • IME Service - Allows you monitor server and network activity of the Cisco Intercompany Media Engine server.
      • Edit - Allows you to configure categories (for table format view), set the polling rate for devices and performance monitoring counters, hide the quick launch channel, and edit the trace setting for RTMT.
      • Window - Allows you to close a single RTMT window or all RTMT windows.
      • Application - Depending on your configuration, allows you to browse the applicable web pages for Cisco Unified Communications Manager Administration, Cisco Unified Serviceability, Cisco Unity Connection Administration, and Cisco Unity Connection Serviceability.
      • Help - Allows you to access RTMT documentation online help or to view the RTMT version.
      Quick Launch Channel
      You can click this pane with tabs on the left side of the RTMT window to display information about the server or information about the applications. The tab contains groups of icons that you can click to monitor various objects.
      Monitor pane
      Pane where monitoring results display.

      Predefined Cisco Intercompany Media Engine objects in RTMT

      RTMT provides a set of predefined monitoring objects that assist you in monitoring the health of the Cisco Intercompany Media Engine feature. On the Cisco Unified Communications Manager server, you can monitor the call processing activity and routing activity of Cisco IME calls. On the Cisco Intercompany Media Engine server, you can monitor a variety of statistics related to Internet bandwidth and IME distributed cache status. You need objects from both servers to monitor the performance of the Cisco Intercompany Media Engine product.

      Intercompany Media Services monitored items


      Tip


      The polling rate in each precanned monitoring window remains fixed, and the default value specifies 30 seconds. If the collecting rate for the AMC (Alert Manager and Collector) service parameter changes, the polling rate in the precanned window also updates. In addition, the local time of the RTMT client application, not the backend server time, provides the basis for the time stamp in each chart.



      Tip


      To zoom in on the monitor of a predefined object, click and drag the left mouse button over the area of the chart that interests you. Release the left mouse button when you have the selected area. RTMT updates the monitored view. To zoom out and reset the monitor to the initial default view, press the R key.


      The Intercompany Media Services monitoring category monitors the following items:

      Routing
      Displays the total number of Cisco Intercompany Media Engine routes that Cisco Unified Communications Manager maintains. This total includes the following routes:
      • Learned routes that represent the phone numbers that the Cisco Intercompany Media Engine client learned and that exist in the Cisco Unified Communications Manager routing tables
      • Unique domains of peer enterprises for which Cisco Intercompany Media Engine routes exist
      • Published routes that represent the number of direct inward dialing numbers (DIDs) that were published successfully to the IME distributed hash table across all Cisco Intercompany Media Engine services
      • Rejected routes that represent the number of learned routes that got rejected because the administrator blocked them.
      • These charts represent the following performance counters for the Cisco IME Client performance object: RoutesLearned, DomainsUnique, RoutesPublished, and RoutesRejected.
      • To display information on routing, click CallManager > Cisco IME Client > Routing.
      Call activities
      Allows you to monitor the total number of Cisco Intercompany Media Engine calls. This total includes the following types of calls:
      • Calls that were attempted (including calls that were accepted, busy, no answer, and failed)
      • Calls that were received
      • Calls that were set up (that is, made by Cisco Unified Communications Manager and accepted by the remote party)
      • Calls that were accepted (that is, received by Cisco Unified Communications Manager and answered by the called party)
      • Calls that completed fallback to the PSTN
      • Calls that did not successfully fallback to the PSTN. These charts represent the following performance counters for the Cisco IME Client performance object: CallsAttempted, CallAccepted, CallsReceived, CallsSetup, IMESetupsFailed, and FallbackCallsFailed. To display information on call activities, click CallManager > Cisco IME Client  > Call Activities.

      For more information about available objects and counters, see Cisco Intercompany Media Engine performance objects and counters.

      Cisco IME server objects

      IME service monitored items

      The IME Service category monitors the following items:
      Network activity
      Displays the activity on the Cisco Unified Communications Manager that relates to Cisco Intercompany Media Engine. The Network Activity object displays these charts:
      • IME distributed cache health - Displays the health of the IME distributed cache based on the IMEDistributedCacheHealth counter for the IME Server performance object.
      • IME distributed node count - Displays an approximation of the number of nodes in the IME distributed cache, based on the value of the IMEDistributedCacheNodeCount counter for the IME Server performance object. Because each physical Cisco Intercompany Media Engine server contains multiple nodes, the number that displays in the chart does not indicate the number of physical Cisco Intercompany Media Engine servers that participate in the IME distributed cache.
      • Internet BW received - Displays the amount of bandwidth in Kbits/s that the Cisco IME service uses for incoming Internet traffic and represents the InternetBandwidthRecv counter for the IME Server performance object.
      • Internet BW send - Displays the amount in Kbits/s that the Cisco IME service uses for outgoing Internet traffic and represents the InternetBandwidthSend counter for the IME Server performance object.
      • IME distributed cache stored data records - Displays the number of IME Distributed Cache records that the Cisco Intercompany Media Engine server stores and represents the IMEDistributedCacheStoredData counter for the IME Server performance object. To display information on network activity, click Cisco IME Service > Network Activity.
      Server activity
      Allows you to monitor the activity on the Cisco Intercompany Media Engine server. The Server Activity object displays these charts:
      • Number of registered clients - Displays the current number of clients that connect to the Cisco IME service and represents the value of the ClientsRegistered counter for the IME Server performance object.
      • IME distributed cache quota - Indicates the number of individual DIDs that can be written into the IME Distributed Cache, by Cisco Unified CMs attached to this IME server. This number is determined by the overall configuration of the IME Distributed Cache, and the IME license installed on the IME server.
      • IME distributed cache quota used - Indicates the total number of unique DID numbers that have been configured, to be published via enrolled patterns for Intercompany Media Services, by Cisco Unified CMs currently attached to this IME server.
      • Terminating VCRs - Indicates the total number of IME voice call records that are stored on the Cisco IME server for the terminating side of a call. These records can be used for validation of learned routes.
      • Validations pending - Displays the number of pending validations on the Cisco IME service as well as the threshold for validations. This chart represents the ValidationsPending counter for the Cisco IME Server performance object. To display information on server activity, click Cisco IME Service > Server Activity.

      For more information about available objects and counters, see Cisco Intercompany Media Engine performance objects and counters.

      Monitor IME system performance

      Procedure
        Step 1   To display information on the SDL Queue, clickCisco IME Service > SDL Queue.
        Step 2   Select the type from the SDL Queue Type drop-down list box.

        For more information about available objects and counters, see Cisco Intercompany Media Engine performance objects and counters.


        Trace and log central

        The trace and log central feature in the Cisco Unified Real Time Monitoring Tool (RTMT) allows you to configure on-demand trace collection for a specific date range or an absolute time. You can collect trace files that contain search criteria that you specify and save the trace collection criteria for later use, schedule one recurring trace collection and download the trace files to a FTP or SFTP server on your network or to local (localhost) files on the Cisco IME, or collect a crash dump file.

        If you download trace files to the localhost directories on the Cisco IME, you can access the files by opening an SFTP client. You connect to the Cisco IME server by using the adminsftp that you configured during installation.

        For more information on using RTMT to collect traces, refer to the Cisco Unified Real Time Monitoring Tool Administration Guide.