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

スポンサーリンク

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

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

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

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

■名前

Add-ClusterGenericScriptRole

■概要

Windows Script Hostで動作するスクリプトによって制御されるアプリケーションをフェールオーバー クラスター内に構成します。

■構文

Add-ClusterGenericScriptRole [-InputObject <psobject>] -ScriptFilePath <string>
     [[-Name] <string>] [-Cluster <string>] [-IgnoreNetwork <StringCollection>]
     [-StaticAddress <StringCollection>] [-Storage <StringCollection>] [-Wait <int>]
     [<CommonParameters>]

■説明

このスクリプトは、アプリケーションの現在の状況に関する情報をクラスター ソフトウェアに提供します。必要に応じて、クラスター ソフトウェアは、スクリプトの再起動やフェールオーバーを行います (これによって、アプリケーションが再起動またはフェールオーバーされます)。

■パラメーター

-Cluster <string>
このコマンドレットを実行するクラスターの名前を指定します。「-Cluster .」と入力するか、パラメーターを省略した場合、コマンドレットはローカル クラスターで実行されます。

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

-IgnoreNetwork <StringCollection>
操作中に無視するネットワークを指定します。DHCPが有効になっているネットワークが必ず含まれます。他のネットワークでは、-StaticAddressパラメーターを使用して静的アドレスを指定するか、この-IgnoreNetworkパラメーターを使用して明示的に無視する必要があります。

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

-InputObject <psobject>
高可用性スクリプトを作成する対象のクラスターを指定します。

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

-Name <string>
作成するクラスター高可用性スクリプトの名前を指定します。

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

-ScriptFilePath <string>
高可用性スクリプトに対して使用するスクリプト ファイルのパスを指定します。

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

-StaticAddress <StringCollection>
操作時に使用する静的アドレスを1つ以上指定します。DHCPが有効になっているネットワークが必ず含まれます。他のネットワークでは、-StaticAddressパラメーターを使用して静的アドレスを指定するか、この-IgnoreNetworkパラメーターを使用して明示的に無視する必要があります。

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

-Storage <StringCollection>
作成した高可用性スクリプトに追加するクラスター ディスク リソースを指定します。

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

-Wait <int>
操作の待機時間を秒単位で指定します。このパラメーターが指定されていない場合は、操作が完了するまで待機します。”-Wait 0″を指定した場合、呼び出しが開始され、すぐにコマンドレットに戻ります。

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

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

■入力

Microsoft.FailoverClusters.PowerShell.Cluster

■出力

Microsoft.FailoverClusters.PowerShell.ClusterGroup

■メモ

■例

例1

 Add-ClusterGenericScriptRole -ScriptFilePath script1.vbs 

例1:出力結果

Name                       OwnerNode                                      State
—-                       ———                                      —–
cluster1GenScript          node2                                         Online

例1:説明

このコマンドはディスクを割り当てずに、名前およびIPアドレスの既定値を使用してscript1.vbsをフェールオーバー クラスター内で実行するよう構成します。

例2

 Add-ClusterGenericScriptRole -ScriptFilePath script1.vbs -Storage &quot;Cluster Disk 4&quot; -Name script1 

例2:出力結果

Name                       OwnerNode                                      State
—-                       ———                                      —–
script1                    node2                                         Online

例2:説明

このコマンドは、script1.vbsがフェールオーバー クラスター内 (Cluster Disk 4を使用) で実行されるように構成します。また、クラスター化スクリプトにscript1という名前を割り当てます。

例3

 Add-ClusterGenericScriptRole -ScriptFilePath script1.vbs -Wait 0 

例3:出力結果

Name                       OwnerNode                                      State
—-                       ———                                      —–
cluster1GenScript          node2                                        Pending

例3:説明

このコマンドはディスクを割り当てずに、名前およびIPアドレスの既定値を使用してscript1.vbsをフェールオーバー クラスター内で実行するよう構成します。オンラインに移行していないリソースがある場合でも、このコマンドは完了します。

■関連するリンク

  • Get-ClusterGroup
  • Move-ClusterGroup
  • Remove-ClusterGroup
  • Start-ClusterGroup
  • Stop-ClusterGroup

[参考]

コメント

  1. […] Windows Server 2008 R2のWSFCで使用できるPowerShellコマンドレット (Add-ClusterGenericScriptRole) について « 焦げloghttps://kogelog.com/2012/08/16/20120816-02/ […]