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

スポンサーリンク

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

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

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

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

■名前

Set-NlbClusterNode

■概要

呼び出し元によってクエリされた仮想IPアドレスを取得します。

■構文

Set-NlbClusterNode -InterfaceName <string> [[-HostName] <string>] [-Force]
     [-HostPriority <System.Nullable`1[[System.Int32>]
     [-InitialHostState <System.Nullable`1
          [[Microsoft.NetworkLoadBalancingClusters.PowerShell.NodeInitialHostState>]
     [-Reload] [-RetainSuspended <System.Nullable`1[[System.Boolean>]
     [<CommonParameters>]

Set-NlbClusterNode -InputObject <Node[]> [-Force]
     [-HostPriority <System.Nullable`1[[System.Int32>]
     [-InitialHostState <System.Nullable`1
          [[Microsoft.NetworkLoadBalancingClusters.PowerShell.NodeInitialHostState>]
     [-Reload] [-RetainSuspended <System.Nullable`1[[System.Boolean>]
     [<CommonParameters>]

■説明

Set-NlbClusterNodeコマンドレットは、NLBクラスター ノード設定を編集します。変更可能な内容としては、ホスト優先順位、初期ホスト状態、およびリブート間で中断された状態を維持するかどうかが挙げられます。

この操作により、すべてのクラスター ノードの構成が変更されます。結果として、NLBクラスターでは、すべてのノードで収束プロセスを再開し、確実に構成の変更がすべてのノードで適用され、一貫した状態に達するようにする必要があります。すべてのクラスター ノードで収束プロセスが完了し、収束した状態に戻るまで、NLBクラスターで追加の操作を開始しないでください。すべてのクラスター ノードの状態をチェックするには、Get-NlbClusterNodeコマンドレットを使用します。構成を変更した結果、クラスター ノードで収束が終了しなくなった場合は、イベント ログを参照して、クラスター ノード間の構成の不一致を解決してください。

■パラメーター

-Force [<SwitchParameter>]
確認メッセージを表示せずに操作を実行します。既定では、ユーザーは、この操作を続行する前に確認を求められます。

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

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

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

-HostPriority <System.Nullable`1[[System.Int32>
クラスター ノードのホスト優先順位またはホストIDを指定します。指定できる値の範囲は、1~32です。[Alias: hp priority]

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

-InitialHostState <System.Nullable`1[[Microsoft.NetworkLoadBalancingClusters.PowerShell.NodeInitialHostState>
クラスター ノードの初期ホスト状態を指定します。指定できる値は、Started、Stopped、またはSuspendedのいずれかです。[Alias: ihs state]

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

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

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

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

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

-Reload [<SwitchParameter>]
現在のクラスター ノード上のNLBドライバーにより、その設定がロードされます。このコマンドはローカルNLBクラスター ノードに対してのみ有効です。リモートNLBクラスター ノードへの再読み込みには使用できません

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

-RetainSuspended <System.Nullable`1[[System.Boolean>
クラスター ノードの新しい維持の中断設定を指定します。[Alias: rs]

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

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

■入力

Microsoft.NetworkLoadBalancingClusters.PowerShell.Node

■出力

Microsoft.NetworkLoadBalancingClusters.PowerShell.Node

■メモ

■例

例1

 Get-NlbClusterNode node1 | Set-NlbClusterNode -Reload 

例1:出力結果

Name                State               Interface           HostID
—-                —–               ———           ——
node1               Converging          vlan-3              1

例1:説明

このコマンドは、すべての設定を再度読み込むように、node1上のNLBドライバーに指示します。このコマンドが必要になるのは、管理者がドライバーを介して構成の変更内容を強制的に適用する場合です。このコマンドはnode1上でローカル実行する必要があります。

例2

 Get-NlbClusterNode node1 | Set-NlbClusterNode -InitialHostState Suspended 

例2:出力結果

Name                State               Interface           HostID
—-                —–               ———           ——
node1               Converging          vlan-3              1

例2:説明

このコマンドは、node1の初期ホスト状態をsuspendedに設定します。

例3

 Get-NlbClusterNode node1| Set-NlbClusterNode -RetainSuspended $TRUE | fl * 

例3:出力結果

Cluster                   : newcluster
Name                      : node1
InterfaceName             : vlan-3
Host                      : node1.domain.com
State                     : Converging
HostPriority              : 1
AdapterGuid               : {99757561-22EC-44DA-B6D3-82E16B387D6C}
InitialHostState          : Started
PersistSuspendOnReboot    : True
MaskSourceMac             : True
FilterIcmp                : 0
GreDescriptorTimeout      : 10

例3:説明

このコマンドは、node1のリブート時の維持の中断設定をTRUEに変更します。

例4

 Get-NlbClusterNode node1 | Set-NlbClusterNode -HostPriority 5 | fl * 

例4:出力結果

Cluster                   : newcluster
Name                      : node1
InterfaceName             : vlan-3
Host                      : node1.domain.com
State                     : Converging
HostPriority              : 5
AdapterGuid               : {99757561-22EC-44DA-B6D3-82E16B387D6C}
InitialHostState          : Started
PersistSuspendOnReboot    : True
MaskSourceMac             : True
FilterIcmp                : 0
GreDescriptorTimeout      : 10

例4:説明

このコマンドは、node1のホスト優先順位 (ID) を 5 に変更します。

■関連するリンク

  • Add-NlbClusterNode
  • Get-NlbClusterNode
  • Remove-NlbClusterNode
  • Resume-NlbClusterNode
  • Start-NlbClusterNod
  • Stop-NlbClusterNode
  • Suspend-NlbClusterNode

[参考]