Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

New-NlbCluster

New-NlbCluster

microsoft.networkloadbalancingclusters.powershell.dll

Synopsis

Creates a Network Load Balancing (NLB) cluster on the specified interface that is defined by the node and network adapter name.

Syntax

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

Detailed Description

The New-NlbCluster cmdlet creates a new 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.

Parameters

-ClusterName <String>

Specifies the name of the new cluster.

Aliases

Name,CN,N

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-ClusterPrimaryIP <IPAddress>

Specifies the primary cluster IP address for the new cluster.

Aliases

PrimaryIP,IPAddress,IP

Required?

true

Position

3

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-DedicatedIP <IPAddress>

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 will be used.

Aliases

DIP

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-DedicatedIPSubnetMask <IPAddress>

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.

Aliases

DIPSubnetMask

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Force <SwitchParameter>

Runs the cmdlet without prompting for confirmation. By default the cmdlet will ask for confirmation from the user before proceeding. This parameter applies if the DHCP setting on the interface needs to be overwritten by the cmdlet.

Aliases

F

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-HostName <String>

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.

Aliases

Host,HN,H

Required?

false

Position

1

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-InterfaceName <String>

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

Aliases

Interface,IN,I

Required?

true

Position

2

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-OperationMode <ClusterMode>

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, or UNICAST.

Aliases

Mode

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-SubnetMask <IPAddress>

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

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type


Return Type

Microsoft.NetworkLoadBalancingClusters.PowerShell.Cluster

Notes

None

Examples

EXAMPLE 1

This example 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.

PS C:\>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 

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