Set-ScheduledTask

  • Reference
Module:
ScheduledTasks

Modifies a scheduled task.

Syntax

Set-ScheduledTask
   [[-Password] <String>]
   [[-User] <String>]
   [[-Action] <CimInstance[]>]
   [[-TaskPath] <String>]
   [[-Settings] <CimInstance>]
   [[-Trigger] <CimInstance[]>]
   [-TaskName] <String>
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]
Set-ScheduledTask
   [-InputObject] <CimInstance>
   [[-Password] <String>]
   [[-User] <String>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]
Set-ScheduledTask
   [[-Principal] <CimInstance>]
   [[-Action] <CimInstance[]>]
   [[-TaskPath] <String>]
   [[-Settings] <CimInstance>]
   [[-Trigger] <CimInstance[]>]
   [-TaskName] <String>
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]

Description

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.

Examples

Example 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.

Example 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 $Act1,$Act2
TaskPath                          TaskName
--------                          --------
\                                 DeployTools

In this example, the set of commands uses cmdlets and variables to modify a scheduled task.

The first command uses the New-ScheduledTaskAction cmdlet to define an action, to which the $Act1 variable is assigned.

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

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

Parameters

-Action

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.

Type:CimInstance[]
Position:2
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-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.

Type:CimSession[]
Aliases:Session
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Specifies the input object that is used in a pipeline command.

Type:CimInstance
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Password

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.

Type:String
Position:6
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Principal

Specifies the security context in which a task is run.

Type:CimInstance
Position:5
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Settings

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

Type:CimInstance
Position:4
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-TaskName

Specifies the name of a scheduled task.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-TaskPath

Specifies an array of one or more paths for scheduled tasks in Task Scheduler namespace. You can use "*" for a wildcard character query. You can use \* for the root folder. To specify a full TaskPath you need to include the leading and trailing \. If you do not specify a path, the cmdlet uses the root folder.

Type:String
Position:1
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ThrottleLimit

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 PowerShell® 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.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Trigger

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. For more information about triggers, see Triggers.

Type:CimInstance[]
Position:3
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-User

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

Type:String
Position:5
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Outputs

CimInstance