4.31 LocationsList

Use this Knowledge Script to monitor all combinations of Cisco’s location bandwidth counters, including inter-location pairs. Raises an event if a threshold is exceeded. Generates data streams for available bandwidth, bandwidth usage (%), bandwidth-related call failures, available video bandwidth, video bandwidth usage (%), and bandwidth-related failures of video stream requests. This Knowledge Script provides the same data streams as the Locations Knowledge Script. with the difference in how the locations to be monitored are specified. The Locations knowledge script drops on location treeview objects and monitors bandwidth within each location. This script drops on the server object and monitors both bandwidth within the location as well as bandwidth usage between location pairs.

When monitoring by regular expression, the LocationsList Knowledge Script collects a list of all known location instance(s) from the server. The job created by this Knowledge Script compares the list of location instance names collected against the parameter, which can be either a csv list of the locations for which data is to be collected or, if the evaluate instance name(s) as regular expression is selected, a regular expression which can be applied to filter the location names to collect. If no names match, an error event is raised stating that the regular expression did not find any instances, and providing a list of the instances which were found but not matched.

Pattern matching is done using Perl syntax regular expression as provided by the 1.32.0 Boost library described at Boost.org.

The following table shows examples of Boost regular expressions:

To search for:

Expression

Example

All Instances

.*

Matches all location objects and inter-location pairs known to a server.

All things to, from, and within a named location

(.*->)*(locationName)(->.*)*

Matches both the location named "locationname" and all inter-location pairs to or from "locationname"

4.31.1 Resource Object

CiscoCM_CMServer

4.31.2 Default Schedule

By default, this script runs every 30 minutes.

4.31.3 Setting Parameter Values

Set the following parameters as needed:

Parameter

How to Set It

General Settings

Job Failure Notification

 

Event severity when job fails

Set the event severity level, from 1 to 40, to indicate the importance of the failure of the Location List job. The default is 5.

Locations Specifications

Name of location instance(s) to monitor (leave blank for all locations)

Type the name of the location instance you want to monitor. An instance distinguishes between multiple objects of the same type on a single computer. You can specify comma-separated, multiple instance names. to monitor all locations instance(s), do not specify any location instances. The default is blank, so all location instances, including inter-location pairs are monitored.

Evaluate instance name(s) as regular expression?

Select Yes to evaluate the location instance name(s) as to evaluate the location name string as a Boost regular expression rather than a CSV list. The default is unselected, or a CSV list.

NOTE:If entering CSV list, you must specify any inter-location pairs using the exact pair name because the location names are matched exactly. For example, the list A,B only matches the intra-location counters for A and B. To get the inter-location metrics, you must specify A,B, A->B, and B->A, as well. When inter location pair metrics are desired, regular expressions (such as “.*->.*”) are recommended

Intervals between re-evaluation of location matches (Enter 0 to never re-evaluate)

Specify the desired number of intervals to determine how often to re-evaluate the regular expression or all locations list against the CiscoCM location counters. The default is 96 intervals. The regular expression or location list will be re-evaluated to match against new locations when the specified number of intervals has elapsed. Type 0 to never re-evaluate.

NOTE:It is recommended not to set the interval to 0 as the interval might have a negative impact in medium to large environments.

Raise event if filtered locations have been found?

Select Yes to raise an event if the filtered locations were found. The default is not to raise an event.

Event severity when filtered have found

Set the event severity level, from 1 to 40, to specify the number of filtered locations that were found. The default is 25.

Raise event if filtered locations have not been found?

Select Yes to raise an event if the filtered locations were not found. The default is 25.

Event severity when filtered have not been found

Set the event severity level, from 1 to 40, to specify the number of filtered locations that were found. The default is 25.

Monitor Available Bandwidth

Data Collection

 

Collect data for available bandwidth?

Select Yes to collect data for charts and reports. If enabled, data collection returns the amount of bandwidth available at each script iteration. The default is unselected.

Monitor Bandwidth Usage

 

Event Notification

 

Raise event if bandwidth usage exceeds threshold?

Select Yes to raise an event if the percentage of bandwidth usage exceeds the threshold. The default is Yes.

Threshold - Maximum bandwidth usage

Specify the maximum percentage of bandwidth usage that must be detected before an event is raised. The default is 90%.

Event severity when bandwidth usage exceeds threshold

Set the event severity level, from 1 to 40, to indicate the importance of an event in which the percentage of bandwidth usage exceeds the threshold you set. The default is 15.

Data Collection

 

Collect data for bandwidth usage?

Select Yes to collect data for charts and reports. If enabled, data collection returns the percentage of bandwidth usage at each script iteration. the default is unselected.

Monitor Call Failures Caused By Insufficient Bandwidth

Event Notification

 

Raise event if call failures exceed threshold

Select Yes to raise an event if the number of calls that failed because of insufficient bandwidth exceeds the threshold. The default is Yes.

Threshold - Maximum failed calls

Specify the maximum number of calls that must fail before an event is raised. The default is 0 failures.

Event severity when failed calls exceed threshold

Set the event severity level, from 1 to 40, to indicate the importance of an event in which the number of call that failed because of insufficient bandwidth exceeds the threshold you set. The default is 15.

Data Collection

 

Collect data for failed calls?

Select Yes to collect data for charts and reports. If enabled, data collection returns the number of call failures caused by insufficient bandwidth during the monitoring period. The default is unselected.

Monitor Available Video Bandwidth

Data Collection

Collect data for available video bandwidth?

Select Yes to collect data for charts and reports. If enabled, data collection returns the amount of video bandwidth available at each script iteration. The default is unselected.

Monitor Video Bandwidth Usage

Event Notification

Raise event if video bandwidth usage exceeds threshold?

Select Yes to raise an event if the percentage of video bandwidth usage exceeds the threshold. The default is Yes.

Threshold - Maximum video bandwidth usage

Specify the maximum percentage of video bandwidth usage that must occur before an event is raised. The default is 90%.

Event severity when video bandwidth usage exceeds threshold

Set the event severity level, from 1 to 40, to indicate the importance of an event in which the percentage of video bandwidth usage exceeds the threshold you set. The default is 15.

Data Collection

 

Collect data for video bandwidth usage?

Select Yes to collect data for charts and reports. If enabled, data collection returns the percentage of video bandwidth usage at each script iteration. The default is unselected.

Monitor Failed Video Stream Requests Caused by Insufficient Bandwidth

Event Notification

Raise event if failed video stream requests exceed threshold?

Select Yes to raise an event if the number of video stream requests that fail because of insufficient bandwidth exceeds the threshold. The default is Yes.

Threshold - Maximum failed video stream requests

Specify the maximum number of video stream requests that must fail before an event is raised. The default is 0 requests.

Event severity when failed video stream requests exceed threshold

Set the event severity level, from 1 to 40, to indicate the importance of an event in which the number of video stream requests that fail because of insufficient bandwidth exceeds the threshold you set. The default is 15.

Data Collection

 

Collect data for failed video stream requests?

Select Yes to collect data for charts and reports. If enabled, data collection returns the number of bandwidth-related failures of video stream requests that occurred during the monitoring period. The default is unselected.