Set-SCScriptCommandSetting

スクリプト コマンドの設定を構成します。

構文

Default (既定)

Set-SCScriptCommandSetting
    [-ScriptCommandSetting] <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>]

説明

Set-SCScriptCommandSetting コマンドレットは、スクリプト コマンドの設定を構成します。

例 1: スクリプト・コマンドに関連付けられた作業ディレクトリーを更新する

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

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

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

3 番目のコマンドは、$ScriptCommand に格納されているスクリプト コマンドのスクリプト コマンド設定オブジェクトを取得し、そのオブジェクトを $ScriptCmdSetting 変数に格納します。

4 番目のコマンドは、作業ディレクトリの設定を Working_Folder_03 に設定します。

最後のコマンドは、$ScriptCommand に保存されているスクリプト コマンドを、$ScriptCmdSettingに保存されている設定で更新します。

パラメーター

-AlwaysReboot

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

パラメーターのプロパティ

型:Boolean
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-CommandMayReboot

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

パラメーターのプロパティ

型:SwitchParameter
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-FailOnMatch

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

パラメーターのプロパティ

型:SwitchParameter
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-MatchExitCode

障害ポリシーの終了コードを指定します。

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

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-MatchRebootExitCode

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

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

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-MatchStandardError

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

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-MatchStandardOutput

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

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-PersistStandardErrorPath

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

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-PersistStandardOutputPath

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

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-RestartOnRetry

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

パラメーターのプロパティ

型:Boolean
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-RestartScriptOnExitCodeReboot

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

パラメーターのプロパティ

型:Boolean
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-ScriptCommandSetting

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

パラメーターのプロパティ

型:SCScriptCommandSetting
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:0
必須:True
パイプラインからの値:True
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-WarnAndContinueOnMatch

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

パラメーターのプロパティ

型:SwitchParameter
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-WorkingDirectory

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

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

CommonParameters

このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。

出力

ScriptCommandSetting

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