Export (0) Print
Expand All

Set-NlbClusterPortRuleNodeWeight

Windows Server 2012 R2 and Windows 8.1

Updated: October 17, 2013

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

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 <Int32> ] [ <CommonParameters>]

Parameter Set: Pipeline
Set-NlbClusterPortRuleNodeWeight -InputObject <PortRule[]> [-Equal] [-LoadWeight <Int32> ] [ <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.

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

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

E

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

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

Interface,IN,I

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

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

P

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.

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
IPAddress State     Start     End       Protocol  Mode      Affinity  Timeout 
--------- -----     -----     ---       --------  ----      --------  ------- 
All       Enabled   0         65535     Both      Multiple  Single    0 

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
IPAddress State     Start     End       Protocol  Mode      Affinity  Timeout 
--------- -----     -----     ---       --------  ----      --------  ------- 
All       Enabled   0         65535     Both      Multiple  Single    0 
All       Enabled   0         65535     Both      Multiple  Single    0 

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

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft