Citrix Licensing data collection programs
The following data collection programs are designed to improve your product experience, drive adoption, and gather basic licensing information:
- Citrix Licensing Call Home - This program is optional.
- Citrix Licensing Customer Experience Improvement Program (CEIP) - This program is optional.
- Citrix License Server Events – This program is optional.
- Citrix Licensing Telemetry - This program is required.
- NetScaler telemetry program - This program is required.
Citrix handles your data in accordance with the terms of your contract with Citrix, and protects it as specified in the Services Security Exhibit available on the Citrix Trust Center.
For information about configuring a proxy server, see Configure a proxy server manually in the Get started article.
For information about command-line installation, see Use the Windows command line to install licensing.
Citrix Licensing Call Home
Call Home program improves your experience, helps you understand your product usage over time and drive adoption and improves Citrix products. This program shares system configuration, product configuration and usage data including user or device data with Citrix.
This information is transmitted to Citrix once a day, based on the service start time. This program is optional.
Important
The Citrix Service Provider program requires Call Home. When the License Server detects Citrix Service Provider licenses, it enforces daily uploads.
If you want to register your License Server with Citrix Cloud or remove your registration, see Register and remove registration with Citrix Cloud in Usage and statistics.
You can change your participation in the programs at any time by using the Citrix Licensing Manager. For more information, see “Share usage statistics” under Usage and statistics.
| Data collected | Description | What we use it for |
|---|---|---|
| License usage data | Information about the Citrix licenses installed on the License Server, including product ID, license type, quantity, user, and device data, in addition to license usage information. | We use this data to drive adoption and helps you to understand your license usage over time. |
| License Server deployment and configuration data | Information about the License Server and how it was deployed, including License Server version, operating system version, and configuration states. | We use this data to inform further development of Citrix products and to improve the customer experience. |
For the list of Call Home data elements, see Citrix Licensing Call Home data elements.
Citrix Licensing Customer Experience Improvement Program
CEIP does a periodic collection of system and product configuration and non-identifiable usage data. Providing this data helps Citrix to improve customer experience. This information is transmitted to Citrix once a day, based on the service start time. This program is optional.
You can change your participation in the programs at any time by using the Citrix Licensing Manager. For more information, see “Share usage statistics” under Usage and statistics.
| Data collected | Description | What we use it for |
|---|---|---|
| License usage data | Information about the Citrix licenses installed on the License Server, including product ID, license type, and quantity, in addition to license usage information. | We use this data to track how licenses are consumed and track customer population. |
| License Server deployment and configuration data | Information about the License Server and how it was deployed, including License Server version, operating system version, and configuration states. | We use this data to inform further development of Citrix products and to improve the customer experience. |
For the list of CEIP data elements, see Citrix Licensing CEIP data elements.
Citrix License Server Event data
The following table displays data that is collected from the License Server and used for the following:
- Display information in customer facing dashboards
- Provide alerts and notifications about license expiry, license renewals, and License burst mode.
This functionality is available only when the License Server is registered with the Citrix Cloud.
| Data collected | Description | What we use it for |
|---|---|---|
| License usage data | Information about the Citrix licenses installed on the License Server, including product ID, license type, and quantity, in addition to license usage information. | We use this data to enable alerts and notification about license expiry, license renewals, etc. |
| License Server system information | Information about the License Server(such as Hardware ID). | We use this data to identify the License Server in the customer’s environment. |
For information on how to enable or disable this functionality, see the Share usage statistics section.
For the list of license server event data elements, see Citrix License Server Event data elements
Citrix Licensing Telemetry
Citrix Licensing Telemetry is a mandatory data collection program. The automatic upload of data is enabled when the License Server is installed.
The Citrix License Server collects and reports limited license telemetry to Citrix for on-premises product licenses to support license compliance. For those licenses, Citrix requires that you transition to the most recent License Server version within 6 months of release of each new version. License Server license collection and reporting (electronic or manual) must be active for License Server Version 11.17.2 Build 40000 and beyond. Unless you have elected manual reporting, you agree to adjust your firewalls as necessary to allow electronic license reporting. Should you have questions or concerns, contact Customer Care. Citrix may suspend or terminate your Citrix Support for non-compliance with these requirements without liability in addition to any other remedies Citrix may have at law or equity. These requirements do not apply to the extent prohibited by law or regulation. See our License Telemetry FAQ for more details.
Important:
To remain compliant, the number of days since the last successful upload must not be greater than 90 days.
Prerequisites to successfully upload telemetry data:
Outbound to https://cis.citrix.com/ from the License Server. If not available, create required firewall rule or configure a proxy.
| Data Collected | Description | What we use it for |
|---|---|---|
| License usage data | Information about the Citrix licenses installed on the License Server, including product ID, license type, and quantity, user, and device data, in addition to license usage information. | We use this data for our legitimate interests, including license compliance. |
| License Server system information | Information about the License Server (such as Hardware ID) | We use this data to identify the License Server in the customer’s environment. |
For the list of Licensing Telemetry data elements, see Citrix Licensing Telemetry data elements.
Reporting options
The License Management Service uses product telemetry, built into the License Server, to electronically send data to Citrix periodically.
The first upload occurs approximately five minutes after the License Server first starts or restarts and the next uploads occur once a day thereafter. The schedule resets if you reinstall the License Server. If an upload fails, another attempt is made in 24 hours until either the upload succeeds or the License Management Service is disabled.
You can opt for manually reporting this data by disabling the License Management Service. For more information on how to disable the License Management Service, see Use the command line to enable or disable the License Management Service.
The files required to report with Citrix are kept on the License Server locally to enable the manual upload. You must use the Citrix Insight Services to upload this data. For information about the manual upload procedure using the Citrix Insight Services, see the Knowledge Center article - CTX472950.
Note
In the Citrix Insight Services, the maximum file size that a user can upload is limited. For more information about the file uploading requirements, see the Knowledge Center article - CTX131233.
Starting with the 11.17.2 build 45000, users who opt to manually report data with Citrix have to upload both License Server and Citrix Virtual Apps and Desktops data elements. The Licensing server data elements are bundled in upload_compliance*.zip files. The Citrix Virtual Apps and Desktops data elements are bundled in upload_usage_*.zip files.
You can locate the upload_compliance*.zip files at c:\Program Files (x86)\Citrix\Licensing\LS\resource\usage. You can save all the upload_compliance*.zip files into a single zip file and then send this .zip file to Citrix by using the Citrix Insight Services.
You can locate the upload_usage_*.zip files at c:\Program Files (x86)\Citrix\Licensing\LS\resource\cis bundles\ul_usage. You can save all the upload_usage_*.zip files into a single zip file and then send this .zip file to Citrix by using the Citrix Insight Services.
After the upload is successful, you can delete all upload_*.zip files from the License Server. Failure to delete the .zip files might result in the License Server running out of disk space.
To check the status of your latest upload (whether manual or automatic), you can evaluate the contents of the text file at C:\Program Files (x86)\Citrix\Licensing\LS\resource\cache\upload_compliance_result.xml. This file provides detailed information on the last compliance upload including whether it was successful or failed and the reasons for any failures.
Sample data:
Success:
<CtxUploaderResult><Code>CTX_UPLOADER_SUCCESS</Code><Msg></Msg><t>1679283497</t><UploadType>CTX_UPLOAD_TYPE_COMPLIANCE</UploadType></CtxUploaderResult>
<!--NeedCopy-->
Failure:
<CtxUploaderResult><Code>CTX_UPLOADER_ERROR_NETWORK_OPEN</Code><Msg>SocketOpen(cis.citrix.com:443) exception: {GetAddrInfoW(cis.citrix.com) failed: WSAHOST_NOT_FOUND : code 0x00002af9: No such host is known.
}</Msg><Arg>cis.citrix.com:443</Arg><t>1679283245</t><UploadType>CTX_UPLOAD_TYPE_COMPLIANCE</UploadType></CtxUploaderResult>
<!--NeedCopy-->