Product Documentation

Get started, install, and configure

Aug 14, 2017

We recommend that you upgrade the license server to the latest version when you upgrade or install new Citrix products. New license servers are backward compatible and support older products and license files. New products often require the newest license server to check out licenses correctly.

To see the new features in this release, go to What's new.

Licensing your product includes the following steps:

  1. Ensure that you have the latest license server version.
  2. Verify system requirements.
  3. Install licensing.
  4. Obtain license files from My Account or if you have a license code, use Citrix Licensing Manager.
  5. Install your Citrix product (or, if already installed, restart the Citrix products for the new licenses to be recognized)
  6. Configure product-side licensing communication settings that were not set during product installation, if applicable. This configuration includes setting the correct product-edition in the product. Details about these settings are covered in the product documentation.

    Ensure that the product-side edition setting correctly matches the licenses you have purchased. For example, if you purchased Platinum edition licenses, ensure that the edition setting in the product indicates Platinum-not Enterprise or Advanced.

Important

The License Server does not require domain membership. You can install the License Server in a workgroup and still perform all licensing functions on behalf of Citrix products. To manage the License Administration Console or the Citrix Licensing Manager users having Active Directory users or groups, the users must be part of a domain. Otherwise, use local Windows users.

For an overview of the licensing components and process, see Technical overview and Licensing components.

Ensure that you have the latest license server

When upgrading or installing new Citrix products, always have the latest license server. The new license server is backward compatible and supports older products and license files. However, new products require the newest license server to check out licenses correctly. You can install or upgrade the latest version from the product media.

Note: Citrix does not provide hotfixes for license server components and does not support older license servers with newer products. The latest versions of the license server often contain resolutions to issues appearing in earlier versions.

To find your license server version number

If you are unsure if your license server version is current, you can verify it by comparing your version with the number on the Downloads site.

On a license server with the License Administration Console:

  1. For windows: Start the License Administration Console from the programs menu: Citrix > License Administration Console.

    For License Server VPX and remote systems: Open a web browser and go to https://License Server Name:secureWebPort.

  2. Click Administration and select the System Information tab. See the release version in the information list.

Security considerations

We recommend that you upgrade the license server to the latest version when you upgrade or install new Citrix products. New license servers are backward compatible and support older products and license files. Each time a new license server is released, it might contain better security features than in previous versions.

We also recommend the following security considerations when you configure your environment or use the Licensing Administration Console.

  • Configure the license server environment so that only authorized administrators on a trusted network are permitted to access the Licensing Administration Console port. You achieve this outcome with an appropriately configured network or host-based firewall.
  • When using the Licensing Administration Console, avoid visiting untrusted websites or clicking untrusted URLs.

Firewall considerations

Determine if you require a firewall between the license server and any product servers before installing licensing. Firewall considerations can impact where you install the license server.

The License Server VPX has default ports enabled. To change ports, use the Linux iptables command.

If you have hardware firewalls in your environment, you must create the necessary rules manually.

If there is a firewall between your product and the license server, configure port numbers. This configuration process entails:
  • Determining which port numbers to change. You can change port numbers during the installation process or afterward.
  • Opening up the firewall ports. Open any ports on the firewall that you changed so that traffic can flow. For Windows Server 2008, the license server Version 11.5 or later configures the built-in firewall automatically.
  • Changing the product-side settings. Your Citrix product must be configured with the same port numbers as in the License Administration Console. If you do not change the port number referenced in the product, the product cannot contact the license server. You can change the product-side settings during and after installation of the product. See your product documentation for information about these settings.

Install licensing components for Windows

You can install licensing components on a separate, dedicated server or on a server they share with another application. Alternatively, you can use a web or application server. However, the locations mentioned below are less resource intensive. If you are running fewer than 50 servers or 10,000 licenses, you can install the License Server on the same server as your product. To determine if relocation of the License Server to another system is necessary, monitor CPU and memory load (lmadmin.exe and CITRIX.exe).

Important

Use the new CitrixLicensing.exe file for all future installations, except for Active Directory deployments. In that case, use the .msi.

Ensure that both .exe and .msi files are present for the installation.

Install the License Server for Windows and console using the graphical interface

  1. Download the License Server from citrix.com and start the License Server installer, CitrixLicensing.exe, as an administrator or a member of the administrators group.
  2. Follow the installer graphical interface to accept the destination folder.

    Licensing components are installed in C:\Program Files\Citrix\Licensing on a 32-bit computer and C:\Program Files (x86)\Citrix\Licensing on a 64-bit computer.

  3. On the Configure page, accept or change the default port numbers used by licensing components. Choose whether to allow the installer to configure the Windows Firewall exception. If needed, you can change the port numbers after the installation. If you choose to finish the installation without configuring the License Server, restart the CitrixLicensing.exe installer. You can also use the License Server Configuration tool to configure the settings after the installation. Open the configuration tool from: C:\Program Files\Citrix\Licensing\LS\resource\Licensing.Configuration.Tool.exe.
    • License server port number is 27000
    • Vendor daemon port number is 7279
    • Management console web port is 8082
    • Web Services for Licensing port is 8083
  4. The License Server adds the default License Administration Console administrator based on how you are logged on. If you are in a domain, the License Server adds the installing user (domain\user) as a default License Administration Console administrator. If you are a local Windows user, the License Server adds the installing user (computer\user) as a default License Administration Console administrator. The BUILTIN\administrator group, which allows any administrator to manage licensing, is added by default. You can remove BUILTIN\administrators to restrict licensing to specified users. Any user that has access to managing the License Administration Console can also manage the Citrix Licensing Manager.
  5. Choose to start the License Administration Console or the Citrix Licensing Manager and whether to join the Citrix Customer Experience Improvement Program.

If you don't choose the Citrix Licensing Manager, or a license from your product administration console, you can still get your licenses. Go to the citrix.com to obtain the license files for your Citrix products. This procedure is detailed in "Obtain your license files" below.

Use the Windows command line to install licensing

When using the CitrixLicensing.exe command to install licensing, set properties by adding Property=value on the command line anywhere except between an option and its argument.

Ensure that you run the command line with administrator privileges. To start the command prompt with elevated privileges, choose Start, right-click Command Prompt, and choose Run as administrator.

Note: The Citrix Service Provider program requires Customer Experience Improvement Program (CEIP) and Call Home. If you are a Citrix Service Provider, you cannot disable CEIP or Call Home.

The following sample command line installs licensing in silent mode. Add the properties you want to set.

Type the command in one line without returns. The following example shows multiple lines due to space limitations.

CitrixLicensing.exe /quiet /l install.log INSTALLDIR=installdirectory WSLPORT=port_number
LSPORT=port_number VDPORT=port_number MCPORT=port_number CEIPOPTIN=value

Where:

  • /quiet specifies a silent (quiet) installation.
  • /l specifies the log file location
  • INSTALLDIR is the location where the License Server executable is stored. Optional parameter. The default is c:\program files\citrix licensing or c:\program files (x86)\citrix\licensing.
  • WSLPORT is the port number used for the Web Services for Licensing. Optional parameter. The default is 8083.
  • LSPORT is the port number used for the License Server. Optional parameter. The default is 27000.
  • VDPORT is the port number used for the vendor daemon. Optional parameter. The default is 7279.
  • MCPORT is the port number used for the console. Optional parameter. The default is 8082.
  • CEIPOPTIN specifies whether, or how, to opt in to Citrix Customer Experience Improvement Program (CEIP) or Call Home. Optional parameter. The default is ANON.
    • DIAG - Call Home
    • ANON - CEIP
    • NONE

    You can modify the CEIP and Call Home choice using the Citrix Licensing Manager.

localized image

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

#CITRIX CEIP value

Where value is DIAG, ANON, or NONE

Using the command line to install licensing for an Active Directory deployment

When using the msiexec command to install licensing, set properties by adding Property="value" on the command line anywhere except between an option and its argument. Clustering is not supported in the .msi.

Note: Ensure that you run the command line with administrator privileges. To start the command prompt with elevated privileges, choose Start, right-click Command Prompt, and choose Run as administrator.

The following sample command line installs licensing in silent mode and creates a log file to capture information about this operation. Add the properties you want to set after the switches.

Type the command in one line without returns. The following example shows multiple lines due to space limitations.

msiexec /I ctx_licensing.msi /l*v install.log /qn INSTALLDIR=installdirectory LICSERVERPORT=port_number
VENDORDAEMONPORT=port_number MNGMTCONSOLEWEBPORT=port_number WEBSERVICELICENSINGPORT=port_number CEIPOPTIN=value

Where:

  • /l*v is the location of the setup log. Optional parameter.
  • /qn specifies a silent (quiet) installation.
  • INSTALLDIR is the location where the License Server executable is stored. Optional parameter. The default is c:\program files\citrix licensing or c:\program files (x86)\citrix\licensing.
  • LICSERVERPORT is the port number used for the License Server. Optional parameter. The default is 27000.
  • VENDORDAEMONPORT is the port number used for the vendor daemon. Optional parameter. The default is 7279.
  • MNGMTCONSOLEWEBPORT is the port number used for the console. Optional parameter. The default is 8082.
  • WEBSERVICELICENSINGPORT is the port number used for the Citrix Licensing Manager. Optional parameter. The default is 8083.
  • CEIPOPTIN specifies whether, or how, to opt in to Citrix Customer Experience Improvement Program (CEIP) or Call Home. Optional parameter. The default is ANON.
    • DIAG - Call Home
    • ANON - CEIP
    • NONE

    You can change the CEIP and Call Home choice using the Citrix Licensing Manager.

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

    #CITRIX CEIP value

    Where value is DIAG, ANON, or NONE

Use the command line to disable or enable the License Management Service

The License Management Service operates automatically within the License Server and allows for license management and support. We recommend using the License Management Service for management of your license environment, but you can disable it any time after installation. For more information, see "Citrix License Management Service" in Technical overview.

Syntax:

ctx_license_management_service.exe (-enable|-disable|-query)

Where:

-enable enables license management. The first upload to Citrix occurs seven days after you install the License Server.

-disable disables license management. We recommend that you use the License Management Service to manage your licensing environment.

-query displays the current configuration.

Import and configure the License Server VPX

The Citrix License Server VPX is distributed as a virtual machine system configured in .xva format.

To import License Server VPX using XenCenter

  1. Open XenCenter, click the server on which to import the License Server VPX, and select Import.
  2. Browse to the location of your package and choose the .xva package.
  3. Choose a Home Server for your virtual machine. This Home Server is the server on which the virtual machine starts automatically. Alternately, you can click a XenServer pool and the virtual machine automatically starts on the most suitable host in that pool.
  4. Choose a storage repository for the virtual disk. The repository must have a minimum of 8 GB of free space.
  5. Define network interfaces. The License Server VPX communicates on a single virtual NIC. Choose a network that is accessible to the Citrix Servers to which you want to provide license services.

After you import the virtual machine, it appears inside your XenCenter management console. You can restart the virtual appliance in XenServer by right-clicking on its name and choosing Start.

Configure the License Server VPX for first use

After importing the License Server VPX, you have a fully functional Citrix License Server on your XenServer pool. The first time you start the License Server, a set up wizard opens to configure networking.

  1. After the wizard opens, create a strong root password for administrators.
  2. Specify a hostname for the License Server VPX.

    Note: Most Citrix license files are tied to the case-sensitive hostname of your License Server.

  3. Specify a domain for the License Server VPX.
  4. Specify whether to use DHCP as your network type. Choose y to obtain network information automatically. Otherwise, choose n, and type the required network information.
  5. Specify a License Administration Console user name and password for the licensing service.
  6. Choose whether to enable the Customer Experience Improvement Program and Call Home. For more information, see About the Citrix Customer Experience Improvement Program (CEIP).

Configure licenses from a web-based interface, available on port 8082.

If you make a configuration error, log on to the appliance as root with the password you specified. Type the command resetsettings.sh or reset_ceip.sh to rerun the set up wizard.

resetsettings.sh command

resetsettings.sh provides the option to retain or delete historical data files while resetting the Licensing Server VPX configuration. You can fully reset the configuration by deleting all historical data collected until that time or partially reset the configuration by retaining the historical data.

As root, run the following script and make your choices:

# resetsettings.sh


reset_ceip.sh command

reset_ceip.sh provides the option to reset the Customer Experience Improvement Program (CEIP) options you chose during the original configuration. This command resets only the CEIP settings and retains all other settings.

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

#reset_ceip.sh

Export the database for use in a different License Server VPX

Use the migrate_historical_data.sh script to migrate the historical data to a newer Licensing Server VPX. The script provides options to back up and restore historical data.

Run this script as root.

This example procedure migrates the data from VPX_O to VPX_N.

  1. Run the command # migrate_historical_data.sh -b on VPX_O to create a backup file /tmp/historical_data.tar.
  2. When VPX_N is running, copy or move the /tmp/historical_data.tar file to VPX_N using any file transfer protocol. For example, scp.
  3. Run the # migrate_historical_data.sh -r /directory command on VPX_N to restore the data. Where directory is the directory in which historical_data.tar resides.

Obtain your license files

After you install the licensing components, you are ready to obtain your license files.

You can obtain your license files in several ways:

  • Studio in XenApp and XenDesktop. For more information, see Licensing in the XenApp and XenDesktop documentation.
  • Citrix Licensing Manager.
  • License Administration Console.
  • citrix.com.

Before going to the Citrix website, you need the following information at hand:

  • The license code. Find this code: at My Account on citrix.com, in an email you receive from Citrix, or from the Subscription Advantage Management-Renewal-Information system (SAMRI).
  • Your user ID and password for My Account. You can register for this password on My Account.

    Note: If you cannot locate these items, contact Citrix Customer Service.

  • The Host ID of the server on which you installed the licensing components. The entry field for this name is case-sensitive, so ensure that you copy the name exactly as it appears on the computer.

    You can find the license server host name and MAC address (Ethernet) in the License Administration Console in the Administration area on the System Information tab. You can also run the hostnamecommand at a command prompt on the license server.

  • How many licenses you want to include in the license file. You do not have to download all the licenses you are entitled to at once. For example, if your company purchases 100 licenses, you can allocate and download only 50 now. Later, you can allocate the rest in another license file. You can have more than one license file.

Install licenses with the Citrix Licensing Manager builds 21103 and 20104

Not available in License Server VPX.

Considerations - Be aware of these considerations when using the Citrix Licensing Manager to allocate and download licenses:

  • After you click Allocate and Download, you cannot cancel it. If the Allocate and Download fails, use My Account at citrix.com.
  • The Citrix Licensing Manager allocates only retail licenses (no evaluation or demo licenses) and doesn't support redownloading or reallocating of license files. You can return licenses on citrix.com and use the Citrix Licensing Manager to allocate them again. For redownloading, use My Account.
  • If you rename the license server, you must reallocate any license files allocated under the old license server name. For more information about reallocating files, see Reallocate license files.
  • The Citrix Licensing Manger gives you the option of choosing how to obtain your licenses:
    • Use license access code
    • Use downloaded license file - Build 21103 displays information about the licenses when you use the license access code and download license file methods.

In the Start menu, click All Programs > Citrix > Citrix Licensing Manager or from a remote machine, https://licenseservername:8083.

If you choose Use license access code:

  1. Select Use license access code and type the license access code (which is supplied in an email from Citrix) and choose Display Licenses. Your license entitlements display and you can choose which licenses and the quantity to install.
  2. Select a product from the displayed list, type the number of entitlements to install, and choose Install. To select more than one product, choose a product, click Install, choose the next product, click Install, and so on. They are processed in order. After you install all the licenses for a specific license access code, you cannot use that license access code again. If you must perform more transactions with that code, log on to My Account.
  3. To display the newly downloaded licenses, refresh the License Administration Console.
localized image

If you choose Use downloaded license file:

  1. Select Use downloaded license file, choose a file, and check the check box if you want to replace and older file with the same name. If you are using build 21103, the Citrix Licensing Manager displays information about the licenses.
  2. If your license file is successfully uploaded to the License Server, a message displays. To display the newly downloaded licenses, refresh the License Administration Console.
localized image

Obtain licenses using the Citrix Licensing Manager build 19005

Not available in License Server VPX.

Considerations - Be aware of these considerations when using the Citrix Licensing Manager to allocate and download licenses:

  • After you select Allocate and Download, you cannot cancel it. If the Allocate and Download fails, use My Account at citrix.com.
  • The Citrix Licensing Manager allocates only retail licenses (no evaluation or demo licenses) and doesn't support redownloading or reallocating of license files. For those features, use My Account.
  • If you rename the license server, you must reallocate any license files allocated under the old license server name. For more information about reallocating files, see Reallocate license files.
  1. In the Start menu, select All Programs > Citrix > Citrix Licensing Manager or from a remote machine, https://licenseservername:8083.
  2. If you want to change the port or language, click the Settings icon on the menu bar at the top of the page. Make changes and click Save.
  3. Select Allocate Licenses, type the license access code (which is supplied in an email from Citrix) and click Display Licenses.
  4. Select a product from the displayed list and click Allocate and Download. To select more than one product, choose a product, click Allocate and Download, choose the next product, click Allocate and Download, and so on. They are processed in order. After you allocate and download all the licenses for a specific license access code, you cannot use that license access code again. If you must perform more transactions using that code, log on to My Account.
  5. To display the newly downloaded licenses, refresh the License Administration Console.

Obtain license files with the License Administration Console

  1. From a web browser, go to https://ls:8083.
  2. Click Administration and Vendor Daemon Configuration.
  3. Click Import License.
  4. Click the citrix.com link.
  5. On the My Account page, type your user ID and password.
  6. Select All Licensing Tools.
  7. From the main menu, select Allocate.
  8. Follow the process to allocate and generate your file.
  9. Select the licenses you want to download, click Download, and save the file to and save the file to a temporary directory.
  10. In the License Administration Console on the Import License File page, browse to the license file.
  11. If you copied the file directly to the MyFiles directory, or if a file having the same name exists on the License Server, select Overwrite License File on License Server.
  12. Click Import License.
  13. Click Vendor Daemon Configuration and click Administer in the Citrix vendor daemon line.
  14. Click Reread License Files to allow the license server to recognize the new file.

    Users can begin using these licenses when the License Server reads the licenses.

Obtain license files manually

  1. From a web browser, go to http://www.citrix.com.
  2. Click My Account and type your user ID and password.
  3. Select All Licensing Tools.
  4. From the main menu, select Allocate.
  5. Follow the process to allocate and generate your file.
  6. Select the licenses you want to download, choose Download, and save the file to a directory. 
  7. At the license server, copy the license file from the directory where it was saved to the myfiles directory.
    C:\Program Files\Citrix\Licensing\MyFiles on a 32-bit computer
    C:\Program Files (x86)\Citrix\Licensing\MyFiles on a 64-bit computer
    /opt/citrix/licensing/myfiles for License Server VPX

Tip: Ensure that the license file retains the .lic file name extension. Some copy processes do not recognize a file type for that extension and add a ".txt" file name extension during the copy. License files that have the wrong file name extension cannot be imported.

  1. At a command prompt, navigate to:
    • C:\Program Files\Citrix\Licensing\LS on a 32-bit computer
    • C:\Program Files (x86)\Citrix\Licensing\LS on a 64-bit computer
    • /opt/citrix/licensing/LS for License Server VPX

    And type the following command: lmreread -c @localhost -all

Disable domain name truncation on Windows

Warning

Editing the registry incorrectly can cause serious problems that might require you to reinstall your operating system. Citrix cannot guarantee that problems resulting from the incorrect use of Registry Editor can be solved. Use Registry Editor at your own risk. Be sure to back up the registry before you edit it.

If you are hosting multiple tenants on the same License Server, ensure that the License Server does not truncate @domain.com. The License Server detects Citrix Service Provider licenses and enables this functionality.

  1. Locate the registry key:

    For 32-bit machines: HKLM\Software\citrix\licenseserver

    For 64-bit machines: HKLM\Software\Wow6432Node\citrix\licenseserver

    Name: UDUseDomain

  2. Set the registry key to 1.
    Data Description
    0 The domain field is truncated. (default)
    1 The domain field is not truncated.

Disable domain name truncation on the Citrix License Server VPX

The License Server detects Citrix Service Provider licenses and enables this functionality.

  1. On the command line, go to the /opt/citrix/licensing/LS/conf/ud_settings.conf file.
  2. Using the vi editor, set CTX_UD_USERDOMAIN=1.
  3. Restart the License Server VPX or the Citrix Licensing daemon.
Setting Description
CTX_UD_USERDOMAIN=1 Use user domain from user profile. Disables domain name truncation.
CTX_UD_USERDOMAIN=0 Do not use user domain from user profile. (default)

Move license files from an older License Server VPX version

This procedure moves only the license files. Reconfigure all the users on the new License Server. Ensure that the license files that you move have the correct ownership and permissions.

  1. Back up the license files from the old Citrix License Server VPX to a network share.
    All the *.lic license files from: /opt/citrix/licensing/myfiles except citrix_startup.lic
  2. Close the old License Server
  3. Spin up the new Citrix License Server VPX using the same binding as the older one.
    The binding might be a MAC address or hostname or IP Address specified in the SERVER line of the license files.
  4. Restore the backed-up license files from the Network Share to the new License Server. Restore the files to: /opt/citrix/licensing/myfiles with the file ownership as ctxlsuser:lmadmin (user:group) and permission as 644.
  5. Run this command as ctxlsuser: /opt/citrix/licensing/LS/lmreread -c @localhost

Configure a proxy server for use with Citrix Licensing Manager, Customer Experience Improvement Program (CEIP), and Call Home

You can use a proxy with the Citrix Licensing Manager, CEIP, and Call Home. When you configure a proxy server, requests to download licenses and upload Call Home data are sent through a proxy server.

Important

Citrix Licensing components requiring outward bound web communications can inherit network proxy settings using Windows automatic proxy detection. We do not support authenticated proxies. For more information, see WinHTTP AutoProxy Functions.

Configure a proxy server manually

  1. Edit the SimpleLicenseServiceConfig.xml file, which is in the <citrix Licensing>\WebServicesForLicensing directory.
  2. Add a line of xml to the file in the format <Proxy>proxy server name:port number</Proxy>
    Important: The .xml tags are case-sensitive.
Sample Copy

<Configurations>

  <EncoreConfiguration>

    <SamplingPeriod>15</SamplingPeriod>

    <RetentionTime>180</RetentionTime>

    <Enabled>true</Enabled>

  </EncoreConfiguration>

  <Proxy>10.211.55.5:808</Proxy>

</Configurations>