FPCServerFarm Object
The FPCServerFarm object represents a load-balanced cluster of published Web servers.
The FPCServerFarm object representing the server farm associated with a specific Web publishing rule is referenced through the FPCRef object held in the ServerFarm property of the FPCLoadBalancingConfig object accessed through the LoadBalancingConfig property of the FPCWebPublishingProperties object for the applicable Web publishing rule.
The FPCServerFarm object is an element of an FPCServerFarms collection, and a new object representing a server farm can be created by calling the Add method of this collection.
.png "Dd436567.bkbutton(en-us,MSDN.10).png")
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 an object's data to and importing it from XML documents.
Methods
The FPCServerFarm object does not define any methods.
Properties
The FPCServerFarm object defines the following properties.
| Property | Description |
|---|---|
Gets an FPCConnectivityVerifier object that defines the connectivity verifier associated with the server farm. |
|
Gets or sets the description of the server farm. |
|
Gets or sets the name the server farm. |
|
Gets an FPCPublishedServers collection that contains objects representing the published servers defined in the server farm. |
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 properties of the object and its subobjects can be imported from the specified XML document. |
| Export | Writes the stored values of all the properties of the object and its subobjects to the specified XML document. |
| ExportToFile | 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 | Copies the values of all the properties of the object and its subobjects from the specified XML document to persistent storage. |
| ImportFromFile | Copies the values of all the properties of the object and 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 | Reads the values of all the properties of the object and its subobjects from persistent storage, overwriting any changes that have not been saved. |
| Save | 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 object that can hold sets of custom data for extending the object. |
Interfaces for C++ Programming
This object implements the IFPCServerFarm interface.
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. |
See Also
Send comments about this topic to Microsoft
Build date: 6/30/2010