Guest

CiscoWorks Network Compliance Manager

Upgrade Guide for CiscoWorks Network Compliance Manager 1.5.01

  • Viewing Options

  • PDF (173.1 KB)
  • Feedback
CiscoWorks Network Compliance Manager 1.5.01 Upgrade Guide

Table Of Contents

CiscoWorks Network Compliance Manager 1.5.01 Upgrade Guide

Contents

CiscoWorks NCM Core Linux, Solaris, or Windows Installation Overview

High Availability Distributed System Upgrade Installation Overview

Backing Up the CiscoWorks NCM Database

MS-SQL Server Backup Instructions

MySQL Backup and Restore Instructions

Device Software Image and CiscoWorks NCM Files Backup

Running the CiscoWorks NCM 1.5.01 Service Pack Installer

Running the Installer on Windows Platform

Running the Installer on Linux Platform

Running the Installer on Solaris Platform

Restoring Previous Customization

Upgrading Additional CiscoWorks NCM Components

CiscoWorks NCM Satellites

CiscoWorks NCM AAA Log Reader

CiscoWorks NCM Syslog Reader

CiscoWorks NCM Drivers

CiscoWorks NCM Alert Center

Troubleshooting

Accessing the CiscoWorks NCM Documentation Set

Obtaining Documentation and Submitting a Service Request


CiscoWorks Network Compliance Manager 1.5.01 Upgrade Guide


Published: March 2010, OL-21882-01

This guide describes how to upgrade to CiscoWorks Network Compliance Manager (NCM) 1.5.01. CiscoWorks NCM 1.5.01 can be installed on CiscoWorks NCM 1.3.0 or higher releases.


Note If you are upgrading from a version earlier than CiscoWorks NCM 1.4 and are using MySQL 3.23.55 as the database platform, before running the NCM 1.5.01 Service Pack Installer, you must first run the provided MySQL Upgrade Installer to upgrade from MySQL 3.23.55 to MySQL 5.0.58. See Install and Upgrade Guide for CiscoWorks NCM 1.5 for information on upgrading MySQL.


Contents

This document contains the following sections:

CiscoWorks NCM Core Linux, Solaris, or Windows Installation Overview

Backing Up the CiscoWorks NCM Database

Device Software Image and CiscoWorks NCM Files Backup

Running the CiscoWorks NCM 1.5.01 Service Pack Installer

Upgrading Additional CiscoWorks NCM Components

Upgrading Additional CiscoWorks NCM Components

Troubleshooting

Accessing the CiscoWorks NCM Documentation Set

Obtaining Documentation and Submitting a Service Request

CiscoWorks NCM Core Linux, Solaris, or Windows Installation Overview

The following steps provide an outline for single CiscoWorks NCM Core upgrade:


Step 1 Stop all CiscoWorks NCM services.

See Chapter 2, Configuring Administrative Settings in the User Guide for Network Compliance Manager 1.5 for more information.

Step 2 Backup the entire CiscoWorks NCM directory to a safe location, to ensure that no settings or files are lost during the upgrade,.

For example, if you have installed CiscoWorks NCM in c:\cisco\CWNCM directory, backup the entire directory to a safe location.

Step 3 Ensure that you have backed up all the data in the database.

See Backing Up the CiscoWorks NCM Database for more information.

Step 4 Follow the install instructions appropriate to your CiscoWorks NCM platform.

See Running the CiscoWorks NCM 1.5.01 Service Pack Installer and Upgrading Additional CiscoWorks NCM Components for more information.


High Availability Distributed System Upgrade Installation Overview

The following steps provide an outline for High Availability Distributed System upgrades:


Step 1 Stop all CiscoWorks NCM services on all CiscoWorks NCM Cores.

Step 2 Backup the entire CiscoWorks NCM directory to a safe location, to ensure that no settings or files are lost during the upgrade.

For example, if you installed CiscoWorks NCM in c:\cisco\CWNCM directory, backup the entire directory to a safe location.

Step 3 Ensure that you have backed up all the data in the database.

Step 4 Wait for the Transaction queue to be emptied before running the Service Pack Installer on each CiscoWorks NCM Core.

Step 5 Verify the CiscoWorks NCM installation:

1. Edit an object from a CiscoWorks NCM server (for example, a Comments field for a device).

