Understanding the System Dashboard
The System Dashboard has the following portlets:
Note
The data in these portlets does not appear based on any role-based authorization, both device-level or user-level authorization.
Cisco Prime Product Updates
You can view the recent updates and announcements of Cisco Prime products using Cisco Prime Product Updates.
Critical Message Window
In the Critical Message Window portlet, you can view the alerts for Cisco Prime Drive Utilization and for processes that are down. For details, see Utilizing Space in the Cisco Prime Drive.
For instance, if the usage of the drive exceeds the specified limit, the alerts appear. You can click the help link to view the details, and can reduce drive utilization.
You must configure the refresh time in the portlets.
You can also get information about:
- Authentication mode fallback
Authentication mode from which the user fallbacks to the Local Authentication module. This message appears when the user is in fallback mode.
- License expiration
- Single Sign On (SSO) master unreachability, which is applicable only for a slave server.
Utilizing Space in the Cisco Prime Drive
You can use the space in Cisco Prime LMS drive in the following ways:
- Delete the unwanted log files from the NMSROOT directory.
- Use the log rotate functionality, to rotate the logs to other drives.
- Remove unwanted files from the NMSROOT drive.
Note
The Authentication modes appear in the Critical Message Window portlet (in red) if you do not have full privileges in the Device Credential and AAA Information portlet.
Table 1-2 lists the Critical Message Window portlet details.
Table 1-2 Critical Message Window Portlet
|
|
Cisco Prime Drive Utilization |
Displays the utilization of the drive for Windows, Solaris and Soft Appliance. For Windows: Drive is where the product is installed. For example, 'C' drive in case of "C/Program Files/CSCOpx" For Solaris/Soft Appliance: The portlet displays the File System utilization of the following: /opt - Product Installed location /var - Log file details location. |
Processes xyz are down. For example:ESS, EssMonitor, Proxy and so on. |
Displays the processes that are down. All the processes that are down are displayed in red in the portlet. However, when Fault processes such as DFMCTMStartup and Data Purge are down, they are not displayed in the Critical Message Window portlet. |
Device Credentials and AAA Information
The Device Credentials and AAA Information portlet allows you to view the information about the device credentials, admin settings, security settings, and device polling status.
The security settings enable you to view the security settings in LMS such as the Authentication mode, and Single sign-on configuration.
Table 1-3 lists the Device Credentials and AAA Information portlet details.
Table 1-3 Device Credentials and AAA Information Portlet
|
|
Authentication Mode |
Mode selected to authenticate the LMS server when logging into the LMS application. For example, TACACS+, MS Active Directory.
- If the status is displayed in green, authentication is successful in the local or external server.
- The status is in red when you log into the Cisco Prime application in fallback mode.
|
Authorization Mode |
Mode used to authorize the user after authentication. From LMS 4.0, only the Local Authentication mode is used to authenticate users, and authorize them to access Cisco Prime LMS. ACS mode is not available. |
Single Sign On (SSO) Mode |
SSO mode such as Stand alone and Master/Slave. |
No. of Devices |
Number of devices. Click on the number to view the DCR Device Management page details. |
DCR Mode |
DCR mode such as Standalone, Master, Slave. For more information about DCR mode, see DCR Architecture in Inventory Management Online Help. For more information on changing the DCR mode, see Changing DCR Mode. |
|
Device Polling Status |
Status of the device polling. The status can be either enabled or disabled. If the status is enabled, then it displays the scheduled jobs along with the Job ID. For example Job ID: 1034. |
Device Polling Frequency |
Polling frequency of the devices. This frequency can be:
- Every 6 hours
- Every 12 hours
- Daily
- Weekly
- Monthly
|
Total Unreachable Devices |
Total number of devices that are not reachable. Click the unreachable device link to view the report. |
Next Polling Schedule |
Time at which the next polling is scheduled. |
Log Space Usage
In Log Space Usage portlet, you can manage the reports on log file size.
The Log Space Usage portlet also displays details of all log files, including the Tomcat and Apache log files. You must configure the refresh time in the portlets.
Table 1-4 lists the Log Space Usage portlet details.
Table 1-4 Log Space Usage Portlet
|
|
Log File |
Name of the log file such as syslog.log, EDS.log upm_base.log, and so on. The asterisk (*) displayed along with some log file name denotes that there are multiple files available. |
Directory |
Displays the location of the logfile. For instance, var/adm/CSCOpx/log. |
File Size |
Current size of the log file in kilo bytes. |
You can click the portlet name in the title bar of the portlet to navigate to Log File status report page (Reports > System > Status > Log File).
For more information on the list of log files, see Maintaining Log Files .
Process Status
In Process Status portlet, you can manage all the activities or jobs.
Table 1-5 lists the Process Status portlet details.
Table 1-5 Process Status Portlet
|
|
State |
Status of the process, such as Failed to start, Running normally and Shutdown. |
No. of Process |
Number of processes in each state. |
You can click the portlet name in the title bar of the portlet to navigate to the Process Status report page (Reports > System > Status > Process).
You can click the link displayed in the portlet to start or stop the process.
System Backup Status
In the System Backup Status portlet, you can view the details such as the current backup schedule, last backup status, last backup location and the time when the last backup was completed.
You should back up the database regularly so that you have a safe copy of the database. You cannot back up the database while restoring it. Whenever you perform a backup, all the databases of the installed applications are backed up.
LMS provides a single backup and restore facility to back up and restore all applications installed on the LMS server. You cannot backup or restore individual portal databases without the LMS backup utility. See, Backing up Data Using CLI for more information on the backup utility.
To schedule system backups at regular intervals, select Admin > System > Backup.
Table 1-6 lists the System Backup Job Details portlet fields.
Table 1-6 System Backup Job Details Portlet
|
|
Backup Schedule |
Date and time at which the backup was scheduled. You can click the link corresponding to the Backup Schedule to view/schedule the respective Backup Job details. |
Last Backup Completed at |
Date and time when the last backup was completed. |
Last Backup Status |
Status of the last backup. |
Last Backup Location |
Location of the last backup. |
You can click on the portlet name in the title bar of the portlet to navigate to the Backup Job page.
User Login Information
In the User Login Information portlet, you can view the information on users currently logged into LMS server.
You must configure the refresh time in the portlets.
Table 1-7 lists the User Login Information portlet details.
.
Table 1-7 User Login Information Portlet
|
|
No. of Logged-in Users |
Number of users who have logged in. You can click the number of logged-in users to view the Who is Logged on Report page (also available from Reports > System > Users > Who is Logged On). |
Users |
Log-in details of all users and the number of sessions opened by each user. |
Note
You can send broadcast messages to logged-in users by clicking the Send Message to all users link displayed in the User Login Information and the users will receive the message within 60 seconds by default.
You can click the portlet name in the title bar of the portlet to navigate to the Who is Logged on Report page.
For more information on setting up local users, see Setting up Local Users.
Job Information Status
In the Job Information Status portlet, you can view the status of up to 20 jobs of the installed applications. You can click the portlet name in the title bar of the portlet to navigate to the Job Browser page.
You must configure the refresh time in the portlets.
Table 1-8 lists the Job Information Status portlet details.
Table 1-8 Job Information Status Portlet
|
|
Job ID |
Unique ID assigned to the job by the system, when the job is created. The Job IDs are displayed in ID.No.of.Instances format in periodic jobs. For example, the Job ID 1002.11 indicates that this is the eleventh instance of the job whose ID is 1002. When you click the Job ID, the job details, if available, are displayed. |
Job Type |
Type of the job. For example, Inventory Collection, SyslogDefaultPurge, and Net Config Job. |
Status |
Status of the scheduled jobs that are completed. The Job states include Succeeded, Failed, Crashed, Cancelled, and Rejected. The status of the succeeded jobs are displayed in green and the Failed, Crashed, Cancelled, and Rejected jobs are displayed in red. |
Job Description |
Description of the job provided by the job creator. It can contain alphanumeric characters. |
Owner |
Name of the user who created the job. |
Scheduled At |
Date and time at which the job is scheduled to run. |
Audit Trail Information
In the Audit Trail Information portlet, you can view the details of the changes made to the LMS application by the user.
You must configure the refresh time in the portlets.
Table 1-9 lists the Audit Trail Information portlet details.
Table 1-9 Audit Trail Information Portlet
|
|
User Name |
Name of the person who performed the change. This is the name entered when the person logged in. It can be the name under which the LMS application is running, or the name under which the Telnet connection is established. |
Application Name |
Name of the LMS component involved in the network change. For example, Change Audit, Device Management, ICServer, NetConfig, and NetShow. |
Creation Time |
Date and the time at which the changes were performed on the LMS server. |
Description |
Brief summary of the change that occurred on the LMS server. |
You can click the portlet name in the title bar to navigate directly to the Report Generator page.
Job Approval
In Job Approval portlet, you can view the list of all jobs.
To configure Job Approval portlet, see Configuring the Job Approval portlet.
Table 1-10 lists the Job Approval portlet details.
Table 1-10 Job Approval Portlet
|
|
Job ID |
ID of the job that has been given for approval. The unique number assigned to the job. For periodic jobs such as Daily, Weekly, and so on, the job IDs are in the number x format. The x represents the number of instances of the job. For example, 1001.3, indicates that this is the third instance of the job ID 1001. Click the Job ID hyperlink to view the job details. |
Job Description |
Description of the job. |
Job Schedule |
Date and time for which the job is scheduled. |
The Job Approval portlet allows you to approve or reject a job for which you are an approver. A job will run only if it is approved. If the job is not approved by its scheduled runtime, or if an approver rejects it, the job is moved to its rejected state and will not run.
For periodic jobs, only one instance of the job needs to be approved. If one instance is approved, all other instances are also considered as approved.
You are notified by e-mail, when a job approved by you is created.
This portlet enforces the approval process by sending job requests through e-mail to people on the approved list.
You can click the portlet name in the title bar to navigate directly to the Jobs Pending Approval details page in LMS.
In the Job Approval portlet, you can view the list of Job details.
You can configure the Job Approval portlet to set the number of records to be displayed in the portlet, and refresh time both manually and automatically.
Configuring the Job Approval portlet
To configure the Job Approval portlet:
Step 1
Click the Configuration icon. You can:
Step 2
Select the minute and hour from the Refresh Every drop-down list to change the refresh time. The items in the portlet get refreshed at the changed Refresh frequency.
Step 3
Select the number of records to be displayed in the portlet from the Show Last Records drop-down list.
Step 4
Click Save to view the portlet with the configured settings.
Syslog Collectors Information
Syslog Collectors Information portlet displays the list of remote Syslog collectors subscribed to the LMS servers. It contains the syslog collector information such as the name of the remote syslog, analyzer name, status and the number of packets received.
Syslog Collector is a service to receive, filter and forward syslogs to one or more Syslog servers. In this way the collectors reduces traffic on the network as well as the processing load on the server.
By default you can only view the remote Syslog analyzer name, status and the number of packets received. However, you can configure the portlet for you to view the other details in the portlet such as the number of packets that are filtered, invalid, dropped, or forwarded.
Table 1-11 lists the Syslog Collectors Information portlet details.
Table 1-11 Syslog Collectors Information Portlet
|
|
Name |
Host name or the IP address on which the collector is installed. |
Status |
Status of the Remote Syslog Collector. For example, whether it is connected. |
Received |
Number of packets received. |
To configure Syslog Collectors Information:
Step 1
Move the mouse over the title bar of the Syslog Collector
Step 2
Click the configuration icon. You can:
- Select the minute and hour from the Refresh Every drop-down list to change the Refresh time. The items in the portlet get refreshed at the changed Refresh frequency.
- Select the check box against the type of syslog message (Filtered, Invalid, Dropped, Forwarded) to view the respective columns in the Syslog Collector portlet.
–
Filtered—Number of filtered messages. Filters are defined with the option Message Filters option. See Defining Syslog Message Filters for more information.
–
Invalid—Number of invalid Syslog messages.
–
Dropped—Number of Syslog messages dropped.
–
Forwarded—Number of forwarded Syslog messages.
Step 3
Click Save to view the portlet with the configured settings.
Supported Device Finder Portlet
The Supported Device Finder portlet enables you to view the details of the devices that are supported in various LMS applications.
By default the Supported Device Finder portlet is added to the System View.
This portlet enables you to:
- Locate the supported devices in the LMS applications
- Get the latest updates on devices that are supported and those that will be supported in the upcoming releases.
- Raise a request through mail to support a new device that is not supported.
You can search the support of devices added to the DCR using the following search options:
To search using Supported Device Finder portlet:
Step 1
There are three scenarios when the device is not supported:
- If the device is not supported in the current installation the following message appears:
The device is not supported, click here for more information.
- If the requested device is supported in later releases, and not available with your present installation, the following message appears:
Not supported in Installed version <<version number>>. Support available in version << version number>>
Note
If the device is not currently supported with your existing package, you can install the latest IDU from Cisco.com to get the device support.
- If the requested device is not supported in any releases, the following message appears:
The device is not supported, click here for more information.
Step 2
Click the click here
link and a popup box appears:
The popup box has the following information:
- OK button to raise a request for the unsupported device.
- Disclaimer: Please note that all efforts will be made to provide support to this request, however we are unable to commit to a time-line at this moment.
- Links to the latest device updates
- Link to the Supported Devices Table
Step 3
Click OK button to raise a request for the SysObject ID or Model Name. For example, sysobjectId or Model name.
The SysobjectID or the Model Name appears based on the entries made in the portlet.
The default mail client is launched.
The To field and Subject field has the following address and entries:
- To field: lms-dev-supreq@external.cisco.com
- Subject field: Request for new Device Support. For example, <<Model name /SysObjectId>>
The body lists the application names.
Step 4
Enter Yes against the respective application names for which device support is required.
Step 5
Click Send to send a request.
IP Address
You can use the IP Address option to search the devices that are supported in the LMS application.
To search using the IP Address:
Step 1
Select the IP Address from the drop-down list.
Step 2
Enter an IP Address in the IP Address field and click Submit.
All applications are displayed, regardless of whether they are installed or not. The supported servers are also displayed.
- If the requested device is supported in the later releases and you have not installed it, the following support details are displayed:
Supported in LMS 3.2. Click here to download
- If the requested devices is in the roadmap of next recent releases, the following supported details message is displayed.
Support expected by Sept ‘08.
- If the requested device is not supported in any release, the following supported details are displayed.
Click here to send a request to support team.
Host Name
You can use the Host Name option to search the devices that are supported in the LMS applications.
To search using the Host Name:
Step 1
Select the Host Name from the drop-down list.
Step 2
Enter a Host Name in the Host Name field and click Submit.
Note
The valid Host Name characters are A-Z, a-z, 0-9, _.
All LMS functions are displayed. The supported servers are also displayed.
The LMS applications are:
- Inventory, Config and Image Management
- Network Topology, Layer 2 Services and User Tracking
- Fault Management
- IPSLA Performance Management
- Device Performance Management
For more information on the server supported details, see Step 2 of IP Address.
Device Name
You can use the Device Name option to search the devices that are supported in the LMS applications.
To search using the Device Name:
Step 1
Select the Device Name from the drop-down list.
Note
The valid Device Name characters are A-Z, a-z, 0-9, _.
Step 2
Enter a Device Name in the Device Name field and click Submit.
All LMS functions are displayed. The supported servers are also displayed.
For more information on the server supported details, see Step 2 of IP Address.
SysObjectID
You can use the SysObjectID option to search the devices that are supported in the LMS application.
To search using the SysObjectID:
Step 1
Select the SysObjectID from the drop-down list.
Step 2
Enter a SysObjectID in the SysObjectID field and click Submit.
All LMS functions are displayed, regardless of whether they are installed or not. The supported servers are also displayed.
For more information on the server supported details, see Step 2 of IP Address.
Model Name
You can use the Model Name option to search the devices that are supported in the LMS application.
To search using the Model Name:
Step 1
Select the Model Name from the drop-down list.
Step 2
Enter a Model Name in the Model Name field and click Submit.
All LMS functions are displayed. The supported servers are also displayed.
For more information on the server supported details, see Step 2 of IP Address.
Note
You can also use a wildcard search, (*), to search for the model name.
VRF Collector Summary
In the VRF Collector Summary portlet, you can view details of the VRF collection, number of VRFs discovered, number of VRF-supported and VRF-capable devices.
Table 1-12 lists the VRF process summary portlet details.
Table 1-12 VRF Process Summary Portlet
|
|
VRF Collector Status |
Status of the VRF Collector. The two states are:
- Running—Indicates that the VRF collector is running.
- Idle—Indicates that the VRF collector is not running.
|
VRF Collector Last Completion Time |
Indicates the time when the VRF collection is completed. |
Total VRFs Discovered |
Total number of VRFs discovered. Click the number to launch the Virtual Network Manager Report. |
VRF Supported Devices [H/W and S/W Supported] |
Number of VRF-supported devices. These devices have both VRF-supported hardware and software. Click the number to launch the VRF Readiness report. |
VRF Capable Devices [H/W Supported, S/W Update Required] |
Number of VRF-capable devices. These devices have VRF-supported hardware but these devices do not have the supported IOS image for VRF. Click the number to launch the VRF Readiness report. |
Collection Summary Portlet
In the Collection Summary portlet, you can view details of the different collectors in LMS.
Table 1-13 lists the Collection Summary portlet details.
Table 1-13 Collection Summary Portlet
|
|
Collector Name |
Name of the Collector. The various collectors in LMS are:
- Inventory Collection
- Config Archive
- EnergyWise Collection
- Device Discovery
- Fault Discovery
- Topology Data Collection
- UT Major Acquisition
- VRF Collection
|
Succeeded |
Indicates if the respective collection has completed successfully. Note In Inventory Collection, Succedded will give the count of devices that were successfully inventory collected at least once. In Config Archive, partial success state devices will not be shown in Succeeded or Failed columns. |
Failed |
Indicates if the respective collection has failed. Note In Inventory Collection, Failed will give the count of devices that are recently failed. A device which was previously successfully inventory collected and recently failed will have entry in both the columns. We should not compare this with DCR device count. |
Last Completion Time |
Indicates the time when the collection is completed. |
Current Status |
Status of the Collector. The two states are:
- Running—Indicates that the collector is running.
- Idle—Indicates that the collector is not running.
|
Schedule |
Click the Schedule link next to the respective collector to launch the corresponding page. You can now schedule the collector. |
To configure this portlet:
Step 1
Move the mouse over the title bar of the Collection Summary Portlet.
Step 2
Click the configuration icon.
Step 3
Select the Auto Refresh check box.
Step 4
Select the minute and hour from the Refresh Every drop-down list to change the Refresh time. The items in the portlet get refreshed at the changed Refresh frequency.
Step 5
Click Save to view the portlet with the configured settings.
Note
The data in the above portlets is not populated based on device-level or user-level authorization. Role-based access control is not applicable to the portlets.
Note
From LMS 4.2.2, the Collection Summary Portlet page will display the total number of managed devices in LMS server. The customer can view the detailed list of the devices managed by the LMS server by clicking the Managed Device count link on the Collection Summary Portlet page.