42
Nimsoft Documentation: cisco_ucm v1.7x 1 Nimsoft Documentation Nimsoft Probes Technical Description cisco_ucm 1.7x Probe Documentation Last Update: 20 September 2011 Copyright© 1998-2011, Nimsoft Corporation www.nimsoft.com

cisco ucm 1.7x Probe Documentation - Nimsoft · Nimsoft Documentation: cisco_ucm v1.7x 5 5 cisco_ucm This description applies to cisco_ucm version 1.7x. Cisco CallManager is the software-based

  • Upload
    others

  • View
    37

  • Download
    0

Embed Size (px)

Citation preview

Page 1: cisco ucm 1.7x Probe Documentation - Nimsoft · Nimsoft Documentation: cisco_ucm v1.7x 5 5 cisco_ucm This description applies to cisco_ucm version 1.7x. Cisco CallManager is the software-based

Nimsoft Documentation: cisco_ucm v1.7x 1 1

Nimsoft Documentation

Nimsoft Probes – Technical Description

cisco_ucm 1.7x Probe Documentation

Last Update: 20 September 2011

Copyright© 1998-2011, Nimsoft Corporation

www.nimsoft.com

Page 2: cisco ucm 1.7x Probe Documentation - Nimsoft · Nimsoft Documentation: cisco_ucm v1.7x 5 5 cisco_ucm This description applies to cisco_ucm version 1.7x. Cisco CallManager is the software-based

Nimsoft Documentation: cisco_ucm v1.7x 2 2

Contents

Prerequisites and Supported Platforms 4

Requirements .........................................................................................................................................4

Installation Notes....................................................................................................................................4

cisco_ucm 5

The Nimsoft cisco_ucm probe .................................................................................................................5

cisco_ucm Configuration .........................................................................................................................7

General Setup...................................................................................................................................7

Creating a new group folder ...........................................................................................................10

Creating a new host profile .............................................................................................................10

Creating a new CDR Analysis and Reporting (CAR) profile ...............................................................16

Generate CAR Analysis Report ........................................................................................................21

Phone Table ...................................................................................................................................23

Custom CAR Analysis Reporting ......................................................................................................25

Checkpoint monitoring properties ..................................................................................................25

Launching the Message Pool Manager ............................................................................................30

Get Values ......................................................................................................................................30

AutoConfigurations ........................................................................................................................31

AutoMonitors .................................................................................................................................35

QoS ................................................................................................................................................37

Templates ......................................................................................................................................39

Checkpoint Metrics.........................................................................................................................42

Page 3: cisco ucm 1.7x Probe Documentation - Nimsoft · Nimsoft Documentation: cisco_ucm v1.7x 5 5 cisco_ucm This description applies to cisco_ucm version 1.7x. Cisco CallManager is the software-based

Nimsoft Documentation: cisco_ucm v1.7x 3 3

Document History Version Date What’s new?

Version 1.7x 29-Jul-2011 Updated the Product Info and the Add to Template features. Updated the Phone Table section.

Version 1.63 22-Apr-2011 Updated General Setup Tab.

Version 1.63 1-Jun-2011 Updated Defining a CAR Profile.

Page 4: cisco ucm 1.7x Probe Documentation - Nimsoft · Nimsoft Documentation: cisco_ucm v1.7x 5 5 cisco_ucm This description applies to cisco_ucm version 1.7x. Cisco CallManager is the software-based

Nimsoft Documentation: cisco_ucm v1.7x 4 4

Prerequisites and Supported Platforms

Requirements

Platform Windows, Linux

Software Cisco Unified Communications Manager (CallManager) 5.x, 6.x, 7.x, 8.x Cisco Unity Connection 2.x, 7.x, 8.x Cisco Unified Presence 7.x, 8.x Cisco Unified Contact Center Express 8.x There might be more UC Applications that support the AXL Serviceability interface. Cisco has not yet any official support/documentation for this interface (on other applications than UCM), but if it happens to be there, then use it!

Hardware none

Note: The probe needs to run on a Windows Robot in order for the "Custom CAR Analysis Reporting" functionality to operate.

Installation Notes

Install the package into your local archive

Drop the package from your local archive onto the targeted robot(s)

Double-click the probe for initial configuration.

The following services are needed by the probe:

Cisco AXL Web Service

SOAP Real-Time Service APIs

SOAP Performance Monitoring APIs

Page 5: cisco ucm 1.7x Probe Documentation - Nimsoft · Nimsoft Documentation: cisco_ucm v1.7x 5 5 cisco_ucm This description applies to cisco_ucm version 1.7x. Cisco CallManager is the software-based

Nimsoft Documentation: cisco_ucm v1.7x 5 5

cisco_ucm This description applies to cisco_ucm version 1.7x.

Cisco CallManager is the software-based call-processing component of the Cisco IP Telephony solution that manages IP telephony devices and call services over the data network. The Cisco CallManager provides many functions, such as managing call setup, controlling devices, and collecting statistics on call quality. It can manage IP phones, media processing devices, voice gateways, and multimedia applications.

The Cisco CallManager system extends enterprise telephony features and functions to packet telephony network devices such as:

IP phones

Media processing devices

Voice-over-IP (VoIP) gateways

Multimedia applications

Additional data, voice, and video services interact through Cisco CallManager's open telephony application programming interface (TAPI/JTAPI):

Unified messaging

Multimedia conferencing

Collaborative contact centres

Interactive multimedia response systems

The probe monitors key performance metrics and services on CallManager servers and contains an intuitive user interface that makes it easy for administrators to define hosts to be monitored, activate/deactivate checkpoints, and configure thresholds. The Nimsoft probe’s monitoring capabilities can be achieved without installing any software on the Cisco CallManager servers, and the probe can be extended to monitor all available Cisco performance objects.

The Nimsoft cisco_ucm probe

The Nimsoft cisco_ucm probe is a tool for managing the health and performance of your CallManager systems and services.

Page 6: cisco ucm 1.7x Probe Documentation - Nimsoft · Nimsoft Documentation: cisco_ucm v1.7x 5 5 cisco_ucm This description applies to cisco_ucm version 1.7x. Cisco CallManager is the software-based

Nimsoft Documentation: cisco_ucm v1.7x 6 6

The probe monitors a set of checkpoints on defined agents running the CCM software. These checkpoints are grouped in different folders, and none of them is initially activated for monitoring – you have to activate the ones you want to monitor.

The probe includes an interface, which is used to:

Configure the general properties of the probe.

Defines the hosts to be monitored. Group folders can be created to place the hosts in logical groups.

Activate the checkpoints to be monitored and set the monitoring conditions for these checkpoints.

Create your own alarm messages.

Create and monitor CAR profiles.

Monitor the different checkpoints. The measured values will be presented as a graph.

The probe is QoS enabled, supporting the Nimsoft SLA system. It will send QoS data on profiles where it has been enabled.

Page 7: cisco ucm 1.7x Probe Documentation - Nimsoft · Nimsoft Documentation: cisco_ucm v1.7x 5 5 cisco_ucm This description applies to cisco_ucm version 1.7x. Cisco CallManager is the software-based

Nimsoft Documentation: cisco_ucm v1.7x 7 7

cisco_ucm Configuration

General Setup

Click the General Setup button to open the Setup dialog.

Field Description

General

Log-level Set the detail level for messages logged to the log-file.

Page 8: cisco ucm 1.7x Probe Documentation - Nimsoft · Nimsoft Documentation: cisco_ucm v1.7x 5 5 cisco_ucm This description applies to cisco_ucm version 1.7x. Cisco CallManager is the software-based

Nimsoft Documentation: cisco_ucm v1.7x 8 8

Field Description

Advanced

Check Interval

Select the Check interval from the drop-down list. Valid choices are:

1 minute

5 minutes

15 minutes

30 minutes

1 hour

Check interval is the time gap between each time the probe collects the monitor data and writes to the database.

Sample period

Select the Sample period from the drop-down list. Valid choices are:

6 hours

12 hours

24 hours

48 hours

Sample period is the time range within which the monitored values are picked when calculating the average value (used when setting the alarm threshold). A Sample period of 24 hours means that the samples stored within the last 24 hours will be used.

Max number of threads

Specifies the maximum number of profiles the probe can run simultaneously. The valid range is 0 - 100.

CAR interval

Select the CAR interval from the drop-down list. Valid choices are:

1 minute

5 minutes

15 minutes

Page 9: cisco ucm 1.7x Probe Documentation - Nimsoft · Nimsoft Documentation: cisco_ucm v1.7x 5 5 cisco_ucm This description applies to cisco_ucm version 1.7x. Cisco CallManager is the software-based

Nimsoft Documentation: cisco_ucm v1.7x 9 9

Field Description

30 minutes

1 hour

CAR interval is the time gap between each time the probe collects the data and writes to the database.

Note: For more details on CAR profile, see Defining CAR profile.

Insert CAR details to SLM NIS Database

Checking this box inserts details of collected data for CAR profile into the tbnCDR and tbnCMR database tables.

The details are inserted into the database at the path where data_engine is discovered and validated or defined by the user.

To search and validate the data_engine, select the path from the drop-down or enter the path in the field and click Validate. The user gets confirmation message once the path is validated.

Page 10: cisco ucm 1.7x Probe Documentation - Nimsoft · Nimsoft Documentation: cisco_ucm v1.7x 5 5 cisco_ucm This description applies to cisco_ucm version 1.7x. Cisco CallManager is the software-based

Nimsoft Documentation: cisco_ucm v1.7x 10 10

Creating a new group folder

Groups

Using groups makes the management easier when monitoring large configurations. You can create new groups by right-clicking a group and selecting New Group (or by clicking the New Group tool button).

