Citrix Licensing Telemetry data elements
This section includes telemetry data elements for the following products:
- Metadata elements
- License Server data elements
- Citrix Virtual Apps and Desktops data elements
- Citrix Secure Private Access data elements
- Citrix Provisioning data elements
- XenMobile Server data elements
- XenServer data elements
- Unicon data elements
- uberAgent
Note:
The Identifiers collected as part of telemetry data, such as user ID, device names, VDA identifier (items mentioned as scrambled), are securely scrambled at the source using one-way hashing algorithms. As a result, Citrix cannot access or read the original values.
The scrambling algorithm uses SHA256 to hash the original clear text data. Then the first half of 256-bit hashed output was converted to a base64 string.
Metadata elements
| 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-06-30T15:31:34Z |
| Date | Indicates the upload bundle creation date. | 06/30/2022 11:31:34 |
| Product | Identifies the upload bundle. | LicenseServer.OnPremUsage |
| ProductVersion | Indicates Manifest schema version. | 1.0 |
| ProductDeployUTCDate | Denotes the time when the License Server is installed. | 2022-03-21T00:00:00Z |
| GUID | A unique identifier created during install and preserved during upgrade. This field is used to identify which uploads are from the same server. | a5ae17c9-8a4a-4318-938f-a8c6da2aa2ef |
| UploadType | Indicates if the license upload is manual or automatic. | Auto |
| Ccid | Indicates the Citrix Cloud Customer ID; only available with the registered License Server. | xaxddaily1 |
| OrgID | Indicates the Org ID, the installed licenses are tied to; only available with the registered License Server. | 23456123 |
| TotalFiles | Indicates the total number of files in the upload bundle. | 6 |
| SerialNumbers → Serial → ID | Represents the product code associated with the installed license. | XDS_ADV_CCS |
| SerialNumbers → Serial → SADate | Represents the CSS date associated with the installed license. | 2023.1201 |
| SerialNumbers → Serial → SN | Identifies who is entitled to the product. | eval1 |
| File → Name | Name of the uploaded file. | ue_lt_1683864965.zip |
| File → UI | Hash to indicate the integrity of the file. | 4d14a58f98b1ae2e9d965b2980b67853cfcac7c76e655952bd056ad6dc7a80ae |
| File → EventStartTS | Indicates the bundle data start time. | 1697417241680 |
| File → EventEndTS | Indicates the bundle data end time. | 1697430741834 |
| File → OfferingType → Name | Indicates the product. | Broker |
| FilesUI | Hash to indicate integrity of the bundle. | 4d14a58f98b1ae2e9d965b2980b67853cfcac7c76e655952bd056ad6dc7a80ff |
| ManifestUI | Hash to indicate integrity of the manifest. | 4d14a58f98b1ae2e9d965b2980b67853cfcac7c76e655952bd056ad6dc7a8345 |
| LSVersion | Identifies the License Server version. | 11.17.2.0 build 48000 |
| DiskFreeMB | Identifies the free disk space in megabytes. | 357821 |
| DiskTotalMB | Identifies the total disk space in megabytes. | 383070 |
| UI | This field ensures the integrity of the uploaded file. | 8826d6ac8e1c8e68e471ae90c2bacbe1854f8281a6f5ae40cc7b74114e026abc |
| LasOrgId | Indicates the Org ID provided by the LAS service | 23456123 |
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 License burst mode 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]]> |
|
License Server data elements
License Server and Legacy license file Usage information
| Field name | Description | Example value | |
|---|---|---|---|
| License Server information | |||
| GUID | A unique identifier created during install and preserved during upgrade. This field is used to identify which uploads are from the same server. | a5ae17c9-8a4a-4318-938f-a8c6da2aa2ef | |
| HardwareId | This field is a unique identifier for the License Server instance. | E824249098A96BF0 | |
| 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 | |
| InstallUTC | This value denotes the time when the License Server is installed. | 2016-10-12T00:00:00Z | |
| ProductVersion | Identifies the License Server version. | 11.16.6.0. build 35000 | |
| SGPClockErrorCode | Error code indicating why the License Server entered the License burst mode. | 0 | |
| SGPMaxDays | Maximum days remaining in the License burst mode. | 15 | |
| Inventory | |||
| Feature | |||
| ID | This value represents the product code license usage is associated with | CAG_AAC_CCU | |
| UDBinFileCreatedUTC | Timestamp of when the file used to track user or device licenses was created. | 2016-11-09T00:55:56Z | |
| UDReportGenerationUTC | Timestamp of when the user or device report was generated. | 2016-11-09T00:55:56Z | |
| UDAdminUsersReleased | Count of users released by udadmin. |
3 | |
| UDAdminDevicesReleased | Count of devices released by udadmin. |
3 | |
SADate |
This field is used to build a view of license usage over time. | For examples, see SADate in the following section. | |
| SADate | |||
| id | Captures the SA Date through the ID attribute of the SADate element. |
2022.1231 | |
| 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 | This value represents the maximum number of licenses used by this customer. | 6 | |
| CCUDevices | Lists the device IDs that use the Citrix® concurrent licenses. This helps in getting the license usage over time. | ||
| 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 | |
| Licensees | The Licensees field has three sub fields namely CountTotal, Users, and Devices. | For examples, see Licensees in the following section. | |
| CountInstalled | The number of licenses installed. | 1203 | |
| Pool | For examples, see Pool in the following section. | ||
| CCUDevices | |||
| DevId | Specifies the unique concurrent device identifier. This is applicable only for concurrent licenses. | C39A925064A3 | |
| Licensees | |||
| CountTotal | Total number of licenses in use at the time the sample was taken. The total number is the sum of users and devices. | 3 | |
| Users | Specific users where a user license is assigned, contributing to the total count. This is applicable only for user/device licenses. | For examples, see Users in the following section. | |
| Devices | Specific devices where a device license is assigned contributing to the total count. This is applicable only for user/device licenses. | For examples, see Devices in the following section. | |
| Users | |||
| timeLastLogin | Last login time event from a user. | 2022-07-12T10:00:00 | |
| ID | Specific users where a user license is assigned, contributing to the total count. The value is scrambled. | 1EC4ED037766AA18 (always scrambled) | |
| Devices | |||
| timeLastLogin | Last login time event from this device. | 2022-07-12T10:00:00 | |
| DevId | Specifies the unique device identifier where a device license is assigned, contributing to the total count. | C39A925064A3 | |
| Name | Friendly name for the device. | Q648GE661F14B3H7 (always scrambled) | |
| Pool | |||
| Serial | This information allows Citrix to identify who the product is entitled to. | OR10:13 | |
| DateExpiration | The 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 | |
| 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 | Indicates the number of licenses installed among the pools for a given feature. | 100 | |
| CountOverdraft | Indicates the number of licenses used above the installed quantity. | 0 | |
| UsageSamples | For examples, see Sample in the following section. | ||
| DateStart | Date from which licenses are valid on. | 31-Dec-2014 | |
| Sample | |||
| Timestamp | Timestamp of the sample collection. | 2016-11-09T00:55:56Z | |
| CountInUse | Indicates the number of licenses in use at the specific time stamp. | 3 | |
| OverDraft | Indicates the number of licenses used above the installed quantity. | 0 | |
| Installed | Indicates the number of licenses installed at the specific time stamp. | 100 | |
| StartupCounts data elements | |||
| LPE | Product, Edition, and version information for each server communicating with the License Server. Example from left - Apps and Desktops Premium - 2012. | <ID><![CDATA[XDT_PLT_2020.1201]]></ID> |
|
| Count | Total number of LPEs connected to the License Server. | 2 | |
| Licenseburstmode | |||
| ID | This field represents the product code following the License burst mode detail is associated with. | XDT_ENT_UD | |
SADate |
This field represents the CSS date for which the License burst mode was triggered. | 2019.1201 | |
| SGPErrorCode | Error code for which License burst mode was triggered. | -4 | |
| LicCount | License count for which License burst mode was triggered. | 100 | |
| DateTriggerUTC | UTC date on which License burst mode was triggered for ID and SADate. |
2022-07-19T14:35:59Z | |
| DateTriggerLocal | Local date on which License burst mode was triggered for ID and SADate. |
2022-07-19T10:35:59 | |
License activation daily summary
| Key | Description | Examples |
|---|---|---|
| Event Header | ||
| ver | Header version. Hardcoded: “ver”: “1.0” | 1.0 |
| id | Unique event Id (GUID) | 1fced2a0-52e7-4c48-bf4e-6f2e06136e11 |
| type | Event type name | LicenseServer.DailySummary, LicenseServer.ActivationRecord |
| st | UTC formatted timestamp | 2011-08-12T20:17:46.384Z |
| prod | Product name. Hardcoded: “prod”: “LicenseServer” | LicenseServer |
| prodVer | Product version | 11.17.2.0 build 53000 |
| dvc | license server guid. Unique guid in license server | a391f1c8e6cb4948b45c58cd5189572f |
| tenant | Organization (customer) identification info. | “tenant”: { “id”: “”, “orgid”:”” } |
| Event Payload | ||
| ver | Event Schema Version | 1.0 |
| type | Event Type | LicenseServer.DailySummary |
| lsguid | license server guid | 8946c0bd-5247-4d7d-b84d-b79df0b4b32d |
| lsbuild | License Server Build | 11.17.2.0 build 53000 |
| onboardingtype | LAS onboarding type | 0 |
| systemproperties → lsid | Unique LS hash identifier generated using system properties | AE8D3F84672E00BB4239B0D455C4038D4D081B991D91B3F061E59E325FDC6533 |
| systemproperties → pubkey | public key used in license server | —–BEGIN PUBLIC KEY—– MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAvrY93YgyUehzeSCroE7B ZfnjH9P2fuxRdOPrO4Q55r35z+PIQc5Nl7H+9FKO/bOoVjHOJsP/OM1jDv6BW80F 41zQA3cGfI0j/1zZGG+Ap91eztMzm0qpNFhXkLJ/EOf9LY429sIz/0xI4oRQP05F d8niv+0LeSTCGWDeCB2PDW4C2SBALEcdb6td+jkQRezFbRNCZwKcydirigASmSgT 9kYp3PsIZfi3WubB/nMzQbTC7iShKiH8QSIhw3T88IvazE0BrpKPBRzYo8Qjvxas mL0JgT0LNfxidmerEyp9cB+jINIdZ1iQLmdu4iBPnCqxvq6qabBWKfrnqvDWpklX +QIDSVf5 —–END PUBLIC KEY—– |
| installutc | LS Installed Time | 1749138309 |
| hostname | Hostname of LS | micpvdipd1882 |
| activationdata | ||
| pem | Activated product and configuration | XDT_PLT_CCS |
| ver | activation version | 1.0 |
| activationid | activation id | Activation id of the blob |
| instances | Instances of product activated | 10 |
| laspedetails → lpeid | Product Unique instance | AE8D3F84672E00BB4239B0D455C4038D4D081B991D91B3F061E59E325FDC6522 |
| laspedetails → burnindate | Product Version | 2025.0625 |
| laspedetails → productdeploymentinfo | Product deployment properties | ver:[1.0] productAndVersions:[XDT:PLT,XDT:PLT,CVAP:PRE,MPS:PLT,CVAP:PRE] deploymentids:[90ab15fa-ae58-4e3c-8d9b-f6581e1020ce] instanceids:[1e59adac-7ac6-4db5-a095-0567d1590fab] deploymentdetails:[] |
| laspedetails → requestutc | LAS Activation Request Time | 1749138309 |
| signdata | ||
| orgid | LAS onboarded Orgid | int102cd6db |
| onboardingtype | LAS onboarding type | 0 |
| lsid | Unique LS hash identifier generated using system properties | AE8D3F84672E00BB4239B0D455C4038D4D081B991D91B3F061E59E325FDC6533 |
| pubkey | public key used in license server | —–BEGIN PUBLIC KEY—– MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAvrY93YgyUehzeSCroE7B… —–END PUBLIC KEY—– |
| entitlementdata | ||
| licenseexpirationdate | Expiry date | 2025-12-25 |
| pem | Product | XDT_PLT_CCS |
| diskdata | ||
| disktotalmb | Total Disk Size in Mb | 1234567890 |
| diskfreemb | Total Disk Free in Mb | 1234567890 |
| licdirectory | Installed Directory | C:\Program Files (x86)\Citrix\Licensing |
License Activation Usage information
| Key | Description | Examples |
|---|---|---|
| Event Header | ||
| ver | Header version. Hardcoded: “ver”: “1.0” | 1.0 |
| id | Unique event Id (GUID) | 1fced2a0-52e7-4c48-bf4e-6f2e06136e11 |
| type | Event type name. LicenseServer.ActivationRecord - Events coming from LS | LicenseServer.ActivationRecord |
| st | UTC formatted timestamp | 2011-08-12T20:17:46.384Z |
| prod | Product name. Hardcoded: “prod”: “LicenseServer”. LicenseServer - Events coming from LS | LicenseServer |
| prodVer | Product version. 1.0 - when event is coming from LAS. | 11.17.2.0 build 53100 |
| dvc | license server guid. Unique guid in license server | a391f1c8e6cb4948b45c58cd5189572f |
| tenant | Organization (customer) identification info. | “tenant”: { “id”: “abcdef123” } |
| Event Payload | ||
| onboardingtype | LAS onboarding type | 0 |
| signtime | LAS onboarding Time | 1234567890 |
| Activation List (constructed per each activation) | ||
| activationId | Unique LAS Activation Id | 98f6e74c-4436-45e4-97dc-909ba57f5b9e |
| ver | LAS Request Created For Product Activation | 1.0 |
| type | LAS Request Type | LicenseServer.ActivationRequest |
| lsguid | license server guid | 8946c0bd-5247-4d7d-b84d-b79df0b4b32d |
| lsbuild | License Server Build | 11.17.2.0 build 53100 |
| productdeploymentinfo | Product deployment information. Will be available in all the latest LTSR DDCs | ver:[1.0];pdi;productAndVersions:[XDT:PLT,XDT:PLT,CVAP:PRE,MPS:PLT,CVAP:PRE];pdi;deploymentids:[90ab15fa-ae58-4e3c-8d9b-f6581e1020ce];pdi;instanceids:[1e59adac-7ac6-4db5-a095-0567d1590fab];pdi;deploymentdetails:[];pdi; |
| uploadtype | telemetry upload type | auto |
| requestutc | Activation Request time | [ 1717665765 ] |
| products → pem | product configuration | XDT_PLT_CCS |
| products → burnindate | product version | 2025.0624 |
| activationlist → binding | ||
| licenseserver → lsid | Unique hash generated from LS properties | 6d69724c-84ab-47bb-bba3-0f12393ff8ac |
| licenseserver → hostname | Hostname of license server | Mydesktop |
| licenseclient → lpeid | Unique hash generated from product machine properties | 7e81924s-84fg-47qt-kbo3-0f12393ff8ac |
| licenseclient → hostname | Hostname of license client | myclientdesktop |
| activationlist → customer | ||
| orgid | organization id | int102cd6db |
| ccid | citrix cloud id | citrix926070 |
| serialnumbers | legacy license serial numbers | myserial |
Data stored in LAS as part of LAS onboarding
Citrix generated data
| Key | Description | Example |
|---|---|---|
| Lsid | Unique license server identifier generated using system properties | 11ccdb50a8014dec4ee8cfc12b4fd81098699ec560c9898020616e3cab9b209e |
| public key | License server generated identity for authentication | MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA... |
| ls version | License server version | 11.17.2 build 53100 |
| Lsguid | License server generated identity | a1b2c3d4-e5f6-7890-1234-56789abcdef0 |
| request time | LAS Activation Request Time | 2016-10-12T00:00:00Z |
| product edition and model | Product identity | XDT_PLT_CCS |
| Lpeid | Product generated identity | af3357536b217012aaa125892dd2949ce93983d60ee12dfe70d7d451657a6134 |
| site id | Indicates a unique identifier for the site | Site_Production_01 |
| ddc id | Indicates a unique identifier for the delivery controller | C39A925064A3 |
| Orgid | Organization (customer) identification info | ORG123456789 |
| Ccid | Customer ID | CUST-ABC-12345 |
| Uploadtype | Upload type is automatic or manual | automatic or manual |
| product burn-in date | Date associated with every product version and build | 2025.0514 |
Customers provided data
| Key | Description | Example |
|---|---|---|
| hostname (LS) | License Server host name | CITRIX-12T5MRV4 |
| product hostname | Customer given machine hostname | CITRIX-12T5MRV4 |
Citrix Licensing Telemetry data elements
Copied!
Failed!