Set-RDDeploymentGatewayConfiguration

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

Syntax

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

Description

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

Examples

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 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.

Required Parameters

-GatewayMode

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.
Type:GatewayUsage
Parameter Sets:DoNotUse, Custom, Automatic
Position:0
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-BypassLocal

Indicates whether authorized remote users bypass the RD Gateway server for local connections. By default, the value of this parameter is $False.

Type:Boolean
Position:4
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters: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.

Type:String
Position:5
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Force

Forces the command to run without asking for user confirmation.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-GatewayExternalFqdn

Specifies the external FQDN of the RD Gateway server for this Remote Desktop deployment.

Type:String
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-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.

Type:GatewayAuthMode
Parameter Sets:Password, Smartcard, AllowUserToSelectDuringConnection
Position:2
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-UseCachedCredentials

Indicates whether or not remote users can use RD Gateway access credentials to authenticate access to the remote computer.

Type:Boolean
Position:3
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Outputs

Null

None