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

Remove-NlbClusterPortRule

Brian Lich|Last Updated: 3/31/2017

SYNOPSIS

Removes a port rule from a NLB cluster.

SYNTAX

NonPipeline (Default)

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

Pipeline

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

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.

ps_nlbc_checkstate_remark

EXAMPLES

Example 1: Remove the port rule for a specific port number

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

This command deletes the port rule for port number 4 on the local cluster.

PARAMETERS

-Force

Forces the command to run without asking for user confirmation.

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

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

Type: IPAddress
Parameter Sets: NonPipeline
Aliases: 

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

-InputObject

Specifies the cluster port rule to remove.

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: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PassThru

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.

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

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Port

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

Type: UInt32
Parameter Sets: NonPipeline
Aliases: P

Required: False
Position: 0
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

Disable-NlbClusterPortRule

Enable-NlbClusterPortRule

Get-NlbClusterPortRule

Set-NlbClusterPortRule

© 2017 Microsoft