User Guide for Device Fault Manager 1.1 (With LMS 2.0)
Using DFM Adapters
Download this chapter
Using DFM AdaptersUsing DFM Adapters
Download the complete book
Device Fault Manager User GuideDevice Fault Manager User Guide (PDF - 5 MB)
give_us_feedback

Table Of Contents

Using DFM Adapters

Adapter Overview and Uses

Notification Adapters and their Uses

Event Adapters and their Uses

Special Adapters and their Uses

Configuring and Starting Adapters

Using the DFM GUI to Configure Adapters

Using the Command Line to Configure Adapters

Changing Subscriptions for Notification Adapters

Specifying a Notification Adapter's Subscription Profile

Specifying Particular Events to Be Tracked by a Notification Adapter

Configuring the File Notifier Adapter

Using the DFM GUI to Configure the File Notifier Adapter

Using the Command Line to Configure the File Notifier Adapter

Configuring the Trap Notifier Adapter

Using the DFM GUI to Configure the Trap Notifier Adapter

Using the Command Line to Configure the Trap Notifier Adapter

Configuring the Mail Notifier Adapter

Using the DFM GUI to Configure the Mail Notifier Adapter

Using the Command Line to Configure the Mail Notifier Adapter

Configuring the HPOV-NetView Adapter

Configuring the SNMP Trap Adapter

Using the DFM GUI to Configure the SNMP Trap Adapter

Using the DFM GUI to Configure the SNMP Trap Adapter to Receive Traps

Using the DFM GUI to Configure the SNMP Trap Adapter to Forward Traps

Using the Command Line to Configure the SNMP Trap Adapter


Using DFM Adapters

Adapters integrate Device Fault Manager (DFM) with its environment and can be configured using either the GUI or the command line. The GUI allows you to do essential adapter configuration, while the command line lets you fine-tune the adapter. Both configuration methods modify the same underlying configuration files.

These topics explain how to configure the adapters:

•Adapter Overview and Uses

•Configuring and Starting Adapters

•Configuring the File Notifier Adapter

•Configuring the Trap Notifier Adapter

•Configuring the Mail Notifier Adapter

•Configuring the HPOV-NetView Adapter

•Configuring the SNMP Trap Adapter

Note Starting and stopping the adapters, with the exception of the HPOV-NetView Adapter, is controlled by CiscoWorks2000. The HPOV-NetView Adapter is started and stopped automatically by the OpenView or NetView network management system.

Adapter Overview and Uses

DFM adapters provide a means of communication between a domain manager and the networked system, as described in the "DFM Adapters" section. You can configure these adapters to suit your needs—for example, to send notifications to certain mailboxes, to forward and receive traps to and from specified network management systems, or to store alarms in files. Most DFM adapters can be configured using the DFM administration menus, although using the command line can sometimes provide fine-tuning.

To understand how adapters work with DFM, they are categorized as:

•Notification adapters, which receive event notifications from a domain manager and forward the event information to designated recipients.

•Event adapters, which monitor the status of managed elements and forward events to the domain manager for analysis.

•Special adapters, which perform specialized functions.

Notification Adapters and their Uses

You can configure notification adapters to forward event information to recipients on the network. DFM provides three types of notification adapters:

•File Notifier Adapter, which logs alarms detected by the DFM server and forwards them to a file. A file is the only valid recipient for this adapter. Use this adapter to create a historical file containing all alarms generated by DFM.

•Trap Notifier Adapter, which converts DFM alarms into SNMP trap messages and forwards the traps to recipients. You can specify the recipients, such as network management systems or other domain managers, using an IP address or a system name. Use this adapter to send DFM alarms to another application or NMS for additional processing or display. The format of the converted SNMP trap messages is provided in Appendix C, "SNMP Trap Notifier MIB."

•Mail Notifier Adapter, which uses SMTP to send mail notifications to recipients. Like the Trap Notifier Adapter, you can specify the recipients—in this case, an email address. Use this adapter to generate asynchronous email notifications when one or more alarm conditions occur. For example, you could use the Mail Notifier Adapter to send an epage to a specified list of recipients. For less serious faults, you might want to forward the notifications to a list of email addresses.

Event Adapters and their Uses

Event adapters include the HPOV-NetView Adapter, which forwards traps (sent from managed devices to the NMS) from an HP OpenView or NetView network management system to DFM. Use this adapter when you want DFM to monitor faults on devices managed by HP OpenView or NetView. This adapter can also be used with remote versions of HP OpenView or NetView. For more information, refer to Installing and Setting Up Device Fault Manager.

Special Adapters and their Uses

Special adapters are in a class of their own and operate somewhat differently from notification and event adapters, performing special functions or enabling services required by DFM. Special adapters include:

•SNMP Trap Adapter, which listens for traps (sent to DFM from managed devices) on a user-specified port and forwards the traps to specified destinations. Supported traps for forwarding are SNMP V1. Sample uses for this adapter are:

–Allowing DFM to coexist with another trap receiving application, such as an NMS, on the same server. Traps can be received by the SNMP Trap Adapter and forwarded to the other application on a different port (and vice versa).

–Having an NMS forward traps to DFM for processing.

–Having DFM listen for traps from devices and forward the traps to an NMS that does not support trap forwarding.

•RME Adapter, which synchronizes the list of managed devices in the Essentials inventory with the DFM inventory. Use this adapter when you want DFM to monitor faults on devices managed by Resource Manager Essentials. This adapter can also be used with remote versions of Essentials. For more information, refer to Installing and Setting Up Device Fault Manager. For more information on this adapter, including the supported versions of Resource Manager Essentials, refer to "Working with the DFM Inventory."

Configuring and Starting Adapters

Table 10-1 summarizes which adapters you must configure, whether you can use the GUI and/or command line to configure the adapter, and whether you must manually start the adapter.

Note Whenever you configure any adapter using the command line, you must manually stop and restart the adapter. Adapters configured with the DFM administration menus do not need to be stopped and restarted.

Table 10-1 Configuring and Starting Adapters 

Adapter Type
and Name
Must Be Configured Before Use
Can Be Configured Using...
Automatically Starts with CiscoWorks2000
DFM GUI
CLI
Notification Adapters

File Notifier

No

Yes

Yes

No

Trap Notifier

No

Yes

Yes

No

Mail Notifier

Yes

Yes

Yes

No

Event Adapters

HPOV-NetView

No

No

Yes

Yes, if HP OpenView or NetView are installed on the same machine as the adapter

Special Adapters

SNMP Trap

Yes

Yes

Yes

Yes

RME Adapter

No

N/A, but can be started using the CiscoWorks2000 GUI

N/A

Yes, if Essentials is installed on the same machine as the adapter


Note For more information on the RME Adapter, refer to "Working with the DFM Inventory."

When an adapter starts, its configuration information is loaded from a file. The configuration files have an extension of /conf and are located in directories under the directory NMSROOT/objects/smarts/conf.

Caution Do not rename the configuration files or move them. Adapters that cannot find the required configuration file will not run.

All of the adapters, except the HPOV-NetView Adapter, can be configured using either the DFM GUI or the command line. Both methods modify the same underlying configuration files.

Using the DFM GUI to Configure Adapters

You can configure the following adapters using the DFM GUI. After configuring an adapter using the GUI, you do not need to restart the CiscoWorks2000 process associated with the adapter (as described in the "DFM and CiscoWorks2000 Processes" section on page 11-12).

Adapter
DFM GUI Choice
For more information, refer to...

File Notifier Adapter

Device Fault Manager > Administration >
Fault Notification  > File Notifier

Using the DFM GUI to Configure the File Notifier Adapter

Trap Notifier Adapter

Device Fault Manager > Administration >
Fault Notification  > Trap Notifier

Using the DFM GUI to Configure the Trap Notifier Adapter

Mail Notifier Adapter

Device Fault Manager > Administration >
Fault Notification  > Mail Notifier

Using the DFM GUI to Configure the Mail Notifier Adapter

SNMP Trap Adapter

Device Fault Manager > Administration >
Trap Configuration  > Trap Receiving

Device Fault Manager > Administration >
Trap Configuration  > Trap Forwarding

Using the DFM GUI to Configure the SNMP Trap Adapter


Using the Command Line to Configure Adapters

To change the configuration of an adapter using the command line:

Step 1 Locate the configuration file for the given adapter. The configuration files are located in the NMSROOT/objects/smarts/conf directory; the filenames are listed in the sections that provide detailed information about the adapters.

Note Save a copy of any configuration file you intend to change.

