Windows Server 2008 R2では、Active Directory (AD) やフェールオーバー クラスタリング (WSFC)、グループ ポリシーといった役割および機能がインストールされたサーバーの管理、もしくは管理したい役割および機能についてリモート サーバー管理ツールをインストールしたサーバー上で、PowerShellコマンドレットを用いて管理することが可能です。
各役割および機能に関するPowerShellコマンドレットのヘルプについて、オンライン上で公開されていますが、主に英語のみで日本語の情報はあまり公開されていないようです。
ここでは、ネットワーク負荷分散 (NLB) に関するPowerShellコマンドレットの情報について、日本語としてオンライン上で備忘録として確認したいと思い、本ブログ上で纏めてみることにしました (内容については「Get-Help」コマンドレットの-Fullオプションを用いて実行した結果を編集したものとなります)。
この記事では、「Add-NlbClusterPortRule」コマンドレットについて記載します (他のコマンドレットについては、「Windows Server 2008 R2のNLBで使用できるPowerShellコマンドレットについて」を参照)。
■名前
Add-NlbClusterPortRule
■概要
新しいポート規則をNLBクラスターに追加します。
■構文
| Add-NlbClusterPortRule -InterfaceName <string> [-HostName <string>] [-StartPort] <int> [-EndPort] <int> [-Affinity <PortRuleAffinity>] [-IP <IPAddress>] [-Mode <PortRuleFilteringMode>] [-Protocol <PortRuleProtocol>] [-Timeout <System.Nullable`1[[System.UInt32>] [<CommonParameters>] Add-NlbClusterPortRule -InputObject <Cluster[]> [-StartPort] <int> [-EndPort] <int> |
■説明
Add-NlbClusterPortRuleコマンドレットは、新しいポート規則をNLBクラスターに追加します。ポート規則は、NLBクラスターがどのように機能するかを制御します。さまざまな種類のTCP/IPトラフィックを効果的に制御するには、ポート規則を設定して、各ポートのクラスター ネットワーク トラフィックの処理方法を制御します。ポートのネットワーク トラフィックの処理方法は、フィルター モードと呼ばれます。複数ホスト (Multiple)、単一ホスト (Single)、および使用不可 (Disabled) という 3 種類のフィルター モードを設定できます。フィルター モードをポートの数値範囲に適用するよう指定することもできます。具体的には、フィルター モードを定義する一連の構成パラメーターでポート規則を定義します。さらに、なし (None)、単一 (Single)、またはネットワーク (Network) という3種類のクライアント アフィニティ オプションのうちの1つを選択できます。SingleおよびNetworkは、特定のクライアントからのネットワーク トラフィックが、すべて同じクラスター ホストに送信されるように指定する場合に使用します。プロトコル設定でUDPや両方 (Both) を選択する場合は、NLBでIPフラグメントを正しく処理できるように、なし (None) を選択しないでください。
この操作により、すべてのクラスター ノードの構成が変更されます。結果として、NLBクラスターでは、すべてのノードで収束プロセスを再開し、確実に構成の変更がすべてのノードで適用され、一貫した状態に達するようにする必要があります。すべてのクラスター ノードで収束プロセスが完了し、収束した状態に戻るまで、NLBクラスターで追加の操作を開始しないでください。すべてのクラスター ノードの状態をチェックするには、Get-NlbClusterNodeコマンドレットを使用します。構成を変更した結果、クラスター ノードで収束が終了しなくなった場合は、イベント ログを参照して、クラスター ノード間の構成の不一致を解決してください。
■パラメーター
-Affinity <PortRuleAffinity>
新しいポート規則のアフィニティの種類を指定します。指定できる種類は、Single、None、またはNetworkの3つです。
| 必須 | false |
| 位置 | named |
| 既定値 | |
| パイプライン入力を許可する | false |
| ワイルドカード文字を許可する | false |
-EndPort <int>
新しいポート規則の終了ポートを指定します。有効範囲は0から65535までです。
| 必須 | true |
| 位置 | 2 |
| 既定値 | |
| パイプライン入力を許可する | false |
| ワイルドカード文字を許可する | false |
-HostName <string>
このコマンドレットの実行対象となるクラスター ホストの名前を指定します。このパラメーターを省略した場合、または”-HostName .”を使用した場合は、ローカル クラスターが想定されます。[Alias: hn]
| 必須 | false |
| 位置 | named |
| 既定値 | |
| パイプライン入力を許可する | false |
| ワイルドカード文字を許可する | false |
-InputObject <Cluster[]>
仮想IPアドレスを列挙するクラスターを指定します。
| 必須 | true |
| 位置 | named |
| 既定値 | |
| パイプライン入力を許可する | true (ByValue, ByPropertyName) |
| ワイルドカード文字を許可する | false |
-InterfaceName <string>
NLB のバインド先のインターフェイスを指定します。これは、このコマンドレットの実行対象のクラスターのインターフェイスです。
| 必須 | true |
| 位置 | named |
| 既定値 | |
| パイプライン入力を許可する | false |
| ワイルドカード文字を許可する | false |
-IP <IPAddress>
新しいクラスター ポート規則の IP アドレスを指定します。
| 必須 | false |
| 位置 | named |
| 既定値 | |
| パイプライン入力を許可する | false |
| ワイルドカード文字を許可する | false |
-Mode <PortRuleFilteringMode>
新しいクラスター ポート規則のフィルター モードを指定します。指定できるモードは、Multiple、Single、またはDisabledの3つです。
| 必須 | false |
| 位置 | named |
| 既定値 | |
| パイプライン入力を許可する | false |
| ワイルドカード文字を許可する | false |
-Protocol <PortRuleProtocol>
新しいポート規則のプロトコルを指定します。指定できるプロトコルは、TCP、UDP、またはその両方 (both) の3つです。[Alias: ptcl]
| 必須 | false |
| 位置 | named |
| 既定値 | |
| パイプライン入力を許可する | false |
| ワイルドカード文字を許可する | false |
-StartPort <int>
新しいポート規則の開始ポートを指定します。有効範囲は0から65535までです。
| 必須 | true |
| 位置 | 1 |
| 既定値 | |
| パイプライン入力を許可する | false |
| ワイルドカード文字を許可する | false |
-Timeout <System.Nullable`1[[System.UInt32>
新しいクラスター ポート規則のタイムアウトを分単位で指定します。有効範囲は0から240までです。
| 必須 | false |
| 位置 | named |
| 既定値 | |
| パイプライン入力を許可する | false |
| ワイルドカード文字を許可する | false |
<CommonParameters>
このコマンドレットは、次の共通パラメーターをサポートします: Verbose、Debug、ErrorAction、ErrorVariable、WarningAction、WarningVariable、OutBuffer、およびOutVariable。詳細については、「get-help about_commonparameters」と入力してヘルプを参照してください。
■入力
Microsoft.NetworkLoadBalancingClusters.PowerShell.Cluster
■出力
Microsoft.NetworkLoadBalancingClusters.PowerShell.PortRule
■メモ
■例
例1
Get-NlbCluster | Add-NlbClusterPortRule -StartPort 443 -EndPort 443
例1:出力結果
| IPAddress State Start End Protocol Mode Affinity Timeout ——— —– —– — ——– —- ——– ——- All Enabled 443 443 Both Multiple Single 0 |
例1:説明
このコマンドは、新しいポート規則をローカル クラスターに追加します。新しいポート規則はポート443のみを範囲に含んでおり、残りのポート規則パラメーターに対しては既定の設定を使用します。
例2
Get-NlbCluster | Add-NlbClusterPortRule -StartPort 80 -EndPort 80 -Affinity None
例2:出力結果
| IPAddress State Start End Protocol Mode Affinity Timeout ——— —– —– — ——– —- ——– ——- All Enabled 80 80 Both Multiple None 0 |
例2:説明
このコマンドは、新しいポート規則をローカル クラスターに追加します。新しいポート規則はポート80のみを範囲に含み、アフィニティは設定されていません。残りのポート規則パラメーターに対しては既定の設定を使用します。
■関連するリンク
- Disable-NlbClusterPortRule
- Enable-NlbClusterPortRule
- Get-NlbClusterPortRule
- Remove-NlbClusterPortRule
- Set-NlbClusterPortRule
[参考]
- Add-NlbClusterPortRule
http://technet.microsoft.com/en-us/library/ee817129.aspx - Cmdlet Reference for Windows Server 2008 R2
http://technet.microsoft.com/en-us/library/ee407531.aspx - Network Load Balancing cmdlets in Windows PowerShell
http://technet.microsoft.com/en-us/library/ee817138.aspx - ネットワーク負荷分散
http://technet.microsoft.com/ja-jp/library/cc770558.aspx
コメント
[…] Add-NlbClusterPortRule […]