Export (0) Print
Expand All

Stop-NlbClusterNode

Windows Server 2012 R2 and Windows 8.1

Updated: October 17, 2013

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

Stop-NlbClusterNode

Stops a node in a Network Load Balancing (NLB) cluster.

Syntax

Parameter Set: NonPipeline
Stop-NlbClusterNode [[-HostName] <String> ] [-Drain] [-InterfaceName <String> ] [-Timeout <UInt32> ] [ <CommonParameters>]

Parameter Set: Pipeline
Stop-NlbClusterNode -InputObject <Node[]> [-Drain] [-Timeout <UInt32> ] [ <CommonParameters>]




Detailed Description

The Stop-NlbClusterNode cmdlet stops a node in a Network Load Balancing (NLB) cluster. When the nodes are stopped 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

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


Aliases

D

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-HostName<String>

Specifies the name of the cluster host against which this cmdlet is run. If this parameter is omitted or a value of . is entered, then the local cluster is assumed.


Aliases

Host,HN,H

Required?

false

Position?

1

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-InputObject<Node[]>

Specifies the cluster node to stop.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue, ByPropertyName)

Accept Wildcard Characters?

false

-InterfaceName<String>

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


Aliases

Interface,IN,I

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Timeout<UInt32>

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


Aliases

T

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

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

Inputs

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

  • Microsoft.NetworkLoadBalancingClusters.PowerShell.Node

Outputs

The output type is the type of the objects that the cmdlet emits.

  • Microsoft.NetworkLoadBalancingClusters.PowerShell.Node

Examples

EXAMPLE 1

This example stops the cluster node named node2 on the local cluster.


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

EXAMPLE 2

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


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

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft