Export (0) Print
Expand All

Set-NlbCluster

Updated: August 15, 2012

Applies To: Windows Server 2012

Set-NlbCluster

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

Syntax

Parameter Set: NonPipeline
Set-NlbCluster [[-HostName] <String> ] [-InterfaceName] <String> [-ClusterPrimaryIP <IPAddress> ] [-Name <String> ] [-OperationMode <Nullable> ] [ <CommonParameters>]

Parameter Set: Pipeline
Set-NlbCluster -InputObject <Cluster> [-ClusterPrimaryIP <IPAddress> ] [-Name <String> ] [-OperationMode <Nullable> ] [ <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

pip, primaryip

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

-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

none

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

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

<CommonParameters>

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

Inputs

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

  • Microsoft.NetworkLoadBalancingClusters.PowerShell.Cluster

Outputs

The output type is the type of the objects that the cmdlet emits.

  • Microsoft.NetworkLoadBalancingClusters.PowerShell.Cluster

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 

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft