Table Of Contents

Using Common Services Home

Common Services Home Layout

Panes in Common Services Home

Security Settings

ACS Connection Status

Backup Status

Online Users

Recently Completed Jobs

Device Credentials and Admin Settings

System Tasks

Device Management Tasks

Reports

Management Tasks

Using Common Services Home

---

Common Services Home is the first page that appears when you launch Common Services application from CiscoWorks home page. The Common Services Home serves as the dashboard for the Common Services application and provides:

• Launch points and top-level navigation for the frequently used functions in Common Services

• Status summary of jobs in the application

• Status of security configurations

• Information on Device and Credentials Administration mode and number of devices

• Backup schedule and details of the last backup

• Online user information

Common Services Home enables you to view the status summary of tasks and get the latest information about the tasks.

You can view the status of security configuration, backup schedule, Device and Credentials Administration mode and number of devices, online user information, recently completed jobs, process status, log file status and license information from CiscoWorks LMS Portal. See User Guide for LMS Portal 1.0.1 for information on how to view these details.

This chapter contains:

•Common Services Home Layout

•Panes in Common Services Home

Common Services Home Layout

The Common Services Home displays the status of various configuration and tasks, and provides easy access to frequently used functions in the Common Services application.

The Common Services Home also displays the version of the Common Services application installed and the updated date and time whenever the Common Services Home is refreshed manually or automatically.

The Auto Refresh option is available in Common Services Home and is enabled by default.

This section contains the following sub sections:

•Panes

•Icons and Color Legends

•Secured Access

•AutoRefresh Feature

Panes

The Common Services Home displays the status summary and the quick links to frequently used functions under various panes.

See Panes in Common Services Home for information on panes in Common Services Home.

Icons and Color Legends

The following table describes the icons available in Common Services Home.

Icon Name	Description
Refresh	Allows you to refresh the Common Services Home and get the live status of tasks and configurations. When you refresh the Common Services Home page, the date and time of page refresh is updated.
Details	Allows you to view the detailed information of System settings in Common Services Home. This icon appears in the Common Services Home: •When Authorization Mode is ACS •When Device and Credentials Administration Mode is Slave

The Common Services Home uses the following colors for messages to represent the status of the jobs:

•Red — Failure of a task or an error condition.

•Green — Success of a task or a normal condition.

•Black — Status information is not applicable for the specific setting.

Secured Access

The Common Services Home displays the information on status summary and links to frequently used functions in the application.

The links to frequently used functions in the application are displayed based on roles and privileges. If you do not have full privileges or if any of the services is not running, you will not see the status information in Common Services Home; instead an error message will be displayed.

For example, if you do not have privileges to view the status of Recently Completed Jobs, you will see the following message in the Recently Completed Jobs pane.

JRM server is down or inaccessible for this user.

AutoRefresh Feature

The AutoRefresh option refreshes the Common Services Home page automatically at a predefined time interval and displays the live status of tasks in the Common Services Home.

By default:

•The AutoRefresh option is enabled.

•The Common Services Home refreshes automatically every 45 seconds.

You can configure the default state of the AutoRefresh option (enabled or disabled) and the default time delay in the CSHP.properties file available at NMSROOT/lib/classpath directory.

•Set the value of default_autorefresh property to false in the properties file to disable the AutoRefresh option.

•Change the value of autorefresh_timedelay property to change the default value of AutoRefresh time delay. You should specify the value of the time delay in seconds.

---

Note The Last Updated field displays the updated date and time whenever the Common Services Home is refreshed manually or automatically.

---

Panes in Common Services Home

The Common Services Home displays the information of status summary and the quick links to frequently used features under the following panes:

•Security Settings

•Backup Status

•Online Users

•Recently Completed Jobs

•Device Credentials and Admin Settings

•System Tasks

•Device Management Tasks

•Reports

•Management Tasks

Security Settings

The Security pane in the Common Services Home displays information about the security settings in Common Services such as Authentication mode, Authorization mode and Single Sign-on configuration.

You can also view the information of security settings from the Security Settings page. Select Server > Security from the Common Services application to open the Security Settings page.

The following table describes the fields displayed in Security Settings pane.

