Table Of Contents
Getting Started with DFM
Working with DFM Windows
Using Help
Understanding the Dates and Times Displayed
Using Tabular Displays
Paging and Sorting Tabular Displays
Viewing Data from Tabular Displays with Over 2000 Records
Exporting Data from Tabular Displays
Printing Tabular Displays
Selecting Objects and Groups
Selecting Objects Organized by Group Management
Selecting Objects Organized by Discovery Status
Searching for Objects Using the Device Selector
Understanding Your User Role
Responding to Security Alerts
Responding to Messages About Device Limits
Getting Started with DFM
These topics help you to work with and understand the Device Fault Manager (DFM) user interface:
•
Working with DFM Windows
•
Using Tabular Displays
•
Selecting Objects and Groups
•
Understanding Your User Role
•
Responding to Security Alerts
•
Responding to Messages About Device Limits
Working with DFM Windows
This topic focuses on questions you may have when you first start to work with the DFM user interface:
•
What is the purpose of the CiscoWorks Home Page?
•
What is the purpose of the DFM Home Page?
•
Why are multiple windows open?
•
Why do I see the error "The page cannot be displayed"?
•
When I press the Enter key, why doesn't DFM complete the current task?
•
Where is the help button?
What is the purpose of the CiscoWorks Home Page?
The CiscoWorks home page is a portal that provides access to local and remote CiscoWorks applications. You can add or remove applications from the home page, as desired. The applications launched from the CiscoWorks home page normally have a common look and feel for ease of use.
What is the purpose of the DFM Home Page?
The DFM home page opens when you click the Device Fault Manager link or the HomePage link on the CiscoWorks home page. The DFM home page is an easy way to access frequently used operations. The following links are available.
Device Management
|
Notification Services
|
Faults
|
Configuration
|
Add Device
Device Rediscovery
Device Summary
Device Selector
Device Details
Discovery Status
Rediscovery Schedule
|
Notification Service
|
Alerts
Fault History
Fault History Alert Search
Fault History Event Search
|
Polling and Threshold
DFM Group administration
Trap Forwarding
Data Purge
|
The tabs on the DFM home page are the portals for all DFM-related tasks: starting an Alerts and Activities display, running Fault History reports, managing devices in the DFM inventory, configuring notifications, and performing system configuration on DFM. See Figure 2-1.
Figure 2-1 DFM Home Page
Why are multiple windows open?
For ease of use, DFM opens separate windows for each application, and sometimes for functions within applications. Opening multiple browser windows allows you to:
•
Refer to information from one display to complete a task in another window
•
Rapidly compare information on different displays.
When DFM opens a new browser window, it does not close previously opened windows. You can close browser windows when you are done with them.
Note
If you close the CiscoWorks window while displaying Alerts and Activities in the Device Fault Manager browser windows, links in those windows will continue to function. In contrast, if you log out of CiscoWorks, links from those windows will return errors and you will need to log in to CiscoWorks again.
Why do I see the error "The page cannot be displayed"?
DFM displays often include links to more detailed information. Right-clicking a link and selecting Open in New Window is not supported. It is expected behavior for this error to appear.
When I press the Enter key, why doesn't DFM complete the current task?
DFM does not accept pressing the Enter key as a substitute for clicking buttons, such as OK, Finish, or Next, on the application page.
Where is the help button?
You can access help by clicking the Help link at the top right of any home page—the CiscoWorks home page, the DFM home page, or any other application's home page. See Using Help.
Using Help
To start DFM help:
1.
Launch any DFM display from the CiscoWorks home page. See What is the purpose of the DFM Home Page?.
2.
Click the Help link near the top right of the page (the Alerts and Activities display provides a Help button).
Note
If you have selected an option in any home page, the context-sensitive help for that option is displayed.
Help is displayed in a separate browser window that remains open until you close it. Online help includes an index and search capability. You can access CiscoWorks help by clicking Main at the top right of the help page.
Understanding the Dates and Times Displayed
Dates and times displayed by DFM reflect the date, time, and time zone set on the server where DFM is installed. If the client system you use to run DFM is located in a time zone other than the time zone set on the server, you will notice the difference; for example:
•
Status "as of" the current date and time will not display your local time and time zone and may not match your local date.
•
Dates and times shown for previous events are recorded (and displayed) with the server time stamp, which is offset from your local time.
There are no settings that you can change on the client to affect the time zone displayed by DFM. However, you can obtain information about the time zone acronyms and offsets used by DFM in Release Notes for CiscoWorks Common Services 3.0.6. To see the release notes, log in to Cisco.com and go to the Common Services documentation at http://www.cisco.com/univercd/cc/td/doc/product/rtrmgmt/cw2000/index.htm.
Using Tabular Displays
DFM presents information in tabular displays when the amount of data to be displayed or manipulated could be quite large. Tabular displays ease the task of handling information by providing the following features:
•
Sorting—You can sort a tabular display in the order you prefer by clicking any clickable column heading.
•
Direct page access—You can browse a tabular display screen by screen or jump to any screen number in the range by entering a screen number.
Note
A tabular display can show up to 2,000 records. If more than 2,000 records exist and you need to access the additional records, you can export all records using the data export icon.
•
Data export—You can export data from a tabular display to a comma separated values (CSV) file, a Portable Document Format (PDF) file, or both, depending upon the tabular display that you are using. See the icon in Table 2-1.
•
Printer friendly—You can format the tabular display for a printer and print the result from the browser. Like the tabular display, the print-friendly browser display includes a maximum of 2,000 records. See the icon in Table 2-1.
Table 2-1 Tabular Displays—Export and Print-Friendly Icons
Icon
|
Action
|
|
Exports all data to either a CSV file or a PDF file.
|
|
Reformats the displayed records into print-friendly format, and displays them in a new browser window.
|
Paging and Sorting Tabular Displays
The sort order for any tabular display is indicated by the presence of a triangle in the column heading. A triangle pointing down indicates records in descending order, which is the default, while a triangle pointing up indicates records in ascending order.
Step 1
To sort a tabular display, click any blue column heading label.
The first time you click a column heading on a previously unsorted column, data in that column is sorted in descending order. If you click the column heading again, the records will be sorted in the reverse order.
Note
When you sort a tabular display, if there are more than 2,000 records available, all records are sorted, not just those that are displayed. The first 2,000 records are displayed after sorting.
Viewing Data from Tabular Displays with Over 2000 Records
If more than 2,000 records exist, they cannot all be shown in a tabular display. A message will be displayed to notify you when this is the case. If you want to see data for all of the records, you must export the data to a CSV or PDF file. See Exporting Data from Tabular Displays.
You may be able to change which of the more than 2,000 records are displayed by sorting the tabular display. See Paging and Sorting Tabular Displays.
Exporting Data from Tabular Displays
All tabular displays can be exported as comma separated values (CSV) files. Some tabular displays can also be exported as PDF files.
Note
To open a PDF file, you must have Adobe Acrobat Reader 4.0 or higher installed on your client system. However, you can save a file as a PDF file even if you do not have Acrobat Reader on your system.
Step 1
Click the data export icon located on the top-right side of the tabular display. See the icon in Table 2-1.
Step 2
If the dialog box Export to appears, select one of the following and click OK:
•
CSV
•
PDF
Note
Some tabular displays may only support CSV exports.
Step 3
Save the export file in one of the following ways:
•
If you selected PDF and have Adobe Acrobat Reader installed on your client system, the PDF file opens. To save the PDF file, select File > Save as from the browser and follow the online instructions to save the file.
•
If you selected PDF and do not have Adobe Acrobat Reader installed, or if you selected CSV, follow the online instructions to save the file.
Printing Tabular Displays
Step 1
Click the print-friendly icon located on the top-right side of the tabular display. See the icon in Table 2-1.
A new browser window opens, displaying the data in print-friendly format.
Step 2
Print the tabular display from the new browser window.
Selecting Objects and Groups
As you use DFM, you will often need to select something—a device or a device group, for example—before you can view information or complete a task. Groups and devices displayed in a selector differ depending upon the application, as described in the following topics:
•
Selecting Objects Organized by Group Management
•
Selecting Objects Organized by Discovery Status
When you launch the Device Selector from some locations, you have the option to search for groups and devices in the hierarchy. See Searching for Objects Using the Device Selector for more information.
Selecting Objects Organized by Group Management
This topic shows a few examples of selectors to familiarize you with them. Use the application-specific topics to determine what to select to accomplish your objective.
Figure 2-2 shows group selectors as they might first appear when you select Configuration > Other Configurations > Group Administration.
Figure 2-2 Device Selector as Displayed Initially on Group Management Page
Group
|
Description
|
CS@MARVER_DAILY
|
Groups that are controlled by Common Services.
|
DFM@MARVER-DAILY
|
Groups that are controlled by DFM.
|
Figure 2-3 shows a group selector as it might appear when you expand the Common Services and DFM folders. Devices are listed according to their group membership.
Figure 2-3 Expanded Common Services and DFM Groups on Group Management Page
Group
|
Description
|
Common Services System Defined Groups
|
Groups that Common Services predefines and controls.
|
Common Services User Defined Groups
|
Groups provided by Common Services to help you organize devices into groups that you define, based on characteristics you choose; for example, device location. These are controlled by selecting Common Services > Groups > Group Admin.
|
DFM System Defined Groups
|
Groups that are predefined and controlled by DFM.
|
DFM User Defined Groups
|
Groups provided by DFM to help you organize ports, interfaces, and devices into groups that you define, based on characteristics you choose; for example, Backup interfaces in a certain device group. These groups are used by Polling and Thresholds and other DFM functions.
|
These groups are further described in Managing Groups, page 8-1.
Figure 2-4 also shows a device group selector as it might appear when you expand the DFM System Defined Groups and User Defined Groups folders.
Figure 2-4 Expanded DFM Groups and Device Selector on Group Management Page
Group
|
Description
|
System Defined Access Port Groups
|
Predefined access port groups used by DFM.
|
System Defined Interface Port Groups
|
Predefined interface port groups used by DFM.
|
System Defined Trunk Port Groups
|
Predefined trunk port groups used by DFM.
|
User Defined Customizable Access Port Groups
|
Groups the user can customize to track access ports.
|
User Defined Customizable Groups
|
Groups the user can customize to track devices.
|
User Defined Customizable Interface Groups
|
Groups the user can customize to track interfaces.
|
User Defined Customizable Trunk Port Groups
|
Groups the user can customize to track trunk ports.
|
Selecting Objects Organized by Discovery Status
Figure 2-5 shows a Device Selector as you might see it on the Device Management > Device Details page. In this example devices are grouped according to their discovery status (or device state). These groups only appear in your Device Selector when they have members in that discovery state.
Figure 2-5 Device Selector with Devices Organized by Discovery State
Group
|
Description
|
All Known Devices
|
A container for all devices that were successfully imported and are being managed by DFM.
|
All Learning Devices
|
A container for all devices DFM is in the process of discovering.
|
All Pending Devices
|
A container for all devices that are in the process of being deleted from DFM.
|
All Questioned Devices
|
A container for all devices that DFM cannot manage.
|
Device states are described in Understanding the Device Summary and Device States, page 4-7.
Searching for Objects Using the Device Selector
With many devices in DFM, it can sometimes be difficult to locate the devices you are interested in. To assist you in locating devices, DFM provides a search option in the Device Selector when it is launched from some locations.
Note
For a detailed description of the Device Selector features, see the CiscoWorks Common Services 3.0.5 User Guide.
Figure 2-3 shows a Device Selector as it will appear when you launch it from the following locations:
•
Device Management > Rediscover/Delete
•
Device Management > Device Details
•
Notification Services > Notification Groups > Add
•
Fault History > Alert Filtering > Search by Group
•
Fault History > Event Filtering > Search by Group
Figure 2-6 Device Selector with Search Option
The Device Selector pane lists all DFM devices in a group. The devices are listed in the appropriate groups based on Device type groups and User-defined group rules.
Enter the search criteria in the Search Input field. The search criteria can be:
•
IP Address—Enter the Device IP Address.
•
DNS Name—Enter search criteria to match the DNS name.
You can enter multiple criteria separated with a comma. You can also enter a wildcard character (*) or a question mark (?) to select multiple devices.
You have three options:
•
All—Choose this tab to include all the devices. Click the Search Results tab to display the list of devices. From here you can select some or all of the devices to proceed. Then click the Selection tab to display the chosen devices and continue with the original task.
•
Simple search—Enter text in the <Search Input> text box. You can enter the wild card (*) in the search input, for example 10.77.*.* or *.cisco1.com. Click the search arrow or press Enter. Click the Search Results tab to display the list of devices. From here you have the option to select some or all of the devices to proceed. Then click the Selection tab to display the chosen devices and continue with the original task.
•
Advanced search—Click the advanced search tool. A dialog box that includes the advanced search options opens. See Figure 2-7. Choose the attributes you want to include and click Add Rule Expression. The rule is displayed in the Rule Text pane. You can add other attributes using the OR, AND, and EXCLUDE expressions. For more information about rules, see Understanding Rules, page 8-13. This will create a rule which you can check, if required, by clicking Check Syntax. When the search criteria are specified, click Search. The results are displayed; click the Search Results tab. From here you can select some or all of the devices to proceed. Then click the Selection tab to display the chosen devices and continue with the original task.
Note
You can create an accumulated list by combining results from different searches. When devices have been chosen and placed in the Selection pane, continue your search and selection, then place these in the Selection pane.
Figure 2-7 Device Selector Advanced Search Option
Understanding Your User Role
When you log in to DFM, you enter the username and password assigned to you by a system administrator. Your username is associated with either a CiscoWorks role or a Cisco Secure Access Control Server (ACS) role. By default, CiscoWorks and ACS roles are the same, but an ACS administrator can modify the ACS roles. User roles control the functions that you are allowed to see and use from the DFM home page. If you cannot locate a function in the DFM home page, the task is not permitted for the user role. For more information, do the following:
•
View the CiscoWorks Permission Report to determine which tasks are permitted for each user role. From the Common Services home page, select Server > Reports > Permission Report and click Generate Report.
•
View the ACS report by logging onto the ACS server and select Shared Profile Components. Refer to the ACS online help for more information.
For more information, refer to these topics:
•
Configuring Users (ACS and Non-ACS), page 11-5
•
Using DFM in ACS Mode, page 11-6
Responding to Security Alerts
The first time you select nearly any DFM function, you will see a Security Alert window displayed. You should install the self-signed security certificate. You should do this once, on each client system you use to access DFM.
Note
If you see a Security Alert Window with a message that the certificate has expired, you should contact a user with System Administrator privileges to create a self-signed security certificate, and then install it.
Note
If you do not install the self-signed security certificate, you may not be able to access some DFM application pages.
Step 1
Click the View Certificates button on the Security Alert window. The Certificate window is displayed.
Step 2
Install the certificate as follows:
a.
Click the Install Certificate button. The Certificate Import Wizard window is displayed.
b.
Follow the instructions provided by the Certificate Import wizard.
Responding to Messages About Device Limits
If you exceed your server's device limit, DFM will continue to work, but it will not allow you to import any more devices. What happens next depends on whether you use automatic synchronization between the Device and Credentials Repository (DCR) and the DFM inventory, or you add DCR devices to the DFM inventory on a device-by-device basis:
•
Manual synchronization with DCR—When you use the Device Selector page to move devices from the DCR into DFM, DFM will display a popup message warning you that you cannot import any more devices (see Understanding the Device and Credentials Repository, page 4-5).
•
Automatic synchronization with DCR—You will notice that devices are not appearing on DFM pages. You can check the license log for more information (see Viewing and Maintaining Log Files, page 11-12).
For information about device-based licensing, see Installation Guide for Device Fault Manager.