System Administration Guide for Cisco Unity Connection Release 8.x
Managing Licenses in Cisco Unity Connection 8.x
Downloads: This chapterpdf (PDF - 153.0KB) The complete bookPDF (PDF - 3.36MB) | Feedback

Table of Contents

Managing Licenses in Unity Connection 8.x

About License Files

License Files and MAC Addresses

License Files and MAC Addresses for Unity Connection Physical Servers

License Files and License MACs for Unity Connection Virtual Machines

Installing Multiple License Files

License Files Must Be Installed

Permanent, Time-Expiring, and Demonstration License Files

License Files and Unity Connection Clusters

License Files and Migrations from Cisco Unity

License Violations

Obtaining and Installing a License File

Viewing Reports for Licenses

Viewing the License Usage

Viewing the License Expirations

License Parameters for Unity Connection Features

About License Files

See the following sections:

License Files and MAC Addresses for Unity Connection Physical Servers

Each license file for a physical Unity Connection server (except for the demonstration license file) is registered to the MAC address of the network interface card (NIC) on the Unity Connection server. The license file for one server cannot be used on a second server (for example, because you want to replace the Unity Connection server). You must obtain a replacement license file that is registered to the MAC address on the second server.

The license file can be registered to only one MAC address. If the Unity Connection server has a dual NIC, you must either configure it for network fault tolerance, which assigns one MAC address to both NICs, or disable one of the NICs and use the MAC address for the other NIC.

When you order a license file for a dual NIC that has been configured for network fault tolerance, specify the virtual MAC address that applies to both NICs rather than the physical MAC address for either of the NICs. The license file is registered to the virtual MAC address, so the license will continue to be valid even if one of the NICs fails.

License Files and License MACs for Unity Connection Virtual Machines

Each license file for a Unity Connection virtual machine (except for the demonstration license file) is registered to a license MAC value. This value is calculated to look like a MAC address based on the settings listed in Table 42-1 , but it is not a real MAC address.

If you change any of these settings, the existing licenses become invalid, and you must obtain replacement license files that are registered to the calculated license MAC value that is based on the new settings. The old licenses continue to work for a 30-day grace period. During the grace period, you can change the settings back to the original values to make your original licenses valid again. If you need more than 30 days of grace period, change your settings to the original values, then change them back to the new values that you want to use, and you will get another 30- day grace period.

If you do not reset the 30-day grace period by changing settings back to the original values, then Unity Connection stops running. If you restart the server, Unity Connection starts running again but stops after 24 hours. Each time you restart the server, Unity Connection runs for another 24 hours until you either change the settings back to the original values or you install licenses based on the new license MAC value.

To display the license MAC on a Unity Connection virtual machine, run the show status CLI command.

 

Table 42-1 Settings Included in the License MAC, and Operations That Require a New License File

Setting
Operations That Change the Setting and Require a New License File

Time zone

Running the set timezone CLI command.

NTP server 1

In Cisco Unified Operating System Administration, navigating to the Settings > NTP Servers page and changing which server is the first server on the list.

NIC speed

Running the set network nic eth0 CLI command with either the auto parameter (to enable or disable auto negotiation) or the speed parameter (to specify whether the speed of the Ethernet connection is 10 or 100 Mb/s).

Hostname

Using the process documented in the “Renaming Unity Connection 8.x Servers” chapter of the Reconfiguration and Upgrade Guide for Cisco Unity Connection Release 8.x , at http://www.cisco.com/c/en/us/td/docs/voice_ip_comm/connection/8x/upgrade/guide/8xcucrugx/8xcucrug060.html .


Caution If you change the hostname without following the documented process, Unity Connection will stop functioning.

IP address


Caution If you change the IP address, IP mask, or gateway address without following the documented process, Unity Connection will stop functioning.

IP mask

Gateway address

Primary DNS

Running the set network dns primary CLI command.

SMTP server

  • Running the set SMTP CLI command and adding, changing, or deleting the hostname of the SMTP server.
  • In Cisco Unified Communications Operating System, navigating to the Settings > SMTP page and adding, changing, or deleting the value of the Hostname or IP Address field.

Certificate information (Organization, Unit, Location, State, Country)

Running the set web-security CLI command.


Caution Changing any of the above settings on the publisher or subscriber server, invalidates the software license on the server and you must then re-host the license.

Installing Multiple License Files

Multiple license files can be installed on a Unity Connection server. Each installed license file may enable one or more features. All of the installed license files combined enable the features that the customer wants.

Before a license file can be installed, it must be added to the Licenses page in Cisco Unity Connection Administration.


NoteIf the Unity Connection demonstration license is installed on the Unity Connection server, it must be the only license file that is installed, even though you may have added other license files. If the Unity Connection demonstration license is installed on the Unity Connection server, it must be the only license file that is installed, even though you may have added other license files.


License Files Must Be Installed

For license files to become effective, they must be installed after they are added to the Licenses page. For details on installing license files, see the To Install the License Files.

Permanent, Time-Expiring, and Demonstration License Files

The following types of license files are available:

  • Permanent license files are registered either to the MAC address of the network interface card (NIC) on a Unity Connection physical server or to a license MAC value on a Unity Connection virtual machine. These license files do not have an expiration date.
  • Time-expiring license files are registered to the MAC address of the NIC on the Unity Connection server. These license files have an expiration date. All of the features that are enabled by a time-expiring license file will be disabled after the expiration date.
  • Demonstration license files are not registered to a MAC address. These license files do not have an expiration date and enable only a limited range of features (for example, a maximum of two voice messaging ports and ten users with voice mailboxes). A demonstration license file is included with every Unity Connection server. If this license file is installed, it must be the only license file that is installed on the Unity Connection server.

For information on obtaining and installing license files, see the “Obtaining and Installing a License File” section.

License Files and Unity Connection Clusters

When a Unity Connection cluster (high availability) is configured, two licenses are required because licenses are not replicated. The license that has the MAC address or license MAC of the publisher server must be installed on the publisher server. The license that has the MAC address or license MAC of the subscriber server must be installed on the subscriber server. For details on installing license files, see the To Install the License Files.


NoteEither or both Unity Connection servers in a cluster can be installed on virtual machines. Either or both Unity Connection servers in a cluster can be installed on virtual machines.


The license on each server includes the parameter that sets the maximum number of voice messaging ports for that server. The license on only one server (typically the publisher server) includes all other applicable parameters (such as the maximum number of voice messaging users and voice message recordings longer than 30 seconds), which are enabled on both servers in the Unity Connection cluster.

License Files and Migrations from Cisco Unity

Unity Connection can use Cisco Unity license files to enable Unity Connection features when migrating from Cisco Unity 4.x or later to Unity Connection.

Cisco Unity license files must have the MAC address of the server on which Unity Connection is installed or the license MAC of the virtual machine:

  • If Unity Connection is installed on the same server on which Cisco Unity was installed, you can install the Cisco Unity license files.
  • If Unity Connection is installed on a different server from which Cisco Unity was installed, you must have the Cisco Unity license files reissued with the MAC address of the new server.
  • If Unity Connection is installed on a virtual machine, you must have the Cisco Unity license files reissued with the license MAC of the virtual machine.

As shown in Table 42-2 , Cisco Unity licenses that enable any of the following features will be used for the corresponding Unity Connection features when migrating from Cisco Unity.

 

Table 42-2 Corresponding Licensed Features for Migrations from Cisco Unity

Cisco Unity Licensed Feature
Corresponding Unity Connection Licensed Feature

Subscribers

Users

Voice messaging ports

Voice messaging ports

Cisco Unity failover

Unity Connection cluster

For instructions on migrating from Cisco Unity 4.x or later to Cisco Unity Connection, see the “Migrating from Cisco Unity 4.x or Later to Unity Connection 8.x Using a FLash Cutover” chapter of the Reconfiguration and Upgrade Guide for Cisco Unity Connection Release 8.x , at http://www.cisco.com/c/en/us/td/docs/voice_ip_comm/connection/8x/upgrade/guide/8xcucrugx/8xcucrug022.html .

License Violations

When a Unity Connection feature stops working, when Unity Connection Administration displays an alert concerning a license violation, or when Unity Connection stops functioning every 24 hours, one possible cause is a license violation. For information on troubleshooting license violations, see the “Troubleshooting Licensing in Unity Connection 8.x” chapter of the Troubleshooting Guide for Cisco Unity Connection Release 8.x at http://www.cisco.com/c/en/us/td/docs/voice_ip_comm/connection/8x/troubleshooting/guide/8xcuctsgx/8xcuctsg070.html .

Obtaining and Installing a License File

License files, which enable the features purchased by the customer, are required for configuring a new Unity Connection system and for adding or changing licensed features. You obtain the license files by completing registration information on Cisco.com.


NoteWhen a Unity Connection cluster (high availability) is configured, two licenses are required. The license that has the MAC address or license MAC of the publisher server must be installed on the publisher server. The license that has the MAC address or license MAC of the subscriber server must be installed on the subscriber server. When a Unity Connection cluster (high availability) is configured, two licenses are required. The license that has the MAC address or license MAC of the publisher server must be installed on the publisher server. The license that has the MAC address or license MAC of the subscriber server must be installed on the subscriber server.


