Start-ScheduledTask

Starts one or more instances of a scheduled task.

Syntax

Start-ScheduledTask
     [[-TaskPath] <String>]
     [-TaskName] <String>
     [-CimSession <CimSession[]>]
     [-ThrottleLimit <Int32>]
     [-AsJob]
     [<CommonParameters>]
Start-ScheduledTask
     [-InputObject] <CimInstance>
     [-CimSession <CimSession[]>]
     [-ThrottleLimit <Int32>]
     [-AsJob]
     [<CommonParameters>]

Description

The Start-ScheduledTask cmdlet starts a registered background task asynchronously.

Examples

Example 1: Start a registered scheduled task

PS C:\> Start-ScheduledTask -TaskName "ScanSoftware"

This command starts a task named ScanSoftware in the root folder.

Example 2: Start all tasks in a folder

PS C:\>Get-ScheduledTask -TaskPath "\UpdateTasks\UpdateVirus\" | Start-ScheduledTask

This command uses the Get-ScheduledTask cmdlet to get the full task path for the UpdateVirus folder and pipes that value to Start-ScheduledTask, which starts all tasks in the UpdateVirus folder.

Required Parameters

-InputObject

Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.

Type:CimInstance
Position:1
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-TaskName

Specifies the name of a scheduled task.

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

Optional Parameters

-AsJob

ps_cimcommon_asjob

Type:SwitchParameter
Position:Named
Default value:None
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-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[]
Aliases:Session
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-TaskPath

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.

Type:String
Position:1
Default value:None
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
Accept pipeline input:False
Accept wildcard characters:False