Disable-ScheduledTask
Disables a scheduled task.
Syntax
Disable-ScheduledTask
[-TaskName] <String>
[[-TaskPath] <String>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>]
Disable-ScheduledTask
[-InputObject] <CimInstance>
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>]
Description
The Disable-ScheduledTask
cmdlet disables a scheduled task.
Examples
Example 1: Disable a scheduled task
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
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.
Parameters
-AsJob
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
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-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.
Type: | CimSession[] |
Aliases: | Session |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
Specifies the input object that is used in a pipeline command.
Type: | CimInstance |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-TaskName
Specifies the name of a scheduled task.
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-TaskPath
Specifies 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 |
Position: | 1 |
Default value: | None |
Required: | False |
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 |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |