Citrix Licensing CEIP data elements

Metadata fields

Field Description Example
ClientTool This field isn’t in use. Not applicable
UploadUser This field isn’t in use. Not applicable
UTCDate Report generation time in UTC format. 2022-10-10T06:11:14Z
Date Report generation time in local time format. 10/10/2022 02:11:14
Product Name of the upload. LicenseServerAnonymous
ProductVersion The version of the upload. 2.0
ProductUTCDeployDate Denotes the time when the License Server is installed. 2022-08-16T00:00:00Z
SiteID This field isn’t in use. Not applicable
SiteName This field isn’t in use. Not applicable
Component This field isn’t in use. Not applicable

License Server feature usage data

Field Description Example
prod Product reporting V6.Licensing
DateSampleStartUTC Start time of the sample being collected. 1970-01-01T00:00:00Z
DateSampleStopUTC Latest sample time of license usage which ideally is the same as when the report was generated. The sample start isn’t specified because that varies between license types and therefore isn’t a global property. 1970-01-01T00:00:00Z
CLM-WSLUsage Count for individual API calls within Citrix Licensing Manager interface for Citrix Web Services for Licensing service. 10
POSH-WSLUsage Count for individual API calls within PowerShell interface for Citrix Web Services for Licensing service. 2
type Type of data. V6.WSLUsage
ver Version of the data. 1.0
LSVersion The version of the License Server. 11.17.2.0 build 40000

License Server and License Usage information

Field Description Example
License Server Information    
Feature    
GUID An anonymous identifier created during install and preserved during upgrades. This field is used to identify which uploads are from the same server. a5ae17c9-8a4a-4318-938f-a8c6da2aa2ef
DateSampleStopUTC This field is the latest sample time of license usage which ideally is the same as when the report was generated. The sample start is not specified because that varies between license types and therefore isn’t a global property. 2019-11-09T00:57:14Z
DateSampleStop The latest sample time of license usage which ideally is the same as when the report was generated. License Server local time. 11/8/2019 19:57
PortLACHTTP HTTP port that the License Administration Console is configured for. 0
PortLACHTTPS HTTPS port that the License Administration Console is configured for (0 for builds with Citrix Licensing Manager only). 8082
PortLACRedirect Redirect License Administration Console HTTP to HTTPS port. The value can be either true or false. You can set the value to false only for builds with the Citrix Licensing Manager.  
PortLS Citrix Licensing Service (lmgrd.exe) port configuration. 27000
PortVD CITRIX vendor daemon (CITRIX.exe) port configuration. 7279
PortWSL Citrix Web Services for Licensing port configuration. 8083
UDUseDomain If the value is 1, don’t strip the domain from the users name. (user@domain.com). If the value is 0, strip the domain from the users name. 1
OptFileNoLogStatus If the value is 0, log both checkins and checkouts. If the value is 0x1 bit set, checkins are not logged (no log in). If the value is 0x2 bit set, checkouts aren’t logged (no log out). 3
OptFileComplianceConfig This value can be “enabled” or “disabled”. enabled
UDUserNameCase The License Server configuration that denotes how the UserID case-folding is set for User/Device licensing. The values are: 0=nochange; 1=tolower; 2=toupper. 1
UDDeviceNameCase The License Server configuration that denotes how the DeviceID case-folding is set for User/Device licensing. The values are: 0=nochange; 1=tolower; 2=toupper 1
SARenewalCheckOption The values can be “Install”, “Notify”, or “Manual”. Notify
EncoreSamplingPeriod License usage sampling period in minutes. 15
EncoreRetentionTime Historical use data retention in days. 180
EncoreEnabled The option is either true or false. TRUE
SLSProxy The proxy chosen from various sources in order of priority. (1) WinAutoURL using “citrix.com”. (2) WinIE = Internet Explorer settings which require the licensing service to run under a user account rather than local service. (3) WinDefault = The old method that relies on a setting in the windows registry. (4) SimpleLicenseServiceConfig.xml. If the upload is anonymous, this value is either “1” or “0”. If diagnostic (not anonymous), this value is the proxy server string and port, or empty. 0
SLSProxyWinAutoURL If the upload is anonymous, this value is either “1” or “0”. If diagnostic (not anonymous), this value is the proxy server string and port, or empty. 0
SLSProxyWinIE If the upload is anonymous, this value is either “1” or “0”. If diagnostic (not anonymous), this value is the proxy server string and port, or empty. 0
SLSProxyWinDefault If the upload is anonymous, this value is either “1” or “0”. If diagnostic (not anonymous), this value is the proxy server string and port, or empty. 0
SLSProxySlsConfig If the upload is anonymous, this value is either “1” or “0”. If diagnostic (not anonymous), this value is the proxy server string and port, or empty. 0
OS Information about the server machine and operating system that the License Server is installed on. 6.3.9600.17031
WindowsBuildLabEx Information about the server machine and operating system that the License Server is installed on. 9600.17041.x86fre.winblue_gdr.140305-1710
WindowsEditionID Information about the server machine and operating system that the License Server is installed on. Enterprise
WindowsInstallationType Information about the server machine and operating system that the License Server is installed on. Client
WindowsProductName Information about the server machine and operating system that the License Server is installed on. Windows 8.1 Enterprise
WindowsDomainMember Information about the server machine and operating system that the License Server is installed on. N
OSBits Information about the server machine and operating system that the License Server is installed on. 32
OSLocale Information about the server machine and operating system that the License Server is installed on. en-US
VM Information about the server machine and operating system that the License Server is installed on. Y
VMIDString Information about the server machine and operating system that the License Server is installed on. Microsoft Hv
VMHVIDString Information about the server machine and operating system that the License Server is installed on. Hv#1
InstallUTC This value denotes the time when the License Server is installed. 2016-10-12T00:00:00Z
ProductVersion This value is the current version of the License Server. 11.14.0.1 build 18000
UpgradeFrom The previous version of the License Server if the current install was an upgrade.  
SetupCluster Indicates whether a License Server cluster is set up or not. 0
SGPClockErrorCode Error code indicating why the License Server entered the supplemental grace period. 0
SGPMaxDays Maximum days remaining in the Supplemental Grace Period. 15
SupplementalGracePeriod Grace Periods that Citrix provides when you run out of licenses or the product is unable to contact the License Server. This grace period helps the product continues to operate.  
Feature    
FeatureID The tag of the feature.  
UDBinFileCreatedUTC User/Device Only – not applicable for Concurrent usage 2016-11-09T00:55:56Z
UDReportGenerationUTC User/Device Only – not applicable for Concurrent usage 2016-11-09T00:55:56Z
EventLog User/Device Only – not applicable for Concurrent usage <FirstCreation t=”timestamp”/>
UDAdminUsersReleased Count of users released by udadmin. 3
UDAdminDevicesReleased Count of devices released by udadmin. 3
SADate    
DateSampleStartUTC Start time of the sample being collected. 2016-11-08T01:08:13Z
DateSampleStopUTC End time of the sample being collected. 2016-11-09T00:55:56Z
CountUsedMax The maximum number of licenses used. 3
Active If the value is ‘1’, it’s in the current inventory. If the value is ‘0’, it appears only in historical records and is no longer part of the current inventory either because it is removed or expired. 1
UsageSamples   For examples, see Sample in the following section.
DateExpiration Most recent expiration date that impacts the license count in the pool. 1-Dec-20
DateIssued The date that the license file was issued. The date issued of the license file that expires first. 1-Dec-03
VendorStr Representation of licensing information that informs products of what edition and mode that they must operate in. <![CDATA[;LT=Retail;GP=2;PSL=10;CL=ENT,ADV,STD,AST;SA=1;ODP=0]]>
CountInstalled Number of licenses installed among the pools for a given feature. 100
CountOverdraft Number of licenses used above the installed quantity. 0
Sample    
Timestamp Timestamp of the sample collection. 2016-11-09T00:55:56Z
CountInUse Number of licenses in use at this specific time stamp. 3
OverDraft Number of licenses used above the installed quantity. 0
Installed Number of licenses installed at this specific time stamp. 100
Users Specific users where a user license is assigned, contributing to the total count. Scrambled: 1EC4ED037766AA18, Unscrambled: user@domain.com or user
StartupCounts    
LPE ID Information provided to the License Policy Engine - Interface to the License Server. <ID><![CDATA[XDT_PLT_2020.1201]]></ID>
SerialNumbers    
Serial The unique identifier in Citrix back office and license files for a given license allocation and files downloaded for that allocation.  
ID The feature code ID that represents a specific product entitlements (edition and license mode). Such as, Citrix Virtual Apps – Premium – User Device XDT_PLT_UD
SADate Subscription Advantage Date. This date represents the termination date of the CSS entitlement. 2020.1201
SN Serial number for the license entitlements in the pool. OR10:13

Citrix License Server Event data elements

Field Description Example
Header    
tenant_id The Customer ID received during the registration. citrix780933
dvc (unique GUID generated by LS) A unique identifier created during install and preserved during upgrades. This field is used to identify which uploads are from the same server. a5ae17c9-8a4a-4318-938f-a8c6da2aa2ef
type Type of event. LicenseServer.Inventory
prod Type of product. License Server
id Information about the server machine and operating system that the License Server is installed on. E824249098A96BF0
st Timestamp of the event. 2021-08-27T04:22:56.745631Z
ver Version of the payload. 1
prodVer Version of the License Server. 11.16.6.0 build 35000
$schema Schema for the event Header. https://cas.citrix.com/schemas/event.json
     
Payload    
FQDN License Server machine and domain name. This value is sent to help identify License Servers in the reporting experience. Used to pair a License Server calling home to a license allocation record in the back office. CITRIX-12T5MRV4
DateSampleStartUTC Start time of the sample being collected. 2016-11-08T01:08:13Z
DateSampleStopUTC End time of the sample being collected. 2016-11-09T00:55:56Z
     
Feature    
SADate This field represents the CSS date for which the supplemental grace period was triggered. 2019.1201
PEM The tag of the feature. CEHV_ENT_CCS
Notice NOTICE field from the license file. This is populated with Company Name. Citrix Systems Inc
FriendlyName Friendly name of license XenDesktop Enterprise User/Device
CountInstalled The number of licenses installed. 1203
CountOverdraft Number of licenses used above the installed quantity. 0
CountUsedMax The maximum number of licenses used. 3
DateExpiration Most recent expiration date that impacts the license count in the pool. 12/1/2020.
DateIssued The date that the license file was issued. The date issued of the license file that expires first. 1-Dec-03
DateStart Date from which licenses are valid on. 31-Dec-2014
Serial This information allows Citrix to identify who the product is entitled to. OR10:13
VendorStr Representation of licensing information that informs products of what edition and mode that they must operate in. <![CDATA[;LT=Retail;GP=2;PSL=10;CL=ENT,ADV,STD,AST;SA=1;ODP=0]]>
Citrix Licensing CEIP data elements