Product Documentation

Administration without a console

Feb 26, 2018

There are several administration procedures that you can do without using the Citrix Licensing Manager or the License Administration Console. We recommend you use the appropriate console whenever possible. This article describes the procedures required if you are unable to use a console.

  • Combine license files
  • Delete license files
  • Disable domain name truncation on Windows
  • Disable domain name truncation on License Server VPX
  • Install license files
  • Move license files from an older License Server VPX version
  • Reallocate license files
  • Redownloadicense files
  • Customer Success Services renewal files

Combine 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 Redownload.
  5. Use the By Host tab (to automatically combine all specified licenses allocated to a host ID into single line item) and click Select All to select all items on all pages, click the Page check box to select all items on that page, or select the check boxes preceding the licenses that you want to download.
  6. Click Download and save the files to a temporary folder (remember the name of the file and location where you downloaded the file. You will need this location). 
  7. At a command prompt, navigate to the folder and type the following command: 

lmreread -c @localhost -all

Customer Success Services 

After you download your Customer Success Services renewal license file from citrix.com, you must add it to your license server. Copy the Customer Success Services renewal license files to the same directory as your existing license files and reread the license files. By default, this location is C:\Program Files\Citrix\Licensing\MyFiles on a 32-bit server, C:\Program Files (x86)\Citrix\Licensing\MyFiles on a 64-bit server and /opt/citrix/licensing/LS for License Server VPX. After you add the renewal license to your license server, the license automatically unlocks any subsequent versions of the product released during the Customer Success Services period.

Renewing only part of your Customer Success Services membership

If you run products from two different releases in your environment (for example, you have a mixed XenDesktop environment of versions 7.14 and 7.16) and you are not purchasing Customer Success Services for all your licenses, Citrix recommends that you separate the product licenses on two separate license servers. Customer Success Services is applied to the older product versions first.

For example, if you own 200 licenses for 7.14 and you renew your Customer Success Services membership for only 100 of those licenses, it is possible that those 100 renewal licenses, which are required for 7.14, could be consumed by connections to computers running 7.16.

To separate your licenses (two different licenses on two different servers)

  1. Select a second server and install the license server software.
  2. Go to citrix.com to reallocate your original licenses (these are the licenses contained in your current license file on the original license server) and then reallocate the licenses into two new files:
    • Allocate licenses to your first License Server for your 7.14 deployment.
    • Allocate licenses to create another license file for the second License Server for your 7.16 deployment.
  3. Generate and download your Customer Success Services files and then copy them to the server to which you want them applied.
  4. Point all computers to the license server running the version of the Citrix product you want them to use. For information about pointing your Citrix product server to the license server, see your Citrix product's administrator guide.

Delete license files

When you upgrade your edition (for example, Advanced to Enterprise, or Enterprise to Platinum) you receive new Citrix product licenses that you can allocate to one or many Citrix License Servers through license files created at citrix.com. Rescinded licenses must be removed from license servers within ninety (90) days of new license purchase. Removing the licenses enables:

  • License asset management
  • License compliance
  • Remove unnecessary alerts from appearing in the management console

Considerations when deleting files:

  • Incorrect removal of license files could inadvertently lower the total licenses available.
  • Place any new license files on the license server prior to deleting any licenses.
  • Remove a license file only when all INCREMENT lines in the file are obsolete or unnecessary. For example, every increment line has been replaced with a new license as a result of an upgrade.
  • If you used the License Administration Console to add license files, you have to update the console UI for any deleted files.

Important

Never delete the options file (citrix.opt) or startup license (citrix_startup.lic).

  1. At the license server, open the Services panel and stop the Citrix Licensing service.
  2. Open Windows Explorer and navigate to where the license files are stored. By default license files are stored in:
    • C :\Program Files\Citrix\Licensing\MyFiles on a 32-bit server
    • C:\Program Files(x86)\Citrix\Licensing\MyFiles on a 64-bit server
    • /opt/citrix/licensing/myfiles for License Server VPX
  3. Back up all license (.lic) files.
  4. Using a text editor (Microsoft WordPad is recommended), open each license (.lic) file and identify the obsolete license feature INCREMENT line(s).
  5. Ensure all increment lines are obsolete or unnecessary. See License file format for information about increment lines.
  6. Close the file and change the file extension from .lic to .old.
  7. In the Services panel, restart the Citrix Licensing service.

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 host multiple domains and multiple users who have the same user name on different domains (jack@mycompany.com and jack@newplace.com), you can leave domain name truncation enabled. If you have unique users on various domains,  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)

Install license files

  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 (case sensitive) 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.

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

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

Reallocate license files

  1. From a web browser, go to http://www.citrix.com.
  2. Select My Account and type your user ID and password.
  3. Select All Licensing Tools.
  4. From the main menu, select Reallocate.
  5. Select the check box preceding the licenses you want to reallocate, then click Continue.
  6. Follow the instructions to select the licenses to reallocate in to the new file (and associated with a new license server) and download the license file.
  7. Save the file to a temporary folder (remember the file name and location where you downloaded the file; you need this location). 
  8. At a command prompt, navigate to the folder and type the following command: 

lmreread -c @localhost -all

Redownload license files

  1. From a Web browser, go to http://www.citrix.com.
  2. Select My Account and enter your user ID and password.
  3. From the main menu, select Redownload.
  4. Select Select All to select all items on all pages. Check the Page check box to select all items on that page, or check the check boxes preceding the licenses that you want to download.
  5. Select Download and save the file to a temporary location. Remember the file name and location where you downloaded the file. You need this location. 
  6. At a command prompt, navigate to the folder and type the following command: 

lmreread -c @localhost -all