Cisco Unified Analysis Manager Installation and Setup

This chapter provides information to install Cisco Unified Real-Time Monitoring Tool (RTMT), which works for resolutions 800*600 and above, on a computer that is running Windows 8.1, Windows 10, Windows 2000, Windows Vista, or Linux with KDE and/or Gnome client.


Note

RTMT requires at least 128 MB in memory to run on a Windows operating system platform.

Install Cisco Unified Real-Time Monitoring Tool

To install the tool, perform the following procedure:


Note

While installing Cisco Unified Real-Time Monitoring Tool on a Windows Vista platform, you will see a User Account Control pop-up message that says, "An unidentified program wants to access your computer." Click Allow to continue working with Cisco Unified Real-Time Monitoring Tool.

Procedure
    Step 1   Go to the Plug-ins window of the administration interface for your configuration:

    Cisco Unified Communications Manager

    From Cisco Unified Communications Manager Administration, choose Application > Plugins.

    Cisco Business Edition 5000

    From Cisco Unified Communications Manager Administration, choose Application > Plugins.

    Cisco Unity Connection

    From Cisco Unity Connection Administration, choose System Settings > Plugins.

    Step 2   Click the Find button.
    Step 3   To install the Cisco Unified Real-Time Monitoring Tool on a client that is running the Microsoft Windows operating system, click the Download link for the Cisco Unified Communications Manager Real-Time Monitoring Tool-Windows.
    Step 4   To install the Cisco Unified Real-Time Monitoring Tool on a client that is running the Linux operating system, click the Download link for the Cisco Unified Communications Manager Real-Time Monitoring Tool-Linux.
    Step 5   Download the executable to the preferred location on your client.
    Step 6   To install the Windows version, double-click the Cisco Unified Real-Time Monitoring Tool icon that displays on the desktop or locate the directory where you downloaded the file and run the Cisco Unified Real-Time Monitoring Tool installation file.

    The extraction process begins.

    Step 7   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
    Step 8   After the Unified Real-Time Monitoring Tool welcome window displays, click Next.

    To accept the license agreement, click I accept the terms of the license agreement; then, click Next.

    Step 9   Choose the location where you want to install Cisco Unified Real-Time Monitoring Tool. If you do not want to use the default location, click Browse and navigate to a different location. Click Next.
    Step 10   To begin the installation, click Next.

    The Setup Status window displays. Do not click Cancel.

    Step 11   To complete the installation, click Finish.

    Uninstall Cisco Unified Real-Time Monitoring Tool and Cisco Unified Analysis Manager

    On a Windows client, use Add/Remove Programs under the Control Panel to uninstall Unified Real-Time Monitoring Tool and Cisco Unified Analysis Manager (Unified Analysis Manager).

    Launch Cisco Unified Analysis Manager


    Caution

    Unified Communications Manager clusters only. You must configure a second server as the failover collector in Cisco Unified Communications Manager Administration, so Cisco Unified Real-Time Monitoring Tool can continue to retrieve information if the primary collector fails.


    Note

    While using Cisco Unified Real-Time Monitoring Tool on a Windows Vista machine, you will see a User Account Control pop-up message that says "An unidentified program wants to access your computer." Click Allow to continue working with Cisco Unified Real-Time Monitoring Tool.

    The Unified Analysis Manager application is not displayed when Cisco Unified Real-Time Monitoring Tool is connected to a Cisco Unity Connection or IM and Presence server because these products do not have a Call Record database.

    When you use Cisco Unified Real-Time Monitoring Tool to connect to a Cisco Unified Communications Manager or a Cisco Business Edition 5000 server, you can add nodes to include Cisco Unity Connection and IM and Presence servers in the Unified Analysis Manager.

    To launch Unified Analysis Manager, do the following procedure:

    Procedure
      Step 1   After you install the plug-in, perform one of the following tasks:
      1. From your Windows desktop, double-click the Real Time Monitoring Tool 8.5 icon.
      2. Choose Start > Programs > Cisco Unified Serviceability > Real-Time Monitoring Tool.

      The Unified Real-Time Monitoring Tool Login window displays.

      Step 2   In the IP Host 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 user password that you established for the username.
      Step 5   Enter the port that the application will use to listen to the server. The default port number is 8443.
      Step 6   Check the Secure Connection check box.
      Step 7   Click OK.
      Step 8   When prompted, add the certificate store by clicking Yes.

      The Cisco Unified Real-Time Monitoring Tool starts.

      Cisco Unified Analysis Manager Setup

      The Administration option on the Unified Analysis Manager menu allows you to import device and group configurations from a .csv file to the Unified Analysis Manager tool.

      Import Device and Group Settings

      Follow this procedure to import device and group configuration from a .csv file into the Unified Analysis Manager.

      Procedure
        Step 1   From the Unified Analysis Manager menu, select Administration > Import.
        Step 2   Select the .csv configuration file that you want to import.
        Step 3   Click the Import button.

        The selected file appears.

        Scheduled Trace and Log Collection Job Status Display

        This function allows you to display status of scheduled trace setting and log collection jobs. Jobs can be scheduled using the Unified Analysis Manager Tools. Once a device is added to a group, you can schedule trace setting and log collections jobs on the device.

        A scheduled job is linked to the machine it is configured on, and the job cannot be run on a different machine. If the machine on which a job was scheduled is not usable for any reason, the old job can be cloned and saved as a new job with new parameters to be run on the new machine.

        Jobs running on a device can have one of the following states:

        • Scheduled: A job is scheduled within Unified Analysis Manager; however it has not started

        • Running: A job that is currently either setting traces or collecting logs

        • Completed: A job that is done

        • Pending: A job that has completed one run of collecting logs and is waiting to start the next run.

        • Aborted: A job that has stopped abnormally due to an unexpected error

        • Canceled: A job that has stopped due to a cancel operation by the user.

        The Job Status screen gives a system view of all the jobs in Unified Analysis Manager. For jobs that have multiple runs, the status and time of the last run is also shown in this page.

        The following operations can be performed on a job:

        • View Details: Use this option to get more detailed view of the job.

        • Cancel: Use this option to cancel a job. The Cancel operation can only be done on the machine that the job is running or scheduled on. This option cannot be used for jobs that are in the Completed/Aborted/Canceled state.

        • Clone: Use this option to select any job and save it as a new job. The job being cloned from can be in any state. This option allows you to change any attribute of the job before saving. Cloning a job does not impact the attributes of the job being cloned.

        Upload and Transfer Files to FTP Server

        This option allows you to transfer files to a configured FTP server and send an email to interested parties. You can use this option to transfer some files to another machine so they can be viewed by others.

        This screen allows you to specify the files and folders to be transferred as well as any annotations to accompany those files.

        Follow this procedure to transfer files to an FTP server:

        Procedure
          Step 1   From the Unified Analysis Manager menu, select Administration > Upload Files.

          The Upload Files screen appears.

          Step 2   In the Case ID field, enter the number that Cisco TAC has assigned to the case.
          Step 3   Use the drop-down list box in the Send to Server field to select the FTP server you are sending the file to.
          Step 4   Use the Notes box to provide any additional information about the file.
          Step 5   Use the Send Email Notifications check box if you want to add the email addresses to send a notification that the file is uploaded. To add multiple email addresses, add the mail ids separated by comma. The mail addresses can be only the <username> or it can be of the format username@domain.com.
          Step 6   In the bottom section of the screen, in the Files to upload box, select the files you want to transfer. Use the Add or Remove buttons to select or deselect files from the system. The files selected will be zipped by default and then uploaded. The name of the zipped file will be of the format <case id>_uploadedfile.zip.
          Step 7   Click the OK button to transfer the file.

          Cisco Unified Analysis Manager Preferences

          Use the Unified Analysis Manager dropdown menu to set preferences for:

          Related Tasks
          Access FTP Server Options
          Add or Edit FTP Server
          Add or Edit Mail Server
          Set Trace Collection Directory
          Set Up Mail Server
          Related References
          FTP Server Setup

          FTP Server Setup

          This function allows you to configure a FTP Server which you can then use to export information to. These servers can be Cisco TAC FTP servers. This information can include things such as logs, trace files, and system call trace information.

          By default, the Cisco TAC FTP server will be pre-populated. You can modify this configuration for the default FTP server.

          The FTP Server option allows you to manage the configured servers. You can perform the following operations:

          • Add a new FTP server

          • Edit an existing FTP server

          • Delete FTP servers

          • Test the connection of an FTP server

          Cisco TAC has two FTP servers you can configure for exporting files:

          • ftp-rtp.cisco.com

          • ftp-sj.cisco.com


          Note

          On both servers, files should be uploaded to the /incoming directory.

          Access FTP Server Options

          The following procedure explains how to access the FTP Server Options:

          Procedure
            Step 1   From the Unified Analysis Manager drop-down menu, select AnalysisManager > Preferences.

            The Preferences window displays. Click FTP Server.

            Step 2   The FTP Servers screen displays with a list of configured servers and buttons to Add, Edit, or Delete a server. The Test Connection button allows you to test connectivity to a server.
            Step 3   Use the buttons to select the option you want.

            Add or Edit FTP Server

            Follow this procedure to add an FTP Server or edit an existing configuration:

            Procedure
              Step 1   From the Unified Analysis Manager drop-down menu, select AnalysisManager > Preferences. The Preferences window appears. Click FTP Server.
              Step 2   The FTP Servers screen displays with a list of configured servers and buttons to Add, Edit, or Delete a server. The Test Connection button allows you to test connectivity to a server.
              Step 3   Click the Add button to add a server or the Edit button to edit an existing configuration. The Add FTP Server screen appears.
              Step 4   In the Name/IP Address field, enter the name or the IP address of the FTP server you are adding.
              Step 5   In the Protocol field, select either the FTP or SFTP protocol, depending on the type of server you are connecting to. Use SFTP if you are connecting to a Cisco TAC server.
              Step 6   In the User Name and Password fields, enter the username and password that gives you access to the server.
              Step 7   In the Port field, enter the port number on the server that you will be using.
              Step 8   In the Destination Directory field, enter the path for the directory to which you will be exporting files. If you are adding a Cisco TAC server, use the /incoming directory.
              Step 9   Click the OK button to add the server. You can use the Cancel button to end the operation without adding the FTP server.

              Set Up Mail Server

              This option allows you to configure a mail server for the purpose of notifying a set of user configured recipients on the status of Unified Analysis Manager operations such as trace and log collections and file transfers.

              You must configure at least one mail server in order to be able to send a notification.


              Note

              • You can configure a maximum of two mail servers.

              • You can only use mail servers configured with this option for Unified Analysis Manager notifications. For RTMT notifications, you must configure a separate mail server.

              Add or Edit Mail Server

              The following procedure explains how to add a Mail Server or edit an existing configuration:

              Procedure
                Step 1   From the Unified Analysis Manager drop-down menu, select AnalysisManager > Preferences.

                The Preferences window displays. Click Mail Server.

                Step 2   The Mail Servers screen appears with a list of configured servers and buttons to Add, Edit, or Delete a server. The Test Connectivity button allows you to test connectivity to a server. The Refresh button allows you to reload the server.
                Step 3   Click the Add button to add a server or the Edit button to edit an existing configuration. On clicking the Add button, the Add Mail Server screen appears.
                Step 4   In the Name/IP Address field, enter the name or the IP address of the Mail server you are adding.
                Step 5   In the Port No. field, enter the port number on the server that you will be using.
                Step 6   Click Save button to save the settings or the Cancel button to end the operation without adding the Mail server. The Test Connection button allows you to test connectivity to a server.

                Set Trace Collection Directory

                Follow this procedure to use the Trace Collection option under Preferences to set a directory for trace logs:

                Procedure
                  Step 1   From the Unified Analysis Manager drop-down menu, select AnalysisManager > Preferences.

                  The Preferences window appears. Click Trace Collection.

                  Step 2   The Trace Collection screen appears. Enter the directory you want to use for traces logs in the Download Directory box, or use the Browse button to locate the directory. Optionally, you can click the Default button to select the default dirctory.
                  Step 3   Click Save.