Disable-NlbClusterPortRule
Disable-NlbClusterPortRule
Disables a port rule on a Network Load Balancing (NLB) cluster or on a specific host in the cluster.
Syntax
Parameter Set: NonPipeline
Disable-NlbClusterPortRule [-Port] <Nullable> [-ClusterWide] [-Drain] [-HostName <String> ] [-InterfaceName <String> ] [-IP <IPAddress> ] [-Timeout <Nullable> ] [ <CommonParameters>]
Parameter Set: Pipeline
Disable-NlbClusterPortRule -InputObject <PortRule> [-Drain] [-Timeout <Nullable> ] [ <CommonParameters>]
Detailed Description
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.
Parameters
-ClusterWide
Disables the given port rule on all cluster nodes. If this parameter is omitted, then the port rule is only disabled on one node.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Drain
Drains existing traffic before disabling this port rule. If this parameter is omitted, then the existing traffic will be dropped.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
false |
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? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-IP<IPAddress>
Specifies the IP address for the cluster port rule that will be disabled.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-InputObject<PortRule>
Specifies the cluster port rule to disable.
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? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Port<Nullable>
Specifies a port number within the port rule that will be disabled. The acceptable values for this parameter are: 0 through 65535.
Aliases |
none |
Required? |
true |
Position? |
1 |
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 the port rule is disabled. 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.PortRule
Outputs
The output type is the type of the objects that the cmdlet emits.
- Microsoft.NetworkLoadBalancingClusters.PowerShell.PortRule
Examples
EXAMPLE 1
This example disables the port rule for port number 80 on the local cluster.
PS C:\> Disable-NlbClusterPortRule -Port 80
EXAMPLE 2
This example disables all port rules on the local cluster.
PS C:\> Get-NlbClusterPortRule | Disable-NlbClusterPortRule