Cisco Prime Collaboration Assurance Guide - Advanced, 10.0
Prerequisites for Setting Up the Network for Monitoring
Downloads: This chapterpdf (PDF - 1.59MB) The complete bookPDF (PDF - 8.14MB) | Feedback

Prerequisites for Setting Up the Network for Monitoring

Contents

Prerequisites for Setting Up the Network for Monitoring

Before Prime Collaboration can start monitoring the voice and video endpoints in your network, you must complete several tasks.

The following table provides information about the prerequisites for monitoring voice and video endpoints.

Table 1 Prerequisites for Monitoring Voice and Video Endpoints

To monitor . . .

Prerequisite

Voice and video endpoints

Discovering Devices

Video endpoints only

Importing Sessions from CTS-Manager and Cisco TMS

Voice endpoints only

For information on setting up the devices, see the Setting up Devices for Prime Collaboration wiki.

Devices Discovery

Whenever you add new devices to the Prime Collaboration database, you must then discover them.

To discover devices:

  1. Choose Operate > Device Work Center  > Manage Credentials > and enter the credentials for all the devices that you plan to monitor.
  2. Choose Operate > Device Work Center  > Discover Devices.

If you have management and call and session control devices, such Cisco TelePresence Manager (CTS-Manager), Cisco TelePresence Management Suite (TMS), Cisco Unified CM, or VCS deployed in your network, you must discover these devices first. All registered collaboration devices will be discovered when you discover the application managers or call processors.


Note


For endpoints that are registered to Cisco Unified CM, ensure that JTAPI is enabled. If Cisco Unified CM is already discovered, you must rediscover the endpoints again.


For more information about device discovery, see Discovering Devices.

Importing Sessions from CTS-Manager and Cisco TMS

The CTS-Manager and Cisco TMS contain details on the scheduled sessions. Prime Collaboration periodically polls these devices to retrieve the session details. You can configure the frequency of the periodic polling based on your business needs.

To enable uninterrupted monitoring of the sessions, you can manage a CTS-Manager or Cisco TMS cluster using the Manage Clusters option (Operate > Device Work Center > Manage CTS-MAN/TMS Clusters).

For Cisco TMS, if an unscheduled endpoint is added when the scheduled session is in progress, Prime Collaboration shows the session details of that endpoint.

Prime Collaboration imports scheduled sessions data for five days (for the past one day, the current day, and for the next three days).

Note the following points when importing sessions from Cisco TMS:

  • Prime Collaboration supports only the default e-mail template for the Booking Confirm e-mail in Cisco TMS. Sessions will not be imported from Cisco TMS if the default e-mail template is not used.
  • "Reservation Only" meeting details will not be imported from Cisco TMS. Prime Collaboration does not support this type of meeting because resources are not allocated for it while scheduling.

If you have configured a session to start before the scheduled time in CTS-Manager, you must configure the same time in Prime Collaboration. That is, if you have configured to start a session 5 minutes before the scheduled time, you must configure the same time in the Device Monitoring Configuration page. Otherwise, Prime Collaboration will list two sessions for a scheduled meeting that has started before the scheduled time.

In addition to the periodic polling, if you want to import the session details immediately, you can click Import Sessions (Operate > Diagnose > Session Diagnostics > Import Sessions).


Note


The Import Sessions task impacts Prime Collaboration system performance. Use Import Sessions only if it is required.


Two jobs are created for the Import Sessions task. You can monitor these jobs at Administration  > Job Management. The job type is displayed as Synch_CtsMAN-MEETING_UniqueJobID and Synch_TMS-MEETING_UniqueJobID in the Job Management page.

TMS_Session_Import and CTSMan_Session_Import regular jobs run periodically and poll complete details of all sessions.

However, the TMS_Frequent_Session_Import job runs frequently on a regular basis and retrieves only the changes in sessions after the previous polling. (You can change the frequency of polling in System Setup page).

If you are using CTS-Manager 1.7 or later, you must maintain an interval of at least 5 minutes between Import Sessions tasks. If you import sessions within 5 minutes, the job will fail.

Configuring Maximum Capacity for a Trunk or Gateway

You must configure the maximum capacity for trunks and gateways to import the trunk utilization configuration data for all clusters.

To configure the maximum capacity for a trunk or gateway:


    Step 1   Choose Administration  > System Setup  > Assurance Setup > CDR Trunk Utilization Settings.
    Step 2   From the drop-down list, select the Cisco Unified CM cluster that you want to configure.
    Step 3   Select a gateway or trunk type.
    Step 4   Click Configure Maximum Capacity and make the appropriate entries.
    Step 5   Click Apply, and then click Close.

    Importing Trunk Utilization Data for All Clusters

    After you configure trunk utilization settings, you must import the trunk utilization data.

    To import the trunk utilization data for all the Cisco Unified CM clusters:


      Step 1   Choose Administration  > System Setup  > Assurance Setup > CDR Trunk Utilization Settings.
      Step 2   Click Bulk Export.
      Step 3   In the Export Trunk Configuration window, click Export to accept the default named export CSV file.
      Step 4   Open the CSV file and edit the data as needed.

      All the gateways and trunks will be listed in the file. You just need to enter the values in the file.

      Step 5   Click Bulk Import.
      Step 6   Browse to the location of the CSV file, and then click Import.

      Data Source Credentials Updation

      Prime Collaboration collects MOS (a widely accepted scoring value (1-5) used to evaluate a monitored IP call) from Cisco Unified CM clusters, Cisco 1040 Sensors, and NAM. It sends SNMP traps when the voice quality of a call fails to meet a user-defined quality threshold.

      Cisco 1040 sensor monitors the active RTP streams between IP phones and calculates the MOS using the ITU G107 R-factor algorithm. The sensor then forwards the MOS for each monitored stream every 60 seconds to Prime Collaboration.

      Cisco Unified CM calculate the MOS value for an entire call using the Cisco Voice Transmission Quality (CVTQ) algorithm. At the termination of a call, Cisco Unified CM stores the data in Call Detail Records (CDRs) and Call Management Records (CMRs) (for more information on CDR and CMR, see the Cisco Unified Communications Manager Call Detail Records Administration Guide.

      You need not provide the credentials for Cisco 1040 Sensors to enable data collection from them. However, for NAM and Cisco Unified CM publisher servers, you must:

      • Provide Prime Collaboration with credentials.
      • Keep the credentials up-to-date. (Any time you update credentials on a NAM or on a Cisco Unified CM publisher server, you must also update the corresponding credentials in Prime Collaboration.)

      To update the credentials, choose Administration > System Setup > Assurance Setup > Call Quality Data Source Management.

      Using Data Source Credentials to Troubleshoot Problems and Verify Credentials

      Any problem that prevents Prime Collaboration from contacting and connecting to data sources can interrupt the collection and analysis of call data and configuration data. Use the information on the Data Source Management page to:

      • Verify that credentials are valid and that Prime Collaboration is actively obtaining data.
      • Troubleshoot if you notice potential problems with data source credential status or with reports (such as an unusual time gap).

        Step 1   Obtain more information by clicking the status links on the Data Source Management page.

        The information that you obtain could explain the problem or indicate the need for troubleshooting.

        Step 2   Perform some troubleshooting:
        For a NAM—Check whether the:
        • Credentials on a NAM have changed; if so, update the credentials in Prime Collaboration
        • NAM is reachable; if not, take steps to ensure that the NAM is reachable.
        For a Cisco Unified CM—Do the following:
        • Confirm that the last successful contact Prime Collaboration had with the cluster was recent.When the last contact status is Success, in some cases, Prime Collaboration might not be receiving data, but simply waiting to receive data.
        • Verify that credentials for the cluster on Unified Communications Manager match those in Prime Collaboration, and correct, if necessary.
        • Verify that DNS parameters are specified correctly on the Prime Collaboration server and the Unified Communications Manager hostname has been added to DNS. (Prime Collaboration must be able to resolve the IP address for Unified Communications Manager to obtain the correct name.)
        • Check whether any known problems exist that prevent successful data exchange between a cluster and Prime Collaboration.
        • Wait or take preventive action when the call data status shows that Prime Collaboration is discarding data. Prime Collaboration discards data when receiving old data from Unified Communications Manager 6.x and later. This can happen after the connection between Prime Collaboration and Unified Communications Manager is reestablished after a break. Cisco Unified CM first sends old files to Prime Collaboration.
        • Credentials that Prime Collaboration relies upon might change on a Cisco Unified CM platform. If this happens, check with your Unified Communications Manager administrator to obtain the correct credentials. If necessary, update the credentials in Prime Collaboration.
        Step 3   Verify the credentials:
        Note    Do not verify credentials for Cisco Unified CM 4.x while Provisioning Manager synchronization is running.
        1. Choose Administration > System Setup > Assurance Setup > Call Quality Data Source Management. The Data Source Management page appears.
        2. Select the data source for which you want to verify credentials.
        3. Click Verify. If the Configuration Data Collection dialog box appears, do one of the following:

          Click Verify Credentials to verify credentials only.

          Click Verify Credentials and Collect Data to verify credentials and collect configuration data from Cisco Unified CM.


        Cisco 1040 Sensor Management

        Prime Collaboration uses the data that it receives from Cisco 1040 Sensors to determine the voice transmission quality in your network.

        For the Cisco 1040 Sensor to operate as desired, the switch where Cisco 1040 is connected to must be configured. For more details, see the following sections of Quick Start Guide for Cisco 1040 Sensor:

        • Configure DHCP Server Option 150
        • Connecting Your Cisco 1040
        • Understanding the Status Indicator Light
        • Using the Cisco 1040 Web Interface

        This section contains the following:

        Performing Initial Configuration in Prime Collaboration

        For initial configuration of Cisco 1040 Sensors, do the following:


          Step 1   Add one or more TFTP servers for Prime Collaboration and Cisco 1040 Sensors to use. See Configuring TFTP Servers for Cisco 1040 Configuration and Image Files.
          Step 2   Copy the binary image file from the Prime Collaboration server to the root location on each TFTP server that you added in step 1. See Copying the Binary Image File to the TFTP Server.
          Step 3   Create a default configuration file. See Setting Up the Cisco 1040 Sensor Default Configuration.

          When a Cisco 1040 connects to the network, it downloads a configuration file from a TFTP server before registering to Prime Collaboration.


          Configuration for TFTP Servers for Cisco 1040 Configuration and Image Files

          Prime Collaboration uses one or more TFTP servers to provide configuration files and binary image files for Cisco 1040s. You must define at least one TFTP server for Prime Collaboration to use. You can configure additional TFTP servers if you either want a backup server or have more than one DHCP scope.

          You can use the configuration files that Prime Collaboration keeps on the server to recover if there is a write failure on the TFTP server. In this case, you can manually copy configuration files from Prime Collaboration to each TFTP server that is configured for Prime Collaboration.

          Adding and Deleting a TFTP Server

          To enable Cisco 1040s to register with Prime Collaboration, you must define at least one TFTP server where Prime Collaboration can provide Cisco 1040 configuration files (and the binary image file).


          Note


          • Using Prime Collaboration as a TFTP server is not supported. Additionally, we recommend disabling the CWCS TFTP service on the Prime Collaboration server.
          • If you plan to use a Unified Communications Manager as a TFTP server, consider that:
            • You must manually copy configuration and image files from Prime Collaboration to the root location on the Unified Communications Manager TFTP server.
            • After you update files and copy them to the TFTP server, you might also need to restart the Cisco TFTP service (on Unified Communications Manager) for Cisco 1040s to be able to download the files.


            Step 1   Select System Setup > 1040 Sensors > TFTP Servers. The TFTP Server Setup page appears.
            Step 2   Click Add. The TFTP Server Settings dialog box appears.
            Step 3   Enter data in the following fields:
            • TFTP Server—IP address or DNS name.
            • Port Number—The customary port number is 69.
            Step 4   Click OK.
            Note   

            To delete, select the TFTP server and click Delete.


            Copying the Binary Image File to the TFTP Server

            Login as root and copy the binary image file, SvcMonABn_nnn.img, from /opt/CSCOpx/ImageDir on the Prime Collaboration server to the root location on the TFTP server.

            If Prime Collaboration has been added as TFTP server, then copy the binary image file, SvcMonABn_nnn.img to /tftpboot.

            Setting Up the Cisco 1040 Sensor Default Configuration

            Use this procedure to:

            • Enable or disable call metrics archiving—Prime Collaboration saves MOS data in the database. Optionally, you can also save the data to files.
            • View the directory path for the archive data file and the Cisco 1040 image file.
            • Create the default configuration file—QOVDefault.CNF specifies the primary Prime Collaboration to which a Cisco 1040 can register.

              Note


              If you are using Unified Communications Manager software version 4.2 or later as a TFTP server, you must manually copy the default configuration file from the image file directory on the Prime Collaboration server to the root location on the Unified Communications Manager TFTP server. For more information, see step 3, in the following procedure.


            To set up the Cisco 1040 sensor:


              Step 1   Select Administration > System Setup > 1040 Sensors > Setup. The Setup page appears.
              Step 2   Update data described in the following table.
              Step 3   Click OK. Prime Collaboration stores the configuration file locally and copies it to the TFTP servers that are added to Prime Collaboration.

              Cisco 1040 Sensor Setup Page - GUI Elements
              Table 2 Cisco 1040 Sensor Setup Page - GUI Elements

              GUI Element

               

              Call Metrics Archiving radio buttons

              Select one of the following:

              • Enable—After analysis, Prime Collaboration saves data from sensors to disk files.
              • Disable—After analysis, Prime Collaboration discards data.

              Default: Disable.

              Data File Directory

              Directory where files are stored if call metrics archiving is enabled. You cannot edit this field.

              Image File Directory

              Directory where Cisco 1040 binary image file and configuration files are stored locally. You cannot edit this field.

              Send traps every n minutes per endpoint

              Enter a number greater than or equal to 5. Cisco 1040s send data to Prime Collaboration every 60 seconds. Prime Collaboration determines whether a violation has occurred and can potentially send a trap-a-minute for each endpoint. Use this setting to reduce the number of traps that Prime Collaboration sends for each endpoint. For a given endpoint, a trap is sent every n minutes and additional traps during that time are suppressed (not sent).

              Default Configuration to TFTP Server

              Image Filename

              Enter the image file name if you are using a new image (for example, after a product upgrade).

              Primary Prime Collaboration

              IP address or DNS name for the primary Prime Collaboration.

              Configuring Cisco 1040 Sensors in Prime Collaboration

              Prime Collaboration analyzes data that it receives from Cisco 1040 Sensors installed in your voice network. An instance of Prime Collaboration manages multiple Cisco 1040 Sensors.

              This section contains the following:

              Cisco 1040 Sensor Details

              To see Cisco 1040 Sensor details, select Administration > System Setup > Assurance Setup > 1040 Sensors > Management. The Cisco 1040 Sensor Details page displays information listed in the following table:

              GUI Element

               


              Exports data from the Cisco 1040 Sensor Details page to a CSV or PDF file.



              Opens a printer-friendly version of the data in another window; for printing from a browser window.

              Check box column

              Select Cisco 1040s that you want to edit, reset, or delete.

              Name column

              Click the name link to view details of the Cisco 1040 configuration.

              Cisco 1040 Address columns

              Displays MAC and IP addresses for Cisco 1040. Click the MAC address link to launch an HTML page on the Cisco 1040.

              Prime Collaboration columns

              Displays the following:

              • Primary—IP address or hostname of the primary Prime Collaboration defined for the Cisco 1040.
              • Registered with—Displays one of the following:
                • IP address or hostname of the Prime Collaboration to which the Cisco 1040 is currently sending data.
                • Waiting—The Cisco 1040 is not yet registered.
                • Older Image—The binary image on the Cisco 1040 is not supported.

              Reset Time column

              The last date and time that Prime Collaboration sent a reset command to the Cisco 1040.

              Buttons

              Add

              See Adding a Cisco 1040 to Prime Collaboration.

              Edit

              See Adding a Cisco 1040 to Prime Collaboration.

              Delete

              See Deleting a Cisco 1040 Sensor from Prime Collaboration.

              Reset

              See Resetting Cisco 1040s.

              Refresh

              Refresh the Cisco 1040 Sensor Details page.

              Restarting Processes to Update Cisco 1040 Registration Information in Prime Collaboration

              Prime Collaboration might show a Cisco 1040 Sensors waiting to register while receiving and processing syslogs from it; this problem can occur after a user does one of the following:

              • Uses pdterm to stop the QOVR process, and, in quick succession, uses pdexec to start it again. To prevent this problem, wait at least 5 minutes between stopping and starting the QOVR process. To correct this problem: From the command line, stop the QOVR process again, by entering this command:
                
                pdterm QOVR
                
                Wait at least 5 minutes. Enter this command:
                
                pdexec QOVR
                
              • Changes the time on the system where Prime Collaboration is installed without subsequently stopping and restarting the daemon manager. To correct this problem, login as admin and execute the following commands:
                
                <hostname>/admin#application stop cpcm
                <hostname>/admin#application start cpcm
                

              Adding a Cisco 1040 to Prime Collaboration

              To add a Cisco 1040 Sensor, do the following:


                Step 1   SelectAdministration > System Setup > 1040 Sensors > Management. The Cisco 1040 Sensor Details page appears.
                Step 2   Click Add. The Add a Cisco 1040 Sensor dialog box appears.
                Step 3   Enter data listed in the following table:
                Step 4   Click OK. The configuration file is saved on the server where Prime Collaboration is installed and is copied to all TFTP servers. (See Configuring TFTP Servers for Cisco 1040 Configuration and Image Files.) The configuration file is named QOV<MAC address>.CNF, where <MAC address> is the MAC address for the Cisco 1040. Similarly, for updating the configuration, select one or more check boxes and click Edit.


                Note


                • Select a Cisco 1040 Sensor to edit the name or description.
                • Do not edit a Cisco 1040 configuration file using a text editor.

                Cisco 1040 Sensor Dialog Box - GUI Elements Description

                GUI Element

                 

                Sensor Name

                Enter up to 20 characters. This name is used to identify the sensor on Prime Collaboration windows, such as reports.

                Note   

                Cisco 1040 names must be unique. Cisco 1040s that register to Prime Collaboration using the default configuration file use the name Cisco 1040 + <last 6 digits from MAC address>.

                Image File Name

                Enter the binary image file name. The filename format is SvcMonAB2_nnn.img where nnn is a revision number.

                MAC Address

                Enter the MAC address for the Cisco 1040 that you are adding.

                Primary Prime Collaboration

                Enter an IP address or DNS name of a host where Prime Collaboration is installed.

                Description

                (Optional) Enter up to 80 characters.

                Editing Configurations for Multiple Cisco 1040s

                • If you use Unified Communications Manager as a TFTP server, you must manually upload the updated configuration file from the image file directory on the Prime Collaboration server to the root location on Unified Communications Manager TFTP server. Afterward, you must reset the Cisco 1040. (The image file directory is NMSROOT/ImageDir. NMSROOT is the directory where Prime Collaboration is installed; its default location is C:\Program Files\CSCOpx.) If the Cisco 1040 does not register or does not load the latest files, restart the TFTP Server.
                • Do not edit a Cisco 1040 configuration file using a text editor. Edit a Cisco 1040 configuration file using this procedure only.

                To edit configurations for multiple Cisco 1040s:


                  Step 1   Select Administration > Configuration  > Cisco 1040s  > Management.
                  Step 2   Select check boxes for more than one Cisco 1040 and click Edit.
                  Step 3   Update any of the fields.
                  Step 4   Click OK. Prime Collaboration saves the configuration files on the local server copies it to all TFTP servers. Then Prime Collaboration resets the Cisco 1040s, so that they load the updated configuration.

                  Cisco 1040 Management - Field Descriptions

                  Table 3 Cisco 1040 Management - Field Descriptions

                  Fields

                   

                  Image File Name

                  Enter the binary image filename. The filename format is SvcMonAB2_nnn.img where nnn is a revision number. For the name of the most recently supported binary image file, see Cisco Prime Unified Service Monitor 2.3 Compliance Matrix. For more information, see add cross reference.

                  Primary Prime Collaboration

                  Enter an IP address or DNS name of a host where Prime Collaboration is installed. The Cisco 1040 sends data to this Prime Collaboration unless it becomes unreachable.

                  Secondary Prime Collaboration

                  (Optional) Enter an IP address or DNS name of a host where Prime Collaboration is installed. The Cisco 1040 sends data to this Prime Collaboration only if the primary Prime Collaboration becomes unreachable.

                  Resetting Cisco 1040s

                  Use this procedure to boot one or more Cisco 1040s. After a Cisco 1040 boots, it first uses DHCP to obtain the IP address of the TFTP server. Cisco 1040 obtains a configuration file from the TFTP server. If the configuration file specifies a binary image file that is different from the currently installed image, the Cisco 1040 obtains the binary image file from the TFTP server.


                    Step 1   SelectAdministration > System Setup > 1040 Sensors > Management.
                    Step 2   Select check boxes for the Cisco 1040s that you want to reset.
                    Step 3   Click Reset. The Cisco 1040 will take a few minutes to complete the startup sequence, reconfigure (if necessary), and register with Prime Collaboration.
                    Note   

                    If you use Unified Communications Manager as a TFTP server, the Cisco 1040 Sensor does not register or does not load the most recent image file after reset. You must restart the TFTP Service on Cisco Prime Unified Communications Manager.

                    When you reset a Cisco 1040, Prime Collaboration sends the most recent time to the sensor. The Cisco 1040 resets its clock as needed.


                    Deleting a Cisco 1040 Sensor from Prime Collaboration

                    Before you delete a Cisco 1040 Sensor, you must shut the switch port that physically connects to the 10/100-1 Fast Ethernet port on the Cisco 1040:

                    1. To identify the port, get the switch IP address and the switch port from the Cisco 1040 web interface.
                    2. To shut the port, use the CLI on the switch.

                      Note


                      Do not delete the Cisco 1040 from Prime Collaboration until you shut the switch port.


                    You should also either shut or reconfigure the SPAN or RSPAN destination port on the switch. For information about configuring SPAN and RSPAN on Cisco Catalyst switches and modules, see.

                    After you delete a Cisco 1040, it cannot automatically register again to the Prime Collaboration from which it has been deleted. To enable such a Cisco 1040 to register with this Prime Collaboration again, you must add the Cisco 1040 manually. Adding a Cisco 1040 to Prime Collaboration, page 15-8.

                    To delete, select System Setup > 1040 Sensors > Management. Select check boxes for the Cisco 1040s that you want to delete from the Cisco 1040 Sensor Details page and click Delete.


                    Note


                    Delete a Cisco 1040 Sensor from any sensor threshold groups, before you delete the Cisco 1040 Sensor.


                    Prime Collaboration sends a time synchronization message to each Cisco 1040 Sensor hourly. Prime Collaboration also sends a time synchronization message when a Cisco 1040 registers. A Cisco 1040 registers when it is added to the network and when it has been reset. The Cisco 1040 receives the time from Prime Collaboration and resets its clock as needed.

                    Viewing Diagnostic Information on a Cisco 1040

                    To view the diagnostics stored on a Cisco 1040, enter http://<IP address>/Diagnostics in your browser, where IP address is the address of your Cisco 1040.

                    The Cisco 1040 web interface displays a Diagnostics Information window with the following information:

                    Field

                    Description

                    Current Time

                    Current time and date (HH:MM:SS MM/DD/YYYY).

                    Clock Drift

                    Seconds of drift and the last time and date that the clock was reset; for example, “1 second(s) updated at 9:23:37 03/16/2009”.

                    Last Analysis Time

                    Time and date when the Cisco 1040 last ran an analysis.

                    Streams Analyzed

                    Number of RTP streams that were analyzed during the last interval.

                    Last Communication

                    Time and date when the sensor last received an ACK or timeSet message, or any supported message from the Prime Collaboration.

                    Last Successful Report Time

                    Time and date that the Cisco 1040 last sent data to Prime Collaboration.

                    Report Destination

                    Destination hostname or IP address and port number to which the report was sent.

                    Report Length (bytes)

                    Number of bytes in the last report record.

                    Received Packets

                    Number of packets that the Cisco 1040 received during the last interval.

                    Receive Errors

                    Number of errors received on the monitoring interface as reported by pcap.

                    Packets Dropped

                    Number of packets dropped on the monitoring interface as reported by pcap.

                    Buffer overruns

                    Number of buffer overruns on the monitoring interface as reported by pcap.

                    Framing Errors

                    Number of framing errors on the monitoring interface as reported by pcap.

                    Interface Promiscuous

                    Monitoring interface is in promiscuous mode (yes) or not (no).

                    Call Classification

                    Prime Collaboration uses call classification to categorize calls in Call Detail Record (CDR) reports.

                    Prime Collaboration determines whether a call fits in system-defined call categories by analyzing the following data:

                    • Details from CDRs
                    • Device types of the source and target endpoints
                    • Direction of the call (incoming or outgoing)
                    • Protocol (H.323, MGCP, or SIP)

                      Note


                      CDR reports older than seven days are purged.


                    The following table lists system-defined call category types and names, and describes the calls included in the category type.

                    Category Type Description Category Name
                    Voicemail Calls to or from voicemail. Unity Voicemail—Calls that meet system-defined criteria for a voicemail call, such as calls to and from Cisco Unity and Cisco Unity Connection.
                    Note   

                    You can add user-defined category names to this category type.

                    Conference Calls to or from a conferencing system. Conference Bridge—Calls that meet system-defined criteria for a call involving a conference bridge.
                    Note   

                    You can add user-defined category names to this category type.

                    ICT Calls to or from an intercluster trunk (ICT).
                    • ICT GK Controlled—ICT calls that are gatekeeper controlled.
                    • ICT Non-GK Controlled—ICT calls that are not gatekeeper controlled.
                    VG/Trunk-Outgoing Calls to a voice gateway or a trunk; only OffNet calls are included.
                    Note   

                    User-defined dial plans are applied to calls in the VG/Trunk-Outgoing call category.

                    • MGCP Gateway Outgoing—Calls to an MGCP voice gateway.
                    • H.323 Gateway Outgoing—Calls to an H.323 voice gateway.
                    • H.323 Trunk Outgoing—Calls to an H.323 trunk. SIP Trunk Outgoing—Calls to a SIP trunk.
                    VG/Trunk-Incoming Includes calls from a voice gateway or a trunk; only OffNet calls are included.
                    • MGCP Gateway Incoming—Calls from an MGCP voice gateway.
                    • H.323 Gateway Incoming—Calls from an H.323 voice gateway.
                    • H.323 Trunk Incoming—Calls from an H.323 trunk. SIP Trunk Incoming—Calls from a SIP trunk.
                    Tandem A tandem call occurs when both endpoints are voice gateways or trunks. Tandem.
                    OnNet Trunk Calls where one endpoint is a trunk and the call is not an OffNet call.

                    For example, the trunk could be used to connect to WebEx or to a PBX.

                    • OnNet H.323 Trunk.
                    • OnNet SIP Trunk.
                    Internal Calls that do not fall into any of the above categories. For example, calls where one endpoint is an IP phone and the other endpoint is a voice gateway and the call is not an OffNet call. Internal.
                    Unknown For system-related reasons, Prime Collaboration could not determine the device type of the endpoints. Unknown.

                    Prime Collaboration places a call in the user-defined call category if:

                    • The call has already been categorized as an Internal, VG/Trunk-Outgoing, or OnNet Trunk call.
                    • A user-defined dial plan is assigned to the cluster in which the call occurred.

                    Understanding OffNet and OnNet Calls

                    A call is considered to be OffNet when at least one endpoint is a gateway or a trunk and when any of the following is also true of the endpoint:

                    • The Call Classification parameter is set to Offnet in the gateway configuration—or the trunk configuration—in Unified Communications Manager (Administration).
                    • In Unified Communications Manager, both of the following are true:
                      • Call Classification parameter is set to System Default in the gateway or trunk configuration.
                      • System Default service parameter is set to Offnet.
                    • The endpoint is an analog gateway.

                    Any call that does not meet the criteria for an OffNet call is considered to be an OnNet call.

                    Call Category Creation

                    You can create a call category when you add a dial pattern to a dial plan.

                    To add a call category, choose Administration > System Setup > Call Classification > Call Category.

                    Dial Plan Addition

                    A dial plan must have a unique name, can include a set of toll-free numbers, and must include a set of dial patterns. A dial pattern identifies a call category name and type and specifies the rule or pattern that a directory number must match for the call to be included in the category.

                    Prime Collaboration provides a default dial plan as a starting point from which you can define your own dial plans. The default dial plan includes default dial patterns: call category names, types, and rules. As you configure a dial plan, you can update the call categories and add, modify, and delete the rules that are specified in the default dial plan.

                    You can create multiple dial plans. You can assign only one dial plan to each cluster, but you can assign the same dial plan to multiple clusters.

                    To add a dial plan, choose Administration > System Setup > Call Classification > Dial Plan Configuration.

                    Understanding the Default Dial Plan

                    When you add a dial plan, a copy of the default dial plan is displayed for you to update. You can:

                    • Define your own call category names; however, you must select from the available call category types
                    • Add, update, or delete dial patterns

                    Changes that you make while configuring a dial plan have no effect on the default dial plan, which is based on the North American Numbering Plan (NANP).

                    The following table provides the default dial plan values.

                    Condition No. of Chars Default Pattern Call Category Name Call Category Type Explanation Priority
                    > 3 011! International International If the number of digits dialed is greater than 3 and starts with 011, the call is classified as International. 1
                    = 7 ! Local Local If the number of digits dialed is equal to 7 and the pattern is ! (more than one digit; in this case, 7 digits), the call is classified as Local. 2
                    = 10 T! Toll Free Toll Free If the number of digits dialed is equal to 10 and the pattern is T! (more than one digit; in this case, a 10-digit number that starts with a toll-free number that is defined in the dial plan), the call is classified as Toll Free. 3
                    = 10 G! Local Local If the number of digits dialed is equal to 10 and the pattern is G! (more than one digit; in this case, a 10-digit number that starts with a gateway code that has been defined in Prime Collaboration), the call is classified as Local. 4
                    = 10 ! Long Distance Long Distance If the number of digits dialed is equal to 10 and the pattern is ! (more than one digit; in this case, a 10-digit number), the call is classified as Long Distance. 5
                    = 11 T! Toll Free Toll Free If the number of digits dialed is equal to 11 and the pattern is T! (more than one digit; in this case, an 11-digit number that starts with a toll-free number that is defined in the dial plan), the call is classified as Toll Free. 6
                    = 11 XG! Local Local If the number of digits dialed is equal to 11 and the pattern is XG! (more than one digit; in this case, an 11-digit number that starts with any single digit followed by a gateway code that has been defined in Prime Collaboration), the call is classified as Local. 7
                    = 11 ! Long Distance Long Distance If the number of digits dialed is equal to 11 and the pattern is ! (more than one digit; in this case, an 11-digit number), the call is classified as Long Distance. 8

                    Note


                    Prime Collaboration classifies the call as Toll Free if the toll-free code is defined in the dial plan that is assigned to the cluster.


                    Adding a Dial Pattern to a Dial Plan

                    You can add a dial pattern to a dial plan that you are adding or editing.


                      Step 1   From the Add Dial Plan or Edit Dial Plan page, click Add. The Add Dial Pattern dialog box appears.
                      Step 2   Create a dial pattern by supplying data in these fields:
                      • Condition—Applies to the number of characters. Select one:
                        • Left Arrow (<)—Less than
                        • Right Arrow (>) —Greater than
                        • Equals symbol (=)—Equal to
                      • Number of Chars—Enter the total number of digits and non-numeric characters, including plus (+), pound (#), asterisk (*), comma (,), and the at symbol (@). Expresses the number of characters in the directory number to which the dial pattern applies.
                      • Pattern—Enter the pattern to apply to the digits, where:
                        • G indicates that the digits identify a gateway code.
                        • T indicates that Prime Collaboration should compare the digits with the toll-free numbers configured in the dial plan.
                        • ! signifies multiple digits (any number that is more than 1 digit in length, such as 1234 or 5551234).
                        • X signifies a single-digit number (such as 0, 1, or 9).
                      • Call Category Name—Select one of the following radio buttons and supply data as required:
                        • Existing—Select an existing call category name.
                        • New—Enter a unique name and select a call category type.
                      Step 3   Click OK.

                      How Dial Patterns Are Applied to VG/Trunk-Outgoing, Internal, and OnNet Trunk Calls
                      The following table shows how dial patterns are applied from a user-defined dial plan to a call in the Internal, VG/Trunk-Outgoing, or OnNet Trunk call category.
                      Prime Collaboration Applies Dial Patterns of This Category Type... To the Directory Number that is the... In a Call That Is in This System-Defined Category...
                      • Conference
                      • Emergency
                      • International
                      • Local
                      • Long Distance
                      • Service
                      • Toll Free
                      • Voicemail
                      Destination VG/Trunk-Outgoing
                      • Conference
                      • Voicemail
                      Source
                      • Conference
                      • Voicemail
                      • Source
                      • Destination
                      • Internal
                      • OnNet Trunk

                      Configuring Gateway Codes

                      Prime Collaboration uses the gateway codes that you configure to determine the call classification for an external call.


                      Note


                      To view the gateways for which gateway codes are already configured, select clusters and click View.


                      To configure gateway codes:


                        Step 1   Choose Administration > System Setup  > Call Classification  > Gateway Code.
                        Step 2   On the Gateway Code Summary page, select a cluster and click Manage Gateway Code.
                        Step 3   Enter the gateway code, and then click Apply.

                        Configuring SFTP Settings

                        If you are using Cisco Unified CM to monitor calls, you must configure SFTP settings.

                        To configure SFTP settings:


                          Step 1   Choose Administration > System Setup > Assurance Setup > SFTP Settings.
                          Step 2   Enter the required information. For field descriptions, see the table for SFTP Settings Page - Field Descriptions.
                          Step 3   Click Apply.

                          SFTP Settings Page - Field Descriptions

                          The following table describes the fields in the SFTP Settings page.

                          Table 4 SFTP Settings Page - Field Descriptions

                          Fields

                          Description

                          Low-Volume Schedule Hours

                          <day> <timerange>

                          For each day of the week, timerange indicates the hours during which Cisco Prime Collaboration Assurance processes fewer records. During the low-volume schedule, Cisco Prime Collaboration Assurance performs database maintenance.

                          Miscellaneous

                          Wait for Diagnostic Report (min)

                          Number of minutes that Cisco Prime Collaboration Assurance continues to search, when there is a large volume of data, before displaying the matching records found for a diagnostic report.

                          Report Data Retention Period (days)

                          Number of days that data is retained in the Prime Collaboration database before being purged.

                          SFTP

                          Username

                          You cannot change the username from smuser.

                          This same username, smuser, must be configured in Cisco Unified Communications Manager.

                          Change password check box

                          The default password is smuser. If you change the password here, you must also change the password for smuser in Cisco Unified Communications Manager.

                          Importing SRST Polling Settings

                          When you import SRST information, Prime Collaboration adds any new poll settings from the seed file and updates any existing poll settings that you edited.


                          Note


                          Be sure to edit SRST poll settings after you change the SRST configuration in your network.


                          Before You Begin
                          • Before you import SRST poll settings, verify that the following devices are monitored by Prime Collaboration:
                            • The media server that runs the Cisco Unified Communications Manager at the central site. (Phones at the remote site are registered to this Cisco Unified Communications Manager.)
                            • Switches to which the phones at the remote site are connected.
                            • Source and destination routers.
                          • Place the seed file in the /opt/CSCOpx/ImportFiles directory. You must login as a root user. You can also find the sample seed files in the /opt/CSCOpx/ImportFiles directory.
                          • Verify that your seed file is formatted correctly. For details, see Seed File Format.

                          To import SRST poll settings:


                            Step 1   Choose Administration > System Setup > SRST > SRST Import.
                            Step 2   In the SRST Import page, enter the name of the seed file in the Filename field and click OK.

                            Prime Collaboration verifies that the data in the seed file is syntactically correct and formatted properly.

                            If there are errors in the seed file, an error message is displayed:

                            • Check the srst_import.log file at /opt/CSCOpx/log/CUOM/srst for details (you must login as a root user).
                            • Correct the problems in the seed file and import the SRST information again.
                            Step 3   Click OK.

                            Prime Collaboration verifies that the routers are reachable and then creates IP SLA jitter tests on the routers. This might take some time.

                            Step 4   Verify that all IP SLA jitter tests were created successfully, by examining the srst_test_creation_results.log file in the /opt/CSCOpx/log/CUOM/srst directory (you must login as a root user).

                            If IP SLA jitter tests were not successfully created, do the following:

                            a. Use the log file to identify problems.

                            b. Make corrections in the seed file and return to Step 1 in this procedure to import SRST information again.


                            Seed File Format

                            Prime Collaboration supports two seed file formats:

                            To format the seed file correctly, do the following:

                            • Include up to 256 poll settings in the seed file, one poll setting per line. If you include more than 256 poll settings, Prime Collaboration discards the excess poll settings.
                            • Include the following for each poll setting:
                            Table 5 SRST Seed File–Preferred Format

                            Column Number

                            Description

                            1

                            SRST poll settings name—Must be unique.

                            2

                            IP address or DNS name of the source router—Source router and destination router (column 5) combination must be unique.

                            3

                            Read community string of the source router.

                            4

                            Write community string of the source router.

                            5

                            Username—Enter a username for the source router (if you are supplying SNMPV3 credentials).

                            6

                            Password—Enter the password for the source router (if you are supplying SNMPV3 credentials).

                            7

                            IP address or DNS name of the SRST destination router—Source router (column 2) and destination router combination must be unique.

                            8

                            Read community string of the SRST destination router.

                            9

                            Write community string of the SRST destination router.

                            10

                            Phone extension numbers of IP telephones associated with SRST destination router, delimited by a colon (:).

                            11

                            MAC addresses of IP telephones associated with SRST destination router, delimited by a colon (:).

                            MAC addresses must be sequenced in corresponding order with the phone extensions (see column 10).

                            12

                            Polling interval—Default (!{[NOVALUE]}!) = 30 seconds (minimum value).

                            13

                            Interpacket interval in milliseconds—Default (!{[NOVALUE]}!) = 30 milliseconds (minimum value).

                            14

                            Number of packets in each poll setting—Default (!{[NOVALUE]}!) = 10 packets (minimum value).

                            Example: Sample SRST Seed File in Preferred Format

                            SRST2,10.76.34.194,public,private,admin,admin,10.76.34.222,public,private,0009e847060e:00049afc920b,
4013:4017,30,30,20
                            Table 6 SRST Seed File—Secondarily Supported Format

                            Column Number

                            Description

                            1

                            SRST poll settings name—Must be unique.

                            2

                            IP address or DNS name of the source router—Source router and destination router (column 5) combination must be unique.

                            3

                            Read community string of the source router.

                            4

                            Write community string of the source router.

                            5

                            IP address or DNS name of the SRST destination router—Source router (column 2) and destination router combination must be unique.

                            6

                            Read community string of the SRST destination router.

                            7

                            Write community string of the SRST destination router.

                            8

                            MAC addresses of IP telephones associated with SRST destination router, delimited by a colon (:).

                            9

                            Phone extension numbers of IP telephones associated with SRST destination router, delimited by a colon (:).

                            Phone extensions must be sequenced in corresponding order with the MAC addresses (see column 8).

                            10

                            Sample interval specification—Default (!{[NOVALUE]}!) = 30 seconds (minimum value).

                            11

                            Interpacket interval in milliseconds—Default (!{[NOVALUE]}!) = 30 milliseconds (minimum value).

                            12

                            Number of packets in each poll setting—Default (!{[NOVALUE]}!) = 10 packets (minimum value).

                            Example: Sample SRST Seed File in Secondarily Supported Format

                            Test1,10.76.34.194,public,private,10.76.34.218,public,private,0009e8470515:00075079c2da,4015:1016,30,30,10

                            Viewing SRST Poll Setting Status

                            To view SRST poll setting status:


                              Step 1   Choose Administration > System Setup.
                              Step 2   From the SRST drop-down list, select SRST > SRST Operations.

                              The following table describes the fields in the SRST Operations page

                              Table 7 SRST Operations Page - Field Description

                              Field

                              Description

                              Test Name

                              SRST setting name

                              Source Router

                              Router in the central site on which the IP SLA test is created

                              Destination Router

                              Router in the branch office

                              Status

                              • Active—SRST setting is running as configured.
                              • Pending—SRST setting is briefly in a transient state after you click Delete.

                              If device monitoring is suspended for a source router, any associated SRST test setting is also suspended.

                              If you delete an IP SLA router from Prime Collaboration device inventory, any associated SRST test settings are automatically deleted.

                              Creating an SRST Test

                              You can run the SRST test to identify network failure issues.

                              If you cannot locate the test, see the log file /opt/CSCOpx/log/itemlogs/srst/srst_import_errors.log(log in as root using SSH with port 26).


                              Note


                              SRST test names must be unique. If you enter an existing test name, the existing test will be updated. To see a list of existing tests, open the SRST Operations page; for more information, see Viewing SRST Poll Setting Status.

                              To configure SRST test:


                                Step 1   From the Audio or Video Phones/Lines report, choose Launch > SRST Test.
                                Step 2   Specify the source and destination devices. You can do either of the following:
                                • Enter an IP address or DNS name.
                                • Expand device groups in the device selector and select a device.
                                  Note   

                                  The source device must be IP SLA-enabled.

                                Step 3   (Optional) Enter the interface name to set up the test from a particular interface on the device.
                                Step 4   Choose Add  > From Phone Report.
                                Step 5   Check the check box next to the phones that you want to add to the test, and click Select.

                                You can also enter the details directly into the Selected Phones list.

                                Step 6   Enter a test name and click OK.