Step 2 Edit the configuration file, changing only the parameters listed in Table 10-3 through Table 10-6. When changing notification adapter subscriptions, see the "Changing Subscriptions for Notification Adapters" section.

Step 3 Save the edited configuration file(s).

Step 4 Stop and restart the appropriate CiscoWorks2000 process (using Server Configuration>Adminsitration>Process Management), as follows:

•DfmFileNotifier (for the File Notifier Adapter)

•DfmTrapNotifier (for the Trap Notifier Adapter)

•DfmMail Notifier (for the Mail Notifier Adapter)

•DfmServer (for the SNMP Trap Adapter)

If you have to stop the DfmServer process, you will first have to stop any running processes that depend on the DfmServer process.

Step 5 If necessary, register the adapter for automatic startup by running these commands to unregister and re-register the adapters. NMSROOT is the directory where CiscoWorks is installed (for Solaris, the default value for NMSROOT is /opt/CSCOpx, and for Windows2000 and Windows NT, the default value is C:\Program Files\CSCOpx).

On Solaris, the commands are:

•For DfmFileNotifier (the second command is one line): 

# NMSROOT/bin/pdcmd -u DfmFileNotifier

# NMSROOT/bin/pdcmd -r DfmFileNotifier -d DfmServer 
-e NMSROOT/objects/smarts/bin/sm_notify -f "--adapter=filelog --output=sm_file_notifier"

•For DfmTrapNotifier (the second command is one line): 

# NMSROOT/bin/pdcmd -u DfmTrapNotifier

# NMSROOT/bin/pdcmd -r DfmTrapNotifier -d DfmServer -e  
NMSROOT/objects/smarts/bin/sm_notify -f "--adapter=trap --output=sm_trap_notifier"

•For DfmMailNotifier on Solaris (the second command is one line): 

# NMSROOT/bin/pdcmd -u DfmMailNotifier

# NMSROOT/bin/pdcmd -r DfmMailNotifier -d DfmServer 
-e NMSROOT/objects/smarts/bin/sm_notify -f "--adapter=mail --output=sm_mail_notifier"

On Windows 2000 and Windows NT, the commands are:

•For DfmFileNotifier (the second command is one line): 

# NMSROOT\bin\pdcmd.exe -u DfmFileNotifier

# NMSROOT\bin\pdcmd.exe -r DfmFileNotifier -d DfmServer 
-e NMSROOT\objects\smarts\bin\sm_notify.exe -f "--adapter=filelog 
--output=sm_file_notifier"

•For DfmTrapNotifier (the second command is one line): 

# NMSROOT\bin\pdcmd.exe -u DfmTrapNotifier

# NMSROOT\bin\pdcmd.exe -r DfmTrapNotifier -d DfmServer -e  
NMSROOT\objects\smarts\bin\sm_notify.exe -f "--adapter=trap --output=sm_trap_notifier"

•For DfmMailNotifier on Solaris (the second command is one line): 

# NMSROOT\bin\pdcmd.exe -u DfmMailNotifier

# NMSROOT\bin\pdcmd.exe -r DfmMailNotifier -d DfmServer 
-e NMSROOT\objects\smarts\bin\sm_notify.exe -f "--adapter=mail --output=sm_mail_notifier"

To start or stop individual adapter processes, refer to the "DFM and CiscoWorks2000 Processes" section on page 11-12.

Changing Subscriptions for Notification Adapters

The File, Trap, and Mail Notifier Adapter configuration files contain a SubscribesTo parameter, which specifies the devices and notifications the adapter should monitor. This allows you to tailor the adapters to track only the information you want to track.

The following topics describe how to use subscriptions with notification adapters.

Specifying a Notification Adapter's Subscription Profile

You can directly edit a notification adapter configuration file to specify a particular subscription profile (profileName), which identifies the events the adapter will track. (Creating subscription profiles is described in the "Changing Your Subscription Profile" section on page 13-20.)

Note The profileName must match an existing DFM subscription profile. 

SubscribesTo =

{

	GA_ProfileSubscription::Filelog-Default-Profile-Subscriptions

	{

		profileName = "default"

	}

}

Specifying Particular Events to Be Tracked by a Notification Adapter

You can directly edit a notification adapter configuration file to specify the events to which a notification adapter will subscribe. This section describes:

•Valid Parameters for Subscriptions

•Examples of Subscriptions

Valid Parameters for Subscriptions

The device parameters for subscriptions include:

className

Type of managed element (for example, Chassis).

instanceName

Objects that describe the managed element (for example, NumberOfSlots, NumberOfPowerSupplies, ChassisType).

eventName

Name of compound or symptom to be reported for the managed element.

aggregates

Compound events. If set to TRUE, sends a notification when the selected compound events occur.

symptoms

Symptomatic events. If set to TRUE, sends a notification when the selected symptomatic events occur.


A complete list of valid classes, instances, and events is provided in Table 10-2. This method is normally used with the Mail Notifier Adapter and Trap Notifier Adapter. The File Notifier Adapter is ready to use; normally, you will only want to enable the File Notifier Adapter to create one repository for all generated alarms.

Table 10-2 lists the classes, instances, and events supported by DFM.

Note The class ICIM_UnitaryComputerSystem represents the following classes: Bridge, Host, Hub, MSFC, Router, RSFC, RSM and Switch. You can subscribe to any of these systems individually (such as Router, Switch, and so forth), or subscribe to the class ICIM_UnitaryComputerSystem when you want to subscribe to events on all of these system classes.

Table 10-2 Supported Subscription Classes, Instances, and Events 

Class
Instance
Event (Symptom/Compound)

ICIM_UnitaryComputerSystem

.*

DiscoveryError (S)

.*

ErrorException (C)

.*

 

HighErrorRate (S)

.*

OperationalException (C)

.*

 

BackupActivated (S)

.*

 

ExceededMaximumUptime (S)

.*

 

ExcessiveRestarts (S)

.*

 

Flapping (S)

.*

 

OperationallyDown (S)

.*

 

Unresponsive (S)

.*

PerformanceException (C)

.*

 

HighBroadcastRate (S)

.*

 

HighCollisionRate (S)

.*

 

HighDiscardRate (S)

.*

 

HighQueueDropRate (S)

.*

 

HighUtilization (S)

.*

PowerSupplyException (C)

.*

 

VoltageOutOfRange (S)

.*

 

VoltageStateNotNormal (S)

.*

 

PowerSupplyStateNotNormal (S)

.*

ResourceException (C)

.*

 

ExcessiveFragmentation (S)

.*

 

HighBufferMissRate (S)

.*

 

HighBufferUtilization (S)

.*

 

HighUtilization (S)

.*

 

InsufficientFreeMemory (S)

ICIM_UnitaryComputerSystem (continued)

.*

TemperatureException (C)

.*

 

FanStateNotNormal (S)

.*

 

TemperatureOutOfRange (S)

.*

 

TemperatureStateNotNormal (S)

.*

Unresponsive (S)

Card

.*

OperationallyDown (S)

Chassis

.*

BackplaneUtilizationException (C)

.*

 

HighBackplaneUtilization (S)

.*

OperationallyDown (S)

Chassis_Performance

.*

BackplaneUtilizationException (C)

 

.*

 

HighBackplaneUtilization (S)

Chassis_Performance_CiscoStack

.*

BackplaneUtilizationException (C)

 

.*

 

HighBackplaneUtilization (S)

CPU_Performance_CiscoRouter

.*

HighUtilization (S)

DuplicateIP

.*

Duplicate (S)

EthernetAdapter_Performance

.*

PerformanceException (C)

.*

 

HighBroadcastRate (S)

.*

 

HighCollisionRate (S)

.*

 

HighDiscardRate (S)

.*

 

HighQueueDropRate (S)

.*

 

HighUtilization (S)

.*

ErrorException (C)

.*

 

HighErrorRate (S)

Event

.*

InformAlarm (S)

.*

MinorAlarm (S)

.*

MajorAlarm (S)

Fan_Fault

.*

StateNotNormal (S)

Fan_Fault_CiscoEnvMon

.*

StateNotNormal (S)

Fan_Fault_CiscoLS1010

.*

StateNotNormal (S)

Fan_Fault_CiscoStack

.*

StateNotNormal (S)

FTPService

.*

Unresponsive (S)

HTTPService

.*

Unresponsive (S)

Interface_Fault_MIB2

.*

AdministrativelyDown (S)

.*

BackupActivated (S)

.*

ExceededMaximumUptime (S)

.*

Flapping (S)

.*

OperationallyDown (S)

