Upgrade Guide for Cisco Unified Communications Manager, Release 9.0(1)
Before you begin
Downloads: This chapterpdf (PDF - 1.34MB) The complete bookPDF (PDF - 2.76MB) | Feedback

Before you begin

Contents

Before you begin

This chapter discusses how you should prepare to upgrade to a new release of the IM and Presence Service.

Read this first

Read the following important notes before you begin an upgrade.


Warning


Do not make any changes to IM and Presence configuration during an upgrade. If data is written to the database during the upgrade, the upgrade may fail.



Warning


Do not delete any users during the time that you initiate a standard upgrade and switch to the new software version. Deleting users on Cisco Unified Communications Manager (Unified CM) during this time period causes the migration of the UC Profile data from Cisco Unified Presence to Unified CM to fail.

Also, during the time that you initiate a standard upgrade and switch to the new software version, do not perform an LDAP sync that may delete users because this action will cause the migration of the UC Profile data to fail.


  • All refresh upgrades must be performed during a maintenance window because the system will not be available during the upgrade.
  • If you cancel an upgrade at any stage, or if an upgrade fails, you must reboot the IM and Presence server before you attempt another upgrade.

System availability after upgrade

For standard upgrades, when you activate the upgraded software, the system restarts and is out of service for up to 30 minutes on the publisher node, depending on the size of the database. The length of the outage on subscriber nodes depends on how long database replication takes to complete.

If you need to revert to an earlier software version, you must restart the system which results in a similar service outage period.

Support for intercluster peers

This release of IM and Presence supports intercluster peers to clusters running Cisco Unified Presence Release 8.6 and IM and Presence Release 9.x. Intercluster peers to clusters running Release 8.0(x) or Release 8.5(x) are not supported.

Multi-node clusters

If you have an IM and Presence cluster comprising multiple nodes, you must upgrade all nodes in the cluster. If you have a multi-node cluster, you must upgrade the publisher node prior to upgrading the subscriber nodes. Also, you cannot perform a fresh installation on the publisher node and then perform an upgrade on subscriber nodes.

Presence Data Loss After Upgrade Cisco Unified Business Edition 5000 to Cisco Unified Communications Manager

There is no upgrade path in VMware to upgrade from Cisco Unified Business Edition 5000 to Cisco Unified Communications Manager. A fresh installation is needed. After you perform the fresh installation, IM and Presence Service re-synchronizes data with the new Cisco Unified Communications Manager. The Syncagent uses the primary key (pkid) as a comparison field for the synchronization. When the Cisco Unified Communications Manager is re-installed, all the pkid on Cisco Unified Communications Manager are changed. As such, any existing data on IM and Presence Service is cleaned up and the Syncagent deletes the old data. Be sure to backup your data before performing this procedure.

Types of upgrades

You can install upgrade software on your server while the system continues to operate. There are two types of upgrades:

  • standard upgrades—upgrades which do not upgrade the operating system or require multiple reboots during installation
  • refresh upgrades—upgrades which require multiple reboots during installation to upgrade the underlying operating system

The server automatically determines whether you need to perform a standard upgrade or a refresh upgrade.


Note


  • All upgrades to IM and Presence from Cisco Unified Presence Release 8.6(3) or earlier are refresh upgrades.
  • All refresh upgrades must be performed during a maintenance window because the system will not be available during the upgrade.

Standard upgrades

For standard upgrades, when you install upgrade software, you install the software as an inactive version. The system continues to function normally while you are installing the software. When the upgrade is complete, you can choose to automatically reboot the system to the upgraded software or you can manually switch to the new software at a later time. When you reboot to the new software, the old software version remains on the system. This allows you to switch back to the old version in the unlikely event of issues with the new software. During an upgrade your configuration information migrates automatically to the upgraded version.


Note


You can only make changes to the database on the active software. The database for the inactive software is not updated. If you make changes to the database after an upgrade, you must repeat those changes after switching to the new software.


Refresh upgrades


Note


You must perform all refresh upgrades during a maintenance window because the system will not be available during the upgrade.


For refresh upgrades, the system allows you to choose whether or not to automatically run the new upgrade software when the upgrade completes. If you select not to run the new software, the system will reboot to the old software version when the upgrade is complete and you can manually switch to the new software at a later time. Refresh upgrades differ from standard upgrades because with refresh upgrades the system reboots if you want to continue to run the old software version; the system does not need to reboot to switch to the new version.

If for any reason you decide to revert to the prior software version, you can switch versions to the older version of the software. This switch version requires a reboot. Be aware that any configuration changes that you made after upgrading the software will be lost.

If you downgrade to Cisco Unified Presence Release 8.6(3) or earlier, you must install a COP file after you switch to the older software version.


Note


If you deploy MCS-7825-H3 or MCS-7828-H3 servers you cannot revert to the prior version; you must perform a fresh installation.


Related References

Refresh upgrade overview

If required, the server automatically determines if you need to perform a standard upgrade or a refresh upgrade. A refresh upgrade is required when upgrading to IM and Presence from a release earlier than Cisco Unified Presence Release 8.6(4). You can initiate standard and refresh upgrades in the same way using the Command Line Interface or the Cisco Unified IM and Presence Operating System Administration GUI.

A refresh upgrade has the following differences from a standard upgrade:
  • multiple reboots as part of the upgrade
  • once started, the console displays status information similar to that of a fresh installation
  • 16GB USB Flash Drive is required for MCS-7825-H3 and MCS-7828-H3 DRS backup. Do not remove the USB key until the upgrade (data migration) is complete
  • COP file installation is required for upgrades from releases 8.0(1) through to 8.6(1)
  • different options to switch versions following completion of the upgrade
  • e-mail notification is sent upon successful completion of the upgrade

Tip


Several reboots will occur during a refresh upgrade, therefore, you must perform a refresh upgrade during a maintenance window.


In a standard upgrade, you are prompted to either Reboot to upgraded partition or Do not reboot after upgrade. The Reboot to upgraded partition option forces a reboot. This option is required to switch the node to the new software release.

In a refresh upgrade, you are prompted to select one of the following options:
  • Switch to new version after upgrade—no reboot required
  • Do not switch to new version after upgrade—reboot required

If you want to remain on the upgraded software version, select the Switch to new version after upgrade option.

If you want the system to automatically reboot and switch back to the old software version, select the Do not switch to new version after upgrade option.

You can select the Do not switch to new version after upgrade option to perform a staged upgrade. An example of a staged upgrade would be upgrading a publisher node one night, reverting back to the inactive software, and then switching to the new active software the following night before upgrading the subscriber node(s). In this scenario, you must upgrade all subscriber nodes during the same upgrade window and not switch back the publisher node again. If you switch back the publisher node again, you must follow the procedure to switch to Cisco Unified Presence Release 8.6(3) or earlier.

Related References

Special considerations for refresh upgrade


Note


Cisco highly recommends that you perform a DRS backup before you begin a refresh upgrade.


MCS-7825-H3 or MCS-7828-H3 server upgrade

If an upgrade fails for any server other than an MCS-7825-H3 or MCS-7828-H3 server, you can revert back to the previous software version. However, during an upgrade of an MCS-7825-H3 or MCS-7828-H3 server, the disk is completely reformatted, preventing a switch back to the previous version. As a result, Cisco highly recommends that you have a 16GB USB key to which you can backup the DRS.

You should format the USB key. For more information, see the section covering the Answer File Generator in the Installation Guide for IM and Presence Service on Cisco Unified Communications Manager.

COP file installation

For all upgrades from Cisco Unified Presence Release 8.0.x through Release 8.6(1), you must install a COP file. The name of the COP file is ciscocm.cup.refresh_upgrade_v<latest_version>.cop and you can download it from Cisco.com.


Note


You must install the COP file on all nodes before you begin the upgrade.

Failing to install the required COP file when necessary results in the following error: "Error encountered: The selected upgrade is disallowed from the current version." The system aborts the upgrade and automatically reverts back to the previous version of the software. This "COP file check" occurs very early in the upgrade process (preparation phase), prior to the first reboot and reformat of the drive. For more information about the COP file, see Upgrade paths, requirements, and restrictions


Refresh upgrade stages

Preparation Phase

The preparation phase of a refresh upgrade occurs immediately after the upgrade is initiated. During this phase, the upgrade progress can be monitored via the GUI or the CLI. After the preparation phase is completed, the server will automatically reboot to continue the upgrade process. The duration of this phase varies depending on the size and the complexity of the database configuration.

Installation Phase

The installation phase of a refresh upgrade is very similar to that of a fresh installation with a few exceptions. The status of this stage can be monitored via the console. No further GUI updates will occur. During this phase, there is no service support.


Note


If the upgrade fails on any server other than an MCS-7825-H3 or MCS-7828-H3, the server reboots back to the previous software version and you can inspect the install logs using the Command Line Interface. On an MCS-7825-H3 or MCS-7828-H3 server, the disk is completely reformatted; there is no option to revert to the previous software version. For these servers, Cisco recommends that you dump the diagnostic logs to the USB flash drive.


System Startup Phase

This is the last phase of a refresh upgrade. Following the completion of a refresh upgrade, all IM and Presence applications run the new active software

Upgrade time requirements

The time required to upgrade IM and Presence software is variable and depends on a number of factors, such as the number of users, the average contact list size of each user, whether the upgrade is on the publisher or a subscriber node and the hardware deployed. For large deployments, installation of the upgrade software may take several hours.

Throttling affects time required to upgrade

To preserve system stability during upgrades, the system throttles the upgrade process, which may take considerably longer to complete in Cisco Unified Presence 7.0(1) and later than it did in earlier releases.

Related Tasks

License requirements

The IM and Presence Service does not require a server license or software version license. IM and Presence capabilities are integrated with Cisco Unified Communications Manager licenses and are included within both User Connect Licensing (UCL) and Cisco Unified Workspace Licensing (CUWL). Refer to the Cisco Unified Communications Manager Enterprise License Manager User Guide for more information.

For more information about user license requirements for IM and Presence and Cisco Jabber, see the "Cisco Unified IM and Presence Service installation" section of Installing Cisco Unified Communications Manager.

Bridged upgrade

The IM and Presence Service supports bridged upgrades to customers who wish to migrate from discontinued hardware to supported hardware.

The bridged upgrade allows you to create a Disaster Recovery System (DRS) backup on the discontinued hardware. You can then restore the DRS backup on supported hardware after you complete a fresh IM and Presence installation on the supported hardware.

When you attempt an upgrade on the discontinued hardware, IM and Presence displays a warning on the interface, and on the CLI, and informs you that IM and Presence only supports the functionality to create a DRS backup on this server.

IM and Presence supports bridged upgrades from a number of discontinued servers. See the Hardware and Software Compatibility Information for IM and Presence Service on Cisco Unified Communications Manager for the list of discontinued servers.

For more information about DRS backups, see the Disaster Recovery System Administration Guide.

Upgrade paths, requirements, and restrictions

The following table lists the range of upgrade paths that are supported for the IM and Presence Service. For more detailed information about supported upgrade paths, see the Hardware and Software Compatibility Information for IM and Presence Service on Cisco Unified Communications Manager .

From Cisco Unified Presence Release To IM and Presence Release Upgrade Type
8.0(1) to 8.6(1) 9.0(1) Refresh upgrade, COP file needed
8.6(2) and 8.6(3) 9.0(1) Refresh upgrade
8.6(4) 9.0(1) Standard upgrade
Upgrading from Cisco Unified Presence Release 8.6(5) and later to IM and Presence Release 9.0(1) is unsupported.

For upgrades from Cisco Unified Presence 8.0(1) through to 8.6(1), you must install a COP file on all nodes before you begin the upgrade process. You can download the COP file from Cisco.com. The name of the COP file is:

cisco.com.cup.refresh_upgrade_v<latest_version>.cop

The COP file delivers functionality to allow the upgrade path to be supported and provides various enhancements to the user experience.


Caution


If you do not install the COP file on all nodes for the required releases, the upgrade will fail.

Software version restrictions

Unified Communications Manager and IM and Presence Service software versions must have the same major and minor release number. Major and minor release numbers are defined as follows:

9.x.y

where 9 = major release number, x = minor release number and y = maintenance release number.

For example, IM and Presence Release 9.0.2.10000-4 is compatible with Unified Communications Manager Release 9.0.12.30000-2, but it is not compatible with Unified Communications Manager Release 9.1.1.10000-3. Similarly, Unified Communications Manager Release 8.6.2.10000-6 is not compatible with IM and Presence Release 9.0.1.10000-9.

The software version of subsequent IM and Presence nodes that you upgrade must match all five version numbers of the first IM and Presence node that you upgraded.


Note


You cannot upgrade IM and Presence unless the upgraded release of Unified Communications Manager is already installed on the active or inactive partition. You must upgrade Unified Communications Manager before you can upgrade IM and Presence to the matching version.



Caution


If you use Platform Administrative Web Services (PAWS) Management to upgrade IM and Presence, do not attempt to upgrade and reboot to the current IM and Presence release if the active partition on Unified CM is running an incompatible software version. If you do, the upgrade will fail, as expected, but the failure will not be reported until near the end of the upgrade process. You will also experience system downtime when the system reboots.

The delayed upgrade failure notification applies only to upgrades that are performed with PAWS Management. If you perform the upgrade through Cisco Unified IM and Presence Operating System Administration or through the CLI, the upgrade failure notification is displayed at the beginning of the upgrade.


Version switching rules

A number of rules apply when you are manually switching versions and when you switch versions during an upgrade.

Manual switching rules

Version switching during upgrade rules

Upgrade from Cisco Unified Presence Release 8.0(x) or Release 8.5(4)

If you upgrade from Cisco Unified Presence Release 8.0(x) or Release 8.5 to the current release, note the following:

  • If you have intercluster peers to Cisco Unified Presence Release 8.0(x) or Release 8.5 clusters, you will not have intercluster presence until you upgrade all of these clusters to Release 8.6 or to Release 9.x and later. After the upgrade is complete, the previously configured peers will start working and intercluster presence will be restored.
  • If you upgrade a Cisco Unified Presence Release 8.5 cluster that has High Availability (HA) enabled to Release 9.x or later, Cisco recommends that you disable HA on each subcluster before you begin the upgrade. You can reenable HA on each cluster after the switch version is complete, database replication is complete, and all services are back up and running.
  • During a software upgrade, the Cisco Replication Watcher service delays feature service startup on the publisher node for up to 20 minutes and on subscriber nodes indefinitely until replication is established.

User profile data migration

In this release, the user UC Service Profile information for LDAP, Voicemail, Conferencing, Mailstore, CTI Gateway, and Audio that was configured from the Application > CUPC/Cisco Jabber menu in Cisco Unified Presence Administration is now configurable on Cisco Unified Communications Manager from the User Management > User Settings > UC Service and Service Profile menus. Therefore, when you upgrade from Cisco Unified Presence Release 8.x to the current release of IM and Presence, all user profile information is migrated to Unified Communications Manager. The user profile information is stored as new service profiles on Unified Communications Manager with the following name and description format:

Name: UCServiceProfile_Migration_x (where x is a number starting at 1)

Description: Migrated Service Profile Number x

You can edit these service profiles to give them more meaningful names. See Cisco Unified Communications Manager Administration Guide for more information about configuring service profiles.


Note


Profiles that have been created on Cisco Unified Presence Release 8.x but have not been assigned to any end users are not migrated to Unified Communications Manager.


The service profiles that are created on Unified Communications Manager during the user profile data migration include a Presence and IM UC service. The Presence and IM UC service provides Cisco Jabber 9.0 clients with the configuration required to connect to the IM and Presence Service. The Presence and IM UC service is included only in UC service profiles that are assigned to end users.


Note


If DNS is not supported in the Unified Communications Manager deployment, you must modify the Host Name/IP Address field for the Presence and IM UC service. When the Presence and IM UC service is created on Unified Communications Manager, the Host Name/IP Address field is set to the IM and Presence domain name. If DNS is not supported, you must change the Host Name/IP Address field to the IP address of the IM and Presence publisher node. For more information about configuring UC services, see Cisco Unified Communications Manager Administration Guide.


The following examples show how each unique combination of profiles assigned to IM and Presence end users is migrated to Unified Communications Manager as one new UC service profile.

Figure 1. Example 1



Figure 2. Example 2



Figure 3. Example 3



Migration of Cisco Jabber Video Settings

In Cisco Unified Presence Release 8.x, the Always begin with video muted setting is configured in Cisco Unified Presence Administration under Application > Cisco Jabber > Settings. This setting is not migrated during the upgrade to the current release. In the current release, this setting is configured in Unified Communications Manager as a Cisco Jabber Enterprise Parameter called Never start call with video. The default value for the Never start call with video setting is False. If you want to configure calls to not start with video, you must set the Never start call with video value to True in the Unified Communications Manager Enterprise Parameter configuration window.

Intercluster upgrades

This release of the IM and Presence Service supports intercluster peers to clusters running Cisco Unified Presence Release 8.6 and IM and Presence Release 9.x only.

Perform pre-upgrade tasks

Before you begin to upgrade IM and Presence software, you must perform the following tasks.

Procedure
    Step 1   Read the release notes and documentation for the new release and be sure you understand the supported upgrades, new features, and how the upgrade interacts with the other products associated with your system.
    Step 2   Ensure that your hardware is supported on the version of IM and Presence software that you are upgrading to. See the Hardware and Software Compatibility Information for IM and Presence Service on Cisco Unified Communications Manager for more information.
    Step 3   Disable High Availability on the IM and Presence subcluster. Select Cisco Unified CM IM and Presence Administration > System > Cluster Topology.

    For more information, see the Deployment Guide for IM and Presence Service on Cisco Unified Communications Manager.

    Step 4   Back up your system.

    For more information, see the Disaster Recovery System Administration Guide .

    Step 5   If you have to upgrade Cisco Unified Communications Manager as part of your IM and Presence upgrade, you must stop and restart the IM and Presence Sync Agent service. To restart the Sync Agent service, navigate to Cisco Unified IM and Presence Serviceability and select Tools > Control Center - Network Services .
    Step 6   Check that the IM and Presence Service server has connectivity with Cisco Unified Communications Manager.
    Tip   

    You can use the Cisco Unified CM IM and Presence Administration System Troubleshooter to check server connectivity.