Product Documentation

Licensing components

May 22, 2017

The License Server comprises several licensing components:

Citrix vendor daemon

License files

Startup license

Citrix License Server Diagnostics License|Server

Options file

Citrix Licensing Customer Experience Improvement Program (CEIP) and Call Home

Figure 1. License Server Components. This diagram shows the Citrix product using TCP/IP to connect to License Server components.

localized image

Citrix vendor daemon

The Citrix vendor daemon (CITRIX), a process that runs on the License Server, grants licenses. The Citrix vendor daemon tracks the number of licenses that are checked out and which product has them. Citrix products communicate with the Citrix vendor daemon using TCP/IP. By default, the Citrix vendor daemon uses TCP/IP port 7279.

License files

License files are protected text files created by Citrix that store licensing data. They contain information about the product licenses and the number of licenses, and system information such as the name of the License Server. The License Server uses these files to determine whether to grant a license to a Citrix product. For more information, see License files.

Startup license

The startup license (citrix_startup.lic) allows Citrix products to communicate with the License Server using a continuous open connection. The startup license:

  • Tracks which product servers are connected to the License Server
  • Stores licensing system information
  • Does not affect your license count

Caution: Do not edit the startup license file, or any other license files.

Citrix License Server Diagnostics License|Server

The License Server uses Citrix License Server Diagnostics License|Server for internal diagnostics and alert message notifications displayed in Studio and Director. It is available by default with the startup license in the citrix_startup.lic file.

Options file

The options file (Citrix.opt) is a License Server configuration file that the Citrix vendor daemon reads every time it restarts or receives a command to reread the file. This configuration file defines licensing behavior-the number of licenses a product server can use, the location of the System Logs, logging levels, and other user-defined customizations. The Customer Experience Improvement Program (CEIP) and Call Home configurations are stored in this file.

Important

Though Flexera offers ways to edit the options file to control, reserve or limit licensing usage, they are not compatible with Citrix licenses. Therefore, we do not support those editing options.

The License request process

When a product requests a license from the License Server, the Citrix vendor daemon determines whether a license is available for the request.

The license request process has two phases: the product startup phase and the user connection phase.

Product Start-Up Phase
  • When a Citrix product starts, it retrieves the License Server location from its data store
  • The product connects to the Citrix vendor daemon
  • The product checks out a startup license
User connection phase
  • A user connects to a computer running the Citrix product
  • The product requests a license from the License Server
  • The Citrix vendor daemon checks to see if any licenses are available and grants or denies the product's request
  • The license module in the product grants or denies the use of the product based on the response from the Citrix vendor daemon

Citrix Licensing Customer Experience Improvement Program (CEIP) and Call Home

The Citrix Licensing CEIP and Call Home usage and analytics programs are voluntary data collection programs designed to improve your product experience. After installing License Server 11.13.1 and greater, you can participate in the programs anonymously or choose to be identified.

CEIP is enabled by default during License Server installation. You can change your participation in the program at any time by using the Citrix Licensing Manager.

This screenshot was taken from build 20104. Older versions are only slightly different.

localized image

Important

The Citrix Service Provider program requires CEIP and Call Home. If you have Citrix Service Provider licenses installed, you can change the settings, but you cannot disable CEIP or Call Home. When the License Server detects Citrix Service Provider licenses, it enforces daily uploads.

When installing licensing on the command line, use CEIPOPTIN to specify whether, or how, to opt in to CEIP or Call Home Optional parameter. The default is CEIP.

Diagnostic - Call Home
Anonymous - CEIP
None

For more command-line installation information, see the "Use the command line to install licensing" section under Install licensing components for Windows.

You can change the choice made at installation by editing the CITRIX.opt file:

#CITRIX CEIP value

Where value is DIAG, ANON, or NONE

On VPX, do not change the CITRIX.opt file. As root, execute the following command and make your choice of CEIP [1.DIAG 2.ANON 3.NONE]

# reset_ceip.sh

Citrix Licensing Customer Experience Improvement Program (CEIP)

CEIP is voluntary. When you opt in, the CEIP services running in Citrix products gather anonymous configuration and usage data from your deployment. The services automatically send the data to Citrix once a week, based on the service start time. CEIP collects these classes of data:

  • Configuration data
  • Performance and reliability data

How your privacy is protected:

  • Citrix does not collect any personally identifiable data.
  • Random identifier is created at install time, which tracks data transfers over time.
  • Citrix does not record information such as IP addresses, server names, or domain names.
  • All data is sent using HTTPS directly to Citrix servers - no third-party data hosting services.
  • All data is secured on Citrix servers and is accessible only by authorized individuals.

Citrix Call Home

Call Home is voluntary. When you opt in, Call Home performs periodic collection of system and product configuration, performance, errors, and more. The data identifies you as a customer. This information is transmitted to Citrix Insight Services once a week, based on the service start time. Citrix support and product teams use the information to resolve issues proactively.