User Guide for Resource Manager Essentials 4.1 (With LMS 3.0)
Chapter 21 : Setting System-wide Parameters Using System Preferences

Table Of Contents

Setting System-wide Parameters Using System Preferences

Application Log Level Settings

Job Purge

Scheduling a Purge Job

Enabling a Purge Job

Disabling a Purge Job

Performing an Immediate Purge

RME Device Attributes

RME Secondary Credentials

Collection Failure Notification

Configuring Trap Notification Messages

Examples for Collection Failure Notification

Fields in a Trap Notification Message


Setting System-wide Parameters Using System Preferences


You can set system-wide parameters for RME, using the RME > Admin > System Preferences tab. Here you can set parameters for RME, such as log level settings, job purge preferences, device attributes and device credentials verification settings.

Application Log Level Settings

Job Purge

RME Device Attributes

RME Secondary Credentials

Collection Failure Notification

Application Log Level Settings

You can use this option to set the logging levels for RME packages. You can set the log levels for all RME packages, or at a package (application) level.

Log files are stored at these locations:

On Windows: NMSROOT/log, where NMSROOT is the CiscoWorks installation directory.

On Solaris: /var/adm/CSCOpx/log

To set the log levels:


Step 1 Select Resource Manager Essentials > Admin > System Preferences > Application Log level Settings.

The Set Application Logging Levels dialog box appears.

Step 2 Select the Application from the drop-down list.

Step 3 Select the appropriate log level from the Logging Level drop-down list.

The fields in the Set Application Logging Levels dialog box are:

Application
Module
Description

All

-

Changes the logging level for the entire system.

ArchiveMgmt

Archive Service

Archive Client

Changes the logging level for Archive Management.

BugToolkit

Bug Toolkit

Changes the logging level for Bug Toolkit.

ChangeAudit

Change Audit

Change Audit User Interface

Changes the logging level for Change Audit.

CLIFramework

CLI Framework

Changes the logging level for CLI Framework.

ConfigCLI

Config CLI

Netconfig CLI

Changes the logging level for Config CLI and NetConfig CLI.

ConfigEditor

Config Editor

Changes the logging level for Config Editor.

ConfigJob

Config Jobs

Changes the logging level for Configuration Jobs.

ConfigJobManager

Config Job Manager

Changes the logging level for Configuration Job Browser.

CTMJRrmServer

CTM Jrm Server

Changes the logging level for CTM JRM Server.

CRI

CRI

Changes the logging level for Common reporting Infrastructure.

DeviceManagement

Device Management Operations

Check Device Attributes

Changes the logging level for Device Management.

DeviceSelector

Device Selector

Changes the logging level for Device Selector.

ICServer

Inventory Collection Service

Inventory Collection User Interface

Inventory Collection Jobs

Changes the logging level for the IC Server.

Install

Restore RME CCR

RME PSU Adapter

Migration

Changes the logging level for the Installation modules.

InventoryPoller

Inventory Poller

Changes the logging level for Inventory Poller.

InvReports

Inventory Reports

Changes the logging level for Inventory Reports.

MakerChecker

Maker Checker

Changes the logging level for the Job Approval module.

NCTemplateMgr

NetConfig Template Manager

Changes the logging level for NetConfig Template Manager.

NetConfig

Netconfig Client

Changes the logging level for Netconfig client.

RMECommon

Common RME Functions

Changes the logging level for the common RME functions such as, Job Management tasks, purge tasks, etc.

RMECSTMServer

RME CSTM Server

Changes the logging level for RME CSTM Server.

SoftwareMgmt

Software Management User Interface

Software Management Jobs

Changes the logging level for the user interface of Software Management and the Software Management job creation workflows.

SyslogAnalyzer

Syslog Analyzer

Syslog Analyzer User Interface

Changes the logging level for Syslog Analyzer and the user interface of the module.


Step 4 Click Reset to apply the default logging levels.

Step 5 Click Apply after you set the log levels,

A message appears, that the log levels have been successfully updated.


Job Purge

The Job Purge option provides a centralized location for you to schedule purge operations for the following RME jobs:

Credential Verification Jobs—Purge all Credential Verification jobs.

Software Management Jobs—Purge all Software Management jobs such as Image Import, Image Distribution, etc.

Netconfig Jobs—Purge all NetConfig jobs.

