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

New-NlbCluster

Brian Lich|Last Updated: 3/31/2017

SYNOPSIS

Creates a NLB cluster on the specified interface that is defined by the node and network adapter name.

SYNTAX

New-NlbCluster [[-HostName] <String>] [-InterfaceName] <String> [-ClusterName <String>]
 [-ClusterPrimaryIP] <IPAddress> [-SubnetMask <IPAddress>] [-DedicatedIP <IPAddress>]
 [-DedicatedIPSubnetMask <IPAddress>] [-Force] [-OperationMode <ClusterMode>] [<CommonParameters>]

DESCRIPTION

The New-NlbCluster cmdlet creates a Network Load Balancing (NLB) cluster. The following will need to be defined: the node name, the network adapter, primary IP address, dedicated IP address, and the name of the cluster.

EXAMPLES

Example 1: Create a one-node NLB cluster on the current computer

PS C:\>New-NlbCluster -InterfaceName "Vlan-3" -ClusterPrimaryIP 3.53.100.100 -ClusterName "Cluster001"
Name                IPAddress           SubnetMask          Mode 
----                ---------           ----------          ---- 
cluster1            3.53.100.100        255.0.0.0           UNICAST

This command creates a one-node NLB cluster on the current computer. The created cluster is named Cluster001 and has one virtual IP address 3.53.100.100. This assumes that the interface is not DHCP-enabled.

PARAMETERS

-ClusterName

Specifies the name of the new cluster.

Type: String
Parameter Sets: (All)
Aliases: Name, CN, N

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

-ClusterPrimaryIP

Specifies the primary cluster IP address for the new cluster.

Type: IPAddress
Parameter Sets: (All)
Aliases: PrimaryIP, IPAddress, IP

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

-DedicatedIP

Specifies the dedicated IP address to use for the node when creating the new cluster. If this parameter is omitted, then the existing static IP address on the node is used.

Type: IPAddress
Parameter Sets: (All)
Aliases: DIP

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

-DedicatedIPSubnetMask

Specifies the dedicated IP address subnet mask to use for the node when creating the new cluster. If this parameter is omitted, then the existing static IP address subnet mask on the node will be used.

Type: IPAddress
Parameter Sets: (All)
Aliases: DIPSubnetMask

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

-Force

Forces the command to run without asking for user confirmation. This parameter applies if the DHCP setting on the interface needs to be overwritten by the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: F

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

-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: (All)
Aliases: Host, HN, H

Required: False
Position: 0
Default value: None
Accept pipeline input: False
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: (All)
Aliases: Interface, IN, I

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

-OperationMode

Specifies the operation mode for the new cluster. If this parameter is omitted, then the mode is UNICAST. The acceptable values for this parameter are:

  • IGMPMULTICAST
  • MULTICAST
  • UNICAST
Type: ClusterMode
Parameter Sets: (All)
Aliases: Mode
Accepted values: Unicast, Multicast, IgmpMulticast

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

-SubnetMask

Specifies the subnet mask for the new cluster primary IP address.

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

OUTPUTS

Microsoft.NetworkLoadBalancingClusters.PowerShell.Cluster

NOTES

Get-NlbCluster

Get-NlbClusterNodeNetworkInterface

New-NlbClusterIpv6Address

Remove-NlbCluster

Resume-NlbCluster

Set-NlbCluster

Start-NlbCluster

Stop-NlbCluster

Suspend-NlbCluster

© 2017 Microsoft