PowerShell Commands

Get-ScheduledTask

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

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

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.

-TaskName [<String[]>]

  • Accepts pipeline input ByPropertyName

Specifies an array of one or more names of a scheduled task.

-TaskPath [<String[]>]

  • Accepts pipeline input ByPropertyName

Specifies an array of one or more paths for scheduled tasks in Task Scheduler namespace. You can use \ for the root folder. If you do not specify a path, the cmdlet uses the root folder.

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

<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,ErrorAction, ErrorVariable, WarningAction, WarningVariable,OutBuffer, PipelineVariable, and OutVariable.

Outputs
Microsoft.Management.Infrastructure.CimInstance#MSFT_ScheduledTask[]
Examples
  1. Get a scheduled task definition object:
    PS C:\>  Get-ScheduledTask -TaskName "SystemScan"
    
       TaskPath                          TaskName                        State
       --------                          --------                        --------
       \                                 SystemScan                      Ready

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

  2. Get an array of scheduled task definition objects:
    PS C:\>  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.

This work is licensed under a Creative Commons Attribution 4.0 International. It is attributed to Microsoft Corporation and can be found here.

PowerShell Commands