Edit

Share via

Get-RDSessionHost

  • Reference
Module:
RemoteDesktop

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

Syntax

Get-RDSessionHost
   [-CollectionName] <String>
   [-ConnectionBroker <String>]
   [<CommonParameters>]

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.

Examples

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

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

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.

Parameters

-CollectionName

Specifies the name of the RD Session Host collection.

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

-ConnectionBroker

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.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Outputs

Microsoft.RemoteDesktopServices.Management.RDServer