Set-NlbClusterNode
Set-NlbClusterNode
Edits the Network Load Balancing (NLB) cluster node settings.
Syntax
Parameter Set: NonPipeline
Set-NlbClusterNode [[-HostName] <String> ] -InterfaceName <String> [-Force] [-HostPriority <Nullable> ] [-InitialHostState <Nullable> ] [-Reload] [-RetainSuspended <Nullable> ] [ <CommonParameters>]
Parameter Set: Pipeline
Set-NlbClusterNode -InputObject <Node> [-Force] [-HostPriority <Nullable> ] [-InitialHostState <Nullable> ] [-Reload] [-RetainSuspended <Nullable> ] [ <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.
Parameters
-Force
Runs the cmdlet without prompting for confirmation. By default the cmdlet will ask for confirmation from the user before proceeding.
Aliases |
none |
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 |
hn |
Required? |
false |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-HostPriority<Nullable>
Specifies the host priority or host ID for the cluster node. The acceptable values for this parameter are: 1 through 32.
Aliases |
hp, priority |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-InitialHostState<Nullable>
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 |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Reload
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 |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-RetainSuspended<Nullable>
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 |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
- Microsoft.NetworkLoadBalancingClusters.PowerShell.Node
Outputs
The output type is the type of the objects that the cmdlet emits.
- Microsoft.NetworkLoadBalancingClusters.PowerShell.Node
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
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
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 *
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 *