Get-RDLicenseConfiguration
Get-RDLicenseConfiguration
Retrieves the current settings for the RD Licensing server and the licensing mode of the Remote Desktop deployment.
Syntax
Parameter Set: Default
Get-RDLicenseConfiguration [[-ConnectionBroker] <String> ] [ <CommonParameters>]
Detailed Description
The Get-RDLicenseConfiguration cmdlet retrieves the current settings for the Remote Desktop Licensing (RD Licensing) server and the licensing mode of the Remote Desktop deployment.
RD Licensing servers manage 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 this Remote Desktop deployment. If you do not supply a value, the cmdlet uses the fully qualified domain name (FQDN) of the local computer.
Aliases |
none |
Required? |
false |
Position? |
1 |
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.
System.Object
-- Mode (string). Remote Desktop licensing mode that you configured for the deployment. Valid values are PerUser and PerDevice.
-- LicenseServer (string[]). FQDN of the Remote Desktop license server that you configured for the deployment.
Examples
Example 1: Retrieve the Remote Desktop license configuration
This command retrieves the Remote Desktop license configuration for the RD Connection Broker server named Rdcb.Contoso.com.
PS C:\> Get-RDLicenseConfiguration -ConnectionBroker "Rdcb.Contoso.com"