Edit

Share via


Add-NlbClusterVip

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

Syntax

NonPipeline (Default)

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

Pipeline

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:Host, HN, H

Parameter sets

NonPipeline
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

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

Parameter properties

Type:

Cluster[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Pipeline
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False

-InterfaceName

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:Interface, IN, I

Parameter sets

NonPipeline
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-IP

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

Parameter properties

Type:IPAddress
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SubnetMask

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

Parameter properties

Type:IPAddress
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

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

Inputs

Microsoft.NetworkLoadBalancingClusters.PowerShell.Cluster

Outputs

Microsoft.NetworkLoadBalancingClusters.PowerShell.ClusterVip