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-NlbCluster

Stop-NlbCluster

microsoft.networkloadbalancingclusters.powershell.dll

Synopsis

Stops all nodes of a Network Load Balancing (NLB) cluster.

Syntax

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

Stop-NlbCluster [-Drain] [-Timeout] [-InputObject] [<CommonParameters>]

Detailed Description

The Stop-NlbCluster cmdlet stops all nodes in a Network Load Balancing (NLB) cluster. The cmdlet will stop the NLB service on the host and all existing connections will be lost. To avoid interrupting active connections, use the Drain parameter which allows the host to continue servicing active connections, but disables all new traffic to that host.

Parameters

-Drain <SwitchParameter>

Drains existing traffic before stopping the cluster. 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 <Cluster[]>

Specifies the cluster 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

2

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. 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.Cluster

Return Type

Microsoft.NetworkLoadBalancingClusters.PowerShell.Cluster

Notes

None

Examples

EXAMPLE 1

This example stops all cluster nodes on the local cluster.

PS C:\>Stop-NlbCluster
Name                IPAddress           SubnetMask          Mode 
----                ---------           ----------          ---- 
cluster1            3.53.100.100        255.0.0.0           UNICAST 

Online Version
Get-NlbCluster
New-NlbCluster
Remove-NlbCluster
Resume-NlbCluster
Set-NlbCluster
Start-NlbCluster
Suspend-NlbCluster