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

スポンサーリンク

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

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

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

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

■名前

Stop-NlbClusterNode

■概要

NLBクラスター内のノードを停止します。

■構文

Stop-NlbClusterNode [[-HostName] <string>] [-InterfaceName <string>] [-Drain]
     [-Timeout <System.Nullable`1[[System.UInt32>] [<CommonParameters>]

Stop-NlbClusterNode -InputObject <Node[]> [-Drain]
     [-Timeout <System.Nullable`1[[System.UInt32>] [<CommonParameters>]

■説明

Stop-NlbClusterNodeコマンドレットは、NLBクラスター内のノードを停止します。このコマンドレットを使用してクラスター内のノードを停止した場合、既に進行中のクライアント接続は中断されます。アクティブな接続が中断されないようにするには、-drainパラメーターの使用を検討してください。このパラメーターを使用することで、対象のノードによるアクティブな接続へのサービス提供を続行可能にすると同時に、対象のノードへの新しいトラフィックをすべて無効にします。

■パラメーター

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

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

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

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

-InputObject <Node[]>
停止するクラスター ノードを指定します。

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

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

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

-Timeout <System.Nullable`1[[System.UInt32>
クラスター ノードを停止する前にドレイン操作を待機する時間を分単位で指定します。この時間を経過すると、既存の接続が切断されます。

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

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

■入力

Microsoft.NetworkLoadBalancingClusters.PowerShell.Node

■出力

Microsoft.NetworkLoadBalancingClusters.PowerShell.Node

■メモ

■例

例1

 Stop-NlbClusterNode node2 

例1:出力結果

Name                State               Interface           HostID
—-                —–               ———           ——
node2               Stopped             vlan-3              2

例1:説明

このコマンドは、ローカル クラスター上のクラスター ノードnode2を停止します。

例2

 Stop-NlbClusterNode -Drain -Timeout 10 

例2:出力結果

Name                State               Interface           HostID
—-                —–               ———           ——
node3               Stopped             vlan-3              3

例2:説明

このコマンドは、ローカル クラスター ノードを停止します。クラスターを停止する前に、既存の接続をすべてドレインしますが、10分経つとドレイン操作が打ち切られます。その間、このノードでは新しい接続は確立されません。10分経っても処理されずに残っている接続は強制終了となります。

■関連するリンク

  • Add-NlbClusterNode
  • Get-NlbClusterNode
  • Remove-NlbClusterNode
  • Resume-NlbClusterNode
  • Set-NlbClusterNode
  • Start-NlbClusterNode
  • Suspend-NlbClusterNode

[参考]