Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Stop-NlbClusterNode

Stop-NlbClusterNode

microsoft.networkloadbalancingclusters.powershell.dll

Synopsis

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

Syntax

Stop-NlbClusterNode [-HostName] [-Drain] [-InterfaceName] [-Timeout] [<CommonParameters>]

Stop-NlbClusterNode [-Drain] [-Timeout] [-InputObject] [<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 <SwitchParameter>

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

Input Type

Microsoft.NetworkLoadBalancingClusters.PowerShell.Node

Return Type

Microsoft.NetworkLoadBalancingClusters.PowerShell.Node

Notes

None

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 

Online Version
Add-NlbClusterNode
Get-NlbClusterNode
Remove-NlbClusterNode
Resume-NlbClusterNode
Set-NlbClusterNode
Start-NlbClusterNode
Suspend-NlbClusterNode