Stop-NlbCluster
Stop-NlbCluster
Stops all nodes of an NLB cluster.
Syntax
Stop-NlbCluster [[-HostName] <string>] [[-InterfaceName] <string>] [-Drain] [-Timeout <System.Nullable`1[[System.UInt32>] [<CommonParameters>]
Stop-NlbCluster -InputObject <Cluster[]> [-Drain] [-Timeout <System.Nullable`1[[System.UInt32>] [<CommonParameters>]
Detailed Description
The Stop-NlbCluster cmdlet stops all nodes in an 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, existing traffic will be dropped.
Attributes
| Name | Value |
|---|---|
Required? |
false |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
false |
Position? |
named |
-HostName <string>
Specifies the name of the cluster host against which this cmdlet is run. If this parameter is omitted or if "-HostName ." is used, the local cluster is assumed. [Alias: hn]
Attributes
| Name | Value |
|---|---|
Required? |
false |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
false |
Position? |
1 |
-InputObject <Cluster[]>
Specifies the cluster to stop.
Attributes
| Name | Value |
|---|---|
Required? |
true |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
true (ByValue, ByPropertyName) |
Position? |
named |
-InterfaceName <string>
Specifies the interface to which NLB is bound. This is the interface of the cluster against which this cmdlet is run.
Attributes
| Name | Value |
|---|---|
Required? |
false |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
false |
Position? |
2 |
-Timeout <System.Nullable`1[[System.UInt32>
Specifies the number of minutes to wait for the drain operation before stopping the cluster. After this time expires, existing connections will be dropped.
Attributes
| Name | Value |
|---|---|
Required? |
false |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
false |
Position? |
named |
-CommonParameter
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, and OutVariable. For more information, see about_CommonParameters.
Input and Return Types
The input type is the type of the objects that you can pipe to the cmdlet. The return type is the type of the objects that the cmdlet emits.
Examples
EXAMPLE 1
C:\PS>
Stop-NlbCluster
Name IPAddress SubnetMask Mode
---- --------- ---------- ----
cluster1 3.53.100.100 255.0.0.0 UNICAST
Description
-----------
This command stops all cluster nodes on the local cluster.
See Also
Reference
Get-NlbCluster
New-NlbCluster
Remove-NlbCluster
Resume-NlbCluster
Set-NlbCluster
Start-NlbCluster
Suspend-NlbCluster