Edit

Share via


Set-NlbClusterVip

Edits the virtual IP address of a NLB cluster.

Syntax

NonPipeline (Default)

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

Pipeline

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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:Host, HN, H

Parameter sets

NonPipeline
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

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

Parameter properties

Type:

ClusterVip[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Pipeline
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False

-InterfaceName

Specifies the interface to which NLB is bound. This is the interface of the cluster against which this cmdlet is run.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:Interface, IN, I

Parameter sets

NonPipeline
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-IP

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

Parameter properties

Type:IPAddress
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

NonPipeline
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-NewIP

Specifies the new virtual IP address for the cluster.

Parameter properties

Type:IPAddress
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Microsoft.NetworkLoadBalancingClusters.PowerShell.ClusterVip

Outputs

Microsoft.NetworkLoadBalancingClusters.PowerShell.ClusterVip