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-EapConfiguration
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.
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.
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.
Example 4: Create a TTLS customized EAP configuration object
PS C:\> $A = New-EapConfiguration -Ttls
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.
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.
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.EapConfigXmlStream
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.
Example 7: Create an EAP configuration object that uses PEAP authentication
PS C:\> $A = New-EapConfiguration -Peap
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.
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.EapConfigXmlStream
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.
Parameters
-AsJob
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
Parameter properties
Type:
SwitchParameter
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
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.
Parameter properties
Type:
CimSession[]
Default value:
None
Supports wildcards:
False
DontShow:
False
Aliases:
Session
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type:
SwitchParameter
Default value:
False
Supports wildcards:
False
DontShow:
False
Aliases:
cf
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-EnableNap
Indicates that the cmdlet enables Network Access Protection (NAP) for PEAP.
Parameter properties
Type:
SwitchParameter
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
PeapAuth
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-FastReconnect
Specifies whether to enable FastReconnect in the current PEAP configuration.
Specify either $True or $False.
Parameter properties
Type:
Boolean
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
PeapAuth
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-Peap
Indicates that PEAP is used as the authentication method.
Parameter properties
Type:
SwitchParameter
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
PeapAuth
Position:
1
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
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.
Parameter properties
Type:
Int32
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-Tls
Indicates that EAP-TLS, either smart card based or user certificate based, is used as the authentication method.
Parameter properties
Type:
SwitchParameter
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
EapTlsAuth
Position:
1
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-Ttls
Indicates that TTLS is used as the authentication method.
Parameter properties
Type:
SwitchParameter
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
EapTtlsAuth
Position:
1
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-TunneledEapAuthMethod
Specifies the configuration XML for tunneled EAP, EAP-TTLS, or PEAP authentication.
Parameter properties
Type:
XmlDocument
Default value:
None
Supports wildcards:
False
DontShow:
False
Aliases:
TunneledEapAuthMethod
Parameter sets
EapTtlsAuth
Position:
3
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-TunneledNonEapAuthMethod
Specifies the simple EAP-TTLS client authentication methods.
The acceptable values for this parameter are:
Pap
Chap
MSChap
MSCHapv2
Parameter properties
Type:
String
Default value:
None
Accepted values:
Pap, Chap, MSChap, MSChapv2
Supports wildcards:
False
DontShow:
False
Aliases:
TunneledNonEapAuthMethod
Parameter sets
EapTtlsAuth
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
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.
Parameter properties
Type:
SwitchParameter
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
EapTlsAuth
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
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.
Parameter properties
Type:
SwitchParameter
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
EapMsChapv2Auth
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
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.
Parameter properties
Type:
SwitchParameter
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
EapTlsAuth
Position:
2
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
PeapAuth
Position:
2
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Parameter properties
Type:
SwitchParameter
Default value:
False
Supports wildcards:
False
DontShow:
False
Aliases:
wi
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters.
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.