Stop-NlbCluster
Stops all nodes of a NLB cluster.
Syntax
NonPipeline (Default)
Stop-NlbCluster
[[-HostName] <String>]
[[-InterfaceName] <String>]
[-Drain]
[-Timeout <UInt32>]
[<CommonParameters>]
Pipeline
Stop-NlbCluster
-InputObject <Cluster[]>
[-Drain]
[-Timeout <UInt32>]
[<CommonParameters>]
Description
The Stop-NlbCluster cmdlet stops all nodes in a Network Load Balancing (NLB) cluster. The cmdlet stops 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.
Examples
Example 1: Stop 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
This example stops all cluster nodes on the local cluster.
Parameters
-Drain
Indicates that the cmdlet drains existing traffic before stopping the cluster. If this parameter is omitted, then the existing traffic is dropped.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | D |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Host, HN, H |
Parameter sets
NonPipeline
| Position: | 0 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-InputObject
Specifies the cluster to stop.
Parameter properties
| Type: | Cluster[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Pipeline
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-InterfaceName
Specifies the interface to which NLB is bound. This is the interface of the cluster against which this cmdlet is run.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Interface, IN, I |
Parameter sets
NonPipeline
| Position: | 1 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Timeout
Specifies the number of minutes to wait for the drain operation before stopping the cluster. After the time expires, the existing connections are dropped.
Parameter properties
| Type: | UInt32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | T |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.