New-EapConfiguration

  • [アーティクル]

New-EapConfiguration

Generates an XML file with the specified EAP configuration.

構文

Parameter Set: EapMsChapv2Auth
New-EapConfiguration [[-UseWinlogonCredential]] [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: EapTlsAuth
New-EapConfiguration [-Tls] [[-VerifyServerIdentity]] [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [-UserCertificate] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: EapTtlsAuth
New-EapConfiguration [-Ttls] [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [-TunnledEapAuthMethod <XmlDocument> ] [-TunnledNonEapAuthMethod <String> ] [-UseWinlogonCredential] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: PeapAuth
New-EapConfiguration [-Peap] [[-VerifyServerIdentity]] [[-TunnledEapAuthMethod] <XmlDocument> ] [-AsJob] [-CimSession <CimSession[]> ] [-EnableNap] [-FastReconnect <Boolean> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

詳細説明

The New-EapConfiguration cmdlet creates an XML file with the specified EAP configuration. You use this cmdlet to create the EAP XML configuration file for EAP authentication that is then used by the Set-VpnConnection cmdlet or the Add-VpnConnection cmdlet. If errors happen during the generation of the XML file, the error information is returned.

パラメーター

-AsJob

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-CimSession<CimSession[]>

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

エイリアス

Session

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-EnableNap

Indicates that the cmdlet enables Network Access Protection (NAP) for PEAP.

エイリアス

なし

必須?

false

位置は?

named

既定値

False

パイプライン入力を許可する

True (ByPropertyName)

ワイルドカード文字を許可する

false

-FastReconnect<Boolean>

Specifies whether to enable FastReconnect in the current PEAP configuration. Specify either $True or $False.

エイリアス

なし

必須?

false

位置は?

named

既定値

True

パイプライン入力を許可する

True (ByPropertyName)

ワイルドカード文字を許可する

false

-Peap

Indicates that PEAP is used as the authentication method.

エイリアス

なし

必須?

true

位置は?

2

既定値

なし

パイプライン入力を許可する

True (ByPropertyName)

ワイルドカード文字を許可する

false

-ThrottleLimit<Int32>

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

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-Tls

Indicates that EAP-TLS, either smart card based or user certificate based, is used as the authentication method.

エイリアス

なし

必須?

true

位置は?

2

既定値

なし

パイプライン入力を許可する

True (ByPropertyName)

ワイルドカード文字を許可する

false

-Ttls

Indicates that TTLS is used as the authentication method.

エイリアス

なし

必須?

true

位置は?

2

既定値

なし

パイプライン入力を許可する

True (ByPropertyName)

ワイルドカード文字を許可する

false

-TunnledEapAuthMethod<XmlDocument>

Specifies the configuration XML for tunneled EAP, EAP-TTLS, or PEAP authentication.

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-TunnledNonEapAuthMethod<String>

Specifies the simple EAP-TTLS client authentication methods. このパラメーターに対して使用できる値: Pap, Chap, MSChap, and MSCHapv2.

エイリアス

なし

必須?

false

位置は?

named

既定値

Pap

パイプライン入力を許可する

True (ByPropertyName)

ワイルドカード文字を許可する

false

-UserCertificate

Indicates that a user certificate is used for authentication. This parameter is used with EAP-TLS. If this parameter is not specified, a smart card authentication is used.

エイリアス

なし

必須?

false

位置は?

named

既定値

False

パイプライン入力を許可する

True (ByPropertyName)

ワイルドカード文字を許可する

false

-UseWinlogonCredential

Indicates that MSCHAPv2 or EAP-MSCHAPv2 is used as the authentication method, and that Windows logon credentials are used automatically when connecting with the VPN connection profile.

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-VerifyServerIdentity

Indicates that server identity validation is performed for the VPN connection. This parameter is used with PEAP, and EAP-TLS with tunneled EAP client authentication.

エイリアス

なし

必須?

false

位置は?

3

既定値

False

パイプライン入力を許可する

True (ByPropertyName)

ワイルドカード文字を許可する

false

-Confirm

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

必須?

false

位置は?

named

既定値

false

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-WhatIf

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

必須?

false

位置は?

named

既定値

false

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

<CommonParameters>

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

入力

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

出力

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

  • Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/RemoteAccess/ClientEapConfiguration

    Microsoft.Management.Infrastructure.CimInstance オブジェクトは、Windows Management Instrumentation (WMI) オブジェクトを表示するラッパー クラスです。シャープ記号 (#) の後のパスは、基になる WMI オブジェクトの名前空間とクラス名です。
    The VpnConnection object contains the VpnConnection configuration settings.

例

Example 1: Create a default EAP configuration object

This command creates a default EAP configuration object, and stores it in the variable named $A. You can use the XML configuration object stored in the variable when you create a VPN connection or change the configuration of a VPN connection.

PS C:\> $A = New-EapConfiguration

Example 2: Create a customized EAP configuration object

This command creates an EAP configuration object, customized by the UseWinlogonCredential parameter, and stores it in the variable named**$A**. By specifying the UseWinlogonCredential parameter, the EAP configuration object is configured to use MSCHAPv2 as the authentication method, and that Windows logon credentials are used automatically when connecting with the VPN connection profile.

PS C:\> $A = New-EapConfiguration -UseWinlogonCredential

Example 3: Create a TLS customized EAP configuration object

This command creates a customized EAP configuration object and stores it in the variable named $A. The EAP configuration object is customized by specifying the following parameters:

--The Tls parameter, which indicates that this configuration object uses EAP-TLS
-- The VerifyServerIdentity parameter, which indicates that the identity of the server to which the client connects is validated
-- The UserCertificate parameter, which indicates that the EAP-TLS authentication method uses a user certificate.

PS C:\> $A = New-EapConfiguration -Tls -VerifyServerIdentity -UserCertificate

Example 4: Create a TTLS customized EAP configuration object

This command creates an EAP configuration object, customized by the Ttls parameter to use the TTLS authentication method. The configuration object is stored in the variable named $A.

PS C:\> $A = New-EapConfiguration -Ttls

Example 5: Create a TTLS EAP configuration object with MSCHAPv2 as the client authentication method

This command creates a new EAP configuration object and stores it in the variable named $A. The EAP configuration object is customized by specifying the following parameters:

-- The Ttls parameter, which indicates that this configuration object uses TTLS as the authentication method
-- The TunneledNonEapAuthMethod parameter with the MSChapv2 value, which specifies that MSCHAPv2 is used as the specific client authentication method
-- The UseWinlogonCredential parameter, which indicates that Windows logon credentials are used automatically when connecting with the VPN connection profile that uses this EAP configuration object.

PS C:\> $A = New-EapConfiguration -Ttls -TunnledNonEapAuthMethod MSChapv2 -UseWinlogonCredential

Example 6: Create an EAP configuration object and use it as input

This set of commands creates an EAP configuration object customized with a TTLS authentication method which uses EAP-TLS as the tunneled client authentication method.

This command creates an EAP configuration object configured to use an EAP-TLS authentication method and to verify the server identity. The configuration object is stored in a variable named $B.

PS C:\> $B = New-EapConfiguration -Tls -VerifyServerIdentity

This command creates an EAP configuration object configured to use the TTLS authentication method, and specifies the TunnledEapAuthMethod parameter to use the EapConfigXmlStream created by the first EAP configuration object as the tunnel EAP authentication method.

PS C:\> $A = New-EapConfiguration -Ttls -TunnledEapAuthMethod $B.EapConfigXmlStream

Example 7: Create an EAP configuration object that uses PEAP authentication

This command creates an EAP configuration object customized by the PEAP parameter to use the PEAP authentication method. The configuration object is stored in a variable named $A.

PS C:\> $A = New-EapConfiguration -Peap

Example 8: Create a customized EAP configuration object and use it as input

This set of commands creates an EAP configuration object customized with the TLS authentication method, and then uses its EapConfigXmlStream object as the tunneled authentication method.

This command creates the EAP configuration object and stores it in the variable named $B. The EAP configuration object is customized to use the TLS authentication method by the Tls parameter, and configured to verify the identity of the server by the VerifyServerIdentity parameter.

This command implicitly configures a smart card to be used for authentication.

PS C:\> $B = New-EapConfiguration -Tls -VerifyServerIdentity

This command uses the EapConfigXmlStream method of the EAP configuration object created in the previous command to specify the value for the TunnledEapAuthMethod parameter. This command also specifies that PEAP is the authentication method, as specified by the Peap parameter; that NAP is enabled for PEAP, as specified by the EnableNap parameter; and that FastReconnect is enabled, as specified by the FastReconnect parameter.

PS C:\> $a = New-EapConfiguration -Peap -EnableNap -FastReconnect $true -VerifyServerIdentity -TunnledEapAuthMethod $b.EapConfigXmlStream

関連トピック

Add-VpnConnection

Set-VpnConnection