Upgrade Procedures

Upgrade Overview

Use the procedures in this chapter to perform an upgrade using the Unified CM OS Administration interface.


Note
If you want to use Cisco Prime Collaboration Deployment to complete an upgrade or migration, refer to the Cisco Prime Collaboration Deployment Administration Guide to set up an upgrade task or migration task.

Publisher Nodes and Subscriber Nodes

Within a cluster, there is a database publisher for each type of node that you install.

When you install Unified Communications Manager, the installation wizard prompts you to specify whether the node you are installing is the first node in the cluster. The first Unified Communications Manager node that you install becomes the publisher node, because it publishes the voice and video database to the other Unified Communications Manager nodes in the cluster. All subsequent nodes in the cluster are called subscriber nodes. Each subscriber node must be associated with the publisher node. You must set up all subscriber nodes in the system topology on the publisher node before you install the software on the subscriber nodes.

When you install IM and Presence Service nodes, the first node that you install functions as the server for the IM and Presence Service database. Because this node publishes the database for all of the IM and Presence Service nodes in the cluster, it is referred to as the IM and Presence Service database publisher; however, you must install this and all other IM and Presence nodes as subscribers of the Unified Communications Manager publisher node. As with other subscriber nodes, you must add these in the system topology before you install the software.

Understanding Version Switching

When you upgrade a node, the new software is installed as an inactive version. To activate the new software, you must switch the node to the new software version. There are two ways to switch to the new software version:

  • Automatic switching—the system switches the version automatically as part of the upgrade process

  • Manual switching—physically switch the version using the OS Administration interface after the upgrade process is complete

The method that you choose depends on the type of upgrade that you are doing. During the upgrade process, the wizard prompts you to choose whether to switch the software version automatically by rebooting to the upgraded partition, or whether to switch the version manually at a later time. The table below lists the switching method to use for each type of upgrade.

Upgrade type

Switching type

When prompted, choose . . .

Result

Standard upgrade

Automatic

GUI: Reboot to upgraded partition

CLI: Switch to new version after upgrade

When you choose this option, the system reboots to the new software version.

Manual

GUI: Do not reboot after upgrade

CLI: Do not switch to new version after upgrade

When you choose this option, the system continues to run the old software version when the upgrade is complete. You can manually switch to the new software later.

Refresh upgrade

Automatic

GUI: Reboot to upgraded partition

CLI: Switch to new version after upgrade

Choose this option to use the new software version immediately following the upgrade.

Manual

GUI: Do not reboot after upgrade

CLI: Do not switch to new version after upgrade

Use this option only if you are performing a refresh upgrade in stages. When you choose this option the system reboots to the old software version when the upgrade is complete, and you can manually switch to the new software later.

When you switch versions, your configuration information migrates automatically to the upgraded version on the active partition.

If for any reason you decide to back out of the upgrade, you can restart the system to the inactive partition that contains the older version of the software. However, any configuration changes that you made since you upgraded the software will be lost.

For a short period of time after you install Unified Communications Manager or switch over after upgrading to a different product version, any changes made by phone users may be lost. Examples of phone user settings include call forwarding and message waiting indication light settings. This can occur because Unified Communications Manager synchronizes the database after an installation or upgrade, which can overwrite phone user settings changes.

Before You Begin


Caution

Stop all configuration tasks. Do not make any configuration changes during an upgrade. For example, do not change passwords, perform LDAP synchronizations, or run any automated jobs. Do not remove, re-add, or reinstall any nodes in the cluster during the upgrade process. You can make configuration changes only when you have completed the upgrade on all nodes and performed the post-upgrade tasks. Any configuration changes that you make during an upgrade will be lost, and some configuration changes can cause the upgrade to fail.

We recommend that you suspend user synchronization with LDAP and do not resume synchronization until you have completed the upgrade on all Unified Communications Manager nodes and all IM and Presence Service Service nodes.


Caution

During a Refresh Upgrade, traffic is no longer processed and several reboots are required, therefore, you must perform a refresh upgrade during a maintenance window.


Note

