Set-NlbClusterPortRuleNodeWeight
Set-NlbClusterPortRuleNodeWeight
Sets the load weight of a port rule for a specific Network Load Balancing (NLB) node.
Syntax
Parameter Set: NonPipeline
Set-NlbClusterPortRuleNodeWeight [-Port] <UInt32> -InterfaceName <String> -IP <IPAddress> [-Equal] [-HostName <String> ] [-LoadWeight <Nullable> ] [ <CommonParameters>]
Parameter Set: Pipeline
Set-NlbClusterPortRuleNodeWeight -InputObject <PortRule> [-Equal] [-LoadWeight <Nullable> ] [ <CommonParameters>]
Detailed Description
The Set-NlbClusterPortRuleNodeWeight cmdlet sets the load weight of a port rule for a specific Network Load Balancing (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. Different load weights can be specified for each node in the cluster using the LoadWeight parameter. Or, all nodes can be specified to 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.
Parameters
-Equal
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 hosts.
Aliases |
none |
Required? |
false |
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 load weight 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 load weight will be set. This is only applicable when the port rule filtering mode is Multiple hosts.
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 |
-LoadWeight<Nullable>
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 hosts. The acceptable values for this parameter are: 0 through 100.
Aliases |
w |
Required? |
false |
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 load weight 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 sets the weight for all port rules to equal the load weight on all nodes. This is applicable for port rules using the Multiple hosts. Note that this has to be set on all cluster nodes to achieve the desired effect.
PS C:\> Get-NlbClusterNode | Get-NlbClusterPortRule | Set-NlbClusterPortRuleNodeWeight -Equal
EXAMPLE 2
This example 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 hosts. Note that this has to be set on all cluster nodes to achieve the desired effect.
PS C:\> Get-NlbClusterNode | Get-NlbClusterPortRule –Port 80 | Set-NlbClusterPortRuleNodeWeight -Equal
EXAMPLE 3
This example sets the weight for the specified port rule on the node named node1 to 25. This is applicable for port rules using the Multiple hosts. Note that the weights have to be set on each node.
PS C:\> Get-NlbClusterNode -NodeName node1 | Get-NlbClusterPortRule –Port 80 | Set-NlbClusterPortRuleNodeWeight -LoadWeight 25 | Format-List *