Windows Server 2008 R2のNLBで使用できるPowerShellコマンドレット (Get-NlbClusterPortRule) について

スポンサーリンク

Windows Server 2008 R2では、Active Directory (AD) やフェールオーバー クラスタリング (WSFC)、グループ ポリシーといった役割および機能がインストールされたサーバーの管理、もしくは管理したい役割および機能についてリモート サーバー管理ツールをインストールしたサーバー上で、PowerShellコマンドレットを用いて管理することが可能です。

各役割および機能に関するPowerShellコマンドレットのヘルプについて、オンライン上で公開されていますが、主に英語のみで日本語の情報はあまり公開されていないようです。

ここでは、ネットワーク負荷分散 (NLB) に関するPowerShellコマンドレットの情報について、日本語としてオンライン上で備忘録として確認したいと思い、本ブログ上で纏めてみることにしました (内容については「Get-Help」コマンドレットの-Fullオプションを用いて実行した結果を編集したものとなります)。

この記事では、「Get-NlbClusterPortRule」コマンドレットについて記載します (他のコマンドレットについては、「Windows Server 2008 R2のNLBで使用できるPowerShellコマンドレットについて」を参照)。

■名前

Get-NlbClusterPortRule

■概要

呼び出し元によってクエリされたポート規則オブジェクトを取得します。

■構文

Get-NlbClusterPortRule [-HostName <string>] [-InterfaceName <string>]
     [-NodeName <string>] [[-Port] <System.Nullable`1[[System.UInt32>]
     [-Ip <IPAddress>] [<CommonParameters>]

Get-NlbClusterPortRule -InputObject <PSObject[]>
     [[-Port] <System.Nullable`1[[System.UInt32>] [-Ip <IPAddress>]
     [<CommonParameters>]

■説明

Get-NlbClusterPortRuleコマンドレットは、NLBクラスター内のポート規則を取得します。ポート番号が指定されていない場合、クラスターに構成されているポート規則がすべて一覧表示されます。

■パラメーター

-HostName <string>
このコマンドレットの実行対象となるクラスター ホストの名前を指定します。このパラメーターを省略した場合、または”-HostName .”を使用した場合は、ローカル クラスターが想定されます。[Alias: hn]

必須false
位置named
既定値
パイプライン入力を許可するfalse
ワイルドカード文字を許可するfalse

-InputObject <PSObject[]>
ポート規則を列挙する対象のクラスターまたはクラスター ノードを指定します。

必須true
位置named
既定値
パイプライン入力を許可するtrue (ByValue, ByPropertyName)
ワイルドカード文字を許可するfalse

-InterfaceName <string>
NLBのバインド先のインターフェイスを指定します。これは、このコマンドレットの実行対象のクラスターのインターフェイスです。

必須false
位置named
既定値
パイプライン入力を許可するfalse
ワイルドカード文字を許可するfalse

-Ip <IPAddress>
取得するクラスター ポート規則のIPアドレスを指定します。

必須false
位置named
既定値
パイプライン入力を許可するfalse
ワイルドカード文字を許可するfalse

-NodeName <string>
ポート規則を列挙する対象のクラスター ノードの名前を指定します。[Alias: nn]

必須false
位置named
既定値
パイプライン入力を許可するfalse
ワイルドカード文字を許可するfalse

-Port <System.Nullable`1[[System.UInt32>
取得するポート規則に含まれるポート番号を指定します。有効範囲は0から65535までです。

必須false
位置1
既定値
パイプライン入力を許可するfalse
ワイルドカード文字を許可するfalse

<CommonParameters>
このコマンドレットは、次の共通パラメーターをサポートします: VerboseDebugErrorActionErrorVariableWarningActionWarningVariableOutBuffer、およびOutVariable。詳細については、「get-help about_commonparameters」と入力してヘルプを参照してください。

■入力

Microsoft.NetworkLoadBalancingClusters.PowerShell.Cluster

■出力

Microsoft.NetworkLoadBalancingClusters.PowerShell.PortRule

■メモ

■例

例1

 Get-NlbClusterPortRule 

例1:出力結果

IPAddress State     Start     End       Protocol  Mode      Affinity  Timeout
——— —–     —–     —       ——–  —-      ——–  ——-
All       Enabled   0         65535     Both      Multiple  Single    0

例1:説明

このコマンドは、ローカル クラスター上のすべてのポート規則を一覧表示します。

例2

 Get-NlbClusterPortRule 80 

例2:出力結果

IPAddress State     Start     End       Protocol  Mode      Affinity  Timeout
——— —–     —–     —       ——–  —-      ——–  ——-
All       Enabled   0         65535     Both      Multiple  Single    0

例2:説明

このコマンドは、ポート80を含むポート規則を取得します。

例3

 Get-NlbClusterNode | Get-NlbClusterPortRule | fl * 

例3:出力結果

Cluster          : mycluster
NodeName         : node1
VirtualIPAddress : 255.255.255.255
StartPort        : 0
EndPort          : 65535
Affinity         :
FilteringMode    : Single
Protocol         : Both
EqualLoad        : False
LoadWeight       :
PortState        : Enabled
Priority         : 1
Timeout          :

Cluster          : mycluster
NodeName         : node2
VirtualIPAddress : 255.255.255.255
StartPort        : 0
EndPort          : 65535
Affinity         :
FilteringMode    : Single
Protocol         : Both
EqualLoad        : False
LoadWeight       :
PortState        : Enabled
Priority         : 2
Timeout          :

例3:説明

このコマンドはすべてのクラスター ノードからポート規則を取得します。Singleモードが設定されているポート規則が存在する場合に、特に便利です。

■関連するリンク

  • Add-NlbClusterPortRule
  • Disable-NlbClusterPortRule
  • Enable-NlbClusterPortRule
  • Remove-NlbClusterPortRule
  • Set-NlbClusterPortRule

[参考]