FPCNLBConfiguration object

Applies to: desktop apps only

The FPCNLBConfiguration object represents the Network Load Balancing (NLB) configuration for an array and provides access to the configuration settings for NLB integration through its properties (available only in Forefront TMG Enterprise Edition).

When NLB integration is enabled in an array through the NLBIntegrationEnabled property of this object, the array member network adpaters that are attached to the same network can be configured as an NLB cluster represented by the FPCNLBCluster object on the applicable network. Note that an NLB cluster cannot be created for the following predefined array-level networks: Local Host, Quarantined VPN Clients, and VPN Clients.

For example, when two network adapters on two different Forefront TMG computers are attached to the same network, NLB can be used to distribute requests from that network between the two network adapters.

All of the Forefront TMG computers that participate in NLB in an array form a bidirectional affinity (BDA) team.

This object is accessed through the NLBConfiguration property of the 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 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.

Members

The FPCNLBConfiguration object has these types of members:

• Properties

Properties

The FPCNLBConfiguration object has these properties.

Property	Access type	Description
BDATeamAffinity	Read/write	Gets or sets a value from the FpcNLBAffinity enumerated type that specifies the type of affinity for the bidirectional affinity (BDA) team in the array.
BDATeamMaster	Read-only	Gets the name of the master cluster in the bidirectional affinity (BDA) team for the array.
NLBIntegrationClearUponDisable	Read/write	Gets or sets a Boolean value that indicates whether the Network Load Balancing (NLB) settings will be cleared when NLB integration is disabled.
NLBIntegrationEnabled	Read/write	Gets or sets a Boolean value that indicates whether Network Load Balancing (NLB) integration is enabled in the array.

 

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 collection that can hold sets of custom data for extending the object.

 

Interfaces for C++ Programming

This object implements the IFPCEENLBConfiguration and IFPCNLBConfiguration2 interfaces.

Requirements

Minimum supported client	Windows Vista, None supported
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

See also

COM Objects

 

 

Build date: 7/12/2010