| external help file | Module Name | online version | schema |
|---|---|---|---|
ScheduledTask_Cmdlets.xml |
ScheduledTasks |
2.0.0 |
Starts one or more instances of a scheduled task.
Start-ScheduledTask [-TaskName] <String> [[-TaskPath] <String>] [-AsJob] [-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
Start-ScheduledTask [-InputObject] <CimInstance> [-AsJob] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>]
The Start-ScheduledTask cmdlet starts a registered background task asynchronously.
PS C:\> Start-ScheduledTask -TaskName "ScanSoftware"
This command starts a task named ScanSoftware in the root 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.
ps_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: UNNAMED_PARAMETER_SET_2
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseSpecifies the name of a scheduled task.
Type: String
Parameter Sets: UNNAMED_PARAMETER_SET_1
Aliases:
Required: True
Position: 1
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: UNNAMED_PARAMETER_SET_1
Aliases:
Required: False
Position: 2
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: False