Add-SCScriptCommand

Add-SCScriptCommand

Adds a script command to an application profile, application deployment, or host profile.

Syntax

Parameter Set: ApplicationDeployment
Add-SCScriptCommand -ApplicationDeployment <ApplicationDeployment> -ScriptType <ScriptCommandType> {PreService | PostService | SaveState | RestoreState | PreInstall | PostInstall | PreUninstall | PostUninstall | OrderedCommand | OnProvisionFirst | OnProvisionRest | OnDeleteLast | OnDeleteRest | Install} [-CommandParameters <String> ] [-DeploymentOrder <Int32]> ] [-Executable <String> ] [-JobVariable <String> ] [-LibraryResource <CustomResource> ] [-PROTipID <Guid]> ] [-RunAsAccount <VMMCredential> ] [-RunAsynchronously] [-ScriptCommandSetting <SCScriptCommandSetting> ] [-StandardInput <String> ] [-TimeoutSeconds <Int32> ] [-VMMServer <ServerConnection> ] [ <CommonParameters>]

Parameter Set: ApplicationProfile
Add-SCScriptCommand -ApplicationProfile <ApplicationProfile> -ScriptType <ScriptCommandType> {PreService | PostService | SaveState | RestoreState | PreInstall | PostInstall | PreUninstall | PostUninstall | OrderedCommand | OnProvisionFirst | OnProvisionRest | OnDeleteLast | OnDeleteRest | Install} [-CommandParameters <String> ] [-DeploymentOrder <Int32]> ] [-Executable <String> ] [-JobVariable <String> ] [-LibraryResource <CustomResource> ] [-PROTipID <Guid]> ] [-RunAsAccount <VMMCredential> ] [-RunAsynchronously] [-ScriptCommandSetting <SCScriptCommandSetting> ] [-StandardInput <String> ] [-TimeoutSeconds <Int32> ] [-VMMServer <ServerConnection> ] [ <CommonParameters>]

Parameter Set: VMHostProfile
Add-SCScriptCommand -PhysicalComputerProfile <PhysicalComputerProfile> [-CommandParameters <String> ] [-DeploymentOrder <Int32]> ] [-Executable <String> ] [-JobVariable <String> ] [-LibraryResource <CustomResource> ] [-PROTipID <Guid]> ] [-RunAsynchronously] [-ScriptCommandSetting <SCScriptCommandSetting> ] [-StandardInput <String> ] [-TimeoutSeconds <Int32> ] [-VMMServer <ServerConnection> ] [ <CommonParameters>]

Detailed Description

The Add-SCScriptCommand cmdlet adds a script command to an application profile, application deployment, or host profile. A script command allows an Administrator to run code during deployment and servicing operations.

Parameters

-ApplicationDeployment<ApplicationDeployment>

Specifies an application deployment object.

-ApplicationProfile<ApplicationProfile>

Specifies an application profile object.

-CommandParameters<String>

Specifies the parameters for a script or executable program.

-DeploymentOrder<Int32]>

Specifies the order in which a computer tier, application host, or application is deployed.

-Executable<String>

Specifies the name of an executable program.

-JobVariable<String>

Specifies that job progress is tracked and stored in the variable named by this parameter.

-LibraryResource<CustomResource>

Specifies a resource stored in the VMM library.

-PhysicalComputerProfile<PhysicalComputerProfile>

Specifies a profile that is used to deploy an operating system to a computer.

-PROTipID<Guid]>

Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.

-RunAsAccount<VMMCredential>

Specifies a Run As account that contains credentials with permission to perform this action.

-RunAsynchronously

Indicates that the job runs asynchronously so that control returns to the command shell immediately.

-ScriptCommandSetting<SCScriptCommandSetting>

Specifies a script command setting object.

-ScriptType<ScriptCommandType>

Specifies a script type. Valid values are:

-- PreInstall
-- PostInstall
-- SaveState
-- RestoreState
-- PreService
-- PostService
-- PreUninstall
-- PostUninstall

-StandardInput<String>

Specifies a path to a file that contains standard input information to use with the script command.

-TimeoutSeconds<Int32>

Specifies the amount of time, in seconds, that a process waits before timing out.

-VMMServer<ServerConnection>

Specifies a VMM server object.

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

• ScriptCommand

Examples

Example 1: Add a script command to an application profile

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

The second command creates a script command setting object that sets the working directory to Payload, and then stores the object in the $ScriptSetting variable.

The last command adds a preinstall script command to the application profile stored in $AppProfile.

PS C:\> $AppProfile = Get-SCApplicationProfile -Name "SvcWebAppProfile01"
PS C:\> $ScriptSetting = New-SCScriptCommandSetting -WorkingDirectory "Working_Folder_01"
PS C:\> Add-SCScriptCommand -ApplicationProfile $AppProfile -Executable "Startup.ps1" -ScriptType "PreInstall" -ScriptCommandSetting $ScriptSetting -TimeoutSeconds 120

Related topics

Get-SCScriptCommand

Remove-SCScriptCommand

Set-SCScriptCommand

Get-SCApplicationProfile

New-SCScriptCommandSetting