Add-NlbClusterPortRule
Add-NlbClusterPortRule
Adds a new port rule to a Network Load Balancing (NLB) cluster.
Syntax
Parameter Set: NonPipeline
Add-NlbClusterPortRule [-StartPort] <Int32> [-EndPort] <Int32> -InterfaceName <String> [-Affinity <PortRuleAffinity> ] [-HostName <String> ] [-IP <IPAddress> ] [-Mode <PortRuleFilteringMode> ] [-Protocol <PortRuleProtocol> ] [-Timeout <Nullable> ] [ <CommonParameters>]
Parameter Set: Pipeline
Add-NlbClusterPortRule [-StartPort] <Int32> [-EndPort] <Int32> -InputObject <Cluster> [-Affinity <PortRuleAffinity> ] [-IP <IPAddress> ] [-Mode <PortRuleFilteringMode> ] [-Protocol <PortRuleProtocol> ] [-Timeout <Nullable> ] [ <CommonParameters>]
Detailed Description
The Add-NlbClusterPortRule cmdlet adds a new port rule to a Network Load Balancing (NLB) cluster. Port rules control how an NLB cluster functions. To maximize the control of various types of TCP/IP traffic, you can set up port rules to control how each port's cluster-network traffic is handled. The method by which a port's network traffic is handled is called its filtering mode. There are three possible filtering modes: Multiple hosts, Single host, and Disabled. A filtering mode can also apply to a numerical range of ports. You do this by defining a port rule with a set of configuration parameters that define the filtering mode. In addition, you can select one of three options for client affinity: None, Single, or Network. Single and Network are used to ensure that all network traffic from a particular client is directed to the same cluster host. To allow NLB to properly handle IP fragments, you should avoid using None when you select UDP or Both for your protocol setting.
This cmdlet changes the configuration on all cluster nodes. As a result, the NLB cluster will have to restart the convergence process on all nodes to guarantee that configuration changes have been applied on all nodes and that a consistent state is reached. Any additional operations on the NLB cluster should not be initiated until all cluster nodes have completed the convergence process and are back to the converged state.
Parameters
-Affinity<PortRuleAffinity>
Specifies the type of affinity for the new port rule. The acceptable values for this parameter are: Network, None, or Single.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-EndPort<Int32>
Specifies the end port for the new port rule. The acceptable values for this parameter are: 0 through 65535.
Aliases |
none |
Required? |
true |
Position? |
2 |
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? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-IP<IPAddress>
Specifies the IP address for the new cluster port rule.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-InputObject<Cluster>
Specifies the cluster to which the port rule is added.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue, ByPropertyName) |
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? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Mode<PortRuleFilteringMode>
Specifies the filtering mode for the new cluster port rule. The acceptable values for this parameter are: Disabled, Multiple, and Single.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Protocol<PortRuleProtocol>
Specifies the protocol for the new port rule. The acceptable values for this parameter are: Both, TCP, or UDP.
Aliases |
ptcl |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-StartPort<Int32>
Specifies the start port for the new port rule. The acceptable values for this parameter are: 0 through 65535.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Timeout<Nullable>
Specifies the timeout in minutes for the new cluster port rule. The acceptable values for this parameter are: 0 through 240.
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.
- Microsoft.NetworkLoadBalancingClusters.PowerShell.Cluster
Outputs
The output type is the type of the objects that the cmdlet emits.
- Microsoft.NetworkLoadBalancingClusters.PowerShell.PortRule
Examples
EXAMPLE 1
This example adds a new port rule to the local cluster. The new port rule covers port 443 only, and uses the default settings for the rest of the port rule parameters.
PS C:\> Get-NlbCluster | Add-NlbClusterPortRule -StartPort 443 -EndPort 443
EXAMPLE 2
This example adds a new port rule to the local cluster. The new port rule covers port 80 only and has no affinity, and uses the default settings for the rest of the port rule parameters.
PS C:\> Get-NlbCluster | Add-NlbClusterPortRule -StartPort 80 -EndPort 80 -Affinity None