Set-RDVirtualDesktopIdleCount
Set-RDVirtualDesktopIdleCount
Sets the maximum number of idle virtual desktops on host servers.
Syntax
Parameter Set: Default
Set-RDVirtualDesktopIdleCount [-IdleCount] <Int32> [[-HostServer] <String[]> ] [-ConnectionBroker <String> ] [ <CommonParameters>]
Parameter Set: Allocation
Set-RDVirtualDesktopIdleCount [-Allocation] <Hashtable> [-ConnectionBroker <String> ] [ <CommonParameters>]
Detailed Description
The Set-RDVirtualDesktopIdleCount cmdlet sets the maximum number of active but idle virtual desktops on one or more host servers. This cmdlet sets the total number of virtual desktops that can be idle in all pools.
An idle virtual desktop is a virtual machine that is in a running state and there is no user logged on to it. Idle virtual desktops continue to run even if you configured the pool so that the server saves a virtual desktop that is not in use.
Parameters
-Allocation<Hashtable>
Specifies a collection of values (key=value pair) that allocate idle virtual desktops to Remote Desktop Virtualization (RD Virtualization Host) servers.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ConnectionBroker<String>
Specifies the Remote Desktop Connection Broker (RD Connection Broker) server for a remote desktop deployment. If you do not specify a value, the cmdlet uses the fully qualified domain name (FQDN) of the local computer.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-HostServer<String[]>
Specifies an array of names of the servers that host the session. For session collections the host server has the name of the Remote Desktop Session Host (RD Session Host) server. For virtual desktop collections the host server has the name of the Remote Desktop Virtualization Host (RD Virtualization Host) server.
Aliases |
none |
Required? |
false |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-IdleCount<Int32>
Specifies the number of idle virtual desktops.
Aliases |
none |
Required? |
true |
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.
Examples
Example 1: Set the number of idle virtual desktops on host servers
This command sets the maximum number of active but idle virtual desktops on the host servers named "rdvh-1.contoso.com" and "rdvh-2.contoso.com".
PS C:\> Set-RDVirtualDesktopIdleCount -IdleCount 10 -HostServer @("rdvh-1.contoso.com","rdvh-2.contoso.com") -ConnectionBroker "rdcb.contoso.com"
Example 1: Allocate idle virtual desktops to host servers
This command sets the number of idle virtual desktops for specific host servers. The command allocates 2 idle virtual desktops for the host server named "RDS-WKS-A26.contoso.com", and 4 idle virtual desktops for the host server named "RDS-WKS-A27.contoso.com".
PS C:\> Set-RDVirtualDesktopIdleCount -Allocation @{"RDS-WKS-A26.contoso.com"=2;" RDS-WKS-A27.contoso.com"=4} -ConnectionBroker "rdcb.contoso.com"