Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Set-RDLicenseConfiguration

Set-RDLicenseConfiguration

remotedesktop.psm1

Synopsis

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

Syntax

Set-RDLicenseConfiguration [-ConnectionBroker] [-Force] [-Mode] [<CommonParameters>]

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

Set-RDLicenseConfiguration [-ConnectionBroker] [-Force] [-LicenseServer] [<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

Accept pipeline input?

false

Accept wildcard characters?

false

-Force <SwitchParameter>

Performs the action without displaying a confirmation message.

Aliases

None

Required?

false

Position

named

Default value

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

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

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type


Return Type

Null

Notes

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"

Online Version
Get-RDLicenseConfiguration