Table of contents
TLS
TOC
Collapse the table of content
Expand the table of content

Disable-NlbClusterPortRule

Brian Lich|Last Updated: 3/31/2017

SYNOPSIS

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

SYNTAX

NonPipeline (Default)

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

Pipeline

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: 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.

Type: SwitchParameter
Parameter Sets: NonPipeline
Aliases: Cluster, C

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

-Drain

Indicates that the cmdlet drains existing traffic before disabling this port rule. If this parameter is omitted, then existing traffic is dropped.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: D

Required: False
Position: Named
Default value: None
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
Parameter Sets: NonPipeline
Aliases: Host, HN, H

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

-IP

Specifies the IP address for the cluster port rule that this cmdlet disables.

Type: IPAddress
Parameter Sets: NonPipeline
Aliases: 

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

-InputObject

Specifies an array of cluster port rules that this cmdlet disables.

Type: PortRule[]
Parameter Sets: Pipeline
Aliases: 

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
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
Parameter Sets: NonPipeline
Aliases: Interface, IN, I

Required: False
Position: Named
Default value: None
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
Parameter Sets: NonPipeline
Aliases: P

Required: True
Position: 0
Default value: None
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
Parameter Sets: (All)
Aliases: T

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

Microsoft.NetworkLoadBalancingClusters.PowerShell.PortRule

OUTPUTS

Microsoft.NetworkLoadBalancingClusters.PowerShell.PortRule

NOTES

Add-NlbClusterPortRule

Enable-NlbClusterPortRule

Get-NlbClusterPortRule

Remove-NlbClusterPortRule

Set-NlbClusterPortRule

© 2017 Microsoft