Windows Server 2012では、Windows Server 2008 R2からActive Directory (AD)やフェールオーバー クラスタリング (WSFC) といったサーバー管理におけるPowerShellコマンドレットが強化、および追加されました。
各役割および機能に関するPowerShellコマンドレットのヘルプについて、オンライン上で公開されていますが、現時点では主に英語のみで日本語の情報はあまり公開されていないようです。
ここでは、Windows Server 2012のWSFCに関するPowerShellコマンドレットの情報について、日本語としてオンライン上で備忘録として確認したいと思い、本ブログ上で纏めてみることにしました (内容については「Get-Help」コマンドレットの-Fullオプションを用いて実行した結果を編集、補足したものとなります)。
この記事では、「Add-ClusterGenericScriptRole」コマンドレットについて記載します (他のコマンドレットについては、「Windows Server 2012のWSFCで使用できるPowerShellコマンドレットについて」を参照)。
■名前
Add-ClusterGenericScriptRole
■概要
Windows Script Hostで動作するスクリプトによって制御されるアプリケーションをフェールオーバー クラスター内に構成します。
■構文
Add-ClusterGenericScriptRole [[-Name] <string>] -ScriptFilePath <string> [-Storage <StringCollection>] [-StaticAddress <StringCollection>] [-IgnoreNetwork <StringCollection>] [-Wait <int32>] [-InputObject <psobject>] [-Cluster <string>] [<CommonParameters>]
■説明
Add-ClusterGenericScriptRoleコマンドレットは、Windows Script Hostで動作するスクリプトによって制御されるアプリケーションをフェールオーバー クラスター内に構成します。
このスクリプトは、アプリケーションの現在の状況に関する情報をクラスター ソフトウェアに提供します。必要に応じて、クラスター ソフトウェアは、スクリプトの再起動やフェールオーバーを行います (これによって、アプリケーションが再起動またはフェールオーバーされます)。
注: このコマンドレットは、Credential Security Service Provider (CredSSP) 認証なしで、サーバー コンピューター上からリモートで実行することはできません。
■パラメーター
-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 <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-ClusterGenericScriptRole -Online」と入力するか、http://go.microsoft.com/fwlink/?LinkId=216186を参照してください。
■例
例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をフェールオーバー クラスター内で実行するよう構成します。オンラインに移行していないリソースがある場合でも、このコマンドは完了します。
■関連するリンク
- Add-ClusterGenericApplicationRole
- Add-ClusterGenericServiceRole
- Get-ClusterGroup
- Move-ClusterGroup
- Remove-ClusterGroup
- Start-ClusterGroup
- Stop-ClusterGroup
[参考]
- Add-ClusterGenericScriptRole – Windows Server 2012
http://technet.microsoft.com/en-us/library/hh847290.aspx - Windows PowerShell Support for Windows Server 2012
http://technet.microsoft.com/en-us/library/hh801904.aspx - Failover Clusters Cmdlets in Windows PowerShell – Windows Server 2012
http://technet.microsoft.com/en-us/library/hh847239.aspx - Windows Server 2008 R2のWSFCで使用できるPowerShellコマンドレット (Add-ClusterGenericScriptRole) について « 焦げlog
https://kogelog.com/2012/08/16/20120816-02/
コメント
[…] Add-ClusterGenericScriptRole […]