Export (0) Print
Expand All
Collapse the table of content
Expand the table of content
Expand Minimize

Get-RDVirtualDesktopIdleCount

Updated: June 1, 2015

Applies To: Windows 10, Windows Server Technical Preview

Get-RDVirtualDesktopIdleCount

Gets the number of idle virtual desktops on hosts.

Syntax

Parameter Set: Default
Get-RDVirtualDesktopIdleCount [[-HostServer] <String[]> ] [-BatchSize <System.Int32> ] [-ConnectionBroker <String> ] [-InformationAction <System.Management.Automation.ActionPreference> {SilentlyContinue | Stop | Continue | Inquire | Ignore | Suspend} ] [-InformationVariable <System.String> ] [ <CommonParameters>]




Detailed 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.

Parameters

-BatchSize<System.Int32>

Specifies the batch size.


Aliases

none

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.


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?

1

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-InformationAction<System.Management.Automation.ActionPreference>

Specifies how this cmdlet responds to an information event. The acceptable values for this parameter are:

-- SilentlyContinue
-- Stop
-- Continue
-- Inquire
-- Ignore
-- Suspend


Aliases

infa

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-InformationVariable<System.String>

Specifies a variable in which to store an information event message.


Aliases

iv

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see    about_CommonParameters (http://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: Count idle virtual desktops on hosts

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.


PS C:\> Get-RDVirtualDesktopIdleCount -HostServer @("rdvh-1.contoso.com","rdvh-2.contoso.com") -ConnectionBroker "rdcb.contoso.com"

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2015 Microsoft