Get-RDVirtualDesktopIdleCount
Gets the number of idle virtual desktops on hosts.
Syntax
Default (Default)
Get-RDVirtualDesktopIdleCount
[[-HostServer] <String[]>]
[-ConnectionBroker <String>]
[-BatchSize <Int32>]
[<CommonParameters>]
Description
The Get-RDVirtualDesktopIdleCount cmdlet gets the number of idle virtual desktops on one or more hosts. This cmdlet returns a value that represents the number of idle virtual desktops from every pool.
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.
Examples
Example 1: Count idle virtual desktops on hosts
PS C:\>Get-RDVirtualDesktopIdleCount -HostServer @("rdvh-1.contoso.com","rdvh-2.contoso.com") -ConnectionBroker "rdcb.contoso.com"
This command gets the number of idle virtual desktops associated with the connection broker named rdcb.contoso.com on the host servers named rdvh-1.contoso.com and rdvh-2.contoso.com.
Parameters
-BatchSize
Specifies the batch size.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ConnectionBroker
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.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-HostServer
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.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 0 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.