< Back

Disable-ScheduledTask

Wed Jan 30, 2019 5:59 pm

NAME Disable-ScheduledTask



SYNOPSIS

Disables a scheduled task.





SYNTAX

Disable-ScheduledTask [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [<CommonParameters>]



Disable-ScheduledTask [-TaskName] <String> [[-TaskPath] <String>] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [<CommonParameters>]





DESCRIPTION

The Disable-ScheduledTask cmdlet disables a scheduled task.





PARAMETERS

-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.



Required? false

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-TaskName <String>

Specifies the name of a scheduled task.



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.



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.



Required? false

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

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

Microsoft.Management.Infrastructure.CimInstance#MSFT_ScheduledTask







Example 1: Disable a scheduled task



PS C:\\> Disable-ScheduledTask -TaskName "SystemScan"

TaskPath TaskName State

-------- -------- --------

\\ SystemScan Disabled



This command disables the SystemScan task in the root folder.





Example 2: Disable all scheduled tasks in a folder



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

TaskPath TaskName State

-------- -------- --------

\\UpdateTasks\\ UpdateApps Disabled

\\UpdateTasks\\ UpdateDrivers Disabled



This command uses the Get-Scheduledtask cmdlet to get all scheduled tasks in the \\UpdateTasks\\ folder. The command pipes this information to the

Disable-ScheduledTasks cmdlet, which disables these scheduled tasks.







RELATED LINKS

Online Version:

Enable-ScheduledTask

Export-ScheduledTask

Get-ScheduledTaskInfo

New-ScheduledTask

Register-ScheduledTask

Set-ScheduledTask

Start-ScheduledTask

Stop-ScheduledTask

Unregister-ScheduledTask