Edit

Share via

Set-RDLicenseConfiguration

  • Reference
Module:
RemoteDesktop

Defines settings for the RD Licensing server and the licensing mode of the Remote Desktop deployment.

Syntax

Set-RDLicenseConfiguration
   -Mode <LicensingMode>
   [-Force]
   [-ConnectionBroker <String>]
   [<CommonParameters>]
Set-RDLicenseConfiguration
   -Mode <LicensingMode>
   -LicenseServer <String[]>
   [-Force]
   [-ConnectionBroker <String>]
   [<CommonParameters>]
Set-RDLicenseConfiguration
   -LicenseServer <String[]>
   [-Force]
   [-ConnectionBroker <String>]
   [<CommonParameters>]

Description

The Set-RDLicenseConfiguration cmdlet defines settings for the Remote Desktop Licensing (RD Licensing) server and the licensing mode of the Remote Desktop deployment.

RD Licensing manages the Remote Desktop Services client access licenses (RDS CALs) that each device or user requires to connect to a Remote Desktop Session Host (RD Session Host) server.

Examples

Example 1: Set the Remote Desktop license configuration

PS C:\> Set-RDLicenseConfiguration -LicenseServer @("Rdl-1.Contoso.com","Rdl-2.Contoso.com") -ConnectionBroker "Rdcb.Contoso.com"

This command sets the Remote Desktop license configuration with the servers named Rdl1-Contoso.com and Rdl-2.Contoso.com and the RD Connection Broker server named Rdcb.Contoso.com.

Example 2: Set the Remote Desktop license configuration in PerUser mode

PS C:\> Set-RDLicenseConfiguration -LicenseServer @("Rdl-1.Contoso.com","Rdl-2.Contoso.com") -Mode PerUser -ConnectionBroker "Rdcb.Contoso.com"

This command sets the Remote Desktop license configuration in PerUser mode with the servers named Rdl-1.Contoso.com and Rdl-2.Contoso.com and the RD Connection Broker server named Rdcb.Contoso.com.

Example 3: Set the Remote Desktop license configuration in PerDevice mode

PS C:\> Set-RDLicenseConfiguration -Mode PerDevice -ConnectionBroker "Rdcb.Contoso.com"

This command sets the Remote Desktop license configuration in PerDevice mode for the RD Connection Broker server named Rdcb.Contoso.com.

Parameters

-ConnectionBroker

Specifies the Remote Desktop Connection Broker (RD Connection Broker) server for a Remote Desktop deployment. If you do not supply a value, the cmdlet uses the fully qualified domain name (FQDN) of the local host.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Forces the command to run without asking for user confirmation.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-LicenseServer

Specifies the FQDN of the RD Licensing server to configure.

Type:String[]
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Mode

Specifies the licensing mode to configure for the deployment. Valid values are PerUser, PerDevice, and NotConfigured.

Type:LicensingMode
Accepted values:PerDevice, PerUser, NotConfigured
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

Outputs

Null