Edit

Share via

Disable-ScheduledTask

Module:
ScheduledTasks Module

Disables a scheduled task.

Syntax

Name 

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

Object 

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.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:

CimSession[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:Session

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

Specifies the input object that is used in a pipeline command.

Parameter properties

Type:CimInstance
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Object
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-TaskName

Specifies the name of a scheduled task.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Name
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Name
Position:1
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Outputs

CimInstance