License Audit Report File Details#

The License Audit Report process will generate the following ZIP file types as output:

  • license_detailed

    Specifically contains:

    • detailed - CSV file - anonymous version of the license audit report file - details below

  • license

    Specifically contains:

    • anonymous - CSV file - anonymous version of the license audit report file - details below

Both ZIP files contain:

  • anonymous _breakdown - csv file - anonymous file containing a few key statistics from the platform - used for support purposes

  • patch - JSON file - list of patches applied to the system as shown About > Extended Version - used for support purposes

  • adaptation_log - JSON file - list of adaptations applied on the system as shown in About > Adaptation Status - used for support purposes.

  • .hash for each included file - to validate the file

All filenames are of the format:

vlf_<provider_name>_<host_name>_<file_type>_<YYYY-MM-DD_HHMM>

E.g.  vlf_CS-P_VOSS_detailed_2024-03-05_1958

See also: Distributing Licensing Reports.

Detailed and Anonymous License Audit Report file format#

Detailed#

The detailed version is a CSV file containing the hierarchy names for ease of understanding the data.

The header of the file contains metadata about the platform the file was generated on such as platform IDs, licensing info, version, and other similar data.

The main content of the file is an export of the Overall License count data as available via the admin portal. For details of the counting for each column, see License Counting Logic.

An example of the file:

#OrgID=
#Platform ID=67d0bba368c7ef880c8571d1
#hostname=python
#Provider Name=CS-P
#Software Version=pre-release.25.1.build-198
#Platform Version=25.1.0-1741721622
#Deployment Mode=Provider
#License Token=<license-token-not-found>
#License Expiry=<license-expiry-not-found>
#Date Time=2025-03-18 13:08
#Audit Version=5.2.0
Provider,Reseller,Customer,Provider PKID,Customer PKID,User Licenses,Contact Center Express,Cisco and MS Integrated Services,Contact Center User Webex,Standalone Devices,Meeting Rooms,Voss Phone Servers,Sites
CS-P,,,67d0d83e39e7e759c8a78048,,0,0,0,0,0,0,0,0
CS-P,CS-NB,AAAGlobal,67d0d83e39e7e759c8a78048,67d0d8c739e7e759c8a78b32,144,0,0,0,103,0,0,11
CS-P,CS-NB,NBIcorp,67d0d83e39e7e759c8a78048,67d0e20a39e7e759c8a8b337,0,0,0,0,0,0,0,4
CS-P,CS-NB,Overton,67d0d83e39e7e759c8a78048,67d11bc239e7e759c8ae8f2a,13,0,0,0,13,0,0,6
CS-P,,GeoLogic,67d0d83e39e7e759c8a78048,67d0d91d39e7e759c8a78d66,0,0,0,0,0,0,0,5

Note

For licensing:

  • OrgID is the account id from the Customer Portal: Company Information.

Anonymous#

Filename format:

vlf_<provider_name>_<host_name>_anonymous_<YYYY-MM-DD_HHMM>.csv

The anonymous version of the file contains a slightly modified version of the detailed file removing the hierarchy names and replacing it with a customer pkid. The rest of the file content is the same as the detailed version outlined above. For more details on the hierarchy differences - see License Counting Logic. Here is an example of the anonymous file:

#OrgID=
#Platform ID=67d0bba368c7ef880c8571d1
#hostname=python
#Provider Name=CS-P
#Software Version=pre-release.25.1.build-198
#Platform Version=25.1.0-1741721622
#Deployment Mode=Provider
#License Token=<license-token-not-found>
#License Expiry=<license-expiry-not-found>
#Date Time=2025-03-18 13:08
#Audit Version=5.2.0
Provider PKID,Customer PKID,User Licenses,Contact Center Express,Cisco and MS Integrated Services,Contact Center User Webex,Standalone Devices,Meeting Rooms,Voss Phone Servers,Sites
67d0d83e39e7e759c8a78048,,0,0,0,0,0,0,0,0
67d0d83e39e7e759c8a78048,67d0d8c739e7e759c8a78b32,144,0,0,0,103,0,0,11
67d0d83e39e7e759c8a78048,67d0e20a39e7e759c8a8b337,0,0,0,0,0,0,0,4
67d0d83e39e7e759c8a78048,67d11bc239e7e759c8ae8f2a,13,0,0,0,13,0,0,6
67d0d83e39e7e759c8a78048,67d0d91d39e7e759c8a78d66,0,0,0,0,0,0,0,5