Archive Management Jobs—Purge Archive Management jobs such as Compliance Check, Deploy Compliance Results, etc.

Archive Update Jobs—Purge Archive Management collection jobs, Default config collection job.

Archive Poller Jobs—Purge Archive Management polling jobs, Default config polling job.

Archive Purge Jobs—Purge Archive Management purge jobs, Default archive purge job.

Config Editor Jobs—Purge all Config Editor jobs.

CwConfig Jobs—Purge all cwcli config jobs such as Get Config, Put Config, etc.

Inventory Collector Jobs—Purge Inventory collection jobs.

Inventory Poller Jobs—Purge Inventory polling jobs.

Reports Jobs—Purge all RME Reports jobs

Reports Archive Jobs—All reports that are archived are purged. You can view all reports that are archived in the Archives window (Resource Manager Essentials > Reports > Report Archives).

NetShow Jobs—Purge all RME NetShow jobs.

You cannot purge the jobs that are in the running state.

The Job Purge contains the following information:

Column
Description

Application

Lists the application for which the purge is applicable.

Status

Whether a purge job is enabled or disabled.

Policy

This value is in days. Data older than the specified value, will be purged. You can change value this as required. This is a mandatory field. The default is 180 days.

Job ID

Unique ID assigned to the job by the system, when the purge job was created. This job ID does not change even when you disable or enable or change the schedule of the purge job.

For Purge Now task, job ID is not assigned. Also, if a Job ID already exist for that application, the job ID is not updated for Purge Now tasks. That is, the scheduled purge job is not affected by Purge Now task.

Scheduled At

Date and time that the job was scheduled at. For example: Nov 17 2004 13:25:00.

Schedule Type

Specifies the type of schedule for the purge job:

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).


You can select the applications by checking the checkboxes next to the application to perform the following tasks using the Job Purge window:

Button
Description

Schedule

Schedule a purge job.

Enable

After you schedule a job, you can enable purge.

Disable

After you schedule a job, if you have enabled the purge job, you can choose to disable it.

Purge Now

Perform immediate purge operation.

You can select more than one application to purge jobs corresponding to that application(s) in a single step. After selecting the application(s), click on this button to purge jobs corresponding to that application.


Scheduling a Purge Job

To schedule a purge job:


Step 1 Select Resource Manager Essentials > Admin > System Preferences > Job Purge.

The Job Purge dialog box appears.

To create a purge job, select Schedule.

The Purge Schedule dialog box appears for the selected application.

Field
Description
Scheduling

Run Type

Specifies the type of schedule for the purge job:

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 periodic 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

1. Click on the date picker icon and select the date, month and year.

Your selection appears in the Date field in this format:
dd Mmm yyyy (example: 14 Nov 2004).

2. Select the time (hh and mm) from the drop-down lists in the at fields.

Job Info

Days

The default setting for purging archived data is 180 days. That is, data older than 180 days will be purged. You can change this value as required. This is a mandatory field.

You can enter non-negative full day only. You cannot enter fractions of days.

Job Description

Based on the option that you selected, you see a default job description.

For example, for Software Management purge jobs the default description is:

Purge - Software Management Jobs.

For Reports Archive Purge, the default description is: Purge - Reports Archive Purge.


Step 2 Click Done.

The purge job appears in the Job Purge dialog box.



Note You cannot purge the jobs that are in the running state.


Enabling a Purge Job

You can enable only a scheduled purge job.

To schedule a purge job, see Scheduling a Purge Job.

To enable a purge job:


Step 1 Select Resource Manager Essentials > Admin > System Preferences > Job Purge.

The Job Purge dialog box appears.

Step 2 Click Enable.

A confirmation message appears:

There is a purge schedule and it is enabled.

Step 3 Click OK.

The Status column in the Job Purge window displays Enabled for the selected application purge job.


Disabling a Purge Job

You can disable only a purge job that is scheduled and enabled.

To schedule a purge job, see Scheduling a Purge Job and to enable a purge job, see Enabling a Purge Job.

To disable a purge job:


Step 1 Select Resource Manager Essentials > Admin > System Preferences > Job Purge.

The Job Purge dialog box appears.

Step 2 Click Disable.

A confirmation message appears:

There is a purge schedule and it is disabled.

Step 3 Click OK.

The Status column in the Job Purge window displays Enabled for the selected application purge job.


Performing an Immediate Purge

Using this option you can purge application jobs immediately. That is, you can purge RME jobs without scheduling and enabling the purge job.

For the Purge Now task, the Job ID is not assigned. Also, if a Job ID already exist for that application, the Job ID is not updated for Purge Now tasks. That is, the scheduled purge job is not affected by Purge Now task.

To perform an immediate purge:


Step 1 Select Resource Manager Essentials > Admin > System Preferences > Job Purge.

The Job Purge dialog box appears.

Step 2 Click Purge Now.

The Explorer User Prompt dialog box appears.

Step 3 Enter the number of days jobs that have to be purged.

The default setting for purging archived data is 180 days. That is, data older than 180 days will be purged. You can change value this as required.

You can enter non-negative full day values only. You cannot enter fractions of days.

Step 4 Click OK.

The Purge Job Details window appears displaying the purged job details.



Note You cannot purge the jobs that are in the running state.


RME Device Attributes

This option enables you to set the default values for device attributes. These values are applicable to all devices in RME. The RME device attributes are:

SNMP Retry—Number of times that the system should try to access devices with SNMP options.

The default value is 2. The minimum value is zero and the maximum value is 6.

SNMP Timeout—Amount of time that the system should wait for a device to respond before it tries to access it again.

The default value is 2 seconds and the minimum value is zero seconds. There is no maximum value limit. Changing the SNMP timeout value affects inventory collection.

Telnet Timeout—Amount of time that the system should wait for a device to respond before it tries to access it again.

The default value is 36 seconds and the minimum value is zero seconds. There is no maximum value limit.

Changing the telnet timeout value affects inventory collection.

Natted RME IP Address—The RME server ID. This is the translated address of RME server as seen from the network where the device resides.

You need to enable support for NAT, in a scenario where RME tries to contact devices outside the NAT boundary.

The default value is Not Available.

TFTP Timeout—Amount of time that the system should wait for a device to respond before it tries to access it again.

The default value is 5 and the minimum value is 0 seconds. There is no maximum value limit.

To edit the RME device attributes:


Step 1 Select Resource Manager Essentials > Admin > System Preferences > RME Device Attributes.

The RME Device Attributes dialog box appears.

Step 2 Enter the default values for:

SNMP Retry

SNMP Timeout

Telnet Timeout

Natted RME IP Address

TFTP Timeout

The value you enter here will be applicable for all RME devices. You can change the value for individual devices and also enter the device serial number information using the Edit Devices Attributes option on RME Devices window. (see To set or edit the RME device attributes for a single RME device.)

Step 3 Click Apply.

A confirmation message appears:

Default settings are updated successfully.

Step 4 Click OK.


RME Secondary Credentials

The RME server polls and receives two types of credentials from each device and populates the Device Credential Repository (DCR).These credentials are:

Primary Credentials

Secondary Credentials

RME uses either the primary or secondary credentials to access the devices using the following protocols:

Telnet

SSH

The RME server first uses the Primary Credentials to access the device. The Primary Credentials is tried out three times and on failure the Secondary Credentials is tried out three times. Secondary Credentials is used as a fallback mechanism in RME 4.1 for connecting to devices. For instance, if the AAA Server is down, accessing devices using their primary credentials will lead to failure.

You can add or edit the Secondary Credentials information through the DCR page available in CiscoWorks Common Services if the Secondary Credential information is not available for a device.


Note The use of Secondary Credentials fallback is applicable for both Login and Enable connectivity.


You can use the RME Secondary Credential dialog box to enable or disable Secondary Credentials fallback when the Primary Credentials for a device fails. This is a global option which you can use to enable or disable the use of Secondary Credential fallback for all RME applications.

To enable or disable the Secondary Credentials fallback:


Step 1 Select Resource Manager Essentials > Admin > System Preferences > RME Secondary Credentials

The RME Secondary Credentials dialog box appears.

Step 2 Do either of the following:

Check Fallback to Secondary Credentials checkbox if you want to enable the Secondary Credential fallback.

Or

Uncheck Fallback to Secondary Credentials checkbox if you want to disable the Secondary Credential fallback.

Step 3 Click either Apply to apply the option or click Cancel to discard the changes.


Collection Failure Notification

You can use the Collection Failure Notification window to configure the receipt of Trap messages by the host(s) mentioned in the env.properties file on Inventory Collection or Config Fetch failure. This Trap is sent for each device from the RME server whenever the collection does not happen.

The destination IP address to which the traps are to be sent can be configured in the env.properties file. This file is available under this location:

NMSROOT/MDC/tomcat/webapps/rme/WEB-INF/classes/com/cisco/nm/ rmeng/util/env.properties

where NMSROOT is the actual CiscoWorks install directory.

The variables that can be configured in the env.properties file are:

NOTIFY_IP

This variable allows you to configure the destination IP addresses for the receipt of trap messages. The initial value assigned to this variable is DEFAULT. Replace this DEFAULT with the IP address of the host(s) to which the Trap messages need to be sent. You can specify comma-separated IP addresses to which the trap messages are to be sent.

Example 1

You can set 10.10.10.10 as the destination IP Address to receive trap messages.

NOTIFY_IP = 10.10.10.10

Example 2

You can set 10.10.10.10, 20.20.20.20, and 30.30.30.30 as the destination IP Addresses to receive trap messages.

NOTIFY_IP = 10.10.10.10,20.20.20.20,30.30.30.30

NOTIFY_PORT

This variable allows you to configure the destination Port number to which the trap messages are to be sent. The initial value assigned to this variable is 162 and it is the default value. You can change this port number if you want to assign anyother port to receive Trap messages. Trap 162 is the recommended port to receive trap messages.

Example

You can set port 164 as the destination Port to receive the trap messages.

NOTIFY_PORT = 164

Any third party Trap receivers in the host(s) mentioned in the env.properties can receive the Trap messages on Config collection/Inventory collection failure.

Table 21-1 lists the various options available in the Collection Failure Notification Window:

Table 21-1 Notification on Failure

Field
Description

Config Collection

Check this option, if you require the Config Fetch Failure Trap notification to be sent to the host(s) mentioned in the env.properties file.

Uncheck this option if you do not want the Config Fetch Failure trap notification to be sent to the host(s) mentioned in the env.properties file.

Inventory Collection

Check this option, if you require the Inventory Collection Failure trap notification to be sent to the host(s) mentioned in the env.properties file.

Uncheck this option if you do not want the Inventory Collection Failure Trap notification to be sent to the host(s) mentioned in the env.properties file.

All

Check this option, if you require both the Config Fetch Failure and Inventory Collection Failure trap notifications to be sent to the host(s) mentioned in the env.properties file.

Apply

Click to accept the changes made.


Configuring Trap Notification Messages

To configure the distribution of trap notification messages from RME to the connected hosts:


Step 1 Select Resource Manager Essentials > Admin > System Preferences > Collection Failure Notification

The Notification on Failure dialog box appears. See Table 21-1 to further complete the selection in this dialog box.

Step 2 Click Apply to accept the changes made.


Examples for Collection Failure Notification

Example for Config Collection Trap Notification

For example, assume you enable the Config Fetch option. By enabling this option you allow trap notifications to be sent to the host(s) mentioned in the env.properties file.

After that you add few new devices to RME and schedule a job to fetch the configurations for all the devices. If there is a Config Fetch Failure because the scheduled job cannot fetch the configurations for the new devices, the trap notification is sent to the host(s) mentioned in the env.properties file for each Config Fetch Failure and for each device.

Example for Inventory Collection Trap Notification

For example, assume you enable the Inventory Collection option. By enabling this option you allow trap notifications to be sent to the host(s) mentioned in the env.properties file on Inventory Collection Failure to the specified port.

After that you add few new devices to RME and schedule a job to fetch the inventory information for all devices. If there is a Inventory Collection Failure because the scheduled job cannot fetch the inventory details for the new devices, the trap notification is sent to the host(s) mentioned in the env.properties file for each Inventory Collection Failure and for each device.

Fields in a Trap Notification Message

Table 21-2 lists the various fields that constitute a Configuration Fetch or Inventory Collection Failure trap notification message.

Table 21-2 Fields in a Trap Notification Message

Field
Description

Application Name

RME application that caused this change or identified the change and generated the notification.

Device Display Name

Network device for which the inventory or configuration collection has failed.

Collection Failure Time

Time at which the inventory or configuration collection job failed.

Error Message

The message that describes the reason for the collection failure. Some examples of trap error messages:

Inventory Collection Failed due to SNMP TimeOut Exception.

Config Collection Failed due to authentication failure.