Guest

Cisco Unified Application Environment

Upgrade Guide for the Cisco Unified Application Environment (2.5.1)

  • Viewing Options

  • PDF (190.5 KB)
  • Feedback
Upgrade Guide for the Cisco Unified Application Environment, Release 2.5.1

Table Of Contents

Upgrade Guide for the Cisco Unified Application Environment, Release 2.5.1

Conventions

Upgrading the Cisco Unified Application Environment

Related Documentation

Frequently Asked Questions

Performing Pre-Upgrade Tasks

Upgrading from Release 2.4.x to Release 2.5.1

Installing the Cisco Unified Application Environment Core Addendum

Installing the Cisco Unified Platform Services

Installing the Cisco Unified Application Server

Installing the Cisco Unified Media Engine

Upgrading to Release 2.5.1 from Release 2.2 or 2.3

Performing the Post-Upgrade Tasks

Logging In

Restarting Services

Migrating Backed Up Data

Upgrade Error Messages

Obtaining Documentation and Submitting a Service Request


Upgrade Guide for the Cisco Unified Application Environment, Release 2.5.1


Use this document to upgrade the Cisco Unified Application Environment to Release 2.5.1.

This guide includes the following topics:

Conventions

Upgrading the Cisco Unified Application Environment

Obtaining Documentation and Submitting a Service Request

Conventions

Consider the following documentation conventions as you review this installation document:

Blue Text—To quickly navigate to a section or URL, click text that appears in blue.


Note Reader, take note. Notes contain helpful suggestions or references to material not covered in the publication.



Caution Reader, be careful. You may do something that could result in equipment damage or loss of data.

Upgrading the Cisco Unified Application Environment

This section includes the following topics:

Related Documentation

Frequently Asked Questions

Performing Pre-Upgrade Tasks

Upgrading from Release 2.4.x to Release 2.5.1

Upgrading to Release 2.5.1 from Release 2.2 or 2.3

Performing the Post-Upgrade Tasks

Related Documentation

Table 1 provides links to related documentation.

Table 1 Related Documentation 

Related Information
URL

Cisco MCS data sheets

http://www.cisco.com/en/US/products/hw/voiceapp/ps378/index.html

Cisco MCS Operating system installation documentation

http://www.cisco.com/en/US/docs/voice_ip_comm/cucm/win_os/install/os200312.html

Cisco Unified Application Environment Hardware Compatibility Matrix, Release 2.5.1

http://www.cisco.com/en/US/products/ps7058/products_device_support_tables_list.html

Cisco Unified Application Environment Software Compatibility Matrix, Release 2.5.1

Cisco Unified Application Environment Administration Guide, Release 2.5.1

http://www.cisco.com/en/US/products/ps7058/prod_maintenance_guides_list.html

Cisco Unified Application Environment Installation Guide, Release 2.5.1

http://www.cisco.com/en/US/products/ps7058/prod_installation_guides_list.html

Cisco Unified Application Environment Release Notes, Release 2.5.1

http://www.cisco.com/en/US/products/ps7058/prod_release_notes_list.html

Open Source License Notices for the Cisco Unified Application Environment

http://www.cisco.com/en/US/docs/voice_ip_comm/cuae/openssl_license/cuae_ssllic.html


Frequently Asked Questions

Q. How long does it take to upgrade the Cisco Unified Application Environment from Release 2.4.x to Release 2.5.1?

A. The entire upgrade process, excluding pre-/post-upgrade tasks, takes approximately 1 hour.

Q. How long does it take to upgrade the Cisco Unified Application Environment from Release 2.3 to Release 2.5.1?

A. The entire upgrade process, excluding pre-/post-upgrade tasks, takes approximately 2 hours.

Q. Can I install other software on the server?

A. You may only install supported software applications on the server. If you do not know whether the software application is supported, do not install it on the server.

Q. Do I need to apply hotfixes to my Release 2.4.3 system before upgrading to 2.5.1?

A. No. All the hotfixes have been rolled in to Release 2.5.1.

Performing Pre-Upgrade Tasks

Table 2 describes pre-upgrade tasks.

Table 2 Pre-Upgrade Tasks 

Tasks
Pre-upgrade Tasks
Important Notes

1.

Make sure you have console access to the Cisco MCS server, either directly or using virtual network computing (VNC).

You cannot access the server remotely other than through VNC to perform this installation.

2.

Make sure you have the following documents:

Cisco Unified Application Environment Installation Guide, Release 2.5.1

Cisco Unified Application Environment Administration Guide, Release 2.5.1

See Related Documentation.


Upgrading from Release 2.4.x to Release 2.5.1

You can upgrade to Release 2.5.1 from Release 2.4, 2.4.2 and 2.4.3.


Note You are not required to uninstall the previous version of the Cisco Unified Application Environment before installing this version.


Before You Begin

1. Perform a system back up. (See the Backing Up, Restoring, and Reinitializing the System chapter in the Administration Guide for the Cisco Unified Application Environment listed in Related Documentation.)

2. Go to this URL: http://developer.cisco.com/web/cuae/downloads.

3. Download the following executable files, and save them on your system.

a. CUAE-coreadd-2.5.1.exe (Cisco Unified Application Environment Core Addendum)

b. CUAE-platsvc-2.5.1.exe (Cisco Unified Application Environment Platform Services)

c. CUAE-appserver-2.5.1.exe (Cisco Unified Application Server)

d. CUAE-mediaengine-2.5.1.exe (Cisco Unified Media Engine)

Installing the Cisco Unified Application Environment Core Addendum

To install the Cisco Unified Application Environment Core Addendum, follow these steps:

Procedure


Step 1 Locate and double click this executable file where you downloaded it on your local system: CUAE-coreadd1.exe.

Step 2 Click Run.

The end-user license agreement appears.

Step 3 Read it, and if you agree with the terms, select I Agree.

The Cisco Unified AE OS Addendum Setup dialog box appears with a message indicating that older versions of third-party software has been detected.

Step 4 Click Yes to remove the older versions of the third-party software.

A console appears that indicates progress. The system then reboots, and a Clean-up Utility console appears.


Note You may get a security warning indicating that the publisher could not be verified. Proceed to Step 5.


Step 5 Click Yes to run the Cisco Unified Application Environment Core Addendum software.

The end-user license agreement appears.

Step 6 Read it, and if you agree with the terms, select I Agree.

The Cisco Unified AE OS Addendum Setup dialog box appears.

Step 7 Click OK when prompted to begin the installation setup.

A console appears with output indicating the progress of the installation.

Step 8 Click Close when the output stops and the Close button is no longer grayed out.

A window appears indicating that the installation is complete, and that the server must be rebooted.

Step 9 Click Yes to reboot the server.


Installing the Cisco Unified Platform Services

To install the platform services, follow these steps:

Procedure


Step 1 Locate and double click this executable file where you downloaded it on your local system: CUAE-platsvc-2.5.1.exe.

Step 2 Click Run.

The Cisco Unified Application Environment Platform Services installation wizard appears.

Step 3 Click Next.

The end-user license agreement appears.

Step 4 Read it, and if you agree with the terms, select I accept the terms in the license agreement.

A notice about cryptographic features appears.

Step 5 Read it, and if you agree to comply with the applicable laws and regulations described in the notice, then click Next.

The Create Services User dialog box appears.

Step 6 Enter a password for the Cisco Unified Application Environment service user, then reenter it.


Note Remember this password. You will be prompted for it again to install other services.


Step 7 Click Next. A MySQL Database Server dialog box appears.


Note Do not change the default Database Server or Login ID.


Step 8 Enter the MySQL password; the same one used for Release 2.4.x.

Step 9 Click Next.

Step 10 A Ready to Install the Program dialog box appears.

Step 11 Click Install.

The dialog window indicates progress as the installation proceeds.

Step 12 Click Finish when the installation is complete.


Installing the Cisco Unified Application Server

To install the Cisco Unified Application Server, follow these steps:

Procedure


Step 1 Locate and double click this executable file where you downloaded it on your local system: CUAE-appserver-2.5.1.exe.

Step 2 Click Run.

The Cisco Unified Application Environment Application Server installation wizard appears.

Step 3 Click Next.

The end-user license agreement appears.

Step 4 Read it, and if you agree with the terms, select I accept the terms in the license agreement.

Step 5 Click Next.

A notice about cryptographic features appears.

Step 6 Read it, and if you agree to comply with the applicable laws and regulations described in the notice, then click Next.

The Service User Password dialog box appears.

Step 7 Enter the password for the Cisco Unified Application Environment service user.

This is the password you created in Step 6 of Installing the Cisco Unified Platform Services.

Step 8 Click Next.

Step 9 A Ready to Install the Program dialog box appears.

Step 10 Click Install.

A dialog will indicate when the installation is complete.

Step 11 Click Finish.

Step 12 A dialog appears asking if you want to restart the system.

Step 13 If you are not going to instal a Cisco Unified Media Engine, click Yes. Otherwise, click No, and proceed with the Cisco Unified Media Engine installation.


Installing the Cisco Unified Media Engine

To install the Cisco Unified Media Engine, follow these steps:

Procedure


Step 1 Locate and double click this executable file where you downloaded it on your local system: CUAE-mediaengine-2.5.1.exe.

Step 2 Click Run.

Step 3 If you do not have the Nuance OpenSpeech Recognizer 3.0 installed on the server, a prompt appears asking if you want to install it. Click Install.

Step 4 If you already have the Nuance OpenSpeech Recognizer 3.0 installed, the Cisco Unified Application Environment Media Engine installation wizard appears. Click Next.

The end-user license agreement appears.

Step 5 Read it, and if you agree with the terms, select I accept the terms in the license agreement.

Step 6 Click Next.

A notice about cryptographic features appears.

Step 7 Read it, and if you agree to comply with the applicable laws and regulations described in the notice, then click Next.

The Service User Password dialog box appears.

Step 8 Enter the password for the Cisco Unified Application Environment service user.

This is the password you created in Step 6 of Installing the Cisco Unified Platform Services.

Step 9 Click Next.

Step 10 A Ready to Install the Program dialog box appears.

Step 11 Click Install.

A dialog box indicates when the installation is complete.

Step 12 Click Finish.

A dialog appears indicating that you must restart the system for the changes to take effect.

Step 13 Click Yes.


Upgrading to Release 2.5.1 from Release 2.2 or 2.3

You can upgrade to Release 2.5.1 from Release 2.2 or 2.3.

Before You Begin

1. Go to this URL: http://developer.cisco.com/web/cuae/downloads.

2. Download the following executable files, and save them on your system.

a. CUAE-lbt-2.5.x.exe

a. CUAE-coreadd-2.5.1.exe (Cisco Unified Application Environment Core Addendum)

b. CUAE-platsvc-2.5.1.exe (Cisco Unified Application Environment Platform Services)

c. CUAE-appserver-2.5.1.exe (Cisco Unified Application Server)

d. CUAE-mediaengine-2.5.1.exe (Cisco Unified Media Engine)

To upgrade the Cisco Unified Application Environment to Release 2.5.1 from Release 2.2 or Release 2.3, follow these steps:

Procedure


Step 1 Locate and double click this executable file where you downloaded it on your local system: CUAE-lbt-2.5.x.exe.

A window appears asking where to install the tool.

Step 2 Select the default location: C:\Program Files\Metreos.

Step 3 Click Install.

Step 4 Use the server console or VNC to open a command window.

Step 5 Navigate to the location on the server where you have saved the executable file, then enter the following command:

cuae-legacy-backup.exe [-u database_user] [-p database_password] [-l path_to_environment] [ +database_name ...]

where

-u is root for both Release 2.2 and Release 2.3

-p is metreos for Release 2.2, and is the administrative password you designated for Release 2.3

-l is C:\metreos for Release 2.2, and C:\Program Files\metreos for Release 2.3

+database_name is the name of a database you want to backup in addition to the system database.

In general, if you have any applications that use their own, customized MySQL database on the server, you will need to specify their database names. Check with the developers who created the applications that are installed on the system to find out if there are custom databases associated with the applications, and whether they should be backed up.


Note Arguments with spaces in their names must have double quotes around them.


For example:

A Release 2.2 server with an additional applications database called application_suite is e entered as follows: cuae-legacy-backup.exe -u root -p metreos -l c:\metreos +application_suite

A Release 2.3 server with no additional application databases and a password for the database named cisco is entered as follows: cuae-legacy-backup.exe -u root -p cisco -l "c:\Program Files\Metreos"

The database is backed up and a folder named Backup is created in the location where you downloaded the cuae-legacy-backup.exe on your server.

Step 6 Save the Backup folder in a location other than the server. You will need the back up file after you have upgraded to Release 2.5.1.


Caution The next step reinstalls the operating system and all existing data on the server is removed. Before starting Step 7, make sure you saved your configuration in a location other than the server (see Step 5 and Step 6). In addition, make sure you have the DVD with the Cisco OS that was shipped with your server.

Step 7 Insert the Cisco OS DVD, shipped with your Cisco MCS server, then reboot the server.