Shortly after registration, Cisco emails the license files. The email from Cisco contains instructions on how to save and store the files.

The following information is required during registration:

  • The MAC address (physical address) for the network interface card (NIC) in the Unity Connection physical server or the license MAC value calculated for a Unity Connection virtual machine.
  • The product authorization key (PAK), which appears on the sticker located on the back of the Unity Connection Application Software Media kit.

This section contains four procedures. Do one of the following two procedures:

Then do the remaining two procedures in the order listed. For a Unity Connection cluster, you must do the procedures on each Unity Connection server in the cluster.

Obtaining the MAC Address of a Unity Connection Physical Server


Step 1 Sign in to Cisco Unified Communications Operating System Administration.

Step 2 On the Show menu, select Network .

Step 3 Write down the value for the MAC Address, excluding the hyphens (for example, if the physical address is 00-a1-b2-c3-d4-e5, record 00a1b2c3d4e5), or save it to a file that you can access during online registration.


 

Obtaining the License MAC of a Unity Connection Virtual Machine


Step 1 On the Unity Connection virtual machine, run the CLI command show status .

The command will return a value like this:

License MAC : 78acc1573f20

Step 2 Write down the value for the license MAC, or save it to a file that you can access during online registration.


 

To Register and Obtain the License Files


Step 1 Go to the software registration site at http://www.cisco.com/go/license (URLs are case sensitive; you may be required to sign in).

Step 2 Enter the PAK and select Submit .

Step 3 Follow the on-screen prompts.

Step 4 You will receive an email with the Unity Connection license file.


 

To Install the License Files


Step 1 If Cisco Unity Connection is not configured for a cluster, in Cisco Unity Connection Administration, expand System Settings , then select Licenses .

If a Unity Connection cluster is configured, on the publisher server, in Cisco Unity Connection Administration, expand System Settings , then select Licenses .

Step 2 On the Search License page, select Add New .

Step 3 On the Add New License page, select Browse , and locate the new license file.

Step 4 If Unity Connection is not configured for a cluster, in the Choose File dialog box, double-click the name of the license file.

If a Unity Connection cluster is configured, in the Choose File dialog box, double-click the name of the license file that has the MAC address of the publisher server.


Caution If you rename the license file, the filename can contain alphanumeric characters, hyphens, and underscores, but must start with an alphabetic character. Otherwise, the license file cannot be installed.

Step 5 On the Add New License page, select Add .

Step 6 If you have more than one new license file, repeat Step 2 through Step 5 until you have added all of the new license files.

Step 7 On the Licenses page, check the check boxes for the license files that you added in Step 2 through Step 5.

Step 8 Select Install Selected .

Step 9 If Unity Connection is not configured for a cluster, skip the remaining steps.

If you are adding licensed features to a Unity Connection cluster that is already installed and in use, skip the remaining steps.

If you are installing a new Unity Connection cluster, on the subscriber server, in Cisco Unity Connection Administration, expand System Settings , then select Licenses .

Step 10 On the Search License page, select Add New .

Step 11 On the Add New License page, select Browse , and locate the new license file.

Step 12 In the Choose File dialog box, double-click the name of the license file that has the MAC address of the subscriber server.


Caution If you rename the license file, the filename can contain alphanumeric characters, hyphens, and underscores, but must start with an alphabetic character. Otherwise, the license file cannot be installed.

Step 13 On the Add New License page, select Add .

Step 14 If you have more than one new license file, repeat Step 10 through Step 13 until you have added all of the new license files.

Step 15 On the Licenses page, check the check boxes for the license files that you added in Step 10 through Step 13.

Step 16 Select Install Selected .


NoteBeginning with Unity Connection 8.6(2) and later releases, license filenames will be case insensitive and will be saved only in lower case letters. Beginning with Unity Connection 8.6(2) and later releases, license filenames will be case insensitive and will be saved only in lower case letters.



 

Viewing Reports for Licenses

Unity Connection can display the following information about Unity Connection licenses:

  • License Usage —Shows the status of licensed features for the Unity Connection server. For features that are licensed for a number of seats, the report displays the number of used and unused seats. See the “Viewing the License Usage” section.
  • License Expirations —Shows the expiration dates, if any, for licensed features for the Unity Connection server. A list of installed and uninstalled license files also appears on the report. See the “Viewing the License Expirations” section.

Viewing the License Usage

Do the following procedure to view the license usage for the Cisco Unity Connection server.

