Product Documentation

Get started

Aug 10, 2016

Citrix recommends 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 work with older products and license files. New products often require the newest license server to check out licenses correctly.

Licensing your product includes the following steps:

  1. Ensure 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 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 with Active Directory users or groups, the users must be part of a domain; otherwise, use local Windows users.

See Technical overview for an overview of the licensing components and process.

Ensure 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 will work with 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

Citrix recommends 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 work with older products and license files. Each time a new license server is released, it may contain better security features than in previous versions.

Citrix also recommends 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 with an appropriately configured network or host-based firewall.
  • When using the Licensing Administration Console, avoid visiting untrusted websites or clicking on untrusted URLs.

Firewall considerations

Determine if you need to place a firewall between the license server and any product servers. Citrix recommends that you determine if your products will communicate with the license server through a firewall before installing licensing. Where you install the license server can be impacted by firewall considerations.

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 manually create the necessary rules.

If there is a firewall between your product and the license server, you need to configure port numbers. This configuration process entails:
  • Determining which port numbers you need 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 modified so that traffic can flow. For Windows Server 2008, the license server Version 11.5 or later configures the built-in firewall automatically.
  • Modifying the product-side settings. Your Citrix product must be configured with the same port numbers as those 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's documentation for information about these settings.

Install licensing components for Windows

Licensing components can either be installed 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. You can monitor CPU and Memory load (lmadmin.exe and CITRIX.exe) to determine if you should relocate the License Server to another system.

Important

Use the new CitrixLicensing.exe file for all installations going forward, 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 and console using the graphical interface

If you install the License Server without successfully configuring it during or after installation, any subsequent License Server upgrades fail.

  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 andC:\Program Files (x86)\Citrix\Licensing on a 64-bit computer.

  3. On the Configure page, accept or change the default port numbers for use by licensing components and choose whether to allow the installer to configure the Windows Firewall exception. You can change the port numbers after the installation, if needed. If you choose to finish the installation without configuring the License Server, restart the CitrixLicensing.exe installer or use the License Server Configuration tool to configure the settings after the installation. You can 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 launch the License Administration Console or the Citrix Licensing Manager and whether to join the Citrix Customer Experience Improvement Program.

If you do not choose the Citrix Licensing Manager, or a license from you product's administration console, you are now ready to go to the Citrix Web site to obtain the license files needed to run your Citrix products. This procedure is detailed in "Obtain your license files" below.

Use the 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: Because 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=portnumber
LSPORT=portnumber VDPORT=portnumber MCPORT=portnumber 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 None.
    • Diagnostic - Call Home
    • Anonymous - CEIP
    • None

    You can modify 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 modify 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

 

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=portnumber
VENDORDAEMONPORT=portnumber MNGMTCONSOLEWEBPORT=portnumber WEBSERVICELICENSINGPORT=portnumber 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 None.
    • Diagnostic - Call Home
    • Anonymous - CEIP
    • None

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

    #CITRIX CEIP value

    where value is DIAG, ANON, or NONE

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 License in the XenApp and XenDesktop documentation in eDocs.
  • Citrix Licensing Manager.
  • License Administration Console.
  • citrix.com.

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

  • The license code. Find this code: on the Citrix installation media pack, 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 name 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 of the licenses you are entitled to at once. For example, if your company purchases 100 licenses, you can choose to allocate and download only 50 at this time. At a later date, you can allocate the rest in another license file. You can have more than one license file.

Obtain licenses with the Citrix Licensing Manager

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

  • Once 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 or Subscription Advantage renewals) and does not 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, click All Programs > Citrix > Citrix Licensing Manager or from a remote machine, https://licenseservername:8083.
  2. If you want to change the port and/or language, click the Settings icon on the menu bar at the top of the page. Make changes and click Save.
  3. Click 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 and they are processed in order. Note that once 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 additional transactions with 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. For Windows: Start the console ( Start > All Programs > 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 Vendor Daemon Configuration.
  3. Click Import License.
  4. Click the citrix.com link.
  5. On the My Account page, enter 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:
    • 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
  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 the file has the same name as an existing one, 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 as soon as the licenses are read by the license server.

Manually obtain license files

  1. From a Web browser, go to http://www.citrix.com.
  2. Click My Account and enter 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, click Download and save the file to a directory (remember the location where you downloaded the file; you will need this location). This is the suggested location:
    • 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
  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 or C:\Program Files (x86)\Citrix\Licensing\MyFiles on a 64-bit computer or /opt/citrix/licensing/myfiles for License Server VPX).

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

  8. 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

If you are hosting multiple tenants on the same License Server, ensure that the License Server does not truncate @domain.com.

Caution: Editing the registry incorrectly can cause serious problems that may 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.

  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

  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. You have to reconfigure all the users on the new License Server. Ensure that the license files that you move have the correct ownership and permissions.

  1. Backup 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. Shutdown the old License Server
  3. Spin up the new Citrix License Server VPX with the same binding as the older one.
    Binding could be 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