Set-ScheduledTask
Set-ScheduledTask
Modifies a scheduled task.
Syntax
Parameter Set: User
Set-ScheduledTask [-TaskName] <String> [[-TaskPath] <String> ] [[-Action] <CimInstance[]> ] [[-Trigger] <CimInstance[]> ] [[-Settings] <CimInstance> ] [[-User] <String> ] [[-Password] <String> ] [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
Parameter Set: Object
Set-ScheduledTask [-InputObject] <CimInstance> [[-Password] <String> ] [[-User] <String> ] [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
Parameter Set: Principal
Set-ScheduledTask [-TaskName] <String> [[-TaskPath] <String> ] [[-Action] <CimInstance[]> ] [[-Trigger] <CimInstance[]> ] [[-Settings] <CimInstance> ] [[-Principal] <CimInstance> ] [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
Detailed 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.
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.
Aliases |
none |
Required? |
false |
Position? |
3 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-AsJob
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-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.
Aliases |
Session |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-InputObject<CimInstance>
Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-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.
Aliases |
none |
Required? |
false |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Principal<CimInstance>
Specifies the security context in which a task is run.
Aliases |
none |
Required? |
false |
Position? |
6 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Settings<CimInstance>
Specifies a configuration object that the Task Scheduler service uses to determine how to run a task.
Aliases |
none |
Required? |
false |
Position? |
5 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-TaskName<String>
Specifies the name of a scheduled task.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-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.
Aliases |
none |
Required? |
false |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-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 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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-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. For more information about triggers, see Triggers.
Aliases |
none |
Required? |
false |
Position? |
4 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-User<String>
Specifies the name of a <run as> user account to use when you run the task.
Aliases |
none |
Required? |
false |
Position? |
6 |
Default Value |
Current user |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
- Microsoft.Management.Infrastructure.CimInstance#MSFT_ScheduledTask
Examples
Example 1: Modify a trigger in a scheduled task
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.
PS C:\> $Time = New-ScheduledTaskTrigger -At 12:00 -Once
PS C:\> Set-ScheduledTask –TaskName "SoftwareScan" –Trigger $Time
Example 2: Modify settings in a scheduled task definition
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.
PS C:\> $Act1 = New-ScheduledTaskAction -Execute Notepad.exe
PS C:\> $Act2 = New-ScheduledTaskAction -Execute Calc.exe
PS C:\> Set-ScheduledTask "DeployTools" -Action $A1,$A2