Windows Server 2012 では、Windows Server 2008 R2 から Active Directory (AD) やフェールオーバー クラスタリング (WSFC) といったサーバー管理における PowerShell コマンドレットが強化、および追加されました。
各役割および機能に関する PowerShell コマンドレットのヘルプについて、オンライン上で公開されていますが、現時点では主に英語のみで日本語の情報はあまり公開されていないようです。
ここでは、Windows Server 2012 の WSFC に関する PowerShell コマンドレットの情報について、日本語としてオンライン上で備忘録として確認したいと思い、本ブログ上で纏めてみることにしました (内容については「Get-Help」コマンドレットの -Full オプションを用いて実行した結果を編集、補足したものとなります)。
この記事では、「Add-ClusterGenericApplicationRole」コマンドレットについて記載します (他のコマンドレットについては、「Windows Server 2012 の WSFC で使用できる PowerShell コマンドレットについて」を参照)。
Add-ClusterGenericApplicationRole について
■名前
Add-ClusterGenericApplicationRole
■概要
当初の設計でフェールオーバー クラスターでの実行が考慮されていなかったアプリケーションに対して、高可用性を構成します。
■構文
Add-ClusterGenericApplicationRole [[-Name] <string>] -CommandLine <string> [-Parameters <string>] [-CheckpointKey <StringCollection>] [-Storage <StringCollection>] [-StaticAddress <StringCollection>] [-IgnoreNetwork <StringCollection>] [-Wait <int32>] [-InputObject <psobject>] [-Cluster <string>] [<CommonParameters>]
■説明
Add-ClusterGenericApplicationRole コマンドレットは、当初の設計でフェールオーバー クラスターでの実行が考慮されていなかったアプリケーションに対して、高可用性を構成します。
アプリケーションを汎用アプリケーションとして実行すると、クラスター ソフトウェアによってそのアプリケーションが起動され、アプリケーションが動作しているかどうかを確認するために、オペレーティング システムに対して定期的にクエリが実行されます。動作している場合、そのアプリケーションはオンラインであると見なされ、再起動またはフェールオーバーは行われません。
注: このコマンドレットは、Credential Security Service Provider (CredSSP) 認証なしで、サーバー コンピューター上からリモートで実行することはできません。
■パラメーター
-CheckpointKey <StringCollection>
高可用性対応の汎用アプリケーションに対して追加するレジストリ チェックポイント キーのコンマ区切り一覧を指定します。レジストリ パスはすべて HKEY_LOCAL_MACHINE への相対パスです。
| エイリアス | なし |
| 必須 | 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 <int32>
操作の待機時間を秒単位で指定します。このパラメーターが指定されていない場合は、操作が完了するまで待機します。”-Wait 0″を指定した場合、呼び出しが開始され、すぐにコマンドレットに戻ります。
| エイリアス | なし |
| 必須 | false |
| 位置 | named |
| 既定値 | なし |
| パイプライン入力を許可する | false |
| ワイルドカード文字を許可する | false |
<CommonParameters>
このコマンドレットは、次の共通パラメーターをサポートします: -Verbose、-Debug、-ErrorAction、-ErrorVariable、-WarningAction、-WarningVariable、-OutBuffer、および-OutVariable。詳細については、「about_commonparameters」と入力してヘルプを参照してください。
■入力
System.Management.Automation.PSObject
■出力
System.Object
■エイリアス
なし
■メモ
このコマンドレットを含むモジュールのヘルプ ファイルをダウンロードしてインストールするには、Update-Helpを使用してください。
このコマンドレットのヘルプ トピックをオンラインで確認するには、「Get-Help Add-ClusterGenericApplicationRole -Online」と入力するか、http://go.microsoft.com/fwlink/?LinkId=216184を参照してください。
■例
例1
Add-ClusterGenericApplicationRole -CommandLine NewApplication.exe
例1:出力結果
| Name OwnerNode State —- ——— —– cluster1GenApp node2 Online |
例1:説明
このコマンドは、NewApplication.exe を汎用クラスター化アプリケーションとして構成します。クライアント アクセス用には既定の名前が使用され、このアプリケーションは記憶域を必要としません。
例2
Add-ClusterGenericApplicationRole -CommandLine NewApplication.exe -Storage "Cluster Disk 4" -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 という名前を割り当てます。オンラインに移行していないリソースがある場合でも、このコマンドは完了します。
■関連するリンク
- Add-ClusterGenericScriptRole
- Add-ClusterGenericServiceRole
- Get-ClusterGroup
- Move-ClusterGroup
- Remove-ClusterGroup
- Start-ClusterGroup
- Stop-ClusterGroup
参考
- Add-ClusterGenericApplicationRole (FailoverClusters) – Windows Server 2012 | Microsoft Learn
https://learn.microsoft.com/ja-jp/powershell/module/failoverclusters/add-clustergenericapplicationrole?view=winserver2012-ps - FailoverClusters Module – Windows Server 2012 PowerShell | Microsoft Learn
https://learn.microsoft.com/en-us/powershell/module/failoverclusters/?view=winserver2012-ps - Windows PowerShell Support for Windows Server 2012
http://technet.microsoft.com/en-us/library/hh801904.aspx
コメント
[…] Add-ClusterGenericApplicationRole […]