New-SCScriptCommandSetting

  • リファレンス
モジュール:
VirtualMachineManager

スクリプト コマンドの設定オブジェクトを作成します。

構文

New-SCScriptCommandSetting
   [-AlwaysReboot <Boolean>]
   [-FailOnMatch]
   [-WarnAndContinueOnMatch]
   [-MatchExitCode <String>]
   [-MatchStandardError <String>]
   [-MatchStandardOutput <String>]
   [-PersistStandardErrorPath <String>]
   [-PersistStandardOutputPath <String>]
   [-MatchRebootExitCode <String>]
   [-RestartScriptOnExitCodeReboot <Boolean>]
   [-WorkingDirectory <String>]
   [-CommandMayReboot]
   [-RestartOnRetry <Boolean>]
   [<CommonParameters>]

説明

New-SCScriptCommandSetting コマンドレットは、スクリプト コマンドの設定オブジェクトを作成します。

例

例 1: スクリプト コマンドに作業ディレクトリ設定を追加する

PS C:\> $AppProfile = Get-SCApplicationProfile -Name "SvcWebAppProfile01"
PS C:\> $ScriptCommand = Get-SCScriptCommand -ApplicationProfile $AppProfile | where {$_.Name -eq "PostInstall"}
PS C:\> $ScriptSetting = New-SCScriptCommandSetting -WorkingDirectory "Working_Folder_02"
PS C:\> Set-SCScriptCommand -ScriptCommand $ScriptCommand -ScriptCommandSetting $ScriptSetting

最初のコマンドは、SvcWebAppProfile01 という名前のアプリケーション プロファイル オブジェクトを取得し、$AppProfile変数にオブジェクトを格納します。

2 番目のコマンドは、$AppProfileに格納されているアプリケーション プロファイルの PostInstall という名前のスクリプト コマンド オブジェクトを取得します。

3 番目のコマンドは、作業ディレクトリをWorking_Folder_02に設定し、オブジェクトを $ScriptSetting 変数に格納する新しいスクリプト コマンド設定を作成します。

最後のコマンドは、$ScriptCommandに格納されているスクリプト コマンドの作業ディレクトリを更新してWorking_Folder_02します ($ScriptSettingの値)。

パラメーター

-AlwaysReboot

スクリプトの実行が完了した後、コンピューターまたは仮想マシンを常に再起動するかどうかを示します。

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CommandMayReboot

スクリプト コマンドがコンピューターまたは仮想マシンを再起動する可能性があることを示します。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-FailOnMatch

エラー ポリシーが一致したときに実行されるアクションが失敗することを示します。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-MatchExitCode

エラー ポリシー終了コードを指定します。

形式の例: -MatchExitCode "[1-9][0-9]*"

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-MatchRebootExitCode

再起動ポリシーの一致終了コードを指定します。

形式の例: -MatchRebootExitCode "{1641}|{3010}|{3011}"

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-MatchStandardError

エラー ポリシー標準エラーを指定します。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-MatchStandardOutput

障害ポリシーの標準出力を指定します。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PersistStandardErrorPath

標準エラーを格納するファイル パスを指定します。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PersistStandardOutputPath

標準出力を格納するファイル パスを指定します。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RestartOnRetry

New-SCScriptCommandSetting または Set-SCScriptCommandSetting と組み合わせて使用した場合に、前のジョブの失敗がスクリプトエラーによるものである場合に、VMM ジョブの再起動時にスクリプトを再起動するかどうかを示します。

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RestartScriptOnExitCodeReboot

終了コードが一致したときに、コンピューターまたは仮想マシンの再起動後にスクリプトを再起動するかどうかを示します。

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WarnAndContinueOnMatch

エラー ポリシーが一致したときに実行されるアクションが、ユーザーに警告して操作を続行することを示します。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WorkingDirectory

スクリプト コマンドの作業ディレクトリを指定します。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

出力

ScriptCommandSetting

このコマンドレットは ScriptCommandSetting オブジェクトを 返します。