Guest

Cisco Transport Manager

Understanding the CTM Patch Process

  • Viewing Options

  • PDF (146.2 KB)
  • Feedback
Understanding the Cisco Transport Manager Patch Process

Table Of Contents

Understanding the Cisco Transport Manager Patch Process

Overview

Determine Whether You Need to Patch the CTM Clients

Verify that CTM Is Running Correctly

Back Up the CTM Server

Verify the Disk Space for the Backup

Back Up and Restore the Database When the CTM ARCHIVELOG Mode Is Enabled

Export and Import the Database When the CTM ARCHIVELOG Mode Is Not Enabled

Verify the CTM Database Backup

Notify CTM Clients Before Shutting Down the CTM Server

Log Out the Remaining CTM Clients

Shut Down the CTM Server, TL1 Clients, and CORBA Clients

Run the Patch Installation Script

Restart the CTM Server

Rediscover the Network

Review the List of NEs in Your Network

Test the TL1, SNMP, or CORBA Gateway Applications

Schedule a Maintenance Window to Back Up the Server

Obtaining Documentation and Submitting a Service Request


Understanding the Cisco Transport Manager Patch Process


February 4, 2008

This document explains the Cisco Transport Manager (CTM) patch process and helps you avoid potential problems while patching your CTM server. You might apply a CTM patch to your current release if:

You need to fix a specific problem you encountered in CTM.

You do not want to wait until the next CTM release to fix a problem.

You want to remain current with the CTM patches that Cisco releases.

Overview

This document describes the generic CTM patch process, which includes the following steps:

Determine Whether You Need to Patch the CTM Clients

Verify that CTM Is Running Correctly

Back Up the CTM Server

Verify the CTM Database Backup

Notify CTM Clients Before Shutting Down the CTM Server

Log Out the Remaining CTM Clients

Shut Down the CTM Server, TL1 Clients, and CORBA Clients

Run the Patch Installation Script

Restart the CTM Server

Rediscover the Network

Review the List of NEs in Your Network

Test the TL1, SNMP, or CORBA Gateway Applications

Schedule a Maintenance Window to Back Up the Server

Determine Whether You Need to Patch the CTM Clients

Refer to the patch readme.txt file to determine whether you need to patch the CTM client software in addition to the server. Most server patches are backward-compatible with the CTM clients. Backward compatibility allows you to patch the CTM server and immediately connect to it with an unpatched CTM client. Generally, client patches are independent of server patches. If you do not patch your client, you will not benefit from any fixes included in the client patch, but you can expect to connect to the server of the same major CTM release level. Determine whether to patch your client software, and plan for the distribution and installation of the client patch, if necessary.

If your client users are widely distributed and the client patch is large, set up an FTP server to distribute the client patch. Notify users via e-mail of the patch availability and installation instructions. Refer to the patch readme.txt file for the installation instructions.

Verify that CTM Is Running Correctly

Before applying a CTM patch, check for any problems in your system. You do not want to discover a problem after the patch is installed and wonder whether the patch caused the problem.

Check the CTM Alarm Browser and verify that there are no CTM EMS alarms. Check the Domain Explorer and note any NEs that are disconnected or out of service. If applicable, verify that your TL1 or CORBA probe is connected and is monitoring the server correctly.

Back Up the CTM Server

You cannot undo the patch command. You will need a backup of the server database in case the patch installation fails, and you will have to reinstall CTM and import or restore the database. Therefore, it is imperative that you back up your server database.

The backup can take up to several hours, depending on the size of your CTM installation (small, medium, large, or high end), the number of NEs in the network, and whether performance monitoring is enabled.

In addition, you must stop the CTM server before applying the patch. When the server restarts, it must rediscover the network, which can take up to several hours depending on the network size and speed.

With a hot backup you can back up the CTM server without having to stop it. A hot backup is recommended to minimize downtime for your network operations center. However, you cannot run a hot backup unless CTM has ARCHIVELOG mode enabled. (ARCHIVELOG mode must be enabled during CTM installation or just prior to a server restart. You cannot enable ARCHIVELOG mode while running CTM and then immediately perform a hot backup. The CTM server must be restarted to enable ARCHIVELOG mode.)

To determine whether ARCHIVELOG mode is enabled on your server, go to the CTM Domain Explorer and choose Administration > Control Panel. In the Database Properties pane, see whether the Enable ARCHIVELOG Mode check box is checked.

Verify the Disk Space for the Backup

Enter the following command to verify that your backup directory has enough disk space to hold a backup:

# df -k

The default backup directory is /ctm_backup. You might have to delete the oldest backup to make room for the new backup.

Back Up and Restore the Database When the CTM ARCHIVELOG Mode Is Enabled

To perform a hot database backup, enter the following commands at the UNIX prompt:

# cd /opt/CiscoTransportManagerServer/bin
# ./backupdb.sh

The hot backup log file is saved under /{oraclesw9i | oracle}/admin/<ORACLE_SID>/udump/ backup_db.log. The log file contains a list of all files that have been backed up. The default Oracle SID is CTM.

If you need to restore the database from a hot backup, enter the following commands at the UNIX prompt:

# cd /opt/CiscoTransportManagerServer/bin
# ./restore_db.sh <backup_file_location> <log_directory>


Note The default backup file location is /ctm_backup.


Export and Import the Database When the CTM ARCHIVELOG Mode Is Not Enabled

