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

Set-NlbCluster

microsoft.networkloadbalancingclusters.powershell.dll

Synopsis

Edits the configuration of a Network Load Balancing (NLB) cluster.

Syntax

Set-NlbCluster [-HostName] [-InterfaceName] [-ClusterPrimaryIP] [-Name] [-OperationMode] [<CommonParameters>]

Set-NlbCluster [-ClusterPrimaryIP] [-Name] [-OperationMode] [-InputObject] [<CommonParameters>]

Detailed Description

The Set-NlbCluster cmdlet edits the configuration of a Network Load Balancing (NLB) cluster. The configuration changes you can make include the cluster operation mode (MULITCAST or UNICAST), the cluster name, and the cluster primary IP address.

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

-ClusterPrimaryIP <IPAddress>

Specifies the IP address to use as the cluster primary IP address. The IP address must be one of the existing virtual IP addresses on the cluster.

Aliases

PrimaryIP,PIP

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

-InputObject <Cluster[]>

Specifies the cluster 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

2

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Name <String>

Specifies the new name of the cluster.

Aliases

ClusterName

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-OperationMode <ClusterMode>

Specifies the new operation mode for the cluster. The acceptable values for this parameter are: IGMPMULTICAST, MULTICAST, or UNICAST.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

Microsoft.NetworkLoadBalancingClusters.PowerShell.Cluster

Return Type

Microsoft.NetworkLoadBalancingClusters.PowerShell.Cluster

Notes

None

Examples

EXAMPLE 1

This example changes the cluster name to newcluster.

PS C:\>Get-NlbCluster | Set-NlbCluster -Name newcluster
Name                IPAddress           SubnetMask          Mode 
----                ---------           ----------          ---- 
newcluster          fe80::b349:6945:... ::                  UNICAST 

EXAMPLE 2

This example changes the cluster operation mode to MULTICAST.

PS C:\>Get-NlbCluster | Set-NlbCluster -OperationMode MULTICAST
Name                IPAddress           SubnetMask          Mode 
----                ---------           ----------          ---- 
newcluster          fe80::b349:6945:... ::                  MULTICAST 

EXAMPLE 3

This example changes the cluster primary IP address to one of the other cluster virtual IP addresses on the cluster.

PS C:\>Get-NlbCluster | Set-NlbCluster -ClusterPrimaryIP 2.53.0.120
Name                IPAddress           SubnetMask          Mode 
----                ---------           ----------          ---- 
newcluster          2.53.0.120          255.0.0.0           MULTICAST 

Online Version
Get-NlbCluster
New-NlbCluster
Remove-NlbCluster
Resume-NlbCluster
Start-NlbCluster
Stop-NlbCluster
Suspend-NlbCluster