Stop-NlbClusterNode

Article
03/11/2010

Stop-NlbClusterNode

Stops a node in an NLB cluster.

Syntax

Stop-NlbClusterNode [[-HostName] <string>] [-InterfaceName <string>] [-Drain] [-Timeout <System.Nullable`1[[System.UInt32>] [<CommonParameters>]


Stop-NlbClusterNode -InputObject <Node[]> [-Drain] [-Timeout <System.Nullable`1[[System.UInt32>] [<CommonParameters>]

Detailed Description

The Stop-NlbClusterNode cmdlet stops a node in an NLB cluster. When you use the stop the nodes in the cluster, client connections that are already in progress are interrupted. To avoid interrupting active connections, consider using the -drain parameter, which allows the node to continue servicing active connections but disables all new traffic to that node.

Parameters

-Drain <SwitchParameter>

Drains existing traffic before stopping the cluster node. If this parameter is omitted, existing traffic will be dropped.

Attributes

Name	Value
Required?	false
Accept wildcard characters?	false
Accept Pipeline Input?	false
Position?	named

-HostName <string>

Specifies the name of the cluster host against which this cmdlet is run. If this parameter is omitted or if "-HostName ." is used, the local cluster is assumed. [Alias: hn]

Attributes

Name	Value
Required?	false
Accept wildcard characters?	false
Accept Pipeline Input?	false
Position?	1

-InputObject <Node[]>

Specifies the cluster node to stop.

Attributes

Name	Value
Required?	true
Accept wildcard characters?	false
Accept Pipeline Input?	true (ByValue, ByPropertyName)
Position?	named

-InterfaceName <string>

Specifies the interface to which NLB is bound. This is the interface of the cluster against which this cmdlet is run.

Attributes

Name	Value
Required?	false
Accept wildcard characters?	false
Accept Pipeline Input?	false
Position?	named

-Timeout <System.Nullable`1[[System.UInt32>

Specifies the number of seconds to wait for the drain operation before stopping the cluster node. After this time expires, existing connections will be dropped.

Attributes

Name	Value
Required?	false
Accept wildcard characters?	false
Accept Pipeline Input?	false
Position?	named

-CommonParameter

This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, and OutVariable. For more information, see about_CommonParameters.

Input and Return Types

The input type is the type of the objects that you can pipe to the cmdlet. The return type is the type of the objects that the cmdlet emits.

Examples

EXAMPLE 1

C:\PS> 
Stop-NlbClusterNode node2 
 
Name                State               Interface           HostID 
----                -----               ---------           ------ 
node2               Stopped             vlan-3              2

Description

-----------

This command stops cluster node node2 on the local cluster.

EXAMPLE 2

C:\PS> 
Stop-NlbClusterNode -Drain -Timeout 10 
 
Name                State               Interface           HostID 
----                -----               ---------           ------ 
node3               Stopped             vlan-3              3

Description

-----------

This command stops the local cluster node. Before it stops the cluster, it drains all existing connections for up to 10 seconds. During that time, new connections will not be established on this node. Any remaining connections after the 10 seconds will be forcefully terminated.

Stop-NlbClusterNode