IFPCVpnConfiguration::PreSharedIPSecKey property

Article
08/27/2012

Applies to: desktop apps only

The PreSharedIPSecKey property gets or sets the preshared IPsec key for incoming L2TP connections. A preshared key is a string of text that is configured on both the VPN client and the VPN server. A preshared key provides a relatively weak authentication method. Therefore, we recommend using it only in the interim when your public key infrastructure (PKI) is being deployed to obtain computer certificates, or when a preshared key is required by VPN clients.

This property is read/write.

Syntax

HRESULT put_PreSharedIPSecKey(
  BSTR bstrKey
);

HRESULT get_PreSharedIPSecKey(
  BSTR *pbstrKey
);

' Data type: String

Property PreSharedIPSecKey( _
  ByVal bstrKey As BSTR, _
  ByVal pbstrKey As BSTR _
) As String

Property value

String value that specifies the IPsec key for incoming L2TP connections.

Error codes

These property methods return S_OK if the call is successful; otherwise, they return an error code.

Remarks

This property is read/write. Its default value is an empty string.

The preshared key will be used only if the AllowCustomIPSecPolicyForL2TP property is set to True (VARIANT_TRUE in C++).

Requirements

Minimum supported client	Windows Vista
Minimum supported server	Windows Server 2008 R2, Windows Server 2008 with SP2 (64-bit only)
Version	Forefront Threat Management Gateway (TMG) 2010
IDL	Msfpccom.idl
DLL	Msfpccom.dll

Share via