VpnCommonConfig class
The VpnCommonConfig class represents the common attributes of the VpnConnection and ThirdPartyVpnConnection objects.
The following syntax is simplified from MOF code and includes all inherited properties.
Syntax
[ClassVersion("1.0"), dynamic, provider("VpnClientPSProvider"), AMENDMENT]
class VpnCommonConfig
{
string Name;
string ProfileType;
string ServerAddress;
string ProvisioningAuthority;
boolean RememberCredential;
boolean SplitTunneling;
string Guid;
string ConnectionStatus;
uint32 IdleDisconnectSeconds;
VpnServerAddress ServerList[];
MSFT_NetRoute Routes[];
VpnConnectionTrigger VpnTrigger;
string DnsSuffix;
VpnConnectionProxy Proxy;
boolean IsAutoTriggerEnabled;
};
Members
The VpnCommonConfig class has these types of members:
Properties
The VpnCommonConfig class has these properties.
-
ConnectionStatus
-
-
Data type: string
-
Access type: Read-only
The connection status of the VPN connection.
-
-
Connected ("Connected")
-
Connected.
-
Connecting ("Connecting")
-
In the process of connecting.
-
Dormant ("Dormant")
-
The connection is dormant.
-
Limited ("Limited")
-
There connection has less than full capabilities.
-
NotConnected ("NotConnected")
-
Not connected.
DnsSuffix
-
Data type: string
-
Access type: Read/write
The DNS suffix of the connection.
Guid
-
Data type: string
-
Access type: Read-only
The GUID of this VPN profile.
IdleDisconnectSeconds
-
Data type: uint32
-
Access type: Read/write
The amount of idle time after which a connection is terminated. A value of 0 disables the time-out.
IsAutoTriggerEnabled
-
Data type: boolean
-
Access type: Read-only
true if the VPN connection is enabled for auto-trigger; false if it is not.
Windows 8 and Windows Server 2012: The property is not available before Windows 8.1 and Windows Server 2012 R2.
Name
-
Data type: string
-
Access type: Read/write
The name of the current VPN connection profile.
ProfileType
-
Data type: string
-
Access type: Read/write
The profile type.
Inbox ("Inbox")
The profile is an inbox profile.
ThirdParty ("ThirdParty")
The profile is a third party profile.
ProvisioningAuthority
-
Data type: string
-
Access type: Read/write
The provisioning authority of the VPN profile.
Windows 8 and Windows Server 2012: The property is not available before Windows 8.1 and Windows Server 2012 R2.
Proxy
-
Data type: VpnConnectionProxy
-
Access type: Read/write
-
Qualifiers: EmbeddedInstance ("VpnConnectionProxy")
The proxy settings of the VPN connection.
RememberCredential
-
Data type: boolean
-
Access type: Read/write
true to store the credentials used for the first successful connection; otherwise, false.
Routes
-
Data type: MSFT_NetRoute array
-
Access type: Read/write
-
Qualifiers: EmbeddedInstance ("MSFT_NetRoute")
The list of routes to plumb on the VPN interface when the VPN profile is connected.
ServerAddress
-
Data type: string
-
Access type: Read/write
The address of the remote VPN server that the client connects to. This address is a URL, a friendly name, an IPv4 address, or an IPv6 address. This should be one of the elements of ServerList.
ServerList
-
Data type: VpnServerAddress array
-
Access type: Read/write
-
Qualifiers: EmbeddedInstance ("VpnServerAddress")
The VPN server list.
SplitTunneling
-
Data type: boolean
-
Access type: Read/write
true to enable split tunneling; false to disable it.
VpnTrigger
-
Data type: VpnConnectionTrigger
-
Access type: Read/write
-
Qualifiers: EmbeddedInstance ("VpnConnectionTrigger")
The trigger properties of the VPN connection.
Requirements
| Minimum supported client |
Windows 8 |
| Minimum supported server |
Windows Server 2012 |
| Namespace |
Root\Microsoft\Windows\RemoteAccess\Client |
| MOF |
|
| DLL |
|