User Guide for CiscoWorks LMS Portal 1.2 (With LMS 3.2)
Chapter 10 Working with Common Services View

Table Of Contents

Working with Common Services View

Critical Message Window

Utilizing Space in the CiscoWorks Drive

DCR and AAA Information

Device Discovery Summary

Device Allocation Summary

Devices Managed by the Applications

Job Information Status

Log Space Usage

Process Status

Products Installed

Servers and Applications

System Backup Status

User Login Information

Common Services

CS Workflow Demo


Working with Common Services View


CiscoWorks Common Services (CS), is a set of management services that is shared by CiscoWorks applications. CiscoWorks is a family of products based on Internet standards, to manage networks and devices. All CiscoWorks products use and depend on Common Services.

Common Services creates a standard user experience for all management functions. It also provides a common framework for all basic system-level operations such as installation, data management including backup-restore and import-export, event and message handling, and job and process management.

Common Services enables critical information to be shared among the various products, and provides a new framework for delivering timely support of new devices. Additionally, CS supports new platforms, and provides enhanced security mechanisms.

This chapter describes the portlets available in the CS View and how to customize these portlets.

Critical Message Window

DCR and AAA Information

Device Discovery Summary

Device Allocation Summary

Job Information Status

Log Space Usage

Process Status

Products Installed

Servers and Applications

System Backup Status

User Login Information

Common Services

CS Workflow Demo

Critical Message Window

In the Critical Message Window portlet, you can view the alerts for CiscoWorks Drive Utilization and down processes. For details, see Utilizing Space in the CiscoWorks Drive.

For instance, if the usage of the drive exceeds the limit, the alerts appear. You can click the help link to view the details to reduce the drive utilization space.

To configure the Critical Message Window portlet, see Configuring Refresh Time.

To customize the look and feel of the Critical Message Window portlet, see Changing the Look of Your Portlets.

Table 10-1 lists the Critical Message Window portlet details.

Table 10-1 Critical Message Window Portlet

Details
Description

CiscoWorks Drive Utilization

Displays the utilization of the drive for Windows and Solaris.

For Windows:

Drive where the product is installed.

For example, 'C' drive in case of "C/Program Files/CSCOpx"

For Solaris:

It 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 the DFM processes such as DFMCTMStartup and Data Purge are down, they are not displayed in the Critical Message Window portlet.


Utilizing Space in the CiscoWorks Drive

You can utilize the space in Ciscoworks drive in the following ways:

Delete the unwanted logs files from the NMSROOT directory.

Use the log rotate functionality, to rotate the logs to other drives.

Remove the unwanted files from the NMSROOT drive.


Note The Authorization and Authentication modes appear in the Critical Message Window portlet (in red) if you do not have full privileges in the DCR and AAA Information portlet.


For more information, see User Guide for Common Services 3.3

DCR and AAA Information

The Device and Credential Repository (DCR) and Authentication Authorization and Accounting (AAA) Information portlet allows you to view the information about the device credentials, admin settings, security settings, and device polling status.

The device credentials and admin settings enable you to view the device management status.

The security settings enable you to view the security settings in CS such as the Authentication mode, Authorization mode, and Single sign-on configuration.

To configure DCR and AAA Information portlet, see Configuring Refresh Time.

To customize the look and feel of DCR and AAA Information portlet details, see Changing the Look of Your Portlets.

Table 10-2 lists the DCR and AAA Information portlet details.

Table 10-2 DCR and AAA Information Portlet

Field
Description

Authentication Mode

Mode selected to authenticate the Common Services server when logging into the CiscoWorks application. For example, TACACS+, MS Active Directory.

If the status is displayed in green, the authentication is successful against the local or external server.

The status is in red when you log into the CiscoWorks application in fallback mode.

Authorization Mode

Mode selected to authorize the user after authentication.

The Authorization services can be provided by ACS or non-ACS (CiscoWorks local) server.

When the server is in ACS mode:

The information displayed in green denotes the following:

The ACS Server is reachable from CiscoWorks Server through both TACACS+ and HTTP/HTTPS connectivity.

