FPCConnectivityVerifier Object

The FPCConnectivityVerifier object represents a connectivity verifier. A connectivity verifier checks the connectivity from a Forefront TMG computer to another computer, such as an external Web server.

This object is an element of an FPCConnectivityVerifiers collection, and a new object representing a connectivity verifier can be created by calling the Add method of the FPCConnectivityVerifiers collection.

An FPCConnectivityVerifier object that defines the connectivity verifier associated with a server farm can also be accessed through the ConnectivityVerifier property of an FPCServerFarm 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 the persistent storage of an object's data. They include methods for exporting the object's data to and importing it from an XML document.

Methods

The FPCConnectivityVerifier object defines the following methods.

Method	Description
SetConnectivityRequest	Sets the ServerAddress, RequestType, and TCPPort properties of the connectivity verifier object.
SetHTTPConnectivityRequest	Sets the ServerAddress and HostHeader properties of the connectivity verifier object.

Properties

The FPCConnectivityVerifier object defines the following properties.

Property	Description
AlertEnabled	Gets or sets a Boolean value that indicates whether an alert will be issued when the round-trip threshold set in the Threshold property is exceeded.
Description	Gets or sets the description of the connectivity verifier.
Enabled	Gets or sets a Boolean value that indicates whether the connectivity verifier is enabled.
GroupType	Gets or sets a value from the FpcConnectivityGroupType enumerated type that specifies the group type used in Forefront TMG Management to categorize the connectivity verifier according to the type of servers with which connectivity is checked.
HostHeader	Gets the alternative Host header to be used in HTTP GET requests sent by the connectivity verifier.
Name	Gets or sets the name of the connectivity verifier.
RequestType	Gets a value from the FpcRequestType enumerated type that specifies the type of request to be used in the verification operation of the connectivity verifier.
ServerAddress	Gets the address of the server to which connectivity is to be verified.
TCPPort	Gets the TCP port on the remote server to which connectivity is to be verified.
Threshold	Gets or sets the round-trip time threshold for the verification operation, in milliseconds. If the threshold is exceeded, an alert can be issued.

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	Writes the stored values of all of the object's properties to the specified XML document.
ExportToFile	Writes the stored values of all of the object's properties 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	Copies the values of all of the object's properties from the specified XML document to persistent storage.
ImportFromFile	Copies the values of all of the object's properties 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	Reads the values of all of the object's properties from persistent storage, overwriting any changes that have not been saved.
Save	Writes the current values of all of the object's properties 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 object that can hold sets of custom data for extending the object.

Interfaces for C++ Programming

This object implements the IFPCConnectivityVerifier interface.

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.