If you use RTMT as a monitoring tool and have a mega cluster deployment, Cisco recommends high-availability setup for RTMT to avoid any connectivity loss during Simple Upgrade. Following are the steps to setup high availability for RTMT Monitoring:

  1. Login to CM Administration page.

  2. Click System → Service Parameter.

  3. Select any Unified Communications Manager node from server drop down.

  4. Select Cisco AMC Service from Service drop down.

  5. Select Primary Collector as any Subscriber node.

  6. Select Failover Collector as any Subscriber node other than the node that is selected as Primary collector and then click Save.

  7. Connect RTMT to any Subscriber.

Note

During the switch version, only User Facing features (UFF) in dynamic tables (numplandynamic, devicedynamic, and more) gets updated. Other tables are migrated during upgrade. Any configuration changes after the upgrade or before the switch versions are lost.


Note

The system checks for any existing phone service URLs during upgrade and automatically appends “&EMCC=#EMCC#” if it does not added in the phone service URLs. As a result, any phones that do not support EMCC may encounter issues trying to login to Extension Mobility. The appended “&EMCC=#EMCC#” can be removed after upgrade if Unified Communications Manager contains any legacy or third-party devices which does not support EMCC

Upgrade Task Flow

Procedure

  Command or Action Purpose
Step 1

Upgrade the application using one of the following procedures:

Use these procedures when you upgrade Unified Communications Manager or the IM and Presence Service using the Unified CM OS Administration interface.

Step 2

Switch the Software Version

Use this procedure to activate the new software.
Step 3

Switch to Previous Version

Use the procedures in this section if you need to revert to the software version that was running before the upgrade.
Step 4

Verify that Database Replication is Functioning
Step 5

Verify that Database Replication is Complete

Upgrade the Applications

Upgrade from a Local Source

Follow this procedure to upgrade to a new release of Unified Communications Manager or the IM and Presence Service Service from a local source.

Before you begin

Ensure that you have the correct ISO file for the upgrade. Upgrade files use the following naming convention:

  • UCSInstall_CUP_<XXXXXXXX>.sgn.iso

  • UCSInstall_UCOS_<XXXXXXXX>.sgn.iso

  • Export unrestricted software has a XU license SKU.

  • Export restricted software has a K9 license SKU.

Procedure

Step 1

Ensure that you can access the upgrade file. Choose one of the following options:

  • Insert the CD or DVD into the disc drive on the local server that is to be upgraded.
  • Create a data store ISO file on the local ESXi host.
  • Create a data store ISO file on a storage area network (SAN) that is connected to the ESXi host.
Step 2

Log in to the management software for the node that you are upgrading:

  • If you are upgrading an IM and Presence Service node, log in to Cisco Unified IM and Presence Operating System Administration.
  • If you are upgrading a Unified Communications Manager node, log in to Cisco Unified Communications Operating System Administration.
Step 3

If you are performing a refresh upgrade that requires a COP file, install the required COP file.

If you are unsure whether you have to install a COP file, review the information about supported upgrade paths. See the Related Topics section for more information.

Step 4

Select Software Upgrades > Install/Upgrade.

Step 5

Select DVD/CD from the Source list, or edit the virtual machine to map to the ISO file.

Step 6

In the Directory field, enter the path to the location of the patch file. If the file is in the root directory, enter a slash (/).

Step 7

Enter your email address and IP address in the Email Notification and SMTP Server fields. This option enables you to receive an email notification upon successful completion of the upgrade.

Note 

These fields are only visible for refresh upgrades.
Step 8

Select Next to continue the upgrade process.

Step 9

Select the upgrade version that you want to install and select Next.

Step 10

Monitor the progress of the download, which includes the filename and the number of megabytes that are being transferred.

Step 11

When the download completes, verify the checksum value against the checksum for the file that you downloaded from Cisco.com.
Step 12

Perform one of the following actions:

For standard upgrades:

  • For a single-node deployment, if you want to install the upgrade and automatically reboot to the upgraded software, select Reboot to upgraded partition.

  • For a multinode deployment, select Do not reboot after upgrade. This option allows you to install the upgrade and later manually reboot to the upgraded software. For more information about how to manually reboot the system and activate the upgrade, see the Related Topics section.

For refresh upgrades:

  • Select Do not switch to new version after upgrade only if you perform a staged upgrade.

  • Select Switch to new version after upgrade to remain on the new active software version.

Note 

For more information about the rules for switching during an upgrade, see Version Switching during upgrade rules.

Step 13

Select Next.

Step 14

Select Finish when the installation completes.

Upgrade from a Remote Source

Follow this procedure to upgrade to a new release of Cisco Unified Communications Manager or the IM and Presence Service Service using software from a network drive or remote node. The network drive or remote node must run an SFTP/FTP server that is accessed by each node that you want to upgrade.

Before you begin

Ensure that you have the correct ISO file for the upgrade. Upgrade files use the following naming convention:

  • UCSInstall_CUP_<XXXXXXXX>.sgn.iso

  • UCSInstall_UCOS_<XXXXXXXX>.sgn.iso

  • Export unrestricted software has a XU license SKU.

  • Export restricted software has a K9 license SKU.

Procedure

Step 1

Ensure that you can access the FTP/SFTP server where you stored the upgrade file.
Step 2

Log in to the management software for the node that you are upgrading:

  • If you are upgrading an IM and Presence Service node, log in to Cisco Unified IM and Presence Operating System Administration.
  • If you are upgrading a Unified Communications Manager node, log in to Cisco Unified Communications Operating System Administration.
Step 3

If you are performing a refresh upgrade that requires a COP file, install the required COP file.

If you are unsure whether you have to install a COP file, review the information about supported upgrade paths. See the Related Topics section for more information.

Step 4

Select Software Upgrades > Install/Upgrade.

Step 5

Select Remote Filesystem from the Source list.

Step 6

In the Directory field, enter the path to the patch file on the remote system.

Step 7

In the Server field, enter the FTP or SFTP server name.

Step 8

In the User Name field, enter the username for the remote node.

Step 9

In the User Password field, enter the password for the remote node.

Step 10

Enter your email address and IP address in the Email Notification and SMTP Server fields. This option enables you to receive an email notification upon successful completion of the upgrade.

Note 

These fields are only visible for refresh upgrades.
Step 11

From the Transfer Protocol field, select the transfer protocol, for example, SFTP.

Step 12

Select Next to continue the upgrade process.

Step 13

Select the upgrade version that you want to install and select Next.

Step 14

When the download completes, verify the checksum value against the checksum for the file that you downloaded from Cisco.com.

Step 15

Perform one of the following actions:

For standard upgrades:

  • If this is a single-node deployment and you want to install the upgrade and automatically reboot to the upgraded software, select Reboot to upgraded partition.

  • If this is a multinode deployment, select Do not reboot after upgrade.This option allows you to install the upgrade and then manually reboot to the upgraded software later. For more information about how to manually reboot the system and activate the upgrade, see the Related Topics section.

For refresh upgrades:

  • Select Do not switch to new version after upgrade only if you are performing a staged upgrade.

  • Select Switch to new version after upgrade to remain on the new active software version.

Note 

See the topic called Version switching during upgrade rules for more information about the rules for switching during an upgrade.

Step 16

Select Next.

Step 17

Select Finish when the installation completes.

Version Switching

A number of rules apply when you are manually switching versions and when you switch versions during an upgrade. The table below outlines the version switching rules for activating the release 10.x software version and for switching back to a previous software version.


Note
You cannot switch the version of any node if doing so violates the version matching requirements. This rule applies whether you are switching forward to a new software version, or switching back to a previous software version.

Product

Node type

Switch from

Switch to

Switching rule

Activate the new software version

Unified CM

Publisher

8.x or 9.x

11.x

You must switch the software version on the publisher node before you switch the software version on subscriber nodes.

10.x

11.x

Unified CM

Subscriber

8.x or 9.x

11.x

Supported when the publisher node has been switched to the new version. The software version you are switching to must match the version number of the active partition on the Unified Communications Manager publisher node.

10.x

11.x

IM and Presence

Database publisher

8.x or 9.x

11.x

Supported when the software version you are switching to matches the major and minor version number of active partition on theUnified Communications Manager publisher node.

10.x

11.x

IM and Presence

Subscriber

8.x or 9.x

11.x

