PowerShell Logo Small

Add-RDServer



This is the built-in help made by Microsoft for the command 'Add-RDServer', in PowerShell version 5 - as retrieved from Windows version 'Microsoft Windows Server 2012 R2 Standard' PowerShell help files on 2016-06-23.

For PowerShell version 3 and up, where you have Update-Help, this command was run just before creating the web pages from the help files.

SYNOPSIS

Adds an RDS server to a Remote Desktop deployment.

SYNTAX


Add-RDServer [-Server] <String> [-Role] <String> [[-ConnectionBroker] <String>] [[-GatewayExternalFqdn] <String>] [[-CreateVirtualSwitch]] [<CommonParameters>]



Search powershellhelp.space

DESCRIPTION


The Add-RDServer cmdlet adds a Remote Desktop Services (RDS) server to a Remote Desktop deployment. Specify a server to add by using a fully qualified domain name (FQDN) and
role service name. If you add a Remote Desktop Gateway (RDGateway) role, specify the FQDN for the external gateway. You can use this cmdlet to create a virtual switch.



<

RELATED LINKS

Online Version: http://go.microsoft.com/fwlink/?LinkId=294203
Get-RDServer
Remove-RDServer

REMARKS

<

Examples


Example 1: Add an RD Session Host server

PS C:\> Add-RDServer -Server "SessionHost.Contoso.com" -Role "RDS-RD-SERVER" -ConnectionBroker "RDCB.Contoso.com"



This command adds a server named SessionHost.Contoso.com as an RDSession Host server to a deployment that has an RDConnection Broker server named RDCB.Contoso.com. The
RDS-RD-SERVER role indicates an RDSession Host server.




Example 2: Add an RD Virtualization Host server and create a virtual switch

PS C:\>Add-RDServer -Server "VirtualizationHost.Contoso.com" -Role "RDS-VIRTUALIZATION" -ConnectionBroker "RDCB.Contoso.com" -CreateVirtualSwitch



This command adds a server named VirtualizationHost.Contoso.com as an RDVirtualization Host server to a deployment that has an RDConnection Broker server named
RDCB.Contoso.com. The command creates a virtual switch.




Example 3: Add an RD Gateway server

PS C:\>Add-RDServer -Server "Gateway.Contoso.com" -Role "RDS-GATEWAY" -ConnectionBroker "RDCB.Contoso.com" -GatewayExternalFqdn "ExternalFQDN.NorthWindTraders.com"



This command adds a server named Gateway.Contoso.com as an external gateway to a deployment that has an RDConnection Broker server named RDCB.Contoso.com. The external FQDN
of the gateway is ExternalFQDN.NorthWindTraders.com.




Example 4: Add an RD Connection Broker server

PS C:\>Add-RDServer -Server "RDCB02Contoso.com" -Role "RDS-CONNECTION-BROKER" -ConnectionBroker "RDCB.Contoso.com"



This command adds a server named RDCB02Contoso.com as an RD Connection Broker server to a deployment that has an RD Connection Broker server named RDCB.Contoso.com.