2. Wait for a minute and then verify that the updated comment exists on other CiscoWorks NCM servers.

3. Check the status of the Oracle Distributed Monitor to ensure that no problems are being reported.


For additional information on CiscoWorks NCM High Availability Distributed System, see the High Availability Distributed System on Microsoft SQL Server Configuration Guide for Network Compliance Manager or High Availability Distributed System on Oracle Server Configuration Guide for Network Compliance Manager available at the following URL: http://www.cisco.com/en/US/products/ps6923/products_installation_and_configuration_guides_list.html

Backing Up the CiscoWorks NCM Database

Backup all your data in CiscoWorks NCM database before running the NCM 1.5.01 Service Pack Installer.


Note Once the CiscoWorks NCM 1.5.01 is installed, the CiscoWorks NCM installation and its database can not be reverted. Always backup your database before you run this upgrade.


See Device Software Image and CiscoWorks NCM Files Backup for information on backing up your device software images and CiscoWorks NCM files.

While entering the name of the CiscoWorks NCM database for backing up and restoring the database, you must follow the same case as used in the application database name. For example, if you have named your CiscoWorks NCM database as NCMdb, you must enter the database name with the same case (NCMdb) while backing up and restoring the database.

The following topics provide the backup instructions for MS-SQL and MySQL server:

MS-SQL Server Backup Instructions

MySQL Backup and Restore Instructions

Device Software Image and CiscoWorks NCM Files Backup

MS-SQL Server Backup Instructions

To back up MS-SQL Server database:


Step 1 Start Enterprise Manager.

Step 2 Connect to the MS-SQL database server and navigate to your database.

Step 3 Right-click and choose All Tasks > Backup Database.

Step 4 Under Destination, if there are any entries highlight them and click Remove.

Step 5 Under Destination, click Add.

Step 6 Open the file browser.

Step 7 Enter a filename for your backup file in the File Name field.

Always provide a new filename or you may overwrite any existing backups.

Step 8 Click OK three times to start the backup procedure.

Depending on the size of your database, this could take several minutes.


MySQL Backup and Restore Instructions

To back up the MySQL databases used by CiscoWorks NCM:


Step 1 Locate the mysql\bin folder and enter the following command in the command line prompt:

mysqldump -hdatabaseserver -uusername -ppassword -r YourFileName.sql DatabaseName

where:

databaseserver—IP address or hostname where the database is running

username—Username used to connect to the database server

password—Password used to connect to the database server

DatabaseName—CiscoWorks NCM database name that was specified while installing the CiscoWorks NCM.

Example:

mysqldump -hNCMDBServer -utc -ptc -r NCM_Backup_04_30_04.sql NCM

Step 2 Copy (or move) the file to a backup location.

Step 3 Stop the MySQL service:

On Windows platform, choose My Computer > Control Panel > Administrative Tools > Services.

On Linux or Solaris platform, enter the command /etc/init.d/mysql stop

Step 4 Locate the mysql\data folder that contains the ibdata file.

Normally, this file is located in c:\mysql\data.

Step 5 Copy the entire data folder to a backup location.

Step 6 Restart the MySQL service.


Note This operation can take ten minutes or more for large databases.



Device Software Image and CiscoWorks NCM Files Backup

In an enterprise environment, system administrators are usually required to periodically backup crucial software applications. CiscoWorks NCM's server state is maintained in several configuration files. Before installing the CiscoWorks NCM 1.5.01, create a full copy of your CiscoWorks NCM directory.

Running the CiscoWorks NCM 1.5.01 Service Pack Installer

This section provides information about running the CiscoWorks NCM 1.5.01 Service Pack Installer. Before running the CiscoWorks NCM 1.5.01 Service Pack Installer, ensure that the database server is running.


Note CiscoWorks NCM does not support the use of MS SQL Server named instances.


This section contains the following topics:

Running the Installer on Windows Platform

Running the Installer on Linux Platform

Running the Installer on Solaris Platform

Restoring Previous Customization

Running the Installer on Windows Platform

For upgrading on a Windows platform, insert the CiscoWorks NCM 1.5.01 Service Pack Installer DVD into the DVD drive and do the following:


Step 1 On the Windows taskbar, click Start > Run.

Step 2 Enter [drive]:\windows_[nnnn]-[mmddyy]_spi_setup.exe

where drive is your DVD drive, nnnn is the build number, and mmddyy is the build date.

Step 3 Click OK.

Step 4 Follow the instructions on the screen.


See Upgrading Additional CiscoWorks NCM Components for information on upgrading additional CiscoWorks NCM components, such as CiscoWorks NCM Satellites, CiscoWorks NCM AAA Log Reader, and CiscoWorks NCM Syslog Reader.

Running the Installer on Linux Platform

If you are installing the CiscoWorks NCM 1.5.01 Service Pack Installer on a Linux server, insert the DVD into the DVD drive and do the following:


Step 1 Enter cd /[DVD_MOUNT_POINT]

where DVD_MOUNT_POINT is the location of the DVD drive.

Step 2 Enter cd linux

Step 3 Enter sh linux_[nnnn]-[mmddyy]_spi_setup.bin

where nnnn is the build number and mmddyy is the build date.

Step 4 Follow the instructions on the screen.



Note You must have root access to run the CiscoWorks NCM 1.5.01 Service Pack Installer.


Running the Installer on Solaris Platform

If you are installing the CiscoWorks NCM 1.5.01 Service Pack Installer on a Solaris server, insert the DVD into the DVD drive and do the following:


Step 1 Enter cd /[DVD_MOUNT_POINT]

where DVD_MOUNT_POINT is the location of the DVD drive.

Step 2 Enter cd solaris

Step 3 Enter sh solaris_[nnnn]-[mmddyy]_spi_setup.bin

where nnnn is the build number and mmddyy is the build date.

Step 4 Follow the instructions on the screen.



Note You must have root access to run the CiscoWorks NCM 1.5 Service Pack Installer.


If CiscoWorks NCM was configured to run without root privileges on Linux or Solaris, CiscoWorks NCM will not start after the upgrade. If you are running CiscoWorks NCM as non-root, after installing the CiscoWorks NCM 1.5.01 Service Pack, you must enter:

chown -R $user $CWNCM find $CWNCM -type d -exec ls -ld {} \; |grep `^d..-.' | awk `{print $9}' | xargs chmod u+x

where $CWNCM is the root CiscoWorks NCM directory and $user is the username used to start the CiscoWorks NCM Management Engine.

Restoring Previous Customization

The current CiscoWorks NCM upgrade process does not restore the CiscoWorks NCM Install Dir\jre\reporting.rcx file. If you have customized the CiscoWorks NCM Summary reports template or specification, manually update the customized settings from the backed up version of the file to the new installed version of the file.

All settings in the site_options.rcx and adjustable_options.rcx files are preserved and restored automatically. If you want to restore the reporting.rcx file, you must manually edit the new reporting.rcx file.

If you have changed other .rcx files in the previous installation and want to retain those changes after upgrading, you should add those changes to the new adjustable_options.rcx file. You cannot use the previous .rcx file to overwrite the new version. Doing so could cause the application to fail.

All settings in the [$CWNCM_HOME]/server/ext/wrapper/conf/*.conf file and [$CWNCM_HOME]/server/ext/jboss/server/default/conf/log4j.xml file are preserved and restored automatically.

Upgrading Additional CiscoWorks NCM Components

The following optional components must be upgraded while upgrading to CiscoWorks NCM 1.5.01:

CiscoWorks NCM Satellites

CiscoWorks NCM AAA Log Reader

CiscoWorks NCM Syslog Reader

CiscoWorks NCM Drivers

CiscoWorks NCM Alert Center

CiscoWorks NCM Satellites

If you are using CiscoWorks NCM Satellites, after installing CiscoWorks NCM 1.5.01, you must run the Deploy Remote Agent task to re-install the upgraded Satellite agent on all the remote Gateways. See the Upgrading the Satellite section in the Installation and Upgrade Guide for CiscoWorks NCM Gateway for detailed information.

CiscoWorks NCM AAA Log Reader

If you are running CiscoWorks NCM on a Windows platform and using the AAA Log Reader on your AAA server to provide real-time change detection, you need to update the AAA Log Reader.

To update the AAA Log Reader:


Step 1 Backup the AAA Log Reader directory on your AAA server.

Step 2 Copy the truecontrol-client.jar file located in the AAA folder, to the AAA Log Reader directory. Overwrite the existing file.

Step 3 Change the following four options in the agent.rcx file for correct error logging to appear in the aaa_wrapper.log.

Change:

[option name="log/AAALogReader"]System.out[option]

[option name="log/AAALogReader/level"]0[option>

[option name="log/connect"]System.out[option]

[option name="log/connect/level"]75[option]

To:

[option name="log/External/AAALogReader"]System.out[option]

[option name="log/External/AAALogReader/level"]0[option]

[option name="log/System/Authenticate"]System.out[option]

[option name="log/System/Authenticate/level"]75[option] 4


CiscoWorks NCM Syslog Reader

CiscoWorks NCM uses Syslogs to detect device changes in real-time. Some environments require the Syslog Reader to forward messages from the syslog server to CiscoWorks NCM.

To upgrade the Syslog Reader:


Step 1 Go to /usr/local/rendition/syslogreader/probe.rcx.

Step 2 In the probe.rcx file, make the following changes:

[option name="connect/AppServerURL"]SERVERNAME:1099[/option]

[option name="SyslogReader/LogFile/FileName"]SOMEPATH/FILE[/option]

Step 3 Stop the Syslog Reader.

Step 4 Run /etc/init.d/truecontrol.syslogreader stop.

Step 5 Remove the /usr/local/rendition directory.

Step 6 Follow the install instructions in the ReadMe.txt file.


CiscoWorks NCM Drivers

You must install the latest CiscoWorks NCM Driver Pack after you upgrade to CiscoWorks NCM 1.5.01, otherwise you could experience a regression in functionality. Go to the Cisco Software Download page, http://www.cisco.com/cisco/psn/web/download/index.html, and download the latest CiscoWorks NCM Driver Pack.

CiscoWorks NCM Alert Center

If you are using the CiscoWorks NCM Alert Center 1.3 or earlier release, we recommend that you install the latest CiscoWorks NCM Alert Center release after you upgrade to CiscoWorks NCM 1.5.01 to improve the functionality. You can download the latest CiscoWorks NCM Alert Center release from http://www.cisco.com/cisco/psn/web/download/index.html.

Troubleshooting

If the CiscoWorks NCM 1.5.01 upgrade failed, check the following files for detailed error messages:

1. [Install_Directory]/CiscoWorks_Network_Compliance_Manager_InstallLog.log

2. All files in [Install_Directory]/server/log

If the CiscoWorks NCM 1.5.01 upgrade is successful, but CiscoWorks NCM 1.5.01 does not run, check the following:

1. [Install_Directory]/CiscoWorks_Network_Compliance_Manager_InstallLog.log file

If this file is truncated, this indicates that CiscoWorks NCM 1.5.01 was not allocated enough disk space. Contact your System Administrator to resolve disk space or other hardware issues.

2. [Install_Diretory]/jre folder

If JRE is installed successfully, the folder should contain approximately 600 files. An installation failure will result in less than 100 files. This could occur if Windows Explorer was not closed or other applications were running during the upgrade. Always close the Windows Explorer and all other applications before running the Service Pack Installer.

Running a multi-million record update can take long time and the system may appear hung. Before you cancel the upgrade installer, check the log file. The log file is located in the Installation Directory and is named CiscoWorks_Network_Compliance_Manager_InstallLog.log.

Accessing the CiscoWorks NCM Documentation Set

All or any part of the CiscoWorks NCM documentation set, including this document, might be upgraded over time. Therefore, we recommend that you access the CiscoWorks NCM documentation set using the following URL: http://www.cisco.com/en/US/products/ps6923/tsd_products_support_series_home.html


Tip To cut and paste a two-line URL into the address field of your browser, you must cut and paste each line separately to get the entire URL without a break.


The Docs tab provided in the CiscoWorks NCM UI might not include links to the latest documents.

Obtaining Documentation and Submitting a Service Request

For information on obtaining documentation, submitting a service request, and gathering additional information, see the monthly What's New in Cisco Product Documentation, which also lists all new and revised Cisco technical documentation, at:

http://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html

Subscribe to the What's New in Cisco Product Documentation as a Really Simple Syndication (RSS) feed and set content to be delivered directly to your desktop using a reader application. The RSS feeds are a free service and Cisco currently supports RSS Version 2.0.