< Back

Remove-RDSessionHost

Thu Apr 04, 2019 5:42 am

NAME Remove-RDSessionHost



SYNOPSIS

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





SYNTAX

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





DESCRIPTION

The Remove-RDSessionHost cmdlet removes one or more Remote Desktop Session Host (RDSession Host) servers from a session collection. The servers

remain part of the deployment.



RDSession 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 RDSession Host server to run programs, save files, and use network resources on that server.





PARAMETERS

-ConnectionBroker [<String>]

Specifies the Remote Desktop Connection Broker (RDConnection 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.



Required? false

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-Force [<SwitchParameter>]

Forces the command to run without asking for user confirmation.



Required? false

Position? named

Default value none

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 RDSession Host role and that you remove from the session

collection.



Required? true

Position? 1

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.



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.Shows what would happen if the cmdlet runs. The cmdlet is not run.



Required? false

Position? named

Default value false

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS









OUTPUTS

Null







Example 1: Remove a session host



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



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







RELATED LINKS

Online Version: http://go.microsoft.com/fwlink/?LinkId=294249

Add-RDSessionHost

Get-RDSessionHost

Set-RDSessionHost