Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Add-NlbClusterVip

Add-NlbClusterVip

microsoft.networkloadbalancingclusters.powershell.dll

Synopsis

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

Syntax

Add-NlbClusterVip [-IP] [-HostName] [-SubnetMask] [-InterfaceName] [<CommonParameters>]

Add-NlbClusterVip [-IP] [-SubnetMask] [-InputObject] [<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.

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 a value of . is entered, then the local cluster is assumed.

Aliases

Host,HN,H

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

Interface,IN,I

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

Input Type

Microsoft.NetworkLoadBalancingClusters.PowerShell.Cluster

Return Type

Microsoft.NetworkLoadBalancingClusters.PowerShell.ClusterVip

Notes

None

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
IPAddress                               SubnetMask 
---------                               ---------- 
fe80::94dc:5e59:3626:f1d4               :: 

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
IPAddress                               SubnetMask 
---------                               ---------- 
fe80::94dc:5e59:3626:f1d4               :: 

Online Version
Get-NlbClusterVip
Remove-NlbClusterVip
Set-NlbClusterVip