This document describes the Unity Connection Release 9.x license
process and the introduction of the Enterprise Licensing Manager (ELM). ELM is
a web-based tool that can run on the same node as Unity Connection/CUCM or on a
standalone device and simplifies the license registration process.
There are no specific requirements for this document.
This document is based on Cisco Unity Connection Release 9.0 and
The information in this document was created from the devices in a
specific lab environment. All of the devices used in this document started with
a cleared (default) configuration. If your network is live, make sure that you
understand the potential impact of any command.
Technical Tips Conventions for more information on document
Licenses are handled differently in Cisco Unity Connection and Cisco
Unified Communications Manager (CUCM) Release 9.0(1) and later. Previously,
licenses were handled in plain text license files that were uploaded to
individual servers/clusters and tied to the server's MAC address. Or, in the
case of virtual machines, a licensing MAC address.
In Release 9.0 and later, Unity Connection moved to what will hopefully
be an easier to manage process. The main revision that supports the easier
process is the introduction of ELM. Multiple servers can be connected to a
single ELM instance and allowed to share/pool licenses. In addition to the
changes to the method that licenses are applied, Cisco has also greatly
simplified the number of licensed features that are available.
Previously, a license file for a release earlier than Release 9.x might
have had over a dozen attributes:
LicSubscribersMax—Users with voice mailboxes
LicIMAPSubscribersMax—Users with Internet Message Access protocol
(IMAP) or Single Inbox access to voice messages
LicVMISubscribersMax—Cisco Unity Inbox users
LicAdvancedUserMax—Text-to-speech (TTS) and Automatic Speech
Recognition (ASR) (advanced users)
LicSTTSubscribersMax—Cisco SpeechView users
LicMaxMsgRecLenIsLicensed—Voice message recordings longer than 30
LicRegionIsUnrestricted—US English usage and personal call routing
LicVPIMIsLicensed—Voice Profile for Internet Mail (VPIM) Networking
delivery locations allowed
LicUCxnUpgrades—License files from previous releases
LicVMNIsLicensed—ViewMail for Notes feature
With Release 9.x, this has been greatly simplified:
CUC_Messaging—Total number of voice mail users
CUC_SpeechView—Total number of SpeechView standard
CUC_SpeechViewPro—Total number of SpeechView professional
CUC_SpeechConnectPort—Total number of TTS and ASR
Almost everything has been collapsed under the CUC_Messaging feature.
Most user features, other than SpeechView, are not licensed separately and
there are no longer port licenses. This allows you to configure as many as your
hardware platform supports.
By default, ELM is installed co-resident with Unity Connection, CUCM,
or CUCM Business Edition 5000. There are no steps necessary to ensure this
happens and, in fact, you cannot prevent it. ELM can also be installed on a
In order to install ELM, complete these steps:
Boot a server or virtual machine off of the Release 9.0 installation
media, which is the same as for the Unity Connection or CUCM installation
From the Product Deployment Selection window, choose Cisco
Enterprise License Manager.
Complete the installation as normal.
ELM can be reached from this URL: https://<address of
A link is also provided on the default home page at this URL:
https://<address of server>. It is NOT currently
listed in the navigation drop-down list on the upper right corner of other
server administration pages (such as, OS admin, cuadmin, ccmadmin, and
To log in, use the application administrator's account credentials.
These are the credentials you would use to access cuadmin or ccmadmin, NOT the
OS administration account.
All Release 9.x servers must be registered to an ELM server to function
properly. There is no alternative.
Note: The same steps apply for both an upgrade from Release 9.x and
earlier and also for new installations.
In order to register the server, complete these steps:
Log in to the ELM administration interface (refer to
Expand Inventory and click Product
Choose Add and enter the name, product type,
hostname/ip, username, password, and so on as appropriate.
Note: In the username/password fields, enter the OS administration
account information and NOT the application administration account information
used to log in to ELM.
Choose Test Connection to validate the entries. Once
the test passes, click OK.
Verify the server is now listed in the Product Instances table.
The exact process to follow depends on your installation/upgrade path.
Refer to the applicable section below for the exact steps.
In order to install the files, complete these steps:
Log in to the ELM administration interface (refer to
Expand License Management and click
Click Generate License Request.
A screen displays instructions to select and copy a string of text.
Go to Product
License Registration, enter your Product Authorization Key (PAK) ID, and
paste in the string of text.
Once the above steps are complete, the license file will be
In order to upload the emailed file to the ELM server, in the
Licenses window click Install License
These three scenarios are supported in order to migrate to Release 9.x
Unity Connection licenses. In all three scenarios, the end result prior to the
request for a Release 9.x license is that data is populated in the
tbl_CUCLegacyLicenseInfo table in UnityDirDb database. Once this information is
present, the same process is followed to request a migrated Release 9.x
In-place Upgrade of a Previous Version of Unity Connection to
Unity Connection Release 9.x
License data is automatically copied into the table in the upgrade
Migration from a Previous Version of Unity Connection to a New
Release 9.x Server via COBRAS
Download and run the latest version of Cisco Objected Backup and
Restore Application Suite (COBRAS) Export for Unity tool from
Cisco Unified Communication
Choose License Details for Migration to Connection 9.x and
This option requires the OS administration credentials and NOT the
application administration account used to run COBRAS.
Download and run the latest version of COBRAS Import for Unity tool,
Release 1.2.10 or later, from Cisco
Unified Communication Tools.
Choose at least one object to import. There is not a way to only
import license data.
After the import is complete, the SQL table is updated if the import
Migration from Microsoft Windows-based Unity Connection to a
New Unity Connection Release 9.x Server via COBRAS
Download and run the latest version of COBRAS Export for Unity tool,
Release 7.0.121 or later, from Cisco Unified Communication
Run an export. The current license information will be included in
the export data.
Note: There is not a specific option that needs to be checked. It will
always be included.
Run the latest version of COBRAS Import for Unity tool, Release
1.2.10 or later, from Cisco Unified
Communication Tools. For the wizard to proceed, choose at least one
After the import is complete, the tbl_CUCLegacyLicenseInfo SQL table
is updated if the import was successful.
With data populated in tbl_CUCLegacyLicenseInfo by some combination of
the above methods, complete these steps to request and install a migrated
Note: The server must be registered with ELM first.
Log in to the ELM administration interface to which the server is
Choose License Management > License Planning > Upgrade
In the Product Type field, choose Unity Connection.
In the Available Product Instances field, choose the server in
question. Click the arrow to move the server name to Product Instances to
Upgrade. Click Next.
Verify the license counts. Click
Optionally, view/save the summary report.
Click Finish & Generate
Follow the on-screen instructions to copy/save the text output and
paste it into the
License Registration migration portal.
Once the above steps are completed, the license file will be
To apply the license file in ELM, choose License Management
> Licenses. Click Install License File and upload
the received license file.
In a Cisco Unity Connection (high availability) environment, only the
publisher server needs to be configured and connected with the ELM to obtain
the license status and for the license enforcement. When the publisher server
stops functioning (for example, when it is shut down for maintenance), the
subscriber server handles all the incoming calls for the cluster for a 60 days
grace period. However, if the publisher server does not resume its normal
function within the 60 days grace period, Unity Connection will move to the