Windows PowerShell command on Get-command Stop-ScheduledTask
MyWebUniversity

Windows PowerShell command on Get-command Stop-ScheduledTask

NAME

Stop-ScheduledTask

SYNOPSIS

Stops all running instances of a task.

SYNTAX

Stop-ScheduledTask [-TaskName] [[-TaskPath] ] [-CimSession ] [-ThrottleLimit

] []

Stop-ScheduledTask [-CimSession ] [-ThrottleLimit ] []

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

-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. Required? false Position? named Default value none Accept pipeline input? false Accept wildcard characters? false

-TaskName

Specifies the name of a scheduled task. Required? true Position? 1 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. Required? false Position? 2 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 PowerShellr 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. Required? false Position? named Default value none Accept pipeline input? false Accept wildcard characters? false This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS

Example 1: Stop a scheduled task

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

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

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

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

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.

RELATED LINKS

Online Version:

Disable-ScheduledTask

Enable-ScheduledTask

Export-ScheduledTask

Get-ScheduledTask

New-ScheduledTask

Register-ScheduledTask

Set-ScheduledTask

Start-ScheduledTask

Unregister-ScheduledTask



Contact us      |      About us      |      Term of use      |       Copyright © 2000-2019 OurUNIX.com ™