Installation Guide for Cisco Unified SIP Proxy Release 10.2

Installation Guide for Cisco Unified SIP Proxy Release 10.2

---

First Published: August 27, 2020

This document provides the technical information that you need to install Cisco Unified SIP Proxy Release 10.2 and contains the following topics:

• Change History
• Overview
• Server Requirements
• Virtual Machine Requirements for Cisco Unified SIP Proxy
• Downloading the Cisco Unified SIP Proxy OVA
• Deploying the Cisco Unified SIP Proxy OVA
• Patch Upgrade
• Configuring the CUSP Software
• Configuring Cisco Unified SIP Proxy Application
• Cisco Smart Software Licensing
• Cisco Smart Software Manager Satellite
• Migration from Cisco Unified SIP Proxy 8.x to Cisco Unified SIP Proxy 10.2
• Upgrading from Cisco Unified SIP Proxy Release 9.x to Release 10.2
• Upgrading from Cisco Unified SIP Proxy Release 10.0.x or 10.1 to Release 10.2

Change History

This table lists all the changes made to this guide, the most recent changes appearing at the top.

Overview

Cisco Unified SIP Proxy Release 10.2 supports operating within a VMware ESXi virtualized environment. The software is packaged as an OVA for installation within the ESXi environment (5.5 and above). For more information about the ESXi environment, see: http://www.vmware.com/products/vsphere/esxi-and-esx/overview.html

Except the High Availability (HA) feature using Hot Standby Router Protocol (HSRP), Cisco Unified SIP Proxy Virtual application supports all the other features that are supported by Cisco Unified SIP Proxy on a SRE Module.

---

Note For information on caveats resolved in Cisco Unified SIP Proxy Release 10.2, see “Caveats” section in Release Notes for Cisco Unified SIP Proxy 10.2.

Server Requirements

Following is the approach to select a server for running Cisco Unified SIP Proxy Software within a VMware ESXi environment.

• Specifications-based Platforms

Virtual Machine Requirements for Cisco Unified SIP Proxy

Cisco Unified SIP Proxy Software requires VMware ESXi 5.5 and above. After configuring the server hardware, install VMware vSphere ESXi.

---

Note Cisco Unified SIP Proxy deployment requires 6 GB RAM and 80 GB disk space.

Table 2 provides the hardware recommendations for the virtualized Cisco UCS platform.

---

Note CPU speed is greater than or equal to 2.99 GHz.

Table 3 provides the hardware recommendations for virtualized low speed Cisco UCS and Cisco UCS (E) platforms.

---

Note CPU speed is less than 2.99 GHz.

---

---

Downloading the Cisco Unified SIP Proxy OVA

To download the Cisco Unified SIP Proxy Server OVA template (virtual machine template), perform the following steps:

---

Step 1 Open the Cisco Unified SIP Proxy Server site:
http://www.cisco.com/c/en/us/support/unified-communications/unified-sip-proxy-software/tsd-products-support-series-home.html

Step 2 If prompted, log in, using your Cisco.com user name and password.

Step 3 Locate the OVA in “Download Software” section and download the file.

 

Deploying the Cisco Unified SIP Proxy OVA

After downloading the Cisco Unified SIP Proxy OVA, use the following procedure to deploy the virtual machine template.

Prerequisites

• Cisco Unified SIP Proxy OVA for installation
• Server with VMware ESXi environment installed
• (Optional) VMware vCenter vSphere Client installed and operating

Procedure

---

Step 1 In the Hypervisor GUI, select File > Deploy OVF Template…

The Deploy OVF Template dialog box appears.

Step 2 Browse to the location where Cisco Unified SIP Proxy Server OVA file is downloaded. Click Next.

Step 3 Review and confirm the software image details. Click Next.

Step 4 Enter the name of the device in Name field. The name provided determines how the device appears in the left pane of the vCenter window.

Step 5 Click Next.

The Deploy OVF Template dialog box displays disk format options.

---

Note If there are multiple server hosts running ESXi, select the host on which you want Cisco Unified SIP Proxy Server to run. Click Next.

Step 6 Select any of the following Thick provisioning format.

• Thick Provision Lazy Zeroed
• Thick Provision Eager Zeroed

Step 7 Click Next.

The Deploy OVF Template dialog box displays the available networks.

Step 8 Select the network under Destination Networks column. The selected network is used to communicate with the remote sites.

Step 9 Click Next.

The Deploy OVF Template dialog box displays a summary of the options that you have configured.

Step 10 Click Finish to deploy Cisco Unified SIP Proxy Server.

A dialog box indicates when the deployment is complete.

Step 11 Select the VM instance, right click and choose Edit Settings....

Virtual Machine Properties dialog box appears.

Step 12 Click the Hardware tab and set the values for memory and vCPU as provided in Table 2 .

Step 13 Click the Resources Tab and select CPU. Adjust the Reservation and Shares to the value provided in Table 2 .

---

Note Select the Unlimited option if the call flow details and the expected call capacity expected are not clear (this option takes care of cases where the call load is more than the planned load and needs additional CPU resources).

Step 14 Select Memory and change the reservation value as mentioned in the Table 2 .

---

Note Select the Unlimited option if the call flows details and expected call capacity expected are not clear (this option handles the cases where call load is more than the planned load and needs additional RAM).

Step 15 Save the settings.

Step 16 Right click or select actions for the virtual machine and select Upgrade VM Compatibility.

Step 17 Select the Hypervisor version in use and select Upgrade.

Step 18 Restart the VM.

Step 19 Select Resource Allocation and confirm the resource reservations.

 

Patch Upgrade

You can install a patch file on an existing major release version of Cisco Unified SIP Proxy starting with Cisco Unified SIP Proxy Release 10.2. The patch file helps you upgrade to a newer patch version of the Cisco Unified SIP Proxy without any modifications to your existing virtual machine.

When the upgrade begins, the system goes offline and prevents you from making any configuration changes. Cisco Unified SIP Proxy stops processing calls in the offline mode. As part of the upgrade process, the existing configuration is backed up before installing the patch file. The backup files are stored in the server specified while configuring backup and restore.

You can return the system to the Online mode after the patch install. Call processing will resume once the system is online. In case the patch upgrade is successful, you can bring back the system to Online mode with the new patch version. If the patch upgrade fails, vCUSP will try to bring itself back to the original patch/release version from where the installation was attempted.

The patch releases are cumulative. Installing the latest patch file contains all the changes that were part of the previous patch releases. For example, the patch release Cisco Unified SIP Proxy Release 10.2v3 contains all the changes that were part of Cisco Unified SIP Proxy Release 10.2v1 and Cisco Unified SIP Proxy Release 10.2v2.

---

Note ● Although both Command Line Interface (CLI) and Graphical User Interface (GUI) are supported for patch upgrade, we recommend you to use CLI for a smooth upgrade experience. When you use GUI there are chances of downtime for a minute or two due to the web server reload depending on the fix the patch carries. We also recommend you to read the patch release notes before initiating the patch upgrade.

• Upgrade to a new major version (for example to 10.3) requires a new OVA deployment, similar to the upgrade to 10.2. For detailed information, see “Migration to Cisco Unified SIP Proxy 10.2” section of Release Notes for Cisco Unified SIP Proxy 10.2.
• You cannot manually roll back to a previous version of the patch release. For example, if you are currently on Cisco Unified SIP Proxy Release 10.2v3, you cannot roll back to Cisco Unified SIP Proxy Release 10.2v1

 

For details on installing patch using CLI and GUI, see CLI Configuration Guide for Cisco Unified SIP Proxy Release 10.2 and GUI Configuration Guide for Cisco Unified SIP Proxy Release 10.2.

Configuring the CUSP Software

When you open the first session, the system launches the post installation configuration tool, and asks you if you want to start configuration immediately.

Enter the appropriate response, y or n. If you enter n, the system will halt. If you enter y, the system will ask you to confirm, then begin the interactive post installation configuration process.

The following is an example:

---

Note During the configuration of Cisco Unified SIP Proxy software, the post installation configuration tool displays an IP address acquired through DHCP, and asks if you want to use this configuration. Enter the appropriate response, y or n. If you enter n, you can configure your module with the required IP address. If you enter y, the IP address acquired through DHCP is set as the IP address of your module. To reset the IP address of your module, follow the steps mentioned in the section Configuring NTP Servers.

Configuring Cisco Unified SIP Proxy Application

Cisco Unified SIP Proxy can be configured in the following ways:

• Configuring Cisco Unified SIP Proxy using GUI
• Configuring Cisco Unified SIP Proxy using CLI
• Configuring Cisco Unified SIP Proxy using SSH

Cisco Smart Software Licensing

Cisco Smart Software Licensing is a standardized licensing platform that facilitates you to deploy and manage Cisco software licenses easily and quickly. Cisco Smart Software Licensing establishes a pool of software licenses that can be used across your network in a flexible and automated manner. It also provides visibility to your purchased and deployed licenses in your network. Cisco Smart Software Licensing removes the need for Product Activation Keys (PAKs) and reduces your license activation and registration time.

You must have a valid account in Cisco Smart Manager to configure smart licensing for Cisco Unified SIP Proxy. By logging into your account in Cisco Smart Manager, you can generate token ID for Cisco Unified SIP Proxy. The generated token ID is unique to your account and it is mandatory to provide the generated token ID during license registration. The Cisco Unified SIP Proxy (Smart Agent) contacts the Cisco Smart Manager (Cisco Datacentre) using Call Home or HTTP protocol and configures the license. Smart licenses can be configured using either Graphical User Interface (GUI) or Command Line Interface (CLI).

Once the smart licensing is enabled and configured using GUI or CLI, the Cisco Unified SIP Proxy sends the entitlement tag, token ID and other required information to the Smart Agent and registers with the Smart Manager (cloud server). The registration is valid for a period of one year. If the registration fails, then Cisco Unified SIP Proxy moves to evaluation mode. In evaluation mode, all features are supported for 90 days. Cisco Unified SIP Proxy stops working after the evaluation period.

After successful registration, the license count and other necessary details are sent to the Smart Manager for authorization. If the authorization is successful, the Cisco Unified SIP Proxy is in authorized state. If the requested number of licenses is within the purchased license count, Licensing Agent state moves to InCompliance state. If the requested number of licenses is more than the purchased licenses, Licensing Agent state moves to OutofCompliance state.

The authorization is renewed automatically every 30 days without the intervention of the users. In case the authorization renewal fails for 90 days, Cisco Unified SIP Proxy moves to the authorization expiry state. In this state, Cisco Unified SIP Proxy continues to receive all the calls. But, at the same time, the Smart Agent retries to renew the authorization every four hours to establish a new registration period. Also, if you have a valid license, calls are not rejected when the calls-per-second exceeds the purchased license count. Since the Cisco Unified SIP Proxy is successfully authorized once, all calls are processed in the AuthorizedPeriodExpired or EvalExpired mode. In the event where the Smart Agent Client is disabled using GUI or CLI, none of the calls are processed. In this case, Cisco Unified SIP Proxy should have another successful authorization with Cisco Smart Manager to process calls in the AuthorizedPeriodExpired or EvalExpired mode.

For information on configuring smart licenses using GUI and CLI refer to GUI Configuration Guide for Cisco Unified SIP Proxy Release 10.2 and CLI Configuration Guide for Cisco Unified SIP Proxy Release 10.2.

Cisco Smart Software Manager Satellite

Cisco Smart Software Manager satellite is a component of Cisco Smart Licensing and works with Cisco Smart Software Manager (CSSM). It helps customers intelligently manage product licenses, providing near real-time visibility and reporting of the Cisco licenses they purchase and consume. From release 9.1.5 onwards, Cisco Unified SIP Proxy supports Cisco Smart Software Manager satellite version 3.0.0. When using version 10 licenses for a version 9 CUSP instance registered to a Satellite, the Satellite version must be 7 or higher.

For security-sensitive customers who do not want to manage their installed Cisco Unified SIP Proxy using a direct Internet connection, the Smart Software Manager satellite is installed on the customer premises and provided a subset of CSSM functionality. The satellite needs to synchronize with CSSM to reflect the latest license entitlements periodically. The satellite registration process is immediate. Cisco Unified SIP Proxy can register to the Smart Software Manager satellite directly as though it were a replicate of the Smart Software Manager in one of the following methods:

• Direct connection to CSSM
• Connection to local satellite using secure connection (https)
• Connection to local satellite using nonsecure connection (http)

---

Note Customers need to synchronize their local databases with the Cisco portal to make sure that the most recent purchases are reflected in their local copies.

For information on deploying, installing, and managing Smart Software Manager satellite, see Smart Software Manager satellite Installation Guide.

For support on installation of the satellite or other synchronization issues, contact the satellite team at: mailto:cs-cssm-satellite@cisco.com.

Migration from Cisco Unified SIP Proxy 8.x to Cisco Unified SIP Proxy 10.2

You can migrate from an existing Cisco Unified SIP Proxy 8.x releases to Cisco Unified SIP Proxy Release 10.2. However, the following are the limitations during the migration:

• Cisco Unified SIP Proxy Release 10.2 cannot be installed on SRE Module. You require VMWare ESXi platform to install Cisco Unified SIP Proxy Release 10.2.
• Existing Cisco Unified SIP Proxy 8.x SWIFT licenses cannot be migrated to Cisco Unified SIP Proxy 10.2.Contact your Cisco partner or reseller to enquire about the purchase of current licensing.
• The backup configuration files from Cisco Unified SIP Proxy 8.x release do not have the network-related configuration as the Cisco SRE module gets the relevant information through RBCP protocol from the host router when it powers up. Cisco Unified SIP Proxy 10.2 does not support RBCP communication. So, if a backup configuration from Cisco Unified SIP Proxy 8.5.x release is restored in Cisco Unified SIP Proxy 10.2, you must manually enter and configure the IP address, subnet mask, and default gateway details during the reload as follows:

a. Ensure that you have console access to the VM of virtual Cisco Unified SIP Proxy 10.2, while you are restoring the configuration of 8.X on 10.2.

b. After the restore is completed, reload the module as per the instructions on the screen.

c. Immediately after the reboot is completed, access the console with your username and password.

d. Configure the IP address, subnet mask, and default gateway as follows:

e. After the Cisco Unified SIP Proxy is online, re-associate the users to groups with password reset and try to ssh.

• Cisco Unified SIP Proxy 8.x release configuration has multiple sub-interfaces. The sub-interface format in Cisco Unified SIP Proxy Release 10.2 is different from that in Cisco Unified SIP Proxy Release 8.x. You must configure these interfaces manually after the reload is complete.
• Listen points are not restored as it requires the IP address of the virtual Cisco Unified SIP Proxy. So, you must manually configure the listen points after restoring the back up from the Cisco Unified SIP Proxy 8.x release.
• SIP Ping configuration is not restored as it requires the IP address of the virtual Cisco Unified SIP Proxy. So, you must manually configure SIP Ping configuration on Cisco Unified SIP Proxy 10.2 release after restoring the backup from the Cisco Unified SIP Proxy 8.x release.

Following are the steps to migrate from any of the existing Cisco Unified SIP Proxy Releases to Cisco Unified SIP Proxy Release 10.2:

1. Take a backup of the existing Cisco Unified SIP Proxy 8.x configuration. For more information, see CLI Configuration Guide for Cisco Unified SIP Proxy CLI Release 8.5 or GUI Administration Guide for Cisco Unified SIP Proxy Release 8.5.

2. Deploy the Cisco Unified SIP Proxy Release 10.2 OVA on a virtual machine. For more information, see Cisco Unified SIP Proxy 10.2 Installation Guide.

3. Configure the Smart licenses. For more information, see GUI Administration Guide for Cisco Unified SIP Proxy Release 10.2 and CLI Configuration Guide for Cisco Unified SIP Proxy Release 10.2.

4. Restore the configuration backup of Cisco Unified SIP Proxy 8.x in Cisco Unified SIP Proxy 10.2. For more information, see CLI Configuration Guide for Cisco Unified SIP Proxy Release 10.2 and GUI Administration Guide for Cisco Unified SIP Proxy Release 10.2.

---

Note Smart licensing details are reset if smart licensing is configured before restore of configuration. It is always recommended to restore the configuration before enabling smart licensing.

---

Note When you migrate from Cisco Unified SIP Proxy Release 8.x to Cisco Unified SIP Proxy Release 10.2, if there are no Sub-Interfaces or VLANs defined on the Virtual Machine, remove the VLAN 0 tag from packets at the ESXi switch side or network side. If not, packets with VLAN 0 tag are dropped.

Upgrading from Cisco Unified SIP Proxy Release 9.x to Release 10.2

You can upgrade your system from Cisco Unified SIP Proxy Release 9.x to Release 10.2.

A clean install wipes out all configuration and data; therefore, you must back up your configuration first. After you install the new system, you restore the configuration and data. Use the information in this section along with the other configuration sections in this guide.

---

Note Although a best effort has been made to ensure backward compatibility, we recommend that you thoroughly inspect the backed up configuration to ensure that the data was not compromised.

Upgrading from Cisco Unified SIP Proxy Release 10.0.x or 10.1 to Release 10.2

You can upgrade your system from Cisco Unified SIP Proxy Release 10.0.x or 10.1 to Release 10.2.

A clean install wipes out all configuration and data; therefore, you must back up your configuration first. After you install the new system, you restore the configuration and data. Use the information in this section along with the other configuration sections in this guide.

---

Note Although a best effort has been made to ensure backward compatibility, we recommend that you thoroughly inspect the backed up configuration to ensure that the data was not compromised.