Add-NlbClusterVip
Add-NlbClusterVip
Adds a virtual IP address to a Network Load Balancing (NLB) cluster.
Syntax
Parameter Set: NonPipeline
Add-NlbClusterVip [-IP] <IPAddress> -InterfaceName <String> [-HostName <String> ] [-SubnetMask <IPAddress> ] [ <CommonParameters>]
Parameter Set: Pipeline
Add-NlbClusterVip [-IP] <IPAddress> -InputObject <Cluster> [-SubnetMask <IPAddress> ] [ <CommonParameters>]
Detailed Description
The Add-NlbClusterVIP cmdlet adds a virtual IP address to a Network Load Balancing (NLB) cluster. The virtual IP address will appear on all hosts in the cluster. This IP address is used to address the cluster as a whole, and it should be the IP address that maps to the full Internet name that you specify for the cluster.
This cmdlet 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 new cluster to which the virtual IP address is added.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-InputObject<Cluster>
Specifies the cluster to which the cluster virtual IP address is added.
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 |
-SubnetMask<IPAddress>
Specifies the subnet mask for the virtual IP address of the new cluster.
Aliases |
none |
Required? |
false |
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.Cluster
Outputs
The output type is the type of the objects that the cmdlet emits.
- Microsoft.NetworkLoadBalancingClusters.PowerShell.ClusterVip
Examples
EXAMPLE 1
This example adds an IPv6 IP address to the list of virtual NLB cluster IP addresses on the network interface vlan-3.
PS C:\> Add-NlbClusterVip -IP fe80::94dc:5e59:3626:f1d4 -InterfaceName vlan-3
EXAMPLE 2
This example adds an IPv6 IP address to the list of virtual NLB cluster IP addresses on the local cluster.
PS C:\> Get-NlbCluster | Add-NlbClusterVip -IP fe80::94dc:5e59:3626:f1d4