The left-pane shows the various groups and all hosts belonging to a group. Expanding the host node, you will find a number of folders, sorting the different Call Manager performance objects into different groups.

On selecting a group, all hosts in that group will be listed in the right pane.

On selecting a host, all activated Call Manager performance objects will be listed in the right pane.

On selecting a folder under a host, all Call Manager performance objects grouped in this folder will be listed in the right pane.

Right-click a group to select one of the following actions:

New Host Opens the profile dialog, enabling you to define a new host to be monitored

New Group Opens the profile dialog, enabling you to define a new group Use the group folders to place the hosts in logical groups

Refresh Reflects the current values of the objects listed in the right pane.

Creating a new host profile

You may create a new host profile by selecting the group it should belong to and clicking the Create New Host Profile icon in the menu-bar.

A dialog appears prompting you to select the Unified Server type. By default, Cisco Unified Communications Manager option is selected. Click OK.

Page 11: cisco ucm 1.7x Probe Documentation - Nimsoft · Nimsoft Documentation: cisco_ucm v1.7x 5 5 cisco_ucm This description applies to cisco_ucm version 1.7x. Cisco CallManager is the software-based

Nimsoft Documentation: cisco_ucm v1.7x 11 11

A wizard is launched, guiding you through the steps necessary to define the new host.

Read the instructions in the Welcome dialog and click the Next button to continue.

Page 12: cisco ucm 1.7x Probe Documentation - Nimsoft · Nimsoft Documentation: cisco_ucm v1.7x 5 5 cisco_ucm This description applies to cisco_ucm version 1.7x. Cisco CallManager is the software-based

Nimsoft Documentation: cisco_ucm v1.7x 12 12

Fill in the host name or IP-address of the host to be monitored. Specify also the communication port to be used. Default port is 8443. Click the Next button to continue.

Fill in a valid user name and password with administrative privileges to the Call Manager. Click the Next button to continue.

Page 13: cisco ucm 1.7x Probe Documentation - Nimsoft · Nimsoft Documentation: cisco_ucm v1.7x 5 5 cisco_ucm This description applies to cisco_ucm version 1.7x. Cisco CallManager is the software-based

Nimsoft Documentation: cisco_ucm v1.7x 13 13

A list of nodes available on the host is listed. Select the one you want to use and click the Next button to continue.

You need to provide the FTP details where all the files containing CMR/CDR details will be kept.

Page 14: cisco ucm 1.7x Probe Documentation - Nimsoft · Nimsoft Documentation: cisco_ucm v1.7x 5 5 cisco_ucm This description applies to cisco_ucm version 1.7x. Cisco CallManager is the software-based

Nimsoft Documentation: cisco_ucm v1.7x 14 14

Field Description

Hostname/IP Enter the Hostname/IP address where FTP server is located. It must be the same system on which the probe is installed.

Remote Directory

The directory where the ftp client on the UCM should put the CDR/CMR files.

User Name and Password

Enter the credentials to be used by the ftp client on the UCM.

FTP Actual Path

Directory from where the probe is picking up the CDR/CMR files.

Secure FTP Select Secure FTP option if it is a secure FTP.

Time Zone Offset

Select the Time Zone Offset between the Probe and ucm server.

Page 15: cisco ucm 1.7x Probe Documentation - Nimsoft · Nimsoft Documentation: cisco_ucm v1.7x 5 5 cisco_ucm This description applies to cisco_ucm version 1.7x. Cisco CallManager is the software-based

Nimsoft Documentation: cisco_ucm v1.7x 15 15

Click the Finish button to finish and exit the wizard.

The new host is now listed in the left pane.

Note the symbols indicating if a monitored host responds or not:

Indicates that the host responds. Can access all checkpoints.

Indicates that the host does not respond (host stopped etc.)

Indicates that the host responds, but there are some problems.

Initializing, waiting for measured values from the profile.

Indicates that the profile is created and stored, but is not active.

Right-click the host profile to select one of the following actions:

New Opens the profile dialog, enabling you to define a new host to be monitored or a QoS definition

Edit Opens the profile dialog for the selected host, enabling you to modify the properties for the host.

Page 16: cisco ucm 1.7x Probe Documentation - Nimsoft · Nimsoft Documentation: cisco_ucm v1.7x 5 5 cisco_ucm This description applies to cisco_ucm version 1.7x. Cisco CallManager is the software-based

Nimsoft Documentation: cisco_ucm v1.7x 16 16

Rename Allows you rename the selected group or host. Note that you cannot rename the group Default.

Delete Lets you delete the selected host, group or QoS definition. Note that you cannot delete the group Default.

Refresh Reflects the current values of the objects listed in the right pane.

Reload Retrieves updated configuration information from the selected agent.

Information Opens the window, containing system and configuration information about the selected host.

Product Info

Opens the window containing information about the product that this profile monitors.

Creating a new CDR Analysis and Reporting (CAR) profile

You may create a new CAR profile by clicking the New CAR Profile tool button.

Page 17: cisco ucm 1.7x Probe Documentation - Nimsoft · Nimsoft Documentation: cisco_ucm v1.7x 5 5 cisco_ucm This description applies to cisco_ucm version 1.7x. Cisco CallManager is the software-based

Nimsoft Documentation: cisco_ucm v1.7x 17 17

A wizard is launched, guiding you through the steps necessary to define the new CAR.

Read the instructions in the Welcome dialog and click the Next button to continue.

Page 18: cisco ucm 1.7x Probe Documentation - Nimsoft · Nimsoft Documentation: cisco_ucm v1.7x 5 5 cisco_ucm This description applies to cisco_ucm version 1.7x. Cisco CallManager is the software-based

Nimsoft Documentation: cisco_ucm v1.7x 18 18

Fill in the CAR name or IP-address of the CAR to be monitored. Specify also the communication port to be used. Default port is 8443. Click the Next button to continue.

Fill in a valid user name and password with administrative privileges to the Call Manager. Click the Next button to continue.

Page 19: cisco ucm 1.7x Probe Documentation - Nimsoft · Nimsoft Documentation: cisco_ucm v1.7x 5 5 cisco_ucm This description applies to cisco_ucm version 1.7x. Cisco CallManager is the software-based

Nimsoft Documentation: cisco_ucm v1.7x 19 19

A list of nodes available on the CAR is listed. Select the one you want to use and click the Next button to continue.

While configuring a CAR profile, you are instructing the UCM to push CDR/CMR files to an ftp server. The cisco_ucm probe will pick up these files from the ftp server and analyze them. You need to provide the FTP details, instructing both the ftp client (on the UCM) and the probe, where the CMR/CDR files should be located.

Page 20: cisco ucm 1.7x Probe Documentation - Nimsoft · Nimsoft Documentation: cisco_ucm v1.7x 5 5 cisco_ucm This description applies to cisco_ucm version 1.7x. Cisco CallManager is the software-based

Nimsoft Documentation: cisco_ucm v1.7x 20 20

Field Description

Hostname/IP Enter the Hostname/IP address where FTP server is located. It must be the same system on which the probe is installed.

Remote Directory

The directory where the ftp client on the UCM should put the CDR/CMR files.

User Name and Password

Enter the credentials to be used by the ftp client on the UCM.

FTP Actual Path

Directory from where the probe is picking up the CDR/CMR files.

Secure FTP Select Secure FTP option if it is a secure FTP.

Time Zone Offset

Select the Time Zone Offset between the Probe and ucm server.

Page 21: cisco ucm 1.7x Probe Documentation - Nimsoft · Nimsoft Documentation: cisco_ucm v1.7x 5 5 cisco_ucm This description applies to cisco_ucm version 1.7x. Cisco CallManager is the software-based

Nimsoft Documentation: cisco_ucm v1.7x 21 21

The ftp server should be on the same system as the system running the cisco_ucm probe. For example:

If the ftp users home directory is C:\ìnetpub\wwwroot\user, and the remotedir is configured to "/", the actual path have to be configured to C:\ìnetpub\wwwroot\user

ftp_remotedir = /

ftp_actual_path = C:\ìnetpub\wwwroot\user

Click the Finish button to finish and exit the wizard.

The new CAR is now listed in the left pane.

Note: For more details on CAR please see http://www.cisco.com/en/US/docs/voice_ip_comm/cucm/service/5_0_1/car/caranrpt.html

Generate CAR Analysis Report

You can generate the CAR analysis report by clicking Show CAR Analysis Report button in Tool menu.

CAR Analysis Report gives details of CDR/CMR. Here CDR is Call Detail Records and CMR is Call Management Records.

Page 22: cisco ucm 1.7x Probe Documentation - Nimsoft · Nimsoft Documentation: cisco_ucm v1.7x 5 5 cisco_ucm This description applies to cisco_ucm version 1.7x. Cisco CallManager is the software-based

Nimsoft Documentation: cisco_ucm v1.7x 22 22

In the left pane of this report you can see the Call Identifier which is a unique ID for each call. You can also see Call From and Call To details and the Time at which the call was made. On clicking any of the Call Identifier its respective CMR details will be displayed in the right pane.

In CMR Average Summary analysis, Jitter shows the total Jitters of all CMR. No of Packets Lost shows the total No of Packets Lost in all CMR. Rest of the fields in CMR Average Summary Analysis section show the average of their respective values.

Field Description

jitter This field provides an estimate of the statistical variance of the RTP data packet interarrival time, measured in milliseconds and expressed as an unsigned integer. The interarrival jitter J specifies the mean deviation (smoothed absolute value) of the difference D in packet spacing at the receiver, compared to the sender for a pair of packets. RFC 1889 contains detailed computation algorithms. The value remains zero if the connection was set in "send only" mode. Default is 0

No. of Packets Lost

Shows the No of Packets Lost during the duration of the call.

CCR Cumulative Conceal Ratio represents the cumulative ratio of concealment time over speech time that is observed after starting a call.

Page 23: cisco ucm 1.7x Probe Documentation - Nimsoft · Nimsoft Documentation: cisco_ucm v1.7x 5 5 cisco_ucm This description applies to cisco_ucm version 1.7x. Cisco CallManager is the software-based

Nimsoft Documentation: cisco_ucm v1.7x 23 23

Field Description

ICR Interval Conceal Ratio represents an interval-based average concealment rate that is the ratio of concealment time over speech time for the last 3 seconds of active speech.

ICRmx Interval Conceal Ratio Max represents the maximum concealment ratio that is observed during the call.

CS Conceal Secs represents the time during which some concealment is observed during a call.

SCS Severely Conceal Secs represents the time during which a significant amount of concealment is observed. If the concealment that is observed is usually greater than 50 milliseconds or approximately 5 percent, the speech probably does not seem very audible.

MLQK MOS Listening Quality K-factor provides an estimate of the MOS score of the last 8 seconds of speech on the reception signal path.

MLQKmn MOS Listening Quality K-factor Min represents the minimum score that is observed since the beginning of a call and represents the worst sounding 8-second interval.

MLQKmx MOS Listening Quality K-factor Max represents the maximum score that is observed since the beginning of a call and represents the best sounding 8-second interval.

MLQKav MOS Listening Quality K-factor Avg8 represents the running average of scores that are observed since the beginning of a call.

Phone Table

The Phone Table button allows you to view information about registered phone devices.

To view information about registered phone devices

1. In the left pane, click a configured profile.

2. In the toolbar, click Phone Table.

The phone details report appears.

Page 24: cisco ucm 1.7x Probe Documentation - Nimsoft · Nimsoft Documentation: cisco_ucm v1.7x 5 5 cisco_ucm This description applies to cisco_ucm version 1.7x. Cisco CallManager is the software-based

Nimsoft Documentation: cisco_ucm v1.7x 24 24

Note: If there are no phone details available, the probe generates a blank Phone Table report.

Page 25: cisco ucm 1.7x Probe Documentation - Nimsoft · Nimsoft Documentation: cisco_ucm v1.7x 5 5 cisco_ucm This description applies to cisco_ucm version 1.7x. Cisco CallManager is the software-based

Nimsoft Documentation: cisco_ucm v1.7x 25 25

Custom CAR Analysis Reporting

The CAR data is stored in the tbnCDR and tbnCMR database tables in your NIS database. Using reporting tools, such as Nimsoft’s Unified Reporter, you can create your own CAR Analysis reports. For more details please refer UMP documentation.

Checkpoint monitoring properties

Double-clicking a checkpoint in the right window pane opens the Monitor Properties dialog for the checkpoint, enabling you to modify the monitoring properties for the checkpoint.

Field Description

Name This field allows you to create your own name of the monitoring object (checkpoint). If desired, replace the original name with a name of your own choice.

Monitoring object

This is the name of the monitoring object (checkpoint) and cannot be changed.

Page 26: cisco ucm 1.7x Probe Documentation - Nimsoft · Nimsoft Documentation: cisco_ucm v1.7x 5 5 cisco_ucm This description applies to cisco_ucm version 1.7x. Cisco CallManager is the software-based

Nimsoft Documentation: cisco_ucm v1.7x 26 26

Field Description

Description This field allows you to create your own description of the monitoring object (checkpoint). Click the Query Description button to get a description from the system...

Enable Monitoring

Select this option to activate the monitoring of the checkpoint.

Note that the checkpoint will also be ticked in the list of checkpoints in the right window pane when this option is selected, and that you can enable/disable monitoring of the checkpoint from that list.

Value definition

Decides which value to be compared with the Threshold value defined below. The two options are:

Current value

Average value

Delta value (current-previous)

Current value

Uses the last measured value to be compared with the Threshold value defined below

Average value

Computes the average of the values measured in the time interval selected from the drop-down list.

You may select one of the predefined intervals from the drop-down list or you may type your own value in the field.

Delta value (current-previous)

The delta value (current –previous) This means that the delta value calculated from the current and the previous measured sample will be used.

Enable Monitoring

Ticking this option activates the monitoring of the checkpoint.

Note that the checkpoint will also be ticked in the list of checkpoints in the right window pane when this option is selected, and that you can enable/disable monitoring of the checkpoint from that list.

Threshold Value

The alarm threshold value If this value is exceeded (see value and operator above).

Note: For some checkpoints (services), the threshold is not a value, but a condition (either running or not

Page 27: cisco ucm 1.7x Probe Documentation - Nimsoft · Nimsoft Documentation: cisco_ucm v1.7x 5 5 cisco_ucm This description applies to cisco_ucm version 1.7x. Cisco CallManager is the software-based

Nimsoft Documentation: cisco_ucm v1.7x 27 27

Field Description

running). Then the threshold must be selected as a fixed condition/status from a drop-down list. The Unit field (see below) does not apply and will be hidden.

Unit You can fill in a unit of the monitored value in this field (for example %, Mbytes etc.). The field is initially empty.

Message Token

Select the alarm message to be issued if the specified threshold value is breached. These messages are kept in the message pool. They can be modified in the Message Pool Manager (see Launching the Message Pool Manager (below).

Publish Quality of Service (QoS)

If this option is checked, QoS data will be sent at the specified check interval for the profile.

QoS Name Here you may define a new QoS, you may select the default QoS or another available Default QoS for the variable.

Page 28: cisco ucm 1.7x Probe Documentation - Nimsoft · Nimsoft Documentation: cisco_ucm v1.7x 5 5 cisco_ucm This description applies to cisco_ucm version 1.7x. Cisco CallManager is the software-based

Nimsoft Documentation: cisco_ucm v1.7x 28 28

Note the meaning of the different icons in the window:

This indicator may be - green (means OK) - black (means the checkpoint is not active) - other colors: Indicates that the monitor is activated for monitoring, and the threshold value defined in the properties dialog for the monitor is exceeded. The color reflects the message token selected in the properties dialog for the monitor.

This indicator means that the checkpoint is not available at the host. This indicator will also preliminary appear for checkpoints that are available at the host if configuration changes have been made and the probe has been restarted. The indicator will disappear when measured values are returned from the checkpoint.

Right-click an object to select one of the following actions:

Edit Opens the Monitor Properties dialog, enabling you to modify the monitoring properties for the selected checkpoint.

Delete Using this option; you can delete the checkpoint from the list. If you later want to monitor it again, you must locate it in its group in the left pane and activate it.

Activate Activates the selected checkpoint to be monitored by the probe. Note that you may also activate it by clicking the check box belonging to the checkpoint.

Deactivate Deactivates the selected checkpoint (if activated), and the probe will stop monitoring the checkpoint.

Monitor Opens the monitor window for the selected checkpoint, showing the values recorded. The sample period in the Setup section sets the maximum time range shown in the window. This time range can be set to a lower value, changing the backlog to a lower value (see below).

Page 29: cisco ucm 1.7x Probe Documentation - Nimsoft · Nimsoft Documentation: cisco_ucm v1.7x 5 5 cisco_ucm This description applies to cisco_ucm version 1.7x. Cisco CallManager is the software-based

Nimsoft Documentation: cisco_ucm v1.7x 29 29

Note: The horizontal red line in the graph indicates the alarm threshold (in

this case 36000) defined for the checkpoint.

When clicking and holding the left mouse button inside the graph, a red vertical line appears. If you continue to hold the left mouse-button down and move the cursor, you can read the exact value at different points in the graph. The value is displayed in the upper part of the graph on the format: <Day> <Time> <Value>.

Right-clicking inside the monitor window lets you select the backlog (the time range shown in the monitor window). In addition, the right-click menu lets you select the option Show Average. This adds a horizontal blue line in the graph, representing the average sample value.

Note: The status bar at the bottom of the monitor window. The following information can be found:

o The number of samples since the probe was started.

o The minimum value measured.

Page 30: cisco ucm 1.7x Probe Documentation - Nimsoft · Nimsoft Documentation: cisco_ucm v1.7x 5 5 cisco_ucm This description applies to cisco_ucm version 1.7x. Cisco CallManager is the software-based

Nimsoft Documentation: cisco_ucm v1.7x 30 30

o The average value measured.

o The maximum value measured.

o The backlog This is the time range shown in the monitor window. The backlog can be selected to 6, 12, 24 or 48 hours by right-clicking inside the graph. Note that the graph cannot show a time range that is greater than the selected Sample Period setting in the Setup section of the GUI.

Add to Template

Gives an option to add this monitor to a template.

Launching the Message Pool Manager

The Message Pool Manager is launched by clicking the Message Pool button in the Tool bar.

The alarm messages for each alarm situation are stored in the Message Pool. Using the Message Pool Manager, you can customize the alarm text, and you may also create your own messages.

Note that variable expansion in the message text is supported. If typing a ‘$’ in the Alarm text field, a dialog pops up, offering a set of variables to be chosen.

Get Values

Page 31: cisco ucm 1.7x Probe Documentation - Nimsoft · Nimsoft Documentation: cisco_ucm v1.7x 5 5 cisco_ucm This description applies to cisco_ucm version 1.7x. Cisco CallManager is the software-based

Nimsoft Documentation: cisco_ucm v1.7x 31 31

Clicking this button refreshes the window to display the most current measured values for the monitors.

AutoConfigurations The right pane of the application shows the list of all checkpoints of the selected monitoring object group.

Same checkpoints can belong to different instances. To configure such checkpoint, which is same across different instances, AutoConfiguration option can be used.

Select the checkpoint to be configured and drag and drop it in AutoConfiguration.

Page 32: cisco ucm 1.7x Probe Documentation - Nimsoft · Nimsoft Documentation: cisco_ucm v1.7x 5 5 cisco_ucm This description applies to cisco_ucm version 1.7x. Cisco CallManager is the software-based

Nimsoft Documentation: cisco_ucm v1.7x 32 32

Now click the AutoConfiguration option. In the right pane, you will see the list of all checkpoints selected for Auto Configuration.

Double click the checkpoint which is to be configured. Auto Configuration Properties window opens.

Page 33: cisco ucm 1.7x Probe Documentation - Nimsoft · Nimsoft Documentation: cisco_ucm v1.7x 5 5 cisco_ucm This description applies to cisco_ucm version 1.7x. Cisco CallManager is the software-based

Nimsoft Documentation: cisco_ucm v1.7x 33 33

Field Description

Name This field allows you to create your own name of the monitoring object (counter). If desired, replace the original name with a name of your own choice.

Monitoring object

This is the name of the monitoring object (counter) and cannot be changed.

Description This field allows you to create your own description of the monitoring object (counter). Click the Query Description button to get a description from the system...

Value definition

Decides which value to be compared with the Threshold value defined below. The two options are:

Current value

Average value

Delta value (current-previous)

Current value: Uses the last measured value to be compared with the Threshold value defined below

Average value: Computes the average of the values measured in the time interval selected from the drop-down list.

You may select one of the predefined intervals from the drop-down list or you may type your own value in the field.

Delta value (current-previous): The delta value (current –previous) This means that the delta value calculated from the current and the previous measured sample will be used.

Enable Monitoring

Select this option to activate the monitoring of the counter.

Note that the counter will also be ticked in the list of checkpoints in the right window pane when this option is selected, and that you can enable/disable monitoring of the counter from

Page 34: cisco ucm 1.7x Probe Documentation - Nimsoft · Nimsoft Documentation: cisco_ucm v1.7x 5 5 cisco_ucm This description applies to cisco_ucm version 1.7x. Cisco CallManager is the software-based

Nimsoft Documentation: cisco_ucm v1.7x 34 34

After configuring the checkpoint properties, click the Apply option on the left bottom of the screen. Click Yes to restart the probe.

Now, you have successfully auto configured a checkpoint. The properties defined for a checkpoint using auto configuration will be same across all its instances.

that list.

Threshold Value

The alarm threshold value If this value is exceeded (see value and operator above).

Note: For some checkpoints (services), the threshold is not a value, but a condition (either running or not running). Then the threshold must be selected as a fixed condition/status from a drop-down list. The Unit field (see below) does not apply and will be hidden.

Unit You can fill in a unit of the monitored value in this field (for example %, Mbytes etc.). The field is initially empty.

Message Token

Select the alarm message to be issued if the specified threshold value is breached. These messages are kept in the message pool. They can be modified in the Message Pool Manager (see Launching the Message Pool Manager (below).

Publish Quality of Service (QoS)

If this option is checked, QoS data will be sent at the specified check interval for the profile.

QoS Name Here you may define a new QoS, you may select the default QoS or another available Default QoS for the variable.

Page 35: cisco ucm 1.7x Probe Documentation - Nimsoft · Nimsoft Documentation: cisco_ucm v1.7x 5 5 cisco_ucm This description applies to cisco_ucm version 1.7x. Cisco CallManager is the software-based

Nimsoft Documentation: cisco_ucm v1.7x 35 35

AutoMonitors

Once a checkpoint has been successfully configured using auto configuration, all the instances of such a checkpoint will be displayed in the right pane on clicking Auto Monitor option.

You can modify checkpoint properties by double clicking any of the instances in Auto Monitor.

On double clicking any of the checkpoint in the Auto Monitor, following dialogue appears.

If you modify any of the checkpoint properties in Auto Monitor, it will become static and it will not be auto monitored. It will no longer appear in Auto Monitor list. All the checkpoints which appear in Auto Monitor cannot be deactivated directly.

On trying to deactivate such checkpoints you will get following message

Page 36: cisco ucm 1.7x Probe Documentation - Nimsoft · Nimsoft Documentation: cisco_ucm v1.7x 5 5 cisco_ucm This description applies to cisco_ucm version 1.7x. Cisco CallManager is the software-based

Nimsoft Documentation: cisco_ucm v1.7x 36 36

You can only disable the monitoring of a checkpoint by de-selecting the Enable Monitoring option.

Page 37: cisco ucm 1.7x Probe Documentation - Nimsoft · Nimsoft Documentation: cisco_ucm v1.7x 5 5 cisco_ucm This description applies to cisco_ucm version 1.7x. Cisco CallManager is the software-based

Nimsoft Documentation: cisco_ucm v1.7x 37 37

QoS

The QoS node is present in the left pane of the probe GUI.

This node contains the standard QoS definitions included with the probe package. These can be selected when editing the monitoring properties for a monitor.

To define your own QoS definitions, right-click the QoS node and select New.

Publish Quality of Service

You can select to publish Quality of Service data by checking the Publish QoS option in the properties dialog for a variable.

From the drop-down list at the bottom of the dialog, you may select one of the following:

The default QoS for the variable

Define and a new QoS

Select one of the defined QoS definitions, if any.

Apply the settings by clicking the OK button to exit the dialog and then click the Apply button on the Probe User Interface.

Adding a new Quality of Service

You can add new Quality of Service by opening the properties dialog for a variable, checking the Publish Quality of Service option and selecting Add a new QoS Definition from the drop-down list at the bottom of the dialog.

The QoS Properties dialog for the variable appears.

Page 38: cisco ucm 1.7x Probe Documentation - Nimsoft · Nimsoft Documentation: cisco_ucm v1.7x 5 5 cisco_ucm This description applies to cisco_ucm version 1.7x. Cisco CallManager is the software-based

Nimsoft Documentation: cisco_ucm v1.7x 38 38

Define your QoS and click the OK button to save and exit. The new QoS definition will now appear in the QoS drop-down list at the bottom of the Variable dialog and under the QoS node in the Navigation Pane. The group specified in the dialog will appear under the Quality of Service node in the Service Level Manager, containing the new variable.

Page 39: cisco ucm 1.7x Probe Documentation - Nimsoft · Nimsoft Documentation: cisco_ucm v1.7x 5 5 cisco_ucm This description applies to cisco_ucm version 1.7x. Cisco CallManager is the software-based

Nimsoft Documentation: cisco_ucm v1.7x 39 39

Templates

Templates are a useful tool for defining monitors to be measured on the various hosts, or folders under host node.

You may create templates and define a set of monitors belonging to that template. These templates are applied to a group or hosts under a group by dragging and dropping the template on the group/host, where you want to measure the monitors defined for the template. You may also drop a template on a host in the tree structure, and the template will be assigned to the particular folder under that host.

Creating a template

In the left pane, right-click the Templates node, and then click New.

Note that you may also edit an existing template by selecting one of the templates defined (found by expanding the Templates node and selecting Edit).

The Template Properties dialog appears, letting you specify a Name and a Description for the new template.

Adding monitors to the template

Drag checkpoints from the right pane and drop on the template in the left pane.

Page 40: cisco ucm 1.7x Probe Documentation - Nimsoft · Nimsoft Documentation: cisco_ucm v1.7x 5 5 cisco_ucm This description applies to cisco_ucm version 1.7x. Cisco CallManager is the software-based

Nimsoft Documentation: cisco_ucm v1.7x 40 40

A message appears inquiring whether you wish to create a wild card monitor or a fixed monitor.

To create a wildcard monitor select the first option (the one which has “\*”) and click OK.

You may now edit the properties for the monitors under the template.

Page 41: cisco ucm 1.7x Probe Documentation - Nimsoft · Nimsoft Documentation: cisco_ucm v1.7x 5 5 cisco_ucm This description applies to cisco_ucm version 1.7x. Cisco CallManager is the software-based

Nimsoft Documentation: cisco_ucm v1.7x 41 41

Applying a template to a group/host

Drag and drop the template on the group/host where you want to measure the monitors defined for the template.

Note that you may drop the template on a group containing multiple hosts/folders.

You will then be asked if you want to apply the template to all hosts/folders under the node. You may also drop a template on a node in the tree structure, and the template will be assigned to the particular folder under that host.

Page 42: cisco ucm 1.7x Probe Documentation - Nimsoft · Nimsoft Documentation: cisco_ucm v1.7x 5 5 cisco_ucm This description applies to cisco_ucm version 1.7x. Cisco CallManager is the software-based

Nimsoft Documentation: cisco_ucm v1.7x 42 42

Checkpoint Metrics

The following table describes the checkpoint metrics that can be configured using the cisco_ucm probe.

Metric Name Units Description

QOS_CCM_CALLS Calls Cisco CallManager Calls

QOS_CCM_DEVICES Value Cisco CallManager Devices

QOS_CCM_NUM Number Number Count

QOS_CCM_PERFORMANCE Value Cisco CallManager Performance

QOS_CPU_USAGE Percent CPU Usage

QOS_DISK_USAGE_PERC Percent Disk Usage (%)

QOS_MEMORY_USAGE_CCM KBytes Cisco CallManager Memory Usage

QOS_MEMORY_USAGE_PERC Percent Memory Usage (%)

QOS_PROCESS_MEMORY Kilobytes Process Memory Usage

QOS_SERVICE_STATE State Cisco CallManager Service Availability

~~End of Document~~