Set-NlbClusterVip
Set-NlbClusterVip
Edits the virtual IP address of a Network Load Balancing (NLB) cluster.
Syntax
Parameter Set: NonPipeline
Set-NlbClusterVip [-IP] <IPAddress> -InterfaceName <String> -NewIP <IPAddress> [-HostName <String> ] [ <CommonParameters>]
Parameter Set: Pipeline
Set-NlbClusterVip -InputObject <ClusterVip> -NewIP <IPAddress> [ <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.
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 |
hn |
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 |
none |
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 |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
- Microsoft.NetworkLoadBalancingClusters.PowerShell.ClusterVip
Outputs
The output type is the type of the objects that the cmdlet emits.
- Microsoft.NetworkLoadBalancingClusters.PowerShell.ClusterVip
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