Phase 5 - Unified Communications Applications Upgrade

Workflow for Upgrading UC Applications

The strategy for upgrading and migrating UC Applications involves the phases provided in the procedure.

Each phase has the following characteristics:

  • Comprises one or more Cisco UC applications, management and data center components.

  • Requires completion in a single or multiple maintenance windows

  • Requires completion in a specific order

  • Includes pre upgrade and post upgrade phase conditions and activities

  • Includes the upgrade maintenance window conditions and activities

You can operate your Cisco HCS deployment between upgrade phases because the application and component groups of any phase are compatible with the subsequent upgrade phases. However, before you upgrade to the next phase, the previous phases must be upgraded to the minimum version. You can upgrade the required Service Provider Cisco HCS Data Center components (based on the minimum versioning analysis) significantly before upgrading the subsequent phases.

Procedure

Step 1

Plan - Pre Upgrade Checks

Provides the pre upgrade checks that need to be performed before upgrade on Cisco UC applications, management and data center components. Perform the following checks in sequence:

  1. Plan - Compatibility and Documentation References

  2. Plan - Unified CM and Unified CM IM and Presence

  3. Plan - Cisco Unity Connection

  4. Plan - Cisco Emergency Responder

Note 

You can use HCM-F Release 11.5(4), to perform few pre upgrade checks on Unified CM, Unified CM IM and Presence, and Cisco Unity Connection. To understand the supported checks and their results, see Upgrade Checks. For executing the checks, see Perform Upgrade Checks.

Step 2

Prepare - Pre Upgrade Actions

Provides the pre upgrade actions or tasks that need to be performed before upgrade on Cisco UC applications. Perform the following tasks in sequence:

  1. Prepare - Unified CM and Unified CM IM and Presence

  2. Prepare - Cisco Unity Connection
Step 3

Upgrade UC Applications

Provides the upgrade tasks that need to be performed on Cisco UC applications (refresh and standard upgrade), management and data center components:

Step 4

Restore UC Application

Provides the post upgrade actions or tasks that need to be performed after upgrade for restoring the UC applications.
Step 5

Validate UC Application

Provides the post upgrade checks that need to be performed after upgrade for validating the applications.

Note 

You can use HCM-F Release 11.5(4) to perform validation by executing the upgrade checks before and after upgrade. The results obtained are used for post upgrade validation. The post upgrade validation is supported on Unified CM, Unified CM IM and Presence, and Cisco Unity Connection. To understand the checks that are used for comparison, see Upgrade Comparison. For executing the comparison, see Post Upgrade Comparison.

Plan for UC Application Upgrade

Plan - Pre Upgrade Checks

This section helps you to:

  • Determine the scope of your upgrade.

  • Understand the hardware, software and component compatibility.


Note

Upgrades can take a long time, depending on the number of customers to be migrated, or the size of individual customers.

Upgrading single customer's UC Application cluster (such as Cisco Unified Communications Manager, Cisco Unity Connection, or Cisco Emergency Responder) may require more than one maintenance window for larger customers.

The following table provides approximate time that is required for upgrade:

Table 1. Time Estimate for Upgrade

Components considered

Approximate time taken

Refresh

Standard (includes upgrade and switch version time)

DC Component

ESXi

30 min

Management Applications

Unified CDM

-

 4 hrs (standalone)

HCM-F

-

 1 hr

PLM

-

 30 min

PCD

-

1 hr 50 min

Unified Communications Applications

Unified CM PUB

3 hrs

4 hrs per node (through PCD)

Unified CM SUB

3 hrs

4 hrs per node (through PCD)
Unity Connection PUB

3 hrs

4 hrs per node (through PCD)

Unity Connection SUB

3 hrs

4 hrs per node (through PCD)

IM and Presence PUB

3 hrs

4 hrs per node (through PCD)

IM and Presence SUB

3 hrs

4 hrs per node (through PCD)

CER PUB

3 hrs

4 hrs per node (through PCD)

CER SUB

3 hrs

4 hrs per node (through PCD)

For information about Refresh and Standard upgrade, see Upgrade and Migration Guide for Cisco Unified Communications Manager and IM and Presence Service at https://www.cisco.com/c/en/us/support/unified-communications/unified-communications-manager-callmanager/products-installation-guides-list.html.

Plan - Unified CM and Unified CM IM and Presence

Perform the following checks. You can use UI or CLI to complete the tasks or checks provided in the Command or Action column. To complete the check using UI, use the reference or use the command in CLI.

Procedure

  Command or Action Purpose
Step 1

Check the network health (Network and Database) by performing these checks:

The health of your system affects the amount of time that an upgrade requires. You can reduce the amount of time needed for an upgrade by ensuring that your system meets the conditions.

Complete and repeat the steps for all upgrade and migration methods.

Step 2

Check device name. In Cisco Unified Communications Manager Administration, use the Device > Phone menu path to check Device Name.

Device name for the Cisco Unified Mobile Communicator device should be less than 15 characters.
Step 3

Ensure that there are no expired certificates on the partition, including any trust certificates in the certificate chain. To verify if certificates are valid, use the following commands in CLI: show cert list own and show cert own certificate.pem. If there are expired certificates, perform one or more of the following procedures:

  • Delete a Trust Certificate
  • Regenerate a Certificate if an identify certificate is expired. To check expired certificates in HCM-F 11.5(4), go to Infrastructure Manager > Service Provider Toolkit > Certificate Monitoring > UC Applications and select Collect Certificates.
Note 
Display fails if there are errors or certificate expires.

Perform this step for refresh upgrades on Cisco Unified Communications Manager and IM and Presence Service nodes only. Expired certificates are not imported during a refresh upgrade. As a result, a new certificate is generated during upgrade process and can cause errors.

Step 4

Do any one of the following:

Verify that the IM and Presence Service node has connectivity with Cisco Unified Communications Manager.

Do this step for only for direct upgrades, which use either the Unified CM OS Admin interface or the PCD Upgrade task to perform the upgrade.

See Upgrade section in Migration to Cisco Unified Communications Manager Using Prime Collaboration Deployment document.

Step 5

Do any one of the following:

Record the current configuration and login information for your Unified Communications Manager nodes in case any issues are encountered during the upgrade process.

Step 6

Do any one of the following:

Use the Real Time Monitoring Tool (RTMT) to capture the device count so that you can verify your endpoints and resources after the upgrade is complete. You can also use this information to verify that you have not exceeded the capacity of the virtual machine (VM) that you are deploying.

Do this step for all upgrade and migration methods.

Step 7

Record the Number of Assigned Users

Record the number of assigned users on IM and Presence Service nodes so that you can verify this information after the upgrade is complete.

Do this step for all upgrade and migration methods.

Step 8

Record TFTP Parameters

The upgrade process changes a TFTP parameter. Record the current setting so that you can reset the parameter after the upgrade is complete.

Step 9

Do any one of the following:

Record the settings for Enterprise Parameters on both Unified Communications Manager nodes and IM and Presence Service nodes. Some Enterprise Parameters exist on both types of nodes and the settings that are configured on Unified Communications Manager nodes may overwrite the settings configured on IM and Presence Service nodes during an upgrade. Record the settings so that you can restore them as needed after the upgrade is complete.

Do this step for all upgrade and migration methods.

Step 10

Check the Available Common Partition Space

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.

Do this step for only for direct upgrades, which use either the Unified CM OS Admin interface or the PCD Upgrade task to perform the upgrade.

Step 11

If you do not have enough common partition space, perform one or more of the following procedures:

Do this step for only for direct upgrades, which use either the Unified CM OS Admin interface or the PCD Upgrade task to perform the upgrade.

Note 
Performing an upgrade without sufficient disk space can cause the upgrade to fail.
Step 12

Ensure that you have the necessary license files for the new release.

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 at https://www.cisco.com/c/en/us/support/cloud-systems-management/prime-license-manager/products-user-guide-list.html for information about generating and installing licenses. For Agnostic HCS UC Applications License information, see Version Agnostic HCS UC Applications License.

Do this step for all upgrade and migration methods.

Note 
Apply all pre-9.0 licenses to Cisco Unified Communications Manager before you upgrade to Release 9.0 or later software. After you upgrade to Release 9.0 or later software, you cannot apply these licenses to Cisco Unified Communications Manager and you cannot apply them using the Cisco Prime License Manager. Ensure that you install all unused licenses or Product Authorization Keys (PAKs) before you upgrade the system. The Cisco Unified Communications Manager displays a warning to prompt you to install any unused licenses before proceeding.
Encryption license is required in PLM if CUCM is in Secure mode before upgrade.
Step 13

Verify Critical Services

Verify that all critical services are activated.

What to do next

See Plan - Cisco Unity Connection.

Factors that Affect Upgrade Time Requirements

The table below lists the factors that impact the amount of time that an upgrade requires. You can reduce the amount of time needed for an upgrade by ensuring that your system meets these conditions.

Table 2. Factors that Affect Time Requirements

Item

Description

External Services and Tools

Time requirements are reduced when external services and tools, such as NTP servers, DNS servers, LDAP directories, and other network services are reachable with response times as short as possible with no dropped packets.

We recommend that you configure the ESXi server and the Unified Communications Manager publisher node to point to the same NTP server.

Note 

To avoid upgrade failures due to time sync issues with VM, disable the VM's NTP sync with the ESXi host using the workaround mentioned in the following link: http://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=1189

Accessibility of upgrade images

Save time by ensuring that ISO images are on DVD, or are already downloaded and staged on the same LAN as the Unified Communications Manager and IM and Presence Service virtual machines (VM).

System health

The virtual machine configuration impacts the time requirement for an upgrade. Use the virtual machine specifications that are correct for your deployment size. If your database exceeds the virtual machine's configuration limits, the upgrade process will take longer to complete or fail. For example, having too many devices for the VM configuration will impact the upgrade.

Low memory or memory leaks will impact the upgrade.

Round Trip Times (RTT) between nodes will extend the time required.

Ensure that there are no OutOfSynch (OOS) tables in the database.

Ensure that there are no SD link out-of -service events on the Unified Communications Manager node. These events typically indicate a network problem, which you must address before you begin the upgrade process.

System errors can impact upgrade time. In the Real Time Monitoring Tool (RTMT) interface, double-click Alert Central in the left navigation pane and ensure that there are no errors.

Physical and virtual hardware infrastructure

Upgrade time is reduced when your infrastructure is configured for high-capacity and low-latency, and when there is low contention from other traffic. For example, you can optimize the upgrade process by ensuring that:

  • There are no infrastructure bottlenecks from VMs sharing same ESXi host, the same Direct Attached Storage (DAS) volume, the same Logical Unit Number (LUN), or the same congested network link.

  • Storage latencies meet the requirements specified at www.cisco.com/go/virtualized-collaboration.

  • The physical CPU cores and the virtualization design comply with virtualization requirements of Unified Communications Manager and IM and Presence Service. Do not oversubscribe CPUs by having VMs share the host resources; use logical cores or resource reservations

  • Unified Communications Manager and IM and Presence Service virtual machines are on same hosts, or on hosts wtih 1GbE LAN between them with low contention from other traffic.

  • If the cluster is over a WAN, ensure that you follow all bandwidth and latency rules listed in the Cisco Collaboration Systems Solution Reference Network Designs (SRND) for at http://www.cisco.com/c/en/us/support/unified-communications/unified-communications-system/products-implementation-design-guides-list.html.

System capacity

Reduce the upgrade time by purging unnecessary files, such as:

  • Call Detail Recording (CDR) records

  • Outdated files, such as TFTP files, firmware, and log files

Throttling

On IM and Presence Service nodes, the system throttles the upgrade process to preserve system stability during upgrades. Throttling may increase the time required to complete the upgrade. Although you can disable throttling to decrease the time it takes to perform the upgrade, doing so may degrade system performance.

Generate a Database Status Report

Use Cisco Unified Reporting Tool (CURT) to generate a Database Status Report to verify that there are no network issues between cluster nodes. For example, verify that there are no issues with reachability or latency that affect database replication between nodes or that affect quality of service (QoS) for voice and video signaling.

Procedure
Step 1

Log in to the reporting interface for the node:

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

Select System Reports.

Step 3

Select the report for the node:

  • To check database replication on a Unified Communications Manager node, select Unified CM Database Status.
  • To check database replication on an IM and Presence Service node, select IM and Presence Database Status.
Step 4

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

Step 5

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

Step 6

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

Check Database Replication

Use this procedure to verify that the database replication is functioning correctly before you begin an upgrade.

Procedure
Step 1

Start a CLI session using one of the following methods:

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

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

Execute the utils dbreplication status command to check for errors or mismatches in the database tables.

Step 3

Execute the utils dbreplication runtimestate command to check if the database replication is active on the node.

The output lists all the nodes and if database replication is set up and in a good state, the replication setup value for each node is 2.

If a value other than 2 is returned, you must resolve the errors before proceeding.
Check Performance Reports
Procedure
Step 1

From the Cisco Unified Serviceability interface, select Tools > Serviceability Reports Archive.

Step 2

Click on the link and choose the most recent report.
Step 3

Click the CallActivitiesRep to open the Call Activities Report in a new tab and verify that the number of Calls Attempted is not too high for the capacity of the virtual machine. You can determine the threshold for the number of Calls Attempted by checking the recommendations for your system in the Cisco Collaboration Systems Solution Reference Network Designs (SRND) at https://www.cisco.com/c/en/us/td/docs/voice_ip_comm/cucm/srnd/collab11/collab11.html.

Step 4

Return to the Cisco Unified Serviceability interface and click the PerformanceRep link for each node to view the Performance Protection Statistics Reports.

Step 5

In each Performance Protection Statistics Report, verify that your system does not exceed the cluster-wide or per-node limits that are specified for your deployment size.

For information about deployment sizing, see:

Run CLI Diagnostics

Use the command line interface (CLI) diagnostic commands to diagnose and solve network problems before you begin and upgrade.

Procedure
Step 1

Start a CLI session using one of the following methods:

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

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

Execute the utils diagnose test command.

This command runs all diagnostic commands but does not attempt to fix problems. You can view a list of all the diagnostic commands by executing the utils diagnose list command.

Step 3

Execute the utils diagnose fix command to attempt to automatically fix system problems.

Network Connectivity

Use this procedure to verify connectivity between all nodes and services in your network.

Procedure
Step 1

Start a CLI session using one of the following methods:

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

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

Execute the show network cluster command on each node in your network to verify communication between Cisco Unified Communications Manager servers in the cluster.

Step 3

To check the cluster size, execute the following commands:

  1. utils dbreplication runtimestate

  2. show network eth0

  3. set network ip eth0 <ipaddress> 255.255.255.0 <gwip>

Step 4

If you have an NTP server, execute the utils diagnose test command to diagnose but not attempt to repair system.

Step 5

If you have an SMTP server, check the name of the SMTP host using show smtp command.

Step 6

Ping to check SMTP IP using utils network ping <smtp IP> command.

Step 7

If you are using DNS, execute the show network eth0 command on each node in your network to verify that the DNS and domain are configured.

Step 8

Ping to check and resolve DNS hostname to an address or an address to a hostname:

  1. utils network ping <hostname>

  2. utils network ping <ip>

Step 9

If you have SFTP server, check the name of the SFTP host using show sftp command.

Step 10

Ping to check and resolve SFTP hostname to an address or an address to a hostname:

  1. utils network ping <hostname>

  2. utils network ping <ip>

Delete a Trust Certificate

A trusted certificate is the only type of certificate that you can delete. You cannot delete a self-signed certificate that is generated by your system.


Caution

Deleting a certificate can affect your system operations. Deleting a certificate can break a certificate chain if the certificate is part of an existing chain. You can verify this relationship from the username and subject name of the relevant certificates in the Certificate List window. You cannot undo this action.

Procedure
Step 1

From Cisco Unified OS Administration, choose Security > Certificate Management.

Step 2

Use the Find controls to filter the certificate list.

Step 3

Choose the filename of the certificate.

Step 4

Click Delete.

Step 5

Click OK.

Note 

  • If the certificate that you delete is of the type "CAPF-trust", "tomcat-trust", "CallManager-trust", or "Phone-SAST-trust", the certificate is deleted across all servers in the cluster.

  • If you import a certificate into the CAPF-trust, it is enabled only on that particular node and is not replicated across the cluster.

Regenerate a Certificate

Before you begin an upgrade, ensure that there are no expired certificates on the partition, including any trust certificates in the certificate chain. Regenerate a certificate if it is expired. Follow this procedure after business hours, because you must restart phones and reboot services. You can regenerate only a certificate that is listed as type "cert" in Cisco Unified OS Administration.


Caution

Regenerating a certificate can affect your system operations. Regenerating a certificate overwrites the existing certificate, including a third-party signed certificate if one was uploaded.

Procedure
Step 1

From Cisco Unified OS Administration, choose Security > Certificate Management.

Enter search parameters to find a certificate and view its configuration details. The system displays the records that match all the criteria in the Certificate List window.

If you click Regenerate button in certificate details page, a self-signed certificate with the same key length is regenerated.

To regenerate a self-signed certificate with a new key length of 3072 or 4096, Click Generate Self-Signed Certificate.

Step 2

Configure the fields on the Generate New Self-Signed Certificate window. See the online help for more information about the fields and their configuration options.

Step 3

Click Generate.

Step 4

Restart all services that are affected by the regenerated certificate. See the Related Topics section for more information about the certificate names and their descriptions.

Step 5

Rerun the CTL client (if configured) after you regenerate the CAPF or CallManager certificates.

Note 

When a Tomcat certificate is regenerated, the TFTP service should be deactivated and later activated. Else, the TFTP will continue to offer the old cached self-signed tomcat certificate.

What to do next

After you regenerate certificates, you must perform a system backup so that the latest backup contains the regenerated certificates.

Certificate Names and Descriptions

The following table describes the system security certificates that you can regenerate and the related services that must be restarted. For information about regenerating the TFTP certificate, see the Cisco Unified Communications Manager Security Guide at http://www.cisco.com/c/en/us/support/unified-communications/unified-communications-manager-callmanager/products-maintenance-guides-list.html.

Table 3. Certificate Names and Descriptions

Name

Description

Related Services

tomcat

tomcat-ECDSA

This self-signed root certificate is generated during installation for the HTTPS node.

Tomcat and TFTP

ipsec

This self-signed root certificate is generated during installation for IPsec connections with MGCP and H.323 gateways.

Cisco Disaster Recovery System (DRS) Local and Cisco DRF Master

CallManager

This self-signed root certificate is installed automatically when you install Unified Communications Manager. This certificate provides node identification, including the node name and the global unique identifier (GUID).

CallManager, CAPF, and CTI

CAPF

The system copies this root certificate to your node or to all nodes in the cluster after you complete the Cisco client configuration.

CallManager and CAPF

TVS

This is a self-signed root certificate.

TVS

Check Connectivity between IM and Presence and Cisco Unified Communications Manager

Verify that the IM and Presence Service node has connectivity with Unified Communications Manager.

Procedure
Step 1

From the Cisco Unified CM IM and Presence Administration interface, select Diagnostics > System Troubleshooter .

The system automatically runs a troubleshooting check.
Step 2

When the results of the troubleshooting check are loaded, verify that all of the Sync Agent Troubleshooter tests have a green checkmark in the Outcome column to indicate that the test was passed.

Step 3

If any of the Sync Agent Troubleshooter tests are failed, use the information in the Problem and Solution columns to resolve the issue before continuing with the upgrade process.

Collect Configuration and Login Information

Record the current configuration and login information for your Unified Communications Manager nodes in case any issues are encountered during the upgrade process.

Procedure
Step 1

Record the following login and password information:

  • all application users credentials, such as DRS, AXL, and accounts for other third-party integrations

  • administrator, cluster security, and Certificate Trust List (CTL) security token passwords
Step 2

Record the following information about your network configuration:

  • IP addresses, hostnames, gateways, domain names, DNS servers, NTP servers, the Call Detail Recording (CDR) server, and SMTP information

  • server versions and time zones

  • services running on each server and the associated activation status

  • LDAP information and access details

  • SNMP information

Record the Registered Device Count

Use the Real Time Monitoring Tool (RTMT) to capture the device count before you begin an upgrade, so that you can verify your endpoints and resources after the upgrade is complete. You can also use this information to verify that you have not exceeded the capacity of the virtual machine (VM) that you are deploying.

Procedure
Step 1

From the Unified RTMT interface, select CallManager > Device > Device Summary.

Step 2

Record the number of registered devices for each node:

Item Count

Registered Phones

  

FSX

  

FSO

  

T1 CAS

  

PRI

  

MOH

  

MTP

  

CFB

  

XCODE

  

Record the Number of Assigned Users

Record the number of assigned users on IM and Presence Service nodes so that you can verify this information after the upgrade is complete.

Procedure
Step 1

From the Cisco Unified CM IM and Presence Administration interface, select System > Cluster Topology.

The Cluster Topology Details page displays information about nodes and subclusters.
Step 2

Record the number of users that are assigned to each node and cluster.

Record TFTP Parameters

During the upgrade process, the TFTP service parameter Maximum Serving Count is changed to allow for an increased number of device registration requests. Record the existing settings so that you can reset the parameter after the upgrade is complete.

Procedure
Step 1

From the Cisco Unified CM Administration interface, choose System > Service Parameters.

Step 2

From the Server drop-down list, select the node that is running the TFTP service.

Step 3

From the Service drop-down list, select Cisco TFTP service.

Step 4

Click Advanced.

Step 5

Click Save.

Step 6

Record the value that is configured for the Maximum Serving Count.

Check the Available Common Partition Space

Use the Real-Time Monitoring Tool (RTMT) to verify that you have enough common partition space for the upgrade.

Procedure
Step 1

In the Real-Time Monitoring Tool, select Disk Usage from the list of System counters on the left navigation pane.

A page displays detailed information about disk usage.
Step 2

View the tables on the bottom of the page and compare the Total Space to the Used Space for the common partition. You need a minimum 25G of available common partition space before you begin an upgrade. However, your deployment may require more space if you have numerous TFTP data (device firmware loads), music-on-hold (MOH) files, or if you have many locale files installed. In some cases, even if 25GB of free space is available, upgrade may fail with the error message as insufficient space.The workaround is to delete the unnecessary files and create more space in the common partition.

Adjust High and Low Watermarks

Use this procedure to adjust the low and high watermarks to reduce the traces and remove unnecessary log files. After the upgrade, you must restore the high and low watermarks to their original values in order to avoid premature purging of traces. The default value for the high watermark is 85. The default value for the low watermark is 80.

Procedure
Step 1

In the Real Time Monitoring Tool (RTMT) interface, double-click Alert Central in the left navigation pane.

Step 2

On the System tab, right-click LogPartitionLowWaterMarkExceeded and select Set Alert/Properties.

Step 3

Select Next.

Step 4

Adjust the slider value to 30.
Step 5

On the System tab, right-click LogPartitionHighWaterMarkExceeded and select Set Alert/Properties.

Step 6

Select Next.

Step 7

Adjust the slider value to 40.

Create Additional Partition Space

To create additional space in the common partition, you can perform one or more of the steps in this procedure. To download the COP files and the Readme files that are listed in this procedure, go to https://software.cisco.com > click Software Download link under Download & Upgrade section, and then, navigate to Unified Communications > Call Control > Cisco Unified Communications Manager (CallManager) > <Version> > Unified Communications Manager/CallManager/Cisco Unity Connection Utilities.

Procedure
Step 1

Manually remove outdated or unused firmware files from the TFTP directory using one of the following options:

  • From the Cisco Unified OS Administration interface, select Software Upgrades > TFTP File Management and delete any unnecessary files.
  • From the command line interface, use the file list tftp and file delete tftp commands delete any unnecessary files.
  • From the Cisco Unified OS Administration interface, select Software Upgrades > Device Load Management and delete any unnecessary files.
Note 

Run the show diskusage tftp <sort> command, to check tftp device load size, which is sorted by descending file size.

Run the show diskusage common <sort> command, to check the common partition size for available, and free space, which is sorted by descending file size.

Step 2

If you are upgrading from release 9.x and earlier, use the Disk Expansion COP file (ciscocm.vmware-disk-size-reallocation-<latest_version>.cop.sgn) to expand the vDisk size if your virtual environment has additional available disk space.

Ensure that you review the Readme file that supports this COP file before you proceed.

Step 3

Perform this step only if the previous steps did not create enough disk space for the upgrade. Use the Free Common Space COP file (ciscocm.free_common_space_v<latest_version>.cop.sgn).

This COP file removes the inactive side in the common partition to increase available disk space without requiring a system rebuild. Ensure that you review the Readme file that supports this COP file before you proceed.

Note 

You will not be able to switch back to the inactive version after installing this file because the inactive partition becomes unusable.

Note 

For 110G or 80G single disk or two 80G disk deployments, available space for upgrade should be at least twice the active partition disk space. For example, in a two 80G disk deployment, active partition should not be more than 25G, and available space should be at least 50G. Following are commands to check the disk usage.

  1. Run the show diskusage activelog <sort> command, to check active side partition size, which is sorted by descending file size.

  2. Run the show diskusage common <sort> command, to check the common partition size for available, and free space, sorted by descending file size.

  3. Run the show diskusage tftp <sort> command, to check tftp device load size, which is sorted by descending file size.

  4. Run the file delete activelog <filename> command, to delete logs from active partition.

Version Agnostic HCS UC Applications License

Cisco HCS Release 11.5 supports version agnostic license bundles for UC applications in Prime License Manager (PLM). You can upgrade from HCS 10.x to HCS 11.x without requiring upgrade licenses. Only PLM version 11.5(1) SU1a or higher supports version agnostic license bundles.

The version agnostic HCS license is supported with HCS and HCS LE license types, except HCS EA. The version agnostic HCS license supports all the UC application licenses managed by PLM (for example, CUCM, CUCxn, and CER).

Note

Cisco Emergency Responder (CER) 10.0 does not support HCS licenses. CER 10.0 should be upgraded to CER 10.5 to be compatible with HCS version agnostic licensing. Contact Cisco HCS Licensing at mailto:hcs-license@cisco.com to upgrade CER 10.0 licenses to HCS CER 10.x licenses.

If you are planning to upgrade CUCM or CUC to 11.5 SU3 or higher, we recommend you to upgrade PLM to version 11.5 SU2. CUCM 11.5 SU3 and CUC 11.5 SU3 requires PLM 11.5 SU2.

If you require an encyption license, we recommend that you upgrade to PLM version 11.5(1) SU2. See Encryption License for more information.


Important

  • After a fresh install or upgrade to HCS 11.5, install Prime License Manager 11.5(1) SU2. Refer to the Download Software page for downloading the ISO file for Prime License Manager; navigate to Products > Cloud and System Management > Collaboration and Unified Communications Management > Prime License Manager.

  • There is no 11.x license available for CUCM, CUCxn, or CER; if you request one, Cisco will ship a 10.x license. When PLM 11.5(1) SU2 detects that the 10.x license is present in your HCS installation, it will approve CUCM 11.x.

  • HCS 11.5 License and Service Inventory reports show the license type as 10.x rather than 11.x.

Encryption License

Cisco Prime License Manager supports the encryption license, which enables higher levels of encryption for registered products. Some newer Cisco products, such as Cisco Unified Communications Manager Release 11.5(1)SU3, require an encryption license to run in mixed mode.


Note

If you are running Cisco Unified Communications Manager Release 11.5(1)SU3 or Cisco Unity Connection 11.5(1)SU3, you must upgrade to or install Cisco Prime License Manager 11.5(1)SU2.

Cisco Emergency Responder (CER) 10.0 does not support HCS licenses. CER 10.0 should be upgraded to CER 10.5 to be compatible with HCS version agnostic licensing.

Record Enterprise Parameters

Record the settings for Enterprise Parameters on both Unified Communications Manager nodes and IM and Presence Service nodes. Some Enterprise Parameters exist on both Unified Communications Manager nodes and IM and Presence Service nodes. Where the same parameter exists, the settings that are configured on Unified Communications Manager nodes overwrite the settings configured on IM and Presence Service nodes during the upgrade process. Enterprise Parameters that are unique to IM and Presence Service nodes are retained during an upgrade.

Record the settings so that you can restore them as needed after the upgrade is complete.

Procedure
Step 1

From the Cisco Unified CM Administration interface, choose System > Enterprise Parameters.

Step 2

Take screen captures to record the settings that you have configured, and save the information so that you can restore the settings after the upgrade is complete.

Step 3

From the Cisco Unified CM IM and Presence Administration interface, choose System > Enterprise Parameters.

Step 4

Take screen captures to record the settings that you have configured, and save the information so that you can restore the settings after the upgrade is complete.

Verify Critical Services

Use the Cisco Unified Real Time Monitoring Tool (RTMT) to verify that all critical services are activated.

Procedure
Step 1

From the Unified RTMT interface, select System > Server > Critical Services.

Step 2

To display system critical services, click the System tab.

Step 3

To display Unified Communications Manager critical services, select a Unified Communications Manager node from the drop-down list and click the Voice/Video tab.

Step 4

To display IM and Presence Service critical services, click the IM and Presence tab and select an IM and Presence Service node from the drop-down list.

Step 5

If the status indicates that any critical services are stopped, reactivate them before beginning the upgrade.

Plan - Cisco Unity Connection

Perform the following steps:

Procedure

Step 1

Ensure that you have a good network connection to avoid service interruptions during upgrade.

To check the network reachability to subscribers, DNS and default gateway, login to Publisher admin CLI and use the following commands:

  1. # utils network ping <CUC_Subscriber_IP>

  2. # utils network ping <Default_Gateway_IP>

  3. # utils network ping <DNS_IP> 
Step 2

Check the network reachability to FTP or SFTP server.

To check the network reachability to FTP or SFTP server, login to Publisher admin CLI and use the following command in CLI:

#utils network ping <SFTP_Server_IP>
Step 3

Check the server status in a cluster and confirm the running state of database replication. Publisher and subscriber servers must be active for answering the calls. This check can be done through CUC Servicebility UI or Publisher CLI.

To confirm if the server in a cluster is active, do any one of the following:

  • Perform the following steps through CUC Serviceability UI:

    1. Sign in to CUC Serviceability UI.

    2. Expand Tools and select Cluster Management.

  • Use the following commands on Publisher CLI:

    1. #utils service list

    2. # show cuc cluster status

    3. # utils dbreplication runtimestate
Step 4

Before upgrading to the release 11.x, rename the notification templates if created. To check the notification templates, login to CUC Publisher and navigate to Cisco Unity Connection Administration Page. Then, navigate to Templates > Notification Templates > Notification Templates.

Rename the notification templates if created with the below mentioned names:

  • Default_Missed_Call_With_Summary

  • Default_Scheduled_Summary

  • Default_Voice_Message_With_Summary

  • Default_Dynamic_Icons

  • Default_Actionable_Links_Only

What to do next

See Plan - Cisco Emergency Responder.

Plan - Cisco Emergency Responder

Perform the following steps as part of planning phase for CER.

Procedure

Command or Action Purpose

Ensure that the PLM has hosted license for CER.

Request for hosted license for CER from License tool and upload hosted CER License in PLM.

Note 

In 10.1(1), CER consumes Enterprise License. After upgrade to 11.5, CER consumes hosted license.

For information about license, see Cisco Emergency Responder Administration Guide at https://www.cisco.com/c/en/us/support/unified-communications/emergency-responder/products-maintenance-guides-list.html.

What to do next

See Prepare - Pre Upgrade Actions.

Prepare for UC Application Upgrade

Prepare - Pre Upgrade Actions

This section helps you to complete the pre-upgrade tasks for the following Collaboration Applications and prepare for upgrade. Perform the following procedures to complete the pre-upgrade actions:

Procedure

Step 1

Prepare - Unified CM and Unified CM IM and Presence

Provides steps to follow before upgrading CUCM.
Step 2

Prepare - Cisco Unity Connection

Provides steps to follow before upgrading CUC.

Prepare - Unified CM and Unified CM IM and Presence

Perform the following steps. You can use UI or CLI to complete the tasks or checks provided in the Command or Action column. To complete the check using UI, use the reference or use the command in CLI.

Procedure

  Command or Action Purpose
Step 1

Take a Fresh Backup

You must create a fresh backup file.

Do this step for all upgrade and migration methods.

Note 
You may lose data or you may be unable to restore your system if your backup is outdated.

If you have custom ringtones or background images in the TFTP directory, you need to create a separate backup for these files. They are not included in the Disaster Recovery System (DRS) backup file. See, Back Up Custom Ringtones and Background Images
Step 2

Export User Records

Export user records using the Bulk Administration Tool (BAT).

Do this step for all upgrade and migration methods.
Step 3

Upgrade IP Phone Firmware

You can upgrade your IP phones to the firmware that corresponds to the new release as a pre-upgrade task. Although IP phones automatically download their new firmware after an upgrade, you can choose to apply new firmware files to the endpoints in a controlled manner prior to the upgrade in order to minimize phone downtime after an upgrade.

Do this step for direct upgrades, which use either the Unified CM OS Admin interface or the PCD Upgrade task to perform the upgrade.

Step 4

Do any one of the following:

Perform this procedure only if you are upgrading from Release 9.x or earlier. For upgrades from Release 9.x or earlier, you need to stop Cisco Extension Mobility services on CUCM nodes before you begin an upgrade.

Note 

EM users who are already logged in can make calls normally and will remain logged in. Only, logout of existing EM users and login of fresh EM users will not work.

Do this step for only for direct upgrades, which use either the Unified CM OS Admin interface or the PCD Upgrade task to perform the upgrade.

Step 5

Do any one of the following:

Stop TFTP services on CUCM nodes before you begin an upgrade.
Step 6

Do any one of the following:

If you need to upgrade CUCM as part of your IM and Presence upgrade, you need to stop the IM and Presence Sync Agent service before you begin the upgrade process.

Do this step for only for direct upgrades, which use either the CUCM OS Admin interface or the PCD Upgrade task to perform the upgrade.

Step 7

Do any one of the following:

  • Obtain Upgrade Files
  • To check if the COP file is available, use the following commands in CLI: sh version active and sh version inactive

Download the upgrade files for the CUCM and the IM and Presence Service.

Note 

For refresh upgrades, you must also download the upgrade COP files.

Do this step for only for direct upgrades, which use either the Unified CM OS Admin interface or the PCD Upgrade task to perform the upgrade.

Step 8

Increase the Database Replication Timeout

Optional. This procedure applies to the CUCM publisher node only. Use this procedure when you upgrade large clusters. If you increase the database replication timeout, you need to restore the timeout to the default value after the entire cluster upgrades and the CUCM subscriber nodes have successfully set up replication.

Do this step for only for direct upgrades, which use either the Unified CM OS Admin interface or the PCD Upgrade task to perform the upgrade.

Step 9

Disable High Availability on Presence Redundancy Groups

This procedure applies to IM and Presence Service nodes only. If you have configured presence redundancy groups for high availability, you need to disable it during the upgrade process.

Do this step for only for direct upgrades, which use either the Unified CM OS Admin interface or the PCD Upgrade task to perform the upgrade.

Step 10

Add a Serial Port to the Virtual Machine

Add a serial port to the virtual machine so that you can dump logs in the event of an upgrade failure. Perform this procedure for all nodes.

Note 

Shut down and power on the VMs in the following order:

  1. Unified CM PUB

  2. Unified CM SUB

  3. IM and Presence PUB

  4. IM and Presence SUB

Do this step for all upgrade and migration methods.
Step 11

Subnet mask correction. To verify the subnet mask, use the following command in CLI: set network ip eth0 server_ip_address 255.255.255.0.

Take a Fresh Backup

You must backup the system before you perform an upgrade to ensure that the backup file matches the currently-installed software exactly. If you try to restore the system from a backup file that does not match the current version, the restore will fail.

Perform this procedure for all upgrade and migration methods.


Caution

You may lose data or you may be unable to restore your system if your backup is outdated.
Before you begin

  • Ensure 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.

  • Ensure that your system meets the version requirements:

    • All Unified Communications Manager cluster nodes must be running the same version of the Unified Communications Manager application.

    • All IM and Presence Service cluster nodes must be running the same version of the IM and Presence Service application.

    For each application, the entire version string must match. For example, if the IM and Presence database publisher node is at version 11.5.1.10000-1, then all IM and Presence subscriber nodes must be 11.5.1.10000-1, and you must create a backup file for version 11.5.1.10000-1.

  • The backup process can fail due to non availability of space on a remote server or due to interruptions in the network connectivity. You need to start a fresh backup after addressing the issues that caused the backup to fail.

  • Make sure that you have a record of the cluster security password. If the cluster security password changes after you complete this backup, you will need to know the password or you will not be able to use the backup file to restore your system.

Procedure
Step 1

From the Disaster Recovery System, select Backup > Manual Backup.

Step 2

In the Manual Backup window, select a backup device from the Backup Device Name area.

Step 3

Choose a feature from the Select Features area.

Step 4

Click Start Backup.

Back Up Custom Ringtones and Background Images

If you have custom ringtones or background images in the TFTP directory, you need to create a separate backup for these files. They are not included in the Disaster Recovery System (DRS) backup file.

Procedure
Step 1

Use a web browser or TFTP client to access the directories where the ringtones and background images are stored.
Step 2

Backup the following files: Ringlist.xml and List.xml .

Step 3

Back up the custom ringtones. These are located in the TFTP directory.
Step 4

Back up the background images. These are located in the folder /Desktops (and its subfolders) in the TFTP directory.

Export User Records

Export user records using the Bulk Administration Tool (BAT).

Procedure
Step 1

From Cisco Unified CM Administration, choose Bulk Administration > Users > Export Users.

Step 2

Click Find to display all user records.

Step 3

Click Next.

Step 4

Enter a filename in the in the File Name text box and choose file format from the File Format drop-down list.

Step 5

In the Job Information area, enter the Job description.

Step 6

Click Run Immediately to export user records immediately

Step 7

Click Submit.

Step 8

To download the exported file, choose Bulk Administration > Upload/Download Files.

Step 9

Enter search criteria for the file that you generated and click Find.

Step 10

Select the check box that corresponds to the file that you want to download and click Download Selected.

Step 11

In the File Download pop-up window, click Save.

Step 12

In the Save As pop-up window, choose the location where you want to save the file and click Save. Ensure that you copy the file off of the server and save it to a remote PC or device.

Upgrade IP Phone Firmware

You can upgrade your IP phones to the firmware that corresponds to the new release as a pre-upgrade task. Although phones automatically download their new firmware after an upgrade, you can choose to apply new firmware files to the endpoints in a controlled manner prior to the upgrade in order to minimize phone downtime after an upgrade.

When you apply new firmware to phones in groups, you can eliminate the load on the TFTP server after the upgrade and accelerate the upgrade of the individual devices. Afterwards, restart the TFTP service on the Unified Communications Manager servers, and restart the IP Phones in a controlled order to minimize downtime. Because the phones cannot be used for calls when their firmware is being upgraded, we recommend that you use a maintenance window outside of your upgrade window to upgrade phone firmware.

Before you begin

  • Copy the new firmware load to the following directory on the TFTP server: /usr/local/cm/tftp

  • Make a record of the system defaults and per-device assignments for your IP phones and registered endpoints.

Procedure
Step 1

From Cisco Unified OS Administration, choose Software Upgrades > Install/Upgrade.

Step 2

Fill in the applicable values in the Software Location section and click Next.

Step 3

In the Available Software drop-down list, select the device package file and click Next.

Step 4

Verify that the MD5 value is correct, and then click Next.

Step 5

In the warning box, verify that you selected the correct firmware, and then click Install.

Step 6

Check that you received a success message.

Note 
Skip to Step 8 if you are rebooting the cluster.
Step 7

Stop and restart the TFTP server.

Step 8

Reset the affected devices to upgrade the devices to the new load.

Step 9

From Cisco Unified CM Administration, choose Device > Device Settings > Device Defaults and manually change the name of the "Load Information" and "Inactive Load Information" for the specific Device Type fields for the new load on the TFTP server.

Step 10

Click Save, and then reset the devices.

Deactivate Cisco Extension Mobility

Perform this procedure only if you are upgrading from Release 9.x or earlier. For upgrades from Release 9.x or earlier, you must stop Cisco extension mobility on Unified Communications Manager nodes before you begin an upgrade.

Procedure
Step 1

From Cisco Unified Serviceability, choose Tools > Service Activation.

Step 2

From the Server list, choose the node on which you want to deactivate services and click Go.

Step 3

Deselect the Cisco Extension Mobility services.

Step 4

Click Stop.

Step 5

Repeat Steps 2 through 4 for each node that is running Cisco Extension Mobility services.

Step 6

Make a list of all the nodes on which you have disabled these services. You will need to restart the services after the upgrade is complete.

Deactivate TFTP services

Use this procedure to stop TFTP services on Unified Communications Manager nodes before you begin an upgrade.

Procedure
Step 1

From Cisco Unified Serviceability, choose Tools > Service Activation.

Step 2

From the Server list, choose the node on which you want to deactivate services and click Go.

Step 3

Deselect Cisco TFTP services.

Step 4

Click Stop.

Step 5

Repeat Steps 2 through 4 for each node that is running Cisco TFTP services.

Step 6

Make a list of all the nodes on which you have disabled these services. You will need to restart the services after the upgrade is complete.

Stop the IM and Presence Sync Agent

If you need to upgrade Unified Communications Manager as part of your IM and Presence upgrade, you must stop the IM and Presence Sync Agent service before you begin the upgrade process.

Procedure
Step 1

From the Cisco Unified Serviceability interface, select Tools > Control Center - Network Services.

Step 2

Select an IM and Presence Service node from the Server drop-down list and click Go.

Step 3

In the IM and Presence Services section, select the Cisco Sync Agent and click Stop.

Check the Available Common Partition Space

Use the Real-Time Monitoring Tool (RTMT) to verify that you have enough common partition space for the upgrade.

Procedure
Step 1

In the Real-Time Monitoring Tool, select Disk Usage from the list of System counters on the left navigation pane.

A page displays detailed information about disk usage.
Step 2

View the tables on the bottom of the page and compare the Total Space to the Used Space for the common partition. You need a minimum 25G of available common partition space before you begin an upgrade. However, your deployment may require more space if you have numerous TFTP data (device firmware loads), music-on-hold (MOH) files, or if you have many locale files installed. In some cases, even if 25GB of free space is available, upgrade may fail with the error message as insufficient space.The workaround is to delete the unnecessary files and create more space in the common partition.

Adjust High and Low Watermarks

Use this procedure to adjust the low and high watermarks to reduce the traces and remove unnecessary log files. After the upgrade, you must restore the high and low watermarks to their original values in order to avoid premature purging of traces. The default value for the high watermark is 85. The default value for the low watermark is 80.

Procedure
Step 1

In the Real Time Monitoring Tool (RTMT) interface, double-click Alert Central in the left navigation pane.

Step 2

On the System tab, right-click LogPartitionLowWaterMarkExceeded and select Set Alert/Properties.

Step 3

Select Next.

Step 4

Adjust the slider value to 30.
Step 5

On the System tab, right-click LogPartitionHighWaterMarkExceeded and select Set Alert/Properties.

Step 6

Select Next.

Step 7

Adjust the slider value to 40.

Create Additional Partition Space

To create additional space in the common partition, you can perform one or more of the steps in this procedure. To download the COP files and the Readme files that are listed in this procedure, go to https://software.cisco.com > click Software Download link under Download & Upgrade section, and then, navigate to Unified Communications > Call Control > Cisco Unified Communications Manager (CallManager) > <Version> > Unified Communications Manager/CallManager/Cisco Unity Connection Utilities.

Procedure
Step 1

Manually remove outdated or unused firmware files from the TFTP directory using one of the following options:

  • From the Cisco Unified OS Administration interface, select Software Upgrades > TFTP File Management and delete any unnecessary files.
  • From the command line interface, use the file list tftp and file delete tftp commands delete any unnecessary files.
  • From the Cisco Unified OS Administration interface, select Software Upgrades > Device Load Management and delete any unnecessary files.
Note 

Run the show diskusage tftp <sort> command, to check tftp device load size, which is sorted by descending file size.

Run the show diskusage common <sort> command, to check the common partition size for available, and free space, which is sorted by descending file size.

Step 2

If you are upgrading from release 9.x and earlier, use the Disk Expansion COP file (ciscocm.vmware-disk-size-reallocation-<latest_version>.cop.sgn) to expand the vDisk size if your virtual environment has additional available disk space.

Ensure that you review the Readme file that supports this COP file before you proceed.

Step 3

Perform this step only if the previous steps did not create enough disk space for the upgrade. Use the Free Common Space COP file (ciscocm.free_common_space_v<latest_version>.cop.sgn).

This COP file removes the inactive side in the common partition to increase available disk space without requiring a system rebuild. Ensure that you review the Readme file that supports this COP file before you proceed.

Note 

You will not be able to switch back to the inactive version after installing this file because the inactive partition becomes unusable.

Note 

For 110G or 80G single disk or two 80G disk deployments, available space for upgrade should be at least twice the active partition disk space. For example, in a two 80G disk deployment, active partition should not be more than 25G, and available space should be at least 50G. Following are commands to check the disk usage.

  1. Run the show diskusage activelog <sort> command, to check active side partition size, which is sorted by descending file size.

  2. Run the show diskusage common <sort> command, to check the common partition size for available, and free space, sorted by descending file size.

  3. Run the show diskusage tftp <sort> command, to check tftp device load size, which is sorted by descending file size.

  4. Run the file delete activelog <filename> command, to delete logs from active partition.

Obtain Upgrade Files

You must download the upgrade file for the new release, as well as any upgrade Cisco Option Package (COP) files that are required.

Procedure
Step 1

Refer to the table below this procedure to identify the COP files, if any, that you need.
Step 2

Download the upgrade files for the applications from Cisco.com. The software is available in export restricted (K9) and export unrestricted versions (XU), so be sure to confirm that you select the correct file.

  • To download the Unified Communications Manager upgrade file, go to https://software.cisco.com > click Software Download link under Download & Upgrade section, and then, navigate to Unified Communications > Call Control > Cisco Unified Communications Manager (CallManager) > <Version> > Unified Communications Manager/CallManager/Cisco Unity Connection Updates.
  • To download the IM and Presence Service upgrade file, go to https://software.cisco.com > click Software Download link under Download & Upgrade section, and then, navigate to Unified Communications > Unified Communications Applications > Presence Software > Unified Communications Manager IM and Presence Service > <Version> > Unified Presence Service (CUP) Updates.
Step 3

Go to https://software.cisco.com > click Software Download link under Download & Upgrade section, and then, navigate to Unified Communications > Call Control > Cisco Unified Communications Manager (CallManager) > <Version> > Unified Communications Manager/CallManager/Cisco Unity Connection Utilities to download COP files for Unified Communications Manager.

Step 4

Go to https://software.cisco.com > click Software Download link under Download & Upgrade section, and then, navigate to Unified Communications > Unified Communications Applications > Presence Software > Unified Communications Manager IM and Presence Service > <Version> > Unified Presence Service (CUP) Updates and select UTILS to download COP files for IM and Presence Service.

COP Files Required for Upgrades to Release 11.5

The tables below lists the upgrade paths that require COP files. You must install COP files on each node before you begin an upgrade using the Cisco Unified OS Admin interface, or before you begin an upgrade or migration using the Prime Collaboration Deployment (PCD) tool. If you are using PCD, you can perform a bulk installation of the COP files before you begin the upgrade.

Table 4. Required COP Files for Upgrades and Migrations to Cisco Unified Communications Manager Release 11.5(x)
From To Upgrade Type

8.6(x)

11.5(x)

Refresh upgrade. Required COP files:

Optional COP files:

  • ciscocm.vmware-disk-size-reallocation-<latest_version>.cop.sgn)

  • ciscocm.free_common_space_v<latest_version>.cop.sgn

9.1(x)

11.5(x)

Refresh upgrade. Required COP files:

Optional COP files:

  • ciscocm.vmware-disk-size-reallocation-<latest_version>.cop.sgn)

  • ciscocm.free_common_space_v<latest_version>.cop.sgn

10.5(x)

11.5(x)

Standard upgrade; no COP file required.

11.0(x)

11.5(x)

Standard upgrade; no COP file required.

11.5(x)

11.5((y)

Standard upgrade; no COP file required.
Table 5. Required COP Files for Refresh Upgrades from Cisco Unified Presence Releases
From Cisco Unified Presence Release To IM and Presence Release Upgrade Type

8.5(4) through 8.6(1)

11.5(x)

Refresh upgrade. Requires the following COP files:

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

  • ciscocm.version3-keys.cop.sgn
Table 6. Required COP Files for Refresh Upgrades from IM and Presence Service Releases

From IM and Presence Release

To IM and Presence Release

Upgrade Type

9.1(x)

11.5(x)

Refresh upgrade. Requires the following COP file:

  • ciscocm.version3-keys.cop.sgn

10.5(x)

11.5(x)

Standard upgrade; no COP file required.

11.0(x)

11.5(x)

Standard upgrade; no COP file required.

11.5(x)

11.5(y)

Standard upgrade; no COP file required.

Increase the Database Replication Timeout

Perform this procedure on the Unified Communications Manager publisher node only.

Increase the database replication timeout value when you upgrade large clusters so that more Unified Communications Manager subscriber nodes have sufficient time to request replication. When the timer expires, the first Unified Communications Manager subscriber node, plus all other Unified Communications Manager subscriber nodes that requested replication within that time period, begin a batch data replication with the Unified Communications Manager database publisher node.

Procedure
Step 1

Start a CLI session using one of the following methods:

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

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

Execute the utils dbreplication setrepltimeout timeout command, where timeout is database replication timeout, in seconds. Ensure that the value is between 300 and 3600.

The default database replication timeout value is 300 (5 minutes).

Disable High Availability on Presence Redundancy Groups

This procedure applies to IM and Presence Service nodes only. Use it to disable high availability on the IM and Presence presence redundancy group.

Before you begin

Take a record of the number of active users for each cluster node in each Presence Redundancy Group. You can find this information in the (System > Presence Topology) window of Cisco Unified CM IM and Presence Administration. You will need this information later when you re-enable High Availability.

Procedure
Step 1

From the Cisco Unified CM Administration user interface, choose System > Presence Redundancy Groups.

Step 2

Click Find and select the group.

Step 3

On the Presence Redundancy Group Configuration window, uncheck the Enable High Availability check box.

Step 4

Click Save.

Step 5

Repeat this procedure for each Presence Redundancy Group.
Step 6

When you are done, wait at least two minutes to sync the new HA settings across the cluster before you make any further changes

Add a Serial Port to the Virtual Machine

Add a serial port to the virtual machine so that you can dump logs in the event of an upgrade failure.

Procedure
Step 1

Power off the virtual machine.

Step 2

Edit the settings to add a serial port. For more information about making configuration changes using vSphere Client, refer to the user manual for the product.

Step 3

Attach the serial port to a .tmp file.
Step 4

Power on the virtual machine and proceed with the upgrade.
What to do next

After you successfully upgrade the system, follow the procedure to Remove the Serial Port. In the event of an upgrade failure, refer to Dump a Log File After an Upgrade Failure.

Dump a Log File After an Upgrade Failure

Use this procedure in the event of a failure when you are upgrading Uinified Communications Manager or the IM and Presence Service.

Before you begin

You need the 7-Zip utility to open the log files. Go to http://www.7-zip.org/download.html

Procedure
Step 1

Attach a new, empty file to the serial port. Edit the settings on the VM and attach the file name where you want the logs dumped.

Note 

If the system stops running due to an upgrade failure and prompts you to dump the logs, you must attach the empty file before you answer Yes and proceed.

Step 2

Return to the VM console, and dump the logs into the serial port.

Step 3

When the process is complete, click Inventory > Datastores and Datastore Clusters.

Step 4

Select the datastore where you created the file.

Step 5

Right-click and choose Browse Datastore and browse to the file that you created.

Step 6

Right-click the file, select Download, and select a location on your PC to save the file.

Step 7

Open the file using 7-Zip and check the file size:

  • If the size of the file is larger than 0, extract the files to your PC and then edit the settings on the virtual machine to remove the serial port.
  • If the file size is 0, proceed to the next step.
Step 8

If the file size is zero, complete the following steps:

  1. Power off the virtual machine.

  2. Create a new file for log output.

  3. Unmap the installation disk.

  4. On the Options tab, select Boot Options and enable Force BIOS Setup.

  5. Power on the virtual machine and wait for it to boot to the BIOS.

  6. In the BIOS, select the hard drive as the first boot device and save and exit.

    The system will boot to the hard drive and go back to the point where the upgrade failed. A failure notification displays.

  7. Input yes to dump the contents of the log to a file.

  8. Navigate to the file and open it using 7-Zip.
Step 9

If the size of the file is larger than 0, extract the files to your PC and then edit the settings on the virtual machine to remove the serial port.

Prepare - Cisco Unity Connection

Perform the following steps as part of prepare phase for CUC.

Procedure

Step 1

Determine if you need COP files depending on the upgrade process.

Go to the following URL and select the Unity Connection Release for downloading the COP files:

https://software.cisco.com/download/home/280082558
Step 2

Backing Up and Restoring Cisco Unity Connection Components

Backup all the existing data.

To backup existing data, use the following command in CLI: utils disaster_recovery history backup.

Step 3

Confirm the status of publisher and subscriber servers. Both the servers need to be active and answer calls.

Perform the following steps to confirm the server status in a cluster:

  1. Sign in to Cisco Unity Connection Serviceability.

  2. Expand Tools and select Cluster Management.

  3. Check the server status in a cluster.

  4. Confirm the running state of database replication.

To confirm the status of Publisher and Subscriber, use the following commands on Publisher CLI:

  1. # utils service list

  2. # show cuc cluster status

  3. # utils dbreplication status

  4. # utils dbreplication runtimestate
Step 4

Initiate a pre-upgrade test before starting the upgrade process.

On the CUC Publisher Admin CLI, enter the following command to initiate a pre-upgrade test:

# run cuc preupgrade test

Back Up and Restore Cisco Unity Connection Components

Configuring DRS Backup

Note

In a cluster deployment, you need to take the backup of publisher server only
Procedure
Step 1

Set up and configure the FTP or SFTP server(s) used for storing the backups.

A number of SFTP applications, such as Free FTP and Core FTP mini SFTP server are available that can be used to store and retrieve the backups.

To configure the FTP or SFTP server, you must define the directory that stores the backup and create an account that DRS can use to store and retrieve the backups.

Note 
Make sure there is enough capacity in the directory for the required number and size of backups. Keep in mind that the size of the backups increase as the organization grows.
Step 2

Configure a backup device in DRS.

Each DRS backup device consists of the backup location, the FTP or SFTP account credentials, and the total number of backups that can be stored at the backup location. When the total number of allowed backups is reached, DRS overwrites the oldest backup on the server.

Follow the given steps to configure a backup device:

  • Sign in to Disaster Recovery System and login using the same administrator username and password that you use for Cisco Unified Operating System Administration.

  • Select Backup> Backup Device. The Backup Device window displays. Select Add New.

  • Enter the backup device name, network configuration information and the number of backups to store on network directory.

  • Select Save to create the backup device.

Note 

Depending on the backup policy and organization, it is advisable to create multiple backup devices for redundancy. If the organization consists of multiple locations, each location should have its own set of backup devices

Caution 
Do not use the same network location/directory for different backup devices. Backup files for each Unity Connection server must be stored in a directory dedicated to that server.
Step 3

Configure the backup process

After creating the backup device, you can

Configuring a Backup Schedule

You can create a different backup schedule for each backup device you created. Backup schedule can be configured to run the backup at different times. It is recommended to take multiple schedules, each stored on a different network location.

In most of the cases, you should set a schedule that performs a nightly backup during a defined maintenance window when there is the least amount of server and network traffic.

You can configure up to ten backup schedules, each has its own backup device, features, and components.


Note
Disabling the schedule allows you to prevent the scheduled backups from running without deleting the schedule entirely.

To Configure a Backup Schedule for Each Backup Device in Disaster Recovery System

Procedure
Step 1

Sign in to Disaster Recovery System and login using the same Administrator username and password that you use for Cisco Unified Operating System Administration.

Step 2

Select Backup> Scheduler. The Schedule List window displays.

Step 3

On the Schedule List window, select Add New to create a new backup schedule. The Scheduler window displays.

Step 4

On the Scheduler window, the following information are mentioned to configure a schedule:

  • Schedule Name: Specify a schedule name.
  • Select Backup Device: Specify the backup device for which you want to create a schedule.
  • Select Features: Specify the Unity Connection components you want to backup.
  • Starts Backup at: Specify the starting date and time of the schedule.
  • Frequency: Specify the daily, weekly, or monthly cycles of the schedule.
Step 5

Select Save to apply the backup schedule.

Note 
If you select the Set Default option in the toolbar enables you to configure the backup schedule to perform weekly backups on Tuesday through Saturday.
Configuring a Manual Backup

You can run a manual backup for all components each time you create or change the configuration of a backup device.


Note
Make sure to select all the components listed for backup.

The amount of time required to complete the backup depends on the size of the database and the number of components selected for backup. The maximum time taken for backup to complete is 20 hours or it gets time out.

Procedure
Step 1

Sign in to Disaster Recovery System and login using the same Administrator username and password that you use for Cisco Unified Operating System Administration.

Step 2

Select Backup> Manual Backup. The Manual Backup window displays.

Step 3

On the Manual Backup window,

  • Select Backup Device: Specify the backup device to be used for backup.
  • Select Features: Specify the Unity Connection components you want to backup.
Step 4

Select Start Backup to start the manual backup.

DRS generates a log file for each component after completing its backup. If an error occurred, you can open the component’s log file to identify the specific error.

Viewing the Backup Status

To View the Backup Status in Disaster Recovery System

Procedure
Step 1

Sign in to Disaster Recovery System and login using the same Administrator username and password that you use for Cisco Unified Operating System Administration.

Step 2

Select Backup> Current Status. The Backup Status window displays.

Step 3

The Backup Status window displays the current status of the components selected for backup.

Step 4

You can select Cancel Backup to cancel the backup after the backup of the current component completes.

Viewing the Backup History

To View the Backup History in Disaster Recovery System

Procedure
Step 1

Sign in to Disaster Recovery System and login using the same Administrator username and password that you use for Cisco Unified Operating System Administration.

Step 2

Select Backup> History. The Backup History window displays.

Step 3

On the Backup History window you can view the backup history after running a manual backup, to ensure it completed successfully.

Step 4

You can select Cancel Backup to cancel the backup after the backup of the current component completes.

Upgrade UC Application

This section lists the upgrade tasks for Unified CM, Unified CM IM and Presence, Cisco Emergency Responder, and Cisco Unity Connection through Refresh or Standard upgrade.

Initiate Refresh or Standard upgrade depending on the upgrade method followed to upgrade ESXi, VMware, VMs, and Management Components.

Upgrade UC Applications using Refresh Upgrade

Perform the following tasks for upgrading UC Applications using Refresh Upgrade. Ensure to complete the following steps in sequence for Refresh Upgrade:

  1. Plan - Compatibility and Documentation References

  2. Upgrade ESXi, VMware, and VM using Refresh Upgrade

Procedure

Follow the upgrade steps described in the following table in sequence for the refresh upgrade:

Table 7. Upgrade Tasks for Refresh Upgrade

Upgrade Step

Action

UC Applications

1

Order of upgrade

  1. Unified CM PUB and switch version are set to No.

  2. Switch Unified CM PUB version.

  3. Unified CM SUB and switch version are set to No.

  4. IM and Presence PUB and switch version are set to No.

  5. Switch Unified CM SUB version.

  6. Switch IM and Presence PUB version.

  7. IM and Presence SUB and switch version are set to No.

  8. By default, Unity Connection PUB and switch version are set to Yes.

  9. By default, Unity Connection SUB and switch version are set to Yes.

Unified CM

2

Delete the product instances in the co-resident ELM.

4

The licenses for 10.x must be available in PLM.

PLM supports version agnostic licensing. Even when UC applications are upgraded to 11.x, it consumes 10.x license in PLM 11.5 SU2.

See Version Agnostic HCS UC Applications License.

5

In HCM-F, sync the version of the UC applications from Unified CDM.

Sync UC application versions

PLM

6

Assign the UC clusters to PLM.

For assigning the clusters to PLM, see the procedure Assign a Cluster to a License Manager in

Cisco Hosted Collaboration Mediation Fulfillment Install and Configure Guide

Unified CM 11.5(x)

7

Apply COP file for Push Notification.

Push Notification is applicable if upgraded to UC applications 11.5 SU2 and onwards.

Upgrade UC Applications using Standard Upgrade

Perform the following tasks for upgrading UC Applications using Standard Upgrade. Ensure to complete the following steps in sequence for Standard Upgrade:

  1. Plan - Compatibility and Documentation References

  2. Upgrade ESXi, VMware, and VM using Refresh Upgrade

  3. Upgrade Management Components

Procedure

Follow the upgrade steps described in the following table in sequence for the standard upgrade:

Table 8. Upgrade Tasks for Standard Upgrade

Upgrade Step

Action

Approximate time taken

1

Order of upgrade

  1. Unified CM PUB and switch version are set to No.

  2. Switch version for Unified CM PUB.

  3. Unified CM SUB and switch version are set to No.

  4. IM and P PUB and switch version are set to No.

  5. Switch version for Unified CM SUB.

  6. Switch version for IM and P PUB.

  7. IM and P SUB and switch version are set to No.

  8. By default, Unity Connection PUB and switch version are set to Yes.

  9. By default, Unity Connection SUB and switch version are set to Yes

Unified CM

2

Upgrade Unified CM cluster from PCD

Unified CM PUB and Unity Connection PUB upgrade starts at the same time when the PCD and CER PUB starts manually.

As part of Unified CM cluster, the following applications are upgraded:

  • Unified CM PUB

  • Unified CM SUB

  • IM and Presence PUB

  • IM and Presence SUB

For detailed procedure, see the chapter Upgrade, Migration, and Configuration in Migration to Cisco Unified Communications Manager Release Using Prime Collaboration Deployment.

(Day 3) 3 to 3.5 hrs per node

3

Upgrade the Unity Connection cluster from PCD

Unified CM PUB and Unity Connection PUB upgrade starts at the same time when the PCD and CER PUB starts manually.

As part of Unity Connection cluster, the following applications are upgraded:

  • Unity Connection PUB

  • Unity Connection SUB

See Upgrade CUCM/CUC/CUPS with Prime Collaboration Deployment at https://www.cisco.com/c/en/us/support/unified-communications/unified-communications-manager-callmanager/products-configuration-examples-list.html.

(Day 3) 3 to 3.5 hrs per node

Cisco Emergency Responder

4

Upgrade the CER cluster manually

Unified CM PUB and Unity Connection PUB upgrade can be started at the same time when the PCD and CER PUB starts manually.

For information about the upgrade procedure, see section Software Upgrades in Cisco Emergency Responder Administration Guide.

(Day 3) 3 to 3.5 hrs per node

UC Applications Switch Version

5

Initiate switch version of Unified CM cluster from PCD

For detailed procedure, see the chapter Upgrade, Migration, and Configuration in Migration to Cisco Unified Communications Manager Release Using Prime Collaboration Deployment.

(Day 3) 30 min per node

6

Initiate switch version of Unity Connection cluster from PCD

See Upgrade CUCM/CUC/CUPS with Prime Collaboration Deployment at https://www.cisco.com/c/en/us/support/unified-communications/unified-communications-manager-callmanager/products-configuration-examples-list.html.

(Day 3) 30 min per node

CER Switch Version

7

Switch version CER PUB and SUB 11.5

For information about the upgrade procedure, see section Software Upgrades in Cisco Emergency Responder Administration Guide.

(Day 3) 30 min per node

Unified CDM 11.5(x)

8

Change the version of UC applications in Unified CDM

See Set Up Cisco Unified Communications Manager Servers procedure in Cisco Hosted Collaboration Solution Customer Onboarding Guide.

(Day 3) 5 min

HCM-F 11.5(x)

9

In HCM-F, sync the version of the PLM

It is assumed that clusters are synced from Unified CDM to HCMF.

CER

10

Delete the CER enterprise product instance from License Manager

Unified CDM 11.5(x)

11

Add CER cluster in Unified CDM 11.5(x)

Note 

CER is not supported in 10.x, CER cluster will not be available in Unified CDM and HCM-F. After Unified CDM is upgraded, add CER cluster in Unified CDM 11.5(x).

PLM

12

Check for 10.x licenses in PLM

In PLM, check if 10.x Licenses are available for Unified CM and CER.

Note 

Unified CM hosted license are available and CER hosted license needs to be added.

HCM-F 11.5(x)

13

Assign CER cluster to PLM

(Day 3) 15 min

Unified CM 11.5(x)

14

Apply COP file for Push Notification

Push Notification is applicable if upgraded to UC applications 11.5 SU2 and onwards.

(Day 3) 15 min

Restore UC Application

This section describes the procedures for restoring the services after the UC app upgrade.

Restore Unified CM and IM and Presence

Procedure

  Command or Action Purpose
Step 1

Switch the Software Version

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

Perform this procedure for all nodes.
Step 2

Remove the Serial Port

During the preupgrade tasks, you added a serial port to the virtual machine to capture the upgrade logs. After you have successfully upgraded the system, you must remove the serial port so that it does not impact the performance of the virtual machine.

Perform this procedure for all nodes.
Step 3

Restart Extension Mobility

Upgrades from Release 9.x or earlier require you to stop Cisco extension mobility before you begin the upgrade process. If you deactivated Cisco extension mobility as part of your preupgrade tasks, use this procedure to restart the service after the upgrade is complete.

Step 4

Restart TFTP Services

Use this procedure to restart TFTP services on Cisco Unified Communications Manager nodes after you complete an upgrade.

Step 5

Reset TFTP Parameters

Reset TFTP parameters that are changed during the upgrade process.
Step 6

Restore Enterprise Parameters

Use this procedure to restore Enterprise Parameters on IM and Presence Service nodes that may have been overwritten during the upgrade process.

Step 7

Reset High and Low Watermarks

Use this procedure to restore the high and low watermarks to their original values in order to avoid premature purging of traces.

Do this step for only for direct upgrades, which use either the Unified CM OS Admin interface or the PCD Upgrade task to perform the upgrade.

Step 8

Updating VMware Tools

Update the VMWare Tools after you complete the upgrade.

Perform this procedure for all nodes.
Step 9

Install Locales

Use this procedure to install locales. After an upgrade, you must reinstall any locales that you are using, with the exception of US-English, which is installed by default.

Perform this procedure for all nodes.
Step 10

Restore the Database Replication Timeout

Use this procedure if you increased the database replication timeout value before you began the upgrade process.

Perform this procedure on Cisco Unified Communications Manager nodes only.

Step 11

Upgrade RTMT

If you use Cisco Unified Real Time Monitoring Tool (RTMT), upgrade to the new software version.

Step 12

Manage TFTP Server Files

Optional. Use this procedure to upload phone rings, callback tones, and backgrounds to a TFTP server so that they are available to Cisco Unified Communications Manager nodes.

Step 13

Set Up a Custom Log-On Message

Optional. 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, Cisco Prime License Manager, and the command line interface.

Perform this procedure on Cisco Unified Communications Manager nodes only.

Step 14

Configure IPSec Policies

Use this procedure only if you are performing a PCD migration from Release 6.1(5). Recreate your IPSec policies after the PCD migration is complete, because IPSec policies from Release 6.1(5) are not migrated to the new release.

Step 15

Assign New Manager Assistant Roles

Perform this procedure only if your previous release was configured to use the Cisco Unified Communications Manager Assistant feature, and you assigned application users to use either the Inter-Cluster Peer-User or the Admin-CUMA roles. The InterCluster Peer-User and Admin-CUMA roles are deprecated and are removed during the upgrade process. Assign new roles for those users.

Perform this procedure on Cisco Unified Communications Manager nodes only.

Step 16

Enable High Availability on Presence Redundancy Groups

This procedure applies to IM and Presence Service nodes only. If you disabled high availability on presence redundancy groups before beginning the upgrade process, use this procedure to enable it now.

Step 17

Restart the IM and Presence Sync Agent

If you stopped the IM and Presence Sync Agent service before you began the upgrade process, restart it now.
Step 18

(Optional) To upgrade JTAPI application, from Cisco Unified CM Administration, choose Application > Plugins and download the JTAPI installer. Then, follow the instructions in the Cisco Unified JTAPI Developers Guide: https://www.cisco.com/c/en/us/support/unified-communications/unified-communications-manager-callmanager/products-programming-reference-guides-list.html

(Optional)

Upgrade your JTAPI application, if necessary.

Restore Cisco Emergency Responder

Procedure

Command or Action Purpose

Replace the files if CER uses secure JTAPI connection.

If Cisco Emergency Responder uses secure JTAPI connection, the CTLfile.tlv, JtapiClientKeyStore, and JtapiServerKeyStore files can get deleted after the upgrade. Use the following options as a workaround:

Switch the Software Version

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

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

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


Caution

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

Before you begin

The software versions on Unified Communications Managerand 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.

Review the information in Understanding Version Switching

Procedure

Step 1

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

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

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

Select Settings > Version.

Step 4

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

Step 5

Select Switch Versions to switch versions and restart the system.

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

Understanding Version Switching

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

  • automatic switching—the system switches the version automatically as part of the upgrade process
  • manual switching—you switch the version using the OS Administration interface after the upgrade process is complete

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

Upgrade type

Switching type

When prompted, choose . . .

Result

Standard upgrade

Automatic

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 Unified Communications Manager or switch over after upgrading to a different product version, any changes made by phone users may be lost. Examples of phone user settings include call forwarding and message waiting indication light settings. This can occur because Unified Communications Manager synchronizes the database after an installation or upgrade, which can overwrite phone user settings changes.

Remove the Serial Port

During the pre-upgrade tasks, you added a serial port to the virtual machine to capture the upgrade logs. After you have successfully upgraded the system, you must remove the serial port so that it does not impact the performance of the virtual machine.

Procedure

Step 1

Power off the virtual machine.
Step 2

Edit the settings to remove the serial port. For information about how to edit the settings, see the VMWare documentation.
Step 3

Power on the virtual machine and proceed with the post-upgrade tasks.

Restart Extension Mobility

Upgrades from Release 9.x or earlier require you to stop Cisco extension mobility before you begin the upgrade process. If you deactivated Cisco extension mobility as part of your pre-upgrade tasks, use this procedure to restart the service on Unified Communications Managernodes.

Procedure

  Command or Action Purpose
Step 1

From Cisco Unified Serviceability, choose Tools > Service Activation.

Step 2

From the Server list, choose the node on which you want to deactivate services and click Go.

Step 3

Select the Cisco Extension Mobility services.

Step 4

Click Restart.

Restart TFTP Services

Use this procedure to restart TFTP services on Unified Communications Managernodes after you complete an upgrade.

Procedure

  Command or Action Purpose
Step 1

From Cisco Unified Serviceability, choose Tools > Service Activation.

Step 2

From the Server list, choose the node on which you want to deactivate services and click Go.

Step 3

Select the Cisco TFTP services.

Step 4

Click Restart.

Reset TFTP Parameters

During the upgrade process, the TFTP service parameter Maximum Serving Count is changed to allow for an increased number of device registration requests. Use this procedure to reset the parameter after the upgrade is complete.

Procedure

Step 1

From the Cisco Unified CM Administration interface, choose System > Service Parameters.

Step 2

From the Server drop-down list, select the node that is running the TFTP service.

Step 3

From the Service drop-down list, select Cisco TFTP service.

Step 4

Click Advanced.

Step 5

Click Save.

Step 6

Set the Maximum Serving Count to the same value that you used prior to the upgrade, or to the value that is recommended for your configuration.

The default value is 500. We recommend that you use the default value if you run the TFTP service with other Cisco CallManager services on the same server. For a dedicated TFTP server, use the following values:

  • 1500 for a single-processor system

  • 3000 for a dual-processor system

  • 3500 for dedicated TFTP servers with higher CPU configurations

Restore Enterprise Parameters

Some Enterprise Parameters exist on both Unified Communications Manager nodes and IM and Presence Service nodes. Where the same parameter exists, the settings that are configured on Unified Communications Manager nodes overwrite the settings configured on IM and Presence Service nodes during an upgrade. Enterprise Parameters that are unique to IM and Presence Service nodes are retained during an upgrade.

Use this procedure to reconfigure the settings on IM and Presence Service nodes that have been overwritten during the upgrade process.

Before you begin

Make sure you have access to the settings that you recorded as part of the pre-upgrade tasks.

Procedure

Step 1

From the Cisco Unified CM IM and Presence Administration interface, choose System > Enterprise Parameters.

Step 2

Compare the current settings to the settings that existed prior to the upgrade and update the Enterprise Parameters as needed.

Step 3

Click Save.

Step 4

Click Reset, and then click OK to reset all devices.

Reset High and Low Watermarks

Use this procedure to restore the high and low watermarks to their original values in order to avoid premature purging of traces.

Procedure

Step 1

In the Real Time Monitoring Tool (RTMT) interface, double-click Alert Central in the left navigation pane.

Step 2

On the System tab, right-click LogPartitionLowWaterMarkExceeded and select Set Alert/Properties.

Step 3

Select Next.

Step 4

Adjust the slider value to 80.
Step 5

On the System tab, right-click LogPartitionHighWaterMarkExceeded and select Set Alert/Properties.

Step 6

Select Next.

Step 7

Adjust the slider value to 85.

Updating VMware Tools

VMware Tools are a set of utilities for management and performance optimization. Your system uses one of the following VMware Tools:

  • Native VMware Tools (provided by VMware)

  • Open VMware Tools (provided by Cisco)

  • To upgrade Unified Communications Manager from a version earlier than Release 11.5(x), you must use the native VMware tools option. You can change to open VMware Tools after the upgrade.

  • For upgrades from Unified Communications Manager Release 11.5(1) onwards (for example, to a higher SU), you can choose whether your system use Native VMware or Open VMware Tools.

  • For fresh installation and PCD migrations from Unified Communications Manager Release 11.5(1) onwards, open VMware tools installed by default.

Procedure

Step 1

Execute a command utils vmtools status to ensure that VMware tools are currently running.

Step 2

If necessary, run one of the following commands to switch to the desired VMware tools platform: utils vmtools switch native or utils vmtools switch open.

Step 3

Follow one of the methods below if you are using Native VMware Tools:

  • Initiate the automatic tools update with the viClient.

    Note 
    For ESXI 6.5 VM tools update, power off the VM before updating the configuration parameters. Choose the Edit settings > options > Advanced > General > Configuration parameters and then add: 
    tools.hint.imageName=linux.iso

  • Configure the tool to automatically check the version during a VM power-on and upgrade.

For information about how to configure these options, refer to VMware documentation. You can also find more information by searching the topic "VMware Tools" at https://www.cisco.com/c/dam/en/us/td/docs/voice_ip_comm/uc_system/virtualization/virtualization-software-requirements.html#vmtools.

Install Locales

Use this procedure to install locales. After an upgrade, you must reinstall any locales that you are using, with the exception of US-English, which is installed by default. Install the latest version of the locales that match the major.minor version number of your Unified Communications Managernode or IM and Presence Service node.

You can install locales on Unified Communications Manageror on IM and Presence Service nodes. If you are installing a locale for both products, install the locale on all cluster nodes in the following order:

  1. Unified Communications Managerpublisher node

  2. Unified Communications Managersubscriber nodes

  3. IM and Presence database publisher node

  4. IM and Presence subscriber nodes

If you want to install specific locales on IM and Presence Service nodes, you must first install the Unified Communications Managerlocale file for the same country on the Unified Communications Managercluster.

Procedure

Step 1

Find the locale installer for your release on cisco.com:
Step 2

Download your release's locale installer to a server that supports SFTP. You need the following files:

  • User Locale files—These files contain language information for a specific language and country and use the following convention:

    • cm-locale-language-country-version.cop ( Cisco Unified Communications Manager)

    • ps-locale-language_country-version.cop ( IM and Presence Service)

  • Combined Network Locale file—Contains country-specific files for all countries for various network items, including phone tones, annunciators, and gateway tones. The combined network locale file uses the following naming convention:

    • cm- locale-combinednetworklocale-version.cop (Cisco Unified Communications Manager)

Step 3

Log in to Cisco Unified OS Administration using the administrator account.
Step 4

Choose Software Upgrades > Install/Upgrade.

Step 5

Complete the following fields in the Software Installation/Upgrade window:

  • For the Source, choose Remote file System.
  • From the Directory, enter the path to the directory where you saved the locale installer.
  • From the Server field, enter the server name for the remote file system.
  • Enter the credentials for the remote file system.
  • From the Transfer Protocol drop-down list, choose SFTP. You must use SFTP for the transfer protocol.
Step 6

Click Next.

Step 7

Download and install the locale on the server.

Step 8

Restart the server. The updates take effect after the server restarts
Step 9

Repeat this procedure on all Unified Communications Managerand IM and Presence Service cluster nodes in the prescribed order.


Note
Do not reset user locales for your end users until the new locale is installed on all cluster nodes. If you are installing the locale for both Unified Communications Managerand IM and Presence Service, you must install the locale for both products before you reset user locales. If you run into any issues, such as could occur if an end user resets a phone language before the locale installation is complete for IM and Presence Service, have your users reset their phone language in the Self-Care Portal to English. After the locale installation is complete, users can reset their phone language, or you use Bulk Administration to synchronize locales to the appropriate language by bulk.

Restore the Database Replication Timeout

This procedure applies to Unified Communications Managernodes only.

Use this procedure if you increased the database replication timeout value before you began the upgrade process.

The default database replication timeout value is 300 (5 minutes). Restore the timeout to the default value after the entire cluster upgrades and the Unified Communications Manager subscriber nodes have successfully set up replication.

Procedure

Step 1

Start a CLI session using one of the following methods:

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

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

Execute the utils dbreplication setrepltimeout timeout command, where timeout is database replication timeout, in seconds. Set the value to 300 (5 minutes).

Upgrade RTMT


Tip

To ensure compatibility, Cisco recommends that you upgrade RTMT after you complete the Unified Communications Manager upgrade on all servers in the cluster.

RTMT saves user preferences and downloaded module jar files locally on the client machine. The system saves user-created profiles in the database, so you can access these items in Unified RTMT after you upgrade the tool.

Before you begin

Before you upgrade to a newer version of RTMT, Cisco recommends that you uninstall the previous version.

Procedure

Step 1

From Unified Communications Manager Administration, choose Application > Plugins.

Step 2

Click Find.

Step 3

Perform one of the following actions:

  • To install the tool on a computer that is running the Microsoft Windows operating system, click the Download link for the Cisco Unified Real-Time Monitoring Tool - Windows.
  • To install the tool on a computer that is running the Linux operating system, click the Download link for the Cisco Unified Real-Time Monitoring Tool - Linux.
Step 4

Download the installation file to your preferred location.

Step 5

Locate and run the installation file.

The extraction process begins.
Step 6

In the RTMT welcome window, click Next.

Step 7

Because you cannot change the installation location for upgrades, click Next.

The Setup Status window appears; do not click Cancel.
Step 8

In the Maintenance Complete window, click Finish.

Manage TFTP Server Files

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:

Procedure

Step 1

From the Cisco Unified Communications Operating System Administration window, navigate to Software Upgrades > TFTP > File Management.

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:

  1. Click Upload File.

    The Upload File dialog box opens.

  2. To upload a file, click Browse and then choose the file that you want to upload.

  3. To upload the file to a subdirectory of the tftp directory, enter the subdirectory in the Directory field.

  4. To start the upload, click Upload File.

    The Status area indicates when the file uploads successfully.

  5. After the file uploads, restart the Cisco TFTP service.

    Note 

    If you plan to upload several files, restart the Cisco TFTP service only once, after you have uploaded all the files.

    For information about restarting services, refer to Cisco Unified Serviceability Administration Guide.

Step 3

To delete files, follow this procedure:

  1. Check the check boxes next to the files that you want to delete.

    You can also click Select All to select all of the files, or Clear All to clear all selection.

  2. Click Delete Selected.

    Note 

    If you want to modify a file that is already in the tftp directory, you can use the CLI command file list tftp to see the files in the TFTP directory and file get tftp to get a copy of a file in the TFTP directory. For more information, see the Command Line Interface Reference Guide for Cisco Unifed Communications Solutions.

Set Up a Custom Log-On Message

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:

Procedure

Step 1

From the Cisco Unified Communications Operating System Administration window, navigate to Software Upgrades > Customized Logon Message.

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.

Note 

You cannot upload a file that is larger than 10kB.

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.

Configure IPSec Policies

Use this procedure only if you are performing a PCD migration from Release 6.1(5). You must recreate your IPSec policies after the PCD migration is complete, because IPSec policies from Release 6.1(5) are not migrated to the new release.

  • IPsec requires bidirectional provisioning, or one peer for each host (or gateway).

  • When you provision the IPSec policy on two Unified Communications Manager nodes with one IPsec policy protocol set to "ANY" and the other IPsec policy protocol set to "UDP" or "TCP", the validation can result in a false negative if run from the node that uses the "ANY" protocol.

  • IPsec, especially with encryption, affects the performance of your system.

Procedure

Step 1

From Cisco Unified OS Administration, choose Security > IPSec Configuration.

Step 2

Click Add New.

Step 3

Configure the fields on the IPSEC Policy Configuration window. See the online help for more information about the fields and their configuration options.

Step 4

Click Save.

Step 5

(Optional) To validate IPsec, choose Services > Ping, check the Validate IPsec check box, and then click Ping.

Assign New Manager Assistant Roles

Perform this procedure only if your previous release was configured to use the Cisco Unified Communications Manager Assistant feature, and you assigned application users to use either the InterCluster Peer-User or the Admin-CUMA roles. The InterCluster Peer-User and Admin-CUMA roles are deprecated from release 10.0(1) onward and are removed during the upgrade process. You must assign new roles for those users.

Procedure

Step 1

To configure roles and users, see the chapter "Manage Users" in the Administration Guide for Cisco Unified Communications Manager and IM and Presence Service at http://www.cisco.com/c/en/us/support/unified-communications/unified-communications-manager-callmanager/products-maintenance-guides-list.html.

Step 2

Ensure that the AXL user defined on the IM and Presence Service user interface (Presence > Inter-Clustering ) has a Standard AXL API Access role associated with it on the Unified Communications Manager application user page.

Enable High Availability on Presence Redundancy Groups

This procedure applies to IM and Presence Service nodes only. If you disabled high availability on presence redundancy groups before beginning the upgrade process, use this procedure to enable it now.

Before you begin

If it has been less than 30 minutes since your services restarted, confirm that your Cisco Jabber sessions have been recreated before you enable High Availability. Otherwise, Presence will not work for Jabber clients whose sessions aren't created.

To obtain the number of Jabber sessions, run the show perf query counter "Cisco Presence Engine" ActiveJsmSessions CLI command on all cluster nodes. The number of active sessions should match the number of users that you recorded when you disabled high availability prior to the upgrade.

Procedure

Step 1

From the Cisco Unified CM Administration user interface, choose System > Presence Redundancy Groups.

Step 2

Click Find and select the Presence Redundancy Group.

The Presence Redundancy Group Configuration window displays.
Step 3

Check the Enable High Availability check box.

Step 4

Click Save.

Step 5

Repeat this procedure in each Presence Redundancy Group.

Restart the IM and Presence Sync Agent

If you stopped the IM and Presence Sync Agent service before you began the upgrade process, restart it now.

Procedure

Step 1

From the Cisco Unified Serviceability interface, select Tools > Control Center - Network Services.

Step 2

Select an IM and Presence Service node from the Server drop-down list and click Go.

Step 3

In the IM and Presence Services section, select the Cisco Sync Agent and click Restart.

Example


Note

After the Cisco Intercluster Sync Agent has finished the initial synchronisation, manually load the new Tomcat certificate onto Uinified Communications Manager. This ensures that the synchronisation does not fail.


Note

Run the post-upgrade COP. It runs a series of tests to verify that the system is stable. It also compares various parameters before the upgrade with the current version to identify any differences.

Validate UC Application

This section describes the checks for validating the UC applications upgrade.

Validate Unified CM and IM and Presence

Procedure

  Command or Action Purpose
Step 1

Verify the Registered Device Count

Use this procedure to verify your endpoints and resources on Cisco Unified Communications Manager nodes after the upgrade is complete.

Step 2

Verify Assigned Users

Use this procedure to verify the number of assigned users on IM and Presence Service nodes after the upgrade is complete.

Step 3

Test Functionality

Verify phone functions and features are working correctly after the upgrade.
Step 4

Verify IM and Presence Service Data Migration

Use this procedure only if you performed an upgrade or migration from Cisco Unified Presence Release 8.x to an IM and Presence Service release.

Validate Unity Connection

Procedure

  Command or Action Purpose
Step 1

Verify the version of CUC server in CLI using the command: show cuc version.

Cisco Unity Connection server active and inactive version details.

Step 2

Verify the CUC upgrade status in CLI using the command: utils system upgrade status.

Cisco Unity Connection upgrade status details.

Verify the Registered Device Count

Use the Real Time Monitoring Tool (RTMT) to view the device count and verify your endpoints and resources after the upgrade is complete.

Procedure

Step 1

From the Unified RTMT interface, select Voice/Video > Device Summary.

Step 2

Record the number of registered devices:

Item Count

Registered Phones

  

Registered Gateways

  

Registered Media Resources

  

Registered Other Station Devices

  
Step 3

Compare this information to the device counts that you recorded before the upgrade and ensure that there are no errors.

Verify Assigned Users

Use this procedure to verify the number of assigned users on IM and Presence Service nodes after the upgrade is complete.

Procedure

Step 1

From the Cisco Unified CM IM and Presence Administration interface, select System > Cluster Topology.

Step 2

Compare this information to the number of assigned users that you recorded before the upgrade and ensure that there are no errors.

Test Functionality

After the upgrade, perform the following tasks:

  • Run the post-upgrade COP.

    It runs a series of tests to verify that the system is stable. It also compares various parameters before the upgrade with the current version to identify any differences. After you complete all the steps in this list, run the post-upgrade COP file again and verify the COP report.

  • Verify phone functions by making the following types of calls:

    • Voice mail

    • Interoffice

    • Mobile phone

    • Local

    • National

    • International

    • Shared line

  • Test the following phone features:

    • Conference

    • Barge

    • Transfer

    • C-Barge

    • Ring on shared lines

    • Do Not Disturb

    • Privacy

    • Presence

    • CTI call control

    • Busy Lamp Field

  • Test IM and Presence Service functions:

    • Basic presence states, such as available, unavailable, and busy

    • Send and receive files

    • Advanced features, such as persistent chat, federated users, and message archiving

Verify IM and Presence Service Data Migration

When you upgrade from Cisco Unified Presence Release 8.x to an IM and Presence Service release, user profiles are migrated to Unified Communications Manager. The user profile information is stored as new service profiles on Unified Communications Manager with the following name and description format:

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

Description: Migrated Service Profile Number x

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 Unified Communications Manager.

Procedure

Step 1

From Cisco Unified CM Administration, select User Management > User Settings > Service Profile.

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 there is an import error, an alarm is raised on Uinified Communications Manager. To view the alarm details, log into RTMT for Cisco Unified Communications Manager.

What to do next

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

For more information about how user profiles are migrated, see the section "User profile data migration".

Run the post-upgrade COP file. It runs a series of tests to verify that the system is stable. It also compares various parameters before the upgrade with the current version to identify any differences.

Upgrade Checks for UC Applications using HCM-F

Upgrade Toolkit Overview

Enables partners to perform a quick and hassle free:

  • Checks before and after upgrade.

  • Use the results obtained from upgrade checks (before and after) to validate upgrade.

  • Understand the deprecated phones in the network.

HCM-F has information of the UC applications and various other devices in partner network. This information is used along with the information available from compatibility matrices to build a rich source of data useful for partners.

For information about API, see Cisco Hosted Collaboration Mediation Fulfillment Developer Guide.

Limitations

There are limitations for the following scenarios:

Scenario

Tasks or Error Message

Upgrading Cisco Unified Presence Server (CUPS) from Release 9.1(x) to 10.1(x) or 11.5(x) to 12.5(x)

While upgrading from Release 9.1(x) to 11.5(x)/12.5(x), keep the CUPS and Cisco Unified Communications Manager clusters separate until the Upgrade Comparison is complete. After completing and verifying the comparison results, delete the CUPS cluster and add it to Cisco Unified Communications Manager.

Upgrade Check - Cluster Version Information

When Cisco Unified Communications Manager IM and P (CUPS) is a separate cluster in Release 10.1(x) or 11.5(x)/12.5(x), node count fails with node count as 0.

Upgrade Check - Phone Count and CTI Device Count

Phone count does not appear for phones with status None.

Upgrade Toolkit Prerequisites

The following prerequisites are required to perform upgrade checks, upgrade comparison and phone compatibility check:


Note

Ensure to upgrade HCM-F version to 11.5(4) or later to use the upgrade checks.

S.No

Checks

Path/Reference

1

Activate the following services to perform upgrade checks and comparison post upgrade:

To verify if the services are started, do any one of the following:

  • In HCM-F, select Infrastructure Manager > Service Provider Toolkit.

  • Enter the following command in CLI:

    utils service list

UC Monitor

utils service activate Cisco HCS UC Monitor Service

Cisco HCS Provisioning Adapter (CHPA)

utils service activate Cisco HCS Provisioning Adapter

Data Access Manager (DAM)

Note 

This service is active by default.

utils service activate Cisco HCS Data Access Manager Service

Cisco HCS UC Provisioning Adapter (UCPA)

utils service activate Cisco HCS UCPA Service

Cisco HCS UCSM Sync Service

utils service activate Cisco HCS UCSMSync Service

Cisco HCS VCenter Sync

utils service activate Cisco HCS VCenterSync Service

2

 Certificate scheduling and email notification must be configured or collect the certificates on-demand. For configuration, see Certificate Configuration in Cisco Hosted Collaboration Solution Upgrade and Migration Guide.

3

Check if all customers and their clusters for the UC applications are added. Supported UC applications: Cisco Unified CM, Cisco Unity Connection and Cisco UCM IM and P.

To test the cluster connection, see Test Cluster Connection procedure in

Cisco Hosted Collaboration Mediation Fulfillment Install and Configure Guide

.

4

While adding new clusters for the UC applications, ensure to select the Access Type as Platform and Admin

Path: Infrastructure Management > Application Management > Cluster Application > Add New > Credentials

5

Check if vCenter is configured for each vCenter server deployed in the Data Center and VCenter sync is enabled.

Path: Infrastructure Management > Data Center Management > Data Center > vCenter.

For configuration information, see Add vCenter procedure in

Cisco Hosted Collaboration Mediation Fulfillment Install and Configure Guide

.

Upgrade Toolkit Workflow

Complete the following tasks to perform the upgrade.

Before you begin

Upgrade Toolkit Prerequisites

Procedure

Step 1

Perform Upgrade Checks

Perform upgrade checks on the UC application clusters before the upgrade. Ensure all checks pass.
Step 2

Verify the job status in the HCM-F interface.

Check the Status column for the Job Entity, UC Monitor in the path: Infrastructure Manager > Administration > Jobs.

Note 

If the job fails, go to Upgrade Checks and check the Status column for failures and Recommended Action.

Step 3

Click Save for Compare to save the check result after executing all the checks before upgrade.

Step 4

Perform the Phone Compatibility Check to understand the deprecated phone models.
Step 5

Remove the deprecated phone models.

To remove the deprecated phone models, see Delete Phones procedure in Cisco Hosted Collaboration Solution End-User Provisioning Guide.

Step 6

Perform the steps mentioned in Prepare-Pre Upgrade Actions, Upgrade UC Applications, and Restore-Post Upgrade Actions procdures to upgrade the UC Applications.

To understand end-to-end UC upgrade workflow, see Cisco Hosted Collaboration Solution Upgrade and Migration Guide.

Step 7

Perform Upgrade Checks

Perform upgrade check on the UC application clusters after the upgrade.

Step 8

Click Submit after executing the checks post upgrade.

Step 9

Post Upgrade Comparison

Compares and displays the check results obtained before and after upgrade.

Perform Upgrade Checks

Perform upgrade checks on the UC application clusters and vCenter.

Before you begin

Upgrade Toolkit Prerequisites

Procedure

Step 1

From the side menu, choose Service Provider Toolkit > Upgrade Toolkit > Upgrade Checks.

Step 2

From Select a Customer drop down, select the customer name for performing the checks.

Step 3

From Select a Cluster drop down, select the UC application cluster. On selecting a shared cluster, it displays the name of customers associated with the selected shared cluster.

Note 

If upgrade checks are performed for the first time, Not Executed appears in the Status column. If a check is already performed, then the status of the check appears (tick or cross-mark).

Step 4

By default, all the checks are selected. To perform a particular check, uncheck the check box from the table header and select the individual checks using the check box.

Note 

Ensure to perform all the checks.
Step 5

Click Submit to perform the selected checks.

Step 6

(Optional) Check the job status.

Select Infrastructure Manager > Administration > Jobs. Check for Job Entity, UC Monitor Checks.

Note 

You can run the upgrade check on different clusters for the same customer at the same time. But, if another upgrade check for the same cluster associated with the same customer is initiated, then the initiation fails. Also, a message appears that the job is in progress.

Step 7

In the Status column, the tick-mark appears if the check is successful and cross-mark appears if the check fails. Click the cross-mark in the Status column to understand the recommended action for the entire check as well as the individual check result:

  • Status: Indicates the check failed.

  • Last Execution Date/Time: Indicates the time when the check was last executed.

  • Recommended Action: Indicates the recommended action for the check failure.

To understand the details of the check, click the arrow button to expand the check in the Check column. The tick-mark appears if the collection is successful. Cross-mark appears if the HCM-F is unable to collect the details from all the clusters during the check. It can be due to any of the following reasons:

  • Node not reachable

  • Check was not complete.

Note 

On the table header, click Checks to sort the table alphabetically or click Status to sort the table based on the execution status.

Manually perform and verify the skipped checks.
Step 8

Complete these steps to save the check result and use it for comparison depending on when the Upgrade Check is performed:

  1. Before Upgrade: Click Save for Compare.

  2. After Upgrade: Click Submit.

Note 

Use Save for Compare only to save the Check Result before upgrade. If it is selected after upgrade, the check result saved before the upgrade is overwritten.

Perform this step only after performing all the checks before upgrade.

  1. (Optional) Click Download to download (present) check results.

    The Check Result are saved to UpgradeChecksReport_<clustername>_<timestamp in yyyymmdd_hhmmss>.csv.

  2. (Optional) Click Download Saved Reports to download the last saved results.

    The Check Result are saved to UpgradeSavedChecksReport_<clustername>_<timestamp in yyyymmdd_hhmmss>.csv.

  3. (Optional) Select Open File to view the spreadsheet without saving or select Save File to save it to a location and click OK.

Upgrade Checks

The following checks involve checking all or some nodes (Subscriber and Publisher) in the UC application cluster for the selected customer.

Even if one node fails while executing a check, the entire check fails and cross-mark appears in the Status column. See the Recommended Action and perform the recommended action if there is a failure and execute the check again.

Table 9. Upgrade Checks

Upgrade Checks

Is Upgrade Check Supported on UC Application?

Nodes of the Cluster Supported by Check

Unified CM

Unity Connection

IM and Presence

Emergency Responder

Available Common Partition Space

Y

N

Y

Y

Publisher and Subscriber

CLI Diagnostics

Y

Y

Y

N

Publisher and Subscriber

CTI Device Count

Y

N

N

N

Publisher

Certificate Status Information

Y

Y

Y

Y

Publisher and Subscriber

Check Cluster Status

N

Y

N

N

Publisher
Cluster Version Information

Y

Y

Y

Y

Publisher and Subscriber

DB Consistency State

N

Y

N

N

All nodes

Disaster Recovery System Backup

Y

N

Y

Y

Publisher and Subscriber

Enterprise Service Parameters

Y

N

Y

N

Publisher

Health of Network Within the Cluster

Y

N

Y

N

Publisher and Subscriber

Installed COP Files

Y

Y

Y

Y

Publisher and Subscriber

LDAP Details

Y

N

N

N

Publisher and Subscriber

List of Services

Y

N

Y

Y

Publisher and Subscriber
Network Connectivity (DNS, SMTP, and NTP)

Y

Y

Y

Y

Publisher and Subscriber

Phone Count

Y

N

N

N

Publisher

Port Information

N

Y

N

N

All nodes

Run Pre-Upgrade Test

N

Y

N

N

Publisher and Subscriber

State of Database Replication

Y

N

Y

N

Publisher and Subscriber
VCenter and ESXi and UCS Details

Y

Y

Y

Y

Publisher and Subscriber
Available Common Partition Space

Checks if atleast minimum 25 GB of common partition space is available.

Check

Displays the available space in the cluster.

Check Result

Following are the result details for the check:

  • Application Name: Specifies the node name.

  • Available Space: Specifies the available space in the common partition.

  • Used Space: Specifies the used space in the common partition.

  • Status:

    • Pass: Indicates the available common partition space is atleast 25 GB.

    • Fail: Indicates the available common partition space is less than 25 GB.

Status and Recommended Action

If the check fails, clear the space so that the minimum available partition space is 25 GB.
CLI Diagnostics

Log into HCM-F GUI and run the utils diagnose test command on all nodes within the cluster with the admin credentials.

Check

Displays result of each test run by utils diagnose test command.

Check Result

Following are the result details for the check:

  • Application Name: Specifies the node name.

  • Test Name: Specifies the test run by utils diagnose test command.

  • Result: Indicates if the test passed or failed.

  • Status:

    • Pass: Indicates that the test run as part of utils diagnose test command passed or skipped in the cluster.

    • Fail: Indicates that the test executed as part of utils diagnose test command failed in the cluster.

Status and Recommended Action

If the check fails, check the node connectivity.
CTI Device Count

Records the total number of CTI devices, which includes CTI ports and Route Points.

Use this information for comparison post upgrade.

Check

Displays the CTI device count.

Check Result

Following are the result details for the check:

  • Application Name: Specifies the node name.

  • CTI Device Status: Collects CTI device count for the following status:

    • Registered

    • Partially Registered

    • Unregistered

    • Rejected

  • CTI Device Count: Specifies the CTI device count for the preceding status.

  • Status:

    • Pass: Indicates that the collection of CTI device count was successful.

    • Fail: Indicates HCM-F is unable to fetch device count data from Cisco Unified Communications Manager.

Status and Recommended Action

If the status fails, check cluster reachability and the credentials.
Certificate Status Information

Displays the Certificate information that is collected from the Certificate Monitor, to verify the certificate status information. Certificates are sorted based on number of days to expire.

Check

Displays the certificate status.

Check Result

  • Certificate Name: Specifies the certificate name.

  • Expiry Date: Specifies the certificate expiry date. The table is sorted based on the certificate expiry date.

  • Status:

    • Pass: Indicates that all the certificates are valid.

    • Fail: Indicates that one or more certificates are not valid.

Status and Recommended Action

If the certificate collected by certificate monitor is older than seven days, then the overall status fails. Check the certificate validity and Recommended Actions.

Check Cluster Status

Checks if publisher server has Primary status and subscriber server has Secondary status. This check is applicable only for Cisco Unity Connection.

Check

 Displays the publisher and subscriber server name and status.

Result

Following are the result details:

  • Application Name: Specifies the node name. It is applicable only for publisher.

  • Server Name: Specifies the publisher and subscriber server name.

  • Server State: Specifies that one server node has publisher (Primary status) and the other has subscriber (Secondary status).

  • Internal State: Specifies if the server is active or inactive.

  • Status:

    • Pass: Indicates that the server state is Primary, Secondary or Secondary and Primary.

    • Fail: Indicates failure for the following server states:

      • Both nodes are in Primary.

      • Both nodes are in Secondary.

Status and Recommended Action

Check the Recommended Action for failure.
Cluster Version Information

Checks if all the applications for the selected cluster are available.

Check

Displays the application version and cluster node count.

Check Result

Following are the result details:

  • Application Name: Specifies the node name.

  • Application Version: Specifies the UC application version installed on the node.

  • Cluster Nodes Count: Specifies the number of nodes in the cluster. This entry is available only for publisher node.

  • Status:

    • Pass: Indicates that following conditions passed:

      • All the nodes of the cluster are reachable.

      • All nodes of the cluster have same software version (including the build number) installed.

      • Configuration in HCM-F aligns with the cluster configuration.

    • Fail: Indicates that one or all conditions mentioned in pass have failed.

Status and Recommended Action

If the check fails, check node connectivity and credentials. Add the missing applications for the cluster.
DB Consistency State

Checks the consistency of tables and validates indexes for the unitydirdb, unitydyndb, unitymbxdb1, and unityrptdb database in Unity Connection. This check runs on all nodes in the cluster.

The information from the check is used for comparison post upgrade.

Check

Checks the consistency of tables and validates indexes for the database in Unity Connection. Run the show cuc dbconsistency <dbname> command on each database using the HCM-F admin credentials.

Check Result

Following are the result details for the check:

  • Database name: Specifies the names of the Unity Connection database.

  • Result:

    • Checks for the table consistency.

    • Index validation.

Status and Recommended Action

If the check fails, check the table for inconsistencies, disabled indexes or invalid index entries.
Disaster Recovery System Backup

Checks if Disaster Recovery System (DRS) is configured and backup is completed.

Check

Displays the features considered for backup with their status.

Check Result

Following are the result details for the check:

  • Application name: Specifies the node name.

  • Backup Filename: Specifies the backup filename with file extension as .tar.

  • Features: Lists the backup features separated by comma.

  • Backup Status: Specifies backup status with the percentage completed. If the backup is in progress, the percentage completed is displayed.

  • Status:

    • Pass: Indicates that the backup is completed.

    • Fail: Indicates that the backup is not completed.

Status and Recommended Action

If the status fails, check if DRS is configured and run the scheduled or manual backup on all features.
Enterprise Service Parameters

Displays all the enterprise service parameters for Unified Communications Manager and IM and P.

Check

The service parameter values are collected.

Check Result

Following are the result details for the check:

  • Application Name: Specifies the node name.

  • Service Parameter: Specifies the service parameter name and the service name separated by PIPE (|||). Format of the output is <Service Parameter Name>||| <Service Name>.

  • Value: Specifies present value of the service parameter.

  • Status:

    • Pass: Indicates that the service parameter collection was successful from all nodes in the cluster.

    • Fail: Indicates that the service parameter collection was unsuccessful.

Status and Recommended Action

If the status fails, then check if the nodes in the selected cluster are reachable from HCM-F.
Health of Network Within the Cluster

Checks the network reachability among nodes in the selected cluster.

Check

Displays the node name and its reachability status.

Check Result

Following are the result details for the check:

  • Application Name: Specifies the node name.

  • Network Connectivity: Specifies if all the nodes are reachable or not.

  • Status:

    • Pass: Indicates that all the cluster nodes are reachable to each other.

    • Fail: Indicates that some or all of the nodes are not reachable.

Status and Recommended Action

If the check fails, check the node connectivity and credentials.

Installed COP Files

Checks if the required COP files are available for the upgrade.

The required COP file while upgrading from Cisco Unified Communications Manager Release 8(x)/9(x) to 11.5(x)/12.5(x) is ciscocm.version3-keys.cop.sgn.

Check

Displays the COP files available in the cluster.

Check Result

Following are the result details for the check:

  • Application Name: Specifies the node name.

  • Installed COP Files: Specifies the list of COP files installed.

  • Status:

    • Pass: Indicates the required COP files are available for the upgrade.

    • Fail: Indicates the required COP files are not available for the upgrade.

Status and Recommended Action

If the check fails, install the required COP files for upgrading Cisco Unified Communications Manager.
LDAP Details

Checks the last sync status of all LDAPs and their network connectivity.

Check

Displays LDAPs network connectivity and last sync status.

Check Result

Following are the result details for the check:

  • Application Name: Specifies the node name.

  • LDAP Server: Specifies the LDAP server name.

  • LDAP Status: Specifies the sync status and connectivity of all the LDAPs.

  • Status:

    • Pass: Indicates that the LDAP sync and connectivity are available.

      Note 

      The status appears as Pass even if LDAP is not configured.

    • Fail: Indicates that the LDAP sync or connectivity is not available.

Status and Recommended Action

If LDAP sync fails, update the LDAP credentials and rerun the sync. If LDAP is not in network, add LDAP to the network.
List of Services

Checks and displays the status all the services.

Check

Displays the status all the services.

Check Result

Following are the result details for the check:

  • Application Name: Specifies the node name.

  • Service Name: Lists the services available in the cluster.

  • Service Status: Specifies if the service is started or stopped.

  • Status:

    • Pass: Indicates the cluster was reachable for the collection.

    • Fail: Indicates that clusters were not reachable for the collection.

Status and Recommended Action

If the check fails, check the cluster credentials and its reachability. For Cisco Emergency Responder, check if the SNMP master Agent is running else the check fails.

Network Connectivity (DNS, SMTP, and NTP)

Checks if SMTP and DNS (Primary and Secondary) are configured and reachable. The DNS reachability and SMTP reachability fields display the server address along with the reachability status. The NTP status shows whether the UC application is synchronized with the configured NTP servers.


Note

The check ignores the status, if DNS, SMTP or NTP protocols are not configured.

Check

Displays the DNS (Primary and Secondary), SMTP reachability status along with the NTP synchronization status.

Check Result

Following are the result details for the check:

  • Application Name: Specifies the node name.

  • DNS Reachability: Specifies the DNS configuration and reachability status. Only if DNS is configured, Primary and Secondary DNS reachability status are displayed.

  • SMTP Reachability: Specifies the SMTP configuration and reachability status.

  • NTP Status: Specifies the UC application synchronization with the NTP server.

  • Status:

    • Pass: DNS or SMTP configured on the nodes are reachable and UC application is synchronized with the NTP server.

    • Fail: DNS or SMTP configured on the nodes are not reachable and UC application is not synchronized with the NTP server.

Status and Recommended Action

If the check fails, check the network connectivity with the configured DNS and SMTP. Diagnose NTP server configuration using the diagnostic modules.

Phone Count

Displays the phone count with status.

This information is used for comparison post upgrade.

Check

Displays the phone count with status.

Check Result

Following are the result details for the check:

  • Application Name: Specifies the node name.

  • Phone Status: Collects phone count for the following phone status:

    • Registered

    • Partially Registered

    • Rejected

    • UnRegistered

  • Phone Count: Specifies the phone count for the preceding status.

  • Status

    • Pass: Indicates that clusters were reachable for collecting the phone count.

    • Fail: Indicates that clusters were not reachable for collecting the phone count.

Status and Recommended Action

If the status fails, check if the node is reachable from HCM-F and initiate the check again.
Port Information

Displays the active ports and the total ports that are configured on the nodes. This check runs on all nodes in the cluster and is applicable only to Unity Connection.

This information is used for comparison post upgrade.

Check

Displays the active ports and the total ports that are configured on the nodes.

Check Result

Following are the result details for the check:

  • Total Ports: Displays the total ports configured for the node.

  • Ports in Service: Specifies the number of ports in service.

Status and Recommended Action

If the check fails, check the connectivity to Unity Connection, administrator credentials, node version and network address.
Run Pre-Upgrade Test

Performs the pre-upgrade checks and displays the result. This check is applicable only for Cisco Unity Connection.

Check

Performs the pre-upgrade checks and displays the result.

Result

  • Application Name: Specifies the node name.

  • Test name: Lists the executed tests:

    • Locales Installation Test

    • Connection DB Test

    • DRS Backup History Test

    • Cluster State Test

    • Critical Services Test

    • COP File Installation Test

  • Result: Specifies the status of the tests listed in the Test Name.

  • Status:

    • Pass: Indicates that all the tests passed.

    • Fail: Indicates that one or more tests failed.

Status and Recommended Action

Check the Recommended Actions to understand the failure reason.
State of Database Replication

Checks the current status of database replication between publisher and subscriber nodes for Cisco Unified Communications Manager and IM and Presence.

Check

Displays the current status of database replication between publisher and subscriber nodes for Cisco Unified Communications Manager and IM and P.

Check Result

Following are the result details for the check:

  • Application Name: Specifies the node name.

  • Database Replication Status: Specifies the node replication status.

  • Status:

    • Pass: Indicates that cluster nodes are reachable and data replication values are collected successfully.

    • Fail: Indicates that the cluster nodes are not reachable or the data replication failed for the cluster nodes.

Status and Recommended Action

If status is failed, then check the connectivity between publisher and subscriber nodes in the cluster. Also, check the reachability of cluster from HCM-F.

VCenter and ESXi and UCS Details

Collects the information about ESXi (host configuration) for understanding the supported and unsupported versions of vCenter, ESXi and VM hardware.

Check

Use this information provided to understand the supported and unsupported versions.

Check Result

Following are the result details:

  • Application Name: Specifies the node name.

  • ESXi/Host Configuration: Displays the following information:

    • VCenter version

    • ESXi version

    • VM hardware version

    • Blade model

    • VM Tools running

  • Pass: Indicates that the node was reachable for collection.

  • Fail: Indicates that the node was not reachable for collection.

Status and Recommended Action

If the check fails, check the node connectivity and credentials.

Post Upgrade Comparison

Perform upgrade comparison to validate the results obtained before and after upgrade.

Before you begin

Ensure to do the following:

Procedure

Step 1

From the side menu, choose Service Provider Toolkit > Upgrade Toolkit > Upgrade Comparison.

Step 2

From Select a Customer drop down, select the same customer name on which you performed Upgrade Checks before and after upgrade.

Step 3

From Select a Cluster drop down, select the the same UC application cluster on which you performed Upgrade Checks before and after upgrade..

The comparison check results (tick or cross-mark) for the selected UC application cluster appear in the Status column.

Step 4

Click the tick or cross-mark in the Status column to understand the result details.

Upgrade Comparison

The checks in Upgrade Comparison use the results obtained from the Upgrade Checks before and after upgrade for comparison. The following table lists the checks that are supported on different UC applications.

Table 10. Upgrade Comparison

Upgrade Comparison

Is Upgrade Comparison Supported on UC Application?

Unified CM

Unity Connection

IM and P

Installed COP Files

Y

N

Y

LDAP Details

Y

N

N

CTI Device Count

Y

N

N

List of Services

Y

N

Y

Phone Count

Y

N

N

CLI Diagnostics

Y

N

Y

Enterprise Service Parameters

Y

N

Y

Cluster Version Information

Y

Y

Y

Check Cluster Status

N

Y

N

Phone Compatibility Check

Perform this check to understand the deprecated phone details.

Before you begin

Upgrade Toolkit Prerequisites

Note

Ensure CHPA services are active using the command utils service activate Cisco HCS Provisioning Adapter as this check is applicable for phone compatibility.

Procedure

Step 1

From the side menu, choose Service Provider Toolkit > Upgrade Toolkit > Phone Compatibility Check.

Step 2

From Select a Customer drop-down, select the customer name for performing the checks.

Step 3

From Select a Cluster drop-down choose a UC application cluster, or choose All to perform the compatibility check on all clusters of a customer.

Date and time when the last phone compatibility check for the cluster was performed appears, if the compatibility check for the same customer and the same UC application cluster is initiated. The compatibility check result can be downloaded using Download.

Step 4

Click Submit to perform the compatibility check.

The job initiation status appears.
Step 5

Check the job status.

Select Infrastructure Manager > Administration > Jobs. Check for Job Entity, UC Monitor Checks.

Note 

You can run the check on different clusters for the same customer at the same time. But, if a check for a customer cluster is in progress and if another check is initiated for the same cluster, the initiation fails.

Step 6

Click Download to download the .csv file.

The .csv file contains Customer Name, Cluster Name, User Name, Phone Model, Device Name, Phone IP address, and Directory number.

Upgrade UC Application to 12.5 to Use Smart Licensing

Provision the Smart account with client credentials that includes Client ID and Client Secret in HCM-F. This provisioning enables HCM-F to authenticate with the Cisco Authentication Gateway with the client credentials. HCM-F gets the access token from Cisco Authentication Gateway for communicating with CSSM.

Procedure

Step 1

Create a CSSM client application with the CCO ID. The CCO ID stores the Client ID and Client Secret.

The CCO ID must have ‘Smart Account User’ access for the specific Smart Account, to enable HCM-F to manage smart license.

To create the application, select the OAuth Grant type as Client Credentials Grant. HCM-F uses the Client Credentials Grant type to communicate with CSSM.

To create a new application with client credentials and select the Grant type, go to mulesoft API gateway at:

Smart Accounts and Licensing API
Step 2

Configure HCM-F for Smart Licensing.

  1. Unassign the UC clusters from PLM before you upgrade HCM-F and UC clusters to 12.5(x). Navigate to License Management > License Management Summary.

  2. Upgrade HCM-F to 12.5(x). For details, see Cisco Hosted Collaboration Mediation Fulfillment Install and Configure Guide

  3. Set the Transport Mode in HCM-F, navigate to Smart Licensing > Transport Mode). For details, see Cisco Hosted Collaboration Mediation Fulfillment Install and Configure Guide

    Note 

    CER cluster assignment with Smart Account works with port 8443, as port 3128 is not open in CER. For other UC clusters, port 3128 is still valid.

  4. Configure the Smart Account, navigate to Smart Licensing > Configure Smart Account. For details, see Cisco Hosted Collaboration Mediation Fulfillment Install and Configure Guide

    Note 

    Once the Smart Account is configured, HCM-F synchronizes with CSSM portal and retrieves all the Virtual Account details to HCM-F in Virtual Account Summary window (Smart Licensing > Virtual Account Summary).

  5. Assign the License Mode to HCS for a Virtual Account, navigate to Smart Licensing > Virtual Account Summary. For details, see Cisco Hosted Collaboration Mediation Fulfillment Install and Configure Guide

    Note 

    Ensure the licenses are present in the VA in CSSM.

  6. Upgrade the UC applications.

  7. Upgrade the Cluster Application Version to 12.5(x). Navigate to Cluster Management > Cluster > to verify the version. For details, see Cisco Hosted Collaboration Mediation Fulfillment Install and Configure Guide

  8. Assign a Cluster to a Virtual Account. For more information, see Cisco Hosted Collaboration Mediation Fulfillment Install and Configure Guide

Note 

Ensure the HCM-F job is successful.
Step 3

Login to Cisco Software Central, to check that the product instances are populated correctly and licenses are consumed.

Upgrade Requirements for Push Notifications

Use the following table to determine whether you need to upgrade your system in order to deploy Push Notifications.

Table 11. Upgrade Requirements to Support Push Notifications

If your Apple mobile deployment includes...

Upgrade to these minimum releases...

No Jabber clients on iOS

No upgrade required

Phone only (with iOS)

See the Cisco Hosted Collaboration Solution Compatibility Matrix for details on minimum supported versions of Cisco Jabber, Unified CM, and Expressway MRA for implementing Apple Push Notification Service for IM and presence.

Instant Messaging only (with iOS)

See the Cisco Hosted Collaboration Solution Compatibility Matrix for details on minimum supported versions of Cisco Jabber, Unified CM and IM and Presense Service, and Expressway MRA for implementing Apple Push Notification Service for IM and presence.

Full Unified Communications (calling and instant messaging)

See the Cisco Hosted Collaboration Solution Compatibility Matrix for details on minimum supported versions of Cisco Jabber, Unified CM and IM and Presense Service, and Expressway MRA for implementing Apple Push Notification Service for IM and presence.

Full Unified Communications (calling and WebEx Messenger)

See the Cisco Hosted Collaboration Solution Compatibility Matrix for details on minimum supported versions of Cisco Jabber, Unified CM for implementing Apple Push Notification Service for IM and presence.

Upgrades from 11.5(1)SU2 with Push Notifications Enabled

If you are upgrading from the 11.5(1)SU2 release and you had Push Notifications enabled in the old release, you must disable Push Notifications in the current release and then follow the onboarding process to enable Push Notifications once again. This is required due to API changes in this release that were not a part of the 11.5(1)SU2 release. Your upgraded system will not be able to send troubleshooting logs to the Cisco Cloud unless you disable Push Notifications and then follow the onboarding process for this release.

After you upgrade your system, do the following:

Procedure

Step 1

Disable Push Notifications

Follow these steps:

  1. From Cisco Unified CM Administration, choose Advanced Features > Cisco Cloud Onboarding

  2. Uncheck the following check boxes:

    • Enable Push Notifications

    • Send Troubleshooting information to the Cisco Cloud

    • Send encrypted PII to the Cisco Cloud for troubleshooting

  3. Click Save.

Step 2

Add a Unified Communications Manager product instance into the Smart Licensing system.

See the "Smart Software Licensing" chapter of the System Configuration Guide for Cisco Unified Communications Manager at http://www.cisco.com/c/en/us/support/unified-communications/unified-communications-manager-callmanager/products-installation-and-configuration-guides-list.html.

Step 3

Enable Push Notifications for this release.

For the full onboarding process, See the "Configure Push Notifications for Cisco Jabber on iPhone and iPad" chapter of the System Configuration Guide for Cisco Unified Communications Manager at http://www.cisco.com/c/en/us/support/unified-communications/unified-communications-manager-callmanager/products-installation-and-configuration-guides-list.html.