New-NlbCluster
New-NlbCluster
Creates a Network Load Balancing (NLB) cluster on the specified interface that is defined by the node and network adapter name.
Syntax
Parameter Set: Default
New-NlbCluster [[-HostName] <String> ] [-InterfaceName] <String> [-ClusterPrimaryIP] <IPAddress> [-ClusterName <String> ] [-DedicatedIP <IPAddress> ] [-DedicatedIPSubnetMask <IPAddress> ] [-Force] [-OperationMode <ClusterMode> ] [-SubnetMask <IPAddress> ] [ <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 |
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 |
ip, ipaddress, primaryip |
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
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 |
none |
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 |
hn |
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 |
none |
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 |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
- Microsoft.NetworkLoadBalancingClusters.PowerShell.Cluster
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