Interface_Performance_CiscoRouter

.*

PerformanceException (C)

.*

 

HighBroadcastRate (S)

.*

 

HighCollisionRate (S)

.*

 

HighDiscardRate (S)

.*

 

HighQueueDropRate (S)

.*

 

HighUtilization (S)

.*

ErrorException (C)

.*

 

HighErrorRate (S)

Interface_Performance_CiscoRouter_Ethernet

.*

HighBroadcastRate (S)

.*

HighDiscardRate (S)

.*

HighQueueDropRate (S)

.*

HighUtilization (S)

.*

ErrorException (C)

.*

 

HighErrorRate (S)

Interface_Performance_MIB2

.*

HighBroadcastRate (S)

.*

HighDiscardRate (S)

.*

HighQueueDropRate (S)

.*

HighUtilization (S)

.*

ErrorException (C)

.*

 

HighErrorRate (S)

Memory_Performance

.*

ExcessiveFragmentation (S)

.*

HighBufferMissRate (S)

.*

HighBufferUtilization (S)

.*

InsufficientFreeMemory (S)

Memory_Performance_CiscoRouter

.*

ExcessiveFragmentation (S)

.*

HighBufferMissRate (S)

.*

HighBufferUtilization (S)

.*

InsufficientFreeMemory (S)

NetworkAdapter_Fault

.*

AdministrativelyDown (S)

.*

BackupActivated (S)

.*

ExceededMaximumUptime (S)

.*

Flapping (S)

.*

OperationallyDown (S)

NetworkAdapter_Fault_MIB2

.*

AdministrativelyDown (S)

.*

BackupActivated (S)

.*

ExceededMaximumUptime (S)

.*

Flapping (S)

.*

OperationallyDown (S)

NetworkAdapter_Fault_SNMP

.*

AdministrativelyDown (S)

.*

BackupActivated (S)

.*

ExceededMaximumUptime (S)

.*

Flapping (S)

.*

OperationallyDown (S)

NetworkAdapter_Performance

.*

HighBroadcastRate (S)

.*

HighDiscardRate (S)

.*

HighQueueDropRate (S)

.*

HighUtilization (S)

.*

ErrorException (C)

.*

 

HighErrorRate (S)

Port_Fault_MIB2

.*

AdministrativelyDown (S)

.*

BackupActivated (S)

.*

ExceededMaximumUptime (S)

.*

Flapping (S)

.*

OperationallyDown (S)

Port_Fault_MIB2Repeater

.*

AdministrativelyDown (S)

.*

BackupActivated (S)

.*

ExceededMaximumUptime (S)

.*

Flapping (S)

.*

OperationallyDown (S)

Port_Performance_MIB2

.*

HighBroadcastRate (S)

.*

HighDiscardRate (S)

.*

HighQueueDropRate (S)

.*

HighUtilization (S)

.*

ErrorException (C)

.*

 

HighErrorRate (S)

Port_Performance_dot3_Ethernet

.*

ErrorException (C)

.*

 

HighErrorRate (S)

.*

PerformanceException (C)

.*

 

HighBroadcastRate (S)

.*

 

HighCollisionRate (S)

.*

 

HighDiscardRate (S)

.*

 

HighQueueDropRate (S)

.*

 

HighUtilization (S)

PowerSupply_Fault

.*

StateNotNormal (S)

PowerSupply_Fault_CiscoEnvMon

.*

StateNotNormal (S)

PowerSupply_Fault_CiscoLS1010

.*

StateNotNormal (S)

PowerSupply_Fault_CiscoStack

.*

StateNotNormal (S)

Processor_Performance

.*

HighUtilization (S)

Rack

.*

OperationallyDown (S)

SMTPService

.*

Unresponsive (S)

SNMPAgent

.*

Unresponsive (S)

SNMPTrap

.*

InformAlarm (S)

.*

MinorAlarm (S)

.*

MajorAlarm (S)

SNMPAgent_Fault

.*

RepeatedRestarts (S)

SNMPAgent_Fault_MIB2

.*

RepeatedRestarts (S)

TemperatureSensor_Fault

.*

OutOfRange (S)

.*

StateNotNormal (S)

TemperatureSensor_Fault_CiscoEnvMon

.*

OutOfRange (S)

.*

StateNotNormal (S)

TemperatureSensor_Fault_CiscoLS1010

