Set-NlbClusterNode

Set-NlbClusterNode
    [[-HostName] <String>]
    -InterfaceName <String>
    [-Reload]
    [-HostPriority <Int32>]
    [-InitialHostState <NodeInitialHostState>]
    [-RetainSuspended <Boolean>]
    [-Force]
    [<CommonParameters>]

Set-NlbClusterNode
    -InputObject <Node[]>
    [-Reload]
    [-HostPriority <Int32>]
    [-InitialHostState <NodeInitialHostState>]
    [-RetainSuspended <Boolean>]
    [-Force]
    [<CommonParameters>]

The Set-NlbClusterNode cmdlet edits the Network Load Balancing (NLB) cluster node settings. The changes you can make include reconfiguring the host priority, the initial host state, and whether to persist suspended states across reboots.

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.

ps_nlbc_checkstate_remark

PS C:\>Get-NlbClusterNode -NodeName "Node1" | Set-NlbClusterNode -Reload
Name                State               Interface           HostID
----                -----               ---------           ------
Node1               Converging          vlan-3              1

This command instructs the NLB driver on the node named Node1 to reload all of its settings. This is required if an administrator wants to force configuration changes through the driver. This cmdlet must be run on Node1 locally.

PS C:\>Get-NlbClusterNode -NodeName "Node1" | Set-NlbClusterNode -InitialHostState Suspended
Name                State               Interface           HostID
----                -----               ---------           ------
Node1               Converging          vlan-3              1

This command sets the initial host state of the node named Node1 to Suspended.

PS C:\>Get-NlbClusterNode -NodeName "Node1" | Set-NlbClusterNode -RetainSuspended $True | Format-List -Property "*"
Cluster                   : newcluster
Name                      : node1
InterfaceName             : vlan-3
Host                      : node1.domain.com
State                     : Converging
HostPriority              : 1
AdapterGuid               : {99757561-22EC-44DA-B6D3-82E16B387D6C}
InitialHostState          : Started
PersistSuspendOnReboot    : True
MaskSourceMac             : True
FilterIcmp                : 0
GreDescriptorTimeout      : 10

This command changes the persist suspend on reboot setting on node named Node1 to $True.

PS C:\>Get-NlbClusterNode -NodeName "Node1" | Set-NlbClusterNode -HostPriority 5 | Format-List -Property "*"
Cluster                   : newcluster
Name                      : node1
InterfaceName             : vlan-3
Host                      : node1.domain.com
State                     : Converging
HostPriority              : 5
AdapterGuid               : {99757561-22EC-44DA-B6D3-82E16B387D6C}
InitialHostState          : Started
PersistSuspendOnReboot    : True
MaskSourceMac             : True
FilterIcmp                : 0
GreDescriptorTimeout      : 10

This command changes the host priority (ID) on the node named Node1 to 5.

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.