Skip to content

xRDGatewayConfiguration

dscbot edited this page Oct 15, 2025 · 1 revision

Parameters

Parameter Attribute DataType Description Allowed Values
ConnectionBroker Key String
BypassLocal Write Boolean
ExternalFqdn Write String
GatewayMode Write String DoNotUse, Custom, Automatic
GatewayServer Write String
LogonMethod Write String Password, Smartcard, AllowUserToSelectDuringConnection
UseCachedCredentials Write Boolean

Description

This resource is used to configure the Remote Desktop Gateway Configuration.

Examples

Example 1

This example shows how to ensure that the Remote Desktop Gateway is setup.

configuration Example
{
    Import-DscResource -ModuleName 'xRemoteDesktopSessionHost'

    node localhost {

        xRDGatewayConfiguration MyGateway {
            ConnectionBroker     = 'connectionbroker.server.fqdn'
            GatewayServer        = 'gateway.server.fqdn'
            GatewayMode          = 'Automatic'
            ExternalFqdn         = 'gateway.external.fqdn'
            LogonMethod          = 'AllowUserToSelectDuringConnection'
            UseCachedCredentials = $false
            BypassLocal          = $false
        }
    }
}
Clone this wiki locally