Edit

Share via

Set-NlbCluster

  • Reference
Module:
NetworkLoadBalancingClusters

Edits the configuration of a NLB cluster.

Syntax

Set-NlbCluster
   [[-HostName] <String>]
   [-InterfaceName] <String>
   [-ClusterPrimaryIP <IPAddress>]
   [-Name <String>]
   [-OperationMode <ClusterMode>]
   [<CommonParameters>]
Set-NlbCluster
   -InputObject <Cluster[]>
   [-ClusterPrimaryIP <IPAddress>]
   [-Name <String>]
   [-OperationMode <ClusterMode>]
   [<CommonParameters>]

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, the cluster name, and the cluster primary IP address.

This operation changes the configuration on all cluster nodes. As a result, the NLB cluster restarts 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: Change the cluster name

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

This command changes the cluster name to NewCluster001.

Example 2: Change the cluster operation mode

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

This command changes the cluster operation mode to MULTICAST.

Example 3: Change the cluster primary IP address

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

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

Parameters

-ClusterPrimaryIP

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.

Type:IPAddress
Aliases:PrimaryIP, PIP
Position:Named
Default value:None
Required:False
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
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Specifies the cluster to set.

Type:Cluster[]
Position:Named
Default value:None
Required:True
Accept pipeline input:True
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:1
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Name

Specifies the new name of the cluster that this cmdlet sets.

Type:String
Aliases:ClusterName
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-OperationMode

Specifies the new operation mode for the cluster. The acceptable values for this parameter are:

  • IGMPMULTICAST
  • MULTICAST
  • UNICAST
Type:ClusterMode
Accepted values:Unicast, Multicast, IgmpMulticast
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.NetworkLoadBalancingClusters.PowerShell.Cluster

Outputs

Microsoft.NetworkLoadBalancingClusters.PowerShell.Cluster