New-SCScriptCommandSetting

Creates a settings object for a script command.

Description

The New-SCScriptCommandSetting cmdlet creates a settings object for a script command.

For more information about New-SCScriptCommand Setting, type "Get-Help New-SCScriptCommandSetting -online".

Parameters

AlwaysReboot

Required? false
Accept Pipeline Input? false
Position? named 
Indicates whether a computer or virtual machine should always restart after the script has finished running.

CommandMayReboot

Required? false
Accept Pipeline Input? false
Position? named 
Indicates that the script command may reboot the computer or virtual machine.

FailOnMatch

Required? false
Accept Pipeline Input? false
Position? named 
Indicates that the action taken when a failure policy is matched is to fail.

MatchExitCode

Required? false
Accept Pipeline Input? false
Position? named 
Specifies the failure policy exit code.

Example format: -MatchExitCode "[1-9][0-9]*"

MatchRebootExitCode

Required? false
Accept Pipeline Input? false
Position? named 
Specifies the restart policy match exit code.

Example format: -MatchRebootExitCode "{1641}|{3010}|{3011}"

MatchStandardError

Required? false
Accept Pipeline Input? false
Position? named 
Specifies the failure policy standard error.

MatchStandardOutput

Required? false
Accept Pipeline Input? false
Position? named 
Specifies the failure policy standard output.

PersistStandardErrorPath

Required? false
Accept Pipeline Input? false
Position? named 
Specifies the file path to store the standard error.

PersistStandardOutputPath

Required? false
Accept Pipeline Input? false
Position? named 
Specifies the file path to store the standard output.

RestartScriptOnExitCodeReboot

Required? false
Accept Pipeline Input? false
Position? named 
Indicates whether the script restarts after the computer or virtual machine is restarted when an exit code is matched.

WarnAndContinueOnMatch

Required? false
Accept Pipeline Input? false
Position? named 
Indicates that the action taken when a failure policy is matched is to warn the user and continue the operation.

WorkingDirectory

Required? false
Accept Pipeline Input? false
Position? named 
Specifies a working directory for a script command.

Examples

1: Add a working directory setting to a script command. 
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

The first command gets the application profile object named SvcWebAppProfile01 and stores the object in the $AppProfile variable.

The second command gets the script command object named PostInstall for the application profile stored in $AppProfile.

The third command creates a new script command setting which sets the working directory to Working_Folder_02, and then stores the object in the $ScriptSetting variable.

The last command updates the working directory for the script command stored in $ScriptCommand to be Working_Folder_02 (the value of $ScriptSetting).

See Also