DrainEx method of the MicrosoftNLB_Node class

Disables new traffic handling for rule containing the specified virtual IP address and port. The values of virtual IP address to specify 'All Vip' (AKA 'Rest of the VIPs') and 'Every Vip' are '255.255.255.255' and '0.0.0.0' respectively. Port may take any value from 0 to 65,535 or 0xFFFFFFFF to specify all ports.This method fails when called on instances of objects that represent remote nodes.

Syntax


uint32 DrainEx(
  [in] string VirtualIpAddress,
  [in] uint32 Port
);

Parameters

VirtualIpAddress [in]

One or more virtual IP addresses to be affected by the operation.

Port [in]

The range of the ports to be drained. To affect a range of ports, set Port to a port number (0 to 65,535). All ports in the port rule containing the specified port number will be affected. To affect all ports, set Port to 0xFFFFFFFF.

Return value

This method returns a uint32 set to one of the standard return values.

WLBS_OK (1000)
WLBS_NOT_FOUND (1004)
WLBS_SUSPENDED (1013)
WLBS_ALREADY (1001)
WLBS_STOPPED (1005)
WLBS_DRAINING (1009)

Remarks

This method will fail if called on an instance of a MicrosoftNLB_Node object that represents a remote node.

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2008

Namespace

Root\MicrosoftNLB

MOF

WlbsProv.mof

DLL

WlbsProv.dll

See also

MicrosoftNLB_Node
MicrosoftNLB_ClusterSetting
Drain Method of the MicrosoftNLB_Node Class

 

 

Show: