Edit

Share via

Stop-NlbClusterNode

  • Reference
Module:
NetworkLoadBalancingClusters

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

Syntax

PowerShell 
Stop-NlbClusterNode
    [-Drain]
    [-Timeout <UInt32>]
    [[-HostName] <String>]
    [-InterfaceName <String>]
    [<CommonParameters>]
PowerShell 
Stop-NlbClusterNode
    -InputObject <Node[]>
    [-Drain]
    [-Timeout <UInt32>]
    [<CommonParameters>]

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.

Examples

EXAMPLE 1

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

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

EXAMPLE 2

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

This example stops the local cluster node. Before this cmdlet stops the cluster, this cmdlet 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.

Parameters

-Drain

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

Type:SwitchParameter
Aliases:D
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-HostName

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.

Type:String
Aliases:Host, HN, H
Position:0
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Specifies the cluster node to stop.

Type:Node[]
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-InterfaceName

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

Type:String
Aliases:Interface, IN, I
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Timeout

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

Type:UInt32
Aliases:T
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.NetworkLoadBalancingClusters.PowerShell.Node

Outputs

Microsoft.NetworkLoadBalancingClusters.PowerShell.Node