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

スポンサーリンク

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

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

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

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

■名前

Stop-NlbCluster

■概要

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

■構文

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

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

■説明

Stop-NlbClusterコマンドレットは、NLB クラスター内のすべてのノードを停止します。このコマンドレットは、ホスト上のNLBサービスを停止します。これにより、すべての既存の接続は失われます。アクティブな接続が中断されないようにするには、-drainパラメーターを使用して、対象のホストによるアクティブな接続へのサービス提供を続行可能にすると同時に、対象のホストへの新しいトラフィックをすべて無効にします。

■パラメーター

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

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

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

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

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

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

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

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

-Ip <IPAddress>
仮想IPアドレスを列挙するクラスターのIPアドレスを指定します。

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

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

■入力

Microsoft.NetworkLoadBalancingClusters.PowerShell.Cluster

■出力

Microsoft.NetworkLoadBalancingClusters.PowerShell.Cluster

■メモ

■例

例1

 Stop-NlbCluster 

例1:出力結果

Name                IPAddress           SubnetMask          Mode
—-                ———           ———-          —-
cluster1            3.53.100.100        255.0.0.0           UNICAST

例1:説明

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

■関連するリンク

  • Get-NlbCluster
  • New-NlbCluster
  • Remove-NlbCluster
  • Resume-NlbCluster
  • Set-NlbCluster
  • Start-NlbCluster
  • Suspend-NlbCluster

[参考]