Set-NlbClusterPortRuleNodeHandlingPriority
Set-NlbClusterPortRuleNodeHandlingPriority
Sets the host priority of a port rule for a specific Network Load Balancing (NLB) node.
Syntax
Parameter Set: NonPipeline
Set-NlbClusterPortRuleNodeHandlingPriority [-Port] <UInt32> -HandlingPriority <Int32> -InterfaceName <String> -IP <IPAddress> [-HostName <String> ] [ <CommonParameters>]
Parameter Set: Pipeline
Set-NlbClusterPortRuleNodeHandlingPriority -HandlingPriority <Int32> -InputObject <PortRule> [ <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.
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 |
hn |
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 |
none |
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 |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
- Microsoft.NetworkLoadBalancingClusters.PowerShell.PortRule
Outputs
The output type is the type of the objects that the cmdlet emits.
- Microsoft.NetworkLoadBalancingClusters.PowerShell.PortRule
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
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