The Disable-NlbClusterPortRule cmdlet disables a specific port rule on a Network Load Balancing (NLB) cluster or on a specific host in the NLB cluster.
Disabling new traffic handling should be considered for the port rule using the optional Drain parameter.
Specifying the Drain parameter at the cluster level drains the specified ports on all hosts within the cluster, and specifying it at the host level drains the ports on the specific host only.
Examples
Example 1: Disable a port rule for a port number on the local cluster
PS C:\>Disable-NlbClusterPortRule -Port 80
IPAddress State Start End Protocol Mode Affinity Timeout
--------- ----- ----- --- -------- ---- -------- -------
All Disabled 80 80 Both Multiple Single 0
This command disables the port rule for port number 80 on the local cluster.
Example 2: Disable all port rules on the local cluster
PS C:\>Get-NlbClusterPortRule | Disable-NlbClusterPortRule
IPAddress State Start End Protocol Mode Affinity Timeout
--------- ----- ----- --- -------- ---- -------- -------
All Disabled 80 80 Both Multiple Single 0
This command disables all port rules on the local cluster.
Parameters
-ClusterWide
Indicates that the cmdlet disables the given port rule on all cluster nodes.
If this parameter is omitted, then the port rule is only disabled on one node.
Parameter properties
Type:
SwitchParameter
Default value:
None
Supports wildcards:
False
DontShow:
False
Aliases:
Cluster, C
Parameter sets
NonPipeline
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-Drain
Indicates that the cmdlet drains existing traffic before disabling this port rule.
If this parameter is omitted, then 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:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-InputObject
Specifies an array of cluster port rules that this cmdlet disables.
Parameter properties
Type:
PortRule[]
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
-IP
Specifies the IP address for the cluster port rule that this cmdlet disables.
Parameter properties
Type:
IPAddress
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
NonPipeline
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-Port
Specifies a port number within the port rule that will be disabled.
The acceptable values for this parameter are: 0 through 65535.
Parameter properties
Type:
UInt32
Default value:
None
Supports wildcards:
False
DontShow:
False
Aliases:
P
Parameter sets
NonPipeline
Position:
0
Mandatory:
True
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 the port rule is disabled.
After the time expires, the existing connections will be 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.