Table Of Contents
Administration
System Preferences
Set Log Levels
Purge Jobs
Set Report Publish Location
Purge Data
View Purge Details
Schedule Quick Reports
Poll Settings
Load MIB Files
View Audit Trail Log Report
Understanding Audit Trail Log Report
Administration
This chapter explains how to perform maintenance and administrative tasks in CiscoWorks HUM. The System Preferences section provides a list of tasks to perform maintenance and administration.
System Preferences
The System Preferences page allow you to perform the following maintenance and administrative tasks in HUM:
•
Set Log Levels
•Purge Jobs
•Set Report Publish Location
•Purge Data
•View Purge Details
•Schedule Quick Reports
•Poll Settings
•Load MIB Files
•View Audit Trail Log Report
To access the System Preferences page go to LMS Portal and select Health and Utilization Monitor > Admin > System Preferences.
The Current Admin Settings table appears, displaying the administrative settings currently applied.
Table 7-1 describes the fields in the Current Admin Settings table.
Table 7-1 Current Admin Settings Fields
Field
|
Description
|
Job Purge Settings
|
Date and time of next job purge schedule.
For example, 09 Jun 2007, 08 Hrs 10 Mins
|
Report Publish Path
|
Directory path configured to publish HUM reports.
|
Data Purge Settings
|
Displays the schedule of next purge.
For example, 09 Jun 2007, 10 Hrs 10 Mins
|
Quick Report Schedule
|
Frequency of Quick Report generation.
For example, Job Frequency: Every 1 hour
|
Poll Settings
|
Displays the Poll Settings details.
For example,
•SNMP Timeout: 3 sec
•SNMP Retry: 1
•Failure Notification Interval: 24 hours
•E-Mail ID
|
Set Log Levels
You can use this option to configure and manage log level settings in HUM. You can set log level modes (such as Fatal, Error, Info, Debug) either for all HUM application modules or at a module level.
HUM application module log files are stored at these locations:
•On Windows: $NMSROOT\log\, where $NMSROOT is the CiscoWorks HUM installation directory.
•On Solaris: /var/adm/CSCOpx/log/
When a log file reaches its maximum file size of 10000 KB, the module backs up the file and starts writing to a new log file. The maximum number of backup log files stored for each application is two.
To set log levels:
Step 1 Go to LMS Portal and select Health and Utilization Monitor > Admin > System Preferences.
Step 2 Select Log Level Settings.
The Set Application Logging Levels dialog box appears.
Step 3 Select the application module from the drop-down list.
The sub-module for the selected application module appear in the Module field.
Step 4 Select an appropriate log level from the Logging Level drop-down list. Changes to HUM modules are logged with appropriate log level message. The logging levels are:
•Fatal
•Error
•Warn
•Info
•Debug
The logging level is set as Info, by default.
Table 7-2 describes the fields in the Set Application Logging Levels dialog box and also provides information on the files to which these logs are stored.
Table 7-2 Set Application Logging Levels Fields
Application Module
|
Sub-module
|
Log File
|
Description
|
All
|
—
|
—
|
Set logging level for the entire system
|
UI
|
Poller Management
|
upm_ui.log
|
Set logging level for User Interface modules
|
Template Management
|
Threshold Setup
|
Report Management
|
Report Job Browser
|
Admin Pages
|
HUM Portlets
|
HUMPortal.log
|
Device Center
|
upm_ui.log
|
UPMProcess
|
Polling Engine
|
upm_process.log
|
Set logging level for UPMProcess modules
|
Instance Querying
|
Threshold Monitor
|
Device Access Layer
|
Device Management
|
UPMProcess
|
UPMProcess.log
|
PollerUPMProcess
|
upm_process.log
|
TemplateUPMProcess
|
ThresholdUPMProcess
|
JOBS
|
Report Jobs
|
HumReportJob_<JobId>_<InstanceId>.log
For example, HumReportJob_1003_479.log
|
Set logging level for Job modules
|
Summarization Job
|
upm_summarizer.log
|
Purge Job
|
upm_purge.log
|
Failure Tracker Job
|
HumReportJob_<JobId>_<InstanceId>.log
For example, HumReportJob_1003_479.log
|
UPMCTMOperations
|
UPM CTM Operations
|
upm_ctm.log
|
Set logging level for UPMCTMOperations modules
|
Step 5 Click Apply to set the logging level or Reset to apply the default logging level.
A message appears confirming that the logging levels are successfully updated.
Purge Jobs
You can configure HUM to periodically purge job data that you no longer need. This is done using Job Purge.
Job Purge provides a centralized location for you to schedule purging for the following HUM jobs:
•Quick Report Jobs—Purge all Quick Report jobs older than the specified number of days.
•Custom Report Jobs—Purge all Custom Report jobs older than the specified number of days.
•Threshold Report Jobs—Purge all Threshold Report jobs older than the specified number of days.
•Poller Report Jobs—Purge all Poller Report jobs older than the specified number of days.
•Failure Tracker Jobs—Purge all Failure Tracker jobs older than the specified number of days.
To schedule Job Purge:
Step 1 Go to LMS Portal and select Health and Utilization Monitor > Admin > System Preferences.
Step 2 Select Job Purge.
The Job Purge Settings page appears, displaying Job Purge Schedule dialog box.
Table 7-3 describes the fields in the Job Purge Schedule dialog box.
Table 7-3 Job Purge Schedule Fields
Field/Button
|
Description
|
Scheduling
|
Run Type
|
Specify the type of schedule for job purge:
•Daily—Runs daily at the specified time.
•Weekly—Runs weekly on the day of the week and at the specified time.
•Monthly—Runs monthly on the day of the month and at the specified time. (A month comprises 30 days).
For Daily jobs, the subsequent instances of jobs will run only after the earlier instance of the job is complete.
For example, if you have scheduled a daily job at 10:00 a.m. on November 1, the next instance of this job will run at 10:00 a.m. on November 2, only if the earlier instance of the November 1 job has completed. If the 10.00 a.m. November 1 job has not completed before 10:00 a.m. November 2, then the next job will start only at 10:00 a.m. on November 3.
|
Date
|
Specify the date and time that the job purge is scheduled for.
Select the date by clicking the calendar icon and time from the drop-down list.
|
Purge Policy
|
Days
|
The default setting for purging archived job data is 30 days. That is, job data older than 30 days will be deleted. You can change this value as required. This is a mandatory field.
You can enter only full day value. You cannot enter fractions of days.
|
Apply
(button)
|
Job purge is scheduled at the specified Run Type and Date for the job data older than the days specified in the Days field.
|
Purge Now
(button)
|
Job purge is done immediately for the job data older than the days specified in the Days field.
|
Step 3 Update the necessary fields in the following panes:
•Scheduling
•Purge Policy
See Table 7-3 for the description of fields that appear in the Job Purge Schedule dialog box.
Step 4 Click Apply to schedule job purge or Purge Now to immediately perform job purge.
•If you click Apply, a message appears confirming that the purge settings are applied successfully.
•If you click Purge Now, a message appears confirming that purge is done successfully and the Job ID appears.
You can see the job details in the CiscoWorks Common Services Job Browser at LMS Portal > CiscoWorks Common Services > Server > Admin > Job Browser.
Note We recommend that you wait for any activity currently running in the system to stop before purging jobs.
By default, all Job Purge jobs older than seven days are purged by CiscoWorks HUM.
Set Report Publish Location
CiscoWorks HUM allows you to publish the PDF, HTML and CSV format of all the reports to a directory location of your choice. This is done by setting a default directory path.
Note Ensure that the casuser is assigned the required write permission privileges to publish the PDF format of the report to the directory path. For more information, see User Guide for CiscoWorks Common Services 3.2.
To set a report publish location:
Step 1 Go to LMS Portal and select Health and Utilization Monitor > Admin > System Preferences.
Step 2 Select Report Location.
The Default Report Publish Location page appears, displaying Default Location Settings dialog box.
Table 7-4 describes the field in the Default Location Settings dialog box.
Table 7-4 Default Location Settings Fields
Field/Button
|
Description
|
Report Location
|
Directory path where the PDF format of the reports are published.
Use the Browse button to select a directory path.
The Server Side File Browser dialog box is launched. You can select the directory path in this dialog box.
|
Step 3 Click Browse.
The Server Side File Browser dialog box appears.
Step 4 Select the directory path from the Server Side File Browser dialog box.
Step 5 Click OK.
The directory path is displayed in the Report Location field.
Step 6 Click Apply to save the default directory path settings or Cancel to reset the directory path.
Purge Data
You can configure HUM to periodically purge polled data that you no longer need in the database. You can purge data records such as summarization records, Poller failure records, threshold violation records, audit trail records.
CiscoWorks HUM polls the device and stores the polled data in the database. Over a period of time, the polled data occupies a large amount of space in the database.
To prevent this, HUM stores only the last 24 hours data in the database. Background tasks in HUM summarizes this polled data and categorizes the data as 5-minute summarization record, 30-minute summarization record, 3-hour summarization record and 12-hour summarization record.
The summarization of polled data happens every one hour. The summarized data can be purged at regular intervals using the Data Purge option.
Data Purge allows you to schedule purging for the following HUM data records:
•5 Minute Summarization records—Purge all 5-minute summarization data records older than the specified number of days.
•30 Minute Summarization records—Purge all 30-minute summarization data records older than the specified number of days.
•3 Hour Summarization records—Purge all 3-hour summarization data records older than the specified number of days.
•12 Hour Summarization records—Purge all 12-hour summarization data records older than the specified number of days.
•Poller failure records—Purge all failure data records older than the specified number of days.
•Threshold violation records—Purge all threshold violation data records older than the specified number of days.
•Audit trail records—Purge all audit trail data records older than the specified number of days.
To schedule Data Purge:
Step 1 Go to LMS Portal and select Health and Utilization Monitor > Admin > System Preferences.
Step 2 Select Data Purge.
The Data Purge Settings page appears, displaying the Data Purge Schedule dialog box.
Table 7-5 describes the fields in the Data Purge Schedule dialog box.
Table 7-5 Data Purge Schedule Fields
Field/Button
|
Description
|
Purge Schedule
|
Run Type
|
Specify the type of schedule to perform Data Purge:
•Hourly—Runs hourly.
•Daily—Runs daily at the specified time.
•Weekly—Runs weekly on the day of the week and at the specified time.
•Monthly—Runs monthly on the day of the month and at the specified time. (A month comprises 30 days).
By default, Daily is set as the default Run Type schedule for Data Purge.
For example, if you have scheduled Run Type as Daily for Data Purge job at 10:00 a.m. on November 1, the next instance of this Data Purge job will run at 10:00 a.m. on November 2, only if the earlier instance of the November 1 job has completed.
If the 10.00 a.m. November 1 Data Purge job has not completed before 10:00 a.m. November 2, then the next Data Purge job will start only at 10:00 a.m. on November 3.
|
Date
|
Specify the date and time that the Data Purge job is scheduled for.
Select the date by clicking the calendar icon and time from the drop-down list.
|
Purge Policy
|
Days
|
The following are the default settings for purging the following data:
•5 Minute's Summarization records—3 days
•30 Minute's Summarization records—15 days
•3 Hour Summarization records—90 days
•12 Hour Summarization records—365 days
•Poller failure records—1 day
•Threshold violation records—180 days
•Audit trail records—90 days
The default data purge settings provides optimal performance of CiscoWorks HUM. You can also change the default purge settings as required, however the performance of CiscoWorks HUM may not be as expected.
You can enter only full days. You cannot enter fractions of days.
This is a mandatory field.
|
Apply
(button)
|
Data purge is scheduled at the specified Run Type and Date for the data older than the days specified in the Days field.
|
Purge Now
(button)
|
Data purge is done immediately for the data older than the days specified in the Days field.
|
Step 3 Update the necessary fields in the following panes:
•Purge Schedule
•Purge Policy
See Table 7-5 for the description of fields that appear in the Data Purge Schedule dialog box.
Step 4 Click Apply to schedule the data purge or Purge Now to immediately perform the data purge.
•If you click Apply, a message appears confirming that data purge settings are applied successfully.
•If you click Purge Now, a message appears confirming that purge is done successfully and the Job ID appears.
You can see the job details in the CiscoWorks Common Services Job Browser at LMS Portal > CiscoWorks Common Services > Server > Admin > Job Browser.
Note By default, all Summarization jobs older than seven days are purged by CiscoWorks HUM.
View Purge Details
CiscoWorks HUM allows you to view the details of the data purged using the option Purge Details.
To view Data Purge details:
Step 1 Go to LMS Portal and select Health and Utilization Monitor > Admin > System Preferences.
Step 2 Select Purge Details.
The Purge Details page appears, displaying Show Purge Details dialog box.
Table 7-6 describes the fields in the Show Purge Details dialog box.
Table 7-6 Show Purge Details Fields
Field
|
Description
|
Details
|
Displays the purge details of the Data Purge job.
The following purge information is displayed:
•Next Data Purge Job scheduled at
•No. of Poll Failure records purged
•No. of Audit Trail records purged
•No. of Threshold Violation records purged
•No. of Polled records purged
•Last Job Purge completed at
|
Value
|
Details the number of records purged and purge schedule.
|
Schedule Quick Reports
You can configure the frequency of generating Quick Reports using the option Quick Report Schedule. By default, Quick Reports are generated every one hour.
To schedule Quick Reports:
Step 1 Go to LMS Portal and select Health and Utilization Monitor > Admin > System Preferences.
Step 2 Select Quick Report Schedule.
The Quick Report Schedule dialog box appears.
Step 3 Select Frequency and Time for generating Quick Reports.
For example, Frequency as 1 hour and Time as 04 Hrs 10 Mins.
Table 7-7 describes the fields in the Quick Report Schedule dialog box.
Table 7-7 Quick Report Schedule Fields
Field
|
Description
|
Frequency at Every
|
Specify the frequency from the drop-down list.
You can select any of these predefined values. The default option is 1 hours.
•30 Minutes—Quick Report generated every 30 minutes
•1 Hour—Quick Report generated every 1 hour.
•4 Hours—Quick Report generated every 4 hours.
•12 Hours—Quick Report generated every 12 hours.
•1 Day—Quick Report generated every day.
|
Start Time
|
Specify the time the Quick Report job is scheduled for. The time should be later than the current time.
|
Step 4 Click Apply.
A message appears confirming that the default time for generating Quick Report is updated successfully.
Poll Settings
CiscoWorks HUM allows you to configure the SNMP timeout and SNMP retries using the Poll Settings option. The SNMP timeout and SNMP retries are based on the device and network response time.
•SNMP timeout is the duration of time HUM waits for the device to responed before it retries to query the device again.
•SNMP retry is the maximum number of times HUM retries to query the device.
You can also configure Poll Settings to send the polling failure report as an e-mail.
To configure Poll Settings:
Step 1 Go to LMS Portal and select Health and Utilization Monitor > Admin > System Preferences.
Step 2 Select Poll Settings.
The Poll Settings dialog box appears.
Table 7-8 describes the fields in the Poll Settings dialog box.
Table 7-8 Poll Settings Fields
Field
|
Description
|
Poll Details
|
SNMP Timeout
|
Specify the SNMP timeout interval in seconds.
The default SNMP timeout value is 3 seconds. You can change the default SNMP timeout value to a value between 0 to 15 seconds.
|
SNMP Retries
|
Specify the SNMP retries count.
The default SNMP retry count value is 1. You can set the default SNMP retry count to a value between 0 to 3.
|
Polling Failure
|
Notification Interval
|
Specify the polling failure notification interval.
You can select any of these predefined values. The default option is 6 hours.
•01 - Hour—Polling failures notified every 1 hour.
•06 - Hours—Polling failures notified every 6 hours.
•24 - Hours—Polling failures notified every 24 hours.
•48 - Hours—Polling failures notified every 48 hours.
•Weekly—Polling failures notified every week.
Polling failure notification report is generated periodically based on notification interval. This report contains information on the SNMP polling failures with device details.
|
E-mail ID
|
Enter the e-mail address.
The E-mail address must be in the format: user@domain.com.
The poll failure report is send to the E-mail address based on the Notification Interval.
|
Step 3 Update the necessary fields in the following panes:
•Poll Details
•Polling Failure
See Table 7-8 for the description of fields that appear in the Poll Settings dialog box.
Step 4 Click Apply to update the poll settings or Reset to cancel the poll settings.
A message appears confirming that poll settings are updated successfully.
Load MIB Files
You can load a new MIB file into HUM using the Load MIB option. The new MIB file is compiled and stored in HUM. You can use the new MIB file to create new templates by grouping MIB variables. For more information, see Creating a Template.
You can load MIB files with the file extension .my.
To load a MIB file:
Step 1 Go to LMS Portal and select Health and Utilization Monitor > Admin > System Preferences.
Step 2 Select Load MIB.
The Load MIB dialog box appears.
Table 7-9 describes the field in the Load MIB dialog box.
Table 7-9 Load MIB Fields
Field
|
Description
|
MIB file
|
Use the Browse button to load a MIB file from a directory location.
For example, RFC1213-MIB.my
You are allowed to load a MIB file only from the following directory path:
•In Windows, $NMSROOT\hum\mibmanager\mibcompiler\mibs
•In Solaris, $NMSROOT/hum/mibmanager/mibcompiler/mibs
$NMSROOT is the default CiscoWorks HUM installation directory.
|
Step 3 Click Browse to select the MIB file from a directory location.
The Server Side File Brower dialog box appears.
Step 4 Double-click the MIB file from the directory location.
Step 5 Click Apply to load the MIB file into HUM or Cancel to cancel the operation.
You will be able to load and compile a new MIB file into HUM only when its dependent MIB files are available in the directory location.
For example,
To load and compile RFC1213-MIB, the dependent MIB files for RFC1213-MIB (RFC1155-SMI and RFC-1212) must also be available at the same directory location. If the dependent MIB files are not available, an appropriate error message is displayed and RFC1213-MIB does not compile.
To view the list of dependent MIB go to:
http://tools.cisco.com/Support/SNMP/do/BrowseMIB.do?local=en&step=2
The compiled MIB file appears in the Show MIB drop-down list in Select MIB Variables page. For more information, see Creating a Template.
View Audit Trail Log Report
CiscoWorks HUM logs all the changes made to the individual HUM modules as Audit Trail messages. These Audit Trail messages are logged and stored in the HUM database.
You can use the Audit Trail Logging option to view the Audit Trail Logging report for all modules, categories and users.
To generate the Audit Trail Logging report:
Step 1 Go to LMS Portal and select Health and Utilization Monitor > Admin > System Preferences.
Step 2 Select Audit Trail Logging.
The Audit Trail Logging dialog box appears.
Table 7-10 describes the fields in the Audit Trail Logging dialog box.
Table 7-10 Audit Trail Logging Fields
Field
|
Description
|
Date Range
|
24 Hours
|
Check the 24 Hours checkbox to generate Audit Trail Logging report for last 24 hours.
|
From
|
Specify the start date and time of your Audit Trail Logging report.
Select the date by clicking the calendar icon and time from the drop-down list.
The From date must be earlier than the current date.
This field is disabled if you have selected the 24 Hours checkbox.
|
To
|
Specify the end date and time of your Audit Trail Logging report.
Select the date by clicking the calendar icon and time from the drop-down list.
The To date must be later than the From date and earlier than the current date.
This field is disabled if you have selected the 24 Hours checkbox.
|
Options
|
Module
|
Select one of the following modules from the drop-down list to generate the Audit Trail Logging report:
•All—The report is generated for all HUM modules.
•Poller Management—The report is generated for the Poller Management module.
•Template Management—The report is generated for the Template Management module.
•Polling Engine—The report is generated for the Polling Engine module.
•Threshold Manager—The report is generated for the Threshold module.
•Job Manager—The report is generated for the Job Manager module.
•Summarization—The report is generated for the Summarization operation module.
•Purge—The report is generated for the Purge operations module.
•Admin—The report is generated for the Admin module.
The drop-down list displays All, by default.
|
Category
|
View the Audit Trail Logging report for each Module category.
See Table 7-11 for the list of categories under each HUM module.
This field is disabled if you have selected All in the Module option.
|
User
|
Select one of the following users from the drop-down list to generate the Audit Trail Logging report:
•All—The report is generated for changes done by All users.
•Admin—The report is generated for changes done by the Admin user.
•System—The report is generated for changes done by the System user.
The drop-down list displays all users, by default.
|
Step 3 Update the necessary fields in the following panes:
•Date Range
•Options
See Table 7-10 for the description of fields that appear in the Audit Trail Logging dialog box.
Step 4 Click OK to launch the Audit Trail Logging report or Cancel to cancel report generation.
The Audit Trail Log Report page appears, displaying the report details. For more information, see Understanding Audit Trail Log Report.
Table 7-11 lists the categories available in each HUM module
Table 7-11 HUM Modules and Categories
Module
|
Category
|
Description
|
Poller Management
|
•All
•Poller Creation
•Poller Modification
•Poller Deletion
•Poller State Change
•Delete Devices From Poller
•Delete Failures from Poller
•Clear Missed Cycles
|
The report is generated for the category selected in the Poller Management module.
If you have selected All, the report generated for all the categories in the Poller Management module.
|
Template Management
|
•Template Creation
•Template Modification
•Template Deletion
•Template Import
•Template Export
|
The report is generated for the category selected in the Template Management module.
If you have selected All, the report generated for all the categories in the Template Management module.
|
Polling Engine
|
Polling Cycle Missed
|
The report is generated for the category selected in the Polling Engine module.
If you have selected All, the report generated for all the categories in the Polling Engine module.
|
Threshold Manager
|
•Threshold Creation
•Threshold Modification
•Threshold Deletion
|
The report is generated for the category selected in the Threshold Manager module.
If you have selected All, the report generated for all the categories in the Threshold Manager module.
|
Job Manager
|
•Job Creation
•Job Updation
•Job Deletion
|
The report is generated for the category selected in the Job Manager module.
If you have selected All, the report generated for all the categories in the Job Manager module.
|
Summarization
|
•Summarization Start
•Summarization End
•Summarization Ended with Failure
|
The report is generated for the category selected in the Summarization module.
If you have selected All, the report generated for all the categories in the Summarization module.
|
Purge
|
•Purge Start
•Purge End
•Purge Ended with Failure
|
The report is generated for the category selected in the Purge module.
If you have selected All, the report generated for all the categories in the Purge module.
|
Admin
|
•Report Location Modification
•Report Location Creation
•Data Purge Policy Modification
•Quick Report Time Modified
•Poll Settings Updated
•Job Purge Job updated
•Job Purge Job Created
•Data Purge Job Updated
•Data Purge Job Created
•Failure Tracker Job Updated
•New MIB Loaded
•Log Level Modified
|
The report is generated for the category selected in the Admin module.
If you have selected All, the report generated for all the categories in the Admin module.
|
Understanding Audit Trail Log Report
This section describes the fields available in the Audit Trail Log report. The Audit Trail Log report provides information on the changes that occurred in each HUM module.
Table 7-12 describes the fields in the Audit Trail Log report.
Table 7-12 Audit TTail Log Report Fields
Field
|
Description
|
Module
|
Name of the HUM module.
For example, Job Manager
|
Category
|
Name of the module category.
For example, Job Creation
|
Time Stamp
|
Displays the date and time at which the change was made to the HUM module.
For example, Mon, Apr 21 2008, 12:44:08
|
User
|
User who made the change in the HUM module.
For example, admin or system
|
Description
|
Change that occurred in the HUM module.
For example, Poller XYZ Created at Mon, Apr 21 2008, 12:44:08
|
