Get-ScheduledTask

  • Reference
Module:
ScheduledTasks

Gets the task definition object of a scheduled task that is registered on the local computer.

Syntax

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

Description

The Get-ScheduledTask cmdlet gets the task definition object of a scheduled task that is registered on a computer.

Examples

Example 1: Get a scheduled task definition object

Get-ScheduledTask -TaskName "SystemScan"

TaskPath                          TaskName                        State
--------                          --------                        --------
\                                 SystemScan                      Ready

This command gets the definition object of the SystemScan scheduled task in the root folder.

Example 2: Get an array of scheduled task definition objects

Get-ScheduledTask -TaskPath "\UpdateTasks\*"

TaskPath                          TaskName                        State
--------                          --------                        --------
\UpdateTasks                      UpdateApps                      Ready
\UpdateTasks                      UpdateDrivers                   Ready
\UpdateTasks                      UpdateOS                        Disabled
\UpdateTasks                      UpdateSignatures                Running

This command gets an array of task definitions objects from the UpdateTasks folder.

Example 3: Get an array of scheduled task definition objects in multiple paths

Get-ScheduledTask -TaskPath "\Microsoft\Windows\Work Folders\","\Microsoft\Windows\Workplace Join\"

TaskPath                                       TaskName                          State
--------                                       --------                          -----
\Microsoft\Windows\Work Folders\               Work Folders Logon Synchroniza... Ready
\Microsoft\Windows\Work Folders\               Work Folders Maintenance Work     Ready
\Microsoft\Windows\Workplace Join\             Automatic-Device-Join             Disabled
\Microsoft\Windows\Workplace Join\             Device-Sync                       Disabled
\Microsoft\Windows\Workplace Join\             Recovery-Check                    Disabled

This command gets task definition objects from multiple task paths

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

-TaskName

Specifies an array of one or more names of a scheduled task. You can use "*" for a wildcard character query.

Type:String[]
Position:0
Default value:None
Required:False
Accept pipeline input:True
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:True
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

Outputs

CimInstance[]