ThirdPartyVpnConnection class

The ThirdPartyVpnConnection class represents third party VPN profiles.ThirdPartyVpnConnection is derived from VpnCommonConfig.

The following syntax is simplified from MOF code and includes all inherited properties.

Syntax

[ClassVersion("1.0.0"), dynamic, provider("VpnClientPSProvider"), AMENDMENT]
class ThirdPartyVpnConnection : VpnCommonConfig
{
  string  ServerAddress;
  string  ProvisioningAuthority;
  boolean RememberCredential;
  boolean SplitTunneling;
  boolean IsAutoTriggerEnabled;
  string  Name;
  string  ProfileType;
  string  Guid;
  string  ConnectionStatus;
  uint32  IdleDisconnectSeconds;
  string  ServerList[];
  string  Routes[];
  string  VpnTrigger;
  string  DnsSuffix;
  string  Proxy;
  string  VpnConfigurationXml;
  string  PlugInApplicationID;
  string  CustomConfiguration;
};

Members

The ThirdPartyVpnConnection class has these types of members:

Properties

The ThirdPartyVpnConnection class has these properties.

ConnectionStatus
Data type: string
Access type: Read-only

The connection status of the VPN connection.

This property is inherited from VpnCommonConfig.

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.

CustomConfiguration
Data type: string
Access type: Read/write

A custom configuration used by third party VPN profiles.

DnsSuffix
Data type: string
Access type: Read/write

The DNS suffix of the connection.

This property is inherited from VpnCommonConfig.

Guid
Data type: string
Access type: Read-only

The GUID of this VPN profile.

This property is inherited from VpnCommonConfig.

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.

This property is inherited from VpnCommonConfig.

IsAutoTriggerEnabled
Data type: boolean
Access type: Read-only

true if the VPN connection is enabled for auto-trigger; false if it is not.

This property is inherited from VpnCommonConfig.

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.

This property is inherited from VpnCommonConfig.

PlugInApplicationID
Data type: string
Access type: Read/write

The identifier of the third party VPN application.

ProfileType
Data type: string
Access type: Read/write

The profile type.

This property is inherited from VpnCommonConfig.

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.

This property is inherited from VpnCommonConfig.

Windows 8 and Windows Server 2012:  The property is not available before Windows 8.1 and Windows Server 2012 R2.

Proxy
Data type: string
Access type: Read/write
Qualifiers: EmbeddedInstance ("VpnConnectionProxy")

The proxy settings of the VPN connection.

This property is inherited from VpnCommonConfig.

RememberCredential
Data type: boolean
Access type: Read/write

true to store the credentials used for the first successful connection; otherwise, false.

This property is inherited from VpnCommonConfig.

Routes
Data type: string 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.

This property is inherited from VpnCommonConfig.

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.

This property is inherited from VpnCommonConfig.

ServerList
Data type: string array
Access type: Read/write
Qualifiers: EmbeddedInstance ("VpnServerAddress")

The VPN server list.

This property is inherited from VpnCommonConfig.

SplitTunneling
Data type: boolean
Access type: Read/write

true to enable split tunneling; false to disable it.

This property is inherited from VpnCommonConfig.

VpnConfigurationXml
Data type: string
Access type: Read-only

An XML representation of this instance, which can be used as input for MSFT_VpnConnection::Set.

VpnTrigger
Data type: string
Access type: Read/write
Qualifiers: EmbeddedInstance ("VpnConnectionTrigger")

The trigger properties of the VPN connection.

This property is inherited from VpnCommonConfig.

Requirements

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Namespace

Root\Microsoft\Windows\RemoteAccess\Client

MOF

VPNClientPSProvider.mof

DLL

VPNClientPSProvider.dll

See also

VpnCommonConfig

 

 

Show: