Set-RDDeploymentGatewayConfiguration
Specifies settings for the RD Gateway server for a Remote Desktop deployment.
Syntax
Default (Default)
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.
Parameters
-BypassLocal
Indicates whether authorized remote users bypass the RD Gateway server for local connections. By default, the value of this parameter is $False.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 4 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 5 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Force
Forces the command to run without asking for user confirmation.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-GatewayExternalFqdn
Specifies the external FQDN of the RD Gateway server for this Remote Desktop deployment.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 1 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-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.
Parameter properties
| Type: | GatewayUsage |
| Default value: | None |
| Accepted values: | DoNotUse, Custom, Automatic |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | GatewayAuthMode |
| Default value: | None |
| Accepted values: | Password, Smartcard, AllowUserToSelectDuringConnection |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 2 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-UseCachedCredentials
Indicates whether or not remote users can use RD Gateway access credentials to authenticate access to the remote computer.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 3 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Outputs
undefined
None