{'Description':'Specifies the name of the VPN connection profile to be created.','In':True}
ServerAddress
string
1
✓
-
{'Description':'Specifies the address of the remote VPN server to which the client will connect. Can be specified as a URL, friendly name, IPv4, or IPv6 address.','In':True}
TunnelType
string
2
✓
-
{'Description':'Specifies the type of tunnel used for the VPN connection. Options include PPTP, L2TP (for L2TP/IPSec), SSTP, IKEv2 and Automatic (IKEv2, L2TP)','In':True,'ValueMap':['Pptp', 'L2tp', 'Ikev2', 'Sstp'],'Values':['Pptp', 'L2tp', 'Ikev2', 'Sstp']}
AllUserConnection
boolean
3
✓
-
{'Description':'Specifies that the VPN connection should be added to the AllUserConnection phone book entries.','In':True}
RememberCredential
boolean
4
✓
-
{'Description':'Specifies whether the credentials supplied at the time of first successful connection should be stored in the cache.','In':True}
IdleDisconnectSeconds
uint32
5
✓
-
{'Description':'Idle time before the VPN connection is disconnected','In':True}
DnsSuffix
string
6
✓
-
{'Description':'DNS suffix of the VPN connection','In':True}
SplitTunneling
boolean
7
✓
-
{'Description':'Specifies that split tunnel should be enabled for the VPN connection profile. If this parameter is not specified, split tunneling is disabled.','In':True}
Force
boolean
8
✓
-
{'Description':'If L2TP is used, enforces supplying the Pre-Shared Key value over unsecure channel. ','In':True}
PassThru
boolean
9
✓
-
{'Description':'Returns the VpnConnection object that contains the VpnConnection configuration settings. ','In':True}
L2tpPsk
string
10
✓
-
{'Description':'Specifies the value of Pre-Shared Key to be used for L2TP authentication. If this parameter is not specified, by default a certificate will be used for L2TP.','In':True}
UseWinlogonCredential
boolean
11
✓
-
{'Description':'Specifies that MSCHAPv2 should be used as the authentication method, and Windows logon credentials should be used automatically when connecting with the VPN connection profile.','In':True}
EapConfigXmlStream
string
12
✓
-
{'Description':'Specifies the contents of the EAP XML configuration file (including the EAP method ID).','In':True}
AuthenticationMethod
string
13
✓
-
{'Description':'Specifies the authentication method to be used for the VPN connection. Available methods include PAP, CHAP, MSCHAPv2, and EAP.','In':True,'ValueMap':['Pap', 'Chap', 'MsChapv2', 'Eap'],'Values':['Pap', 'Chap', 'MsChapv2', 'Eap']}
EncryptionLevel
string
14
✓
-
{'Description':'Specifies the encryption level for the VPN connection.','In':True,'ValueMap':['NoEncryption', 'Optional', 'Required', 'Maximum'],'Values':['NoEncryption', 'Optional', 'Required', 'Maximum']}
MachineCertificateIssuerFilter
uint8
15
✓
-
{'Description':'Certificate issuer filter for IKEv2 machine certificate selection','In':True}
MachineCertificateEKUFilter
string
16
✓
-
{'Description':'EKU filter for IKEv2 machine certificate selection','In':True}
{'Description':'VpnConnection consists of the following fields:
Name (string) Specifies the name of the VPN connection profile.
ServerAddress (string) Specifies the address of the Remote VPN Server.
RememberCredential (boolean) Specifies whether the credentials for the VPN Connection are stored in cache after first successful connection.
SplitTunneling (boolean) Specifies whether split tunneling is enabled or disabled.
UseWinlogonCredential (boolean) Specifies whether the Windows logon user credentials should be automatically for VPN connection profile.
Guid (Guid) Specifies the read-only GUID that represents the phone-book entry
ConnectionStatus (string) Specifies the connection status of the VPN connection profile. Available values: Connected, NotConnected, Connecting, Limited, Dormant
IdleDisconnectSeconds (uint32) Specifies the idle time before the VPN connection is disconnected
ServerList (VpnServerAddress[]) Specifies the address of the Remote VPN Server.
Routes (MSFT_NetRoute[]) Specifies the route to be plumbed.
VpnTrigger (VpnConnectionTrigger) Specifies Trigger properties of VPN connection.
DnsSuffix (string) Specifies the connection specific DNS suffix
AllUserConnection (boolean) Specifies that the VPN connection is in AllUserConnection phone book entries.
TunnelType (string) Specifies the VPN Tunnel Type in the VPN Connection profile. Available values: Automatic, Pptp, L2tp, Sstp, Ikev2
AuthenticationMethod (string[]) Specifies the authentication method set configured for the VPN Connection profile. Available values: Pap, Chap, MsChapv2, Eap
EncryptionLevel (string) Specifies the encryption level for the VPN connection profile. Available values: NoEncrytpion, Optional, Required, Maximum
L2tpIPsecAuth (string) Specifies whether the L2TP/IPSec authentication uses a certificate or Pre-Shared key. Available values: Certificate, Psk
EapConfigXmlStream (XML) Specifies the contents of the XML file containing the EAP Configuration for the VPN connection profile.
NapState (string) Specifies the NAP status for PEAP authentication method. Available values: Success, NotNapCapable, NoConnection, Error
MachineCertifiacateEKUFilter (string[]) Specifies the EKU filters for Machine certificate selection
MachineCertificateIssuerFilter (X509Certificate2) Specifies the Certificate Issuer filter for machine certificate selection
','EmbeddedInstance':'VpnConnection','Out':True}
Description
'Adds a VPN connection to the Connection Manager phonebook. '
{'Description':'VpnCommonConfig consists of the following fields:
Name (string) Specifies the name of the VPN connection profile.
ServerAddress (string) Specifies the address of the Remote VPN Server.
RememberCredential (boolean) Specifies whether the credentials for the VPN Connection are stored in cache after first successful connection.
SplitTunneling (boolean) Specifies whether split tunneling is enabled or disabled.
UseWinlogonCredential (boolean) Specifies whether the Windows logon user credentials should be automatically for VPN connection profile.
Guid (Guid) Specifies the read-only GUID that represents the phone-book entry
ConnectionStatus (string) Specifies the connection status of the VPN connection profile. Available values: Connected, NotConnected, Connecting, Limited, Dormant
IdleDisconnectSeconds (uint32) Specifies the idle time before the VPN connection is disconnected
ServerList (VpnServerAddress[]) Specifies the address of the Remote VPN Server.
Routes (MSFT_NetRoute[]) Specifies the route to be plumbed.
VpnTrigger (VpnConnectionTrigger) Specifies Trigger properties of VPN connection.
DnsSuffix (string) Specifies the connection specific DNS suffix
Inbox GCW profile consist of following additional fields:
AllUserConnection (boolean) Specifies that the VPN connection is in AllUserConnection phone book entries.
TunnelType (string) Specifies the VPN Tunnel Type in the VPN Connection profile. Available values: Automatic, Pptp, L2tp, Sstp, Ikev2
AuthenticationMethod (string[]) Specifies the authentication method set configured for the VPN Connection profile. Available values: Pap, Chap, MsChapv2, Eap
EncryptionLevel (string) Specifies the encryption level for the VPN connection profile. Available values: NoEncrytpion, Optional, Required, Maximum
L2tpIPsecAuth (string) Specifies whether the L2TP/IPSec authentication uses a certificate or Pre-Shared key. Available values: Certificate, Psk
EapConfigXmlStream (XML) Specifies the contents of the XML file containing the EAP Configuration for the VPN connection profile.
NapState (string) Specifies the NAP status for PEAP authentication method. Available values: Success, NotNapCapable, NoConnection, Error
MachineCertifiacateEKUFilter (string[]) Specifies the EKU filters for Machine certificate selection
MachineCertificateIssuerFilter (X509Certificate2) Specifies the Certificate Issuer filter for machine certificate selection
3rd Party profile consist of following additional fields:
PlugInApplicationID (string) Specifies Identifier for the third party application.
CustomConfiguration (string) Specifies custom configuration used by Third Party VPN plugins.
','EmbeddedInstance':'VpnCommonConfig','Out':True}
Description
'Retrieves the VPN connection profile specified by the parameters.'
{'Description':'Specifies the name of the VPN connection profile to be created.','In':True}
ServerAddress
string
1
✓
-
{'Description':'Specifies the address of the remote VPN server to which the client will connect. Can be specified as a URL, friendly name, IPv4, or IPv6 address.','In':True}
RememberCredential
boolean
2
✓
-
{'Description':'Specifies whether the credentials supplied at the time of first successful connection should be stored in the cache.','In':True}
SplitTunneling
boolean
3
✓
-
{'Description':'Specifies that split tunnel should be enabled for the VPN connection profile. If this parameter is not specified, split tunneling is disabled.','In':True}
PassThru
boolean
4
✓
-
{'Description':'Returns the VpnConnection object that contains the VpnConnection configuration settings. ','In':True}
Force
boolean
5
✓
-
{'Description':'If L2TP is used, enforces supplying the Pre-Shared Key value over unsecure channel. ','In':True}
{'Description':'ThirdPartyVpnConnection consists of the following fields:
Name (string) Specifies the name of the VPN connection profile.
ServerAddress (string) Specifies the address of the Remote VPN Server.
RememberCredential (boolean) Specifies whether the credentials for the VPN Connection are stored in cache after first successful connection.
SplitTunneling (boolean) Specifies whether split tunneling is enabled or disabled.
UseWinlogonCredential (boolean) Specifies whether the Windows logon user credentials should be automatically for VPN connection profile.
Guid (Guid) Specifies the read-only GUID that represents the phone-book entry
ConnectionStatus (string) Specifies the connection status of the VPN connection profile. Available values: Connected, NotConnected, Connecting, Limited, Dormant
IdleDisconnectSeconds (uint32) Specifies the idle time before the VPN connection is disconnected
ServerList (VpnServerAddress[]) Specifies the address of the Remote VPN Server.
Routes (MSFT_NetRoute[]) Specifies the route to be plumbed.
VpnTrigger (VpnConnectionTrigger) Specifies Trigger properties of VPN connection.
DnsSuffix (string) Specifies the connection specific DNS suffix
PlugInApplicationID (string) Specifies Identifier for the third party application.
CustomConfiguration (string) Specifies custom configuration used by Third Party VPN plugins.
','EmbeddedInstance':'ThirdPartyVpnConnection','Out':True}
Description
'Adds a Third Party VPN connection to the Connection Manager phonebook. '
implemented
True
static
True
NewByThirdParty method is in 1 class (PS_VpnConnection) of ROOT\Microsoft\Windows\RemoteAccess\Client and in 2 namespaces
{'Description':'VpnCommonConfig consists of the following fields:
Name (string) Specifies the name of the VPN connection profile.
ServerAddress (string) Specifies the address of the Remote VPN Server.
RememberCredential (boolean) Specifies whether the credentials for the VPN Connection are stored in cache after first successful connection.
SplitTunneling (boolean) Specifies whether split tunneling is enabled or disabled.
UseWinlogonCredential (boolean) Specifies whether the Windows logon user credentials should be automatically for VPN connection profile.
Guid (Guid) Specifies the read-only GUID that represents the phone-book entry
ConnectionStatus (string) Specifies the connection status of the VPN connection profile. Available values: Connected, NotConnected, Connecting, Limited, Dormant
IdleDisconnectSeconds (uint32) Specifies the idle time before the VPN connection is disconnected
ServerList (VpnServerAddress[]) Specifies the address of the Remote VPN Server.
Routes (MSFT_NetRoute[]) Specifies the route to be plumbed.
VpnTrigger (VpnConnectionTrigger) Specifies Trigger properties of VPN connection.
DnsSuffix (string) Specifies the connection specific DNS suffix
Inbox GCW profile consist of following additional fields:
AllUserConnection (boolean) Specifies that the VPN connection is in AllUserConnection phone book entries.
TunnelType (string) Specifies the VPN Tunnel Type in the VPN Connection profile. Available values: Automatic, Pptp, L2tp, Sstp, Ikev2
AuthenticationMethod (string[]) Specifies the authentication method set configured for the VPN Connection profile. Available values: Pap, Chap, MsChapv2, Eap
EncryptionLevel (string) Specifies the encryption level for the VPN connection profile. Available values: NoEncrytpion, Optional, Required, Maximum
L2tpIPsecAuth (string) Specifies whether the L2TP/IPSec authentication uses a certificate or Pre-Shared key. Available values: Certificate, Psk
EapConfigXmlStream (XML) Specifies the contents of the XML file containing the EAP Configuration for the VPN connection profile.
NapState (string) Specifies the NAP status for PEAP authentication method. Available values: Success, NotNapCapable, NoConnection, Error
MachineCertifiacateEKUFilter (string[]) Specifies the EKU filters for Machine certificate selection
MachineCertificateIssuerFilter (X509Certificate2) Specifies the Certificate Issuer filter for machine certificate selection
3rd Party profile consist of following additional fields:
PlugInApplicationID (string) Specifies Identifier for the third party application.
CustomConfiguration (string) Specifies custom configuration used by Third Party VPN plugins.
','EmbeddedInstance':'VpnCommonConfig','Out':True}
{'Description':'Specifies the address of the remote VPN server to which the client will connect. Can be specified as a URL, IPv4, or IPv6 address.','In':True}
AllUserConnection
boolean
1
✓
-
{'Description':'Specifies that the VPN connection being modified is in the AllUserConnection phone book entries. ','In':True}
SplitTunneling
boolean
2
✓
-
{'Description':'Specifies that split tunnel should be enabled for the VPN connection profile. ','In':True}
RememberCredential
boolean
3
✓
-
{'Description':'Specifies whether the credentials supplied at the time of first successful connection should be stored in the cache.','In':True}
TunnelType
string
4
✓
-
{'Description':'Specifies the type of tunnel used for the VPN connection. Options include PPTP, L2TP (for L2TP/IPSec), SSTP, IKEv2 and Automatic (IKEv2, L2TP)','In':True,'ValueMap':['Pptp', 'L2tp', 'Sstp', 'Ikev2', 'Automatic'],'Values':['Pptp', 'L2tp', 'Sstp', 'Ikev2', 'Automatic']}
PassThru
boolean
5
✓
-
{'Description':'Returns the VpnConnection object that contains the VpnConnection configuration settings. ','In':True}
Force
boolean
6
✓
-
{'Description':'If L2TP is used, enforces supplying the Pre-Shared Key value over unsecure channel.','In':True}
L2tpPsk
string
7
✓
-
{'Description':'Specifies the value of Pre-Shared Key to be used for L2TP authentication. If this parameter is not specified, by default a certificate will be used for L2TP.','In':True}
AuthenticationMethod
string
8
✓
-
{'Description':'Specifies the authentication method to be used for the VPN connection. Available methods include PAP, CHAP, MSCHAPv2, and EAP.','In':True,'ValueMap':['Pap', 'Chap', 'MsChapv2', 'Eap', 'MachineCertificate'],'Values':['Pap', 'Chap', 'MsChapv2', 'Eap', 'MachineCertificate']}
EapConfigXmlStream
string
9
✓
-
{'Description':'Specifies the contents of the EAP XML configuration file (including the EAP method ID).','In':True}
Name
string
10
✓
-
{'Description':'Specifies the name of the VPN connection profile to be modified. ','In':True}
UseWinlogonCredential
boolean
11
✓
-
{'Description':'Specifies that MSCHAPv2 should be used as the authentication method, and Windows logon credentials should be used automatically when connecting with the VPN connection profile.','In':True}
EncryptionLevel
string
12
✓
-
{'Description':'Specifies the encryption level for the VPN connection.','In':True,'ValueMap':['NoEncryption', 'Optional', 'Required', 'Maximum', 'Custom'],'Values':['NoEncryption', 'Optional', 'Required', 'Maximum', 'Custom']}
MachineCertificateEKUFilter
string
13
✓
-
{'Description':'EKU filter for IKEv2 machine certificate selection','In':True}
MachineCertificateIssuerFilter
uint8
14
✓
-
{'Description':'Certificate issuer filter for IKEv2 machine certificate selection','In':True}
{'Description':'VpnConnection consists of the following fields:
Name (string) Specifies the name of the VPN connection profile.
ServerAddress (string) Specifies the address of the Remote VPN Server.
RememberCredential (boolean) Specifies whether the credentials for the VPN Connection are stored in cache after first successful connection.
SplitTunneling (boolean) Specifies whether split tunneling is enabled or disabled.
UseWinlogonCredential (boolean) Specifies whether the Windows logon user credentials should be automatically for VPN connection profile.
Guid (Guid) Specifies the read-only GUID that represents the phone-book entry
ConnectionStatus (string) Specifies the connection status of the VPN connection profile. Available values: Connected, NotConnected, Connecting, Limited, Dormant
IdleDisconnectSeconds (uint32) Specifies the idle time before the VPN connection is disconnected
ServerList (VpnServerAddress[]) Specifies the address of the Remote VPN Server.
Routes (MSFT_NetRoute[]) Specifies the route to be plumbed.
VpnTrigger (VpnConnectionTrigger) Specifies Trigger properties of VPN connection.
DnsSuffix (string) Specifies the connection specific DNS suffix
AllUserConnection (boolean) Specifies that the VPN connection is in AllUserConnection phone book entries.
TunnelType (string) Specifies the VPN Tunnel Type in the VPN Connection profile. Available values: Automatic, Pptp, L2tp, Sstp, Ikev2
AuthenticationMethod (string[]) Specifies the authentication method set configured for the VPN Connection profile. Available values: Pap, Chap, MsChapv2, Eap
EncryptionLevel (string) Specifies the encryption level for the VPN connection profile. Available values: NoEncrytpion, Optional, Required, Maximum
L2tpIPsecAuth (string) Specifies whether the L2TP/IPSec authentication uses a certificate or Pre-Shared key. Available values: Certificate, Psk
EapConfigXmlStream (XML) Specifies the contents of the XML file containing the EAP Configuration for the VPN connection profile.
NapState (string) Specifies the NAP status for PEAP authentication method. Available values: Success, NotNapCapable, NoConnection, Error
MachineCertifiacateEKUFilter (string[]) Specifies the EKU filters for Machine certificate selection
MachineCertificateIssuerFilter (X509Certificate2) Specifies the Certificate Issuer filter for machine certificate selection
','EmbeddedInstance':'VpnConnection','Out':True}
{'Description':'Specifies the name of the VPN connection profile to be created.','In':True}
ServerAddress
string
1
✓
-
{'Description':'Specifies the address of the remote VPN server to which the client will connect. Can be specified as a URL, friendly name, IPv4, or IPv6 address.','In':True}
RememberCredential
boolean
2
✓
-
{'Description':'Specifies whether the credentials supplied at the time of first successful connection should be stored in the cache.','In':True}
SplitTunneling
boolean
3
✓
-
{'Description':'Specifies that split tunnel should be enabled for the VPN connection profile. If this parameter is not specified, split tunneling is disabled.','In':True}
PassThru
boolean
4
✓
-
{'Description':'Returns the VpnConnection object that contains the VpnConnection configuration settings. ','In':True}
Force
boolean
5
✓
-
{'Description':'If L2TP is used, enforces supplying the Pre-Shared Key value over unsecure channel. ','In':True}
{'Description':'ThirdPartyVpnConnection consists of the following fields:
Name (string) Specifies the name of the VPN connection profile.
ServerAddress (string) Specifies the address of the Remote VPN Server.
RememberCredential (boolean) Specifies whether the credentials for the VPN Connection are stored in cache after first successful connection.
SplitTunneling (boolean) Specifies whether split tunneling is enabled or disabled.
UseWinlogonCredential (boolean) Specifies whether the Windows logon user credentials should be automatically for VPN connection profile.
Guid (Guid) Specifies the read-only GUID that represents the phone-book entry
ConnectionStatus (string) Specifies the connection status of the VPN connection profile. Available values: Connected, NotConnected, Connecting, Limited, Dormant
IdleDisconnectSeconds (uint32) Specifies the idle time before the VPN connection is disconnected
ServerList (VpnServerAddress[]) Specifies the address of the Remote VPN Server.
Routes (MSFT_NetRoute[]) Specifies the route to be plumbed.
VpnTrigger (VpnConnectionTrigger) Specifies Trigger properties of VPN connection.
DnsSuffix (string) Specifies the connection specific DNS suffix
PlugInApplicationID (string) Specifies Identifier for the third party application.
CustomConfiguration (string) Specifies custom configuration used by Third Party VPN plugins.
','EmbeddedInstance':'ThirdPartyVpnConnection','Out':True}
Description
'Adds a Third Party VPN connection to the Connection Manager phonebook. '
implemented
True
static
True
SetByThirdParty method is in 1 class (PS_VpnConnection) of ROOT\Microsoft\Windows\RemoteAccess\Client and in 2 namespaces
Detailed description of PS_VpnConnection properties
'A value that specifies the time, in seconds, after which an idle connection is terminated. Unless the idle time-out is disabled, the entire connection is terminated if the connection is idle for the specified interval.'
'Specifies the value of Pre-Shared Key to be used for L2TP authentication. If this parameter is not specified, by default a certificate will be used for L2TP.'
read
True
write
True
L2tpPsk property is in 1 class (PS_VpnConnection) of ROOT\Microsoft\Windows\RemoteAccess\Client and in 2 namespaces
'This property reflects the NAP (Health) status of the connection if it is configured to use PEAP authentication method and is currently connected to the Remote VPN Server.'
'This flag is only used for MsChapv2/EAP-MsChapv2 Authentication Methods. It indicated whether the User Winlogon Credentials are to be automatically used for connection using the current VPN connection profile.'