Table of contents
TLS
TOC
Collapse the table of content
Expand the table of content

Get-RDSessionHost

Last Updated: 4/3/2017

SYNOPSIS

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
Parameter Sets: (All)
Aliases: 

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
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
Parameter Sets: (All)
Aliases: 

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.

INPUTS

OUTPUTS

Microsoft.RemoteDesktopServices.Management.RDServer

NOTES

Add-RDSessionHost

Remove-RDSessionHost

Set-RDSessionHost

© 2017 Microsoft