The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
You can use the Software Upgrades options to perform the following types of installations and upgrades:
Install/Upgrade - Use this option to upgrade the application software, install Cisco Unified Communications Manager Locale Installers and dial plans, or install Cisco Unity Connection locales, and upload and install device packs, phone firmware loads, and other COP files.
TFTP File Management - Use this option to upload various device files for use by the phones to the TFTP server. The TFTP server files that you can upload include custom phone rings, callback tones, and phone backgrounds.
For information on upgrading Cisco Unity Connection to the shipping version, see the applicable chapter in the Reconfiguration and Upgrade Guide for Cisco Unity Connection Release 7.x at http://www.cisco.com/en/US/docs/voice_ip_comm/connection/7x/upgrade/guide/7xcucrugx.html.
For information on installing Cisco Unity Connection languages, see the "Installing Additional Languages" chapter of the Reconfiguration and Upgrade Guide for Cisco Unity Connection Release 7.x at http://www.cisco.com/en/US/docs/voice_ip_comm/connection/7x/upgrade/guide/7xcucrug027.html.
The following sections provide information about Cisco Unified Communications Manager and the IM and Presence Service, and the relationship between these nodes when they are installed together in a cluster.
Cisco Unified Communications Manager serves as the software-based call-processing component of the Cisco Unified Communications family of products. A wide range of Cisco Media Convergence Servers provides high-availability server platforms for Cisco Unified Communications Manager call processing, services, and applications.
IM and Presence, which is a service of Cisco Unified Communications Manager, provides native standards-based dual-protocol enterprise instant messaging (IM) and network-based availability as part of Cisco Unified Communications. This secure, scalable, and easy-to-manage service offers users feature-rich communications capabilities both within and external to the enterprise.
This section provides an overview of the system topology and describes the relationship between the types of nodes in the topology.
Clusters provide a mechanism for distributing call processing and database replication among multiple servers. They provide transparent sharing of resources and features and enable system scalability.
A cluster comprises a set of Cisco Unified Communications Manager (Unified Communications Manager) nodes and IM and Presence nodes that run compatible software versions.
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 nodes, the first node that you install functions as the server for the IM and Presence database. Because this node publishes the database for all of the IM and Presence nodes in the cluster, it is referred to as the IM and Presence 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.
This chapter provides the following information:
The following sections provide information about the requirements that your system must meet, and limitations that apply when you install or upgrade Cisco Unified Communications Manager or IM and Presence Service.
Caution | Do not modify any of the IM and Presence Service server entries on the Application Server or Server configuration pages of the Cisco Unified CM Administration interface. The IM and Presence Service upgrade process automatically updates these entries on the Cisco Unified Communications Manager cluster during the final stages (switch version) of the upgrade process. For upgrades from Release 8.x or 9.x to Release 10.x or later, any manual modification of these entries during the upgrade process will result in data migration failures between IM and Presence Service and Cisco Unified Communications Manager. If such failures occur, you must restart the entire upgrade process for both Cisco Unified Communcations Manager and IM and Presence Service clusters. |
This section describes the limitations that apply when you install or upgrade Cisco Unified Communications Manager or the IM and Presence Service.
Do not install Cisco Unified Communications Manager in a large Class A or Class B subnet that contains a large number of devices.
The number of call processing subscriber nodes in a cluster cannot exceed 4 subscriber nodes and 4 standby nodes, for a total of 8 subscribers. The total number of servers in a cluster, including the publisher node, TFTP server, media servers, and IM and Presence nodes can not exceed 20.
Note | The maximum number of IM and Presence nodes in a cluster is 6. |
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.
This section lists the requirements that your network must meet before you can deploy Cisco Unified Communications Manager and the IM and Presence Service.
You must configure the server to use static IP addressing to ensure that the server obtains a fixed IP address. Using a static IP address also ensures that Cisco Unified IP Phones can register with the application when you plug the phones into the network.
Note the following DNS requirements:
Mixed-mode DNS deployments not supported—Cisco does not support mixed-mode deployments. Both Cisco Unified Communications Manager (Unified Communications Manager) and IM and Presence must either use or not use DNS.
If your deployment uses DNS—Unified Communications Manager and IM and Presence should use the same DNS server. If you use different DNS servers between IM and Presence and Unified Communications Manager, it is likely to cause abnormal system behavior.
If your deployment does not use DNS—You must modify the Host Name/IP Address field in the service profile for the Presence and IM UC service. 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 services, see Cisco Unified Communications Manager Administration Guide.
Multinode considerations—If you are using the multinode feature in IM and Presence, see the section regarding multinode deployments in the Deployment Guide for IM and Presence on Cisco Unified Communications Manager for DNS configuration options.
Cisco allows you to use any SFTP server product but recommends SFTP products that have been certified with Cisco through the Cisco Technology Developer Partner program (CTDP). CTDP partners, such as GlobalSCAPE, certify their products with specified versions of Cisco Unified Communications Manager. For information on which vendors have certified their products with your version of Cisco Unified Communications Manager, refer to the following URL:
http://www.cisco.com/pcgi-bin/ctdp/Search.pl
For information on using GlobalSCAPE with supported Cisco Unified Communications versions, refer to the following URL:
http://www.globalscape.com/gsftps/cisco.aspx
Cisco uses the following servers for internal testing. You may use one of the servers, but you must contact the vendor for support:
Open SSH (refer to http://sshwindows.sourceforge.net/)
Cygwin (refer to http://www.cygwin.com/)
Titan (refer to http://www.titanftp.com/)
Cisco does not support using the SFTP product free FTDP. This is because of the 1GB file size limit on this SFTP product.
For issues with third-party products that have not been certified through the CTDP process, contact the third-party vendor for support.
In this release, you cannot install or run Cisco Unified Communications Manager and the IM and Presence Service directly on server hardware; you must run these applications on virtual machines.
Before you can install or upgrade the software on a virtual machine, you must:
This section provides information about the platform requirements that you must meet before you can deploy Cisco Unified Communications Manager and the IM and Presence Service on virtual machines.
Cisco supports virtualized deployments of Unified Communications Manager and the IM and Presence Service on Cisco Unified Computing System servers, or on a Cisco-approved third-party server configuration.
Whether you use a Cisco Unified Computing System server or a Cisco-approved third-party server configuration, you must ensure that the server meets the configuration requirements of the release. The following options are available:
For information about the platform configuration specifications, such as CPU, memory, and storage specifications, see UC Virtualization Supported Hardware.
You must install a version of vSphere ESXi hypervisor that meets the requirements of the release, as well as VMWare Tools. VMware Tools are specialized drivers for virtual hardware that is installed in the UC applications when they are running virtualized. It is very important that the VMware tools version be in sync with the version of ESXi being used. For more information, see Cisco Unified Communications Manager on Virtualized Servers.
If the server is running VMware EX/ESXi and the motherboard has an ICH10 onboard SATA controller, you must disable the SATA controller in the BIOS. The ICH10 onboard SATA controller is not supported by EX/ESXi.
Once ESXi is running on the hardware platform, it is ready to host the virtual machines. The first step is to create the virtual machines on the host. You must use Cisco-generated OVA templates to create the virtual machines to run the Unified Communications Manager application. These OVA templates contain aligned disk partitions and other specific configurations that are required. See Virtualization for Cisco Unified Communications Manager to download the OVA file for your release.
Ensure that you connect each node to an uninterruptible power supply (UPS) to provide backup power and protect your system. Failure to do so may result in damage to physical media and require a new installation.
If you want the node to automatically monitor UPS signaling and automatically initiate a graceful shutdown upon power loss, Cisco Unified Communications Manager is dependent on the capabilities of the virtualization software or physical server's service processor. Please see documentation for those products for support, if any.
The following sections provide information about the software requirements that your deployment must meet.
Cisco Unified Communications Manager and the IM and Presence Service both provide interfaces that you can use to configure and manage the system. You can access the interfaces by using the browsers and operating systems listed in the following table. Cisco does not support or test other browsers.
The time required to upgrade the software is variable and depends on a number of factors. For large deployments, installation of the upgrade software may take several hours.
To preserve system stability during upgrades, the system throttles the upgrade process, which may increase the time required to complete the upgrade.
If the upgrade process is taking much longer than you would like, you can disable throttling. Although disabling throttling decreases the time it takes to perform the upgrade, it may degrade system performance.
To disable throttling, use the following command in the CLI before you start the upgrade:
utils iothrottle disable
If you want to restart throttling after you start the upgrade, you must cancel the upgrade, restart throttling, and then restart the 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.
The following sections provide information about the supported upgrade paths for the Cisco Unified Communications Manager and the IM and Presence Service.
All servers in a cluster must run the same release of Cisco Unified Communications Manager. The only exception is during a cluster software upgrade, during which a temporary mismatch is allowed.
If you are installing IM and Presence nodes, the software version of the first IM and Presence node (the IM and Presence database publisher node) must match the first two numbers of the software version installed on the Unified Communications Manager publisher node. For example, IM and Presence Service software version 10.0.1.10000-1 is compatible with Cisco Unified Communications Manager software version 10.0.1.30000-2.
After you install the first IM and Presence node, the software version of any IM and Presence subscriber nodes that you install must match all five version numbers of the first IM and Presence node.
The following table lists the range of upgrade paths that are supported for Cisco Unified Communications Manager. For more detailed information about supported upgrade paths, see the Cisco Unified Communications Manager Software Compatibility Matrix.
From | To | Upgrade Type |
---|---|---|
8.5(x) or older | 10.0(1) | Refresh upgrade, COP file needed |
8.6(x) to 9.x | 10.0(1) | Refresh upgrade |
10.0(1)x | 10.0(1)y | Standard upgrade |
The following table lists the range of upgrade paths that are supported for the IM and Presence Services. For more detailed information about supported upgrade paths, see the Cisco Unified Communications Manager Software Compatibility Matrix.
From Cisco Unified Presence Release | To IM and Presence Release | Upgrade Type |
---|---|---|
8.5(4) | 10.0(1) | Refresh upgrade, COP file needed |
8.6(3) to 9.x | 10.0(1) | Refresh upgrade |
10.0.1.x | 10.0.1.y | Standard upgrade |
If you are upgrading from IM and Presence Service 10.0(1) Export Unrestricted to any higher release of IM and Presence Service Export Unrestricted (including Service Updates), you must install the following COP file before you begin the upgrade: ciscocm.cup.unrst_upgrade_10_0_1_v1.2.cop.sgn. You can download this file from Cisco.com.
For upgrades from Cisco Unified Presence 8.5(4), 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. This 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 cisco.com.cup.refresh_upgrade_v<latest_version>.cop COP file on all nodes for the required releases, the upgrade will fail. |
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 availability 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 availability 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 presence redundancy group 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.
Note | In IM and Presence Release 10.0(1), the Cisco Replication Watcher service has been renamed to the Cisco IM and Presence Data Monitor service. |
The following sections provide information about the licensing requirements for Cisco Unified Communications Manager and the IM and Presence Service.
Use the Cisco Prime License Manager to allocate and monitor the licenses for Cisco Unified Communications Manager, its applications and endpoints. See the Cisco Prime License Manager User Guide for information about generating and installing licenses.
Unused PAKs and/or licenses for versions prior to Release 9.0 cannot be installed once your system has been upgraded to Release 9.0 or later. If you have uninstalled PAKs, install all licenses before upgrading.
The IM and Presence Service does not require a server license or software version license. However, you must assign users and enable the IM and Presence Service for each assigned user.
Note | With the Jabber for Everyone Offer, no end user licenses are required to enable IM and Presence functionality. See the Jabber for Everyone Quick Start Guide for more information. |
You can assign IM and Presence on a per user basis, regardless of the number of clients you associate with each user. When you assign IM and Presence to a user, this enables the user to send and receive IMs and also to send and receive availability updates. If users are not enabled for IM and Presence, they will not be able to log in to the IM and Presence server to view the availability of other users, send or receive IMs, and other users will not see their availability status.
You can enable a user for IM and Presence using any of the following options:
The End User Configuration window in Cisco Unified Communications Manager. See the Cisco Unified Communications Manager Administration Guide for more information.
The Bulk Administration Tool (BAT)
Assign IM and Presence to a feature group template which you can reference from the Quick User/Phone Add window in Unified Communications Manager.
See the IM and Presence chapter in the Cisco Unified Communications Manager Features and Services Guide for more information.
IM and Presence capabilities are included within both User Connect Licensing (UCL) and Cisco Unified Workspace Licensing (CUWL). IM and Presence capabilities can also be acquired for users that are not Cisco Unified Communications Manager IP Telephony users through the Jabber for Everyone Offer. See the Jabber for Everyone Quick Start Guide for more information.
This section provides the following information:
There are two types of upgrades:
The server automatically determines whether you need to perform a standard upgrade or a refresh upgrade.
Standard upgrades are upgrades that do not require upgrades to the operating system. You can install upgrade software on your server while the system continues to operate.
For standard upgrades, you install the upgrade 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 are required in situations where incompatibilities exist between the old and new software releases. For example, a refresh upgrade is required when the major version of the operating system changes between the version you are upgrading from and the version that you are upgrading to. Refresh upgrades require multiple reboots during installation to upgrade the underlying operating system, causing a temporary server outage while the software is installed. The duration of this outage will depend on your configuration and the size of the database. A typical refresh upgrade takes between 1 and 4 hours per node.
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 upgrade wizard 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.
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.
When you perform a refresh upgrade, you must install COP files before you begin upgrading from any of the following releases:
upgrades from Cisco Unified Communications Manager 8.5(x) and older to Cisco Unified Communications Manager 10.0(x)
upgrades from Cisco Unified Presence 8.5(4) to IM and Presence 10.0(x)
You can download the following COP files from Cisco.com:
COP file | Purpose | ||
---|---|---|---|
ciscocm.refresh_upgrade_v<latest_version>.cop.sgn |
Required. Install this file on all Unified Communications Manager nodes to update the operating system so that it supports the new release. |
||
ciscocm.cup.refresh_upgrade_v<latest_version>.cop |
Required. Install this file on all IM and Presence Service nodes to update the operating system so that it supports the new release. |
||
ciscocm.vmware-disk-size-reallocation-<latest_version>.cop.sgn |
Optional. This COP file expands the vDisk size. Install this COP file on either Unified Communications Manager nodes or IM and Presence Service nodes if you need to increase the vDisk space to meet the space requirements of a refresh upgrade. This option requires a reboot. |
||
ciscocm.free_common_space_<latest_version>.cop.sgn |
Optional. This COP file removes the inactive side in the common partition to increase available disk space without requiring a system rebuild. Install this COP file on Unified Communications Manager nodes or IM and Presence Service nodes as required to perform an upgrade. You can use this COP file as an alternative to the COP file listed above, or in conjunction with it. This option does not require a reboot.
|
To find COP files on Cisco.com, navigate to
.Caution | If you do not install the COP file on all nodes for the required releases, the upgrade will fail. |
The following guidelines apply to installing COP files. If the documentation for a specific COP file contradicts these general guidelines, follow the COP file documentation:
Install the appropriate COP file on every node in a cluster. Perform this task before you install new software on each node in the cluster and set up the database.
After you install a COP file, you must restart the node.
Restart Cisco Unified Communications Manager to ensure that configuration changes that are made during the COP file installation get written into the database.
Restart the IM and Presence Service to ensure that configuration changes that are made during the COP file installation get written into the database.
You can begin an upgrade using either the command line interface or graphical user interface. You can monitor progress of the upgrade using the console until the command line interface and graphical user interface access has been restored. Once these interfaces are restored, you can use the command line interface or graphical user interface to continue to monitor upgrade progress.
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:
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 |
Reboot to upgraded partition |
When you choose this option, the system reboots to the new software version. |
Manual |
Do not reboot 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 at a later time. |
|
Refresh upgrade |
Manual |
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 manually switch to the new software at a later time. When you use this upgrade method, you must switch your publisher node to the new software version before you upgrade your subscriber nodes. |
Automatic |
Switch to new version after upgrade |
Choose this option to use the new software version immediately following the upgrade. When you use this upgrade method, you must switch your publisher node to the new software version before you upgrade your subscriber nodes. |
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 Cisco Unified Communications Manager or switch over after upgrading to a different product version, settings 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 Cisco Unified Communications Manager synchronizes the database after an installation or upgrade, which can overwrite phone user settings changes.
The method that you use to access the upgrade file depends on your network environment. The following options are available:
access the upgrade file on a remote FTP or SFTP server
The following sections provide a list of the high-level tasks that you must perform for each of the supported upgrade scenarios:
upgrade the software on both Unified Communications Manager nodes, and IM and Presence nodes
upgrade the software on Unified Communications Manager nodes only
upgrade the software on IM and Presence nodes only
Perform the tasks in the order shown in these high-level task lists. For detailed information about how to perform the tasks outlined in these task lists, refer to the Related Topics section included at the end of each task list.
Complete the high-level tasks listed in this section when you want to perform a standard upgrade on both the Unified Communications Manager nodes and the IM and Presence nodes in your network.
Complete the high-level tasks listed in this section when you want to perform a refresh upgrade on both the Unified Communications Manager nodes and the IM and Presence Service nodes in your network.
Step 1 | Perform all pre-upgrade tasks that apply to your site. | ||
Step 2 | Stop all
configuration tasks. Do not perform any configuration tasks during the upgrade.
| ||
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 need to install a COP file, review the information about supported upgrade paths. | ||
Step 4 | Upgrade the Unified Communications Manager publisher node. The Unified Communications Manager publisher node is the first node in the cluster. | ||
Step 5 | Switch the software to the new software release. To do this, select Switch to new version after upgrade. The publisher node must be running the new software before you upgrade each subscriber node. | ||
Step 6 | Upgrade each Unified Communications Manager subscriber node. | ||
Step 7 | Switch the
software on the subscriber nodes to the new software release. To do this,
select
Switch
to new version after upgrade.
| ||
Step 8 | Ensure that
database replication is functioning between the first node (the
Unified Communications Manager publisher node) and the
subscriber nodes. You can check database replication status by using one of the
following methods:
Before you proceed, ensure that the database replication is setup and in a good state. For more information about using the Real Time Monitoring Tool, see the Cisco Unified Real Time Monitoring Tool Administration Guide. | ||
Step 9 | Perform post-upgrade tasks for Unified Communications Manager nodes. | ||
Step 10 | If you are
performing a refresh upgrade that requires a COP file, install the required COP
file on every
IM and
Presence node in the cluster and restart the nodes.
If you are unsure whether you need to install a COP file, review the information about supported upgrade paths. See the Related Topics section below for more information. | ||
Step 11 | Upgrade the IM and Presence database publisher node. The IM and Presence database node is the first node in the IM and Presence cluster. | ||
Step 12 | Switch the software to the new software release. To do this, select Switch to new version after upgrade. The IM and Presence database publisher node must be running the new software before you upgrade the IM and Presence subscriber nodes. | ||
Step 13 | Upgrade each IM and Presence subscriber node. | ||
Step 14 | Switch the software on the subscriber nodes to the new software release. To do this, select Switch to new version after upgrade. | ||
Step 15 | 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.
| ||
Step 16 | Perform post-upgrade tasks for the IM and Presence Service. |
Complete the high-level tasks listed in this section when you want to perform a standard upgrade of only the Unified Communications Manager nodes in your network. When you upgrade Unified Communications Manager nodes without upgrading IM and Presence nodes, ensure that the installed version of the IM and Presence Service is compatible with the new version of the Unified Communications Manager software.
Note | When Cisco Unified Communications Manager 10.0(x) is upgraded as part of a service update or a maintenance release, Cisco Sync Agent sends a notification to Cisco Unified CM IM and Presence Administration that the IM and Presence Service database publisher node and subscriber nodes must be rebooted. You must manually clear this notification after the reboots are complete. A warning message about the upgrade is also raised in the Cisco Unified Communications Manager OS Administration GUI. |
Step 1 | Perform all pre-upgrade tasks that apply to your site. |
Step 2 | Stop all configuration tasks. Do not perform any configuration tasks during the upgrade. |
Step 3 | Upgrade the Unified Communications Manager publisher node. The Unified Communications Manager publisher node is the first node in the cluster. |
Step 4 | Upgrade the Unified Communications Manager subscriber nodes. |
Step 5 | When you have completed the upgrade of all the subscriber nodes, switch the publisher node to the upgraded software version. |
Step 6 | When the publisher node is switched to the new version, switch the subscriber nodes to the upgraded software version. |
Step 7 | Ensure that
database replication is functioning between the first node (the
Unified
Communications Manager publisher node) and the subscriber nodes. You
can check database replication status by using one of the following methods:
Before you proceed, ensure that the database replication is setup and in a good state. For more information about using the Real Time Monitoring Tool, see the Cisco Unified Real Time Monitoring Tool Administration Guide. |
Step 8 | Perform post-upgrade tasks for Unified Communications Manager nodes. |
Step 9 | If you upgraded Cisco Unified Communications Manager to a Maintenance Release (MR) or an Engineering Special (ES) Release and you do not upgrade the IM and Presence Service, you must reboot all IM and Presence nodes after the Unified Communications Manager upgrade is complete. |
Complete the high-level tasks listed in this section when you want to perform a refresh upgrade of only the Unified Communications Manager nodes in your network. When you upgrade Unified Communications Manager nodes without upgrading IM and Presence nodes, ensure that the installed version of the IM and Presence Service is compatible with the new version of the Unified Communications Manager software.
Step 1 | Perform all pre-upgrade tasks that apply to your site. |
Step 2 | Stop all configuration tasks. Do not perform any configuration tasks during the upgrade. |
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 need to install a COP file, review the information about supported upgrade paths. |
Step 4 | Upgrade the Unified Communications Manager publisher node. The Unified Communications Manager publisher node is the first node in the cluster. |
Step 5 | Switch the software to the new software release. To do this, select Switch to new version after upgrade. The publisher node must be running the new software before you upgrade each subscriber node. |
Step 6 | Upgrade the Unified Communications Manager subscriber nodes. |
Step 7 | Switch the software to the new software release. To do this, select Switch to new version after upgrade. |
Step 8 | Ensure that
database replication is functioning between the first node (the
Unified
Communications Manager publisher node) and the subscriber nodes. You
can check database replication status by using one of the following methods:
Before you proceed, ensure that the database replication is setup and in a good state. For more information about using the Real Time Monitoring Tool, see the Cisco Unified Real Time Monitoring Tool Administration Guide. |
Step 9 | Perform post-upgrade tasks for Cisco Unified Communications Manager nodes. |
Step 10 | If you upgraded Unified Communications Manager to a Maintenance Release (MR) or an Engineering Special (ES) Release and you do not upgrade IM and Presence Service, you must reboot all IM and Presence nodes after the Unified Communications Manager upgrade is complete. |
Complete the high-level tasks listed in this section when you want to perform a standard upgrade the IM and Presence nodes in your network without upgrading Unified Communication Manager subscriber nodes.
When you upgrade IM and Presence nodes without upgrading Unified Communication Manager subscriber nodes, ensure that the installed version of Unified Communication Manager is compatible with the new version of the Unified Communication Manager software. The software version of the first IM and Presence node (the IM and Presence database publisher node) must match the first two numbers of the software version installed on the Unified Communications Manager publisher node. For example, IM and Presence Service software version 10.0.1.10000-1 is compatible with Cisco Unified Communications Manager software version 10.0.1.30000-2.
Step 1 | Perform all pre-upgrade tasks that apply to your site. | ||
Step 2 | Stop all configuration tasks. Do not perform any configuration tasks during the upgrade. | ||
Step 3 | Upgrade the Unified Communications Manager publisher node. The Unified Communications Manager publisher node is the first node in the cluster. | ||
Step 4 | Upgrade the IM and Presence database publisher node. The IM and Presence database publisher node is the first node in the IM and Presence cluster. | ||
Step 5 | Upgrade the IM and Presence subscriber nodes. | ||
Step 6 | Switch the software to the new
software release. To do this, select Switch to new version after upgrade. You must switch the software to the upgraded version in the following order:
Wait until each of the nodes has successfully restarted and is at the sign in prompt before you proceed with the software switch on the next node. Repeat until the new software release is running on all 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.
| ||
Step 8 | Perform post-upgrade tasks for the IM and Presence Service. |
In the event of an IM and Presence upgrade failure
If the upgrade of Cisco Unified Communications Manager nodes is successful but the upgrade of IM and Presence nodes fails, you must either:
perform another upgrade of both the Cisco Unified Communications Manager nodes and the IM and Presence nodes after you address the issues that caused the failure
perform a DRS restore on the Cisco Unified Communications Manager node where the backup was taken from to restore it to the configuration it had before the attempted upgrade of the IM and Presence nodes
Complete the high-level tasks listed in this section when you want to perform a refresh upgrade the IM and Presence nodes in your network without upgrading Cisco Unified Communication Manager subscriber nodes. When you upgrade IM and Presence nodes without upgrading Cisco Unified Communications Manager subscriber nodes, ensure that the installed version of Cisco Unified Communications Manager is compatible with the new version of the IM and Presence Service software.
Step 1 | Perform all pre-upgrade tasks that apply to your site. | ||
Step 2 | Stop all configuration tasks. Do not perform any configuration tasks during the upgrade. | ||
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 need to install a COP file, review the information about supported upgrade paths. See the Related Topics section below for more information. | ||
Step 4 | Upgrade the Cisco Unified Communications Manager publisher node. The Cisco Unified Communications Manager publisher node is the first node in the cluster. | ||
Step 5 | Switch the software to the new software release. To do this, select Switch to new version after upgrade. The Cisco Unified Communications Manager publisher node must be running the new software before you upgrade each IM and Presence subscriber node. | ||
Step 6 | Upgrade the IM and Presence database node. The IM and Presence database node is the first node in the IM and Presence cluster. | ||
Step 7 | Switch the software to the new software release. To do this, select Switch to new version after upgrade. | ||
Step 8 | Upgrade the IM and Presence subscriber nodes. | ||
Step 9 | Switch the software on the subscriber nodes to the new
software release. To do this, select Switch to new version after upgrade.
Wait until each of the nodes has successfully restarted and is at the sign in prompt before you proceed with the software switch on the next node. Repeat until the new software release is running on all nodes. | ||
Step 10 | 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.
| ||
Step 11 | Request that all IM and Presence client users in the local and remote cluster sign out, and sign back in to the application. | ||
Step 12 | Perform post-upgrade tasks for the IM and Presence Service. |
In the event of an IM and Presence upgrade failure
If the upgrade of Cisco Unified Communications Manager nodes is successful but the upgrade of IM and Presence nodes fails, you must either:
perform another upgrade of both the Cisco Unified Communications Manager nodes and the IM and Presence nodes after you address the issues that caused the failure
perform a DRS restore on the Cisco Unified Communications Manager node where the backup was taken from to restore it to the configuration it had before the attempted upgrade of the IM and Presence nodes
Complete the high-level tasks listed in this section when you want to upgrade nodes in a cluster in parallel.
You can begin upgrading subscriber nodes after the publisher node has finished upgrading. If you are performing a refresh upgrade, there will be a temporary server outage until all subscriber nodes get upgraded to the new software version.
Step 1 | Perform all pre-upgrade tasks that apply to your site. |
Step 2 | Stop all configuration tasks. Do not perform any configuration tasks during the upgrade. |
Step 3 | Upgrade the Unified Communications Manager publisher node. The Unified Communications Manager publisher node is the first node in the cluster. |
Step 4 | View the installation
log to monitor the status of the upgrade by using the Software
Installation/Upgrade window in
Cisco Unified Communications Operating System Administration or by using the command line
interface (CLI).
|
Step 5 | When the upgrade on the publisher node is complete, begin the upgrade on the subscriber nodes. |
Step 6 | Activate the new software on the publisher node. |
Step 7 | Activate the new software on the subscriber nodes. |
Before you begin the upgrade, perform the following tasks:
Step 1 | Read the release notes for the new release and be sure that you understand the new features and how the upgrade interacts with the other products that are associated with your system. | ||
Step 2 | Familiarize yourself with the requirements and limitations listed in this document. Ensure that your system meets all requirements, including network requirements, platform requirements, and software requirements. | ||
Step 3 | Ensure that the software version you are upgrading from is running on a virtual machine. If your current deployment is running on MCS hardware, see the Cisco Prime Collaboration Deployment Administration Guide for information about how to migrate an existing cluster to a virtualized cluster. | ||
Step 4 | Use the Real-Time Monitoring Tool (RTMT) to verify that you have enough common partition space for the upgrade. Typically, you need at least 25G of common partition space; however, your deployment may require more space if you have a lot of TFTP data (device firmware loads), music-on-hold (MOH) files, or if you have many locale files installed. If you do not have enough space, perform one or more of the following steps to create enough space:
| ||
Step 5 | Download any upgrade COP files that are required. COP files are required for refresh upgrades only. To determine which COP files you need, see the information about COP files and supported upgrade paths listed in the Related Topics section below. | ||
Step 6 | Ensure that you have the necessary license files for the new release. | ||
Step 7 | Back up your
system, ensuring that you use a network device as the storage location for the
backup files. Virtualized deployments of
Unified Communications Manager do not support the use
of tape drives to store backup files.
For more information, see the Disaster Recovery System Administration Guide. | ||
Step 8 | Perform these
additional tasks when you upgrade
Cisco
Unified Communications Manager:
| ||
Step 9 | Perform these
additional tasks when you upgrade the
IM and
Presence Service:
|
Use the following procedure when you need to change the configuration specifications on your virtual machine (VM) in order to upgrade to a new release of Unified Communications Manager or IM and Presence Service. Configuration specifications include the vCPU, vRAM, and vDisk size. For information about VM requirements, see the Readme file with the OVA template that supports your release. Details about OVA templates are available on the Virtualization Docwiki at http://docwiki.cisco.com/wiki/Implementing_Virtualization_Deployments.
Step 1 | Perform a
Disaster Recovery System (DRS) backup.
For more information about performing a backup, see the Cisco Unified Communications Manager Disaster Recovery Administration Guide. |
Step 2 | (Optional.) If
you need to increase the vDisk space to meet the space requirements of a
refresh upgrade, install the following COP file:
ciscocm.vmware-disk-size-reallocation-<latest_version>.cop.sgn |
Step 3 | Shut down the virtual machine. |
Step 4 | Change the
configuration of the virtual machine as needed:
For more information about making configuration changes using vSphere Client, refer to the user manual for the product. |
Step 5 | Upgrade the software to the latest version. |
Step 6 | Modify the
Network Adapter to use the VMXNET 3 Adapter type.
For information about modifying the Network Adapter to meet the requirements of this release, see the Readme file for the OVA template. |
Step 7 | Power on the virtual machine. |
Use the following procedure when you need to update your vSphere ESXi hypervisor in order to upgrade to a new release of Unified Communications Manager.
Step 1 | Move the virtual machine that is running Unified Communications Manager off the host server using one of the following methods: |
Step 2 | Upgrade the vSphere ESXi using the upgrade procedures provided by VMware. |
Step 3 | Verify that the vSphere ESXi upgraded successfully. |
Step 4 | Move the virtual machine that is running Unified Communications Manager back to the host server using one of the following methods: |
If you need to update the virtual machine version or the VMware compatibility version in order to upgrade the vSphere ESXi, proceed to Change Virtual Machine Configuration Specifications
Before you begin the upgrade process, you must obtain the appropriate upgrade file from Cisco.com.
For more information, see the Cisco Unified Communications Manager Release Notes.
You can access the upgrade file during the installation process from either a local 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.
This section contains the procedures for performing an upgrade.
Review the pre-installation tasks and ensure that you have performed all the steps.
Stop all configuration tasks. Do not make any configuration changes during an upgrade. Any configuration changes that you make during an upgrade may be lost, and some configuration changes can cause the upgrade to fail.
For upgrades to the IM and Presence Service software, 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.
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. |
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 server before you attempt another upgrade. |
Follow this procedure to upgrade to a new release of Unified Communications Manager or theIM and Presence Service using a CD or DVD in a local disk drive.
Step 1 | Ensure that you can access the upgrade file. Choose one of the following options: | ||
Step 2 | Log in to the management software for the node that you are upgrading: | ||
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 need to install a COP file, review the information about supported upgrade paths. See the Related Topics section below for more information. | ||
Step 4 | Select . | ||
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 will enable you to receive an email notification upon successful completion of the upgrade.
| ||
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 refresh upgrades:
| ||
Step 13 | Select Next and select Finish when the installation completes. |
Follow this procedure to upgrade to a new release of Cisco Cisco Unified Communications Manager or the IM and Presence Service using software from a network drive or remote node. The network drive or remote node must be running a SFTP/FTP server that can be accessed by each node that you want to upgrade.
Step 1 | Log in to the management software for the node that you are upgrading: | ||
Step 2 | If you are performing a refresh upgrade that requires a COP file, install the required COP file. If you are unsure whether you need to install a COP file, review the information about supported upgrade paths. See the Related Topics section below for more information. | ||
Step 3 | Select . | ||
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 node. | ||
Step 8 | In the User Password field, enter the password for the remote node. | ||
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.
| ||
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:
For refresh upgrades:
| ||
Step 16 | Select Next and select Finish when the installation completes. |
Use the following procedure when you need to change the configuration specifications on your virtual machine (VM) in order to upgrade to a new release of Unified Communications Manager or IM and Presence Service. Configuration specifications include the vCPU, vRAM, and vDisk size. For information about VM requirements, see the Readme file with the OVA template that supports your release. Details about OVA templates are available on the Virtualization Docwiki at http://docwiki.cisco.com/wiki/Implementing_Virtualization_Deployments.
Step 1 | Perform a
Disaster Recovery System (DRS) backup.
For more information about performing a backup, see the Cisco Unified Communications Manager Disaster Recovery Administration Guide. |
Step 2 | (Optional.) If
you need to increase the vDisk space to meet the space requirements of a
refresh upgrade, install the following COP file:
ciscocm.vmware-disk-size-reallocation-<latest_version>.cop.sgn |
Step 3 | Shut down the virtual machine. |
Step 4 | Change the
configuration of the virtual machine as needed:
For more information about making configuration changes using vSphere Client, refer to the user manual for the product. |
Step 5 | Upgrade the software to the latest version. |
Step 6 | Modify the
Network Adapter to use the VMXNET 3 Adapter type.
For information about modifying the Network Adapter to meet the requirements of this release, see the Readme file for the OVA template. |
Step 7 | Power on the virtual machine. |
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 Communications Manager |
Publisher |
8.x or 9.x |
10.x |
You must switch the software version on the publisher node before you switch the software version on subscriber nodes. |
10.x |
10.y |
|||
Unified Communications Manager |
Subscriber |
8.x or 9.x |
10.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 |
10.y |
|||
IM and Presence Service |
Database publisher |
8.x or 9.x |
10.x |
Supported 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. |
10.x |
10.y |
|||
IM and Presence Service |
Subscriber |
8.x or 9.x |
10.x |
Supported when the software version of this node matches the five version numbers of the IM and Presence database publisher node. |
10.x |
10.y |
|||
Switch back to a previous software version |
||||
Unified Communications Manager |
Publisher |
10.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. |
10.y |
10.x |
|||
Unified Communications Manager |
Subscriber |
10.x |
8.x or 9.x |
Supported when the CUCM 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. |
10.y |
10.x |
|||
IM and Presence Service |
Database publisher |
10.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 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. |
10.y |
10.x |
|||
IM and Presence Service |
Subscriber |
10.x |
8.x or 9.x |
Not supported when the IM and Presence 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 database publisher node. |
10.y |
10.x |
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.
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. |
The software versions on Cisco Unified Communications Manager and IM and Presence nodes must match according to the manual switching rules. Therefore, you must switch Unified Communications Manager before you switch IM and Presence.
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: |
Step 3 | Select . It may take some time for all the services on the IM and Presence nodes to move to the Started state. Select and select a node from the tree view to monitor the status of the services on the node. |
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.
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.
To switch a cluster back to a previous version, complete these high-level tasks:
Step 1 | Log in to the management software for the node that you are upgrading: |
Step 2 | Choose
.
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:
|
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.
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 Cisco Unified Communications Manager.
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 . | ||
Step 4 | Verify the version of the active and inactive software.
| ||
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.
| ||
Step 7 | After you have installed the COP file, manually restart the system. To do this, select Restart. and select | ||
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 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 |
The following sections provide information about the tasks that you must complete after you upgrade Cisco Unified Communications Manager nodes or IM and Presence nodes.
This section describes post-upgrade tasks that you must perform for both Unified Communications Manager nodes and IM and Presence Service nodes.
You must update the VMWare Tools after you complete and upgrade. There are two options for updating the VMWare Tools:
For information about how to configure these options, see the VMWare documentation.
You can configure Cisco Unified Communications Manager and IM and Presence Service to support multiple languages. There is no limit to the number of supported languages you can install.
Cisco provides locale-specific versions of the Cisco Unified Communications Manager Locale Installer and the IM and Presence Service Locale Installer on www.cisco.com. Installed by the system administrator, the locale installer allows the user to view/receive the chosen translated text or tones, if applicable, when a user works with supported interfaces.
After you upgrade Cisco Unified Communications Manager or the IM & Presence Service, you must reinstall all the locales. Install the latest version of the locales that match the major.minor version number of your Cisco Unified Communications Manager node or IM and Presence Service node.
Install locales after you have installed Cisco Unified Communications Manager on every node in the cluster and have set up the database. If you want to install specific locales on IM and Presence Service nodes, you must first install the Cisco Unified Communications Manager locale file for the same country on the Cisco Unified Communications Manager cluster.
Use the information in the following sections to install locales on Cisco Unified Communications Manager nodes and on IM and Presence Service nodes after you complete the software upgrade.
User locale files contain language information for a specific language and country. They provide translated text and voice prompts, if available, for phone displays, user applications, and user web pages in the locale that the user chooses. These files use the following naming convention:.
cm-locale-language-country-version.cop (Cisco Unified Communications Manager)
ps-locale-language_country-version.cop (IM and Presence Service)
If your system requires user locales only, install them after you have installed the CUCM locale.
Network locale files provide country-specific files for various network items, including phone tones, annunciators, and gateway tones. The combined network locale file uses the following naming convention:
Cisco may combine multiple network locales in a single locale installer.
Note | Virtualized deployments of Cisco Unified Communications Manager on Cisco-approved, customer-provided servers can support multiple locales. Installing multiple locale installers ensures that the user can choose from a multitude of locales. You can install locale files from either a local or a remote source by using the same process for installing software upgrades. You can install more than one locale file on each node in the cluster. Changes do not take effect until you reboot every node in the cluster. Cisco strongly recommends that you do not reboot the nodes until you have installed all locales on all nodes in the cluster. Minimize call-processing interruptions by rebooting the nodes after regular business hours. |
User locale files provide translated text for user applications and user web pages in the locale that the user chooses. User locales are country-specific. Use the following procedure to install locales on the node. Optionally, you can follow the software upgrade procedure to install locale files from either a local or a remote source.
Step 1 | Download the locale installer from www.cisco.com. |
Step 2 | Click the version of the Cisco Unified Communications Manager Locale Installer. |
Step 3 | Click Download to download the installer file to the node. |
Step 4 | After downloading the file, save the file to the hard drive and note the location of the saved file. |
Step 5 | Double-click the file to begin the installation. |
Step 6 | Perform these actions to complete the installation:
|
Step 7 | When the installation is complete, a new dialog requests confirmation of a restart. Should you wish to apply another locale installer, repeat this procedure before restarting the node in order to reduce downtime. |
Step 8 | Click Finish. The Setup dialog box displays. Do not click any buttons or press any keys. |
Step 9 | When the Setup dialog box automatically closes, you have completed the installation on the node. Install the Cisco Unified Communications Manager Locale Installer on every node in the cluster. |
Step 10 | After you complete all locale installation procedures, perform these actions: |
Step 11 | Verify that your users can select the locale(s) for supported
products.
Make sure that you install the same components on every node in the cluster. |
Step 1 | Navigate to
cisco.com and choose the locale installer for your
version of
IM and Presence
Service.
http://software.cisco.com/download/navigator.html?mdfid=285971059 | ||
Step 2 | Click the version of the IM and Presence Locale Installer that is appropriate for your working environment. | ||
Step 3 | After downloading the file, save the file to the hard drive and note the location of the saved file. | ||
Step 4 | Copy this file to a server that supports SFTP. | ||
Step 5 | Sign into Cisco Unified IM and Presence Operating System Administration using the administrator account and password. | ||
Step 6 | Choose . | ||
Step 7 | Choose Remote File System as the software location source. | ||
Step 8 | Enter the file location, for example /tmp, in the Directory field. | ||
Step 9 | Enter the IM and Presence Service server name in the Server field. | ||
Step 10 | Enter your username and password credentials in the User Name and User Password fields. | ||
Step 11 | Choose SFTP for the Transfer Protocol. | ||
Step 12 | Click Next. | ||
Step 13 | Choose the IM and Presence Service locale installer from the list of search results. | ||
Step 14 | Click Next to load the installer file and validate it. | ||
Step 15 | After you complete the locale installation, restart each server in the cluster. | ||
Step 16 | The default
setting for installed locales is "English, United States”. While your
IM and Presence
Service node is restarting, change the language of your browser, if
necessary, to match the locale of the installer that you have downloaded.
| ||
Step 17 | Verify that your
users can choose the locales for supported products.
|
See the following table for a description of the messages that can occur during Locale Installer activation. If an error occurs, you can view the messages in the installation log.
[LOCALE] File not found: <language>_<country>_user_locale.csv, the user locale has not been added to the database. |
This error occurs when the system cannot locate the CSV file, which contains user locale information to add to the database. This indicates an error with the build process. |
[LOCALE] File not found: <country>_network_locale.csv, the network locale has not been added to the database. |
This error occurs when the system cannot locate the CSV file, which contains network locale information to add to the database This indicates an error with the build process. |
[LOCALE] Communications Manager CSV file installer installdb is not present or not executable |
This error occurs because a Cisco Unified Communications Manager application called installdb must be present; it reads information that is contained in a CSV file and applies it correctly to the Cisco Unified Communications Manager database. If this application is not found, it either was not installed with Cisco Unified Communications Manager (very unlikely), has been deleted (more likely), or the node does not have Cisco Unified Communications Manager installed (most likely). Installation of the locale will terminate because locales will not work without the correct records that are held in the database. |
[LOCALE] Could not create /usr/local/cm/application_locale [LOCALE] Could not create /usr/local/cm/application_locale/cmservices/ipma/com/cisco/ ipma/client/locales/maMessages_<ll>_<CC>.properties.Checksum. [LOCALE] Could not create /usr/local/cm/ application_locale/cmservices/ipma/com/cisco/ ipma/client/locales/maGlobalUI_<ll>_<CC>.properties.Checksum. [LOCALE] Could not create /usr/local/cm/ application_locale/cmservices/ipma/ LocaleMasterVersion.txt.Checksum. |
These errors could occur when the system fails to create a checksum file; causes can include an absent Java executable, /usr/local/thirdparty/java/j2sdk/ jre/bin/java, an absent or damaged Java archive file, /usr/local/cm/jar/cmutil.jar, or an absent or damaged Java class, com.cisco.ccm.util.Zipper. Even if these errors occur, the locale will continue to work correctly, with the exception of Cisco Unified Communications Manager Assistant, which cannot detect a change in localized Cisco Unified Communications Manager Assistant files. |
[LOCALE] Could not find /usr/local/cm/application_locale/cmservices/ipma/LocaleMaster Version.txt in order to update Unified CM Assistant locale information. |
This error occurs when the file does not get found in the correct location, which is most likely due to an error in the build process. |
[LOCALE] Addition of <RPM-file-name> to the Cisco Unified Communications Manager database has failed! |
This error occurs because of the collective result of any failure that occurs when a locale is being installed; it indicates a terminal condition. |
For a list of products that Cisco Unified Communications Manager Locale Installers support, see the Cisco IP Telephony Locale Installer for Cisco Unified Communications Manager, which is available at this URL:
http://www.cisco.com/cgi-bin/tablebuild.pl/callmgr-locale-51
This section describes the post-upgrade tasks that you must perform for Cisco Unified Communication Manager nodes.
When the upgrade is complete, restore the following settings:
If you changed the database replication timeout value for the upgrade using the utils dbreplication setrepltimeout CLI command, restore the timeout to the default value of 300 (5 minutes). For more information, see the Command Line Interface Guide for Cisco Unified Communications Solutions.
Enable the Cisco Extension Mobility service by navigating to Cisco Unified Serviceability Administration Guide.
. For more information, see theNote | If you do not enable the Cisco Extension Mobility service, Cisco Extension Mobility users cannot log in and log out of phones that support Cisco Extension Mobility. |
After the upgrade, perform the following tasks:
You can install dial plan files from either a local or a remote source by using the same process for installing software upgrades. See the Upgrade Guide for Cisco Unified Communications Manager for more information about upgrading from a local or remote source.
After you install the dial plan files on the system, log in to Cisco Unified CM Administration and then navigate to to complete installing the dial plans.
You can upload files for use by the phones to the TFTP server. Files that you can upload include custom phone rings, callback tones, and backgrounds. This option uploads files only to the specific server to which you connected, and other nodes in the cluster do not get upgraded.
Files upload into the tftp directory by default. You can also upload files to a subdirectory of the tftp directory.
If you have two Cisco TFTP servers that are configured in the cluster, you must perform the following procedure on both servers. This process does not distribute files to all nodes, nor to both Cisco TFTP servers in a cluster.
To upload and delete TFTP server files, follow this procedure:
Step 1 | From the
Cisco Unified Communications
Operating System Administration window, navigate to
.
The TFTP File Management window displays and shows a listing of the current uploaded files. You can filter the file list by using the Find controls. |
Step 2 | To upload a
file, follow this procedure:
|
Step 3 | To delete files,
follow this procedure:
|
You can upload a text file that contains a customized log-on message that appears in Cisco Unified Communications Operating System Administration, Cisco Unified CM Administration, Cisco Unified Serviceability, Disaster Recovery System Administration, and the command line interface.
To upload a customized log-on message, follow this procedure:
Step 1 | From the
Cisco Unified Communications
Operating System Administration window, navigate to Software
.
The Customized Logon Message window displays. | ||
Step 2 | To choose the text file that you want to upload, click Browse. | ||
Step 3 | Click
Upload
File.
The system displays the customized log-on message. | ||
Step 4 | To revert to the
default log-on message, click
Delete.
Your customized log-on message gets deleted, and the system displays the default log-on message.
|
If you are upgrading from Unified Communications Manager release 6.1(5) or earlier, you must re-create your IPSec policies after the upgrade is complete. The configuration information for IPSec policies from release 6.1(5) and earlier will not be migrated as part of the upgrade process. For information about how to create IPSec policies, see the Cisco Unified Communications Manager Operating System Administration Guide.
This section describes the post-upgrade tasks for the IM and Presence Service.
This section describes the post-upgrade tasks for the IM and Presence Service.
If your deployment supports high-availability, you must turn high-availability back on in each presence redundancy group after a system upgrade. Do this after you switch versions, finish the database replication and restart all services. For information about how to turn on high-availability, see the Cisco Unified Communications Manager Administration Guide.
When you upgrade from Cisco Unified Presence Release 8.x to IM and Presence Service Release 9.x and later, user profiles are migrated to Cisco Cisco Unified Communications Manager. The user profile information is stored as new service profiles on Cisco 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
To ensure that users can successfully log into Cisco Jabber after an upgrade from Cisco Unified Presence Release 8.x, you must verify that the user profile data migration was successful.
Profiles that are created but that are not assigned to users are not migrated to Cisco Unified Communications Manager.
Step 1 | From Cisco Unified CM Administration, select . | ||
Step 2 | Select Find to list all service profiles. | ||
Step 3 | Verify that there are migrated service profiles with the following name format: UCServiceProfile_Migration_x | ||
Step 4 | If there are no migrated service profiles, check the installdb log file for any errors. | ||
Step 5 |
If the data migration fails, an import error alarm is
raised on
Cisco Unified Communications
Manager and the Cisco Sync Agent sends a failure notification to the
Cisco Unified CM IM and Presence Administration GUI.
|
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.
This section contains the following information:
This section provides information about troubleshooting Unified Communications Manager upgrades.
Problem The upgrade of a subscriber node fails after you upgrade the Unified Communications Manager publisher node and switch it to the new version, or the upgrade of one of the subscriber nodes in your cluster failed during the upgrade cycle.
Solution Do one of the following:
Correct the errors that caused the upgrade failure on the subscriber node. You may want to check the network connectivity of the nodes in your cluster, reboot the subscriber node, and ensure that the server memory and CPU usage on the subscriber node is not too high. Upgrade the subscriber node again.
Make sure that the active partition of the Unified Communications Manager publisher node runs the newest version of software installed on the server. Perform a fresh installation on the subscriber node using the same software version as that running on the active partition of the publisher node. If you are reinstalling the subscriber node, you should delete the server from Cisco Unified CM Administration and add the server again as described in the Cisco Unified Communications Manager Administration Guide.
Problem The upgrade of Unified Communications Manager fails with an error stating that the common partition is full.
Solution Typically, you need at least 25G of common partition space; however, your deployment may require more space if you have a lot of TFTP data (device firmware loads), music-on-hold (MOH) files, or if you have many locale files installed. Perform one or more of the following actions to create additional disk space:
You can download COP files and their Readme files from Cisco.com. Navigate to
.Problem When you add a new access control group to existing users, the level of privileges for some pre-existing access control groups is unexpectedly reduced.
Solution Users can belong to multiple access control groups. When you add a new access control group to existing users, the current level of privileges for some pre-existing access control groups may be reduced if the new access control group has the "Effective Access Privileges for Overlapping User Groups and Roles" Enterprise parameter set to minimum.
Access privilege reduction can occur inadvertently, for example, during an upgrade of Cisco Unified CM Administration. If the upgrade version supports the Standard RealTimeAndTrace Collection user group, which has the "Effective Access Privileges for Overlapping User Groups and Roles" Enterprise parameter set to minimum, all users are automatically added to that user group during the upgrade. To resolve the permissions issue in this example, you can remove users from the Standard RealTimeAndTrace Collection user group.
For a short period of time after you install Cisco Unified Communications Manager or switch over after upgrading to a different product version, settings that were configured by phone users may be reset. Examples of settings configured by phone users include call forwarding and message waiting indication settings. This situation can occur when Cisco Unified Communications Manager synchronizes the database after an installation or upgrade, which can overwrite setting changes made by phone users.
Problem The upgrade is successful and the cluster is running the new release, but the Unified Communications Manager publisher node subsequently fails.
Solution Do one of the following:
Problem The upgrade is successful and the cluster is running the new release, but a Unified Communications Manager subscriber node subsequently fails.
Solution Do one of the following:
This section provides information about troubleshooting IM and Presence Service upgrades.
Problem You are upgrading a multinode cluster that includes both Unified Communications Manager and IM and Presence nodes, and the upgrade of the IM and Presence database publisher node fails.
Solution The action that you take depends on the point at which the failure occurred:
Problem You are upgrading a multinode cluster that includes both Unified Communications Manager and IM and Presence nodes, and the upgrade of the IM and Presence subscriber node fails.
Solution The action that you take depends on the point at which the failure occurred:
Problem During a refresh upgrade, the following error is reported: Error encountered: The selected upgrade is disallowed from the current version.
Solution You did not install the required COP file on the node. Download the following COP file from Cisco.com: ciscocm.cup.refresh_upgrade_v<latest_version>.cop. Restart the server. Install the COP file on every node in the cluster before you attempt the refresh upgrade again.
Problem During an upgrade on a Cisco IM and Presence server, you cannot select the software image from the disk or remote directory. The following error is reported: The version obtained from the name does not match the active or inactive version of the publisher.
Solution The version matching rules have not been met. The software versions must meet the following requirements:
The software version of the IM and Presence database publisher node (the first IM and Presence node that you upgrade) must match the first two numbers of the software version installed on the Unified Communications Manager publisher node. The software version installed on the Unified Communications Manager publisher node may be active or inactive. For example, IM and Presence Service software version 10.0.1.10000-1 is compatible with Cisco Unified Communications Manager software version 10.0.1.30000-2.
The software version of the IM and Presence subscriber nodes that you upgrade must match five numbers of the software version installed on the IM and Presence database publisher node.
Ensure that the first node that you upgrade is either the Unified Communications Manager publisher node or the IM and Presence database publisher node, or select a different image for the software upgrade.
Problem Switching the version on the Cisco IM and Presence node fails. The following error is reported: Version mismatch. Please switch versions on the publisher and try again.
Solution The version matching rules have not been met. The software versions must meet the following requirements:
The software version of the IM and Presence database publisher node (the first IM and Presence node that you upgrade) must match the first two numbers of the software version installed on the Unified Communications Manager publisher node. For example, IM and Presence Service software version 10.0.1.10000-1 is compatible with Cisco Unified Communications Manager software version 10.0.1.30000-2.
The software version of the IM and Presence subscriber nodes that you upgrade must match five numbers of the software version installed on the IM and Presence database publisher node.
To correct this error, ensure that the first node that you switch is either theUnified Communications Manager publisher node or the IM and Presence database publisher node.
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.
Problem During an IM and Presence Service upgrade, the IM and Presence Service server generates the following error message, even though the upgrade path and file are valid:
The directory was located and searched but no valid options or upgrades were available. Note, a machine cannot be downgraded so option and upgrade files for previous releases were ignored.
Problem The upgrade of IM and Presence Service fails with an error stating that the common partition is full.
Solution Download and apply the COP file ciscocm.free_common_cup_space_v<latest_version>.cop.sgn. This COP file cleans up the common partition and allows subsequent upgrades to proceed as normal.