Supported when the software version of this node matches the five version numbers of the IM and Presence Service database publisher node.

10.x

11.x

Switch back to a previous software version

Unified CM

Publisher

11.x

8.x or 9.x

Supported. You must switch the software version on the publisher node before you switch the software version on subscriber nodes.

11.y

10.x

Unified CM

Subscriber

11.x

8.x or 9.x

Supported when the Unified Communications Manager publisher node has been switched to the previous version. The software version you are switching to must match the version number of the active partition on the Unified Communications Manager publisher node. You cannot switch a subscriber node to a previous version when the publisher node is running new version.

11.y

10.x

IM and Presence

Database publisher

11.x

8.x or 9.x

Not supported when the Unified Communications Manager publisher node is running a software version that is newer than the one that you are switching back to. Switching the IM and Presence Service database publisher node to a previous release after the Unified Communications Manager has been upgraded to a newer release violates the version matching requirements.

Switching back to a previous release is supported only when the software version you are switching to matches the major and minor version number of active partition on the Unified Communications Manager publisher node.

11.y

10.x

IM and Presence

Subscriber

11.x

8.x or 9.x

Not supported when the IM and Presence Service database publisher node is running a software version that is newer than the one that you are switching back to.

Switching back to a previous release is supported only when the software version of this node matches the five version numbers of the IM and Presence Service database publisher node.

11.y

10.x

Switch the Software Version

When you perform a standard upgrade, the new software is installed as an inactive version. You can reboot to the new software during the upgrade process or you can switch to the new version later.

If you did not switch versions immediately after completing the upgrade, do so now. You must switch versions so that the upgrade is complete and all nodes in the cluster are updated. Do not perform a backup until you have switched to the new software version.

When you switch versions, the system restarts, and the inactive software becomes active. The system restart may take up to 15 minutes. When you perform this procedure both the active and inactive software versions are indicated.


Caution

This procedure causes the system to restart and become temporarily out of service.

Before you begin

The software versions on Unified Communications Manager and IM and Presence Service nodes must match according to the manual switching rules. Therefore, you must switch Unified Communications Manager before you switch IM and Presence Service.

Review the information in Understanding Version Switching

Procedure

Step 1

If you switch versions in a multinode deployment, you must switch the publisher node first.
Step 2

Log in to the management software for the node that you are upgrading:

  • If you are upgrading an IM and Presence Service node, log in to Cisco Unified IM and Presence Operating System Administration.
  • If you are upgrading a Unified Communications Manager node, log in to Cisco Unified Communications Operating System Administration.
Step 3

Select Settings > Version.

Step 4

Verify the version of the active software and the inactive software.

Step 5

Select Switch Versions to switch versions and restart the system.

After you perform a switch version when you upgrade Unified Communications Manager, IP phones request a new configuration file. This request results in an automatic upgrade to the device firmware.

Switch to Previous Version

If you need to revert to the software version that was running before the upgrade, you can do so by using the Switch Version option to switch the system to the software version on the inactive partition.

Switch Cluster to Previous Version

To switch a cluster back to a previous version, complete these high-level tasks:

Procedure

Step 1

Switch back the publisher node.

Step 2

Switch back all backup subscriber nodes.

Step 3

Switch back all primary subscriber nodes.

Step 4

If you are reverting to an older product release, reset database replication within the cluster.

Switch Node to Previous Version

Procedure

Step 1

Log in to the management software for the node that you are upgrading:

  • If you are upgrading an IM and Presence Service node, log in to Cisco Unified IM and Presence Operating System Administration.
  • If you are upgrading a Unified Communications Manager node, log in to Cisco Unified Communications Operating System Administration.
Step 2

Choose Settings > Version.

The Version Settings window displays.

Step 3

Click the Switch Versions button.

After you verify that you want to restart the system, the system restarts, which might take up to 15 minutes.

Step 4

To verify that the version switch was successful, follow these steps:

  1. Log in again to the management software for the node that you are upgrading.

  2. Choose Settings > Version.

    The Version Settings window displays.

  3. Verify that the correct product version is now running on the active partition.

  4. Verify that all activated services are running.

  5. For the publisher node, log in to Cisco Unified CM Administration.

  6. Verify that you can log in and that your configuration data exists.

Reset Database Replication

If you switch back the servers in a cluster to run an older product release, you must manually reset database replication within the cluster. To reset database replication after you revert all the cluster servers to the older product release, enter the CLI command utils dbreplication reset all on the publisher server.

When you switch versions by using Cisco Unified Communications Operating System Administration or the CLI, you get a message that reminds you about the requirement to reset database replication if you are reverting to an older product release.

Switch version back to Cisco Unified Presence 8.6(3) or earlier

Cisco Unified Presence releases 8.6(4) and later do not support the Cisco Presence Engine database. If you upgrade from Release 8.6(3) or earlier and you subsequently want to revert to the previous release, you must install a COP file that will reinstall the Cisco Presence Engine database. The COP filename is ciscocm.cup.pe_db_install.cop and you can download it from Cisco.com.


Note

In a multinode environment, you must install the COP file on every node in the cluster after you switch versions from Cisco Unified Presence Release 8.6(4) or later.

In this release, you cannot downgrade to a version earlier than Release 8.6(3).


Note

You must restart the system after you install the COP file.

Before you begin

Switch versions on Unified Communications Manager.

Procedure

Step 1

Download the following COP file from Cisco.com: ciscocm.cup.pe_db_install.cop.

Step 2

Sign in to Cisco Unified IM and Presence Operating System Administration.

Step 3

Select Settings > Version.

Step 4

Verify the version of the active and inactive software.

Note 

This procedure only applies if you want to switch from Release 9.0 or later back to a release earlier than 8.6(4).
Step 5

Select Switch Versions to switch back to the earlier release and restart the system.

Step 6

After the system has restarted, install the COP file.

Note 

In a multinode environment, you must install the COP file on every node in the cluster.
Step 7

After you have installed the COP file, manually restart the system. To do this, select Settings > Version and select Restart.

Step 8

Run the following CLI command (on the publisher or subscriber node) to check if the database replication is active on the node: utils dbreplication runtimestate

If database replication is active on all nodes, the output lists all the nodes and the replication setup value for each node is 2. If database replication is not complete (a value other than 2 is returned), core services will not start on the subscriber node until replication is complete.

Step 9

Select Cisco Unified CM IM and Presence Administration > System > Notifications to determine whether database replication is complete.

Step 10

If database replication cannot be established, use the following CLI command on the publisher node to reset replication: utils dbreplication reset all

Verify that Database Replication is Functioning

Use Cisco Unified Reporting to generate Database Status reports for Unified Communications Manager and IM and Presence Service nodes. You can use the reports to confirm that you have a database replication with no errors.

Before you begin

Ensure that the Cisco Tomcat service is running.

Procedure

Step 1

Log in to the reporting interface for the node:

  • For Unified CM nodes, log in to the Cisco Unified Reporting interface.
  • For IM and Presence nodes, log in to the Cisco Unified IM and Presence Reporting interface.
Step 2

Select System Reports.

Step 3

Check database replication on the node:

  • For Unified CM, select Unified CM Database Status.
  • For IM and Presence, select IM and Presence Database Status.
Step 4

Click the Generate Report (bar chart) icon in the Reports window.

Step 5

Click the View Details link to expose details for a section that does not automatically appear.

Step 6

If the report indicates that there are errors, select the Report Descriptions report and review the troubleshooting information with possible remedies.

Verify that Database Replication is Complete

Use this procedure to verify that the database replication has completed successfully. Replication takes 30 minutes on average, but it may take longer depending on the size of the database.

Procedure

Step 1

Start a CLI session using one of the following methods:

  • From a remote system, use SSH to connect securely to the Cisco Unified Operating System. In your SSH client, enter your ssh adminname@hostname and enter your password.

  • From a direct connection to the serial port, enter your credentials at the prompt that displays automatically.
Step 2

Execute the utils dbreplication runtimestate command to monitor whether the database replication is active on the node and to view the progress of the database setup.

If database replication is active on all nodes, the output lists all the nodes and the replication setup value for each node is 2.

If database replication is not complete (a value other than 2 is returned), core services will not start on the subscriber nodes until replication is complete.