Set-RDLicenseConfiguration
Set-RDLicenseConfiguration
Defines settings for the RD Licensing server and the licensing mode of the Remote Desktop deployment.
Syntax
Parameter Set: ModePS
Set-RDLicenseConfiguration -Mode <LicensingMode> [-ConnectionBroker <String> ] [-Force] [ <CommonParameters>]
Parameter Set: BothPS
Set-RDLicenseConfiguration -LicenseServer <String[]> -Mode <LicensingMode> [-ConnectionBroker <String> ] [-Force] [ <CommonParameters>]
Parameter Set: LicenseServerPS
Set-RDLicenseConfiguration -LicenseServer <String[]> [-ConnectionBroker <String> ] [-Force] [ <CommonParameters>]
Detailed 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.
Parameters
-ConnectionBroker<String>
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Force
Performs the action without displaying a confirmation message.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-LicenseServer<String[]>
Specifies the FQDN of the RD Licensing server to configure.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Mode<LicensingMode>
Specifies the licensing mode to configure for the deployment. Valid values are PerUser, PerDevice, and NotConfigured.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Null
None
Examples
Example 1: Set the Remote Desktop license configuration
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.
PS C:\> Set-RDLicenseConfiguration -LicenseServer @("Rdl-1.Contoso.com","Rdl-2.Contoso.com") -ConnectionBroker "Rdcb.Contoso.com"
Example 2: Set the Remote Desktop license configuration in PerUser mode
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.
PS C:\> Set-RDLicenseConfiguration -LicenseServer @("Rdl-1.Contoso.com","Rdl-2.Contoso.com") -Mode PerUser -ConnectionBroker Rdcb.Contoso.com
Example 3: Set the Remote Desktop license configuration in PerDevice mode
This command sets the Remote Desktop license configuration in PerDevice mode for the RD Connection Broker server named Rdcb.Contoso.com.
PS C:\> Set-RDLicenseConfiguration -Mode PerDevice -ConnectionBroker "Rdcb.Contoso.com"