Field	Description
Authentication Mode	Displays the mode selected to authenticate the Common Services Server when logging into the CiscoWorks application. See Setting the Login Module to Non-ACS and Setting the Login Module to ACS for details on usage of the login modules. The status is displayed in green, if the authentication is successful against the local or external server. It is in red when you log into the CiscoWorks application in fallback mode. If the status is displayed in red, check whether the Authentication Server specified is reachable and the related settings are configured properly. See Setting up the AAA Mode for more information.
Authorization Mode	Displays the mode selected to authorize the user after authentication. The Authorization services can be provided by ACS or non-ACS (CiscoWorks local) server. If the Authorization mode is ACS, use the Details icon to view the detailed information on ACS Connection Status in a popup window. See ACS Connection Status for more information on ACS Connection Status in the Common Services Home. The information in green denotes that ACS Server is reachable from CiscoWorks Server through both TACACS+ and HTTP/HTTPS connectivity. This also denotes that the System Identity User is configured with all privileges in ACS. See Setting up the AAA Mode for more information on configuring the ACS Server. The message in red denotes failure. The failure could be because: •ACS settings do not match with the configuration of ACS in Common Services Server. • ACS Server is not reachable from CiscoWorks Server through both TACACS+ and HTTP/HTTPS connectivity. • System Identity User is not configured with all privileges in ACS.
Single Sign-On Configuration	Displays the configured Single-Sign-On mode of the system. The system can be configured in Master, Slave or Standalone mode. •Status information in green denotes that the SSO mode is configured properly. •Message in red indicates problems with the SSO mode configuration that you should correct. For example, if the SSO mode displays Slave in red, you should check whether the SSO Master (Authentication Server) is reachable.

ACS Connection Status

When your Authorization mode is ACS, you can view the details of ACS Connection Status from Common Services Home.

The ACS Connection Status window displays the ACS Connection details. Use the ACS Details icon in the Security pane to open the ACS Connection Status window from the Common Services Home.

The color legends used in this window is slightly different from the legends used in Common Services Home:

•Messages in black indicate that the server is configured properly.

•Messages in red denotes mean that the server is not reachable.

The following table describes the fields displayed in the ACS Connection Status window.

Field	Description
TACACS+ Connectivity With ACS	Displays whether the TACACS+ Connectivity with ACS is configured properly. If the message is in red, it means that the TACACS+ Connectivity with ACS is not configured properly and the server is not reachable.
HTTP/HTTPs Connectivity With ACS	Displays whether the ACS is reachable from CiscoWorks Server through HTTP or HTTPS connectivity. If the message is in red, it means that the server is not configured correctly and is not reachable through HTTP or HTTPS protocol connection. This could be because of the following one or more possible reasons: • Protocol settings of ACS do not match with the ACS configuration in Common Services Server • Invalid ACS admin credentials configured in AAA Setup mode • IP Filtering may be configured in ACS See the Reports and Activity, and Administration Audit pages in the external ACS Server for figuring out the exact reason for HTTP/HTTPS connectivity failure with ACS. See Setting the Login Module to ACS for details on usage of the login modules and on the information on HTTP/HTTPS Connectivity with ACS.
CiscoWorks System Identity User Configuration in ACS	Displays whether the CiscoWorks System Identity user is configured correctly. If the message is in red, it denotes that the System Identity User is not configured with all privileges in ACS mode. We recommend that you configure the System Identity User with all privileges for all the applications in ACS mode. You can assign the Super Admin role to System Identity User for all CiscoWorks applications. You need not create a custom role with all the privileges and assign that role to the user.

Backup Status

The Backup pane in the Common Services Home displays the status of the current backup schedule, status of the last backup, and the date and time of completion of last backup.

You can also view these information from the Backup Job page in the Common Services application. Select Server > Admin > Backup from the Common Services application to open the Backup Job page.

The following table describes the fields in the Backup Status pane.

Field	Description
Backup Schedule	Displays the frequency, and date and time of backup schedule, when backup is scheduled. When the backup schedule is not created or after a fresh installation, this appears as Not Scheduled.
Last Backup Completed at	Displays the date and time of completion of last backup. When no backup is run or completed after a fresh installation or software upgrade, this appears as Not Found or Unable to Detect.
Last Backup Status	Displays the status as success or failure for the last backup. When the backup is not completed or after a fresh installation, this appears as Not Found or Unable to Detect.

Online Users

The Online Users pane displays information on the number of online users and their user IDs.

The following table describes the fields in the Online Users pane.

Field	Description
Number of Online users	Number of users who have currently logged into the CiscoWorks Application. When you click the number displayed, the Who is Logged On report opens.
Online User Id(s)	Login IDs of users who have currently logged into the CiscoWorks Application. The number of sessions opened by the users is also displayed. If there are more than four users online, this field displays only the first four users and a ... link. Click on the link named ... to open the Who is Logged On report to view the information on other online users.

You can send broadcast messages to all online users using the Send Message link.

To send a broadcast message to all online users:

---

Step 1 Click the Send Message link and go to the Notify Users page.

Step 2 Enter the broadcast message in the Message field.

Step 3 Click Send.

The status of the message will be displayed in the Status field in the Notify Users page.

---

Recently Completed Jobs

The Recently Completed Jobs pane contains information about the last eight jobs completed.

You can also view these information from the Job Browser page in the Common Services application. To open the Job Browser page, select Server > Admin > Job Browser from the Common Services application.

The following table describes the fields in the Recently Completed Jobs pane.

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 for 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 are displayed, if they are available.
Job Type	Type of a job. The examples for Job Type include Inventory Collection, SyslogDefaultPurge, and NetConfigJob.
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 and the failed jobs are marked in green and red, respectively.
Description	Description of the job provided by the job creator. The description can contain alphanumeric characters.
Completed At	Date and time when the job was completed.

If there are more than eight completed jobs available, the Recently Completed Jobs displays a link named More. Click this link to open the Job Browser page and view the detailed job information.

Device Credentials and Admin Settings

The Device Credentials and Admin pane displays the information on devices and enables you to view the device management status. The information displayed in this pane is fetched from the Device Management page.

You can access the Device Management page by selecting Device and Credentials > Device Management from the Common Services application.

The following table describes the fields in the Device Credentials and Admin pane.

Field	Description
Number of Devices	Displays the number of devices in Common Services Device and Credentials Repository when the server is configured in non-ACS mode. Note This field is visible only when the CiscoWorks Server is configured in non-ACS mode. You can click the link provided on the number displayed to go to Common Services DCR Device List Report page, and view information on the display name and type of all devices. The link provided on the number displayed to view the DCR Devices List Report page is available only on DCR Master and DCR Standalone servers. The link is not available on a DCR Slave server. You can also open the DCR Device List Report from the Report Generator page. Select Device and Credentials > Reports from the Common Services application to open the DCR Device List Report.
Authorized Devices	Displays the number of devices authorized for the user when the CiscoWorks server is configured in ACS mode. Note This field is visible only when the CiscoWorks Server is configured in ACS mode. You can click the link provided on the number displayed to go to Common Services DCR ACS Devices List Report page, and view information on the display name and type of all devices. The link provided on the number displayed to view the DCR ACS Devices List Report page is available only on DCR Master and DCR Standalone servers. The link is not available on a DCR Slave server. You can also open the DCR ACS Devices List Report from the Report Generator page.
Devices not configured in ACS	Displays the number of devices that are not configured in ACS. If the AAA mode is set to non-ACS, it displays as Not Applicable. You can click the link provided on the number displayed to go to Common Services Device List not included in ACS Report page.
DCR Mode	Displays the mode of Common Services Device Credentials and Administration server. The possible modes of configuration are Standalone, Master and Slave. If the Device and Credentials Administration mode is Slave, you can use the Details icon to view the mode settings. Click the Details icon to go to Device and Credentials Admin page to view the information such as: •Mode of configuration •Master Hostname •Port Number •Master certificate validity status If the Device and Credentials Administration mode is Master, you can use the Details icon to view the list of Slaves and their details in the Current DCR settings dialog box. Select Device and Credentials > Admin from the Common Services application to open the Current DCR settings dialog box.
Discovery Status	Displays the status of Common Services device discovery. The status of device discovery could be any of the following: •Completed •Initializing •Recent Discovery Information Not Found •Running •Stopping You can click the link on the discovery status to go to Device Discovery Summary page. See Viewing Device Discovery Summary for more information.

System Tasks

The System Tasks pane provides you the links to perform the frequently used system tasks such as Local User Setup, AAA mode setup and License Management in the application.

The following table lists the links available in System Tasks Pane, the destination page of each link, and the alternative methods of launching the destination page from the application home page.

Field	Description
Local User Setup	When you click this link, the Local User Setup page opens. Alternatively, to open this page, select Server > Security > Single-Server Management > Local User Setup from the Common Services application.
Multi-Server Trust Management	When you click this link, the Multi-Server Trust Management page opens. Alternatively, to open this page, select Server > Security > Multi-Server Trust Management from the Common Services application.
Configure Single Sign-On	When you click this link, the Single Sign-On Setup page opens. Alternatively, to open this page, select Server > Security > Multi-Server Trust Management > Single Sign-On Setup from the Common Services application.
AAA Mode Setup	When you click this link, the AAA Mode Setup page opens. Alternatively, to open this page, select Server > Security > AAA Mode Setup from the Common Services application.
License Management	When you click this link, the Licensing Information page opens. Alternatively, to open this page, select Server > Admin > Licensing from the Common Services application.
Group Management	When you click this link, the Groups Administration page opens. Alternatively, to open this page, click the Groups tab from the Common Services application.

Device Management Tasks

The Device Management Tasks pane contains links that allow you to perform the frequently used device management tasks. When you have configured the DCR Server in Slave mode, only the links to the Device Discovery and Device Selector Settings appears. The other links do not appear.

The following table lists the links available in the Device Management Tasks pane, the destination location of each link, and alternative methods to launch the destination page from the application home page.

Field	Description
Device Discovery	When you click this link, the Device Discovery Summary page opens. Alternatively, to open the Device Discovery summary page, select Device and Credentials > Device Discovery from the Common Services application.
Add Devices	When you click this link, the Device Properties wizard opens. Alternatively, to open the Device Properties wizard: 1. Select Device and Credentials > Device Management from the Common Services application. The Device Summary page appears. 2. Click Add in the Device Summary page. The Device Properties wizard appears.
Add User-defined Attributes	When you click this link, the User Defined Fields page opens. Alternatively, to open this page, select Device and Credentials > Admin > User Defined Fields from the Common Services application.
Edit/Delete Devices	When you click this link, the Device Management page opens. Alternatively, to open this page, select Device and Credentials > Device Management from the Common Services application.
Import Devices / Export Devices	When you click the Import Devices link, the Device Import page opens in a new window. Alternatively, to open the Device Import page: 1. Select Device and Credentials > Device Management from the Common Services application. The Device Summary dialog box appears. 2. Click Bulk Import in the Device Summary dialog box. The Device Import page opens in a new window. When you click the Export Devices link, the Device Export page opens in a new window. Alternatively, to open the Device Export page: 1. Select Device and Credentials > Device Management from Common services. The Device Summary dialog box appears. 2. Click Export in the Device Summary page. The Device Export page opens in a new window.
Device Selector Settings	When you click this link, the Device Selector Settings page opens. Alternatively, to open this page, select Device and Credentials > Device Management > Device Selector Settings from the Common Services application.

Reports

The Reports pane contains links to frequently used reports in Common Services. The reports are launched in a popup window.

When the Common Services Server is configured in the DCR Slave mode, links to Device Audit Log report and Device Import Status report will not be displayed in the Reports pane.

The following table lists the links available in the Reports pane and the alternative methods of launching the reports from the application home page.

Field	Alternative Method of Launching Reports From Common Services
Permission Report	Select Server > Reports from the Common Services application, and select Permission Report from the list of Available System Reports.
Log File Status	Select Server > Reports from the Common Services application, and select Log File Status from the list of Available System Reports.
Process Status	Select Server > Reports from the Common Services application, and select Process Status from the list of Available System Reports.
System Audit Log	Select Server > Reports from the Common Services application, and select Audit Log from the list of Available System Reports.
Device Audit Log	Select Device and Credentials > Reports from the Common Services application, and select Audit Log from the list of Available System Reports.
Device Import Status	Select Device and Credentials > Reports from the Common Services application, and select Import Status Report from the list of Available System Reports.

Management Tasks

The Management Tasks pane contains links that allows you to perform common server administration tasks.

The following table lists the links available in Management Tasks pane, the destination location of each link, and the alternative method of launching the destination page from the application home page.

Field	Description
Schedule Backup	When you click this link, the Backup Job page opens. Alternatively, to open this page, select Server > Admin > Backup from the Common Services application.
Check for Software Updates	When you click this link, the Software Update page opens. Alternatively, to open this page, select Software Center > Software Update from the Common Services application.
Check for Device Updates	When you click this link, the Device Update page opens. Alternatively, to open this page, select Software Center > Device Update from the Common Services application.
Launch Device Center	When you click this link, the Device Center page opens in a new window. Alternatively, to open this page: 1. Go to the CiscoWorks home page. 2. Select Device Center from the Device Diagnostic Tools panel.
Collect Server Information	When you click this link, the Collect Server Information page opens Alternatively, to open this page, select Server > Admin > Collect Server Information from the Common Services application.