Edit

Share via

New-NlbCluster

Module:
NetworkLoadBalancingClusters Module

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

Syntax

Default (Default) 

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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:Name, CN, N

Parameter sets

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

-ClusterPrimaryIP

Specifies the primary cluster IP address for the new cluster.

Parameter properties

Type:IPAddress
Default value:None
Supports wildcards:False
DontShow:False
Aliases:PrimaryIP, IPAddress, IP

Parameter sets

(All)
Position:2
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

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

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

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

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:F

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

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

Parameter sets

(All)
Position:0
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
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

(All)
Position:1
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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

Parameter properties

Type:ClusterMode
Default value:None
Accepted values:Unicast, Multicast, IgmpMulticast
Supports wildcards:False
DontShow:False
Aliases:Mode

Parameter sets

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

-SubnetMask

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

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.

Outputs

Microsoft.NetworkLoadBalancingClusters.PowerShell.Cluster