To View the License Usage for Cisco Unity Connection


Step 1 In Cisco Unity Connection Administration, expand System Settings , then select Licenses .

Step 2 On the Licenses page, under License Count, the license usage for the Unity Connection server appears.


 

Viewing the License Expirations

Do the following procedure to view the license expirations for the Cisco Unity Connection server.

To View the License Expirations for Cisco Unity Connection


Step 1 In Cisco Unity Connection Administration, expand System Settings , then select Licenses .

Step 2 On the Licenses page, in the Status area, license expirations for the Unity Connection server appear.


 

License Parameters for Unity Connection Features

Table 42-3 lists the license parameters that are used by license files and the Unity Connection features that the license parameters enable.

 

Table 42-3 License Parameters for Unity Connection Features

License Parameter
Feature
Description

LicAdvancedUserMax

TTS and ASR (advanced) users

Sets the maximum number of users who can use voice recognition.

LicIMAPSubscribersMax

Users with IMAP access to voice messages or with single inbox (single inbox available in Unity Connection 8.5 and later only)

Sets the maximum number of users who can use:

  • A third-party IMAP client to access voice messages.
  • The unified messaging feature “Synchronize Unity Connection and Exchange Mailboxes (Single Inbox)” on the Unified Messaging > Unified Messaging Services page and on the Users > Users > Unified Messaging Accounts page.

For single inbox, the total number of users in classes of service for which single inbox is enabled must not exceed the licensed maximum. This applies regardless of the number of users in those classes of service who are configured to use single inbox. In addition, all users who are configured for single inbox must be in a class of service for which single inbox is enabled.

LicMaxMsgRecLenIsLicensed

Voice message recordings longer than 30 seconds allowed

Depending on whether the parameter is present in any of the installed license files, determines the maximum length of recorded messages:

  • If the parameter is not present in any of the installed license files (the License Usage report shows a value of “No”), the maximum message length is 30 seconds regardless of the settings in Cisco Unity Connection Administration.
  • If the parameter is present in any of the installed license files (the License Usage report shows a value of “Yes”), the maximum length for all messages is restricted by the Maximum Recording Time in Milliseconds field on the System Settings > Advanced > Telephony > Telephony Configuration page.

The following settings further restrict the maximum length depending on the origin of the call:

Message length from other users is restricted by the Message Length—Maximum Length field on the Class of Service > Class of Service > Edit Class of Service page.

Message length from unidentified callers is restricted by the Maximum Message Length field on the Users > Users > Edit Message Settings page.

LicRealspeakSessionsMax

Text to Speech sessions

Sets the maximum number of simultaneous Text to Speech (TTS) sessions allowed on the Unity Connection server.

LicServerBackend

(not used)

This parameter may be present in a license file but does not affect the Unity Connection server.

LicServerVoiceRec

(not used)

This parameter may be present in a license file but does not affect the Unity Connection server.

LicSubscribersMax

Users with voice mailboxes

Sets the maximum number of voice messaging users allowed in Unity Connection.

LicUCxnUpgrades

License files from previous releases allowed

Depending on whether the parameter is present in any of the installed license files, determines whether Unity Connection will use license files from an earlier version of Unity Connection:

  • If the parameter is not present in any of the installed license files (the License Usage report shows a value of “No”), license files from an earlier version of Unity Connection cannot be used.
  • If the parameter is present in any of the installed license files (the License Usage report shows a value of “Yes”), license files from an earlier version of Unity Connection can be used.

LicUnityVoiceRecSessionsMax

Voice recognition sessions

Sets the maximum number of simultaneous voice recognition sessions (or ports) allowed on the Unity Connection server.

LicVMISubscribersMax

Unity Connection Web Inbox (Unity Connection 8.5 and later) or Messaging Inbox (Unity Connection 8.0) users

Sets the maximum number of users who can be enabled to access the Web Inbox (Unity Connection 8.5 and later) or Messaging Inbox (Unity Connection 8.0). There is no restriction on the number of users who can access the Web Inbox or Messaging Inbox at one time.

LicVoicePortsMax

Voice ports

Sets the maximum number of Unity Connection voice messaging ports that can be installed on the Unity Connection server.

LicVPIMIsLicensed

VPIM Networking delivery locations allowed

Depending on whether the parameter is present in any of the installed license files, determines whether VPIM Networking is allowed:

  • If the parameter is not present in any of the installed license files (the License Usage report shows a value of “No”), VPIM Networking is not allowed.
  • If the parameter is present in any of the installed license files (the License Usage report shows a value of “Yes”), VPIM Networking is allowed.