Product Documentation

Multi-type licensing

May 22, 2017

Multi-type licensing supports consumption of different license types for Delivery Groups on a single XenApp or XenDesktop site. Type is a single combination of Product ID (XDT, MPS) and Model (UserDevice, Concurrent). The Delivery Groups must use the Product Edition set for the site.

If multi-type licensing is not configured, different license types can be used only when configured on entirely separate sites. The Delivery Groups use the site license.

localized image

To determine the Delivery Groups that consume the different types of licenses, use these Broker PowerShell cmdlets:

  • New-BrokerDesktopGroup
  • Set-BrokerDesktopGroup
  • Get-BrokerDesktopGroup

To install licenses, use:

  • Citrix Studio
  • Citrix Licensing Manager
  • License Administration Console
  • citrix.com

Subscription Advantage dates are specific to each license file and to each product and model. Delivery Groups set differently might have different Subscription Advantage dates than each other.

Broker PowerShell SDK

The DesktopGroup object has these two properties you can manipulate using the associated New-BrokerDesktopGroup and Set-BrokerDesktopGroup cmdlets.

Name Value Restriction

LicenseModel

An enum (Concurrent or UserDevice) specifying the licensing model for the group.

If the feature toggle is disabled, attempting to set either property fails.

ProductCode

A text string of XDT (for XenDesktop) or MPS (for XenApp) specifying the licensing Product ID for the group. 

If the feature toggle is disabled, attempting to set either property fails.

New-BrokerDesktopGroup

Creates a desktop group for managing the brokering of groups of desktops. For more information on this cmdlet, see https://citrix.github.io/delivery-controller-sdk/Broker/New-BrokerDesktopGroup/

Set-BrokerDesktopGroup

Disables or enables an existing broker desktop group or alters its settings. For more information on this cmdlet, see https://citrix.github.io/delivery-controller-sdk/Broker/Set-BrokerDesktopGroup/

Get-BrokerDesktopGroup

Retrieves desktop groups matching the specified criteria. The output of the Get-BrokerDesktopGroup cmdlet includes the ProductCode and LicenseModel properties of the group. If the properties have not been set using New- BrokerDesktopGroup or Set-BrokerDesktopGroup, null values are returned. If null, the site-wide license model and product code is used. For more information on this cmdlet, see https://citrix.github.io/delivery-controller-sdk/Broker/Get-BrokerDesktopGroup/

Example

This PowerShell cmdlet example illustrates setting multi-type licensing for two existing Delivery Groups and creates and sets a third Delivery Group.

To see the license product and license model associated with a Delivery Group, use the Get-BrokerDesktopGroup PowerShell cmdlet.

  1. We set the first Delivery Group for XenApp and Concurrent.
    Set-BrokerDesktopGroup -Name "Delivery Group for XenApp Platinum Concurrent" -ProductCode MPS -LicenseModel Concurrent
  2. We set the second Delivery Group for XenDesktop and Concurrent.
    Set-BrokerDesktopGroup -Name "Delivery Group for XenDesktop Platinum Concurrent" -ProductCode XDT -LicenseModel Concurrent
  3. We create and set the third Delivery Group for XenDesktop and UserDevice.
    New-BrokerDesktopGroup -Name "Delivery Group for XenDesktop Platinum UserDevice" -PublishedName "MyDesktop" -DesktopKind Private -ProductCode XDT -LicenseModel UserDevice

Special considerations

Multi-type licensing has different functionality than regular XenApp and XenDesktop licensing. 

  • There are no alerts and notifications from Director or Studio:
    • No information when nearing license limits or the trigger or expiry of the Supplemental Grace Period.
    • No notification if there is a problem with a specific group.
  • You publish an application on multiple Delivery Groups having different Licensing Types. Some of the Delivery Groups do not license the application. The application starts only on the Delivery Group machines set to the supported Licensing Types. For example,

The site is set to ProductCode XenDesktop and Edition Enterprise.  Delivery Group1 inherits these settings, and you set Delivery Group 2 to ProductCode XenApp and it inherits Edition Enterprise.
Start a single session application licensed for XenApp Enterprise but not for XenDesktop Enterprise. The application starts only on the Delivery Group 2 machines