Set-NlbClusterPortRuleNodeWeight

Set-NlbClusterPortRuleNodeWeight

Sets the load weight of a port rule for a specific NLB node.

Syntax

Set-NlbClusterPortRuleNodeWeight [-Port] <UInt32> -InterfaceName <string> -IP <IPAddress> [-HostName <string>] [-Equal] [-LoadWeight <System.Nullable`1[[System.Int32>] [<CommonParameters>]


Set-NlbClusterPortRuleNodeWeight -InputObject <PortRule[]> [-Equal] [-LoadWeight <System.Nullable`1[[System.Int32>] [<CommonParameters>]

Detailed Description

The Set-NlbClusterPortRuleNodeWeight cmdlet sets the load weight of a port rule for a specific NLB node. The load weight applies only for the Multiple hosts filtering mode. When using the Multiple hosts filtering mode, the load weight specifies the relative amount of load-balanced network traffic that this node should handle for the associated port rule. Allowed values range from 0 (zero) to 100. To prevent a host from handling any network traffic, set the load weight to 0 (zero). The actual fraction of traffic handled by each node is computed as the local load weight divided by the sum of all load weights across the cluster. You can specify different load weights for each node in the cluster using the LoadWeight parameter. Or, you can specify that all nodes distribute the network load equally by using the Equal parameter instead of the LoadWeight parameter.

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

-Equal <SwitchParameter>

Sets the port rule weight to Equal on the cluster node. This specifies that all nodes distribute the network load equally. This parameter is only applicable when the port rule filtering mode is multiple host.

Attributes

-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

-InputObject <PortRule[]>

Specifies the cluster port rule on which the load weight will be set. This is only applicable when the port rule filtering mode is multiple host.

Attributes

-InterfaceName <string>

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

Attributes

-IP <IPAddress>

Specifies the IP address for the cluster port rule on which the load weight will be set.

Attributes

-LoadWeight <System.Nullable`1[[System.Int32>

Specifies the load weight for the given port rule to use for this node. This is only applicable when the port rule filtering mode is multiple host. The valid range for the weight is between 0 and 100. [Alias: w]

Attributes

-Port <UInt32>

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

Attributes

-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 | Get-NlbClusterPortRule | Set-NlbClusterPortRuleNodeWeight -Equal



IPAddress State     Start     End       Protocol  Mode      Affinity  Timeout

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

All       Enabled   0         65535     Both      Multiple  Single    0                        

Description

-----------

This command sets the weight for all port rules to equal the load weight on all nodes. This is applicable for port rules using the Multiple host. Note that this has to be set on all cluster nodes to achieve the desired effect.

EXAMPLE 2

C:\PS>

Get-NlbClusterNode | Get-NlbClusterPortRule 80 | Set-NlbClusterPortRuleNodeWeight -Equal



IPAddress State     Start     End       Protocol  Mode      Affinity  Timeout

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

All       Enabled   0         65535     Both      Multiple  Single    0

All       Enabled   0         65535     Both      Multiple  Single    0                        

Description

-----------

This command sets the weight for the specified port rule to equal the load weight on all nodes. This is applicable for port rules using the Multiple host. Note that this has to be set on all cluster nodes to achieve the desired effect.

EXAMPLE 3

C:\PS>

Get-NlbClusterNode node1 | Get-NlbClusterPortRule 80 | Set-NlbClusterPortRuleNodeWeight -LoadWeight 25 | fl *



Cluster          : cluster1

NodeName         : node1

VirtualIPAddress : 255.255.255.255

StartPort        : 0

EndPort          : 65535

Affinity         : Single

FilteringMode    : Multiple

Protocol         : Both

EqualLoad        : True

LoadWeight       : 25

PortState        : Enabled

Priority         :

Timeout          : 0                        

Description

-----------

This command sets the weight for the specified port rule on node1 to 25. This is applicable for port rules using the Multiple host. Note that the weights have to be set on each node.

See Also

Reference

Set-NlbClusterPortRule
Set-NlbClusterPortRuleNodeHandlingPriority
Add-NlbClusterPortRule