PowerShell Logo Small


This is the built-in help made by Microsoft for the command 'Set-RDDeploymentGatewayConfiguration', 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.


Specifies settings for the RD Gateway server for a Remote Desktop deployment.


Set-RDDeploymentGatewayConfiguration [-GatewayMode] <GatewayUsage> [[-GatewayExternalFqdn] <String>] [[-LogonMethod] <GatewayAuthMode>] [[-UseCachedCredentials] <Boolean>]
[[-BypassLocal] <Boolean>] [[-ConnectionBroker] <String>] [-Force] [<CommonParameters>]

Search powershellhelp.space


The Set-RDDeploymentGatewayConfiguration cmdlet specifies settings for the Remote Desktop Gateway (RDGateway) server for a Remote Desktop deployment. These settings include
whether to use the RDGateway server, user authentication methods, and other connection and authentication options. The RDGateway role service enables authorized users to
connect to virtual desktops, WindowsServer®2008R2 RemoteApp programs, and session-based desktops on an internal corporate network from any Internet-connected device.



Online Version: http://go.microsoft.com/fwlink/?LinkId=294258




Example 1: Specify settings to configure RD Gateway access

PS C:\> Set-RDDeploymentGatewayConfiguration -GatewayMode Automatic -GatewayExternalFQDN "rdg.contoso.com" -LogonMethod AllowUserToSelectDuringConnection
-UseCachedCredentials $True -BypassLocal $True -ConnectionBroker "rdcb.contoso.com"

This command sets these options for the RD Gateway server:

-- Authorized users automatically detect settings from the RD Gateway server.

-- The RD Gateway server has an FQDN of rdcb.contoso.com.

-- Remote users authenticate access when they connect, use RDGateway access credentials to authenticate access to the remote computer, and bypass the RDGateway server for
local connections.

-- The cmdlet also specifies rdcb.contoso.com as the RD Connection Broker server.