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
 

Remove-RDSessionHost

Remove-RDSessionHost

remotedesktop.psm1

Synopsis

Removes one or more RD Session Host servers from a session collection.

Syntax

Remove-RDSessionHost [-SessionHost] [-ConnectionBroker] [-Force] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The Remove-RDSessionHost cmdlet removes one or more Remote Desktop Session Host (RD Session Host) servers from a session collection. The servers remain part of the deployment.

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

-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

-Force <SwitchParameter>

Indicates that the cmdlet removes the RD Session Host without prompting for user confirmation.

Aliases

None

Required?

false

Position

named

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

-SessionHost <String[]>

Specifies an array that contains the name(s) of one or more servers that run the RD Session Host role and that you remove from the session collection.

Aliases

None

Required?

true

Position

1

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

-Confirm <SwitchParameter>

Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type


Return Type

Null

Notes

None

Examples

Example 1:

This command removes the session host named rdsh.contoso.com from the session collection.

PS C:\> Remove-RDSessionHost -SessionHost @("rdsh.contoso.com") -ConnectionBroker "rdcb.contoso.com" -Force

Online Version
Add-RDSessionHost
Get-RDSessionHost
Set-RDSessionHost