Set-VpnAuthType

Set-VpnAuthType

Sets the authentication type to be used for connecting to a VPN.

構文

Parameter Set: Set0
Set-VpnAuthType [-Type] <String> [[-RadiusServer] <String> ] [[-SharedSecret] <String> ] [-AsJob] [-CimSession <CimSession[]> ] [-ComputerName <String> ] [-EntrypointName <String> ] [-MsgAuthenticator <String> ] [-PassThru] [-RadiusPort <UInt16> ] [-RadiusScore <Byte> ] [-RadiusTimeout <UInt32> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

詳細説明

The Set-VpnAuthType cmdlet is only used to toggle from one authentication type to another. This cmdlet cannot be used to explicitly add any additional RADIUS servers if RADIUS authentication is being used.
-- The parameters for RADIUS authentication properties, such as the MsgAuthenticator, RadiusPort, RadiusScore, RadiusServer, RadiusTimeout and SharedSecret parameters, are applicable only when the ExternalRadius authentication is configured.

パラメーター

-AsJob

-CimSession<CimSession[]>

リモート セッションまたはリモート コンピューターでコマンドレットを実行します。New-CimSession コマンドレットや Get-CimSession コマンドレットの出力など、コンピューター名またはセッション オブジェクトを入力します。既定値は、ローカル コンピューターで実行中の現在のセッションです。

-ComputerName<String>

Specifies the IPv4 or IPv6 address, or host name, of the computer on which the VPN server computer specific tasks should be run. If this parameter is specified, then the authentication type is configured for that VPN server.

-EntrypointName<String>

Identifies a site in a multi-site deployment for which the authentication type needs to be configured.
If this parameter is not specified in a multi-site deployment, then this parameter value on which the cmdlet is run is used. The server could also be represented by using the ComputerName parameter.
If this parameter and the ComputerName parameter are specified and the ComputerName does not belong to the site represented by this parameter, then this parameter takes precedence and the authentication type is configured for it.

-MsgAuthenticator<String>

Specifies the enabled state for the usage of message authenticator. このパラメーターに対して使用できる値:
-- Enabled.
-- Disabled. This is the default value.
This parameter can be configured only if the Type parameter is specified to be ExternalRadius.

-PassThru

作業中の項目を表すオブジェクトを返します。既定では、このコマンドレットによる出力はありません。

-RadiusPort<UInt16>

Specifies the port number on which the RADIUS server is accepting authentication requests.
The default value is 1813.
This parameter can be configured only if the Type parameter is specified to be ExternalRadius.

-RadiusScore<Byte>

Specifies the initial score.
The default value is 30.
This parameter can be configured only if the Type parameter is specified to be ExternalRadius.

-RadiusServer<String>

Specifies the IPv4 or IPv6 address, or host name, of the external RADIUS server that is used for accounting. This parameter can be configured only if the Type parameter is specified to be ExternalRadius.
Specifying the corresponding shared secret is mandatory. The default values can be used for the other parameters.

-RadiusTimeout<UInt32>

Specifies the RADIUS time out value, in seconds.
The default value is 5 seconds.
This parameter can be configured only if the Type parameter is specified to be ExternalRadius.

-SharedSecret<String>

Specifies the shared secret between the Remote Access server and the specified external RADIUS server which is required for successful communication between the two servers.
Note: The secret is specified in clear text.
This parameter can be configured only if the Type parameter is specified to be ExternalRadius.
When specifying a RADIUS server for authentication, it is mandatory to also specify the shared secret. The default values can be used for the other parameters.

-ThrottleLimit<Int32>

このコマンドレットを実行するために確立できる最大同時操作数を指定します。このパラメーターを省略するか、値として 0 を入力した場合、Windows PowerShell® では、コンピューターで実行している CIM コマンドレットの数に基づいて、コマンドレットに対する最適なスロットル制限を計算します。スロットル制限は現在のコマンドレットのみに適用され、セッションまたはコンピューターには適用されません。

-Type<String>

Specifies the authentication type. このパラメーターに対して使用できる値:
-- Windows.
-- ExternalRadius.

-Confirm

コマンドレットを実行する前に、ユーザーに確認を求めます。

-WhatIf

コマンドレットを実行するとどのような結果になるかを表示します。コマンドレットは実行されません。

<CommonParameters>

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

入力

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

• None

出力

出力型は、コマンドレットによって生成されるオブジェクトの型です。

• Microsoft.Management.Infrastructure.CimInstance#VpnAuth

  Microsoft.Management.Infrastructure.CimInstance オブジェクトは、Windows Management Instrumentation (WMI) オブジェクトを表示するラッパー クラスです。シャープ記号 (#) の後のパスは、基になる WMI オブジェクトの名前空間とクラス名です。
  The VpnAuth object consists of the following properties:
  -- Authentication type: Windows or ExternalRadius.
  -- Configured RADIUS servers: If external RADIUS authentication was set, then the configured RADIUS servers are displayed.

例

EXAMPLE 1

This example sets the VPN authentication type to be ExternalRadius. A RADIUS server is specified along with the shared secret required to communicate with that RADIUS server.

PS C:\> Set-VpnAuthType -Type "ExternalRadius" -RadiusServer "10.1.1.1" -SharedSecret "s3cr3t" -PassThru

EXAMPLE 2

This example sets the VPN authentication type to be Windows, which causes authentication to happen on the Remote Access server computer.

PS C:\> Set-VpnAuthType -Type "Windows" -PassThru

関連トピック

Get-VpnAuthProtocol

Set-VpnAuthProtocol