The System Identity User is configured with all privileges in ACS.

The information displayed in red denotes the following:

ACS Server is not reachable from CiscoWorks Server through both TACACS+ and HTTP/HTTPS connectivity.

The System Identity User is not configured with all privileges in the ACS mode.

Click the link corresponding to the Authorization Mode to view the ACS Connection Status details.

SSO Mode

SSO mode, such as Stand alone, Master/Slave.

Authorized Devices

Number of authorized devices. (For ACS Mode).

Click on the number to view the DCR Device Management page details.

Devices Not Configured in ACS

Number of devices that are not configured in ACS mode.

Click the link corresponding to the Devices Not Configured in ACS to view the DCR ACS Devices List Report.

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.

Device Polling Status

Device Polling Status

Status of the polling of the devices.

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 when next polling schedule time.


You can click the portlet name in the title bar of the portlet to navigate to the Security settings page in the CS application.

For more information, see User Guide for Common Services 3.3

Device Discovery Summary

The Device Discovery Summary portlet gives the summary of the discovered devices, such as the total number of devices discovered, reachable devices, unreachable devices, devices added to DCR and devices updated to DCR and so on.


Note The Device Discovery Summary portlet is not added to CS View by default. However, the portlet is listed below the CS link and you can add it to any view.


To configure the Device Discovery Summary portlet, see Configuring Refresh Time.

To change the Look and Feel of the Device Discovery Summary portlet, see Changing the Look of Your Portlets.

Table 10-3 displays the Device Discovery Summary portlet details.

Table 10-3 Device Discovery Summary Portlet

Field
Description

Discovery Status

Status of the discovery whether it is in the initializing, running or complete status.

Discovery Start Time

Displays the Day, month, date, and time when the discovery began.

Discovery End Time

Displays the Day, month, date, and time when the discovery got completed.

Total Devices Discovered

Number of devices found.

You can click the number to navigate to the Device Discovery Report for all Devices Discovered.

Reachable Devices

Number of devices that are reachable.

You can click the number to navigate to the Device Discovery Report for Reachable devices.

Unreachable Devices

Number of unreachable devices.

You can click the number to navigate to the Device Discovery Report for Unreachable devices.

Devices Newly Added to DCR

Number of devices added to DCR.

You can click the number to navigate to the Device Discovery Report for Devices Newly Added to DCR.

Devices Updated to DCR

Number of devices updated to DCR.

You can click the number to navigate to the Device Discovery Report for Devices Updated in DCR.


You can click the portlet name in the title bar of the portlet to navigate to the Device Discovery Summary details page in the CS application.

For more information, see User Guide for Common Services 3.3.

Device Allocation Summary

In the Device Allocation Summary portlet, you can view the summary of all the devices managed by each application. For more information, see Devices Managed by the Applications

The portlet also displays the details of the devices not managed by the application.

If the server is in a Master -Slave setup, the Device Allocation Summary will display device management information about all Masters and Slaves.

In a Master- Slave setup when the same device is managed by both the Master and the Slave in an application, it creates a duplicate entry. However, the Device Allocation Summary portlet displays the number of devices after deleting the duplicate entries.

To configure the Device Allocation Summary details, see Configuring Refresh Time.

To customize the Device Allocation Summary details, see Changing the Look of Your Portlets.

Table 10-4 lists the Device Allocation Summary portlet details.

Table 10-4 Device Allocation Summary Portlet

Field
Description

Application

Name of the applications managing devices such as Resource Manager Essentials (RME), Device Fault Manager (DFM), Health and Utilization Monitor (HUM), Campus Manager (CM), and Internetwork Performance Monitor (IPM).

Managed Devices

Number of devices managed by the corresponding application.

You can click the Device Count to launch the devices managed by the Application report. This report displays the server name and the managed device count.

Total no. of devices in the server

Total number of devices in the server.

Devices not managed by any application.

In Non-ACS mode:

Displays the total number of devices not managed by any of the applications.

In ACS mode:

Displays the total number of devices that are neither configured in ACS nor managed by any of the applications.


