Add-NlbClusterPortRule
Add-NlbClusterPortRule
Adds a new port rule to a Network Load Balancing (NLB) cluster.
構文
Parameter Set: NonPipeline
Add-NlbClusterPortRule [-StartPort] <Int32> [-EndPort] <Int32> -InterfaceName <String> [-Affinity <PortRuleAffinity> {Network | None | Single} ] [-HostName <String> ] [-IP <IPAddress> ] [-Mode <PortRuleFilteringMode> {Disabled | Multiple | Single} ] [-Protocol <PortRuleProtocol> {Both | Tcp | Udp} ] [-Timeout <UInt32> ] [ <CommonParameters>]
Parameter Set: Pipeline
Add-NlbClusterPortRule [-StartPort] <Int32> [-EndPort] <Int32> -InputObject <Cluster[]> [-Affinity <PortRuleAffinity> {Network | None | Single} ] [-IP <IPAddress> ] [-Mode <PortRuleFilteringMode> {Disabled | Multiple | Single} ] [-Protocol <PortRuleProtocol> {Both | Tcp | Udp} ] [-Timeout <UInt32> ] [ <CommonParameters>]
詳細説明
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.
パラメーター
-Affinity<PortRuleAffinity>
Specifies the type of affinity for the new port rule. このパラメーターに対して使用できる値: Network, None, or Single.
エイリアス |
A |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-EndPort<Int32>
Specifies the end port for the new port rule. このパラメーターに対して使用できる値: 0
through 65535
.
エイリアス |
E |
必須? |
true |
位置は? |
2 |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
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.
エイリアス |
Host,HN,H |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-IP<IPAddress>
Specifies the IP address for the new cluster port rule.
エイリアス |
なし |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-InputObject<Cluster[]>
Specifies the cluster to which the port rule is added.
エイリアス |
なし |
必須? |
true |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
True (ByValue, ByPropertyName) |
ワイルドカード文字を許可する |
false |
-InterfaceName<String>
Specifies the interface to which NLB is bound. This is the interface of the cluster against which this cmdlet is run.
エイリアス |
Interface,IN,I |
必須? |
true |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-Mode<PortRuleFilteringMode>
Specifies the filtering mode for the new cluster port rule. このパラメーターに対して使用できる値: Disabled, Multiple, and Single.
エイリアス |
M |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-Protocol<PortRuleProtocol>
Specifies the protocol for the new port rule. このパラメーターに対して使用できる値: Both, TCP, or UDP.
エイリアス |
PTCL |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-StartPort<Int32>
Specifies the start port for the new port rule. このパラメーターに対して使用できる値: 0
through 65535
.
エイリアス |
S |
必須? |
true |
位置は? |
1 |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-Timeout<UInt32>
Specifies the timeout in minutes for the new cluster port rule. このパラメーターに対して使用できる値: 0
through 240
.
エイリアス |
T |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
<CommonParameters>
このコマンドレットは次の共通パラメーターをサポートします。-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、-OutVariable.詳細については、以下を参照してください。 about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216)。
入力
入力型は、コマンドレットにパイプできるオブジェクトの型です。
- Microsoft.NetworkLoadBalancingClusters.PowerShell.Cluster
出力
出力型は、コマンドレットによって生成されるオブジェクトの型です。
- Microsoft.NetworkLoadBalancingClusters.PowerShell.PortRule
例
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