Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Set-NlbClusterVip

Set-NlbClusterVip

microsoft.networkloadbalancingclusters.powershell.dll

Synopsis

Edits the virtual IP address of a Network Load Balancing (NLB) cluster.

Syntax

Set-NlbClusterVip [-IP] [-HostName] [-InterfaceName] [-NewIP] [<CommonParameters>]

Set-NlbClusterVip [-InputObject] [-NewIP] [<CommonParameters>]

Detailed 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 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 a value of . is entered, then the local cluster is assumed.

Aliases

Host,HN,H

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-IP <IPAddress>

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

Aliases

None

Required?

true

Position

1

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-InputObject <ClusterVip[]>

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

Interface,IN,I

Required?

true

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-NewIP <IPAddress>

Specifies the new virtual IP address for the cluster.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

Microsoft.NetworkLoadBalancingClusters.PowerShell.ClusterVip

Return Type

Microsoft.NetworkLoadBalancingClusters.PowerShell.ClusterVip

Notes

None

Examples

EXAMPLE 1

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

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

Online Version
Add-NlbClusterVip
Get-NlbClusterVip
Remove-NlbClusterVip