Devices Managed by the Applications

To see the devices managed by the applications:


Step 1 Go to Device Allocation Summary portlet.

The name of the application such as Campus Manager (CM), Device Fault Manager (DFM), Resource Manager Essentials (RME), Internetwork Performance Monitor (IPM), Health and Utilization Monitor (HUM) are displayed along with the number of the devices managed by each application.

Step 2 Click the device number link in the Managed Device column.

For example, if you click the device number link against Campus Manager application, the Device Managed By Campus Manager Application page is launched.

You can view the names of the servers and the device count.

Step 3 Click the number link in the Device Column.

The display name of the server along with the attributes, such as IP Address and Host Name are displayed.


Job Information Status

In the Job Information Status portlet, you can view the status of up to 20 jobs of the installed applications.

To configure the portlet, see Job Information Status

To customize the look and feel of the Job Information Status portlet, see Changing the Look of Your Portlets.

Table 10-5 lists Job Information Status portlet details.

Table 10-5 Job Information Status Details

Field
Description

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 when the job is scheduled.


You can click the portlet name in the title bar of the portlet to navigate to the Job Browser page in the CS application.

For more information, see User Guide for Common Services 3.3

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.

To configure the Log Space Usage portlet, see Configuring Refresh Time.

To customize the Log Space Usage portlet, see Changing the Look of Your Portlets.

Table 10-6 lists Log Space Usage portlet details.

Table 10-6 Log Space Usage Portlet

Field
Description

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 and is displayed in Kilo bytes.


You can click the portlet name in the title bar of the portlet to navigate to Log File status report page in the CS application.

For more information, see User Guide for Common Services 3.3

Process Status

In Process Status portlet, you can manage application-specific activities or jobs.

To configure Process Status portlet, see Configuring Refresh Time.

To customize the look and feel of Process Status portlet, see Changing the Look of Your Portlets.

Table 10-7 lists Process Status portlet.

Table 10-7 Process Status Portlet

Field
Description

State

Status of the process, such as Failed to start, Running normally and Shutdown.

No. of Process

Number of the processes corresponding to Failed to start, Running normally and Shut down.


You can click the portlet name in the title bar of the portlet to navigate to the Process Status report page in the CS application.


Note You can click the link displayed in the portlet to manage the process by either starting or stopping it.


For more information, see User Guide for Common Services 3.3

Products Installed

In the Products Installed portlet, you can view the name of the installed product, along with its version, license details and status.

You can click the name of the installed product, to view the CS Software Update's Application and Packages installed report page.

To configure the Products Installed portlet, see Configuring Refresh Time.

To customize the look and feel of the Products Installed portlet, see Changing the Look of Your Portlets.

Table 10-8 lists the Product Installed portlet details.

Table 10-8 Product Installed Portlet

Field
Description

Name

Name of the installed product,.

Version

Version number of the product.

License Status

License status either as licensed or purchased details.

Size

Device limit for the licensed application.


You can click the Portlet name in the title bar of the portlet to navigate to the Software updates page in the CS application. For more information, see User Guide for Common Services 3.3.


Note Click the link displayed in the portlet to navigate to the License page and view the corresponding details.


Servers and Applications

In the Servers and Applications portlet, you can view the home page of the installed applications in the DCR Master or Slave. If the server is in Standalone mode, the portlet will display only its installed applications.


Note The Servers and Applications portlet is not added to CS View by default. However, the portlet is listed below the CS link and you can add it to any view.


To configure the Servers and Applications portlet, see Configuring Refresh Time.

To customize the look and feel of Servers and Applications portlet, see Changing the Look of Your Portlets.

Table 10-9 lists the Servers and Applications portlet details.

Table 10-9 Servers and Applications Portlet

Servers
Applications

Displays the name of the server.

Applications installed on the respective servers.

You can click the application name link to navigate to the home page of the corresponding application.



Note An error message server unreachable/invalid certificate appears in the portlet, if any of the servers are down, host name is not DNS(Domain Name Server) resolvable, or if the certificate is invalid.


For more information, see User Guide for Common Services 3.3.

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.

Common Services provides a single backup and restore facility to back up and restore all applications installed on the CiscoWorks server. You cannot backup or restore individual portal databases without the Common Services backup utility.

Use the Common Services Backup dialog box to schedule system backups at regular intervals.

To configure the System Backup Status portlet, see Configuring Refresh Time.

To customize the look and feel of the System Backup Status portlet, see Changing the Look of Your Portlets.

Table 10-10 lists the System Backup Job Details portlet details.

Table 10-10 System Backup Status Details Portlet

Field
Description

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 in the CS application.

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 in the CS application.

For more information, see User Guide for Common Services 3.3.

User Login Information

In the User Login Information portlet, you can view the information on users currently logged into CiscoWorks server using the User Login Information portlet.

To configure the User Login Information portlet, see Configuring Refresh Time.

To customize the look and feel of User Login Information portlet, see Changing the Look of Your Portlets.

Table 10-11 lists the User Login Information portlet details.

.

Table 10-11 User Login Information Portlet

Field
Description

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 in Common Services.

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 you 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 in Common Services.

For more information, see User Guide for Common Services 3.3.

Common Services

CiscoWorks Common Services (Common services) represents a common set of management services that are shared by CiscoWorks applications. CiscoWorks is a family of products on Internet standards for managing networks and devices.

You can customize and configure the Common Services portlet.

To customize the look and feel of the Common Services portlet, see Changing the Look of Your Portlets.

For details on Common Services, see CS Workflow Demo.

To configure the Common Services portlet:


Step 1 Go to the Common Services portlet and click the Configuration icon.

Step 2 Select the application name from the Application drop-down list.

You can select any application name from the drop-down list.

Step 3 Click Save to save the settings.

The new Application portlet appears.


Table 10-12 lists the Common Services portlet details.

Table 10-12 Common Services Portlet  

Field
Description

Home

Serves as a dashboard for the CS application.

It also provides information on:

Status of the job

Status of security configuration

Information on Devices and Credentials Administration mode.

Details on the Backup schedule and last backup status

Online user's information.

Server

Common Services includes administrative tools to configure the server, manage security, and data.

You can set up security mechanisms, manage processes, jobs, resources, and generate reports that provide troubleshooting information about the status of the server.

Security

Provides security mechanisms to prevent unauthenticated access to the CiscoWorks Server, CiscoWorks application and to other data.

Report

Provides detailed reports on logfile status, roles and privileges, users currently logged in, processes that are currently running and system activities that occur within the Cisco Works Common Services client applications.

Admin

Enables you to manage process, set up backup parameters, update licensing information, collect server information, manage jobs and resources, and configure system-wide information on the CiscoWorks Server.

Home page Admin

Allows you to register or unregister the following in the home page.

Application Registration: Register Cisco application that resides on other servers.

Links Registration: Add additional links to CiscoWorks home page for both custom and third party applications.

Settings: Change CiscoWorks home page name, custom tool Label and Third party label.

Software Center

Allows you to view a list of all CiscoWorks related bundle and products currently installed on your system.

It provides information on:

Software Update

Device Update

Schedule Device Downloads

Activity Log

Device and Credentials

Information on devices and enables you to view the device management and device discovery status.

It also provides information on:

Device Discovery

Device Management

AUS Management

Reports

Device Selector Settings

Admin

Groups

Provides information on the Group Admin.

Named set of devices.

The group is characterized by a set of properties, such as an associated rule, name, description type, and access permission.

The rule determines the membership of a group that may change whenever you evaluate the rule.


You can click the portlet name in the title bar of the portlet to navigate to the Common Services home page in the CS application.

For more information, see User Guide for Common Services 3.3.

CS Workflow Demo

The Common Services (CS)Workflows Demo (audio and video) portlet displays the most frequently used workflows in CS application.

They are as follows:

Server Setup

Groups Management

Device Discovery

CiscoView Mini-RMON Setup

Click the corresponding links to view the demo.


Note You must enable JavaScript in the browser window and install the latest version of the Flash Player to view the demo.