New-CMTSStepRunPowerShellScript

Creates a t s step run power shell script.

Syntax

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

Description

Note

Configuration Manager cmdlets must be run from the Configuration Manager site drive. The examples in this article use the site name XYZ. For more information, see the getting started documentation.

Examples

Example 1

PS XYZ:\>

Parameters

-Condition
Type:IResultObject[]
Aliases:Conditions
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ContinueOnError
Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Description
Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Disable
Type:SwitchParameter
Aliases:DisableThisStep
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DisableWildcardHandling

DisableWildcardHandling treats wildcard characters as literal character values. Cannot be combined with ForceWildcardHandling.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ExecutionPolicy
Type:ExecutionPolicyType
Aliases:PowerShellExecutionPolicy
Accepted values:AllSigned, Undefined, Bypass
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ForceWildcardHandling

ForceWildcardHandling processes wildcard characters and may lead to unexpected behavior (not recommended). Cannot be combined with DisableWildcardHandling.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Name
Type:String
Aliases:StepName
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-OutputVariableName

Use this parameter to configure the following setting in the Run PowerShell Script task sequence step: Output to task sequence variable. Save the command output to a custom task sequence variable.

Type:String
Aliases:Output, OutputVariable
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PackageId
Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Parameter
Type:String
Aliases:Parameters
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ScriptName
Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-SourceScript

{{ Fill SourceScript Description }}

Type:String
Aliases:SourceCode
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-SuccessCode

{{ Fill SuccessCode Description }}

Type:Int32[]
Aliases:SuccessCodes
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-TimeoutMins

{{ Fill TimeoutMins Description }}

Type:Int32
Aliases:TimeoutInMinutes
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-UserName

{{ Fill UserName Description }}

Type:String
Aliases:User
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-UserPassword

{{ Fill UserPassword Description }}

Type:SecureString
Aliases:Password
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-WorkingDirectory

{{ Fill WorkingDirectory Description }}

Type:String
Aliases:StartIn
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Inputs

None

Outputs

IResultObject