IFPCEENLBCluster::SetVIPAndMask method

Article
08/27/2012

Applies to: desktop apps only

The SetVIPAndMask method sets the virtual IP address and its mask for the Network Load Balancing (NLB) cluster.

Syntax

HRESULT SetVIPAndMask(
  [in]  BSTR newIPAddress,
  [in]  BSTR newIPMask
);

FPCNLBCluster.SetVIPAndMask( _
  ByVal newIPAddress As String, _
  ByVal newIPMask As String _
)

Parameters

newIPAddress [in]

C++ BSTR that specifies the virtual IP address for the NLB cluster in dotted-decimal format.

VB String that specifies the virtual IP address for the NLB cluster in dotted-decimal format.

newIPMask [in]

C++	BSTR that specifies the mask of the virtual IP address for the NLB cluster in dotted-decimal format.
VB	String that specifies the mask of the virtual IP address for the NLB cluster in dotted-decimal format.

Return value

C++

This method returns S_OK if the call is successful; otherwise, it returns an error code.

VB

This method has no return values. If the call is unsuccessful, an error is raised that can be intercepted by using an error handler.

Remarks

This method sets the VIP and Mask properties and instructs NLB integration to set the virtual IP address specified as the second IP address of all the network adapters attached to the applicable network in the array.

The virtual IP address specified in newIPAddress must belong to the network.

The binary value of the subnet mask specified in newIPMask should consist of a series of ones followed by a series of zeros. These series of bits separate the IP address specified in newIPAddress into two parts. The first part specifies a network address, and the bits of the second part are reserved for all of the possible host addresses in the network segment. The combination of the virtual IP address and the subnet mask must specify the same network address as do the combinations of the dedicated IP addresses and subnet masks of the array member network adapters attached to the network.

The subnet mask typically consists of zero, one, two, or three binary octets that are represented in dotted-decimal format by the decimal number 255 and one binary octet that contains a series of ones (which may be empty) followed by a series of zeros and is represented by one of the following decimal numbers:

Note All additional virtual IP addresses that are configured through the AdditionalVIPs property must be removed before changing the primary virtual IP address of an NLB cluster by calling this method or by programmatically importing the primary virtual IP address from a stored configuration.

Requirements

Minimum supported client	Windows Vista
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
DLL	Msfpccom.dll

Share via