Patch Update to Latest Release

From Version 2.3.0 of the License Audit tool, a single patch is available to install all the latest changes to any releases from CUCDM 11.5.1 SU1 / VOSS-4-UC 17.4 onwards.

Important

  • All changes in version 3.0.2 of the License Super Patch are automatically included in release 19.3.3. Therefore, the License Super Patch is not required for platforms on release 19.3.3.

  • For all releases before the 19.x series, there is a known, pre-existing issue where License audit files are not generated when a scheduled License audit overlaps with a scheduled subscriber data extract (SDE).

    To avoid this issue in this release, ensure that you have non-overlapping license audit and SDE schedules. You can modify the schedule of your SDE (see: Scheduling), but if you wish to modify the License audit default schedule from 3AM UTC, please contact VOSS support.

The Patch and the MOP are available here:

  • Server Name: https://voss.portalshape.com

  • Path: Downloads > VOSS-4-UC > License Audit Script > License-Super-Patch-4.0.1

  • Patch Directory: License-Super-Patch-4.0.1_patch

  • Patch File: License-Super-Patch-4.0.1_patch.script

  • MOP File: MOP-License-Super-Patch-4.0.1_patch.pdf

It is not required to install the License-Super-Patch-4.0.1 on release 19.3.4 PB5 in order to enable the VOSS Cloud License Service integration.

An accompanying file, EKB-10875_PB5_sysadmin_cloud_license.template is available to expose the VOSS Cloud License Service in the sysadmin user menu.

Supported Releases and Dependency Requirements

The super patch is compatible with CUCDM 11.5.1 SU1 / VOSS-4-UC 17.4 platform versions and later. For each release version, there may be a dependency on or more additional patches. Where possible, the super patch automatically installs missing dependencies. Otherwise, the installation fails with an error message instructing the platform administrator to install the missing dependencies. The table below provides dependency details for various release versions.

Release

Patch Dependencies

Action on Missing Dependencies

VOSS-4-UC 19.3.4 FCS, PB1 - PB5

No Dependencies

Cloud License template file for PB5

VOSS-4-UC 19.1.1 and later

No Dependencies

Not Applicable

VOSS-4-UC 18.1

  • VOSS-4-UC 18.1 Bundle 03 or later

    18.1-V4UC-Patch-Bundle-03/b

or

  • Licensing Version 2 (Provider)

    VOSSUC-225_PROVIDER_18.1_bundled

or

  • Licensing Version 2 (Enterprise)

    VOSSUC-225_ENTERPRISE_18.1_bundled

Install VOSS-4-UC 18.1 Bundle 3b or later first

CUCDM 11.5.3

  • Licensing Version 2

    VOSSUC-225_CUCDM_11.5.3_bundled

Install CUCDM 11.5.3 Patch Bundle 1 or later first

CUCDM 11.5.2

VOSS-4-UC 17.6

  • Licensing Version 1

    VOSSUC15663-11.5.2

    VOSS-46-11.5.2

    VOSSUC-20323_11.5.2

Dependencies automatically installed

CUCDM 11.5.1 SU1

VOSS-4-UC 17.4

  • Licensing Version 1

    VOSSUC15663-11.5.1SU1

    VOSS46-11.5.1SU1

    VOSSUC-20323_11.5.1su1

Dependencies automatically installed

Caveats

  1. For CUCDM 11.5.1 SU1, CUCDM 11.5.2, VOSS-4-UC 17.4, and VOSS-4-UC 17.6, the patch does not support the internal platform schedule that automatically executes the license audit at the start of every month.

    Workaround: A standard platform CLI schedule must be used.

  2. The inclusion of Subscriber Data Extracts is a side effect of the underlying implementation dependencies.

    The version number specified in the patch relates to the version number of the license audit reports and is not influenced by changes in Subscriber Data Extracts capabilities.

Change Log

For the current release, refer to the What’s New section for details on these features.

Version

Release(s)

Content

3.0.1

19.3.2

  • No changes were made to the licensing code itself, but the CLI output of the license super patch was made more descriptive

3.0.0

19.3.1

  • The VOSS license audit logic now considers a phone assigned to a user if that device has been setup as an associatedDevice on the user OR phone ownerID

  • Alternate ways were added to automate the collection of the VOSS license files:

    • SFTP: Send the file to a remote SFTP server

    • Email: Email the file to an email destination (requires SMTP server access)

    • HTTP: Send the license file(s) to an HTTP server

    • File Download via the Portal: Local download via the VOSS-4-UC GUI

  • In the event that the file is not sent for any reason (incorrect configuration, permissions issue, etc…), an alert is created in the Admin GUI which in turn results in an SNMP trap being created

  • The license output filename format changed to include provider and hostname - this adds support for a single partner/customer that may have multiple platforms

  • The new filename format:

    • “vlf_<provider_name>_<host_name>_license_<YYYY-MM-DD_HHMM>.zip” (containing anonymous data)

    • “vlf_<provider_name>_<host_name>_detailed_<YYYY-MM-DD_HHMM>.csv” (containing detailed information)

  • Additional headers were added to the output files for platform identification and version:

    • Platform ID (generated by the system and is unique)

    • Hostname of the system

    • Provider on the system

    • Software Version

    • Deployment Mode

Version

Release(s)

Content

2.3.0

19.1.2

  • First version to be delivered via a super patch that is compatible with CUCDM 11.5.1 SU1 / VOSS-4-UC 17.4 and later

  • Alignment with CUCM licensing rules, including:

    • Exclusion of CTI Ports from license counts

    • Spark Remote Device type only consuming a license when it is a subscriber’s only device

  • Addition of a Site Count column to report the number of sites per customer

2.0.0

11.5.3 18.1

  • The expanded ability to audit in terms of VOSS-4-UC added capabilities, such as Webex Teams (aka Spark) and Contact Center

  • Built in schedule to execute at the end of the month automatically.

    Schedule cannot be edited by customer to avoid conflict. This

    replaces any schedule that would have been setup under v1 and that schedule should be removed to avoid duplication, etc.

  • Public sector setting on customer

  • Notifications when the scheduled run of the audit fails for some reason - CLI, email, SNMP.

1.0.0

11.5.3

18.1

  • The ability to audit the existing deployment in terms of CUCDM functionality and licenses.

  • A schedule can be created to execute it on a monthly basis (similar to the Subscriber Data Extract in general). This is a visible and customer configurable schedule.