Edit

Share via

Get-RDVirtualDesktopIdleCount

  • Reference
Module:
RemoteDesktop

Gets the number of idle virtual desktops on hosts.

Syntax

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.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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.

Type:String[]
Position:0
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False