If CTM ARCHIVELOG mode is not enabled, you cannot perform a hot backup. Enter the following commands to stop CTM and export the CTM database:

# ctms-stop
# cd /opt/CiscoTransportManagerServer/bin
# ./export_full_db.sh

If necessary, complete the following steps to import the exported database from an export dump:


Step 1 Insert the CTM Server Disk 1 installation CD.

Step 2 Disconnect all of the CTM clients and enter the following command to shut down the CTM server, if it is running:

# ctms-stop

Step 3 Enter the following commands to import the database, where the default backup file location is /ctm_backup:


Caution The import_full_db.sh command overwrites some Solaris system files (/etc/system, /etc/passwd, /etc/group, and /var/opt/oracle/oratab). You should make a copy of each of these files before running the import_full_db.sh command.
# cd /opt/CiscoTransportManagerServer/bin
# ./import_full_db.sh <backup_file_location> <export_dump_filename> <log_directory>


Verify the CTM Database Backup

Complete one of the following options, depending on whether you performed a hot or cold backup:

Hot backup—Check the backup files in the log file and in the database backup directories. The backup_db.log file is saved in the /{oraclesw9i | oracle}/admin/<ORACLE_SID>/udump/ directory. (The default Oracle SID is CTM.) Also, check the name and time stamp on the backup files in the /ctm_backup directory.

Cold backup—The file is exported to the /ctm_backup directory using the filename export_CTM<time_stamp>.dmp. The filename of the log file is export_CTM.log.

Notify CTM Clients Before Shutting Down the CTM Server

Before the start of your scheduled maintenance window, complete the following steps to notify all CTM users that the CTM server will be shut down:


Step 1 In the Domain Explorer window, choose File > Notify Users. The Notify Users dialog box opens.

Step 2 In the Message Targets area, click the All CTM Users radio button.

Step 3 Type the message in the Message area. Customize the message as appropriate for your organization. A sample message might read:

The CTM server will be shut down in 5 minutes. Please log out of the CTM client before 
then.

Step 4 Click Send.

Step 5 Wait an appropriate amount of time for the CTM users to log out.


Log Out the Remaining CTM Clients

Before shutting down the CTM server, complete the following steps to log out any remaining CTM clients:


Step 1 Log into the CTM server using an account with SuperUser privileges.

Step 2 In the Domain Explorer window, choose Administration > CTM Users.

Step 3 In the CTM Users table, choose Administration > Logged In CTM Users.

Step 4 In the Logged In CTM Users table, select a user and choose Administration > Log Out User (or click the Log Out User tool).


Note This menu option is disabled if you selected your own session.


Step 5 Click Yes at the following prompt:

This operation will log out the selected CTM user. The process will take approximately 
1 minute and this CTM client will be unusable until then. Do you wish to continue?

Wait until the CTM server completes the operation. The CTM GUI is frozen for approximately 1 minute until the request is complete. Log out all of the users listed in the Logged In CTM Users table to make sure that all user sessions are terminated.


Shut Down the CTM Server, TL1 Clients, and CORBA Clients

At the start of your maintenance window, enter the following command at the UNIX prompt to shut down the CTM server and the TL1 and CORBA clients, if applicable:

# ctms-stop

It might take 5 to 10 minutes for the CTM server to shut down.

Run the Patch Installation Script

Enter the following commands to run the CTM patch installation script:

# cd <directory_where_the_patch_was_extracted>
# ./server_patch.sh

The script should take several minutes to complete. Watch the patch installation process on your UNIX server. When the installation is complete, you will receive a message that the patch was installed successfully.

Restart the CTM Server


Step 1 Enter the following command to restart the CTM server and the TL1 and CORBA clients, if applicable:

# ctms-start

Wait for the server, TL1, and CORBA services to come up before starting the TL1 and CORBA clients. It might take up to 10 minutes for the services to start.

Step 2 As the root user, enter the following command to view the CTM processes and verify that the new patch level is displayed:

# showctm

Note the new CTM build level shown immediately above the CTM services. The list of CTM services depends on what features you selected when CTM was first installed.


Rediscover the Network

Allow the CTM server to rediscover the entire network. Depending on the size of your network, it might take several hours for the network discovery to complete. If your network contains thousands of nodes, you can speed up the network discovery by running only a few NE services at a time until the NEs are discovered.

Review the List of NEs in Your Network

After all of the NEs reconnect with the CTM server, review the list of NEs to verify that the server has been restored. If you identify a problem with a single NE, mark the NE as Out of Service (in the Network Element Properties pane > Status tab > Operational State field) and click Save. Wait for 8 minutes (two health poll cycles); then, mark the NE as In Service and click Save.

If NEs that are serviced by one NE service still fail to come up, stop and restart the NE service to re-establish the connection to all of the nodes.

Test the TL1, SNMP, or CORBA Gateway Applications

If used, test the TL1, SNMP, or CORBA gateway applications by connecting them to the CTM database.

Schedule a Maintenance Window to Back Up the Server

You have successfully patched your CTM server and verified that it is working.

It is recommended that you now stop your server and perform a backup. Alternately, schedule a maintenance window to perform the backup. It is important to back up the patched version of CTM, because your last backup was an unpatched version. In the event that you need to restore CTM from a backup, you do not want to have to reinstall the patch.

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.