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-RDServer

Remove-RDServer

remotedesktop.psm1

Synopsis

Removes a server from a Remote Desktop deployment.

Syntax

Remove-RDServer [-Server] [-Role] [-ConnectionBroker] [-Force] [<CommonParameters>]

Detailed Description

The Remove-RDServer cmdlet removes a specified Remote Desktop Services (RDS) server from a Remote Desktop deployment. This cmdlet does not uninstall a server or server role.

Parameters

-ConnectionBroker <String>

Specifies the Remote Desktop Connection Broker (RD Connection Broker) server for a Remote Desktop deployment. If you do not specify a value, the cmdlet uses the fully qualified domain name (FQDN) of the local computer.

Aliases

None

Required?

false

Position

3

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

-Force <SwitchParameter>

Performs the action without a confirmation message.

Aliases

None

Required?

false

Position

named

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

-Role <String>

Specifies an RDS role service name. The acceptable values for this parameter are:  -- RDS-VIRTUALIZATION. Remote Desktop Virtualization Host (RD Virtualization Host). -- RDS-RD-SERVER. Remote Desktop Session Host (RD Session Host). -- RDS-CONNECTION-BROKER. RD Connection Broker. -- RDS-WEB-ACCESS. Remote Desktop Web Access (RD Web Access). -- RDS-GATEWAY. Remote Desktop Gateway (RD Gateway). -- RDS-LICENSING. Remote Desktop Licensing (RD Licensing).

Aliases

None

Required?

true

Position

2

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

-Server <String>

Specifies the FQDN of the server to be removed from the Remote Desktop deployment.

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: Remove an RD Virtualization Host

This command removes an RD Virtualization Host server named RDVH.Contoso.com from the deployment that has an RD Connection Broker server named RDCB.Contoso.com.

PS C:\> Remove-RDServer -Server "RDVH.Contoso.com" -Role "RDS-VIRTUALIZATION" -ConnectionBroker "RDCB.Contoso.com"

Online Version
Add-RDServer
Get-RDServer