< Back
Set-RDVirtualDesktopIdleCount
Post
NAME Set-RDVirtualDesktopIdleCount
SYNOPSIS
Sets the maximum number of idle virtual desktops on host servers.
SYNTAX
Set-RDVirtualDesktopIdleCount [-IdleCount] <Int32> [[-HostServer] <String[]>] [-BatchSize <System.Int32>] [-ConnectionBroker <String>]
[<CommonParameters>]
Set-RDVirtualDesktopIdleCount [-Allocation] <Hashtable> [-BatchSize <System.Int32>] [-ConnectionBroker <String>] [<CommonParameters>]
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.
Required? true
Position? 1
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-BatchSize [<System.Int32>]
Specifies the batch size.
Required? false
Position? named
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.
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.
Required? false
Position? 2
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-IdleCount <Int32>
Specifies the number of idle virtual desktops.
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, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
Example 1: Set the number of idle virtual desktops on host servers
PS C:\\>Set-RDVirtualDesktopIdleCount -IdleCount 10 -HostServer @("rdvh-1.contoso.com","rdvh-2.contoso.com") -ConnectionBroker "rdcb.contoso.com"
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.
Example 2: Allocate idle virtual desktops to host servers
PS C:\\>Set-RDVirtualDesktopIdleCount -Allocation @{"RDS-WKS-A26.contoso.com"=2;" RDS-WKS-A27.contoso.com"=4} -ConnectionBroker "rdcb.contoso.com"
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.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=294269
Get-RDVirtualDesktopIdleCount
Get-RDVirtualDesktop
SYNOPSIS
Sets the maximum number of idle virtual desktops on host servers.
SYNTAX
Set-RDVirtualDesktopIdleCount [-IdleCount] <Int32> [[-HostServer] <String[]>] [-BatchSize <System.Int32>] [-ConnectionBroker <String>]
[<CommonParameters>]
Set-RDVirtualDesktopIdleCount [-Allocation] <Hashtable> [-BatchSize <System.Int32>] [-ConnectionBroker <String>] [<CommonParameters>]
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.
Required? true
Position? 1
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-BatchSize [<System.Int32>]
Specifies the batch size.
Required? false
Position? named
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.
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.
Required? false
Position? 2
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-IdleCount <Int32>
Specifies the number of idle virtual desktops.
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, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
Example 1: Set the number of idle virtual desktops on host servers
PS C:\\>Set-RDVirtualDesktopIdleCount -IdleCount 10 -HostServer @("rdvh-1.contoso.com","rdvh-2.contoso.com") -ConnectionBroker "rdcb.contoso.com"
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.
Example 2: Allocate idle virtual desktops to host servers
PS C:\\>Set-RDVirtualDesktopIdleCount -Allocation @{"RDS-WKS-A26.contoso.com"=2;" RDS-WKS-A27.contoso.com"=4} -ConnectionBroker "rdcb.contoso.com"
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.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=294269
Get-RDVirtualDesktopIdleCount
Get-RDVirtualDesktop