< Back
Set-RDDeploymentGatewayConfiguration
Post
NAME Set-RDDeploymentGatewayConfiguration
SYNOPSIS
Specifies settings for the RD?? Gateway server for a Remote Desktop deployment.
SYNTAX
Set-RDDeploymentGatewayConfiguration [-GatewayMode] {DoNotUse | Custom | Automatic} [[-GatewayExternalFqdn] <String>] [[-LogonMethod] {Password |
Smartcard | AllowUserToSelectDuringConnection}] [[-UseCachedCredentials] <Boolean>] [[-BypassLocal] <Boolean>] [[-ConnectionBroker] <String>]
[-Force] [<CommonParameters>]
DESCRIPTION
The Set-RDDeploymentGatewayConfiguration cmdlet specifies settings for the Remote Desktop Gateway (RDGateway) server for a Remote Desktop
deployment. These settings include whether to use the RDGateway server, user authentication methods, and other connection and authentication
options. The RDGateway role service enables authorized users to connect to virtual desktops, firstref_server_7 RemoteApp programs, and
session-based desktops on an internal corporate network from any Internet-connected device.
PARAMETERS
-BypassLocal [<Boolean>]
Indicates whether authorized remote users bypass the RDGateway server for local connections. By default, the value of this parameter is $False.
Required? false
Position? 5
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ConnectionBroker [<String>]
Specifies the Remote Desktop Connection Broker (RDConnection 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.
Required? false
Position? 6
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Force [<SwitchParameter>]
Forces the command to run without asking for user confirmation.
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.
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 RDGateway 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.
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.
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.
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, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
Null
None
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 RDGateway access credentials to authenticate access to the remote computer, and bypass
the RDGateway server for local connections.
-- The cmdlet also specifies rdcb.contoso.com as the RD?? Connection Broker server.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=294258
Get-RDDeploymentGatewayConfiguration
SYNOPSIS
Specifies settings for the RD?? Gateway server for a Remote Desktop deployment.
SYNTAX
Set-RDDeploymentGatewayConfiguration [-GatewayMode] {DoNotUse | Custom | Automatic} [[-GatewayExternalFqdn] <String>] [[-LogonMethod] {Password |
Smartcard | AllowUserToSelectDuringConnection}] [[-UseCachedCredentials] <Boolean>] [[-BypassLocal] <Boolean>] [[-ConnectionBroker] <String>]
[-Force] [<CommonParameters>]
DESCRIPTION
The Set-RDDeploymentGatewayConfiguration cmdlet specifies settings for the Remote Desktop Gateway (RDGateway) server for a Remote Desktop
deployment. These settings include whether to use the RDGateway server, user authentication methods, and other connection and authentication
options. The RDGateway role service enables authorized users to connect to virtual desktops, firstref_server_7 RemoteApp programs, and
session-based desktops on an internal corporate network from any Internet-connected device.
PARAMETERS
-BypassLocal [<Boolean>]
Indicates whether authorized remote users bypass the RDGateway server for local connections. By default, the value of this parameter is $False.
Required? false
Position? 5
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ConnectionBroker [<String>]
Specifies the Remote Desktop Connection Broker (RDConnection 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.
Required? false
Position? 6
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Force [<SwitchParameter>]
Forces the command to run without asking for user confirmation.
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.
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 RDGateway 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.
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.
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.
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, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
Null
None
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 RDGateway access credentials to authenticate access to the remote computer, and bypass
the RDGateway server for local connections.
-- The cmdlet also specifies rdcb.contoso.com as the RD?? Connection Broker server.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=294258
Get-RDDeploymentGatewayConfiguration