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

スポンサーリンク

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

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

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

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

■名前

Disable-NlbClusterPortRule

■概要

NLBクラスター上またはNLBクラスター内の特定のホスト上のポート規則を無効にします。

■構文

Disable-NlbClusterPortRule [-Port] <System.Nullable`1[[System.UInt32> [-ClusterWide]
     [-HostName <string>] [-InterfaceName <string>] [-Ip <IPAddress>] [-Drain]
     [-Timeout <System.Nullable`1[[System.UInt32>] [<CommonParameters>]

Disable-NlbClusterPortRule -InputObject <PortRule[]> [-Drain]
     [-Timeout <System.Nullable`1[[System.UInt32>] [<CommonParameters>]

■説明

Disable-NlbClusterPortRuleコマンドレットは、NLBクラスター上またはNLBクラスター内の特定のホスト上の特定のポート規則を無効にします。-drainオプション パラメーターを使用して、ポート規則の新しいトラフィック処理を無効にすることを検討してください。-drainパラメーターをクラスター レベルで指定すると、クラスター内のすべてのホスト上で特定のポートのドレイン操作が発生します。また、ホスト レベルで指定すると、特定のホスト上でのみポートのドレイン操作が発生します。

■パラメーター

-ClusterWide [<SwitchParameter>]
すべてのクラスター ノードで指定したポート規則を無効にします。このパラメーターを省略した場合、ポート規則は単一のノード上でのみ無効になります。

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

-Drain [<SwitchParameter>]
このポート規則を無効にする前に既存のトラフィックをドレインします。このパラメーターを省略した場合、既存のトラフィックは切断されます。

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

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

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

-InputObject <PortRule[]>
無効にするクラスター ポート規則を指定します。

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

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

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

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

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

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

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

-Timeout <System.Nullable`1[[System.UInt32>
ポート規則を無効にする前にドレイン操作を待機する時間を分単位で指定します。この時間を経過すると、既存の接続が切断されます。

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

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

■入力

Microsoft.NetworkLoadBalancingClusters.PowerShell.PortRule

■出力

Microsoft.NetworkLoadBalancingClusters.PowerShell.PortRule

■メモ

■例

例1

 Disable-NlbClusterPortRule -Port 80 

例1:出力結果

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

例1:説明

このコマンドは、ローカル クラスター上のポート規則80を無効にします。

例2

 Get-NlbClusterPortRule | Disable-NlbClusterPortRule 

例2:出力結果

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

例2:説明

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

■関連するリンク

  • Add-NlbClusterPortRule
  • Enable-NlbClusterPortRule
  • Get-NlbClusterPortRule
  • Remove-NlbClusterPortRule
  • Set-NlbClusterPortRule

[参考]