User Guide for CiscoWorks LMS Portal 1.0.1 (With LMS 3.0 December 2007 Update)
Chapter 12 Configuring Portlets

Table Of Contents

Configuring Portlets

Configuring Refresh Time

Audit Trail Information

Change Audit

DFM Device Status

High Severity Alerts

IFrame

IPM Lowest Availability

IPM Highest Jitter

IPM Highest Latency

Job Information Status

N-Hop View

RME Job Approval

RME Software Summary

RME Device Status

Syslog Collectors Information

RSS

Syslog Alerts


Configuring Portlets


This chapter explains how to configure the portlets using the Configuration icon in CiscoWorks LMS Portal. You can configure the Refresh time for each portlet. In addition to the refresh time, you can also configure details such as the Refresh time, alerts, collector number, exception period for a report for some of the portlets.

Table 12-1 lists the portlets for which you can only configure the Refresh time.

Table 12-2 lists the portlets for which you can configure both the Refresh time and other details.

The following portlets appear only when the corresponding applications are installed.

Table 12-1 Configuring Refresh Time

Portlets
Application

Critical Message Window

Common Services

DCA and AAA Information

Common Services

Device Discovery Summary

Common Services

Log Space Usage

Common Services

Process Status

Common Services

Products Installed

Common Services

Servers and Application

Common Services

System Backup Status

Common Services

User Login Information

Common Services

Job Approval

Resource Manager Essentials

RME Collection Status

Resource Manager Essentials

Syslog Alerts

Resource Manager Essentials

RME Hardware Summary

Resource Manager Essentials

CM Data Collection Summary

Campus Manager

Discrepancies

Campus Manager

Best Practices Deviation

Campus Manager

High Severity Alerts

Device Fault Manager

IPM Device Status

Internetwork Performance Monitor

IPM Device Categorization

Internetwork Performance Monitor


Configuring Refresh Time

You can configure Refresh time both automatically and manually.

To configure Refresh time:


Step 1 Click the Configuration icon.

a. Select the Auto Refresh check box to refresh the portlet automatically.

b. Select the minute and hour from the Refresh Every drop-down list to manually set the Refresh time. The items in the portlet get refreshed at the set refresh time.

Step 2 Click Save to save all the settings.

The portlet with the configuration settings appear.

Step 3 Click the Back arrow icon to view the previous screen.


Note You can also click the refresh icon displayed at the top right corner of the Portal home page to view the latest data in the portlet.



The following portlets appear only when the corresponding applications are installed.

Table 12-2 lists portlets in which refresh time and other parameters can be configured.

Table 12-2 Configuring Refresh Time and Other Parameters

Portlets
Application

Audit Trail Information

Resource Manager Essentials

Change Audit

Resource Manager Essentials

DFM Device Status

Device Fault Manager

High Severity Alerts

Device Fault Manager

IFrame

N/A

IPM Lowest Availability

Internetwork Performance Monitor

IPM Highest Jitter

Internetwork Performance Monitor

IPM Highest Latency

Internetwork Performance Monitor

Job Information Status

Common Services

N-Hop View

Campus Manager

RME Job Approval

Resource Manager Essentials

RME Software Summary

Resource Manager Essentials

RME Device Status

Resource Manager Essentials

Syslog Collectors Information

Resource Manager Essentials

RSS

N/A

Syslog Alerts

Resource Manager Essentials


Audit Trail Information

In Audit Trail Information portlet, you can view the Audit Trail details such as the user name, application name, creation time, and description about the changes done to the application by the user.

You can configure the Audit Trail Information portlet to set the number of collectors displayed in the portlet and refresh time both manually and automatically.

To configure Audit Trail Information portlet.


Step 1 Go to CiscoWorks LMS Portal and click RME.

The RME View portlets appear.

Step 2 Move the mouse over the title bar of the Audit Trail Information portlet to view the icons.

Step 3 Click the Configuration icon. You can:

