Remove-NlbClusterPortRule

Remove-NlbClusterPortRule

Removes a port rule from an NLB cluster.

Syntax

Remove-NlbClusterPortRule -InterfaceName <string> -IP <IPAddress> [[-Port] <System.Nullable`1[[System.UInt32>] [-HostName <string>] [-Force] [-PassThru] [<CommonParameters>]


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

Detailed Description

The Remove-NlbClusterPortRule cmdlet removes a port rule from an NLB cluster. Port rules control how an NLB cluster functions. To maximize the control of various types of TCP/IP traffic, you can set up port rules 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, it is not accepted as part of the cluster.

This operation 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>

Performs the operation without prompting for confirmation. By default, this operation will seek confirmation from the user before proceeding.

Attributes

Name Value

Required?

false

Accept wildcard characters?

false

Accept Pipeline Input?

false

Position?

named

-HostName <string>

Specifies the name of the cluster host against which this cmdlet is run. If this parameter is omitted or if "-HostName ." is used, the local cluster is assumed. [Alias: hn]

Attributes

Name Value

Required?

false

Accept wildcard characters?

false

Accept Pipeline Input?

false

Position?

named

-InputObject <PortRule[]>

Specifies the cluster port rule to remove.

Attributes

Name Value

Required?

true

Accept wildcard characters?

false

Accept Pipeline Input?

true (ByValue, ByPropertyName)

Position?

named

-InterfaceName <string>

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

Attributes

Name Value

Required?

true

Accept wildcard characters?

false

Accept Pipeline Input?

false

Position?

named

-IP <IPAddress>

Specifies the IP address for the cluster port rule to remove.

Attributes

Name Value

Required?

true

Accept wildcard characters?

false

Accept Pipeline Input?

false

Position?

named

-PassThru <SwitchParameter>

Causes the cmdlet to pass the object through to the pipeline.

Attributes

Name Value

Required?

false

Accept wildcard characters?

false

Accept Pipeline Input?

true (ByPropertyName)

Position?

named

-Port <System.Nullable`1[[System.UInt32>

Specifies a port number within the port rule to remove. The valid range is between 0 and 65535.

Attributes

Name Value

Required?

false

Accept wildcard characters?

false

Accept Pipeline Input?

false

Position?

1

-CommonParameter

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

Input and Return Types

The input type is the type of the objects that you can pipe to the cmdlet. The return type is the type of the objects that the cmdlet emits.

Examples

EXAMPLE 1

C:\PS>

Get-NlbClusterPortRule -Port 4 | Remove-NlbClusterPortRule                        

Description

-----------

This command deletes port rule 4 on the local cluster.

See Also

Reference

Add-NlbClusterPortRule
Disable-NlbClusterPortRule
Enable-NlbClusterPortRule
Get-NlbClusterPortRule
Set-NlbClusterPortRule