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

スポンサーリンク

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

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

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

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

■名前

Add-ClusterGenericApplicationRole

■概要

当初の設計でフェールオーバー クラスターでの実行が考慮されていなかったアプリケーションに対して、高可用性を構成します。

■構文

Add-ClusterGenericApplicationRole [-InputObject <psobject>]
     -CommandLine <string> [[-Name] <string>] [-CheckpointKey <StringCollection>]
     [-Cluster <string>] [-IgnoreNetwork <StringCollection>] [-Parameters <string>]
     [-StaticAddress <StringCollection>] [-Storage <StringCollection>] [-Wait <int>]
     [<CommonParameters>]

■説明

アプリケーションを汎用アプリケーションとして実行すると、クラスター ソフトウェアによってそのアプリケーションが起動され、アプリケーションが動作しているかどうかを確認するために、オペレーティング システムに対して定期的にクエリが実行されます。動作している場合、そのアプリケーションはオンラインであると見なされ、再起動またはフェールオーバーは行われません。

■パラメーター

-CheckpointKey <StringCollection>
高可用性対応の汎用アプリケーションに対して追加するレジストリ チェックポイント キーのコンマ区切り一覧を指定します。レジストリ パスはすべてHKLMへの相対パスです。

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

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

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

-CommandLine <string>
高可用性対応の汎用アプリケーションに対して使用するコマンド ラインを指定します。完全なパスを指定すると、コマンド ラインから現在のディレクトリを解析します。

必須true
位置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

-Parameters <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-ClusterGenericApplicationRole -CommandLine NewApplication.exe 

例1:出力結果

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

例1:説明

このコマンドは、NewApplication.exeを汎用クラスター化アプリケーションとして構成します。クライアント アクセス用には既定の名前が使用され、このアプリケーションは記憶域を必要としません。

例2

 Add-ClusterGenericApplicationRole -CommandLine NewApplication.exe -Storage &quot;Cluster Disk 4&quot; -Name NewApplication 

例2:出力結果

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

例2:説明

このコマンドはCluster Disk 4を使用してNewApplication.exeを汎用クラスター化アプリケーションとして構成し、NewApplicationという名前を割り当てます。

例3

 Add-ClusterGenericApplicationRole -CommandLine NewApplication.exe -Wait 0 

例3:出力結果

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

例3:説明

このコマンドは NewApplication.exeを汎用クラスター化アプリケーションとして構成し、NewApplicationという名前を割り当てます。オンラインに移行していないリソースがある場合でも、このコマンドは完了します。

■関連するリンク

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

[参考]