Remove-RDServer
Removes a server from a Remote Desktop deployment.
Syntax
Default (Default)
Remove-RDServer
[-Server] <String>
[-Role] <String>
[[-ConnectionBroker] <String>]
[-Force]
[<CommonParameters>]
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.
Examples
Example 1: Remove an RD Virtualization Host
PS C:\> Remove-RDServer -Server "RDVH.Contoso.com" -Role "RDS-VIRTUALIZATION" -ConnectionBroker "RDCB.Contoso.com"
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.
Parameters
-ConnectionBroker
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.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 2 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Force
Forces the command to run without asking for user confirmation.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Role
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).
Parameter properties
| Type: | String |
| Default value: | None |
| Accepted values: | RDS-CONNECTION-BROKER, RDS-VIRTUALIZATION, RDS-RD-SERVER, RDS-WEB-ACCESS, RDS-GATEWAY, RDS-LICENSING |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Server
Specifies the FQDN of the server to be removed from the Remote Desktop deployment.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Outputs
undefined