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
 

Remove-NlbClusterPortRule

Remove-NlbClusterPortRule

microsoft.networkloadbalancingclusters.powershell.dll

Synopsis

Removes a port rule from a Network Load Balancing (NLB) cluster.

Syntax

Remove-NlbClusterPortRule [-Port] [-Force] [-HostName] [-PassThru] [-InterfaceName] [-IP] [<CommonParameters>]

Remove-NlbClusterPortRule [-Force] [-PassThru] [-InputObject] [<CommonParameters>]

Detailed Description

The Remove-NlbClusterPortRule cmdlet removes a port rule from a Network Load Balancing (NLB) cluster. Port rules control how an NLB cluster functions. To maximize the control of various types of TCP/IP traffic, port rules can be set up to control how each port's cluster-network traffic is handled. The number and type of port rules must be exactly the same for each node in the cluster. If a node attempts to join the cluster with a different number of rules or with different rules from the other nodes, then it is not accepted as part of the cluster.

This cmdlet changes the configuration on all cluster nodes. As a result, the NLB cluster will have to restart the convergence process on all nodes to guarantee that configuration changes have been applied on all nodes and that a consistent state is reached. Any additional operations on the NLB cluster should not be initiated until all cluster nodes have completed the convergence process and are back to the converged state.

To check the state of all cluster nodes, use the Get-NlbClusterNode cmdlet. If a configuration change results in the cluster nodes remaining in perpetual convergence, refer to the event log to resolve the configuration inconsistency between the cluster nodes.

Parameters

-Force <SwitchParameter>

Runs the cmdlet without prompting for confirmation. By default the cmdlet will ask for confirmation from the user before proceeding.

Aliases

F

Required?

false

Position

named

Default value

None

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 to remove.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-InputObject <PortRule[]>

Specifies the cluster port rule to remove.

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?

true

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-PassThru <SwitchParameter>

Sends items from the interactive window down the pipeline as input to other cmdlets. By default, this cmdlet does not generate any output. To send items from the interactive window down the pipeline, click to select the items and then click OK. Shift-click and Ctrl-click are supported.

Aliases

Pass

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-Port <UInt32>

Specifies a port number within the port rule to remove. The acceptable values for this parameter are: 0 through 65535.

Aliases

P

Required?

false

Position

1

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 deletes the port rule for port number 4 on the local cluster.

PS C:\>Get-NlbClusterPortRule -Port 4 | Remove-NlbClusterPortRule

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