Set-NlbClusterNode

Edits the NLB cluster node settings.

Syntax

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

Description

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

Examples

Example 1: Reload the settings of the NLB driver

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.

Example 2: Set the initial host state of the specified node

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.

Example 3: Change the persist suspend on the reboot settings on a cluster node

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.

Example 4: Change the host priority on a cluster node

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.

Required Parameters

-InputObject

Specifies an array of cluster nodes that this cmdlet sets.

Type:Node[]
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName, ByValue)
Accept wildcard characters:False
-InterfaceName

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

Type:String
Aliases:Interface, IN, I
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Optional Parameters

-Force

Forces the command to run without asking for user confirmation.

Type:SwitchParameter
Aliases:F
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-HostName

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.

Type:String
Aliases:Host, HN, H
Position:0
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-HostPriority

Specifies the host priority or host ID for the cluster node. The acceptable values for this parameter are: 1 through 32.

Type:Int32
Aliases:Priority, HP
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InitialHostState

Specifies the initial host state for the cluster node. The acceptable values for this parameter are:

  • Started
  • Stopped
  • Suspended
Type:NodeInitialHostState
Aliases:IHS, State
Parameter Sets:Started, Stopped, Suspended
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Reload

Indicates that the cmdlet reloads the NLB driver settings on the current cluster node. This cmdlet is only valid for the local NLB cluster node and cannot be used to reload a remote NLB cluster node.

Type:SwitchParameter
Aliases:R
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-RetainSuspended

Indicates whether the cmdlet sets the new retain suspended setting for the cluster node.

Type:Boolean
Aliases:RS
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.NetworkLoadBalancingClusters.PowerShell.Node

Outputs

Microsoft.NetworkLoadBalancingClusters.PowerShell.Node