Licensing guide for XenServer

Install a new license

To install a license, you can either use the automatic method or the manual method. Automatic license allocation requires access to citrix.com public domains through the License Server.

You can download and allocate, and install your licenses by using the Automatic method for machines with internet. Use the Manual method for License servers without internet access.

Using the XenServer (formerly Citrix Hypervisor) Standard and Premium editions requires purchased licenses. For more information, see the feature matrix.

The following section contains methods to install a license:

Before you Start

  • Ensure you have your license access code in the LA-xxxxxxxxxx-xxxxx format. This code is listed in the Citrix email when you purchase a license.
  • Install a License Server if a new site does not have an existing Citrix infrastructure. Install a license server on a Windows machine or create a Citrix Licensing virtual appliance. For installation on a virtual appliance, see How to Install and Configure License Server VPX on XenServer.

Automatic installation

  1. Download the License Server product installer from citrix.com and start the installation.

  2. Use the CitrixLicensing.exe file and start the License Server as an administrator or a member of the administrators group.

  3. Follow the installer instructions to accept the destination folder.

  4. Choose to start the Citrix Licensing Manager and whether to join the Citrix Customer Experience Improvement Program.

  5. After the installation is complete, log on to the License Server.

  6. On the Start menu, select All Programs > Citrix > Citrix Licensing Manager or from a remote machine use https://licenseservername:8083 with your actual License Server name.

  7. Click Install Licenses.

    XenServer automatic method

  8. Select Use license access code and enter the license access code you got in an email from Citrix, and choose Display Licenses. Your license entitlements display and you can choose licenses and the quantity to install.

  9. Select a product from the list, enter the number of entitlements to install, and choose Install.

  10. To display the newly downloaded licenses, click the Dashboard tab.

  11. Connect to your XenServer using XenCenter and open the Xencenter console. For more information, see Install XenServer and XenCenter.

  12. On the Tools menu, click License Manager.

  13. Select the Pool or Hosts that you want to license, and then click Assign License.

  14. In the Apply License dialog, specify the Edition type to assign to the host, and type the hostname or IP address of the License Server. The XenServer host or pool is now licensed.

    For more information, see Managing XenServer Licenses.

Manual installation

If your License Server or appliance isn’t able to contact www.citrix.com, use the Citrix Manage Licenses portal to allocate licenses, download the license file, and upload it to the appliance.

  1. From a web browser, go to www.citrix.com.

  2. Click Sign In > My Account and type your user ID and password.

  3. Select Manage Licenses.

    XenServer license manual method

  4. Select the licenses that you want to allocate. The landing page displays only new licenses within 30 days and expiring term licenses. You can use the Find a license by… search to find all licenses using one of the search criteria. Then use the Filter by menu to narrow the display down to specific types of licenses. You can select Quick find: All active to see all licenses.

  5. From the Select an action menu, choose Allocate licenses.

  6. Enter the host name (case sensitive) and how many licenses to allocate and click Create license file.

  7. Select Yes, create license file.

  8. Select Download license file, and save the file to a location accessible from your License Server or Appliance.

  9. Log on to the License Server.

  10. On the Start menu, click All Programs > Citrix > Citrix Licensing Manager or from a remote machine use this URL with your actual License Server name https://licenseservername:8083.

  11. Click Install Licenses.

    XenServer download and allocate licenses

  12. Select Use downloaded license file, browse and choose a file, and select the check box if you want to replace and older file with the same name.

  13. Click Import. The Citrix Licensing Manager displays information about the licenses. If your license file is successfully uploaded to the License Server, a message displays.

  14. Click the Dashboard tab to display the newly downloaded licenses.

  15. Once the license server is connected, you can select these licenses within XenCenter to the license server.

  16. Connect to your XenServer using XenCenter and open the console. For more information, see Install XenServer and XenCenter.

  17. On the Tools menu, click License Manager.

  18. Select the Pool or Hosts that you want to license, and then click Assign License.

  19. In the Apply License dialog, specify the Edition type to assign to the host, and type the hostname or IP address of the License Server.

    For more information, see Managing XenServer Licenses.

Renew a license

Use the Citrix Licensing Manager to automatically install any renewed licenses to the license server. For automatic license renewal, you need access to citrix.com public domains through the License Server.

To renew the CSS agreement for your license files, refer to the Renewal guide.

This section contains the following:

Renew a license - Automatic method

  1. In the Citrix Licensing Manager, click the Settings icon in the top right of the screen.

  2. Select from the following options on how you want to be notified and automatically install the renewal licenses:

    • Automatically check for Customer Success Services renewal licenses and notify when available: Citrix Licensing Manager displays a notification. Click a link to download and install the available renewals. This same notification appears in Studio and Director if they are configured to manage the License Server.
    • Automatically check for and install Customer Success Services renewal licenses when available: Citrix Licensing Manager checks weekly and automatically installs renewal licenses when available. A notification displays for a few days stating that renewals have been installed.
    • Manually check for Customer Success Services renewal licenses: Select the Update Licenses tab and Check for Available Renewals. You can check the Update Licenses tab at any time to see a list of licenses installed in the last 30 days.

    Note:

    If the automatic checks for Customer Success Services renewal licenses fail, check the firewall setting or configure a proxy. For this feature to work, the License Server must be able to access https://citrixservices.citrix.com. For more information, see the Configure a proxy server manually section in the Get started article.

Renew a license - Manual method

  1. On the License Server Start menu, click All Programs > Citrix > Citrix Licensing Manager or from a remote machine use this URL with your actual License Server name https://licenseservername:8083.

  2. Go to the Update Licenses tab.

    CVAD renewal license step

    Note:

    This screen lists any licenses installed in the last 30 days. If any renewed licenses are not displayed, use the Check for available licenses link for new licenses.

  3. Once the renewed CSS licenses are available, the list of licenses, quantity, and Customer Success Services date displays on the screen.

  4. Use the Download and Install button to download and install the licenses. Your renewed licenses are now installed on the License Server.

Licensing guide for XenServer