Set-RDDeploymentGatewayConfiguration

適用対象: Windows 10, Windows Server Technical Preview

Set-RDDeploymentGatewayConfiguration

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

構文

Parameter Set: Default
Set-RDDeploymentGatewayConfiguration [-GatewayMode] <GatewayUsage> {DoNotUse | Custom | Automatic} [[-GatewayExternalFqdn] <String> ] [[-LogonMethod] <GatewayAuthMode> {Password | Smartcard | AllowUserToSelectDuringConnection} ] [[-UseCachedCredentials] <Boolean> ] [[-BypassLocal] <Boolean> ] [[-ConnectionBroker] <String> ] [-Force] [-InformationAction <System.Management.Automation.ActionPreference> {SilentlyContinue | Stop | Continue | Inquire | Ignore | Suspend} ] [-InformationVariable <System.String> ] [ <CommonParameters>]

詳細説明

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.

パラメーター

-BypassLocal<Boolean>

Indicates whether authorized remote users bypass the RD Gateway server for local connections. By default, the value of this parameter is $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.

-Force

ユーザーの確認を求めることなく、コマンドを強制的に実行します。

-GatewayExternalFqdn<String>

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

-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. このパラメーターに指定できる値は、次のとおりです。

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

-InformationAction<System.Management.Automation.ActionPreference>

Specifies how this cmdlet responds to an information event. The acceptable values for this parameter are:

-- SilentlyContinue
-- Stop
-- Continue
-- Inquire
-- Ignore
-- Suspend

-InformationVariable<System.String>

Specifies a variable in which to store an information event message.

-LogonMethod<GatewayAuthMode>

Specifies the method for authenticating user access to the RD Gateway server. このパラメーターに指定できる値は、次のとおりです。

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

-UseCachedCredentials<Boolean>

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

<CommonParameters>

このコマンドレットは共通のパラメーターをサポートしています(-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、および -OutVariable)。詳細については、TechNet の「 「about_CommonParameters」 (https://go.microsoft.com/fwlink/p/?LinkID=113216) を参照してください。

入力

入力型は、コマンドレットにパイプできるオブジェクトの型です。

出力

出力型は、コマンドレットが出力するオブジェクトの型です。

• Null

  None

使用例

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" 

関連項目

Get-RDDeploymentGatewayConfiguration