Export (0) Print
Expand All
Expand Minimize

Get-RDSessionHost

Updated: August 12, 2013

Applies To: Windows Server 2012

Get-RDSessionHost

Gets a list of RD Session Host servers in a session collection.

Syntax

Parameter Set: Default
Get-RDSessionHost [-CollectionName] <String> [-ConnectionBroker <String> ] [ <CommonParameters>]




Detailed Description

The Get-RDSessionHost cmdlet gets a list of Remote Desktop Session Host (RD Session Host) servers in a session collection. RD Session Host is a Remote Desktop Services role service that lets users share Windows-based programs or the full Windows desktop. Users can connect to an RD Session Host server to run programs, save files, and use network resources on that server.

Parameters

-CollectionName<String>

Specifies the name of the RD Session Host collection.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ConnectionBroker<String>

Specifies the Remote Desktop Connection Broker (RD  Connection Broker) server for this Remote Desktop deployment. If this parameter does not appear, the default value is the fully qualified domain name (FQDN) of the local host.


Aliases

none

Required?

false

Position?

named

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.

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.

  • Microsoft.RemoteDesktopServices.Management.RDServer

Examples

Example 1: Retrieve a list of RD  Session Host servers in a session collection

This command retrieves a list of the RD Session Host servers in the session collection named Session Collection, which is associated with the RD Connection Broker server named rdcb.contoso.com.


PS C:\> Get-RDSessionHost -CollectionName “Session Collection” -ConnectionBroker rdcb.contoso.com

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft