Add-NlbClusterVip
Add-NlbClusterVip
Adds a virtual IP address to an NLB cluster.
Syntax
Add-NlbClusterVIP -InterfaceName <string> [-HostName <string>] [-IP] <IPAddress> [-Subnetmask <IPAddress>] [<CommonParameters>]
Add-NlbClusterVIP -InputObject <Cluster[]> [-IP] <IPAddress> [-Subnetmask <IPAddress>] [<CommonParameters>]
Detailed Description
The Add-NlbClusterVIP cmdlet adds a virtual IP address to an 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 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 if "-HostName ." is used, the local cluster is assumed. [Alias: hn]
Attributes
| Name | Value |
|---|---|
Required? |
false |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
false |
Position? |
named |
-InputObject <Cluster[]>
Specifies the cluster to which the cluster virtual IP address is added.
Attributes
| Name | Value |
|---|---|
Required? |
true |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
true (ByValue, ByPropertyName) |
Position? |
named |
-InterfaceName <string>
Specifies the interface to which NLB is bound. This is the interface of the cluster against which this cmdlet is run.
Attributes
| Name | Value |
|---|---|
Required? |
true |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
false |
Position? |
named |
-IP <IPAddress>
Specifies the IP address of the new cluster to which the virtual IP address is added.
Attributes
| Name | Value |
|---|---|
Required? |
true |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
false |
Position? |
1 |
-Subnetmask <IPAddress>
Specifies the subnet mask for the virtual IP address of the new cluster.
Attributes
| Name | Value |
|---|---|
Required? |
false |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
false |
Position? |
named |
-CommonParameter
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, and OutVariable. For more information, see about_CommonParameters.
Input and Return Types
The input type is the type of the objects that you can pipe to the cmdlet. The return type is the type of the objects that the cmdlet emits.
Examples
EXAMPLE 1
C:\PS>
Add-NlbClusterVip -IP fe80::94dc:5e59:3626:f1d4 -InterfaceName vlan-3
IPAddress SubnetMask
--------- ----------
fe80::94dc:5e59:3626:f1d4 ::
Description
-----------
This command adds an IPv6 IP address to the list of virtual NLB cluster IP addresses on the network interface vlan-3.
EXAMPLE 2
C:\PS>
Get-NlbCluster | Add-NlbClusterVip -IP fe80::94dc:5e59:3626:f1d4
IPAddress SubnetMask
--------- ----------
fe80::94dc:5e59:3626:f1d4 ::
Description
-----------
This command adds an IPv6 IP address to the list of virtual NLB cluster IP addresses on the local cluster.