New-NlbCluster
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] <String>]
[-InterfaceName] <String>
[-ClusterName <String>]
[-ClusterPrimaryIP] <IPAddress>
[-SubnetMask <IPAddress>]
[-DedicatedIP <IPAddress>]
[-DedicatedIPSubnetMask <IPAddress>]
[-Force]
[-OperationMode <ClusterMode>]
[<CommonParameters>]
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.
Examples
EXAMPLE 1
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
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.
Parameters
-ClusterName
Specifies the name of the new cluster.
Type: | String |
Aliases: | Name, CN, N |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ClusterPrimaryIP
Specifies the primary cluster IP address for the new cluster.
Type: | IPAddress |
Aliases: | PrimaryIP, IPAddress, IP |
Position: | 2 |
Default value: | None |
Required: | True |
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 will be used.
Type: | IPAddress |
Aliases: | DIP |
Position: | Named |
Default value: | None |
Required: | False |
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 |
Aliases: | DIPSubnetMask |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Force
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.
Type: | SwitchParameter |
Aliases: | F |
Position: | Named |
Default value: | None |
Required: | False |
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 |
Aliases: | Host, HN, H |
Position: | 0 |
Default value: | None |
Required: | False |
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 |
Aliases: | Interface, IN, I |
Position: | 1 |
Default value: | None |
Required: | True |
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, or UNICAST.
Type: | ClusterMode |
Aliases: | Mode |
Accepted values: | Unicast, Multicast, IgmpMulticast |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SubnetMask
Specifies the subnet mask for the new cluster primary IP address.
Type: | IPAddress |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Outputs
Microsoft.NetworkLoadBalancingClusters.PowerShell.Cluster
Related Links
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for