Set-RDSessionHost

Module:: RemoteDesktop

Configures one or more RD Session Host servers in a session collection.

Syntax

Set-RDSessionHost
   [-SessionHost] <String[]>
   [-NewConnectionAllowed] <RDServerNewConnectionAllowed>
   [-ConnectionBroker <String>]
   [<CommonParameters>]

Description

The Set-RDSessionHost cmdlet configures one or more Remote Desktop Session Host (RD Session Host) servers in a session collection by specifying whether each server can accept new connections. 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 a RD Session Host server to run programs, save files, and use network resources on that server.

Examples

Example 1: Set values for an RD Session Host server

PS C:\> Set-RDSessionHost -SessionHost "rdsh.contoso.com" -NewConnectionAllowed Yes -ConnectionBroker "rdcb.contoso.com"

This command specifies values for an RD Session Host server named rdsh.contoso.com. Users can make new server connections to a session collection on the RD Connection Broker server named rdcb.contoso.com.

Parameters

-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

-NewConnectionAllowed

Determines whether the RD Session Host servers specified by the SessionHost parameter can accept new connections. The acceptable values for this parameter are: Yes, NotUntilReboot, or No.

Type:	RDServerNewConnectionAllowed
Accepted values:	Yes, NotUntilReboot, No
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-SessionHost

Specifies an array that contains the fully qualified ___domain name (FQDN) of one or more RD Session Host servers that you configure.

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

Outputs

Null

Share via