PDQ.com mobilePDQ.com desktop
Support

Set-ScheduledTask

Modifies a scheduled task.
Set-ScheduledTask [-TaskName*] <String> [[-TaskPath] <String>] [[-Action] <CimInstance[]>] [[-Trigger]<CimInstance[]>] [[-Settings] <CimInstance>] [[-User] <String>] [[-Password] <String>] [-CimSession<CimSession[]>] [-ThrottleLimit <Int32>] [<CommonParameters>]
Set-ScheduledTask [-TaskName*] <String> [[-TaskPath] <String>] [[-Action] <CimInstance[]>] [[-Trigger]<CimInstance[]>] [[-Settings] <CimInstance>] [[-Principal] <CimInstance>] [-CimSession <CimSession[]>][-ThrottleLimit <Int32>] [<CommonParameters>]
Set-ScheduledTask [[-Password] <String>] [[-User] <String>] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>][<CommonParameters>]

The Set-ScheduledTask cmdlet modifies a task definition.

You can make changes to a task definition even if an instance of the task is running. The changes do not affect the current instance.

Parameters

-Action [<CimInstance[]>]

Specifies an array of work items to be performed by the task. If you specify several actions, the computer runs them in order. You can specify up to 32 actions.

-CimSession [<CimSession[]>]

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

-Password [<String>]

Specifies a password for the <run as> user. The password is ignored for the well-known system accounts.

Well-known accounts are: NT AUTHORITY\SYSTEM, NT AUTHORITY\LOCALSERVICE, NT AUTHORITY\NETWORKSERVICE, and the well-known security identifiers (SIDs) for all three accounts.

-Principal [<CimInstance>]

Specifies the security context in which a task is run.

-Settings [<CimInstance>]

Specifies a configuration object that the Task Scheduler service uses to determine how to run a task.

-TaskName <String>

  • This value is required

Specifies the name of a scheduled task.

-TaskPath [<String>]

Specifies the path for a scheduled task in Task Scheduler namespace. You can use \ for the root folder. If you do not specify a path, the cmdlet uses the root folder.

-ThrottleLimit [<Int32>]

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShellr calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.

-Trigger [<CimInstance[]>]

Specifies an array of one or more trigger objects that cause a scheduled task to start.

A trigger is a set of criteria that, when met, starts a scheduled task. You can use a time-based trigger or an event-based trigger to start a task and a task can be started by one or more triggers. A task can have up to 48 triggers.

-User [<String>]

Specifies the name of a <run as> user account to use when you run the task.

<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,ErrorAction, ErrorVariable, WarningAction, WarningVariable,OutBuffer, PipelineVariable, and OutVariable.

Outputs
Microsoft.Management.Infrastructure.CimInstance#MSFT_ScheduledTask
Examples
  1. Modify a trigger in a scheduled task:
    PS C:\>  $Time = New-ScheduledTaskTrigger -At 12:00 -Once
    PS C:\>  Set-ScheduledTask -TaskName "SoftwareScan" -Trigger $Time
    
       TaskPath                          TaskName 
       --------                          -------- 
       \                                 SoftwareScan
       In this example, the first command uses the New-ScheduledTaskTrigger cmdlet to define a time trigger, to which the 
       $Time variable is assigned.

    The second command adds (or replaces) the $Time trigger in the scheduled task SoftwareScan.

  2. Modify settings in a scheduled task definition:
    PS C:\>  $Act1 = New-ScheduledTaskAction -Execute "Notepad.exe"
    PS C:\>  $Act2 = New-ScheduledTaskAction -Execute "Calc.exe"
    PS C:\>  Set-ScheduledTask "DeployTools" -Action $A1,$A2
    
       TaskPath                          TaskName 
       --------                          -------- 
       \                                 DeployTools
       In this example, the set of commands uses cmdlets and variables to modify a scheduled task.
       In this example, the first command uses the New-ScheduledTaskAction cmdlet to define an action, to which the $A1 
       variable is assigned.

    The second command uses the New-ScheduledTaskAction cmdlet to define a second action, to which the the $A2 variable is assigned.

    The third command adds the two actions to the scheduled task DeployTools.

Back to PowerShell Command list