Edit

Share via

Disable-NlbClusterPortRule

  • Reference
Module:
NetworkLoadBalancingClusters

Disables a port rule on a Network Load Balancing (NLB) cluster or on a specific host in the cluster.

Syntax

PowerShell 
Disable-NlbClusterPortRule
       [-Drain]
       [-Timeout <UInt32>]
       [-ClusterWide]
       [-HostName <String>]
       [-InterfaceName <String>]
       [-IP <IPAddress>]
       [-Port] <UInt32>
       [<CommonParameters>]
PowerShell 
Disable-NlbClusterPortRule
       -InputObject <PortRule[]>
       [-Drain]
       [-Timeout <UInt32>]
       [<CommonParameters>]

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.

Examples

EXAMPLE 1

PowerShell 
PS C:\>Disable-NlbClusterPortRule -Port 80
IPAddress State     Start     End       Protocol  Mode      Affinity  Timeout 
--------- -----     -----     ---       --------  ----      --------  ------- 
All       Disabled  80        80        Both      Multiple  Single    0

This example disables the port rule for port number 80 on the local cluster.

EXAMPLE 2

PowerShell 
PS C:\>Get-NlbClusterPortRule | Disable-NlbClusterPortRule
IPAddress State     Start     End       Protocol  Mode      Affinity  Timeout 
--------- -----     -----     ---       --------  ----      --------  ------- 
All       Disabled  80        80        Both      Multiple  Single    0

This example disables all port rules on the local cluster.

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.

Type:SwitchParameter
Aliases:Cluster, C
Position:Named
Default value:False
Required: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.

Type:SwitchParameter
Aliases:D
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters: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.

Type:String
Aliases:Host, HN, H
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Specifies the cluster port rule to disable.

Type:PortRule[]
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-InterfaceName

Specifies the interface to which NLB is bound. This is the interface of the cluster against which this cmdlet is run.

Type:String
Aliases:Interface, IN, I
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-IP

Specifies the IP address for the cluster port rule that will be disabled.

Type:IPAddress
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Port

Specifies a port number within the port rule that will be disabled. The acceptable values for this parameter are:0 through 65535.

Type:UInt32
Aliases:P
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters: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.

Type:UInt32
Aliases:T
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.NetworkLoadBalancingClusters.PowerShell.PortRule

Outputs

Microsoft.NetworkLoadBalancingClusters.PowerShell.PortRule