Set-NlbClusterPortRuleNodeHandlingPriority

Article
03/11/2010

Set-NlbClusterPortRuleNodeHandlingPriority

Sets the host priority of a port rule for a specific NLB node.

Syntax

Set-NlbClusterPortRuleNodeHandlingPriority [-Port] <UInt32> -InterfaceName <string> -IP <IPAddress> [-HostName <string>] -HandlingPriority <int> [<CommonParameters>]


Set-NlbClusterPortRuleNodeHandlingPriority -InputObject <PortRule[]> -HandlingPriority <int> [<CommonParameters>]

Detailed Description

The Set-NlbClusterPortRuleNodeHandlingPriority cmdlet sets the host priority of a port rule for a specific NLB node. The host priority specifies a unique ID for each node. The node with the lowest numerical priority among the current members of the cluster handles all of the cluster's network traffic that is not covered by a port rule. You can override these priorities or provide load balancing for specific ranges of ports by specifying rules. If a new node joins the cluster and its priority conflicts with another node in the cluster, the node is not accepted as part of the cluster. The rest of the cluster will continue to handle the traffic.

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

-HandlingPriority <int>

Specifies the handling priority for the cluster node. This is only applicable when the filtering mode of the port rule is single host. [Alias: hp]

Attributes

Name	Value
Required?	true
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 on which the handling priority will be set. This is only applicable when the filtering mode for the port rule is single host.

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 on which the handling priority will be set.

Attributes

Name	Value
Required?	true
Accept wildcard characters?	false
Accept Pipeline Input?	false
Position?	named

-Port <UInt32>

Specifies a port number within the port rule on which the node handling priority will be set. The valid range is between 0 and 65535.

Attributes

Name	Value
Required?	true
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-NlbClusterNode node1 | Get-NlbClusterPortRule | Set-NlbClusterPortRuleNodeHandlingPriority -HandlingPriority 3



IPAddress State     Start     End       Protocol  Mode      Affinity  Timeout

--------- -----     -----     ---       --------  ----      --------  -------

All       Enabled   0         65535     Both      Single

Description

-----------

This command changes the handling priority of the given port rule for node1 to 3. This is applicable for port rules with Single mode.

EXAMPLE 2

C:\PS>

Set-NlbClusterPortRuleNodeHandlingPriority -HostName node1 -Interface vlan-3 -IP 255.255.255.255 -Port 80 -HandlingPriority 4



IPAddress State     Start     End       Protocol  Mode      Affinity  Timeout

--------- -----     -----     ---       --------  ----      --------  -------

All       Enabled   0         65535     Both      Single

Description

-----------

This command changes the handling priority of the given port rule for node1 to 4. This is applicable for port rules with Single mode.

Set-NlbClusterPortRuleNodeHandlingPriority