Set-NlbClusterNode

Article
03/11/2010

Set-NlbClusterNode

Edits the NLB cluster node settings.

Syntax

Set-NlbClusterNode -InterfaceName <string> [[-HostName] <string>] [-Force] [-HostPriority <System.Nullable`1[[System.Int32>] [-InitialHostState <System.Nullable`1[[Microsoft.NetworkLoadBalancingClusters.PowerShell.NodeInitialHostState>] [-Reload] [-RetainSuspended <System.Nullable`1[[System.Boolean>] [<CommonParameters>]


Set-NlbClusterNode -InputObject <Node[]> [-Force] [-HostPriority <System.Nullable`1[[System.Int32>] [-InitialHostState <System.Nullable`1[[Microsoft.NetworkLoadBalancingClusters.PowerShell.NodeInitialHostState>] [-Reload] [-RetainSuspended <System.Nullable`1[[System.Boolean>] [<CommonParameters>]

Detailed Description

The Set-NlbClusterNode cmdlet edits the 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>

Performs the operation without prompting for confirmation. By default, this operation will seek confirmation from the user before proceeding.

Attributes

Name	Value
Required?	false
Accept wildcard characters?	false
Accept Pipeline Input?	false
Position?	named

-HostName <string>

Specifies the name of the cluster host against which this cmdlet is run. If this parameter is omitted or if "-HostName ." is used, the local cluster is assumed. [Alias: hn]

Attributes

Name	Value
Required?	false
Accept wildcard characters?	false
Accept Pipeline Input?	false
Position?	1

-HostPriority <System.Nullable`1[[System.Int32>

Specifies the host priority or host ID for the cluster node. The value should be between 1 and 32. [Alias: hp priority]

Attributes

Name	Value
Required?	false
Accept wildcard characters?	false
Accept Pipeline Input?	false
Position?	named

-InitialHostState <System.Nullable`1[[Microsoft.NetworkLoadBalancingClusters.PowerShell.NodeInitialHostState>

Specifies the initial host state for the cluster node. The value is either started, stopped, or suspended. [Alias: ihs state]

Attributes

Name	Value
Required?	false
Accept wildcard characters?	false
Accept Pipeline Input?	false
Position?	named

-InputObject <Node[]>

Specifies the cluster node to set.

Attributes

Name	Value
Required?	true
Accept wildcard characters?	false
Accept Pipeline Input?	true (ByValue, ByPropertyName)
Position?	named

-InterfaceName <string>

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

Attributes

Name	Value
Required?	true
Accept wildcard characters?	false
Accept Pipeline Input?	false
Position?	named

-Reload <SwitchParameter>

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

Attributes

Name	Value
Required?	false
Accept wildcard characters?	false
Accept Pipeline Input?	false
Position?	named

-RetainSuspended <System.Nullable`1[[System.Boolean>

Specifies the new retain suspended setting for the cluster node. [Alias: rs]

Attributes

Name	Value
Required?	false
Accept wildcard characters?	false
Accept Pipeline Input?	false
Position?	named

-CommonParameter

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

Input and Return Types

The input type is the type of the objects that you can pipe to the cmdlet. The return type is the type of the objects that the cmdlet emits.

Examples

EXAMPLE 1

C:\PS>

Get-NlbClusterNode node1 | Set-NlbClusterNode -Reload



Name                State               Interface           HostID

----                -----               ---------           ------

node1               Converging          vlan-3              1

Description

-----------

This command instructs the NLB driver on node1 to reload all its settings. This is required if an administrator wants to force configuration changes through the driver. You have to run this command on node1 locally.

EXAMPLE 2

C:\PS>

Get-NlbClusterNode node1 | Set-NlbClusterNode -InitialHostState Suspended



Name                State               Interface           HostID

----                -----               ---------           ------

node1               Converging          vlan-3              1

Description

-----------

This command sets the initial host state of node1 to suspended.

EXAMPLE 3

C:\PS>

Get-NlbClusterNode node1| Set-NlbClusterNode -RetainSuspended $TRUE | fl *



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

Description

-----------

This command changes the persist suspend on reboot setting on node1 to TRUE.

EXAMPLE 4

C:\PS>

Get-NlbClusterNode node1 | Set-NlbClusterNode -HostPriority 5 | fl *



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

Description

-----------

This command changes the host priority (ID) on node1 to 5.

Share via

Set-NlbClusterNode