Select the Auto Refresh check box to refresh the portlet automatically.

Or

Select the minute and hour from the Refresh Every drop-down list to manually set the Refresh time. The items in the portlet get refreshed at the set refresh time.

Select the number from the No.of Collectors to be Displayed drop down list. This indicates the number of collectors that will appear in the portlet.

For example, if you select 5, the details of five collectors and the changes made by the Network Administrator appear in the portlet.

Step 4 Click Save to save all the settings.

The Audit Trail Information portlet with configured settings appear.

Or

Click the Back arrow icon to return to the portlet.


Change Audit

In Change Audit portlet you can view the changes in the configuration information for all devices after every Inventory or Configuration Collection.

You can configure the Change Audit portlet to set only the exception period report to be displayed in the portlet and refresh time both manually and automatically.

To configure Change Audit portlet:


Step 1 Go to CiscoWorks LMS Portal and click RME.

The RME View portlets appear.

Step 2 Move the mouse over the title bar of the Change Audit portlet to view the icons.

Step 3 Click the Configuration icon. You can:

Select the Auto Refresh check box to refresh the portlet automatically.

Or

Select the minute and hour from the Refresh Every drop-down list to manually set the Refresh time. The items in the portlet get refreshed at the time that you set

Select the Only Exception Period Report checkbox to view any of the special or extraordinary period report.

Step 4 Click Save to save all the settings.

The Change Audit portlet with configured settings appear.

Or

Click the Back arrow icon to return to the portlet.


DFM Device Status

In DFM Device Status portlet you can view the status and the number of all the devices in the DFM inventory.

You can configure Refresh time both automatically and manually.

To configure DFM Device Status:


Step 1 Click the Configuration icon.

a. Select the Auto Refresh check box to refresh the portlet automatically.

b. Select the minute and hour from the Refresh Every drop-down list to manually set the Refresh time. The items in the portlet get refreshed at the set refresh time.

c. Select the Show zero counts check box to view the zero count of the device statuses.

Step 2 Click Save to save all the settings.

The portlet with the configuration settings appear.


High Severity Alerts

In High Severity Alerts portlet, you can view the severity alerts in devices such as the alert ID, device type, the alert duration, the last changes occurred in the alert and the device name.

You can configure the High Severity portlet to set the number of number of alerts displayed in the portlet and refresh time both manually and automatically.

To configure High Severity Alerts:


Step 1 Go to CiscoWorks LMS Portal and click DFM.

The DFM View portlets appear.

Step 2 Move the mouse over the title bar of the High Severity portlet to view the icons.

Step 3 Click the Configuration icon. You can:

Select the Auto Refresh check box to refresh the portlet automatically.

Or

Select the minute and hour from the Refresh Every drop-down list to manually set the Refresh time. The items in the portlet get refreshed at the set refresh time.

Select the number of alerts to be displayed in the portlet from the No.of Alerts to be displayed drop-down list.

For example, if you select 3 alerts, the details of any three alerts are displayed in the portlet.

Step 4 Click Save to save all the settings.

The High Severity portlet with configured settings appear.

Or

Click the Back arrow icon to return to the portlet.


IFrame

Intra Frame (IFrame) portlet enables you to open new and multiple pages inside the same browser window. You can also change the content, title and the size of the IFrame portlet.

If you browse or check your mail regularly, you can have a portlet exclusively for this purpose. To do this you need to configure the URLs or websites within the IFrame portlet. You can also change the title, customize the URL, and the width and height of the portlet.

To change the look and feel and configure IFrame portlet:


Step 1 Go to CiscoWorks LMS Portal and click the Add Portlet icon.

A popup window appears.

Step 2 Click Miscellaneous.

The IFrame portlet name appears along with other portlets.

Step 3 Click Add next to the IFrame portlet name.

The IFrame portlet is displayed in the view.

Step 4 Click Close to close the popup window.

The IFrame portlet appears.

Step 5 Move the mouse over the portlet to view the icons.

Step 6 Click the Look and Feel icon.

The Look and Feel tab is displalyed.

Step 7 Click the Look and Feel tab and:

a. Enter the name of the portlet in the Title field.

b. Click Save to save the new name or Reset to clear all the details.

c. Go to the Portlet Background area and click the color swatch to select the color.

The selected color swatch is applied as the background color for the portlet.

d. To change the look and feel of the Header Text you can:

Click the color selector icon next to the Color field to select a color swatch. The selected color swatch is applied as the background color to the header text.

Select the decoration type from the Decoration drop-down list to apply to the header text.

Select the font type from the Font drop-down list to apply to the header text.

Select the size from the Size drop-down list to apply to the header text.

Select the style check box to apply the header text.

Step 8 Click Save to save all the settings or Reset to clear all the details.

Step 9 Click the Back arrow icon to view the configured changes in the portlet.


Viewing Changes in the IFrame Portelt

You can also view the changes in the IFrame portlet that is displayed in the screen.

To configure the IFrame portlet do the following:


Step 1 Go to the IFrame portlet and click the configuration icon

The Setup tab is displayed and do the following:

a. Enter the URL in the Source URL field.

For instance, you can enter the name of a website or any other URL to be displayed in the IFrame portlet as shown in the Figure 12-1.

For instance, you can enter the name of a website or any other URL to be displayed in the IFrame

Some websites do not work well with IFrames. If you add these web sites to IFrames they will take over the full browser window. This will hide the portal functions and make CiscoWorks inaccessible.

Figure 12-1 IFrame Portlet


Note Cisco is not liable for the validity and support of any content or URL that is displayed inside the URL field. Some websites do not work well with IFrames. If you add these web sites to IFrames they will take over the full browser window. This will hide the portal functions and make CiscoWorks inaccessible.


b. Select the Authenticate check box to authenticate.

c. Select the authentication type from the Authentication Type drop-down list.

Form is the login form to enter your login credentials.

Basic is a pop-up or dialog box used to enter your login credential

d. Select the form method from the Form Method drop-down list.

Get passes the variables in the URL.

Post puts the variables in session and is a more secure way to submit passwords.

e. Enter the user name in the User Name field.

f. Enter the password in the Password field.

g. Enter the hidden variables in the Hidden Variable field.

If you would like to view a URL and that page requires some variables to be initialized, you can set these variables using the Hidden Variables option. You can enter the hidden variables you want to pass from one form to another without re-typing the information.

h. Enter the HTML attributes in the HTML Attributes field.

The HTML attributes enable you to increase or decrease the frame border, height, space and width of a portlet. For instance, the normal height of a portlet is 300. If you want to increase the height you can enter the variables accordingly.

i. Click Save to save all the settings.

Step 2 Click Save to save all of the settings.


If you encounter any problem after entering and saving the URL in the IFrame portlet follow this Recovery procedure:


Step 1 Click the URL http://servername:portno/cwportal/c/portal/RemoveIFrame.

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

For instance, if you are in Private Portal, select Private.

Step 3 Select the View from the Select View drop-down list.

For instance, if you are in CS View select CS.

Step 4 Click the Remove All IFrame portlet to delete the IFrame portlets.

The IFrame portlet gets deleted. Now you create IFrame portlets in a new View.

For more information on adding a new View, see Adding a View.


IPM Lowest Availability

In IPM Lowest Availability portlet allows you to check the reachability of the target device from the source router using the latency information. You can view the details such as the collectors name, operational name and the availability in this portlet.

You can configure the IPM Lowest Availability portlet to set the number of collectors displayed in the portlet and refresh time both automatically and manually.

To configure IPM Lowest Availability portlet:


Step 1 Go to CiscoWorks LMS Portal and click IPM.

The IPM View portlets appear.

Step 2 Move the mouse over the title bar of the IPM Lowest Availability portlet to view the icons.

Step 3 Click the Configuration icon. You can:

Select the Auto Refresh check box to refresh the portlet automatically.

Or

Select the minute and hour from the Refresh Every drop-down list to manually set the refresh time. The items in the portlet get refreshed at the Refresh time that you set.

Select the number of collectors to be displayed from the No.of collectors to be displayed drop-down list.

For example, if you select 2, the details of two collectors are displayed in the portlet.

Step 4 Click Save to save all of the settings.

The IPM Lowest Availability portlet with the configured settings appear.

Click the Back arrow icon to return to the portlet.


IPM Highest Jitter

In IPM Highest Jitter portlet you can view the inter-packet delay between any two consecutive data packets sent from the source to target to target router and back. You can view the details such as collector name, operation name, source destination jitter, and destination source jitter.

You can configure the IPM Highest Jitter portlet to set the number of collectors displayed in the portlet and refresh time both manually and automatically.

To configure IPM Highest Jitter portlet:


Step 1 Go to CiscoWorks LMS Portal and click IPM.

Step 2 The IPM View portlets appear.

Step 3 Move the mouse over the title bar of the IPM Highest Jitter portlet to view the icons.

Step 4 Click the Configuration icon. You can:

Select the Auto Refresh check box to refresh the portlet automatically.

Or

Select the minute and hour from the Refresh Every drop-down list to manually set the refresh time. The items in the portlet get refreshed at the set refresh time.

Select the number of collectors to be displayed from the No.of collectors to be displayed drop-down list.

For example, if you select 7, the details of seven collectors are displayed in the portlet.

Step 5 Click Save to save all the settings.

The IPM Highest Jitter portlet with configured settings appear.

Or

Click the Back arrow to return to the portlet.


IPM Highest Latency

In Highest Latency portlet you can view the time taken for an IP packet to travel from source to target and back. You can view the details such as collectors name, operation name and the latency details.

You can configure the Highest Latency portlet to set the number of collectors and refresh time both manually and automatically.

To configure Highest Latency portlet:


Step 1 Go to CiscoWorks LMS Portal and click IPM.

The IPM View portlets appear.

Step 2 Move the mouse over the title bar of the Highest Latency portlet to view the icons.

Step 3 Click the Configuration icon. You can:

Select the Auto Refresh check box to refresh the portlet automatically.

Or

Select the minute and hour from the Refresh Every drop-down list to manually set the refresh time. The items in the portlet get refreshed at the set refresh time.

Select the number of collectors to be displayed from the No.of collectors to be displayed drop-down list.

For example, if you select 5, the details of five collectors are displayed in the portlet.

Step 4 Click Save to save all the settings.

The IPM Highest Latency portlet with configured settings appear.

Or

Click the Back arrow icon to return to the portlet.


Job Information Status

In Job Information portlet you can view up to20 report job details such as job ID, job type, status, job description, and time schedule of the job.

You can configure the Job Information Status portlet to:

Set the number of jobs to be displayed in the portlet

Set the refresh time both manually and automatically.

To configure Job Information Status portlet:


Step 1 Go to CiscoWorks LMS Portal and click CS .

The CS view portlets appear.

Step 2 Move the mouse over the title bar of the Job Information Status portlet to view the icons.

Step 3 Click the Configuration icon. You can:

Select Show only my jobs checkbox to display only your jobs in the Job Information Status portlet.

By default, the portlet displays all the jobs in the Job Information Status portlet.

Select Ascending to display the jobs in the ascending order based on the time schedule.

Select Descending to display the jobs in the descending order based on the time schedule.

Select the jobs from the Show Last Jobs drop-down list to display the last jobs in the portlet.

For example, if you select three jobs, the last three jobs based on the time scheduled will be displayed in the portlet.

Select the jobs from the Show Next Jobs drop-down list to display the next jobs in the portlet.

For example, if you select four jobs, the next four jobs based on the time scheduled will be displayed in the portlet.


Note Show Last Jobs and Show Next Jobs are two groups and the sorting (Ascending and Descending) is done within the group based on the time schedule. If two or more jobs have the same time schedule, the sorting is done based on their Job ID.


Select Auto Refresh check box to refresh the portlet automatically.

Select the hour and minute from the Refresh Every drop-down list to manually set the refresh time. The items in the portlet get refreshed at the set refresh time.

Step 4 Click Save to save all of the settings.

The Job Information portlet with configured settings appear.

Or

Click the Back arrow icon to return to the portlet.


N-Hop View

N-Hop View portlet is a HTML-based light weight topology and is available as a part of CiscoWorks LMS Portal. This is much faster than the regular Campus Manger Topology services.

To configure N-Hop View portlet:


Step 1 Go to CiscoWorks LMS Portal and click the Add Portlet icon at the top right corner of the page.

A popup window appears.

To expand and collapse the sections, click the arrow next to the section title. Each section in this window contains a list of portlets.

Step 2 Click CiscoWorks and select CM.

A list of CM portlets appear.

Step 3 Click Add against the N-Hop View portlet.

The configuration screen is displayed.

Step 4 Move the mouse over the title bar of the N-Hop portlet to view the icons.

Step 5 Click the Configuration icon:

The configuration screen is displayed.

Step 6 Enter the IP address or the Device name of the root device in the Root Device field.

If the device you specify is not managed by Campus Manager, an error message such as The root device you specified is not managed by Campus Manager appears.

Step 7 Enter the number of hops in the Hop count field.

The Network Topology map is drawn for the specified number of hops.

Step 8 Add the device to the critical device poller by checking the Poll Devices check-box.

Campus Manager polls the network periodically. If you need to monitor the status of a certain device more frequently, add it to the critical device poller.

This device is removed from the critical poller list when you close the N-Hop View portlet window.

Step 9 Select the time interval from the Refresh Every drop-down list. The interval can be either in minutes or hours.

The interval can be either in minutes or hours.By default, the portlet refreshes the topology map every 5 minutes. If you set the time interval, it refreshes accordingly. For every refresh, the data is fetched from the last polling cycle of the critical device poller.

Step 10 Click Save to save all the settings.

The N Hop View with configured settings appear.

Or

Click the Back arrow icon to return to the portlet.


RME Job Approval

In RME Job Approval portlet, you can view the list of Job details.

You can configure the RME Job Approval portlet to set the number of records to be displayed in the portlet and refresh time both manually and automatically.

To configure RME Job Approval portlet:


Step 1 Go to CiscoWorks LMS Portal and click RME.

The RME View portlets appear.

Step 2 Move the mouse over the title bar of the RME Job Approval portlet to view the icons.

Step 3 Click the Configuration icon. You can:

Select the Auto Refresh check box to refresh the portlet automatically.

Or

Select the minute and hour from the Refresh Every drop-down list to manually set the refresh time. The items in the portlet get refreshed at the set refresh time.

Step 4 Select the number of records to be displayed in the portlet from the Show Last Records drop-down list.

Step 5 Click Save to save all the settings.

The RME Job Approval portlet with configured settings appear.

Or

Click the Back arrow icon to return to the portlet.


RME Software Summary

In the RME Software Summary portlet, you can view the software version information and count for selected devices such as Cisco Interfaces and Modules, Switches and Hubs, Universal Gateways and Access Servers, and Routers.

To configure the RME Software Summary portlet:


Step 1 Go to CiscoWorks LMS Portal and click RME.

The RME View portlets appear.

Step 2 Move the mouse over the title bar of the RME Software Summary portlet to view the icons.

Step 3 Click the Configuration icon. You can:

Select the Auto Refresh check box to refresh the portlet automatically.

Or

Select the minute and hour from the Refresh Every drop-down list to manually set the refresh time. The items in the portlet get refreshed at the set refresh time.

Step 4 Select the number of rows to be displayed in the portlet from the No.of rows to be displayed drop-down list.

Step 5 Click Save to save all the settings.