On reboot, the operating system is reinstalled. (For additional information, see the Cisco MCS Server Operating system installation documentation at the following URL: http://www.cisco.com/en/US/docs/voice_ip_comm/cucm/win_os/install/os200312.html


Note You can not apply the Release 2.5.1 installers on a Release 2.2 or Release 2.3 system. The Release 2.5.1 installers must be run on a clean server.


Step 8 Install the Cisco Unified Application Environment, Release 2.5.1. See Installing the Cisco Unified Application Environment, Release 2.5.1 at the following URL: http://www.cisco.com/en/US/products/ps7058/prod_installation_guides_list.html

Step 9 After you finish the installation and the post-installation tasks, make sure you migrate your backed up data. See Migrating Backed Up Data.


Performing the Post-Upgrade Tasks

This section includes:

Logging In

Restarting Services

Migrating Backed Up Data

Logging In

To log in to the Cisco Unified Application Environment Administration, follow these steps:

Procedure


Step 1 In the address bar of the web browser, enter the following URL: http://<serverIPaddress>/cuaeadmin.

The End User License Agreement appears.

Step 2 Read it, then click I Agree.

A page to set the Administrator and Cisco Unified Media Engine passwords appears.

Step 3 Enter an administrator password, then re-enter it.

Step 4 Enter a Cisco Unified Media Engine password, then re-enter it.

Step 5 Click Set Passwords.

A confirmation appears indicating that the password setup is complete.

Step 6 To log in, click Log in to the administrator console.

Step 7 The Cisco Unified Application Environment Administration login page appears.

Step 8 Enter the username administrator and the password you set in Step 3.


Restarting Services

To ensure that the Cisco Unified Application Server re-verifies the status of the Cisco Unified Application Environment components, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment Administration.

Step 2 Select Serviceability > Services.

Step 3 Select Application Server, then click Restart.


Migrating Backed Up Data


Note Before performing this task, make sure that the upgrade to Release 2.5.1 is successful, and that you have accessed and logged into the Cisco Unified Application Environment management console.


To restore your backed up data on the upgraded Release 2.5.1 Cisco MCS server, follow these steps:

Procedure


Step 1 Place the Backup folder anywhere on the upgraded Cisco MCS server.

Step 2 Log in to the Cisco Unified Application Environment Administration.

Step 3 Choose Serviceability > Services., then stop all the services.

Step 4 Use the server console or VNC to open a command window.

Step 5 Enter this command to access the correct directory:

C:\Program Files\Cisco Systems\Unified Application Environment\Framework\1.0


Note Arguments with spaces in their names must have double quotes around them.


For example:

cd "c:\Program Files\Cisco Systems\Unified Application Environment\Framework\1.0"

Step 6 Enter the following command to restore the data:

cuae-restore.exe [path_to_backup_file]

where path_to_backup_file is the location of the file generated by the cuae-legacy-backup tool, which is located in the Backup folder on the server.

For example, if you want to restore a file called backup1.cuae located inthe C:\Program Files\Cisco Systems\Unified Application Environment\Backups folder, enter:

cuae-restore.exe "C:\Program Fil"s\Cisco Systems\Unified Application Environment\Backups\backup1.cuae"

Step 7 Enter the following command to test the upgrade:

cuae-dbtool.exe -t upgrade

If the test is successful, the following message appears "The trial run was successful," and you can proceed to Step 8.

If the test fails, the following error message appears "The trial run failed." Contact the Cisco Technical Assistance Center (TAC). For a complete list of Cisco TAC contacts, go to this URL: http://www.cisco.com/techsupport/contacts.

Step 8 Enter the following command to migrate the data:

cuae-dbtool.exe upgrade

If the migration is successful, the following message appears "The migration was successful," and you can proceed to Step Step 9.

If the migration fails, the following error message appears "The migration failed." Contact the Cisco Technical Assistance Center (TAC). For a complete list of Cisco TAC contacts, go to this URL: http://www.cisco.com/techsupport/contacts.

Step 9 If this upgraded server is a Cisco Unified Media Engine, then you must reset the password. From the Cisco Unified Application Environment Administration, select System > Global Parameters, and under Media Engine enter a password.


Note You must also enter the same password under Choose System > Global Parameters on any Cisco Unified Application Servers that use this Cisco Unified Application Media Engine. This enables the application servers to communicate with the media engine.


Step 10 Select Serviceability > Services, and restart all the services.


Upgrade Error Messages

Table 3 describes error messages that might be displayed in the dialog boxes and log files during upgrade.

You can obtain and review the log files from these locations:

C:\2.5.1.xxxx-core-addendum-installer.log

C:\2.5.1.xxxx-cisco_unified_application_environment_application server-install.log

C:\2.5.1.xxxx-cisco_unified_application_environment_media_engine-install.log

C:\2.5.1.xxxx-cisco_unified_application_environment_platform_services-install.log

Table 3 Upgrade Error Messages 

Error Message
Probable Cause
Corrective Action

No migration path is defined for starting version.

The migration failed.

You did not run the cuae-restore.exe on the server.

Make sure you have entered the correct command to restore the data.

See Migrating Backed Up Data.

Cisco Unified Application Environment Platform Services 2.5.1 or later must be installed.

You attempted to upgrade the CiscoUnified Application Server or Cisco Unified Media Engine before upgrading the Cisco Unified Platform Services.

Upgrade the platform services first


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.