Upgrade Guide for Cisco Unified Communications Manager, Release 9.1(1)
Upgrade procedures
Download this chapter
Upgrade proceduresUpgrade procedures
Download the complete book
Upgrade Guide for Cisco Unified Communications Manager, Release 9.1(1) Upgrade Guide for Cisco Unified Communications Manager, Release 9.1(1) (PDF - 1 MB)
 Feedback

Upgrade procedures

The following chapter describes the upgrade procedures for the IM and Presence Service.


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.


Note

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.

Multi-node software upgrade procedures

This section describes the high-level procedure for performing a standard upgrade and a refresh upgrade in a multi-node deployment.

Perform a standard upgrade

Figure 1. Multi-node software upgrade flowchart - standard upgrade

Restrictions

Your hardware must comply with the multi-node hardware recommendations. See the Deployment Guide for IM and Presence Service on Cisco Unified Communications Server for more information.


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.

Before you begin

Check that the contact list size for users has not reached the maximum value. The System Troubleshooter in Cisco Unified CM IM and Presence Administration indicates if there are users who have reached the contact list limit.

Procedure
    Step 1   Perform pre-upgrade tasks.
    Step 2   Upgrade the publisher node. Do not switch the software to the new software release at this point.
    Step 3   Upgrade each subscriber node in the cluster. Again, do not switch the software version to the new software release at this point.
    Step 4   Switch the software to the new software release on the publisher node. Wait until the publisher node has successfully restarted (is at the sign in prompt) before you proceed to the next step.
    Step 5   On the subscriber nodes, switch the software to the new software release.
    Step 6   Once the first subscriber has restarted and has come back online with the new software release, switch the software release on the next subscriber node. Wait until each subscriber node has successfully restarted (is at the sign in prompt) before you proceed with the software switch on the next subscriber node. Repeat until the new software release is running on all subscriber nodes.
    Step 7   Run the following CLI command to check if the database replication is active on a 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.

    Note   

    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. Select Cisco Unified CM IM and Presence Administration > System > Notifications to determine whether database replication is complete.

    Step 8   On each subscriber node, restart the Presence Engine service after the database replication becomes active on the node.
    Step 9   Request that all IM and Presence client users in the local and remote cluster sign out, and sign back in to the application.
    Related Tasks

    Perform a refresh upgrade

    This section describes the high-level procedure to perform a refresh upgrade in a multi-node deployment.
    Figure 2. Multi-node software upgrade flowchart - refresh upgrade

    Restrictions

    Your hardware must comply with the multi-node hardware recommendations. See the Deployment Guide for IM and Presence Service on Cisco Unified Communications Manager for more information.

    Before you begin

    Check that the contact list size for users has not reached the maximum value. The System Troubleshooter in Cisco Unified CM IM and Presence Administration indicates if there are users who have reached the contact list limit.

    Procedure
      Step 1   Install the following COP file on all nodes in the IM and Presence cluster: ciscocm.cup.refresh.upgrade_v<latest_version>.cop
      Step 2   Upgrade the publisher node and switch the software to the new software release. To do this, select Switch to new version after upgrade.
      Step 3   On VM platforms only, modify the Guest Operating System on the publisher node to Red-Hat Enterprise Linux 5 (32-bit). See the topic on upgrading to a virtual server for more information.
      Step 4   Upgrade each subscriber node in the cluster and switch to the new software release by selecting Switch to new version after upgrade.
      Note   

      The publisher node must be running the new software before you upgrade each subscriber node.

      Step 5   On VM platforms only, modify the Guest Operating System on each subscriber node to Red-Hat Enterprise Linux 5 (32-bit). See the topic on upgrading to a virtual server for more information.
      Step 6   Run the following CLI command (on the publisher or subscriber node) to check if the database replication is active on a 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.

      Note   

      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. Select Cisco Unified CM IM and Presence Administration > System > Notifications to determine whether database replication is complete.

      Step 7   On each subscriber node, restart the Presence Engine service after the database replication becomes active on the node.
      Step 8   Request that all IM and Presence client users in the local and remote cluster sign out, and sign back in to the application.
      Related Tasks

      Software procedures

      You can access the upgrade file during the installation process from either a local CD or DVD or from a remote FTP or SFTP server. Be aware that directory names and filenames that you enter to access the upgrade file are case-sensitive.


      Note

      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.

      Related Tasks

      Upgrade from local source

      You can upgrade to a new release of the IM and Presence Service using software from a CD or DVD in the local disc drive.

      Before You Begin
      • Obtain the upgrade file from cisco.com. Copy the upgrade file to a writable CD or DVD. Because of their size, some upgrade files may not fit on a CD and require a DVD.
      • Review the software upgrade process and ensure that you have completed the prerequisite system backup procedures. Cisco highly recommends that you perform a backup of the Disaster Recovery System (DRS).
      • Stop all configuration tasks.
      • Perform data migration on MCS-7825-H3 or MCS-7828-H3 servers using a 16GB USB Flash Drive. Do not remove the USB key until the data migration is complete.

        Note

        During a refresh upgrade on either the MCS-7825-H3 or MCS-7828-H3 platform, the hard drive needs to be formatted; it will not be possible to switch back to the older version of Cisco Unified Presence after the refresh upgrade has been started. As a result, Cisco highly recommends that you perform a DRS backup.

      • Do not rename the upgrade file before you install it because the system will not recognize it as a valid file.
      • Do not decompress the file. If you do, the system may not be able to read the upgrade file.

      Tip

      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.

      Procedure
        Step 1   Insert the CD or DVD into the disc drive on the local server that is to be upgraded.
        Step 2   Sign in to Cisco Unified IM and Presence Operating System Administration.
        Step 3   If you are performing a refresh upgrade, install the required COP file: ciscocm.cup.refresh_upgrade_v<latest_version>.cop
        Step 4   Select Software Upgrades > Install/Upgrade.
        Step 5   Select DVD/CD from the Source list.
        Step 6   In the Directory field, enter the path to the patch file on the CD or DVD. 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 will enable 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:

        • 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 multi-node deployment, select Do not reboot after upgrade.This allows you to install the upgrade and then manually reboot to the upgraded software at a later time. For more information about how to manually reboot the system and activate the upgrade, see the topic called Switch IM and Presence software version.

        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 13   Select Next and select Finish when the installation completes.
        Related Tasks
        Related References

        Upgrade from remote source

        You can upgrade IM and Presence using software from a network drive or remote server. The network drive or remote server must be running a SFTP/FTP server that can be accessed by each IM and Presence server that you want to upgrade.

        Before You Begin
        • Review the software upgrade process and ensure that you have completed the prerequisite system backup procedures. Cisco highly recommends that you perform a backup of the Disaster Recovery System (DRS).
        • Stop all configuration tasks.
        • Perform data migration on MCS-7825-H3 or MCS-7828-H3 servers using a 16GB USB Flash Drive. Do not remove the USB key until the data migration is complete.

          Note

          During a refresh upgrade on either the MCS-7825-H3 or MCS-7828-H3 platform, the hard drive needs to be formatted; it will not be possible to switch back to the older version of Cisco Unified Presence after the refresh upgrade has been started. As a result, Cisco highly recommends that you perform a DRS backup.


        Tip

        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.

        Procedure
          Step 1   Sign in to Cisco Unified IM and Presence Operating System Administration.
          Step 2   If you are upgrading from a Release between 8.0(1) and 8.6(1) install the required COP file: ciscocm.cup.refresh_upgrade_v<latest_version>.cop
          Step 3   Select Software Upgrades > Install/Upgrade.
          Step 4   Select Remote Filesystem from the Source list.
          Step 5   In the Directory field, enter the path to the patch file on the remote system.
          Step 6   In the Server field, enter the FTP or SFTP server name.
          Step 7   In the User Name field, enter the user name for the remote server.
          Step 8   In the User Password field, enter the password for the remote server.
          Step 9   Enter your email address and IP address in the Email Notification and SMTP Server fields. This will enable you to receive an email notification upon successful completion of the upgrade.
          Note   

          These fields are only visible for refresh upgrades.

          Step 10   From the Transfer Protocol field, select the transfer protocol, for example, SFTP.
          Step 11   Select Next to continue the upgrade process.
          Step 12   Select the upgrade version that you want to install and select Next.
          Step 13   Monitor the progress of the download, which includes the filename and the number of megabytes that are being transferred.
          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 multi-node deployment, select Do not reboot after upgrade.This allows you to install the upgrade and then manually reboot to the upgraded software at a later time. For more information about how to manually reboot the system and activate the upgrade, see the topic called Switch IM and Presence software version.

          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 and select Finish when the installation completes.
          Related Tasks
          Related References

          Upgrade to IM and Presence on virtual server

          Follow this procedure if you want to upgrade toIM and Presence Release 9.x from Cisco Unified Presence Release 8.6(3) and earlier on a virtual server.

          Before you begin

          The following components of the virtual server must meet the requirements for the latest release of IM and Presence:

          • Guest Operating System
          • RAM
          • Red Hat Enterprise Linux (RHEL) version 5.0

          For information about installing or upgrading IM and Presence on a virtual server, see Virtualization Docwiki.

          Procedure
            Step 1   Upgrade the IM and Presence server to the latest software version.
            Step 2   After you finish the upgrade, shut down the virtual machine.
            Step 3   Change the Guest Operating System to Red-Hat Enterprise Linux 5 (32-bit).
            Step 4   Check the RAM on the virtual machine and make sure that it meets the minimum RAM requirements for this release of IM and Presence. Refer to the readme file that accompanied the OVA file with this release for minimum RAM requirements.
            Step 5   Save the changes.
            Step 6   Restart the virtual machine.

            Switch software version


            Caution

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

            When you upgrade software, 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.

            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.


            Note

            If you switch versions in a multi-node deployment, you must switch the publisher node first. It may take some time for all the services on the IM and Presence nodes to move to the Started state. Select Cisco Unified CM IM and Presence Administration > System > Cluster Topology and select a node from the tree view to monitor the status of the services on the node.

            Before You Begin

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

            Procedure
              Step 1   Sign in to Cisco Unified IM and Presence Operating System Administration.
              Step 2   Select Settings > Version.
              Step 3   Verify the version of the active software and the inactive software.
              Step 4   Select Switch Versions to switch versions and restart the system.
              Related References

              Revert to previous software version


              Caution

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

              After you upgrade IM and Presence to a new software version, the earlier software version remains inactive on the system. If you need to revert to the earlier software version, you can switch versions. If you want to switch to Cisco Unified Presence Release 8.6(3) or earlier, see the relevant topic.


              Caution

              You cannot revert to the earlier software version on an MCS-7825-H3 or MCS-7828-H3 server. The entire disk has been reformatted and old data has been erased.


              Note

              Any changes you made to the database after an upgrade will be lost if you revert to the earlier software version. Therefore, if you make changes to the database after an upgrade, you must repeat those changes after you switch back to the earlier software version.

              Before you begin

              Switch versions on Cisco Unified Communications Manager, see the topic on manual switching rules for more information.

              Procedure
                Step 1   Sign in to Cisco Unified IM and Presence Operating System Administration.
                Step 2   Select Settings > Version.
                Step 3   Verify the version of the active and inactive software.
                Step 4   Select Switch Versions to switch versions and restart the system.
                Related Tasks
                Related References

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

                IM and Presence Release 9.0(1) and later do not support the Cisco Presence Engine database. If you upgrade to IM and Presence Release 9.0(1) or later 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 multi-node environment, you must install the COP file on every node in the cluster after you switch versions from IM and Presence Release 9.0(1) or later.

                The COP file can only be installed on the following versions of Cisco Unified Presence after a downgrade from IM and Presence Release 9.0(1) or later:

                • 8.0(1)
                • 8.0(2)
                • 8.0(3)
                • 8.0(4)
                • 8.5(1)
                • 8.5(2)
                • 8.5(3)
                • 8.5(4)
                • 8.6(1)
                • 8.6(2)
                • 8.6(3)

                Note

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

                Before you begin

                Switch versions on Cisco 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 multi-node 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