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
 

Set-NlbClusterPortRuleNodeHandlingPriority

Set-NlbClusterPortRuleNodeHandlingPriority

microsoft.networkloadbalancingclusters.powershell.dll

Synopsis

Sets the host priority of a port rule for a specific Network Load Balancing (NLB) node.

Syntax

Set-NlbClusterPortRuleNodeHandlingPriority [-Port] [-HostName] [-HandlingPriority] [-InterfaceName] [-IP] [<CommonParameters>]

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

Detailed Description

The Set-NlbClusterPortRuleNodeHandlingPriority cmdlet sets the host priority of a port rule for a specific Network Load Balancing (NLB) node. The host priority specifies a unique identifier (ID) for each node. The node with the lowest numerical priority among the current members of the cluster handles all of the network traffic on the cluster 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, then 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 <Int32>

Specifies the handling priority for the cluster node. This is only applicable when the filtering mode of the port rule is Single host.

Aliases

HP

Required?

true

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

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

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

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

-Port <UInt32>

Specifies a port number within the port rule on which the node handling priority will be set. 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

Input Type

Microsoft.NetworkLoadBalancingClusters.PowerShell.PortRule

Return Type

Microsoft.NetworkLoadBalancingClusters.PowerShell.PortRule

Notes

None

Examples

EXAMPLE 1

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

PS C:\>Get-NlbClusterNode –NodeName node1 | Get-NlbClusterPortRule | Set-NlbClusterPortRuleNodeHandlingPriority -HandlingPriority 3
IPAddress State     Start     End       Protocol  Mode      Affinity  Timeout 
--------- -----     -----     ---       --------  ----      --------  ------- 
All       Enabled   0         65535     Both      Single 

EXAMPLE 2

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

PS C:\>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 

Online Version
Add-NlbClusterPortRule
Set-NlbClusterPortRule
Set-NlbClusterPortRuleNodeWeight