.*

OutOfRange (S)

.*

StateNotNormal (S)

TemperatureSensor_Fault_CiscoStack

.*

OutOfRange (S)

.*

StateNotNormal (S)

VLAN

.*

ErrorException (C)

.*

 

HighErrorRate (S)

.*

OperationalException (C)

.*

 

BackupActivated (S)

.*

 

ExceededMaximumUptime (S)

.*

 

ExcessiveRestarts (S)

.*

 

Flapping (S)

.*

 

OperationallyDown (S)

.*

 

Unresponsive (S)

.*

PerformanceException (C)

.*

 

HighBroadcastRate (S)

.*

 

HighCollisionRate (S)

.*

 

HighDiscardRate (S)

.*

 

HighQueueDropRate (S)

.*

 

HighUtilization (S)

VoltageSensor_Fault

.*

OutOfRange (S)

.*

StateNotNormal (S)

VoltageSensor_Fault_CiscoEnvMon

.*

OutOfRange (S)

.*

StateNotNormal (S)

VoltageSensor_Fault_CiscoLS1010

.*

OutOfRange (S)


Examples of Subscriptions

This topic contains examples of the adapter subscriptions. These examples show the varying degrees of complexity supported by the configuration files.

In the following example, the Mail Notifier Adapter will report all Operational Exception aggregates (compound events) that occur on any router managed by DFM: 

SubscribesTo =

{

             

	GA_ChoiceSubscription::Mail-All-Subscriptions

	{

	# Subscribe to events whose class, instance, and event

	# names match the given pattern.

		 className = "Router"

	      instanceName = ".*"

		 eventName = "OperationalException"

		aggregates = TRUE

		  symptoms = FALSE

	}

}

According to the following example, the Mail Notifier Adapter will report when the state of any power supply managed by DFM is not normal: 

SubscribesTo =

{

             

	GA_ChoiceSubscription::Mail-All-Subscriptions

	{

	# Subscribe to events whose class, instance, and event

	# names match the given pattern.

		 className = "PowerSupply_Fault.*"

	      instanceName = ".*"

		 eventName = ".*"

		aggregates = TRUE

		  symptoms = TRUE

	}

}

According to the following example, the Mail Notifier Adapter will report all high broadcast rate events that occur on any port managed by DFM: 

SubscribesTo =

{

             

	GA_ChoiceSubscription::Mail-All-Subscriptions

	{

	# Subscribe to events whose class, instance, and event

	# names match the given pattern.

		 className = ".*Port.*"

	      instanceName = ".*PORT-.*"

		 eventName = "HighBroadcastRate"

		aggregates = TRUE

		  symptoms = TRUE

	}

}

According to the following example, the Mail Notifier Adapter will report all interface performance events that occur on any interface managed by DFM: 

SubscribesTo =

{

             

	GA_ChoiceSubscription::Mail-All-Subscriptions

	{

	# Subscribe to events whose class, instance, and event

	# names match the given pattern.

		 className = "Interface_Performance.*"

	      instanceName = ".*"

		 eventName = ".*"

		aggregates = TRUE

		  symptoms = TRUE

	}

}

In the following example, the Mail Notifier Adapter will report all high utilization events that occur on any interface managed by DFM: 

SubscribesTo =

{

             

	GA_ChoiceSubscription::Mail-All-Subscriptions

	{

	# Subscribe to events whose class, instance, and event

	# names match the given pattern.

		 className = ".*"

	      instanceName = ".*IF-.*"

		 eventName = "HighUtilization"

		aggregates = TRUE

		  symptoms = TRUE

	}

}

If desired, you can also configure a single notification adapter to subscribe to diverse classes and events by adding the following code fragments to the appropriate notification adapter configuration file: 

SubscribesTo =

{

             

	GA_ChoiceSubscription::Name-All-Subscriptions

	{

	# Subscribe to events whose class, instance, and event

	# names match the given pattern.

		 className = "class"

	      instanceName = ".*"

		 eventName = "event"

		aggregates = {TRUE | FALSE}

		  symptoms = {TRUE | FALSE}

	},

	GA_ChoiceSubscription::Name-All-Subscriptions

	{

	# Subscribe to events whose class, instance, and event

	# names match the given pattern.

		 className = "class"

	      instanceName = ".*"

		 eventName = "event"

		aggregates = {TRUE | FALSE}

		  symptoms = {TRUE | FALSE}

	}

}

When using this method, follow these rules:

•Name must be unique.

•Separate each GA_ChoiceSubscription code fragment with a comma (except for the last fragment).

•Provide values for class and event according to the list on pages 10-9 through 10-12 of the Device Fault Manager User Guide.

•Specify TRUE or FALSE depending on whether or not you want to subscribe to aggregates (compound events) and/or symptoms.

For example, to configure the Mail Notifier Adapter to track all router and switch aggregates (compound events), along with all chassis symptoms, add the following to the Mail Notifier Adapter configuration file: 

SubscribesTo =

{

             

	GA_ChoiceSubscription::Router-All-Subscriptions

	{

	# Subscribe to events whose class, instance, and event

	# names match the given pattern.

		 className = "Router"

	      instanceName = ".*"

		 eventName = ".*"

		aggregates = TRUE 

		  symptoms = TRUE 

	},

	GA_ChoiceSubscription::Switch-All-Subscriptions

	{

	# Subscribe to events whose class, instance, and event

	# names match the given pattern.

		 className = "Switch"

	      instanceName = ".*"

		 eventName = ".*"

		aggregates = TRUE

		  symptoms = TRUE 

	},

	GA_ChoiceSubscription::Chassis-All-Subscriptions

	{

	# Subscribe to events whose class, instance, and event

	# names match the given pattern.

		 className = ".*"

	      instanceName = ".*"

		 eventName = ".*"

		aggregates = FALSE

		  symptoms = TRUE 

	}

}

Configuring the File Notifier Adapter

Note The File Notifier Adapter must be started before it can be used. See the "Configuring and Starting Adapters" section for detailed procedures.

You can use either the GUI or command line to configure the File Notifier Adapter. The GUI lets you do essential configuration, while the command line lets you fine-tune the adapter.

Note The File Notifier Adapter logs all alarms once it is started. You cannot modify the adapter to store alarms for specified lengths of time.

Using the DFM GUI to Configure the File Notifier Adapter

When you enable the File Notifier Adapter using the DFM GUI, the adapter process is registered with CiscoWorks2000, and you can check its status using Server Configuration > Administration > Process Management. If you stop the adapter process from the CiscoWorks2000 GUI, the adapter will be marked disabled in the DFM GUI.

To enable or disable logging and storing alarms detected by DFM in a log file:

Step 1 Select  Device Fault Manager > Administration > Fault Notification > File Notifier.

Step 2 In the Adapter field, select ENABLED or DISABLED to start or stop event logging in the alarms file.

Step 3 Click OK.

This procedure does the following:

•Enables/disables the process and registers/unregisters the process with CiscoWorks2000. When the process is unregistered, you will no longer see it using Server Configuration > Administration > Process Management.

•Creates the File Notifier log file NMSROOT/objects/smarts/logs/sm_file_notifier.log.

•Creates the alarm file NMSROOT/objects/smarts/logs/DFM-alarms.log.

You do not have to restart CiscoWorks2000 for your changes to take effect. To specify the types of notifications you want forwarded to the alarms file, use the command line (refer to the "Using the Command Line to Configure the File Notifier Adapter" section).

Using the Command Line to Configure the File Notifier Adapter

This topic describes the contents of the File Notifier Adapter file (NMSROOT/objects/smarts/conf/notifier/filelog_notify.conf). Table 10-3 lists the parameters you can change using the command line. Additional configuration of this file is normally not required. 

#

# This is a configuration file which contains objects for the

# file notification adapter.

#

# Based on GNA - the Generic Notification Adapter framework

#

# $Id: filelog_notify.conf,v 1.1.2.5.2.2 2000/12/20 17:50:07 current Exp $

#



#

# The GNA notifier object.

#

GNA_Notifier::filelog-Notifier

