Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Disable-NlbClusterPortRule

Disable-NlbClusterPortRule

microsoft.networkloadbalancingclusters.powershell.dll

Synopsis

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

Syntax

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

Disable-NlbClusterPortRule [-Drain] [-Timeout] [-InputObject] [<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 <SwitchParameter>

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

Cluster,C

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-Drain <SwitchParameter>

Drains existing traffic before disabling this port rule. If this parameter is omitted, then the existing traffic will be dropped.

Aliases

D

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

Host,HN,H

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

Interface,IN,I

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Port <UInt32>

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

Aliases

P

Required?

true

Position

1

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Timeout <UInt32>

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

T

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

Microsoft.NetworkLoadBalancingClusters.PowerShell.PortRule

Return Type

Microsoft.NetworkLoadBalancingClusters.PowerShell.PortRule

Notes

None

Examples

EXAMPLE 1

This example disables the port rule for port number 80 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 

EXAMPLE 2

This example disables 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 

Online Version
Add-NlbClusterPortRule
Enable-NlbClusterPortRule
Get-NlbClusterPortRule
Remove-NlbClusterPortRule
Set-NlbClusterPortRule