Share via


Drain method of the MicrosoftNLB_Cluster class

[This method is available for use in the operating systems specified in the Requirements section. Support for this method was removed in Windows Server 2008. Use the Drain or DrainEx method of the MicrosoftNLB_Node class instead.]

Causes one or more port rule to start draining on all nodes that have remote control enabled.

Syntax

uint32 Drain(
  [in]  uint32 Port,
  [out] uint32 NumNodes
);

Parameters

  • Port [in]
    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.

  • NumNodes [out]
    Returns the number of nodes affected by the operation.

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)

Remarks

To enable remote control for a node, set the RemoteControlEnabled property of the MicrosoftNLB_ClusterSetting class to TRUE.

Requirements

Minimum supported client

None supported

Minimum supported server

None supported

End of server support

Windows Server 2003

Namespace

Root\MicrosoftNLB

MOF

WlbsProv.mof

DLL

WlbsProv.dll

See also

MicrosoftNLB_Cluster

MicrosoftNLB_ClusterSetting

MicrosoftNLB_Node

Drain Method of the MicrosoftNLB_Node Class