| external help file | Module Name | ms.date | online version | schema | title |
|---|---|---|---|---|---|
PS_ScheduledTask_v1.0.cdxml-help.xml |
ScheduledTasks |
10/29/2017 |
2.0.0 |
Set-ScheduledTask |
Modifies a scheduled task.
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>]
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.
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.
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 $A2 variable is assigned.
The third command adds the two actions to the scheduled task DeployTools.
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[]
Parameter Sets: User, Principal
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: Falseps_cimcommon_asjob
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseRuns 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-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. The default is the current session on the local computer.
Type: CimSession[]
Parameter Sets: (All)
Aliases: Session
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.
Type: CimInstance
Parameter Sets: Object
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseSpecifies 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
Parameter Sets: User, Object
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the security context in which a task is run.
Type: CimInstance
Parameter Sets: Principal
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies a configuration object that the Task Scheduler service uses to determine how to run a task.
Type: CimInstance
Parameter Sets: User, Principal
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the name of a scheduled task.
Type: String
Parameter Sets: User, Principal
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies 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
Parameter Sets: User, Principal
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies 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
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies 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 Triggershttp://technet.microsoft.com/en-us/library/cc748841.aspx.
Type: CimInstance[]
Parameter Sets: User, Principal
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the name of a <run as> user account to use when you run the task.
Type: String
Parameter Sets: User, Object
Aliases:
Required: False
Position: 5
Default value: Current user
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).