New-EapConfiguration
Generates an XML file with the specified EAP configuration.
Syntax
New-EapConfiguration
[-UseWinlogonCredential]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-WhatIf]
[-Confirm]
[<CommonParameters>] New-EapConfiguration
[-UseWinlogonCredential]
[-Ttls]
[-TunneledNonEapAuthMethod <String>]
[[-TunneledEapAuthMethod] <XmlDocument>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-WhatIf]
[-Confirm]
[<CommonParameters>] New-EapConfiguration
[-Tls]
[-UserCertificate]
[-VerifyServerIdentity]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-WhatIf]
[-Confirm]
[<CommonParameters>] New-EapConfiguration
[-VerifyServerIdentity]
[[-TunneledEapAuthMethod] <XmlDocument>]
[-Peap]
[-EnableNap]
[-FastReconnect <Boolean>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-WhatIf]
[-Confirm]
[<CommonParameters>] 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.
Examples
Example 1: Create a default EAP configuration object
PS C:\> $A = New-EapConfigurationThis 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.
Example 2: Create a customized EAP configuration object
PS C:\> $A = New-EapConfiguration -UseWinlogonCredentialThis 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.
See VPN authentication options and Add connectivity profiles to learn more about VPN authentication methods.
Example 3: Create a TLS customized EAP configuration object
PS C:\> $A = New-EapConfiguration -Tls -VerifyServerIdentity -UserCertificateThis 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.
Example 4: Create a TTLS customized EAP configuration object
PS C:\> $A = New-EapConfiguration -TtlsThis 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.
Example 5: Create a TTLS EAP configuration object with MSCHAPv2 as the client authentication method
PS C:\> $A = New-EapConfiguration -Ttls -TunneledNonEapAuthMethod "MSChapv2" -UseWinlogonCredentialThis 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.
Example 6: Create an EAP configuration object and use it as input
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 *TunneledEapAuthMethod* parameter to use the EapConfigXmlStream created by the first EAP configuration object as the tunnel EAP authentication method.
PS C:\>$A = New-EapConfiguration -Ttls -TunneledEapAuthMethod $B.EapConfigXmlStreamThis set of commands creates an EAP configuration object customized with a TTLS authentication method which uses EAP-TLS as the tunneled client authentication method.
Example 7: Create an EAP configuration object that uses PEAP authentication
PS C:\> $A = New-EapConfiguration -PeapThis 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.
Example 8: Create a customized EAP configuration object and use it as input
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 *TunneledEapAuthMethod* 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 -TunneledEapAuthMethod $b.EapConfigXmlStreamThis 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.
Parameters
-AsJob
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-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.
| Type: | CimSession[] |
| Aliases: | Session |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-EnableNap
Indicates that the cmdlet enables Network Access Protection (NAP) for PEAP.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-FastReconnect
Specifies whether to enable FastReconnect in the current PEAP configuration. Specify either $True or $False.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Peap
Indicates that PEAP is used as the authentication method.
| Type: | SwitchParameter |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ThrottleLimit
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.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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.
| Type: | SwitchParameter |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Ttls
Indicates that TTLS is used as the authentication method.
| Type: | SwitchParameter |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-TunneledEapAuthMethod
Specifies the configuration XML for tunneled EAP, EAP-TTLS, or PEAP authentication.
| Type: | XmlDocument |
| Aliases: | TunneledEapAuthMethod |
| Position: | 3 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TunneledNonEapAuthMethod
Specifies the simple EAP-TTLS client authentication methods. The acceptable values for this parameter are:
- Pap
- Chap
- MSChap
- MSCHapv2
| Type: | String |
| Aliases: | TunneledNonEapAuthMethod |
| Accepted values: | Pap, Chap, MSChap, MSChapv2 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| 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.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| 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.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| 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.
| Type: | SwitchParameter |
| Position: | 2 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Outputs
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.
This cmdlet returns a VpnConnection object that contains the VPN connection configuration settings.