Table of contents
TLS
TOC
Collapse the table of content
Expand the table of content

Add-NlbClusterVip

Brian Lich|Last Updated: 3/31/2017

SYNOPSIS

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

SYNTAX

NonPipeline (Default)

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

Pipeline

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: Add an IPv6 IP address to the list of virtual NLB cluster addresses on the specified network interface

PS C:\>Add-NlbClusterVip -IP fe80::94dc:5e59:3626:f1d4 -InterfaceName Vlan-03
IPAddress                               SubnetMask 
---------                               ---------- 
fe80::94dc:5e59:3626:f1d4               ::

This command adds an IPv6 IP address to the list of virtual NLB cluster IP addresses on the network interface Vlan-03.

Example 2: Add an IPv6 IP address to the list of virtual NLB cluster addresses on the local cluster

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

This command 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
Parameter Sets: NonPipeline
Aliases: Host, HN, H

Required: False
Position: Named
Default value: None
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
Parameter Sets: (All)
Aliases: 

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

-InputObject

Specifies an array of clusters to which this cmdlet adds a cluster virtual IP address.

Type: Cluster[]
Parameter Sets: Pipeline
Aliases: 

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
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
Parameter Sets: NonPipeline
Aliases: Interface, IN, I

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

-SubnetMask

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

Type: IPAddress
Parameter Sets: (All)
Aliases: 

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

Microsoft.NetworkLoadBalancingClusters.PowerShell.Cluster

OUTPUTS

Microsoft.NetworkLoadBalancingClusters.PowerShell.ClusterVip

NOTES

Get-NlbClusterVip

Remove-NlbClusterVip

Set-NlbClusterVip

© 2017 Microsoft