Share via

New-NlbCluster

  • Article

New-NlbCluster

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

Syntax

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

Detailed Description

The New-NlbCluster cmdlet creates a new NLB cluster. You will need to define the node name, the network adapter, primary IP address, dedicated IP address, and the name of the cluster.

Parameters

-ClusterName <string>

Specifies the name of the new cluster. [Alias: name]

Attributes

Name Value

Required?

false

Accept wildcard characters?

false

Accept Pipeline Input?

false

Position?

named

-ClusterPrimaryIP <IPAddress>

Specifies the primary cluster IP address for the new cluster. [Aliases: ip primaryip ipaddress]

Attributes

Name Value

Required?

true

Accept wildcard characters?

false

Accept Pipeline Input?

false

Position?

3

-DedicatedIP <IPAddress>

Specifies the dedicated IP address to use for the node when creating the new cluster. If this parameter is omitted, the existing static IP address on the node will be used. [Alias: dip]

Attributes

Name Value

Required?

false

Accept wildcard characters?

false

Accept Pipeline Input?

false

Position?

named

-DedicatedIPSubnetMask <IPAddress>

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

Attributes

Name Value

Required?

false

Accept wildcard characters?

false

Accept Pipeline Input?

false

Position?

named

-Force <SwitchParameter>

Performs the operation without prompting for confirmation. By default, this operation will seek confirmation from the user before proceeding. This parameter applies if the DHCP setting on the interface needs to be overwritten by the cmdlet.

Attributes

Name Value

Required?

false

Accept wildcard characters?

false

Accept Pipeline Input?

false

Position?

named

-HostName <string>

Specifies the name of the cluster host against which this cmdlet is run. If this parameter is omitted or if "-HostName ." is used, the local cluster is assumed. [Alias: hn]

Attributes

Name Value

Required?

false

Accept wildcard characters?

false

Accept Pipeline Input?

false

Position?

1

-InterfaceName <string>

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

Attributes

Name Value

Required?

true

Accept wildcard characters?

false

Accept Pipeline Input?

false

Position?

2

-OperationMode <ClusterMode>

Specifies the operation mode for the new cluster. If this parameter is omitted, the mode is unicast. The operation mode values are unicast, multicast, or igmpmulticast. [Alias: mode]

Attributes

Name Value

Required?

false

Accept wildcard characters?

false

Accept Pipeline Input?

false

Position?

named

-SubnetMask <IPAddress>

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

Attributes

Name Value

Required?

false

Accept wildcard characters?

false

Accept Pipeline Input?

false

Position?

named

-CommonParameter

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

Input and Return Types

The input type is the type of the objects that you can pipe to the cmdlet. The return type is the type of the objects that the cmdlet emits.

Examples

EXAMPLE 1

C:\PS>

New-NlbCluster -InterfaceName vlan-3 -ClusterPrimaryIP 3.53.100.100 -ClusterName cluster1



Name                IPAddress           SubnetMask          Mode

----                ---------           ----------          ----

cluster1            3.53.100.100        255.0.0.0           UNICAST

Description

-----------

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

See Also

Reference

Get-NlbClusterNodeNetworkInterface
New-NlbClusterIpv6Address
Get-NlbCluster
Remove-NlbCluster
Resume-NlbCluster
Set-NlbCluster
Start-NlbCluster
Stop-NlbCluster
Suspend-NlbCluster