Export (0) Print
Expand All

New-EapConfiguration

Updated: August 15, 2012

Applies To: Windows Server 2012

New-EapConfiguration

Generates a new XML file with the specified EAP configuration.

Syntax

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




Detailed Description

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.

Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-CimSession<CimSession[]>

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.


Aliases

Session

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-EnableNap

Indicates that Network Access Protection (NAP) is enabled for PEAP.


Aliases

none

Required?

false

Position?

named

Default Value

False

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-FastReconnect<Boolean>

Specifies whether FastReconnect is enabled or disabled in the current PEAP configuration. Specify either $true or $false.


Aliases

none

Required?

false

Position?

named

Default Value

True

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Peap

Indicates that PEAP is used as the authentication method.


Aliases

none

Required?

true

Position?

2

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ThrottleLimit<Int32>

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Tls

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


Aliases

none

Required?

true

Position?

2

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Ttls

Indicates that TTLS is used as the authentication method.


Aliases

none

Required?

true

Position?

2

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-TunnledEapAuthMethod<XmlDocument>

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


Aliases

none

Required?

false

Position?

4

Default Value

none

Accept Pipeline Input?

True (ByValue, ByPropertyName)

Accept Wildcard Characters?

false

-TunnledNonEapAuthMethod<String>

Specifies the simple EAP-TTLS client authentication methods. The acceptable values for this parameter are: Pap, Chap, MSChap, and MSCHapv2.


Aliases

none

Required?

false

Position?

named

Default Value

Pap

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

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.


Aliases

none

Required?

false

Position?

named

Default Value

False

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

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.


Aliases

none

Required?

false

Position?

3

Default Value

False

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters.

Outputs

The output type is the type of the objects that the cmdlet emits.

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

    The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.
    The VpnConnection object contains the VpnConnection configuration settings.


Examples

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

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft