FPCVpnConfiguration Object

The FPCVpnConfiguration object defines the virtual private network (VPN) settings for a Forefront TMG computer that acts as a VPN server in an array. For more information about using VPNs in Forefront TMG, including information about the Forefront TMG VPN quarantine, see Virtual Private Networks.

The FPCVpnConfiguration object is accessed through the VpnConfiguration property of an FPCNetworkConfiguration object.

Click here to see the Forefront TMG object hierarchy.

Inheritance

This object inherits from the FPCPersist object, which contains methods and properties related to persistent storage of an object's data. They include methods for exporting an object's data to and importing it from an XML document.

Methods

The FPCVpnConfiguration object defines the following methods.

Method	Description
SetDNSConfiguration	Sets the primary and backup DNS servers, or specifies that the DNS server name is obtained from a DHCP server.
SetNetworkToObtainDHCP	Sets the name of the network for obtaining DHCP services.
SetWINSConfiguration	Sets the primary and backup WINS servers, or specifies that the WINS server name is obtained from a DHCP server.

Properties

The FPCVpnConfiguration object defines the following properties.

Property	Description
AllowCustomIPSecPolicyForL2TP	Gets or sets a Boolean value that indicates whether incoming L2TP connections may use a custom IPsec policy.
BackupDNSServer	Gets the name of the backup Domain Name System (DNS) server.
BackupWINSServer	Gets the name of the backup Windows Internet Name Service (WINS) server.
DomainGroups	Gets an FPCAccounts collection that contains accounts representing domain groups.
DomainMappings	Gets an FPCDomainMappings collection that contains a set of mappings, each of which defines a mapping of a single domain name to a set of domain names.
EnableL2TP	Gets or sets a Boolean value that indicates whether L2TP is enabled.
EnablePPTP	Gets or sets a Boolean value that indicates whether PPTP is enabled.
EnableRADIUSAccounting	Gets or sets a Boolean value that indicates whether RADIUS accounting is enabled for VPN connections.
EnableRADIUSAuthentication	Gets or sets a Boolean value that indicates whether RADIUS authentication is enabled for authenticating VPN clients.
EnableVpnClients	Gets or sets a Boolean value that indicates whether access for remote VPN clients is enabled.
EnableWindowsAccounting	Gets or sets a Boolean value that indicates whether Windows accounting is enabled for VPN connections.
MaximumVpnClients	Gets or sets the maximum number of concurrent VPN clients.
NetworkSetsToListenOn	Gets an FPCRefs collection of references to the network sets from which VPN clients and remote VPN servers can initiate VPN connections.
NetworksToListenOn	Gets an FPCRefs collection of references to the networks from which VPN clients and remote VPN servers can initiate VPN connections.
NetworkToObtainDHCP	Gets an FPCRef object that references the FPCNetwork object representing the network for obtaining DHCP services.
PPPSettings	Gets an FPCVpnPPPSettings object that represents the PPP settings for a Forefront TMG computer acting as a VPN server.
PresharedIPSecKey	Gets or sets the preshared IPsec key for incoming L2TP connections.
PrimaryDNSServer	Gets the name of the primary DNS server.
PrimaryWINSServer	Gets the name of the primary WINS server.
QuarantineSettings	Gets an FPCVpnQuarantineSettings object that represents the VPN quarantine settings.
RADIUSUserMapping	Gets an FPCUserMapping object that represents the RADIUS user mapping settings for a Forefront TMG computer acting as a VPN server.
StaticAddressPool	Gets an FPCIPRangeSet collection that contains objects defining the IP address ranges in the static address pool from which a VPN server can assign IP addresses to VPN clients connecting to it. (This property is deprecated in Forefront TMG.)
UseDHCPForAddressAssignment	Gets or sets a Boolean value that indicates whether DHCP is used for assigning IP addresses to VPN clients and remote VPN servers.
UseDHCPForDNS	Gets a Boolean value that indicates whether DHCP is used for DNS servers.
UseDHCPForWINS	Gets a Boolean value that indicates whether DHCP is used for WINS servers.

Methods Inherited from FPCPersist

Name	Description
CancelWaitForChanges	Cancels the registration established by the WaitForChanges method (for use in C and C++ programming only).
CanImport	Returns a Boolean value that indicates whether the object's properties can be imported from the specified XML document.
Export	Recursively writes the stored values of all the properties of the object and its subobjects to the specified XML document.
ExportToFile	Recursively writes the stored values of all the properties of the object and its subobjects to the specified XML file.
GetServiceRestartMask	Retrieves a 32-bit bitmask of the FpcServices enumerated type that specifies which services need to be restarted for currently unsaved changes to take effect.
Import	Recursively copies the values of all the properties of the object and of its subobjects from the specified XML document to persistent storage.
ImportFromFile	Recursively copies the values of all the properties of the object and of its subobjects from the specified XML file to persistent storage.
LoadDocProperties	Provides the XML document's properties so that you can know what information can be imported from the document.
Refresh	Recursively reads the values of all the properties of the object and of its subobjects from persistent storage, overwriting any changes that have not been saved.
Save	Recursively writes the current values of all the properties of the object and its subobjects to persistent storage.
WaitForChanges	Registers to wait for an event indicating that the contents of the object have changed (for use in C and C++ programming only).

Properties Inherited from FPCPersist

Name	Description
PersistentName	Gets the persistent name of the object. The persistent name of an object is a name that is unique for the object at the respective level of the COM object hierarchy.
VendorParameterSets	Gets an FPCVendorParametersSets collection that can hold sets of custom data for extending the object.

Interfaces for C++ Programming

This object implements the IFPCVpnConfiguration, IFPCEEVpnConfiguration, and IFPCVpnConfiguration2 interfaces.

Requirements

Client	Requires Windows Vista or Windows XP.
Server	Requires Windows Server 2008.
Version	Requires Forefront Threat Management Gateway (TMG).
IDL	Declared in Msfpccom.idl.