voip Integration
cisco-call-manager-subscriber (en)


ServicePilot voip-cisco-call-manager-subscriber


# Cisco Call Manager Subscriber

Overview

The ServicePilot Cisco Call Manager Subscriber package collects information for Cisco Unified Communications Managers Subscriber component.

Description

The Cisco Call Manager Subscriber package uses SNMP to query Cisco Unified Communications Managers Subscriber component. The statistics gathered in this way include:

  • System information
  • CPU, Memory, Process and Disk utilization
  • Network interface statistics

The Cisco Call Manager Subscriber package also configures the ServicePilot Agent to obtain Cisco Unified Communications Manager inventory and performance details using Cisco AXL connections. Details collected include:

  • Call Activity
  • Registered Devices
  • H323 Gateways
  • GateKeeeper Gateways
  • Database Replication
  • Conferences
  • MGCP Gateways
  • Channel Activity

The Cisco Call Manager Subscriber package will also configure the ServicePilot Agent to enable an FTP server, to which CDR and CMR records are to be transferred by the CUCM on a schedule. These details are used as the basis for call statistics and call quality statistics.

The Cisco Call Manager Subscriber package can also check Cisco Disaster Recovery files. The files will be copied from the backup server defined to an empty local directory using SFTP. ServicePilot Manager will then monitor the state of the backup. Ticking the Summary checkbox will also provide summary information for all Cisco servers that are being backed-up.

Requirements

  • Note that the Cisco Call Manager Subscriber package must be imported into the Cisco Call Managers view of the Cisco VoIP package.

  • Network Flows - It is is necessary to ensure network connectivity between ServicePilot and the monitored device. In case of a network infrastructure using a firewall, all the ports below must be opened:

    • UDP/161 (SNMP): Between ServicePilot Manager and Cisco Unified Communications Managers
    • ICMP/Echo Request (Ping): Between ServicePilot Manager and Cisco Unified Communications Managers
    • TCP/8443 (AXL): Between ServicePilot Manager and Cisco Unified Communications Managers
    • Microsoft SQL database access: Between ServicePilot Agent and Cisco Unified Communications CDR database. Only for Cisco Unified Communications v4.
    • UDP/162 (SNMP Trap): (Optional) Between Cisco Unified Communications Managers and ServicePilot Agent
    • ServicePilot Manager Web server access (by default TCP/80 when using HTTP or TCP/443 when using HTTPS although this port is configurable): Between ServicePilot Agent and ServicePilot Manager
  • Third Party Configuration

    • In the Cisco Unified Serviceability web pages, the SNMP V2 community string and access needs to allow ServicePilot Manager to access the Cisco devices
    • From CUCM version 7.1(2) onwards the predefined Cisco Unified CM Administration User Group Standard RealtimeAndTraceCollection should be used. For older releases create a new group with Standard AXL API Access and Standard CCM Admin Users Roles.
    • An AXL Application User, member of the group above, for access to the Cisco equipment by ServicePilot Agent
  • ServicePilot Requirements

    • ServicePilot Manager minimum version: 8.5
    • ServicePilot Agent minimum version: 8.5 installed and configured
    • A Call Quality by Zone Or Network package imported into the configuration for the ServicePilot Agent

Installation

Before adding a resource to monitor, make certain that all pre-requisites are in place and if a ServicePilot Agent is required, that it is communicating correctly with the ServicePilot Manager. Resources can be added to ServicePilot configuration in a number of ways:

Add resource using Views Configuration web interface

  1. As an administrative user of ServicePilot, open the ServicePilot web interface.
  2. Navigate to Administration. The Configuration > Views web page will open.
  3. Click on the view in which to place the new resource in the Views hierarchy on the left of the interface. The View editor section will show the existing view contents.
  4. From the Packages list on the right of the interface, click and drag the voip-cisco-call-manager-subscriber package into the View editor and let go.
  5. The Package properties dialog box will open to allow resource configuration.
  6. Click OK to close the Package properties dialog box. Note that the dialog box will not close if required parameters are not set.
  7. Click Save to apply the new resource to ServicePilot configuration.

Add resource by changing servicepilot.conf configuration file

Resources can be added to ServicePilot configuration by directly editing the servicepilot.conf or other included YAML configuration files. The ServicePilot web interface can be used to make these changes and apply them to the running configuration.

  1. As an administrative user of ServicePilot, open the ServicePilot web interface.
  2. Navigate to Administration.
  3. Navigate to Configuration > Edit configuration.
  4. Expand the configuration to find the provisioning: and then packages: section of the view in which the new resource will be placed.
  5. Add the example package configuration line below.
  6. Click on the green - package: word to open then Package properties dialog box to allow resource configuration.
  7. Click OK to close the Package properties dialog box. Note that the dialog box will not close if required parameters are not set.
  8. Click Save to apply the new resource to ServicePilot configuration.

Example:

- package: "voip-cisco-call-manager-subscriber;;;;;;;;voip-cisco-call-manager-subscriber;;127.0.0.1;v8 and higher;My Publisher Name;;;;;;;N;N;N;N;N;N;N;N"

Key field notes

In the Monitoring Policies tab, specify the policy or policies to apply to the package

  1. Basic Parameters tab:

    1. IP address/FQDN: Specify the IP address, host name or FQDN for the CM Subscriber, as resolvable by the machine on which ServicePilot ** is running
  2. Call Server tab:

    1. CCM Version: Select the Cisco Call Manager version that is being monitored
    2. Publisher Name: Specify the Publisher Name (only CCM version 8 and higher)
  3. Access Parameters tab: (only for CCM version 7 and lower)

    1. AXL Host (If NAT): Specify the AXL host if NAT is configured.
    2. AXL Version: Select the AXL version in use
    3. AXL Login: Specify the AXL Login
    4. AXL Password: Specify the AXL Password
    5. AXL Port: Specify the AXL port
  4. Resources tab: Select the resources that you wish to monitor from the list below

    1. Call Activity
    2. Registered Devices
    3. H323 Gateways
    4. Gatekeepers
    5. Database Replication
    6. Conferences
    7. MGCP Gateways
    8. Channel Activity

Notes

Indicators description

Calls Quality

Number and Percentage of Good, Average and Bad quality calls. Calls are categorized as either good, average or bad according to thresholds defined in the ServicePilot Agent.

Calls Activity

  • Calls Active (An hold call is not considered as an active call. An Active call can be considered as a call with participants talking)
  • Calls In Progress (An active or hold call is considered as in progress)
  • Calls Attempted (An attempted call occurs any time that a phone goes off hook and back on hook, regardless of whether any digits were dialled, or whether it connected to a destination)
  • Authenticated Calls Active (An authenticated call designates one in which all the endpoints that are participating in the call are authenticated. An authenticated phone uses the Transport Layer Security (TLS) authenticated Skinny signaling protocol)

Gatekeeper Gateways

  • ARQs Attempted (Admission Request messages that are attempted by using the configured gatekeeper or its alternate gatekeepers)
  • ACFs Received (Admission Confirm messages that are received from the configured gatekeeper or its alternate gatekeepers).
  • RAS Retries (Number of retries due to loss or delay of all RAS acknowledgment messages on the configured gatekeeper or its alternate gatekeepers)
  • Video Out Of Resources (total number of video-stream requests to the configured gatekeeper or its alternate gatekeepers that failed, most likely due to lack of bandwidth)