SetByThirdParty method of the PS_VpnConnection class

Modifies a third party virtual private network (VPN) connection profile.

Syntax


uint32 SetByThirdParty(
  [in]  string                  Name,
  [in]  string                  ServerAddress,
  [in]  boolean                 RememberCredential,
  [in]  boolean                 SplitTunneling,
  [in]  boolean                 PassThru,
  [in]  boolean                 Force,
  [in]  VpnServerAddress        ServerList[],
  [in]  string                  DnsSuffix,
  [in]  uint32                  IdleDisconnectSeconds,
  [in]  string                  PlugInApplicationID,
  [in]  string                  CustomConfiguration,
  [in]  boolean                 ThirdPartyVpn,
  [out] ThirdPartyVpnConnection cmdletOutput
);

Parameters

Name [in]

The name of the third-party VPN connection profile to be modified.

ServerAddress [in]

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.

RememberCredential [in]

True to store the credentials that are supplied upon the first successful connection; otherwise, false.

SplitTunneling [in]

True to enable split tunneling for the VPN connection profile; otherwise, false.

PassThru [in]

True to return the ThirdPartyVpnConnection object that contains the VPN configuration settings; otherwise, false.

Force [in]

True to force the supplying of the preshared key value over an unsecure channel, if L2TP is used; otherwise, false.

ServerList [in]

The VPN servers that the client can connect to.

DnsSuffix [in]

The DNS suffix of the VPN connection.

IdleDisconnectSeconds [in]

The amount of idle time after which a connection is terminated. A value of 0 disables the time-out.

PlugInApplicationID [in]

The identifier of the third party VPN application.

CustomConfiguration [in]

A custom configuration used by third party VPN profiles.

ThirdPartyVpn [in]

True if the cmdlet is being executed for a third party profile; otherwise, false.

cmdletOutput [out]

When this method returns, contains the ThirdPartyVpnConnection object.

Requirements

Minimum supported client

Windows 8.1

Minimum supported server

Windows Server 2012

Namespace

Root\Microsoft\Windows\RemoteAccess\Client

MOF

VPNClientPSProvider.mof

DLL

VPNClientPSProvider.dll

See also

PS_VpnConnection

 

 

Show: