FPCNLBCluster Object

The FPCNLBCluster object represents a Network Load Balancing (NLB) cluster for a network and provides access to the configuration settings of the NLB cluster through its properties (available only in Forefront TMG Enterprise Edition).

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

Forefront TMG requires every network adapter in an NLB cluster to have a dedicated IP and a virtual IP address. When the virtual IP address of an NLB cluster is configured in Forefront TMG, NLB integration sets this IP address as the second IP address of all the network adapters attached to the applicable network in the array. Forefront TMG also sets the first IP address in the TCP/IP properties of these network adapters as the default IP address provided it is not equal to the IP address specified in the VIP property.

NLB clusters dynamically distribute the flow of incoming TCP and UDP traffic among the cluster nodes according to a set of traffic-handling rules.

This object is accessed through the NLBCluster property of the FPCNetwork object.

Click here to see the Forefront TMG object hierarchy.

Methods

The FPCNLBCluster object defines the following method.

Method	Description
SetVIPAndMask	Sets the virtual IP address and its mask for the Network Load Balancing (NLB) cluster.

Properties

The FPCNLBCluster object defines the following properties.

Property	Description
AdditionalVIPs	Gets an FPCIPAddresses collection that contains the additional virtual IP addresses of the Network Load Balancing (NLB) cluster.
Mask	Gets the subnet mask for the virtual IP address of the Network Load Balancing (NLB) cluster.
NLBEnabled	Gets or sets a Boolean value that indicates whether Network Load Balancing (NLB) is enabled on the network.
OperationMode	Gets or sets a value from the FpcNLBOperationMode enumerated type that specifies the mode in which Network Load Balancing (NLB) operates.
VIP	Gets the virtual IP address of the Network Load Balancing (NLB) cluster.

Interfaces for C++ Programming

This object implements the IFPCEENLBCluster and IFPCNLBCluster2 interfaces.

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

COM Objects

Send comments about this topic to Microsoft

Build date: 6/30/2010