Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Set-NlbClusterNode

Set-NlbClusterNode

microsoft.networkloadbalancingclusters.powershell.dll

Synopsis

Edits the Network Load Balancing (NLB) cluster node settings.

Syntax

Set-NlbClusterNode [-HostName] [-Force] [-HostPriority] [-InitialHostState] [-Reload] [-RetainSuspended] [-InterfaceName] [<CommonParameters>]

Set-NlbClusterNode [-Force] [-HostPriority] [-InitialHostState] [-Reload] [-RetainSuspended] [-InputObject] [<CommonParameters>]

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

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

-Force <SwitchParameter>

Runs the cmdlet without prompting for confirmation. By default the cmdlet will ask for confirmation from the user before proceeding.

Aliases

F

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

1

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-HostPriority <Int32>

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

Aliases

Priority,HP

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-InitialHostState <NodeInitialHostState>

Specifies the initial host state for the cluster node. The acceptable values for this parameter are: Started, Stopped, or Suspended.

Aliases

IHS,State

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-InputObject <Node[]>

Specifies the cluster node to set.

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

-Reload <SwitchParameter>

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

Aliases

R

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-RetainSuspended <Boolean>

Specifies the new retain suspended setting for the cluster node.

Aliases

RS

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

Microsoft.NetworkLoadBalancingClusters.PowerShell.Node

Return Type

Microsoft.NetworkLoadBalancingClusters.PowerShell.Node

Notes

None

Examples

EXAMPLE 1

This example 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 -Reload
Name                State               Interface           HostID 
----                -----               ---------           ------ 
node1               Converging          vlan-3              1 

EXAMPLE 2

This example sets the initial host state of the node named node1 to Suspended.

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

EXAMPLE 3

This example changes the persist suspend on reboot setting on node named node1 to TRUE.

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 

EXAMPLE 4

This example changes the host priority (ID) on the node named node1 to 5.

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 

Online Version
Format-List
Add-NlbClusterNode
Get-NlbClusterNode
Remove-NlbClusterNode
Resume-NlbClusterNode
Start-NlbClusterNode
Stop-NlbClusterNode
Suspend-NlbClusterNode