Stop-NlbCluster
Stop-NlbCluster
Stops all nodes of a Network Load Balancing (NLB) cluster.
Syntax
Parameter Set: NonPipeline
Stop-NlbCluster [[-HostName] <String> ] [[-InterfaceName] <String> ] [-Drain] [-Timeout <Nullable> ] [ <CommonParameters>]
Parameter Set: Pipeline
Stop-NlbCluster -InputObject <Cluster> [-Drain] [-Timeout <Nullable> ] [ <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
Drains existing traffic before stopping the cluster. If this parameter is omitted, then the existing traffic will be dropped.
Aliases |
none |
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 |
hn |
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 |
none |
Required? |
false |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Timeout<Nullable>
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 |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
- Microsoft.NetworkLoadBalancingClusters.PowerShell.Cluster
Outputs
The output type is the type of the objects that the cmdlet emits.
- Microsoft.NetworkLoadBalancingClusters.PowerShell.Cluster
Examples
EXAMPLE 1
This example stops all cluster nodes on the local cluster.
PS C:\> Stop-NlbCluster