User Guide for CiscoWorks Health and Utilization Monitor 1.0
Chapter 4 Poller Configuration

Table Of Contents

Poller Configuration

Managing Pollers

Creating a Poller

Instance Selector

Editing a Poller

Deleting a Poller

Deactivating a Poller

Activating a Poller

Viewing Failures

Clearing Failures

Viewing Poller Configuration Details

Filtering Poller List

Managing Templates

Creating a Template

MIB Variable Selector

Editing a Template

Deleting a Template

Copying a Template

Exporting a Template

Importing a Template

Filtering Template List

Viewing Template Details


Poller Configuration


This chapter explains how to manage Pollers and Templates from the Poller page. The chapter contains the following topics:

Managing Pollers

Managing Templates

Managing Pollers

Poller Management is one of the main features of CiscoWorks HUM. Poller Management page allows you to create and manage Pollers. A Poller is a collection of devices and templates configured in HUM to monitor the utilization and availability levels of devices connected to the network.

From the Poller Management page you can create a Poller, modify the configuration of a Poller, delete a Poller, stop a Poller from polling the devices, view polling failures and so on.

To access the Poller Management page go to LMS Portal and select Health and Utilization Monitor > Poller and Template Management > Poller Management. The List of Pollers dialog appears.

Table 4-1 describes the fields and buttons in the List of Pollers dialog box.

Table 4-1 List of Pollers Field/Button Description 

Field / Button Name
Description

Poller Name

Displays the Poller name.

For example, XYZ Router

Interval

Polling interval assigned to the poller.

Polling interval is duration after which HUM queries the MIB variable on the device. Here the duration is calculated in terms of minutes and hours.

For example, if the Polling Interval for a Poller is set as 15 minutes and the first polling cycle starts at 10:00 a.m., the next polling cycle is scheduled to start at 10:15 a.m.

No. of Devices

Number of devices added to the Poller.

No. of Templates

Number of templates added to the Poller.

Status

Status of a Poller.

The following Poller status is displayed:

Active—HUM is currently polling for device instances.

Inactive—HUM has stopped polling for device instances.

Missed Cycles

Number of polling interval cycles missed during polling.

For example, if the Polling Interval for a Poller is set as 15 minutes and the first polling cycle starts at 10:00 a.m., the next polling cycle is scheduled to start at 10:15 a.m. If the polling cycle that started at 10.00 a.m. does not complete before 10:15 a.m., then the next polling cycle will start only at 10:30 a.m. The polling cycle missed at 10:15 is called Missed Cycle.

The following are some of the possible reasons that may cause Missed Cycles:

Frequent SNMP timeouts

Delayed network response

Unreachable devices

Poll Start Time

Displays the last polling cycle start time. For example, 09 May 2007, 15:30:05

Poll End Time

Displays the last polling cycle end time. For example, 09 May 2007, 15:45:05

Create

(button)

Creates a Poller. See Creating a Poller.

Clear Failures

(button)

Clears all the 24-hour failures recorded for a Poller. See Clearing Failures.

Edit

(button)

Modifies an existing Poller. See Editing a Poller.

Delete

(button)

Deletes an existing Poller. See Deleting a Poller.

Activate

(button)

Activates a deactive Poller for polling. See Activating a Poller.

De-activate

(button)

Stops a Poller from polling. See Deactivating a Poller.

Filter

Filters Pollers based on the criteria selected from the drop-down list.

The drop-down list contain the following criteria:

Poller Name

Interval

Status

See Filtering Poller List

Refresh

Click the Refresh Icon to reload the page.


You can perform the following tasks from the List of Pollers dialog box:

Creating a Poller

Editing a Poller

Deleting a Poller

Deactivating a Poller

Activating a Poller

Viewing Failures

Clearing Failures

Filtering Poller List

Viewing Poller Configuration Details

Creating a Poller

You can create a Poller by adding devices and selecting appropriate templates to poll the devices. You can also set polling frequencies to poll the devices. The Poller polls the devices for the template MIB variable and collects the device data. The polled data can be used to analyze the utilization and availability of devices through reports. For more information, see Reports.

To create a Poller:


Step 1 Go to LMS Portal and select Health and Utilization Monitor > Poller and Template Management > Poller Management.

The List of Pollers dialog box appears.

Step 2 Click Create.

The Select Devices and Templates page appears, displaying the Devices and Templates dialog box.

Table 4-2 describes the fields in the Devices and Templates dialog box.

Table 4-2 Devices and Templates Fields 

Field / Button
Description
Device Selector

Search Input

Enter your search expression in this field.

You can enter the device name. For example, 3500XL.

Search

Use the search icon to perform a simple search of devices, after you have entered your search input.

For more information on how to use Device Selector, see User Guide for CiscoWorks Common Services 3.1.

Advanced Search

Search for devices by specifying a set of rules.

For more information on Advanced Search, see User Guide for CiscoWorks Common Services 3.1.

All

Click All to view all the devices added to the DCR in a hierarchical format (tree view).

Check the checkboxes to select the devices.

Search Results

Displays all your Simple or Advanced search results. You can do a select all, clear all, or select a few devices from the list.

Selection

Displays all the devices that you have selected using the All or Search Results tab.

Poller Details

Poller Name

Enter a descriptive name for the Poller.

The name can contain a mix of alphabets, numerals and special characters (such as -_.#@&$).

Polling Interval

Select a poll interval from the drop-down list.

Polling Interval is the duration after which HUM queries the MIB variable on the device. Polling Interval is set as 5 minutes, by default.

Templates

Available Templates

Displays the list of System-defined and User-defined templates.

Selected Templates

Displays the list of templates selected for polling.

Add

(button)

Adds templates to the Selected Templates list.

Remove

(button)

Removes templates from the Selected Templates list.

Add User Defined Templates

(button)

Creates and adds user-defined templates to the Available Templates list.

Poller Preferences

Poll all Instances

Polls all the instances of the device for the selected template.

For example,

1. Create a Poller by adding a device.

2. Select Interface Utilization template.

3. Select the Poll all Instances checkbox.

In this case, all the interfaces in the device are polled for the Interface Utilization data.


Step 3 Add devices to the Poller by selecting devices from the Device Selector pane.

For more information on how to use Device Selector, see User Guide for CiscoWorks Common Services 3.1.

Step 4 Enter a descriptive name for the Poller in the Poller Name field.

Step 5 Choose a poll interval from the Polling Interval drop-down list.

The default poll interval is set as 5 minutes, but you can make polling occur at any of the following intervals:

1 minute

5 minutes

15 minutes

30 minutes

1 hour

2 hours

4 hours

8 hours

Step 6 Add templates to the Poller by selecting templates from the Available Templates list in the Templates pane.

To select more than one template hold down the Ctrl key.

Step 7 Click Add to add the templates to the Selected Templates list.

Or

Click Remove to remove the templates from the Selected Templates list.

Step 8 Click Add User Defined Templates to create user-defined templates.

You can use the Add User Defined Templates button not only to create new templates, but also to add the newly created templates to the Available Templates list. For more information, see Creating a Template.

Step 9 Go to the Poller Preferences pane in the Select Devices and Templates dialog box. Either:

a. Check Poll all Instances to poll all the instances of the device for the selected template.

b. Click Finish in the Select Devices and Templates dialog box to complete creating the poller.

Or

c. Go to Step 10 to continue.

Step 10 Click Next.

CiscoWorks HUM polls the devices to get the instance information, indicated by a progress bar.

The instance query process may take several minutes based on the number of devices selected.

The Select Instances page appears, displaying the Available Instances dialog box. You can search and select instances using the Available Instances dialog box. For more information, see Instance Selector.

Table 4-3 describes the fields in the Available Instances dialog box.

Table 4-3 Available Instances Fields

Field/Tab
Description

Search Input

Enter your search expression in this text field.

You can enter only a single instance name in this field. The search string is not case sensitive.

To search multiple instances, you can enter the instance name with wildcard character *. This will locate the instances that match the text string that you enter.

Search

Use this icon to perform a Simple search, after you have entered your search input. See Performing Simple Search.

Advanced Search

Use this icon to perform an Advanced search. See Performing Advanced Search.

All

Lists all the devices you have selected in the Select Devices and Templates page in a hierarchical format (tree view). Check the checkbox to select the instance.

You can select all instances, clear all instances, or select a few instances from the list.

Search Results

Displays all your Simple or Advanced search results and you can select all instances, clear all instances, or select a few instances from the list.

Selection

Lists all the instances that you have selected in the All or Search Results tab or through a combination of both. You can also use this tab to deselect the instances you have already selected.

You can perform more than one search and can accumulate your selection of instances.

Refresh

(button)

Click Refresh to repoll the devices to get instance information.


Step 11 Select the required instances from the instance tree.

Step 12 Click Next.

The Poller Summary page appears, displaying the Poller configuration details.

To modify the Poller configuration, click Back until you reach the dialog box you want.

Table 4-4 describes the fields in the Poller Summary page.

Table 4-4 Poller Summary Field Description

Field
Description

Name

Displays the Poller name.

Summary

Polling Interval

Displays the time interval selected for polling.

Instance Details

Displays the instances selected in a tree structure:

Device name—Device selected for polling.

Template name—Template applied for polling.

Instance name—Instance selected for polling.


Step 13 Click Finish.

The Poller details are added to the database.

A pop-up message appears confirming Poller creation.

Step 14 Click OK and the List of Pollers dialog box appears, displaying the Poller.

The data polled is stored in the database and you can use the data to generate Poller reports.

An audit trail message is logged in the database. For more information, see View Audit Trail Log Report.


Instance Selector

You can use the Available Instances dialog box to search and select instances in a device. You can search for instances using a Simple Search or an Advanced Search.

Table 4-3 describes the fields and tabs in the Available Instances dialog box.

Performing Simple Search

You can enter your search criteria in the Search Input field and search for the instances using the Search icon.

Note the following points when you perform a simple search.

You can use the wildcard character * to search for multiple instances that match the text string that you enter.

If you are not using the wildcard character, make sure that you enter the full instance name.

Performing Advanced Search

Use the Advanced Search icon to open the Define Advanced Search Rule pop-up window and specify a rule to perform an Advanced search.

Table 4-5 describes the fields and buttons in the Define Advanced Search Rule window.

Table 4-5 Define Advanced Search Rule Field/Button Description

Field/Button
Description

Variable

Select a variable from the drop-down list. For example, Instance Name.

The list of variables for Advanced Search are:

Device Name

Template Name

Instance Name

Operator

The operator to be used in the rule. The list of operators are:

Starts with

Ends with

Equals

Contains

Search Expression

Enter your search expression in this text field.

Search

(button)

Used to search for instances based on the defined rule.

Clear

(button)

Clears the Search Expression field.

Cancel

(button)

Cancels Advanced search.


If you want to perform a new search, click Clear before selecting any new instances.

Example—Using Advanced Search

The following example describes the procedure for selecting instances using Advanced search.

To perform Advanced search:


Step 1 Click the Advanced Search icon in the Available Instances dialog box.

The Define Advanced Search Rule dialog box appears.

Step 2 Create a search rule expression. To do so:

a. Select Variable as Instance Name

b. Select Operator as equals

c. Enter the search expression as Supervisor

Step 3 Click Search.

The instances that satisfy the specified rule appear in the Available Instances dialog box.


Editing a Poller

You can edit a Poller to update or change the selection of devices, templates, instances, and polling frequencies using the edit wizard.

You can edit only one Poller at a time. If you select multiple Pollers using the checkbox, the Edit button is disabled. You cannot edit the Poller Name field.

To edit a Poller:


Step 1 Go to LMS Portal and select Health and Utilization Monitor > Poller and Template Management > Poller Management.

The List of Pollers dialog box appears.

Step 2 Select the Poller by checking the corresponding checkbox against the Poller Name.

Step 3 Click Edit.

The Select Devices and Templates dialog box appears, displaying the earlier settings.

See Creating a Poller for the descriptions of fields that appear in the Select Devices and Templates dialog box.

Step 4 Make the necessary changes to the Device Selector, Poller Details, and Templates panes.

Step 5 Go to the Poller Preferences pane in the Select Devices and Templates dialog box. Either:

a. Check Poll all Instances to select all instances of the template MIB variable.

b. Click Finish in the Select Devices and Templates dialog box to complete updating the Poller.

Or

c. Go to Step 6 to continue.

Step 6 Click Next.

If any new devices or templates are added, HUM polls the devices to get the instance information, indicated by a progress bar.

The Available Instances dialog box appears, displaying the instances selected earlier in a tree format.

If there are no changes to the devices or templates, only the instances that you have selected earlier appears in the Available Instances dialog box in a tree format.

To add more instances to the present selection:

Click Refresh in the Available Instances dialog box.

The Select Instances page reloads, displaying all the available instances in a tree format.

Select the required instances.

See Creating a Poller for more information on fields that appear in the Available Instances dialog box.

Step 7 To continue, either:

Complete editing Poller information by clicking Finish from the Available Instances dialog box.

Or

Go to Step 8 to continue.

Step 8 Click Next.

The Poller Summary page appears, displaying the Poller configuration summary.

To modify the Poller configuration, click Back until you reach the dialog box you want.

See Creating a Poller for the descriptions of the fields that appear in the Poller Summary page.

Step 9 Click Finish.

The Poller details are updated in the database.

A pop-up message appears confirming that the Poller is updated successfully.

The List of Pollers dialog box appears, displaying the Poller.

The data polled is stored in the database and you can use it to generate reports. For more information, see Reports.

An audit trail message is logged. For more information, see View Audit Trail Log Report.


Deleting a Poller

You can delete one or more Pollers using the Delete button on the List of Pollers dialog box.

Before a Poller is deleted, you are prompted to confirm the deletion because you cannot restore a Poller that you have deleted from the database. If you delete a Poller the polled data is also deleted.

To delete a Poller:


Step 1 Go to LMS Portal and select Health and Utilization Monitor > Poller and Template Management > Poller Management.

The List of Pollers dialog box appears.

Step 2 Select the Poller by checking the appropriate checkbox.

You can select multiple Pollers by checking their respective checkboxes.

Step 3 Click Delete.

A message appears, prompting you to confirm the deletion.

Step 4 Click OK to delete the Poller.

Or

Click Cancel to cancel the operation.

If you choose to click OK, a message appears that the Poller is deleted successfully.

The List of Pollers dialog box appears.

When you delete a Poller, the following data is also deleted:

a. Poller mapping information associated with the template.

b. Threshold configuration information associated with the Poller.


Deactivating a Poller

If you do not want the Poller to poll a device for a MIB variable, you can deactivate it using the De-activate button on the List of Pollers dialog box. You can select multiple Pollers and deactivate them at the same time.

To deactivate a Poller:


Step 1 Go to LMS Portal and select Health and Utilization Monitor > Poller and Template Management > Poller Management.

The List of Pollers dialog box appears.

Step 2 Select the Poller to be deactivated by checking the checkbox.

Step 3 Click De-activate.

A message appears, prompting you to confirm the deactivation.

Step 4 Click OK to deactivate the Poller.

Or

Click Cancel to cancel the operation.

If you choose to click OK, a message appears that the Poller is changed to inactive state.

The List of Pollers dialog box appears, displaying the status of the Poller as Inactive.

The license count for polling the number of devices is not reduced when you deactivate a poller.


Activating a Poller

If you want an inactive Poller to start polling a device for MIB variables, you can activate it using the Activate button on the List of Pollers dialog box. You can select mulitple Pollers and activate them together.

To activate a Poller:


Step 1 Go to LMS Portal and select Health and Utilization Monitor > Poller and Template Management > Poller Management.

The List of Pollers dialog box appears.

Step 2 Select the Poller to be activated by checking the appropriate checkbox.

Step 3 Click Activate.

A message appears, prompting you to confirm the activation.

Step 4 Click OK to activate the Poller.

Or

Click Cancel to cancel the operation.

If you choose to click OK, a message appears that the Poller is changed to active state.

The List of Pollers dialog box appears, displaying the status of the poller as Active.

If you activate a Poller, the polling starts at the next cycle time specified in the polling interval.


Viewing Failures

You can view failures that occurred during polling, in a tabular format. Polling for MIB variables may fail because of various reasons. These can be caused by:

Unreachable devices

Improper credentials

MIB variable not found

SNMP Timeout

HUM logs only the last 24 hours failures in the database.

To view failures for a specific Poller:


Step 1 Go to LMS Portal and select Health and Utilization Monitor > Poller and Template Management > Poller Management.

The List of Pollers dialog box appears.

Step 2 Click the link on the Status column to see the failures for that specific Poller.

The link in the status column is available only when a failure is recorded. Only the last 24 hour failures are recorded and the Poller status is updated, as shown in the example, and appears as a link.

Example:

Active with Errors (82).

Here 82 is the number of polling errors occurred during the last 24 hours.

Table 4-6 describes the fields in the Failure View page.

Table 4-6 Failure View Field Description

Field
Description

MIB Variable

Displays the MIB variable. For example, ifInErrors.

Instance

Displays the MIB variable instance. For example, VLAN-1

Failure Status

Transient—Either the device is down or the SNMP credentials are incorrect.

Permanent—Polled MIB variables or instances are not available.

Failure Count

Number of failures recorded.

Last Failed Reason

Reason for the last failure. For example, Request Timed-Out. Device may be down.

Last Failed

Time of last failure. For example, 09 May 2007, 17:30:15



Clearing Failures

You can clear all the failures recorded in the database for a Poller by clicking the Clear Failures button on the List of Pollers dialog box.

To clear failures of a specific Poller:


Step 1 Go to LMS Portal and select Health and Utilization Monitor > Poller and Template Management > Poller Management.

The List of Pollers dialog box appears.

Step 2 Select a Poller with failures recorded during the last 24 hours.

Step 3 Click Clear Failures.

A message appears, prompting you to confirm the clear failure operation.

Step 4 Click OK to clear the failures recorded for the Poller.

Or

Click Cancel to cancel the operation.

If you choose to click OK, a message appears that the failures were cleared successfully for the Poller.

Step 5 Click OK.

The List of Pollers dialog box appears, displaying the status of the Poller without any recorded failures.


Viewing Poller Configuration Details

You can view the configuration details of a Poller showing the template name and the instances selected for polling each device, in a tabular format.

To view a Poller configuration:


Step 1 Go to LMS Portal and select Health and Utilization Monitor > Poller and Template Management > Poller Management.

The List of Pollers dialog box appears.

Step 2 Click on the Poller name link.

The Poller View page appears, displaying the Poller configuration details.

Table 4-7 describes the fields available in the Poller View page.

Table 4-7 Poller View Field Description

Field Name
Description

Template Name

Templates associated with the Poller.

Instances

Displays the MIB variable instance in the device.



Filtering Poller List

This section describes how you can use the filter option to display the Poller information based on a specific criteria.

To filter a Poller:


Step 1 Go to LMS Portal and select Health and Utilization Monitor > Poller and Template Management > Poller Management.

The List of Pollers dialog box appears.

Step 2 Select a criteria for filtering from the drop-down list.

Step 3 Enter the data to be filtered.

Step 4 Click Show.

The List of Pollers dialog box appears, displaying the Poller information based on the filter criteria.

Table 4-8 describes the criteria to filter.

Table 4-8 Poller Filter Field Description

Filter Criteria
Description

Poller Name

Select Poller Name and enter the data. You can use any of the following methods to filter by entering:

Complete Poller name

Any three consecutive characters of the Poller name

Interval

Select Interval and choose a duration from the drop-down list.

Status

Select Status and choose a status from the drop-down list.

Example: Active or Inactive.



Managing Templates

Templates are a logical group of MIB variables that allow you to monitor the performance parameters of a device (such as CPU, memory, interface) for utilization and availability levels.

From the Template Management page you can create a user-defined template, modify the configuration of a user-defined template, export and import a template, delete a user-defined template, and so on.

The following template types are used in HUM:

System-defined Templates

User-defined Templates

System-defined Templates

System-defined templates help to monitor devices easily. System-defined templates provide most of the common network parameters that you need to monitor a device connected to the network. These templates cannot be deleted or modified.

Table 4-9 describes the list of System-defined templates used in HUM.

Table 4-9 System-defined Templates Used in HUM 

Template Name
MIB Variables Polled
Description

CPU Utilization

Primary Set:
cpmCPUTotal5minRev (1.3.6.1.4.1.9.9.109.1.1.1.1.8)

Fallback Set 1:
cpmCPUTotal5min (1.3.6.1.4.1.9.9.109.1.1.1.1.5)

Fallback Set 2:
avgBusy5 (1.3.6.1.4.1.9.2.1.58)

Fallback Set 3:
hrProcessorLoad (1.3.6.1.2.1.25.3.3.1.2)

Fallback Set 4:
cseSysCPUUtilization (1.3.6.1.4.1.9.9.305.1.1.1)

Fallback Set 5:
apChassisMgrExtSubModuleCPUAverage (1.3.6.1.4.1.2467.1.34.17.1.14)

Monitors the CPU utilization percentage of a device.

The MIB variables in the primary and fallback sets provide the percentage CPU utilization information of a device.

Device Availability

Primary Set:
sysUpTime

Monitors the availability of a device in a network.

Environmental Temperature

Primary Set:
ciscoEnvMonTemperatureStatusIndex (1.3.6.1.4.1.9.9.13.1.3.1.1)
ciscoEnvMonTemperatureStatusDescr (1.3.6.1.4.1.9.9.13.1.3.1.2)
ciscoEnvMonTemperatureStatusValue (1.3.6.1.4.1.9.9.13.1.3.1.3)

Monitors the environmental temperature in a device.

Interface Availability

Primary Set:
ifOperStatus (1.3.6.1.2.1.2.2.1.8)

Monitors the interface availability in a device.

Interface Errors

Primary Set:
ifInErrors (1.3.6.1.2.1.2.2.1.14)
ifOutErrors (1.3.6.1.2.1.2.2.1.20)
ifInDiscards (1.3.6.1.2.1.2.2.1.13)
ifOutDiscards (1.3.6.1.2.1.2.2.1.19)

Monitors the interface errors in a device.

Interface Utilization

Primary Set:
ifInOctets (1.3.6.1.2.1.2.2.1.10)
ifOutOctets (1.3.6.1.2.1.2.2.1.16)
ifSpeed (1.3.6.1.2.1.2.2.1.5)

Formula used for Interface Rx Utilization:

Formula used for Interface Tx Utilization:

Monitors the interface utilization of a device.

Memory Utilization

Primary Set:
CiscoMemoryPoolUsed
ciscoMemoryPoolFree

Formula used in Primary Set:

Fallback Set 1:
cseSysMemoryUtilization (1.3.6.1.4.1.9.9.305.1.1.2)

Fallback Set 2:
hrStorageSize (1.3.6.1.2.1.25.2.3.1.5)
hrStorageUsed (1.3.6.1.2.1.25.2.3.1.6)

Formula used in Fallback Set 2:

Monitors the memory utilization percentage of a device.

The MIB variable in the fallback set 1 cseSysMemoryUtilization provides the percentage memory utilization data of a device.


In System-defined templates, if the MIB variable in the primary set is not available, an alternate MIB variable in the fallback set stored in the device is selected.

This fallback logic is applied during Poller creation and an appropriate MIB variable is selected for polling. System-defined templates support all Cisco devices that supports the following MIB files:

CISCO-ENHANCED-MEMPOOL-MIB

CISCO-ENVMON-MIB

CISCO-MEMORY-POOL-MIB

CISCO-PROCESS-MIB

ENTITY-MIB

OLD-CISCO-CHASSIS-MIB

RFC1213-MIB

User-defined Templates

CiscoWorks HUM allows you to create your own templates by grouping new MIB variables or by leveraging MIB variables from System-defined templates to suit your requirements. These templates are called user-defined templates.

You can add or delete MIB variables in a user-defined template. After the user-defined template is created, the template is listed in the List of Templates page.

To access the Template Management page, go to LMS Portal and select Health and Utilization Monitor > Poller and Template Management > Template Management.

The List of Templates page appears, displaying the templates configured, in a tabular format.

Table 4-10 describes the fields and buttons in the List of Templates page.

Table 4-10 List of Templates Field Description

Field / Button
Description

Template Name

Name of the template.

No. of MIB Variables

Number of MIB variables associated with the template.

No. of Pollers Associated

Number of Pollers associated with the template.

Created By

User who created the template.

Example: System or Admin.

Filter

(button)

Select the filter criteria and enter the data.

Use one of the following filter criteria and click Show:

Template Name

Created By

See Filtering Template List.

Create

(button)

Creates a template. See Creating a Template.

Edit

(button)

Modifies a template. See Editing a Template.

Delete

(button)

Deletes a template. See Deleting a Template.

Copy

(button)

Creates a template from an existing System-defined or User-defined template. See Copying a Template.

Export

(button)

Exports a template to a directory location. See Exporting a Template.

Import

(button)

Imports a template from a directory location. See Importing a Template.


You can perform the following tasks from the List of Templates page:

Creating a Template

Editing a Template

Deleting a Template

Copying a Template

Exporting a Template

Importing a Template

Filtering Template List

Viewing Template Details

Creating a Template

This section explains how to create a user-defined template. You can create a user-defined template by grouping new MIB variables. You can also create user-defined templates during Poller creation using the Add User Defined Template option.

To create a template:


Step 1 Go to LMS Portal and select Health and Utilization Monitor > Poller and Template Management > Template Management.

The List of Templates dialog box appears.

Step 2 Click Create.

The Select MIB Variables page appears, displaying the MIB Variables dialog box. You can search and select MIB variables from the MIB Variables dialog box. For more information, see MIB Variable Selector.

Table 4-11 describes the field and tabs in the MIB Variables dialog box.

Table 4-11 Select MIB Variables Fields 

Field/Tab
Description

Template Name

Enter the template name.

The name can contain a mix of alphabets, numerals and special characters (such as -_.#@&$).

Show MIB

Displays the MIB files as a drop-down list.

To add new MIB files to the drop-down list, see Load MIB Files.

Search Input

Enter your search expression in this text field.

You can enter only a single MIB variable name in this field.

To search multiple MIB variables, you can enter the MIB variable name with wildcard character *. This will locate the MIB variables that match the text string that you enter.

Search

Use the icon to perform a simple search, after you have entered your search input. For more information, see Performing Simple Search.

All

Lists all the MIB variables associated with the MIB file selected from the Show MIB drop-down list in a hierarchical format (tree view). Check the checkboxes to select the MIB variables.

You can select all MIB variables, clear all MIB variables, or select a few MIB variables from the list.

Search Results

Displays all your search results.

You can select all MIB variables, clear all MIB variables, or select a few MIB variables from the list.

Selection

Lists all the MIB variables that you have selected in the All or Search Results tab or through a combination of both. You can also use this tab to deselect the MIB variables you have already selected.


Step 3 Enter a descriptive template name in the Template Name field.

Step 4 Select a MIB file from the Show MIB drop-down list.

A MIB tree for the selected MIB file is displayed under the All tab.

Step 5 Add MIB variables by selecting the required MIB variables from the MIB tree.

You can also use the Search option to select MIB variables.

Only integer MIB variables are displayed in the MIB tree and not string MIB variables. For example, ifDescription is a string MIB variable and will not be displayed in the MIB tree.

You cannot add MIB variables from two different tables in the MIB tree.

Step 6 Click Next.

The MIB Alias Name dialog box appears.

Table 4-12 describes the fields in the MIB Alias Name dialog box.

Step 7 Click Finish.

A message appears confirming that the template is created successfully.

The List of Templates dialog box appears, displaying the template.

Table 4-12 MIB Alias Name Field Description

Field
Description

MIB Variable

Displays the MIB variables selected in Step 5.

Alias Name

Enter an alias name.

You can assign a descriptive name as the alias name for the MIB variable. After you have named the MIB variable with an alias name, the variable appears with its alias name throughout the application.



MIB Variable Selector

You can use the MIB Variables dialog box to search and select MIB variables from a MIB file. You can search for MIB variables using a Simple search. For more information, see Performing Simple Search.

Table 4-11 describes the fields and tabs in the MIB Variable selector window.

Performing Simple Search

You can enter your search expression in the Search Input field and search for the instances using the Search icon.

Note the following points when you perform a simple search:

You can use the wildcard character * to search for multiple MIB variables that match the text string that you entered.

If you are not using the wildcard character, make sure that you enter the full MIB variable name.

Editing a Template

You can make changes to the selection of MIB variables in an existing user-defined template using the Edit button in the List of Templates dialog box. You cannot edit the template name or select another MIB file from the Show MIB list.

When you modify the template by adding new variables, or by removing existing variables, the changes are reflected in all active Pollers associated with the template.

You cannot edit System-defined templates.

You can edit only one template at a time. If you select multiple templates using the checkbox, the Edit button is disabled.

To edit a template:


Step 1 Go to LMS Portal and select Health and Utilization Monitor > Poller and Template Management > Template Management.

The List of Templates dialog box appears.

Step 2 Select the template by checking the corresponding checkbox.

Step 3 Click Edit.

The Select MIB Variables page appears, displaying the MIB Variables dialog box.

Step 4 Make the necessary selections to the MIB variables from the MIB tree.

You can also add additional MIB variables to the template. You cannot add MIB variables from two different tables.

Step 5 Click Next.

The MIB Alias Name dialog box appears.

To easily identify the MIB variable, use an alias name.

See Creating a Template for the descriptions of the fields that appear in the MIB Alias Name dialog box.

Step 6 Click Finish.

A message appears confirming that the template is updated successfully.

The List of Templates dialog box appears, displaying the template.


Deleting a Template

You can delete an existing user-defined template using the Delete button on the List of Templates dialog box. You can select and delete multiple user-defined templates using the checkbox selection. You cannot delete System-defined templates.

The Delete button is enabled only after you have selected the template.

Before deleting a template, you are prompted to confirm the action, as you cannot restore a template that is deleted from the database.

You cannot delete a template if it is part of any Poller. If you try to do so, an appropriate error message appears.

If you select both System-defined and user-defined templates for deletion, an appropriate message appears prompting you to delete only the user-defined templates.

To delete a template:


Step 1 Go to LMS Portal and select Health and Utilization Monitor > Poller and Template Management > Template Management.

The List of Templates dialog box appears.

Step 2 Select a template by checking the checkbox.

You can select multiple User-defined templates by checking the respective checkbox.

If you select both System-defined and User-defined templates for deletion, you will prompted to delete only the User-defined templates.

Step 3 Click Delete.

A message appears prompting you to confirm the deletion.

Step 4 Click OK to delete the User-defined template.

Or

Click Cancel to cancel the operation.

The List of Templates dialog box appears.


Copying a Template

You can copy and create a new template from an existing System-defined or User-defined template using the Copy button on the List of Templates dialog box.

To copy from an existing template:


Step 1 Go to LMS Portal and select Health and Utilization Monitor > Poller and Template Management > Template Management.

The List of Templates dialog box appears.

Step 2 Select the template by checking the appropriate checkbox.

Step 3 Click Copy.

The Select MIB Variables page appears, displaying the MIB Variables dialog box.

Step 4 Enter a name in the Template Name field.

Step 5 Make the necessary MIB variable selection from the MIB tree.

Step 6 Click Next.

The MIB Alias Name dialog box appears. To easily identify the MIB variable, use an alias name.

See Creating a Template for the descriptions of the fields that appear in the MIB Alias Name dialog box.

Step 7 Click Finish.

A message appears confirming that the template is created successfully.

The List of Templates dialog box appears, displaying the template.


Exporting a Template

You can export a template to a location where the HUM application is installed. The exported file is in XML format. You can export both System-defined templates and User-defined templates.

To export a template:


Step 1 Go to LMS Portal and select Health and Utilization Monitor > Poller and Template Management > Template Management.

The List of Templates dialog box appears.

Step 2 Select the template you want to export by checking the corresponding checkbox.

Step 3 Click Export.

The Export Template dialog box appears.

You can either:

a. Enter a descriptive name in the File Name field to which the template is exported.

b. Click OK to export and close the Export Template dialog box.

Or

a. Click Browse to select an existing filename to which the template is exported.

The Server Side File Browser dialog box appears.

b. Select an existing filename from the directory content area.

c. Click OK to close the Server Side File Browser dialog box.

d. Click OK to export and close the Export Template dialog box.

A pop-up message appears with the following message: File name already exists. Are you sure you want to overwrite it?

Click OK to overwrite the existing file with the new template contents or Cancel to select another filename by clicking Browse.

If you click OK, the template is exported to the specified directory location.

A message appears confirming that the template is successfully exported.

Table 4-13 describes the fields in the Server Side File Browser.

Table 4-13 Server Side File Browser Field Description

Field
Description

File

The directory path to export the template file.

You are allowed to export the template only to the following directory path:

In Windows, $NMSROOT\hum\templateEx

In Solaris, $NMSROOT/hum/templateEx

$NMSROOT is the default CiscoWorks HUM installation directory.

Directory Content

Displays the files and folders in the directory path.

You can select a file or a folder in the directory path.



Importing a Template

You can import a template from the location where the HUM application is installed. The imported data need to be in XML format.

To import a template:


Step 1 Go to LMS Portal and select Health and Utilization Monitor > Poller and Template Management > Template Management.

The List of Templates dialog box appears.

Step 2 Click Import.

The Import Template dialog box appears.

Step 3 Click Browse to select the directory path where the template file is located.

The Server Side File Browser dialog box appears.

See Exporting a Template for the descriptions of the fields that appear in the Server Side File Browser dialog box.

Step 4 Locate and select the template file from the directory location.

Step 5 Click OK to close the Server Side File Browser dialog box.

Step 6 Click OK to import and close the Import Template dialog box.

A message appears confirming that the template is successfully imported.

The List of Templates dialog box appears, displaying the template.


Filtering Template List

This section describes how you can use the Show option to filter the template information based on a specific criteria.

To filter a template:


Step 1 Go to LMS Portal and select Health and Utilization Monitor > Poller and Template Management > Template Management.

The List of Templates dialog box appears.

Step 2 Select a criteria from the drop-down list.

Step 3 Enter the data to be filtered.

Step 4 Click Show.

The List of Templates dialog box appears, displaying the template information based on filter criteria.

Table 4-14 describes the criteria you can use for filtering.

Table 4-14 Template Filter Field Description

Filter Criteria
Description

Template Name

Select Template Name and enter the data. You can use any of the following methods to filter by entering:

Complete template name

Any three consecutive characters of the template name

Created By

Select Created By and enter the name of user who created the template.

For example, System or Admin

You can use any of the following methods to filter by entering:

Complete username

Any three consecutive characters of the user name



Viewing Template Details

This section helps you to understand the details of a template such as Template Name, MIB variables used in the template, number of Pollers associated with the template and so on.

You can view the details of a template from the List of Templates dialog box.

To view the details of a template:


Step 1 Go to LMS Portal and select Health and Utilization Monitor > Poller and Template Management > Template Management.

The List of Templates dialog box appears.

Step 2 Click on the template name link.

A pop-up appears, displaying the details of the template.

Table 4-15 describes the fields in the Template Details page.

Table 4-15 Template Details Field Description

Field
Description

Template Name

Displays the template name.

MIB Variables

MIB variables associated with the template. For example, cpmCPUTotal5minRev.

Pollers Configured

Displays the Poller name.

Created By

Name of the user who created the template. For example, System or Admin.