Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Set-RDSessionHost

Set-RDSessionHost

remotedesktop.psm1

Synopsis

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

Syntax

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

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

Parameters

-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

Accept pipeline input?

false

Accept wildcard characters?

false

-NewConnectionAllowed <RDServerNewConnectionAllowed>

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.

Aliases

None

Required?

true

Position

2

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

-SessionHost <String[]>

Specifies an array that contains the name of one or more RD Session Host servers that you configure.

Aliases

None

Required?

true

Position

1

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type


Return Type

Null

Notes

None

Examples

Example 1: Set values for an RD  Session Host server

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.

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

Online Version
Add-RDSessionHost
Get-RDSessionHost
Remove-RDSessionHost