Edit

Share via

Add-NlbClusterVip

  • Reference
Module:
NetworkLoadBalancingClusters

Adds a virtual IP address to a Network Load Balancing (NLB) cluster.

Syntax

PowerShell 
Add-NlbClusterVip
   [-IP] <IPAddress>
   [-SubnetMask <IPAddress>]
   [-HostName <String>]
   -InterfaceName <String>
   [<CommonParameters>]
PowerShell 
Add-NlbClusterVip
   -InputObject <Cluster[]>
   [-IP] <IPAddress>
   [-SubnetMask <IPAddress>]
   [<CommonParameters>]

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.

ps_nlbc_checkstate_remark

Examples

EXAMPLE 1

PowerShell 
PS C:\>Add-NlbClusterVip -IP fe80::94dc:5e59:3626:f1d4 -InterfaceName vlan-3
IPAddress                               SubnetMask 
---------                               ---------- 
fe80::94dc:5e59:3626:f1d4               ::

This example adds an IPv6 IP address to the list of virtual NLB cluster IP addresses on the network interface vlan-3.

EXAMPLE 2

PowerShell 
PS C:\>Get-NlbCluster | Add-NlbClusterVip -IP fe80::94dc:5e59:3626:f1d4
IPAddress                               SubnetMask 
---------                               ---------- 
fe80::94dc:5e59:3626:f1d4               ::

This example adds an IPv6 IP address to the list of virtual NLB cluster IP addresses on the local cluster.

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.

Type:String
Aliases:Host, HN, H
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Specifies the cluster to which the cluster virtual IP address is added.

Type:Cluster[]
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-InterfaceName

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

Type:String
Aliases:Interface, IN, I
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-IP

Specifies the IP address of the new cluster to which the virtual IP address is added.

Type:IPAddress
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-SubnetMask

Specifies the subnet mask for the virtual IP address of the new cluster.

Type:IPAddress
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.NetworkLoadBalancingClusters.PowerShell.Cluster

Outputs

Microsoft.NetworkLoadBalancingClusters.PowerShell.ClusterVip