Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Stop-ScheduledTask

Stop-ScheduledTask

ps_scheduledtask_v1.0.cdxml

Synopsis

Stops all running instances of a task.

Syntax

Stop-ScheduledTask [-TaskName] [-TaskPath] [-AsJob] [-CimSession] [-ThrottleLimit] [<CommonParameters>]

Stop-ScheduledTask [-InputObject] [-AsJob] [-CimSession] [-ThrottleLimit] [<CommonParameters>]

Detailed Description

The Stop-ScheduledTask cmdlet immediately stops all running instances of a registered background task. Upon success, the cmdlet returns a registered scheduled task object.

Parameters

-AsJob <SwitchParameter>

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.

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

2

Default value

None

Accept pipeline input?

True (ByValue)

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

Input Type


Return Type


Notes

None

Examples

Example 1: Stop a scheduled task

This command stops all instances of a task named ScanSoftware in the root folder.

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

Example 2: Stop all instances of all tasks in a folder

This command uses the Get-ScheduledTask cmdlet to get all scheduled tasks in the UpdateTasks folder. The command pipes this information to the Stop-ScheduledTasks cmdlet, which stops all running instances of these scheduled tasks.

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

Online Version
Disable-ScheduledTask
Enable-ScheduledTask
Export-ScheduledTask
Get-ScheduledTask
New-ScheduledTask
Register-ScheduledTask
Set-ScheduledTask
Start-ScheduledTask
Unregister-ScheduledTask