Product documentation
Citrix Virtual Apps and Desktops
Service Current Release 2402 LTSR 2311 2308 2305 2303 2212 2209 2206 2203 LTSR 1912 LTSR
View PDF

Licensing for Citrix Virtual Apps and Desktops using Web Studio

September 5, 2024
Contributed by: 
C S

Note:

You can manage your Citrix Virtual Apps and Desktops deployment using two management consoles: Web Studio (web-based) and Citrix Studio (Windows-based). This article covers only Web Studio. For information about Citrix Studio, see the equivalent article in Citrix Virtual Apps and Desktops 7 2212 or earlier.

From Web Studio, you can manage and track licensing, if the license server is in the same domain as Web Studio or in a trusted domain. For information about licensing tasks, see the licensing documentation and Multi-type licensing.

The following table lists the supported editions and license models:

Products Editions License models
Citrix Virtual Apps Premium, Advanced, Standard Concurrent
Citrix Virtual Desktops Premium, Advanced, Standard User/Device and Concurrent

For more information, see Concurrent license and User/device license.

Supported Current Release (CRs) and Long Term Service Release (LTSRs) version

Citrix strongly recommends that you always use the latest available version of Citrix License Server to benefit from any functional or security improvements it may contain.

Note:

The License Server VPX is deprecated and won’t receive any further maintenance or security fixes. Customers using 11.16.6 or previous versions of License Server VPX are advised to migrate to the latest version of License Server for Windows as soon as possible.

For more information about Citrix products’ lifecycle dates, see Product Matrix.

For information on legacy products and product versions, refer to the Legacy Product Matrix.

You must be a full license administrator to complete the following tasks. To view license information in Web Studio, an administrator must have at least the Read Licensing delegated administration permission. The built-in Full Administrator and Read-Only Administrator roles have that permission.

Download and install a license from Citrix using Web Studio

  1. Sign in to Web Studio and select Licensing in the left pane.
  2. Select Allocate Licenses in the action bar.
  3. Enter the License Access Code. You received in an email from Citrix after licenses are purchased or renewed.
  4. Select a product and choose Allocate Licenses. Licenses available for that product are allocated and downloaded. After you allocate and download all the licenses for a specific License Access Code, you cannot reuse that License Access Code. To do other transactions with the same code, log on to My Account.

Add licenses that are stored on your local computer or on the network

  1. Sign in to Web Studio and select Licensing in the left pane.
  2. Select Add Licenses in the action bar.
  3. Browse to a license file and add it to the license server.

Change the license server

  1. Sign in to Web Studio and select Licensing in the left pane.
  2. Select Change License Server in the action bar.
  3. Type the address of the license server in the form name:port, where the name is a DNS, NetBIOS, or IP address. If you do not specify a port number, the default port (27000) is used.

Select the type of license to use

  • When configuring the Site, after you specify the license server, you’re prompted to select the type of license to use. If there are no licenses on the server, the option to use the product for a 30-day trial period without a license is automatically selected.
  • If there are licenses on the server, their details are displayed and you can select one of them. Or, you can add a license file to the server and then select that one.

Change the product edition and licensing model

  1. Sign in to Web Studio and select Licensing in the left pane.
  2. Select Edit Product Edition in the action bar.
  3. Update the appropriate options.

To access the License Administration Console, in the action bar, select License Administration Console. The console either appears immediately, or if the dashboard is configured as password-protected, you’re prompted for License Administration Console credentials. For details about how to use the console, see the licensing documentation.

Note:

When you switch licenses in the Web Studio, the change takes up to 5 minutes to appear in the Citrix Director. For example, if you switch between Advanced and Premium.

Add a licensing administrator

  1. Sign in to Web Studio and select Licensing in the left pane.
  2. Select the Licensing Administrators tab.
  3. Select Add licensing administrator in the action bar.
  4. Browse to the user you want to add as an administrator and choose permissions.

Change a licensing administrator’s permissions or delete a licensing administrator

  1. Sign in to Web Studio and select Licensing in the left pane.
  2. Select the Licensing Administrators tab and then select the administrator.
  3. Select either Edit licensing administrator or Delete licensing administrator in the action bar.

Add a licensing administrator group

  1. Sign in to Web Studio and select Licensing in the left pane.
  2. Select the Licensing Administrators tab.
  3. Select Add licensing administrator group in the action bar.
  4. Browse to the group you want to act as licensing administrators and choose permissions. Adding an Active Directory Group gives licensing administrator permissions to the users within that group.

Change a licensing administrator group’s permissions or delete a licensing administrator group

  1. Sign in to Web Studio and select Licensing in the left pane.
  2. Select the Licensing Administrators tab and then select the administrator group.
  3. Select either Edit licensing administrator group or Delete licensing administrator group in the action bar.

View license information

Sign in to Web Studio and select Licensing in the left pane. A summary of license usage and settings for the Site is displayed with a list of all the licenses currently installed on the specified license server.

Ensure that the licensing settings for the site, which include the product type, license edition, and licensing model, match the licenses your configured License Server uses. If not, you might have to download or allocate your exiting licenses to match the site’s license settings.

Run the command Get-Brokersite to get the following licensing information:

  • TotalUniqueLicenseUsers
  • PeakConcurrentLicenseUsers
  • PeakConcurrentLicensedDevice

Note:

Use the cloud licensing APIs to get the information in Citrix DaaS. For information on cloud licensing APIs, see APIs to manage Citrix Cloud licensing.

View license expiration alerts

Web Studio queries for license file expiration dates from the Citrix License Server. Web Studio alerts administrators on the Overview tab if license files are approaching expiration or already expired.

Scramble licensing telemetry data

Considering the sensitivity of information sent in the license telemetry, Citrix provides you an option to scramble the data.

The following table lists the data that can be scrambled:

Field Description Example
user



Identifies the User ID to uniquely identify a user initiating the session launch.



  • fullName: C648FE671A44B3F7
  • samName: C758LH671A44B3F7
  • upn: C7948FE671A44B3F7
  • userLicenseId: C265FE671A44B3F7
  • userSid: C097FE671A44B3F7
dvc -> dvcName Indicates the friendly name for the device. C758LH671A44B3F7
workerSid Indicates a Unique identifier for the VDA used for the session. 1E5LH671A44B3F7
AdminLoginList Indicates the list of unique admins SamAccountName {AdminLoginList: [UFMJ+JvXOTHO9mQDsOweiw= =]}

To enable or disable scrambling, run the following PowerShell commands on the Delivery Controller.

  1. Open a PowerShell window from the Delivery Controller host.
  2. Run the command asnp citrix to load Citrix-specific PowerShell modules.

  3. Run the following command to enable or disable scrambling:

    By default, the value is 1, or true, which enables scrambling of license telemetry data.

    To disable:

    Set-BrokerServiceConfigurationData Core.ScrambleLicensingData -SettingValue $false
<!--NeedCopy-->

    After you disable scrambling, you can enable it using the following command:

    Set-BrokerServiceConfigurationData Core.ScrambleLicensingData -SettingValue $true
<!--NeedCopy-->
Licensing for Citrix Virtual Apps and Desktops using Web Studio
September 5, 2024
Contributed by: 
C S
September 5, 2024
Contributed by: 
C S

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.