Add-SCScriptCommand
Adds a script command to an application profile, application deployment, or host profile.
Syntax
Add-SCScriptCommand
-ApplicationProfile <ApplicationProfile>
[-Executable <String>]
[-CommandParameters <String>]
[-ScriptCommandSetting <SCScriptCommandSetting>]
-ScriptType <ScriptCommandType>
[-TimeoutSeconds <Int32>]
[-StandardInput <String>]
[-LibraryResource <CustomResource>]
[-RunAsAccount <VMMCredential>]
[-VMMServer <ServerConnection>]
[-DeploymentOrder <Int32>]
[-RunAsynchronously]
[-PROTipID <Guid>]
[-JobVariable <String>]
[<CommonParameters>] Add-SCScriptCommand
-ApplicationDeployment <ApplicationDeployment>
[-Executable <String>]
[-CommandParameters <String>]
[-ScriptCommandSetting <SCScriptCommandSetting>]
-ScriptType <ScriptCommandType>
[-TimeoutSeconds <Int32>]
[-StandardInput <String>]
[-LibraryResource <CustomResource>]
[-RunAsAccount <VMMCredential>]
[-VMMServer <ServerConnection>]
[-DeploymentOrder <Int32>]
[-RunAsynchronously]
[-PROTipID <Guid>]
[-JobVariable <String>]
[<CommonParameters>] Add-SCScriptCommand
-PhysicalComputerProfile <PhysicalComputerProfile>
[-Executable <String>]
[-CommandParameters <String>]
[-ScriptCommandSetting <SCScriptCommandSetting>]
-ScriptType <ScriptCommandType>
[-TimeoutSeconds <Int32>]
[-StandardInput <String>]
[-LibraryResource <CustomResource>]
[-RunAsAccount <VMMCredential>]
[-VMMServer <ServerConnection>]
[-JobGroup <Guid>]
[-DeploymentOrder <Int32>]
[-RunAsynchronously]
[-PROTipID <Guid>]
[-JobVariable <String>]
[<CommonParameters>] Add-SCScriptCommand
[-Executable <String>]
[-CommandParameters <String>]
[-ScriptCommandSetting <SCScriptCommandSetting>]
-ScriptType <ScriptCommandType>
[-TimeoutSeconds <Int32>]
[-StandardInput <String>]
[-LibraryResource <CustomResource>]
[-RunAsAccount <VMMCredential>]
[-VMMServer <ServerConnection>]
[-JobGroup <Guid>]
[-DeploymentOrder <Int32>]
[-RunAsynchronously]
[-PROTipID <Guid>]
[-JobVariable <String>]
[<CommonParameters>] 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.
Examples
Example 1: Add a script command to an application profile
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 120The first command gets the application profile object named SvcWebAppProfile01 and 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.
Parameters
-ApplicationDeployment
Specifies an application deployment object.
| Type: | ApplicationDeployment |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ApplicationProfile
Specifies an application profile object.
| Type: | ApplicationProfile |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-CommandParameters
Specifies the parameters for a script or executable program.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DeploymentOrder
Specifies the order in which a computer tier, application host, or application is deployed.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Executable
Specifies the name of an executable program.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-JobGroup
Specifies an identifier for a series of commands that will run as a set just before the final command that includes the same job group identifier runs.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-JobVariable
Specifies that job progress is tracked and stored in the variable named by this parameter.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LibraryResource
Specifies a resource stored in the Virtual Machine Manager (VMM) library.
| Type: | CustomResource |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PhysicalComputerProfile
Specifies a profile that is used to deploy an operating system to a computer.
| Type: | PhysicalComputerProfile |
| Aliases: | VMHostProfile |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-PROTipID
Specifies the ID of the Performance and Resource Optimization tip (PRO tip) that triggered this action. This parameter lets you audit PRO tips.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RunAsAccount
Specifies a Run As account that contains credentials with permission to perform this action.
| Type: | VMMCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RunAsynchronously
Indicates that the job runs asynchronously so that control returns to the command shell immediately.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ScriptCommandSetting
Specifies a script command setting object.
| Type: | SCScriptCommandSetting |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ScriptType
Specifies a script type. The acceptable values for this parameter are:
- PreInstall
- PostInstall
- SaveState
- RestoreState
- PreService
- PostService
- PreUninstall
- PostUninstall
- OrderedCommand
- BareMetalPostWinPERegistration
- OnProvisionFirst
- OnProvisionRest
- OnDeleteLast
- OnDeleteRest
- Install
- BareMetalPostDeployment
| Type: | ScriptCommandType |
| Accepted values: | PreService, PostService, SaveState, RestoreState, PreInstall, PostInstall, PreUninstall, PostUninstall, OrderedCommand, BareMetalPostWinPERegistration, OnProvisionFirst, OnProvisionRest, OnDeleteLast, OnDeleteRest, Install, BareMetalPostConfiguration, BareMetalPostUnattend |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-StandardInput
Specifies a path to a file that contains standard input information to use with the script command.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TimeoutSeconds
Specifies the amount of time, in seconds, that a process waits before timing out.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-VMMServer
Specifies a Virtual Machine Manager (VMM) server object.
| Type: | ServerConnection |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Outputs
ScriptCommand
This cmdlet returns a ScriptCommand object.