New-CMTSStepRunPowerShellScript

Syntax

ByName (Default)

New-CMTSStepRunPowerShellScript
 -Name <String>
 [-SuccessCode <Int32[]>]
 [-Condition <IResultObject[]>]
 [-ContinueOnError]
 [-Description <String>]
 [-Disable]
 [-DisableWildcardHandling]
 [-ForceWildcardHandling]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

RunScriptFromSource

New-CMTSStepRunPowerShellScript
 -Name <String>
 -SourceScript <String>
 [-ExecutionPolicy <ExecutionPolicyType>]
 [-OutputVariableName <String>]
 [-Parameter <String>]
 [-SuccessCode <Int32[]>]
 [-TimeoutMins <Int32>]
 [-UserName <String>]
 [-UserPassword <SecureString>]
 [-WorkingDirectory <String>]
 [-Condition <IResultObject[]>]
 [-ContinueOnError]
 [-Description <String>]
 [-Disable]
 [-DisableWildcardHandling]
 [-ForceWildcardHandling]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

RunScriptFromPackage

New-CMTSStepRunPowerShellScript
 -Name <String>
 -PackageId <String>
 -ScriptName <String>
 [-ExecutionPolicy <ExecutionPolicyType>]
 [-OutputVariableName <String>]
 [-Parameter <String>]
 [-SuccessCode <Int32[]>]
 [-TimeoutMins <Int32>]
 [-UserName <String>]
 [-UserPassword <SecureString>]
 [-WorkingDirectory <String>]
 [-Condition <IResultObject[]>]
 [-ContinueOnError]
 [-Description <String>]
 [-Disable]
 [-DisableWildcardHandling]
 [-ForceWildcardHandling]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

Description

Examples

Example 1

$step = New-CMTSStepRunPowerShellScript -Name "Run PowerShell Script" -PackageId "XYZ00821" -ScriptName "Add-ContosoBranding.ps1" -ExecutionPolicy AllSigned

$tsNameOsd = "Default OS deployment"
$tsOsd = Get-CMTaskSequence -Name $tsNameOsd -Fast

$tsOsd | Add-CMTaskSequenceStep -Step $step -InsertStepStartIndex 11

Parameters

-Condition

Specify a condition object to use with this step. To get this object, use one of the task sequence condition cmdlets. For example, Get-CMTSStepConditionVariable.

Parameter properties

Parameter sets

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Parameter sets

-ContinueOnError

Add this parameter to enable the step option Continue on error. When you enable this option, if the step fails, the task sequence continues.

Parameter properties

Parameter sets

-Description

Specify an optional description for this task sequence step.

Parameter properties

Parameter sets

-Disable

Add this parameter to disable this task sequence step.

Parameter properties

Parameter sets

-DisableWildcardHandling

This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.

Parameter properties

Parameter sets

-ExecutionPolicy

Specify the PowerShell execution policy for the scripts you allow to run on the computer. Choose one of the following policies:

• AllSigned: Only run scripts signed by a trusted publisher.

• Undefined: Don't define any execution policy.

• Bypass: Load all configuration files and run all scripts. If you download an unsigned script from the internet, PowerShell doesn't prompt for permission before running the script.

Parameter properties

Parameter sets

-ForceWildcardHandling

This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.

Parameter properties

Parameter sets

-Name

Specify a name for this step to identify it in the task sequence.

Parameter properties

Parameter sets

-OutputVariableName

Specify the name of a custom task sequence variable. When you use this parameter, the step saves the last 1000 characters of the command output to the variable.

Parameter properties

Parameter sets

-PackageId

Specify the package ID for the package that has the PowerShell script. The package doesn't require a program. One package can contain multiple scripts.

This value is a standard package ID, for example XYZ00821.

Then use the ScriptName parameter to specify the name of the script.

Parameter properties

Parameter sets

-Parameter

Specify the parameters passed to the PowerShell script. These parameters are the same as the PowerShell script parameters on the command line. Provide parameters consumed by the script, not for the PowerShell command line.

The following example contains valid parameters:

-MyParameter1 MyValue1 -MyParameter2 MyValue2

The following example contains invalid parameters. The first two items are PowerShell command-line parameters (NoLogo and ExecutionPolicy). The script doesn't consume these parameters.

-NoLogo -ExecutionPolicy Unrestricted -File MyScript.ps1 -MyParameter1 MyValue1 -MyParameter2 MyValue2

If a parameter value includes a special character or a space, use single quotation marks (') around the value. Using double quotation marks (") may cause the task sequence step to incorrectly process the parameter.

For example: -Arg1 '%TSVar1%' -Arg2 '%TSVar2%'

You can also set this parameter to a task sequence variable. For example, if you specify %MyScriptVariable%, when the task sequence runs the script, it adds the value of this custom variable to the PowerShell command line.

Parameter properties

Parameter sets

-ScriptName

Specify the name of the script to run. This script is in the package specified by the PackageId parameter.

Parameter properties

Parameter sets

-SourceScript

Instead of using the PackageId and ScriptName parameters, use this parameter to directly specify the script commands. This string value is the PowerShell commands that this step runs.

You can read the contents of an existing script file into a string variable, and then use that variable for this parameter. For example:

$script = [IO.File]::ReadAllText( "C:\temp\script.ps1" )

Parameter properties

Parameter sets

-SuccessCode

Specify an array of integer values as exit codes from the script that the step should evaluate as success.

Parameter properties

Parameter sets

-TimeoutMins

Specify an integer value that represents how long Configuration Manager allows the script to run. This value can be from 1 minute to 999 minutes. The default value is 15 minutes.

If you enter a value that doesn't allow enough time for the specified script to complete successfully, this step fails. The entire task sequence could fail depending on step or group conditions. If the timeout expires, Configuration Manager terminates the PowerShell process.

Parameter properties

Parameter sets

-UserName

Use this parameter to run the script as a Windows user account and not the local system account. Specify the name of the Windows user account. To specify the account password, use the UserPassword parameter.

Parameter properties

Parameter sets

-UserPassword

Use this parameter to specify the password of the account that you specify with UserName.

Parameter properties

Parameter sets

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet doesn't run.

Parameter properties

Parameter sets

-WorkingDirectory

Specify the folder in which the command starts. This path can be up to 127 characters.

Parameter properties

Parameter sets

CommonParameters

Inputs

None

Outputs

IResultObject

Notes

Related Links

• Get-CMTSStepRunPowerShellScript
• Remove-CMTSStepRunPowerShellScript
• Set-CMTSStepRunPowerShellScript
• About task sequence steps: Run PowerShell Script