Tip Before you upgrade Cisco UGM, locate these documents:
- Cisco Universal Gateway Manager Installation, Upgrade, and Troubleshooting Guide, Version 2.0 (this document)
- Cisco Element Management Framework Installation and Administration Guide, Version 3.2
During the upgrade process, Cisco UGM cannot perform system management functions.
The Cisco UGM upgrade and migration process consists of:
Automated scripts:
installUpgradeQuery, runASUpgradeParser, runASupgradeQuery—These scripts query the data in order to upgrade the Physical, NAS-File-Repository, and Trap Forwarding views. Run these scripts in the Cisco UGM 1.0 environment.
runASUpgradeObjectSpecParser, installDataMigration, runASMigrationParser, and runASDataMigration—These scripts upgrade the Physical, NAS-File-Repository, and Trap Forwarding views, and migrate data for the performance polling and file export configuration dialogs. Run these scripts in the Cisco UGM 2.0 environment.
Manual operations where you create directories and copy files for transfer.
These sections describe the data that is transferred from Cisco UGM 1.0 to Cisco UGM 2.0:
The upgrade process transfers these objects from the Cisco UGM 1.0 Physical view to the Cisco UGM 2.0 Physical view:
Sites, regions, and bays.
All devices supported in Cisco UGM 1.0 (Cisco AS5350, AS5400, AS5800, and AS5850).
Note The Cisco UGM 1.0 names and hierarchy of the devices are maintained in the
transfer. If required, you can change the names manually in Cisco UGM 2.0.
Note that subsequent device discoveries in Cisco UGM 2.0 will preserve the
Cisco UGM 1.0 (or manually assigned) names for these devices.
Table 2-1 lists the Physical view attributes that are transferred.
Table 2-1 Objects and Attributes Transferred for Physical View Upgrade
Object
Attribute
Site
AV-SITE-MIB.contact1Name
AV-SITE-MIB.contact1Phone
AV-SITE-MIB.contact1Pager
AV-SITE-MIB.contact1Email
AV-SITE-MIB.sitePhone
AV-SITE-MIB.siteFAX
AV-SITE-MIB.siteAddress
AV-SITE-MIB.siteCity
AV-SITE-MIB.siteState
AV-SITE-MIB.siteZIP
AMAF-MGMT-MIB.Comment
Region/Bay
AMAF-MGMT-MIB.Comment
AS5xxxChassis
AMAF-MGMT-MIB.ipaddress
ASMainCtrl-MIB.IOSCommand5xxx
CISCO-ENVMON-MIB.ciscoEnvMonSupplyStatusTable
CISCO-MEMORY-POOL-MIB.ciscoMemoryPoolTable
SNMP-ATTRIBUTES-MIB.snmpv1-read-community
SNMP-ATTRIBUTES-MIB.snmpv1-write-community
SNMP-ATTRIBUTES-MIB.snmpv2c-read-community
SNMP-ATTRIBUTES-MIB.snmpv2c-write-community
SNMP-ATTRIBUTES-MIB.snmp-version
CommonCtrl-MIB.enablePassword
CommonCtrl-MIB.userId
CommonCtrl-MIB.userPassword
CommonCtrl-MIB.verifyEnablePassword
CommonCtrl-MIB.verifyUserPassword
IOSFmgrCtrl-MIB.configContainmentPath
IOSFmgrCtrl-MIB.configPath
IOSFmgrCtrl-MIB.IOSImageContainmentPath
IOSFmgrCtrl-MIB.IOSImagePath
IOSFmgrCtrl-MIB.SPEImageContainmentPath
IOSFmgrCtrl-MIB.SPEImagePath
IOSFmgrCtrl-MIB.modemImageContainmentPath
IOSFmgrCtrl-MIB.modemImagePath
Example of Physical Tree Data Transferred (objectSpecPhysical)
Generic objects that are not a site, bay, or region.
Chassis attributes that are not listed in Table 2-1.
Note SNMP attributes, generic controller attributes, and Cisco EMF internal
attributes will be set by Cisco UGM 2.0.
Overview of Upgrading Cisco UGM on a Single Server
Caution Before starting the upgrade process, ensure that user-created object names in the Cisco UGM 1.0 Map View do not have any spaces in them. If any object names contain spaces, manually rename those objects by replacing the spaces with underscores.
Example: Site A1 should be changed to Site_A1.
In order to upgrade your version of Cisco UGM on a server while preserving device and database information, complete these task sequences:
The utility goes through all the views to be transferred, gets information, and creates the corresponding object spec (specification) files and the data migration file (dataPerfPollFileExport) for performance polling and file export dialogs.
Step 2 Enter the complete path of the directory where the object spec files and data migration files will be created.
Example:
/opt/ini
Note Enter the complete path for this directory.
If the /opt level of the path does not exist, this operation fails.
If the /ini directory does not exist, the script creates it.
Step 3 Enter the complete path of the directory where the IOS and configuration files will be preserved.
Example:
/opt/ios
Note Enter the complete path for this directory.
If the /opt level of the path does not exist, this operation fails.
If the /ios directory does not exist, the script creates it.
A summary of created objects spec file information appears.
Note
If the query utility cannot get information on an attribute it proceeds to the next attribute. (The unattainable attribute is missed in the upgrade and migration process.)
The operation fails if there are problems with either initialization or the specified path.
You must be able to reach all devices in the Physical tree.
Tip If errors occur, check the runASUpgradeQuery.log file or the process log file (<CEMF_ROOT>/bin/logs/ASUpgradeQuery.log).
Task 6: (Optional): Verifying the Contents of a File
This task allows you to check the number of objects in the Physical tree, NAS-File-Repository, and Trap Forwarding tree, and compare these results with the summary displayed in the "Task 5: Running the ASUpgradeQuery Utility" section.
Step 1 Verify that the query utility worked without errors and that the number of objects in the Summary of created objects spec file information corresponds to the number of objects from each Cisco UGM 1.0 view that was transferred. Enter:
Step 2 Check the contents of the directories where the object spec files and data migration file were created, and verify if the IOS, SPE, modem images, and Configuration files were preserved:
Note You must run the uninstall script from the directory where the script is located.
Step 1 Verify that you have exited from all Cisco EMF sessions.
Step 2 Insert the Cisco Universal Gateway Manager CD-ROM.
Step 3 Change to the CD-ROM drive and enter:
./removeEMS
This script removes Cisco UGM Version 1.0. You can specify several options with this command. (Refer to the Cisco Element Management Framework Installation and Administration Guide.)
Tip If the uninstallation fails, check the log file lluninstall.log in the /tmp directory to identify the problem.
Task 8: Moving the Cisco EMF License File
Step 1 Create a directory outside the <CEMF_ROOT> structure.
Example:
/opt/lic
Step 2 Copy the <license>.lic file (from /opt/cemf/config/licenses ) to this directory.
Task 9: Resetting the Database
Step 1 Log in as a root user.
Step 2 Change to the following directory:
cd /opt/cemf/bin
Step 3 Enter the following command to stop Cisco EMF:
./cemf stop
Step 4 Enter the following command to reset the Cisco EMF database:
./cemf reset
Step 5 Enter Y(yes) to the query.
Task 10: Uninstalling Cisco EMF Patch 12
Caution The order in which components are removed is important. You must uninstall patch 12; then uninstall Cisco EMF itself.
Step 1 As a superuser (su), log in to the machine where Cisco EMF is installed.
Step 2 Ensure that Cisco UGM has been uninstalled.
Step 3 At the command line prompt, change to the directory from where patch 12 has been installed, and enter:
./cemfinstall -remove
Step 4 Choose an option from the menu.
For more details, see the Cisco Element Management Framework Installation and Administration Guide.
Task 11: Uninstalling Cisco EMF 3.04
Step 1 At the command line prompt, change to the directory from where CEMF 3.04 is installed and enter:
./cemfinstall -remove
Step 2 Choose an option from the menu.
For more details, refer to the Cisco Element Management Framework Installation and Administration Guide.
Troubleshooting Uninstalling Cisco UGM
You may have difficulty uninstalling Cisco UGM 1.0 for these reasons:
Your temporary license ended and you cannot start Cisco EMF.
Cisco UGM 1.0 stopped operating.
If either of these conditions exists, uninstall each individual element package.
The names of the server packages are:
ASMainEMm
IOSCfgm
The names of the client packages are:
ASMainEMc
IOSCfgc
Follow this procedure to uninstall individual element packages:
Step 1 Remove the element package registration from Cisco EMF by entering:
The summary includes the number of objects that were created for each view, and the number of objects that were not created for each view.
Tip If errors occur, check the runASUpgradeObjectSpecParser.log file created in the same working directory.
At this time, Cisco UGM 2.0 discovers device components to resynchronize the components view between the system and network, deploys NAS-File-Repository objects, and creates the Configuration File objects under the ConfigFile folders for each device in the Physical view.
Note If a folder in Cisco UGM 1.0 is empty, the corresponding folder is not created
in Cisco UGM 2.0.
Task 16: Migrating Performance Polling and File Export Configuration Data
Step 2 Run the installation script for data migration:
./installDataMigration
The script copies all the .ini, data, and binary files into the appropriate directories.
Tip If errors occur, check the log file (installDataMigration.log) created in the same working directory. See an example of this log file in the "Sample installDataMigration.log File" section.
Step 3 Run the object file parser to create an object associated with the data migration process. Enter:
./runASDataMigrationParser
Tip If errors occur, check the log file (runASDataMigrationParser.log) created in the same working directory. See an example of this log file is shown in the "Sample runASDataMigrationParser.log File" section.
Step 4 Run the data migration process for performance polling and file export data dialogs. Enter:
./runASDataMigration
Step 5 Enter the path to the directory where the data migration file resides:
To terminate the upgrade at any time and revert to the older versions of the software, you must still follow the same sequence of installation but in reverse order.
For example, if you have completed all the tasks before installing Cisco UGM 2.0 and want to terminate this installation and revert to Cisco UGM 1.0, follow these steps:
1. Uninstall Cisco UGM 2.0
2. Save the license file
3. Uninstall Cisco EMF Patch1.1
4. Uninstall Cisco EMF Patch1
5. Uninstall Cisco EMF 3.2
6. Install Cisco EMF 3.04
7. Install Cisco EMF Patch 12
8. Reset the database
9. Install Cisco UGM 1.0
10. Restore the Cisco UGM 1.0 backed-up database
Tip Enter the following command to restore a backed up version of the database:
Note In order to run two versions of Cisco UGM, you must run two versions of
Cisco EMF. Before starting this installation, make sure that you have two
Cisco EMF licenses.
To upgrade and migrate data between the servers, complete these tasks:
Preparing Files for Transfer from the Cisco UGM 1.0 Server
Caution Before starting the upgrade process, ensure that user-created object names in the Cisco UGM 1.0 Map View do not have any spaces in them. If any object names contain spaces, manually rename those objects by replacing the spaces with underscores.
Example: Change Site A1 to Site_A1.
Task 4: Creating a Working Directory in Cisco UGM 1.0
Step 1 Create a temporary directory (not under the <CEMF_ROOT> directory) to store the upgrade and migration files.
Example:
mkdir /opt/installUpg
The files in this directory are binary files, data files, .ini files, and running script files.
Step 2 Copy or transfer the contents of the UGM 2.0 directory ASUpgradeMigration into the temporary working directory created in Step 1.
Task 5: Backing Up the Cisco UGM 1.0 Database
Step 1 Log in as a root user.
Step 2 Change to the bin directory of Cisco EMF.
Example:
cd /opt/cemf/bin
Step 3 To run the backup script, enter:
./cemf backup
This command backs up the databases currently in <CEMF_ROOT>/AVBackup.
The utility goes through all the views to be transferred, gets information, and creates the corresponding object spec (specification) files and the data migration file (dataPerfPollFileExport) for performance polling and file export dialogs.
Step 2 Enter the complete path of the directory where the object spec files and data migration files will be created.
Example:
/opt/ini
Note If the /opt level of the path does not exist, this operation fails.
If the /ini directory does not exist, the script creates it.
Step 3 Enter the complete path of the directory where the IOS and configuration files will be preserved.
Example:
/opt/ios
Note If the /opt level of the path does not exist, this operation fails.
If the /ios directory does not exist, the script creates it.
A summary of created objects spec file information appears.
Note
If the query utility cannot get information on an attribute, it proceeds to the next attribute. (The unattainable attribute is missed in the upgrade/migration process.)
The operation fails if there are problems with either initialization or the specified path.
You must be able to reach all devices in the Physical tree.
Tip If errors occur, check the runASUpgradeQuery.log file or the process log file (<CEMF_ROOT>/bin/logs/ASUpgradeQuery.log).
Task 9: (Optional) Verifying the Contents of a File
This task allows you to check the number of objects in the Physical tree, NAS file repository, and Trap Forwarding tree, and compare these results with the summary displayed in the "Task 8: Running the ASUpgradeQuery Utility" section.
Step 1 Verify that the query utility worked without errors and that the number of objects in the Summary of created objects spec file information corresponds to the number of objects from each Cisco UGM 1.0 view that was transferred. Enter:
Step 2 Check the contents of the directories where the object spec files and data migration file were created, and verify if the IOS/SPE/Modem images and Configuration files were preserved:
Example:
ls /opt/ini
ls /opt/ios
Transferring Data and Software to the Cisco UGM 2.0 Server
Task 10: Creating a Working Directory on the Cisco UGM 2.0 Server
Step 1 Create a temporary directory (not under <CEMF_ROOT>) where the upgrade/migration files will be stored.
Example:
mkdir /opt/installUpg
The files in this directory are binary files, data files, .ini files, and running script files.
Step 2 Copy or transfer the contents of the Cisco UGM 2.0 ASUpgradeMigration directory into this temporary working directory.
Task 11: Transferring Upgrade and Migration Data from the Cisco UGM 1.0 Server to the Cisco UGM 2.0 Server
Step 1 Create a directory on the Cisco UGM 2.0 server to hold the object spec files and the data migration file that were created on the Cisco UGM 1.0 server. (See the "Task 8: Running the ASUpgradeQuery Utility" section.)
Step 2 Copy or transfer the contents of the directory on the Cisco UGM 1.0 server to the directory (of the same name) on the Cisco UGM 2.0 server.
Step 3 Create a directory on the Cisco UGM 2.0 server to hold the IOS, SPE, modem image, and configuration files from the Cisco UGM 1.0 directory created in the "Task 8: Running the ASUpgradeQuery Utility" section.
Step 4 Copy or transfer the contents of the directory on the Cisco UGM 1.0 server to the directory (of the same name) on the Cisco UGM 2.0 server.
Tip When transferring data, remember that the image files (IOS, SPE, modem) are in binary format, whereas the configuration files are in ASCII format.
If you plan to use the UNIX ftp utility, specify the transfer as binary by entering binary at the ftp command prompt. This transfer setting works for the ASCII transfer of configuration files as well.
Task 12: Upgrading the Physical, NAS-File-Repository, and Trap Forwarding Views
The summary includes the number of objects created for each view, and the number of objects that were not created.
Tip if errors occur, check the runASUpgradeObjectSpecParser.log file created in the same working directory.
At this time, Cisco UGM 2.0 discovers device components to resynchronize the components view between the system and network, deploys NAS-File-Repository objects, and creates the Configuration File objects under the ConfigFile folders for each device in the Physical view.
Note If a folder in Cisco UGM 1.0 is empty, the corresponding folder is not created
in Cisco UGM 2.0.
Task 13: Migrating Performance Polling and File Export Configuration Data
Step 2 To run the installation script for data migration, enter:
./installDataMigration
The script copies all the .ini, data, and binary files into the appropriate directories.
Tip If errors occur, check the log file (installDataMigration.log) created in the same working directory. See an example of this log file in the "Sample installDataMigration.log File" section.
Step 3 To run the object file parser to create an object associated with the data migration process, enter:
./runASDataMigrationParser
Tip If errors occur, check the log file (runASDataMigrationParser.log) created in the same working directory. See an example of this log file in the "Sample runASDataMigrationParser.log File" section.
Step 4 To run the data migration process for performance polling and file export data dialogs, enter:
./runASDataMigration
Step 5 Enter the path to the directory where the data migration file resides:
Task 14: Comparing the Directories on the Two Servers
Verify that the files were transferred successfully by comparing the number of files and their sizes on the two servers.
Examining Log Files Created by the Upgrade/Migration Process
This section contains examples of log files created during the Cisco UGM upgrade and migration process. Check these log files to verify the success of process operations or to troubleshoot failures.
Log File Created During the Data Query Utility Installation
The installASUpgradeQuery.log file is created during the installation of the data query utility.
File /opt/cemf/queryAttr/ASUpgradeQueryAttr does exist
File /opt/cemf/bin/ASUpgradeQueryAttrCorresp does exist
Run execution for Upgrade Query files started. Please, wait ...
Summary of created objects spec file information
================================================
Physical Tree:
Number of Sites = 5
Number of Bays = 3
Number of Regions = 3
Number of Chassises = 9
NAS-File-Repository Tree:
Number of IOS Images = 2
Number of Modem Images (not including the duplicated ones) = 2
Number of SPE Images (not including the duplicated ones) = 2
Number of Config Files (only the associated ones) = 2
When more than one managed device used the same modem or SPE image, Cisco UGM 1.0 stored more than one copy of the image under the device view in Map Viewer.
However, since the Map Viewer in Cisco UGM 2.0 stores all modem images in one folder and all SPE images in another folder, duplicate copies of images are not stored.
The number of modem and SPE images that are followed by the "(not including the duplicated ones)" statement represent the number of unique (not duplicated) images transferred to Cisco UGM 2.0.
*Note: Number of duplicated Modem Images = 2
Number of duplicated SPE Images = 2
Duplicated Modem/SPE images are not subject to upgrade
This note in the log file shows the number of duplicate images (in Cisco UGM 1.0) that were not transferred to Cisco UGM 2.0.
Exe File Name To Run [0] = /opt/cemf/bin/shellRun /opt/cemf/bin/objectFileParser
On File = /opt/cemf/config/configuration/objectSpecifications/S81ASDataMigrationDataAbstractor
###########################################
List of results for file running operation
###########################################
Exe File Name To Run [0] = /opt/cemf/bin/shellRun /opt/cemf/bin/objectFileParser
On File = /opt/cemf/config/configuration/objectSpecifications/S81ASDataMigrationDataAbstractor
Successfully run the exec file /opt/cemf/bin/shellRun /opt/cemf/bin/objectFileParser on file /opt/cemf/config/configuration/objectSpecifications/S81ASDataMigrationDataAbstractor
Successfully parsed the Data Migration configuration file
Sample runASDataMigration.log File
AV_ROOT = /opt/cemf
Directory /tmp/ini does exist - ok
###############################
List of command line arguments
###############################
Number of command line arguments equal to 1
Argument [0] = /tmp/ini/dataPerfPollFileExp
###########################################
List of results for testing file presence
###########################################
Run execution for Data Migration started. Please, wait ...
****************LIST OF ATTRIBUTES AND THEIR VALUES*******************
Exe File Name To Run [0] = /opt/cemf/bin/shellRun /opt/cemf/bin/objectFileParser
On File = /opt/cemf/config/configuration/objectSpecifications/S81ASUpgradeQueryDataAbstractor
###########################################
List of results for file running operation
###########################################
Exe File Name To Run [0] = /opt/cemf/bin/shellRun /opt/cemf/bin/objectFileParser
On File = /opt/cemf/config/configuration/objectSpecifications/S81ASUpgradeQueryDataAbstractor
Successfully run the exec file /opt/cemf/bin/shellRun /opt/cemf/bin/objectFileParser on file /opt/cemf/config/configuration/objectSpecifications/S81ASUpgradeQueryDataAbstractor
Successfully parsed the Upgrade Query configuration file
