Table of contents
TLS
TOC
Collapse the table of content
Expand the table of content

Stop-NlbClusterNode

Brian Lich|Last Updated: 3/31/2017

SYNOPSIS

Stops a node in a NLB cluster.

SYNTAX

NonPipeline (Default)

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

Pipeline

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: Stop a cluster node on the local cluster

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

This command stops the cluster node named Node2 on the local cluster.

Example 2: Stop the local cluster node

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

This command 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.

PARAMETERS

-Drain

Indicates that the cmdlet drains existing traffic before stopping the cluster node. If this parameter is omitted, then the existing traffic is dropped.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: D

Required: False
Position: Named
Default value: None
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
Parameter Sets: NonPipeline
Aliases: Host, HN, H

Required: False
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-InputObject

Specifies the cluster node to stop.

Type: Node[]
Parameter Sets: Pipeline
Aliases: 

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
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
Parameter Sets: NonPipeline
Aliases: Interface, IN, I

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Timeout

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

Type: UInt32
Parameter Sets: (All)
Aliases: T

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

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

INPUTS

Microsoft.NetworkLoadBalancingClusters.PowerShell.Node

OUTPUTS

Microsoft.NetworkLoadBalancingClusters.PowerShell.Node

NOTES

Add-NlbClusterNode

Get-NlbClusterNode

Remove-NlbClusterNode

Resume-NlbClusterNode

Set-NlbClusterNode

Start-NlbClusterNode

Suspend-NlbClusterNode

© 2017 Microsoft