Export (0) Print
Expand All
Expand Minimize

Remove-RDServer

Windows Server 2012 R2 and Windows 8.1

Updated: October 17, 2013

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

Remove-RDServer

Removes a server from a Remote Desktop deployment.

Syntax

Parameter Set: Default
Remove-RDServer [-Server] <String> [-Role] <String> [[-ConnectionBroker] <String> ] [-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

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Force

Performs the action without a confirmation message.


Aliases

none

Required?

false

Position?

named

Default Value

none

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

none

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

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • Null

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"

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft