COMMAND EVERYTHING.

Set-RDDeploymentGatewayConfiguration

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

PowerShell · Risk: High · Documentation Verified

Last verified: 2026-10-26

Microsoft RemoteDesktop reference: Specifies settings for the RD Gateway server for a Remote Desktop deployment. The syntax and selected example below are adapted from the pinned Windows Server 2025 reference. Module availability, target configuration and delegated permissions determine whether it can run in your environment. Documentation and parameter text: Microsoft, CC BY 4.0; formatting adapted by Cmdlet World. No execution testing is claimed.

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

Copied 0 times

Required permissions

Use an account with the target resource permissions documented for Set-RDDeploymentGatewayConfiguration. Modifying administrative cmdlets may require elevation or delegated administration. This catalog does not assert that ordinary users can execute the command.

Supported environments

Windows / RemoteDesktop · Windows Server 2025 documentation; feature/module prerequisites apply

Parameters

-BypassLocal: Indicates whether authorized remote users bypass the RD Gateway server for local connections. By default, the value of this parameter is $False.
-ConnectionBroker: Specifies the Remote Desktop Connection Broker (RD Connection Broker) server for this Remote Desktop deployment. If this parameter does not appear, the default value is the fully qualified domain name (FQDN) of the local host.
-Force: Forces the command to run without asking for user confirmation.
-GatewayExternalFqdn: Specifies the external FQDN of the RD Gateway server for this Remote Desktop deployment.
-GatewayMode (required): Specifies a value that indicates whether or not authorized remote users use the RD Gateway server and, if so, whether they detect existing RD Gateway settings automatically or enter settings manually. The acceptable values for this parameter are: - DoNotUse: Remote users enter settings manually and do not use the Gateway. - Custom: Remote users get Gateway settings from other parameters to this cmdlet. - Automatic: Remote users detect Gateway settings automatically.
-LogonMethod: Specifies the method for authenticating user access to the RD Gateway server. The acceptable values for this parameter are: - GatewayAuthMode: Users authenticate by using the method that the Gateway specifies (using a smart card reader or a password). - AllowUserToSelectDuringConnection: The Gateway prompts users to authenticate access when they connect. They must specify a password or smart card reader as the authentication method.
-UseCachedCredentials: Indicates whether or not remote users can use RD Gateway access credentials to authenticate access to the remote computer.

Prerequisites

Windows with the RemoteDesktop module and the Windows feature or management tools that provide it. Confirm target connectivity and version compatibility using the linked Microsoft reference.

Security considerations

This cmdlet changes system state. Review every target and parameter in the official reference, test outside production, and prepare an appropriate backup or rollback. Do not execute the example automatically.

Examples

Example 1: Specify settings to configure RD Gateway access

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 RD Gateway access credentials to authenticate access to the remote computer, and bypass the RD Gateway server for local connections. - The cmdlet also specifies rdcb.contoso.com as the RD Connection Broker server. Source: Microsoft, CC BY 4.0; transcript prompt/output removed. This example was not executed.

Sources

https://github.com/MicrosoftDocs/windows-powershell-docs/blob/b7645dd8c687139b28e845119da30ec670526507/docset/winserver2025-ps/RemoteDesktop/Set-RDDeploymentGatewayConfiguration.md

https://learn.microsoft.com/powershell/module/remotedesktop/set-rddeploymentgatewayconfiguration?view=windowsserver2025-ps

Personal collections

Explain or customize this command with AI

Related commands