Set-NlbClusterVip

Edits the virtual IP address of a NLB cluster.

Syntax

Set-NlbClusterVip
   [-HostName <String>]
   -InterfaceName <String>
   [-IP] <IPAddress>
   -NewIP <IPAddress>
   [<CommonParameters>]
Set-NlbClusterVip
   -InputObject <ClusterVip[]>
   -NewIP <IPAddress>
   [<CommonParameters>]

Description

The Set-NlbClusterVIP cmdlet edits the virtual IP address of a Network Load Balancing (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 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 virtual IP address

PS C:\>Get-NlbClusterVip -IP fe80::ad1c:c26a:b9d2:5679 | Set-NlbClusterVip -NewIP fe80::ae34:85b1:d7e9:d51f
IPAddress                               SubnetMask 
---------                               ---------- 
fe80::ae34:85b1:d7e9:d51f                ::

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

Parameters

-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:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Specifies an array of cluster virtual IP address that this cmdlet sets.

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

-IP

Specifies the IP address of the cluster for which this cmdlet sets the virtual IP address.

Type:IPAddress
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-NewIP

Specifies the new virtual IP address for the cluster.

Type:IPAddress
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.NetworkLoadBalancingClusters.PowerShell.ClusterVip

Outputs

Microsoft.NetworkLoadBalancingClusters.PowerShell.ClusterVip