< Back
Add-RDServer
Post
NAME Add-RDServer
SYNOPSIS
Adds an RDS server to a Remote Desktop deployment.
SYNTAX
Add-RDServer [-Server] <String> [-Role] {RDS-CONNECTION-BROKER | RDS-VIRTUALIZATION | RDS-RD-SERVER | RDS-WEB-ACCESS | RDS-GATEWAY |
RDS-LICENSING} [[-ConnectionBroker] <String>] [[-GatewayExternalFqdn] <String>] [[-CreateVirtualSwitch]] [<CommonParameters>]
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.
PARAMETERS
-ConnectionBroker [<String>]
Specifies the Remote Desktop Connection Broker (RDConnection Broker) server for a Remote Desktop deployment. If you do not specify a value,
the cmdlet uses the FQDN of the local computer.
Required? false
Position? 3
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-CreateVirtualSwitch [<SwitchParameter>]
Indicates that the cmdlet creates a virtual switch.
Required? false
Position? 5
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-GatewayExternalFqdn [<String>]
Specifies the external FQDN of the RDGateway server for this Remote Desktop deployment. Use this parameter when you are adding the RDGateway
role service. The Role parameter value is RDS-GATEWAY.
Required? false
Position? 4
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. RD?? Gateway.
-- RDS-LICENSING. Remote Desktop Licensing (RD?? Licensing).
If you select a value of RDS-GATEWAY for this parameter, supply a value for the GatewayExternalFqdn parameter.
Required? true
Position? 2
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Server <String>
Specifies the FQDN of the server to add to the Remote Desktop deployment.
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, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
This cmdlet accepts no input.
OUTPUTS
Null
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 RDConnection Broker server to a deployment that has an RDConnection Broker server named
RDCB.Contoso.com.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=294203
Get-RDServer
Remove-RDServer
SYNOPSIS
Adds an RDS server to a Remote Desktop deployment.
SYNTAX
Add-RDServer [-Server] <String> [-Role] {RDS-CONNECTION-BROKER | RDS-VIRTUALIZATION | RDS-RD-SERVER | RDS-WEB-ACCESS | RDS-GATEWAY |
RDS-LICENSING} [[-ConnectionBroker] <String>] [[-GatewayExternalFqdn] <String>] [[-CreateVirtualSwitch]] [<CommonParameters>]
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.
PARAMETERS
-ConnectionBroker [<String>]
Specifies the Remote Desktop Connection Broker (RDConnection Broker) server for a Remote Desktop deployment. If you do not specify a value,
the cmdlet uses the FQDN of the local computer.
Required? false
Position? 3
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-CreateVirtualSwitch [<SwitchParameter>]
Indicates that the cmdlet creates a virtual switch.
Required? false
Position? 5
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-GatewayExternalFqdn [<String>]
Specifies the external FQDN of the RDGateway server for this Remote Desktop deployment. Use this parameter when you are adding the RDGateway
role service. The Role parameter value is RDS-GATEWAY.
Required? false
Position? 4
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. RD?? Gateway.
-- RDS-LICENSING. Remote Desktop Licensing (RD?? Licensing).
If you select a value of RDS-GATEWAY for this parameter, supply a value for the GatewayExternalFqdn parameter.
Required? true
Position? 2
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Server <String>
Specifies the FQDN of the server to add to the Remote Desktop deployment.
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, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
This cmdlet accepts no input.
OUTPUTS
Null
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 RDConnection Broker server to a deployment that has an RDConnection Broker server named
RDCB.Contoso.com.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=294203
Get-RDServer
Remove-RDServer