{

	serverName = "DFM"


	# How long to wait, in seconds, before beginning to send events. Default

	# is 1 sec., to prevent a flood of notifications upon adapter startup.

	initialEventDelay = 1


	ProvidesAdditionalParams = Filelog_AdapterParams::file_Notifier-Parameters

	{

	}


	ReadsInputFrom = GA_SubscriberFE::Filelog_Subscriber-FrontEnd

	{

		# How long an event must remain active before the adapter sends a

		# notification, in units of seconds.

		eventSmoothingInterval = 0


		# Notification threshold; discard notifications with a certainty

		# below this value.

		minimumCertainty = 0.01

		SubscribesTo =

		{

			GA_ProfileSubscription::Filelog-Default-Profile-Subscriptions

			{

				profileName = "default"

			}

		}

	}


	# No user-serviceable parts below here.

	#

   start_stopRuleSet = "filelog/filelogInit.asl"


     adapterRuleSet = "filelog/filelogNotify.asl"


       PerformsSend = FilelogAction::filelog_Interface

}

File Notifier Adapter Command Line Parameters

Table 10-3 lists the File Notifier Adapter parameters you can change.

Table 10-3 File Notifier Adapter Parameters 

Parameter
Description

serverName

Default name of the DFM to connect to. Note that this is the name of the DFM, not the name of the host it is running on. The default is DFM.

initialEventDelay

Time interval (in seconds) the adapter should wait before accepting events from the DFM. The default value is 1.

eventSmoothingInterval

Time (in seconds) that an event must remain in its current state before the adapter sends a notification. If the event is cleared before the event smoothing interval expires, it is not sent. The default value is 0 seconds.

minimumCertainty

Threshold above which notifications are logged. Any notification with a certainty below the threshold is discarded. Values may range from 0.0 to 1.0. The default value is 0.01.

SubscribesTo

Devices and types of notifications an adapter subscribes to. The default is all notifications and devices. Refer to the "Changing Subscriptions for Notification Adapters" section.


When the adapter starts, it creates the File Notifier log file NMSROOT/objects/smarts/logs/sm_file_notifier.log. Anytime you change the File Notifier Adapter file, you must restart the corresponding CiscoWorks2000 process as described in the "DFM and CiscoWorks2000 Processes" section on page 11-12. To configure the File Notifier Adapter for automatic startup with CiscoWorks2000, refer to the "Using the Command Line to Configure Adapters" section.

Alarm Log Example

The following is an example of the DFM alarm log file, NMSROOT/objects/smarts/logs/DFM-alarms.log: 

02-Feb-2001 11:58:38 NOTIFY Switch::172.16.0.0::DiscoveryError 100% An error was 
encountered during the last discovery probe of this System.  


02-Feb-2001 12:00:19 CLEAR Switch::172.16.0.0::DiscoveryError An error was encountered 
during the last discovery probe of this System.  


02-Feb-2001 12:03:14 NOTIFY Switch::172.16.0.0::PowerSupplyException 100% System is 
experiencing power supply problems.  


02-Feb-2001 12:03:14 NOTIFY PowerSupply_Fault_CiscoStack::PWR-172.16.0.0/2 
[]::StateNotNormal 100% The power supply is not in the normal state.  


02-Feb-2001 12:05:09 NOTIFY Undiscovered::172.31.255.255::DiscoveryError 100% An error was 
encountered during the last discovery probe of this System.

Configuring the Trap Notifier Adapter

Note The Trap Notifier Adapter must be started before it can be used. See the "Configuring and Starting Adapters" section for detailed procedures.

You can use either the GUI or command line to configure the Trap Notifier Adapter. The GUI lets you do essential configuration, while the command line lets you fine-tune the adapter.

Using the DFM GUI to Configure the Trap Notifier Adapter

When you enable the Trap Notifier Adapter using the DFM GUI, the adapter process is registered with CiscoWorks2000, and you can check its status using Server Configuration > Administration > Process Management. If you stop the adapter process from the CiscoWorks2000 GUI, the adapter will be marked disabled in the DFM GUI.

To notify other hosts of DFM events and alarms:

Step 1 Select Device Fault Manager > Administration > Fault Notification > Trap Notifier.

Step 2 In the Adapter field, select ENABLED or DISABLED to start or stop trap notification.

Step 3 If you want to add a recipient, in the Add Recipients field, enter the hostname and port number of the machine you want to notify about events and alarms.

Step 4 If you want to remove a recipient, select the recipient from the Remove Recipient field.

Step 5 Click OK.

This procedure does the following:

•Enables/disables the process and registers/unregisters the process with CiscoWorks2000. When the process is unregistered, you will no longer see it using Server Configuration >Administration >  Process Management.

•Updates the Trap Notifier Adapter configuration file NMSROOT/objects/