Set-NlbCluster

  • Article

Set-NlbCluster

Edits the configuration of an NLB cluster.

Syntax

Set-NlbCluster [-InterfaceName] <string> [[-HostName] <string>] [-ClusterPrimaryIP <IPAddress>] [-Name <string>] [-OperationMode <System.Nullable`1[[Microsoft.NetworkLoadBalancingClusters.PowerShell.ClusterMode>] [<CommonParameters>]


Set-NlbCluster -InputObject <Cluster[]> [-ClusterPrimaryIP <IPAddress>] [-Name <string>] [-OperationMode <System.Nullable`1[[Microsoft.NetworkLoadBalancingClusters.PowerShell.ClusterMode>] [<CommonParameters>]

Detailed Description

The Set-NlbCluster cmdlet edits the configuration of an NLB cluster. The configuration changes you can make include the cluster operation mode (multicast 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. This must be one of the existing virtual IP addresses on the cluster. [Alias: primaryip pip]

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

-InputObject <Cluster[]>

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

2

-Name <string>

Specifies the new name of the cluster. [Alias: clustername]

Attributes

Name Value

Required?

false

Accept wildcard characters?

false

Accept Pipeline Input?

false

Position?

named

-OperationMode <System.Nullable`1[[Microsoft.NetworkLoadBalancingClusters.PowerShell.ClusterMode>

Specifies the new operation mode for the cluster. The values for the operation mode can be unicast, multicast, or igmpmulticast.

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-NlbCluster | Set-NlbCluster -Name newcluster



Name                IPAddress           SubnetMask          Mode

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

newcluster          fe80::b349:6945:... ::                  UNICAST

Description

-----------

This command changes the cluster name to newcluster.

EXAMPLE 2

C:\PS>

Get-NlbCluster | Set-NlbCluster -OperationMode multicast



Name                IPAddress           SubnetMask          Mode

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

newcluster          fe80::b349:6945:... ::                  MULTICAST

Description

-----------

This command changes the cluster operation mode to multicast.

EXAMPLE 3

C:\PS>

Get-NlbCluster | Set-NlbCluster -ClusterPrimaryIP 2.53.0.120



Name                IPAddress           SubnetMask          Mode

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

newcluster          2.53.0.120          255.0.0.0           MULTICAST

Description

-----------

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

See Also

Reference

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