-
User Guide for Device Fault Manager 2.0.6 (With LMS 2.6)
-
Open Source License Acknowledgements
-
Preface
-
Introduction
-
Getting Started with DFM
-
Using the Alerts and Activities Display
-
Using Device Management
-
Using Notification Services
-
Using Fault History
-
Configuring and Administering DFM (Basic)
-
Managing Groups
-
Configuring Views for the Alerts and Activities Display
-
Configuring Polling and Thresholds
-
Administering DFM (Advanced)
-
MIBs Polled
-
Processed and Pass-Through Traps, and Unidentified Traps and Events
-
Notification MIB
-
Events Processed
-
Polling-SNMP and ICMP
-
How DFM Calculates Repeated Restarts and Flapping
-
CiscoWorks Navigation Changes
-
Index
-
Table Of Contents
Getting Started with Device Management
Types of Devices and Device Elements that DFM Monitors
Ports and Interfaces that DFM Manages
Listing Ports and Interfaces in the DFM Inventory
Understanding the Device and Credentials Repository
Events That Trigger DCR and DFM Synchronization
Understanding the Device Summary and Device States
Importing Devices from the DCR
How DFM Identifies Devices Imported from the DCR
How DFM Handles Containing and Contained Devices
Automatically Importing DCR Devices
Manually Importing DCR Devices Using the Device Selector
Determining Which Devices Are in DCR But Not in DFM
Importing Devices from DFM 1.2.x
Viewing Alias (Duplicate) Devices
Verifying Device Import Using Discovery Status
Troubleshooting Device Import and Discovery
Editing Device Configuration and Credentials
Rediscovering and Deleting Devices
Understanding the Device Details Display
Modifying SNMP Timeout and Retries
Using Device Management
These topics explain how to use Device Fault Manager (DFM) Device Management:
•
Getting Started with Device Management
•
•
•
•
Getting Started with Device Management
For DFM to monitor a device, you must first add the device to the Device and Credentials Repository (DCR). Use the DCR to perform the following operations:
•
•
•
•
Once a device is added to the DCR, you can then add it to the DFM inventory, which is separate from the DCR. You can add devices from the DCR to DFM automatically by activating automatic synchronization (the default), or you can add them selectively by deactivating using the Device Selector. For more information on how DFM is affected by the DCR, refer to Understanding the Device and Credentials Repository.
DFM is the front-end for performing the following operations on devices in the DFM inventory:
•
•
•
•
As DFM discovers devices, they pass through various device states until they are fully recognized by DFM (see Verifying Device Import Using Discovery Status for details). Once a device is discovered, DFM manages the device and its components according to the polling and threshold settings that apply to the device group (when it is added to the DCR, the DCR assigns the device to a device group).
Technically, DFM manages a device when the device's management state is set to True; conversely, DFM is not managing a device when its management state is set to False. A device with a management state set to False is also called a suspended device. You can also selectively unmanage device components (see Suspending/Resuming a Device Component, page 3-19).
Note
For information on how many devices DFM can manage, refer to Installation and Setup Guide for Device Fault Manager 2.0.3. If the DFM inventory exceeds your device limit, you will see a warning message. For more information, see Responding to Messages About Device Limits, page 2-11.
Types of Devices and Device Elements that DFM Monitors
When devices are added to the DCR, they are assigned to Common Services System Defined Groups. The group to which the DCR assigns the device depends on the device type users specify when they add the device. If a user does not select a device type, or selects the wrong device type, the DCR designates the device as Unknown, and it is assigned to the Common Services Unknown group. (For devices with no specified device type, DFM assigns a device type when it discovers the device.) See Table 4-1 for more information.
Figure 4-1 shows an example of the Common Services System Defined Groups, as seen in the DFM Object Selector.
Figure 4-1 Common Services System Defined Groups
When devices are imported into CiscoWorks, Common Services assigns each device to the appropriate CiscoWorks Common Services system defined group. These groups are listed in Common Services System Defined Groups, page 8-3. When a device is added to the DFM inventory, DFM assigns the device components to the appropriate DFM system defined port and interface groups. These groups are listed in DFM System Defined Groups, page 8-4. Figure 4-1 shows the DFM system defined groups, as shown in the DFM object selector.
Figure 4-2 DFM System Defined Groups
DFM manages many device components: chassis, cards, fans, interfaces, memory, Multilayer Switch Feature Cards (MSFCs), Multilayer Switch Modules (MSMs), ports, power supplies, processors, Route Switch Feature Cards (RSFCs), Route Switch Modules (RSMs), SNMP agents, temperature sensors, VLANs, and voltage sensors. For a detailed list of specific device families and models that DFM supports, refer to Supported Device Table for Device Fault Manager at http://www.cisco.com/univercd/cc/td/doc/product/rtrmgmt/cw2000/dfm/dev_sup/index.htm.
Note
Ports and Interfaces that DFM Manages
DFM manages device ports and interfaces, as described in the following:
•
–
–
•
When a device is added to DFM, DFM assigns the device interfaces and ports to DFM system defined groups depending on their type. For more information on port and interface groups, see DFM System Defined Groups, page 8-4.
Listing Ports and Interfaces in the DFM Inventory
To find out how many trunk and access ports are currently in the DFM inventory, use the sm_tpmgr command:
# NMSROOT\objects\smarts\bin\sm_tpmgr.exe --server=DFM --sizesLocate the line that is similar to the following:
Number of Ports: 761 [92/92]In this example, 761 represents the number of discovered ports, out of which 92 are managed. Unless you have reconfigured DFM to manage access ports, you can assume these 92 ports are trunk ports.
For interfaces, locate the line that is similar to the following:
Number of Interfaces: 351 [322/280]In this example, 351 represents the number of discovered interfaces, out of which 322 are managed.
To list specific ports and interfaces by their types, names, group membership, or managed state, use the sm_adapter command in conjunction with the getNetworkAdapters.asl script. The syntax is as follows (this command is one line):
# NMSROOT\objects\smarts\bin\sm_adapter.exe --server=DFM [-Dargument] utils\getNetworkAdapters.aslThe arguments to the -D option are described in the following table.
The following examples show how you can use the getNetworkAdapters.asl script.
•
sm_adapter -s DFM utils/getNetworkAdapters.asl•
sm_adapter -s DFM -DNetworkAdapterType=all -DPortType=all -DGroupName="lab-gw.cisco.com" -DManagedState=all utils/getNetworkAdapters.asl•
sm_adapter -s DFM -DGroupName="lab-gw.cisco.com" utils/getNetworkAdapters.asl•
sm_adapter -s DFM -DNetworkAdapterType=Interface -DGroupName="lab-gw.cisco.com" -DManagedState=managed utils/getNetworkAdapters.asl•
sm_adapter -s DFM -DNetworkAdapterType=Interface -DGroupName="lab-gw.cisco.com" -DManagedState=unmanaged utils/getNetworkAdapters.asl•
sm_adapter -s DFM -DNetworkAdapterType=all -DPortType=all -DGroupName="CFG-Interface Groups/1 Gb Ethernet" -DManagedState=unmanaged utils/getNetworkAdapters.asl•
sm_adapter -s DFM -DNetworkAdapterType=all -DPortType=all -DGroupName="CFG-Port Groups - Access Ports/10/100 Mb Ethernet" -DManagedState=managed utils/getNetworkAdapters.asl•
sm_adapter -s DFM -DNetworkAdapterType=all -DPortType=all -DGroupName="CFG-Port Groups - Trunk Ports/10/100 Mb Ethernet" -DManagedState=managed utils/getNetworkAdapters.aslUnderstanding the Device and Credentials Repository
The DCR is a centralized device repository for sharing device information across applications. It provides a single place for managing device credentials and attributes, ensuring consistency across applications. Individual applications can query the DCR for a device list, device attributes, and device credentials. Changes to the DCR are propagated to all applications. Thus, you should use the DCR to add, import, and export devices, and to change device credentials.
Note
Once a device is added to the DCR, you can add it to the DFM inventory (the DFM inventory is separate from the DCR). When a device is added to the DCR, the DCR assigns a DCR ID to every managed component.The DCR maps components to devices using either the device name or IP address. When the DCR device is added to DFM, DFM maps the DCR ID to a device name during discovery (see How DFM Determines Device Names).
DFM also uses the DCR ID to verify if the device or component already exists in the DFM inventory (in which case it is not added but is designated as an alias device). (Further information on how DFM identifies devices—such as whether DFM uses an IP address or DNS name as the device name—is provided in Importing Devices from the DCR.)
You can add devices from the DCR to DFM automatically by activating automatic synchronization (which is the default), or you can add them selectively by deactivating using the Device Selector. When a device is deleted locally (from the DFM inventory), the DCR is not affected. The device is added to the Device Selector list, which shows which devices are in the DCR but not in DFM. (In this way, you can easily add the device back to DFM, if desired.)
If a device is deleted from the DCR (global delete), it is deleted from DFM (and all other applications that use that DCR). (For information on deleting components of aggregate devices, see How DFM Handles Containing and Contained Devices.)
All synchronization between the DCR and the DFM inventory is controlled from the Device Selector page. You can access this page from DFM or the CiscoWorks home page, select Device Management > Device Selector.
•
•
Note
For more information on the DCR, refer to the Common Services online help.
Events That Trigger DCR and DFM Synchronization
The following events will trigger synchronization between the DFM inventory and the DCR:
•
•
–
–
•
See these topics for more information:
•
DCR Masters and Slaves
By default, the DCR mode is standalone (single server), and CiscoWorks supports one DCR per CiscoWorks server. However, you can configure the DCR to use a master/slave model. In this model, the master DCR is the primary repository residing on a CiscoWorks server. Slave DCRs reside on other CiscoWorks servers, and replicate the DCR master. Any change in the master DCR is propagated to slave DCRs. This allows applications on different servers to use a synchronized device inventory. Using the master/slave model is transparent to DFM.
If the DCR used by your instance of DFM is changed from master to slave, or from standalone to slave, the DCR device list is synchronized with the DFM inventory. First, all devices are removed from the DFM inventory (regardless of DCR synchronization mode). If DFM is configured to use manual synchronization, all DCR devices will appear in the Device Selector (as devices not in DFM). For automatic synchronization, all DCR devices are added to the DFM inventory.
For more information on the DCR Master/Slave model, refer to the Common Services online help.
Understanding the Device Summary and Device States
The Device Summary lists the device states for all devices in the DFM inventory. The device summary appears when you select Device Management > Device Summary from DFM or the CiscoWorks home page. Figure 4-3 shows an example of the Device Summary page.
Figure 4-3 Device Summary Page
Table 4-1 describes the information displayed on the Device Summary page.
Table 4-1 Device Summary and Device States
Status
Lists the state the devices are in, from the following possibilities:
Known
The device has been successfully imported, and is fully managed by DFM.
Learning
DFM is discovering the device. This is the beginning state, when the device is first added or is being rediscovered. Some of the data collectors1 may still be gathering device information.
Questioned
DFM cannot manage the device. See Troubleshooting Device Import and Discovery.
Pending
The device is being deleted. (DFM is waiting for confirmation from all of its data collectors before purging the device and its details.)
Unknown
The device is not supported by DFM.
Number of Devices
The number of devices that are in each device state.
1 Data collector is a term used to refer to all back-end applications that are involved in device rediscovery and device data collection.
Importing Devices into DFM
A device must be in the DCR before you can add it to the DFM inventory. DFM supports three methods of device import from the DCR:
•
•
•
Importing Devices from the DCR
Once a device has been added to the DCR, it can be added to the DFM inventory:
•
•
To verify which setting you are using, from the CiscoWorks home page or DFM, select Device Management > Device Selector, and check the synchronization setting.
Note
How DFM Identifies Devices Imported from the DCR
When a device is added to DFM from the DCR, DFM attempts to resolve the DNS name (hostname). DFM does not use the DCR Display Name. Table 4-2 shows how DFM names devices, depending on how the devices are added to the DCR.
Note
For information on how DFM performs polling and discovery, refer to Appendix E, "Polling—SNMP and ICMP."
How DFM Handles Containing and Contained Devices
DFM supports contained and containing devices (also referred to as aggregate devices). These are devices that have a parent/child relationship with another device, such as a Catalyst switch (parent) containing an MSFC (child). The switch is considered the containing device, and the MSFC is the contained device.
Table 4-3 How DFM Handles Containing and Contained Devices
Containing
Added
Added1
Contained
N/A
N/A
Containing
Rediscovered
Rediscovered
Contained
No effect
Rediscovered
Containing
Deleted
Deleted from DFM (but not deleted from DCR)
Contained
No effect
Deleted
Containing
Deleted
Deleted
Contained
No effect
Deleted
Containing
Suspended
Suspended
Contained
No effect
Suspended
Containing
Resumed
Resumed
Contained
No effect
Resumed only if containing device is resumed
1 When a containing device is added to the DCR, the DCR does not recognize the contained devices. However, when the device is added to DFM, the contained devices are discovered by DFM and added to the DFM inventory.
Automatically Importing DCR Devices
DFM uses automatic synchronization by default. Use the following procedure to change manual synchronization to automatic synchronization.
Note
Step 1
Step 2
Step 3
Step 4
Note
For information on the rediscovery schedule, refer to Configuring Rediscovery Schedules, page 7-5.
Manually Importing DCR Devices Using the Device Selector
Use the following procedure to change automatic synchronization to manual synchronization.
Step 1
Step 2
Step 3
Step 4
Step 5
Step 6
Step 7
Note
For information on how to handle duplicate devices, refer to Viewing Alias (Duplicate) Devices.
Determining Which Devices Are in DCR But Not in DFM
To identify devices that are in the DCR but not in DFM, use the Device Selector. The Device Selector lists devices that are not in DFM for these reasons:
•
•
You can start the Device Selector by selecting Device Management > Device Selector from the CiscoWorks home page or DFM.
Figure 4-4 DFM Device Selector
When you click Summary, DFM will display a total of devices in the following categories:
•
•
•
•
For information on moving devices from the DCR into DFM, refer to Manually Importing DCR Devices Using the Device Selector. For information on duplicate devices, refer to Viewing Alias (Duplicate) Devices.
Importing Devices from DFM 1.2.x
You can import a list of DFM 1.2.x devices into DFM, but first you must add those DFM 1.2.x devices to the DCR. These are the steps you must perform:
1.
2.
–
–
Viewing Alias (Duplicate) Devices
The Alias Devices page lists all devices for which DFM has found duplicates. DFM considers a device to be an alias when the device is added to DFM using its IP address, device name, or host name; and the IP address, device name, or host name already exists in the DCR.
Step 1
Step 2
Step 3
Verifying Device Import Using Discovery Status
After adding a device, you can verify that it has been imported by using the Discovery Status page.
Step 1
Figure 4-5 Discovery Status Page
Step 2
Step 3
Note
Step 4
Troubleshooting Device Import and Discovery
Step 1
Figure 4-6 Rediscover/Delete Devices Page
Step 2
Step 3
Step 4
•
•
•
Step 5
a.
•
•
b.
•
•
c.
•
•
Step 6
•
–
–
–
–
–
–
•
Step 7
Exporting Devices
You can export devices to create a backup of your devices list, or to import DFM devices into another CiscoWorks server that accepts DCR-format import files. The export file will contain a list of all managed devices, along with their credentials.
You can export devices using either of the following methods:
•
•
Note
Use the following procedure to create a file containing the DFM 2.0.3 devices. Log information is written to NMSROOT\log\dfmLogs\TIS\DeviceManagement.log.
Step 1
a.
b.
Note
Step 2
•
NMSROOT/bin/dfmexport fn=fileName ft=CSV|XML•
NMSROOT\bin\dfmexport.bat fn=fileName ft=CSV|XMLwhere fn indicates the output filename and ft indicates the format. The export file is saved to the NMSROOT/importfiles directory. You should use a unique name for file name so that previous export files are not overwritten.
Editing Device Configuration and Credentials
After you add devices, you can change their configuration setup using CiscoWorks Common Services. From the CiscoWorks home page, select Device and Credentials > Device Management. From the Device Properties page, you can edit the following credentials:
•
•
•
•
Note
Click the Help button to view more information on the device credentials you can change using Common Services.
Rediscovering and Deleting Devices
Rediscovering and deleting specific devices is controlled by the Rediscover/Delete Devices page. Figure 4-6 shows the Rediscover/Delete Devices page.
Note
The Rediscover/Delete Devices page contains two panes. The left pane displays a device selector, from which you select the device or group that you want to rediscover or delete. The right pane displays the information for the selected object.
The left pane includes a search option. For more information, see Searching for Objects Using the Device Selector, page 2-8.
The devices that appear in the device selector are organized in folders by device state. (For a description of device states, see Understanding the Device Summary and Device States.) The folders appear only if there is a device to go in the folder. Figure 4-7 shows an example of the device selector.
Figure 4-7 Rediscover/Delete Devices Device Selector
Devices are displayed in four possible states: Known, Learning, Pending, and Questioned. DFM creates the following folders:
•
•
•
•
Details about and procedures for rediscovering or deleting devices using this page are provided in these topics:
Rediscovering Devices
Through the Rediscover/Delete Devices page, you can rediscover devices or device groups. When rediscovery takes place, if there are any changes to a device or group configuration, the new settings will overwrite any previous settings.
Rediscovery occurs only for active devices. Suspended devices do not go through rediscovery. If some of the devices you are selecting for rediscovery are suspended devices, DFM displays messages indicating that only the active devices will go through rediscovery.
The following events will also trigger rediscovery:
•
•
•
Note
Step 1
Note
Step 2
Note
Step 3
Rediscovery is started. To view rediscovery status, select Device Management > Discovery Status.
Deleting Devices
The DFM Rediscover/Delete Devices page allows you to delete devices from the DFM inventory (local deletion). It does not affect the DCR (all DCR device management is performed from the Common Services home page).
When a device is deleted from the DCR (which can only be done from the Common Services home page), it is automatically deleted from DFM, regardless of the synchronization setting. If you want to delete an alias device, use Common Services > Device and Credentials > Device Management.
When you delete a device from the DFM inventory and DFM is configured to use manual synchronization, the deleted device will appear in the Device Selector (in the Devices Not in Device Fault Manager field). A deleted device will not be readded when DFM inventory collection is performed.
Local deletions are disabled when DFM is configured to use automatic synchronization.
While a device is being deleted, DFM will not allow any rediscovery, suspend, or resume operations to be performed on the device. When you delete a containing device, all of the contained devices are deleted.
Note
•
•
Note
Note
Step 1
Note
Step 2
Note
Step 3
Step 4
Viewing Device Details
On the Device Details page, you select the devices for which you want to see device details. The Device Details display opens and displays the information for the devices. You can also start a Detailed Device View (DDV) from this page, which is useful when you want to view details about a device that has no current alerts.
The Device Details display provides basic information about the device such as name, IP address, when it was added, and so on. (For a description of the Device Details display, see Understanding the Device Details Display.)
Devices are organized in folders according to their device state. (For a description of device states, see Understanding the Device Summary and Device States.)
Step 1
Step 2
Step 3
Note
Step 4
Step 5
Understanding the Device Details Display
The Device Details display shows details for the devices that you select. See Viewing Device Details for information on selecting devices.
Figure 4-8 shows an example of the Device Details display.
Figure 4-8 Device Details Display
Table 4-4 describes the information displayed in the Device Details display.
Modifying SNMP Timeout and Retries
If an SNMP query does not respond in time, DFM will time out. It will then retry contacting the device for as many times as displayed when you select Device Management > SNMP Config.
The timeout period is doubled for every subsequent retry. For example, if the timeout value is 4 seconds and the retries value is 3, DFM waits for 4 seconds before the first retry, 8 seconds before the second retry, and 16 seconds before the third retry.
The SNMP timeout and retries are global settings.
The default values are:
•
•
Figure 4-9 shows an example of the SNMP Configuration page.
Note
Figure 4-9 SNMP Configuration Page
Note
Step 1
Note
Step 2
Step 3
Step 4
Step 5