The RME Job Approval portlet with configured settings appear.

Or

Click the Back arrow icon to return to the portlet.


RME Device Status

In RME Device Status portlet, you can view the number of devices along with its configurations and inventory collection status (Normal, Pending, Alias, Pre-deployed, Suspended, or Conflicting).

You can configure Refresh time both automatically and manually.

To configure RME Device Status:


Step 1 Click the Configuration icon.

a. Select the Auto Refresh check box to refresh the portlet automatically.

b. Select the minute and hour from the Refresh Every drop-down list to manually set the Refresh time. The items in the portlet get refreshed at the set refresh time.

c. Select the Show zero counts check box to view the zero counts of the various device statuses.

d. Click Save to save all the settings.

The portlet with the configuration settings appear.


Syslog Collectors Information

Syslog Collectors Information portlet displays the list of remote Syslog collectors subscribed to the RME servers.

It contains the syslog collector informations such as the name of the remote syslog, analyser name, status and the number of packets received and so on.

To configure Syslog Collectors Information:


Step 1 Go to CiscoWorks LMS Portal and click RME.

The RME View portlets appear.

Step 2 Move the mouse over the title bar of the Syslog Collector

Step 3 Click the configuration icon. You can:

Select the Auto Refresh check box to refresh the portlet automatically.

Or

Select the minute and hour from the Refresh Every drop-down list to manually set the refresh time. The items in the portlet get refreshed at the Refresh time that you set.

Select the checkbox against (Filtered, Invalid, Dropped, Forwarded) to view the respective columns in the Syslog Collector portlet.

Step 4 Click Save to save the settings.

The Syslog Collectors Information portlet with configured settings appear.

Or

Click the Back arrow icon to return to the portlet.


RSS

Really Simple Syndication (RSS) is an XML-based format used to distribute Web content (such as news headlines). By using RSS, web content publishers can easily create and disseminate the most current news headlines and URLs.

You can configure RSS in the CiscoWorks LMS application. You can create, add, modify any URL in the RSS portlet and view the details. You can also change the content and the title while configuring RSS portlet.

To configure RSS portlet:


Step 1 Go to CiscoWorks LMS Portal and add RSS portlet. For more information, see Adding Portlets by RSS.

Step 2 Move the mouse over the title bar of RSS portlet.

Step 3 Click the Configuration icon and do the following:

a. Enter one URL on each line as shown in the Figure 12-2

Figure 12-2 RSS Portlet

b. Select the number of URLs to be displayed in the RSS portlet from the # of Items Per Channel drop-down list.

For instance, if you have entered ten URLs in RSS portlet and if you want to view only two URLs, you can select 2 from the # of Items Per Channel drop-down list.

Step 4 Click Save to save all the settings.

The RSS portlet with configured settings appear.

Or

Click the Back arrow icon to return to the portlet.


Syslog Alerts

You can use the Syslog Analyzer to centrally log and track system error messages, exceptions, and other information (such as device configuration changes) to analyze device and network performance.

You can configure Syslog Alerts portlets to:

Set the syslog alert details (number of alert records to be displayed and exception period report.)

Set the refresh time both manually and automatically.

To configure Syslog Alerts portlet:


Step 1 Go to CiscoWorks LMS Portal and click RME.

The RME View portlets appear.

Step 2 Move the mouse over the title bar of the Syslog Alerts portlet to view the icons.

Step 3 Click the Configuration icon. You can:

Select the Auto Refresh check box to refresh the portlet automatically.

Or

Select the minute and hour from the Refresh Every drop-down list to manually set the refresh time. The items in the portlet get refreshed at the set refresh time.

Select the number of records to be displayed in the portlet from the Show Last Records drop-down list.

To view the exception period report, enable the Only Exception period report checkbox.

Step 4 Click Save to save all the settings.

Step 5 The Syslog Alerts portlet with configured settings appear.

Or

Click the Back arrow icon to return to the portlet.