Stop-NlbClusterNode
Stops a node in a NLB cluster.
Syntax
NonPipeline (Default)
Stop-NlbClusterNode
[[-HostName] <String>]
[-Drain]
[-Timeout <UInt32>]
[-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 seconds. During that time, new connections will not be established on this node. Any remaining connections after the 10 seconds 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.
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 node to stop.
Parameter properties
| Type: | Node[] |
| 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: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Timeout
Specifies the number of seconds to wait for the drain operation before stopping the cluster node. 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.