Set-RDDeploymentGatewayConfiguration
Set-RDDeploymentGatewayConfiguration
Specifies settings for the RD Gateway server for a Remote Desktop deployment.
Syntax
Parameter Set: Default
Set-RDDeploymentGatewayConfiguration [-GatewayMode] <GatewayUsage> [[-GatewayExternalFqdn] <String> ] [[-LogonMethod] <GatewayAuthMode> ] [[-UseCachedCredentials] <Boolean> ] [[-BypassLocal] <Boolean> ] [[-ConnectionBroker] <String> ] [-Force] [ <CommonParameters>]
Detailed 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.
Parameters
-BypassLocal<Boolean>
Indicates whether or not authorized remote users bypass the RD Gateway server for local connections. By default, this parameter is $false.
Aliases |
none |
Required? |
false |
Position? |
5 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ConnectionBroker<String>
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.
Aliases |
none |
Required? |
false |
Position? |
6 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Force
Forces the command to run without asking for user confirmation.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-GatewayExternalFqdn<String>
Specifies the external FQDN of the RD Gateway server for this Remote Desktop deployment.
Aliases |
none |
Required? |
false |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-GatewayMode<GatewayUsage>
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.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-LogonMethod<GatewayAuthMode>
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.
Aliases |
none |
Required? |
false |
Position? |
3 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-UseCachedCredentials<Boolean>
Indicates whether or not remote users can use RD Gateway access credentials to authenticate access to the remote computer.
Aliases |
none |
Required? |
false |
Position? |
4 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Null
None
Examples
Example 1: Specify settings to configure RD Gateway access
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.
PS C:\> Set-RDDeploymentGatewayConfiguration -GatewayMode Automatic -GatewayExternalFQDN "rdg.contoso.com" -LogonMethod AllowUserToSelectDuringConnection -UseCachedCredentials $True -BypassLocal $True -ConnectionBroker "rdcb.contoso.com"