Get-ScheduledTask

Gets the scheduled tasks for the current computer.

Syntax

Get-ScheduledTask [[-Name] <String>] [<CommonParameters>]

Description

The Get-ScheduledTask function gets the scheduled tasks on the current computer. It returns Carbon.TaskScheduler.TaskInfo objects for each one.

With no parameters, Get-ScheduledTask returns all scheduled tasks. To get a specific scheduled task, use the Name parameter, which must be the full name of the task, i.e. path plus name. The name parameter accepts wildcards. If a scheduled task with the given name isn't found, an error is written.

This function has the same name as the built-in Get-ScheduledTask function that comes on Windows 2012/8 and later. It returns objects with the same properties, but if you want to use the built-in function, use the ScheduledTasks qualifier, e.g. ScheduledTasks\Get-ScheduledTask.

Related Commands

Parameters

Name Type Description Required? Pipeline Input Default Value
Name String

The name of the scheduled task to return. Wildcards supported. This must be the full task name, i.e. the task's path/location and its name.

false false

Return Values

Carbon.TaskScheduler.TaskInfo.

EXAMPLE 1

Get-ScheduledTask

Demonstrates how to get all scheduled tasks.

EXAMPLE 2

Get-ScheduledTask -Name 'AutoUpdateMyApp'

Demonstrates how to get a specific task.

EXAMPLE 3

Get-ScheduledTask -Name '*Microsoft*'

Demonstrates how to get all tasks that match a wildcard pattern.

EXAMPLE 4

ScheduledTasks\Get-ScheduledTask

Demonstrates how to call the Get-ScheduledTask function in the ScheduledTasks module which ships on Windows 2012/8 and later.