Note

Refer to the detailed notes following the table below for additional information.

Audit Details Table#

Download licensing-audit-details-sheet.csv

Licensing Audit Details Sheet#

Column

Description

Definition

Customer PKID

Customer hierarchy pkid on the system

PKID of the data/HierarchyNode for the Customer in the system

User Licenses

The user license count for this hierarchy.

Users are defined as present in data/User below sys and hcs hierarchy level. User properties generating a license:

  • Cisco Contact Center Express (device/uccx/Agent)

  • skip if no uccx_username

  • userID matches in data/User: at least one of username_uccx or username

  • Cisco UCM (device/cucm/User)

  • userid matches in data/User: at least one of username_cucm or username

  • mailid matches in data/User: email

  • associatedDevices excluding CTI

  • device.cucm.Phone where ownerusername = cucm_username

  • device.cucm.User.phoneProfiles is not empty

  • device.cucm.User.associatedRemoteDestinationProfiles is not empty

  • Cisco CUC (device/cuc/User)

Alias matches in data/User: at least one of username_cuc or username

  • Cisco Webex (device/Spark/User)

  • email matches in data/User: at least one of: username_webex_teams or email

  • device/Spark/User has calling_pro enabled

  • MS Exchange (device/msexchangeonline/UserMailbox)

UserPrincipalName matches in data/User: at least one of username_ms_365 or email

  • PexIP (device/pexip/conference)

primary_owner_email_address matches in data/User: email

MS Online Users

The MS Online user count for this hierarchy

These are all instances of device/msgraph/MsolUser models for that customer. UserPrincipalName matches in data/User: at least one of username_ms_365 or email

MS Teams Voice Users

The MS Teams voice user count for this hierarchy

UserPrincipalName matches in data/User: at least one of username_ms_teams or email AccountEnabled is True EnterpriseVoiceEnabled is True FeatureTypes contain the string PhoneSystem but does not contain any strings that start with TeamsRoom

MS Exchange Users

The MS Exchange user count for this hierarchy

All instances of the device/msexchangeonline/UserMailbox model for that customer where the users are not MS Teams Voice Users - where the UserPrincipalName was not already counted as part of the MS Teams Voice User count. UserPrincipalName matches in data/User: at least one of username_ms_365 or email

Cisco and MS Integrated Services

Cisco and Microsoft Integrated Service license count for this hierarchy.

data/User has mvs_hybrid_status enabled

Contact Center User Webex

The Contact Center User Webex license count for this hierarchy.

Counted if the device/spark/CXUser has the active flag is True. This count is not included in the User Licenses column count.

Standalone Devices

Standalone Device license count for this hierarchy.

Cisco UCM Standalone phones: where ownerUserName in device/cucm/Phone is blank Cisco Webex: device/spark/Place (Cisco Webex Common area) is in the relevant hierarchy and calling.type is not none

Meeting Rooms

Meeting Room license count for this hierarchy.

MS Teams Meeting Rooms: device/msteamsonline/CsOnlineUser is in the hierarchy. AccountEnabled and EnterpriseVoiceEnabled are both True and FeatureTypes starts with TeamsRoom. Note: Cisco Webex Meeting Room (Workspace) is counted under Standalone Devices.

Voss Phone Servers

Voss Phone Server license count for this hierarchy.

Number of phones stored in VOSS Phone Server data.

Sites

The site count for this hierarchy.

The number of sites under the customer.

Acronyms#

  • UCM: Unified Communications Manager

  • UCCX: Unified Contact Center Express

  • UCCE: Unified Contact Center Enterprise

  • EM: Extension Mobility profile

  • VM: Voicemail

  • SNR: Single Number Reach

  • Public Sector: boolean flag on Customer to indicate public sector customer. Can be set with an API call or on the GUI Customer form.

  • MS O365: Microsoft Office 365

  • MS Teams: Microsoft Teams