PreSharedIPSecKey Property of the IFPCVpnConfiguration Interface

Article
08/13/2010

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.

C++

HRESULT put_PreSharedIPSecKey(
    BSTR bstrKey
);
HRESULT get_PreSharedIPSecKey(
    BSTR* pbstrKey
);

Parameters

bstrKey
BSTR that specifies the IPsec key for incoming L2TP connections.
pbstrKey
Pointer to a BSTR that is set on return to a string value specifying the IPsec key for incoming L2TP connections.

Return Value

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

Visual Basic

Property PreSharedIPSecKey As String

Property Value

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

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

Client	Requires Windows 7 or Windows Vista.
Server	Requires Windows Server 2008 R2 or Windows Server 2008 x64 Edition with SP2.
Version	Requires Forefront Threat Management Gateway (TMG) 2010.
IDL	Declared in Msfpccom.idl.
DLL	Requires Msfpccom.dll.

Share via