Set-NlbClusterVip

Article
03/11/2010

Set-NlbClusterVip

Edits the virtual IP address of an NLB cluster.

Syntax

Set-NlbClusterVIP [-IP] <IPAddress> -InterfaceName <string> [-HostName <string>] -NewIP <IPAddress> [<CommonParameters>]


Set-NlbClusterVIP -InputObject <ClusterVip[]> -NewIP <IPAddress> [<CommonParameters>]

Detailed Description

The Set-NlbClusterVIP cmdlet edits the virtual IP address of an NLB cluster. This cmdlet can be used to edit the IP address and subnet mask for the virtual 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

-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?	named

-InputObject <ClusterVip[]>

Specifies the cluster virtual IP address 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?	named

-IP <IPAddress>

Specifies the IP address of the cluster for which the virtual IP address will be set.

Attributes

Name	Value
Required?	true
Accept wildcard characters?	false
Accept Pipeline Input?	false
Position?	1

-NewIP <IPAddress>

Specifies the new virtual IP address for the cluster.

Attributes

Name	Value
Required?	true
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-NlbClusterVip fe80::ad1c:c26a:b9d2:5679 | Set-NlbClusterVip -NewIP fe80::ae34:85b1:d7e9:d51f



IPAddress                               SubnetMask

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

fe80::ae34:85b1:d7e9:d51f                ::

Description

-----------

This command changes the cluster virtual IP from fe80::ad1c:c26a:b9d2:5679 to fe80::ae34:85b1:d7e9:d51f.

Set-NlbClusterVip