License Audit Report File Details#

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

detailed - csv file - license audit report file.
license - Zip File - which contains the following file types:
- anonymous - csv file - anonymous version of the license audit report file
- 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 file to validate the file

All filenames are of the format:

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

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

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=0010O00001kPTUpQAO
#Platform ID=5e54067d116fa10046313224
#hostname=VOSS-UN-1
#Provider Name=CS-P
#Software Version=21.4
#Platform Version=21.4.0-1630252949
#Deployment Mode=Provider
#Date Time=2022-11-19 13:11
#License Token=[Token or <license-token-not-found>]
#License Expiry=[Date-time or <license-expiry-not-found>]
#Audit Version=4.1.5
Provider,Reseller,Customer,Customer PKID,One Phone & Spark (No VM & No WebEx), \
One Phone (No VM & No WebEx & No Spark),One Phone & VM (No WebEx), \
One Phone & WebEx,Multiple Phones,Users With More Than 10 Phones, \
UCM User (No Phone & No EM & No VM & No WebEx & No SNR & No Spark), \
SNR (No Phone & No EM & No VM & No WebEx & No Spark), \
VM (No Phone & No EM & No WebEx),WebEx (No Phone & No EM), \
Spark (No Phone & No EM & No SNR & No VM & No WebEx), \
EM & Spark (No Phone & No VM & No WebEx), \
EM (No Phone & No SNR & No VM & No WebEx & No Spark), \
EM & SNR (No Phone & No VM & No WebEx & No Spark), \
EM & VM (No Phone & No WebEx),EM & WebEx (No Phone), \
Standalone Phones (No UCM User),Standalone WebEx (No UCM User), \
Standalone Voicemail (No UCM User),Contact Center Enterprise, \
Contact Center Express,Standalone Spark (No UCM User),Public Sector, \
Inactive Billing,Standalone Analog Ports (No UCM User), \
Standard Users with Spark,MS Teams (No Voice),MS Teams & Voice, \
MS Teams & Voice & Exchange,MS O365 User (no Teams), \
Cisco and MS Integrated Service,Multi-vendor Users,PexIP only, \
Phone Server Phones,Site Count
Provider_01,Reseller_01,Customer_01,6197a2522f7ab2c5dbb8f2aa,3,6,2,6,13,3,6,4,4,2,5,3,4,6,7,6,5,2,3,2,2,12,Y,Y,4,0,0,0,0,0,0,0,0,0,2
Provider_01,Reseller_01,Customer_02,6197a2572f7ab2c5dbb8f2fc,0,4,6,7,0,0,0,0,0,1,4,1,1,2,1,3,2,1,1,1,1,8,Y,N,2,0,0,0,0,0,0,0,0,0,1

Note

For licensing:

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

Anonymous#

Filename format:

vlf_<provider_name>_<host_name>_anonymous_legacy_<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=0010O00001kPTUpQAO
#Platform ID=5e54067d116fa10046313224
#hostname=VOSS-UN-1
#Provider Name=CS-P
#Software Version=21.4
#Platform Version=21.4.0-1630252949
#Deployment Mode=Provider
#Date Time=2022-11-19 13:11
#License Token=[Token or <license-token-not-found>]
#License Expiry=[Date-time or <license-expiry-not-found>]
#Audit Version=4.1.5
Customer PKID,One Phone & Spark (No VM & No WebEx),One Phone (No VM & No WebEx & No Spark), \
One Phone & VM (No WebEx),One Phone & WebEx,Multiple Phones,Users With More Than 10 Phones, \
UCM User (No Phone & No EM & No VM & No WebEx & No SNR & No Spark), \
SNR (No Phone & No EM & No VM & No WebEx & No Spark),VM (No Phone & No EM & No WebEx), \
WebEx (No Phone & No EM),Spark (No Phone & No EM & No SNR & No VM & No WebEx), \
EM & Spark (No Phone & No VM & No WebEx),EM (No Phone & No SNR & No VM & No WebEx & No Spark), \
EM & SNR (No Phone & No VM & No WebEx & No Spark),EM & VM (No Phone & No WebEx), \
EM & WebEx (No Phone),Standalone Phones (No UCM User),Standalone WebEx (No UCM User), \
Standalone Voicemail (No UCM User),Contact Center Enterprise,Contact Center Express, \
Standalone Spark (No UCM User),Public Sector,Inactive Billing, \
Standalone Analog Ports (No UCM User),Standard Users with Spark,MS Teams (No Voice), \
MS Teams & Voice,MS Teams & Voice & Exchange,MS O365 User (no Teams), \
Cisco and MS Integrated Service,Multi-vendor Users,PexIP only,Phone Server Phones, \
Site Count
6197a2522f7ab2c5dbb8f2aa,3,6,2,6,13,3,6,4,4,2,5,3,4,6,7,6,5,2,3,2,2,12,Y,Y,4,0,0,0,0,0,0,0,0,0,2
6197a2572f7ab2c5dbb8f2fc,0,4,6,7,0,0,0,0,0,1,4,1,1,2,1,3,2,1,1,1,1,8,Y,N,2,0,0,0,0,0,0,0,0,0,1

Notes on Vendor Services#

Cisco
- Phones (basically anything that is a phone in UCM) - hardphones, soft clients, mobility clients, ATAs (analog), SCCP analog ports. Excludes other Analog gateway ports MGCP/H323 as these can’t be associated to a user
- CTI Port device types are not counted and are excluded from standalone counts and licensed users.
- A user’s associated devices as well as a phone’s ownerUserName are used to determine if a phone belongs to the user or is standalone
- EM Profile = (device/cucm/deviceprofile associated to the UCM user)
- VM (device/cuc/User)
- Webex (device/webex/User) - relates to Webex Meetings
- SNR (device/cucm/RemoteDestinationProfile)
- Spark - Webex Teams (device/spark/User)
- Contact Center - UCCX/UCCE
- In the case of these services, only instances at the Site level are counted.
Microsoft
- O365
- MS Teams
- Exchange
- Meeting Rooms
PexIP
- Conferencing
VOSS Phone Server

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/UserConfig 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. 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
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.

Notes on Audit Details Table#

Microsoft columns detailed notes:

Are only counted if the user only has Microsoft services. For instance: if the user has Cisco and Microsoft, then the user is included in the relevant Cisco column and excluded from the Microsoft count.

Phone detailed notes:

Phones (anything that is a phone in UCM) - hard phones, soft clients, mobility clients, ATAs (analog), and SCCP gateway ports
- CTI Ports are excluded from the counts (these do not consume a license)
- Spark Remote Device is excluded from the user count if they have more than one phone (i.e. Spark Remote Device is not their only phone).
A phone being associated with a user for the license count is driven by:
- Association to user driven by the Subscriber/UCM User setting for associated devices (aka controlled devices). This is how VOSS associates the device with the user in the system (e.g relation Subscriber, self-service, etc).
- ownerID on the Phone (in the event the association above is not set up). This is to cover cases when overbuild might have been used and association is not set up correctly per the above.
- If the phone does not fall into either of the above, then it is counted as a Standalone Phone.
Note

If the phone has an ownerID set but that UCM user is not in the VOSS system (i.e no device/cucm/User records for the user - e.g not synced in, etc) then the ownerID is ignored and it is counted as a standalone phone

Spark detailed notes:

UCM user at site that has a Spark user somewhere (including intermediate node beneath site) - then that will initiate the search for Spark and it will look up/down as needed and count as a premium user or other subscriber permutation. E.g. UCM User at site and Spark user at site = appropriate Subscriber column. UCM User at site, Spark user at Customer = appropriate Subscriber column Spark user without a UCM user at site level - then search initiated by Spark.
If the UCM user is at the same level or lower, then it will count as premium. If UCM user higher or non-existent, then counts as standalone Spark. E.g. Spark User at customer level, UCM user at customer level = Premium. Spark User at site, UCM user at customer = Standalone Spark.

Multi-vendor column notes:

Counted if the user has more than one of:
- device/cucm/User
- device/cuc/User
- device/cucm/Phone
- device/webex/User
- device/spark/User
- device/ccdm/Agent
- device/uccx/Agent
- device/msgraph/MsolUser
- device/msteamsonline/CsOnlineUser
- device/azureadonline/MsolUser
- device/pexip/Conference

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

License Audit Report File Details

On this page

License Audit Report File Details#

Detailed and Anonymous License Audit Report file format#

Detailed#

Anonymous#

Notes on Vendor Services#

Audit Details Table#

Notes on Audit Details Table#

Acronyms#