Skip to main content

Get-SchedulerTask

SYNOPSISโ€‹

Retrieve all details for scheduled tasks on the local computer.

SYNTAXโ€‹

Get-SchedulerTask [[-TaskName] <String>] [[-ContinueOnError] <Boolean>] [<CommonParameters>]

DESCRIPTIONโ€‹

Retrieve all details for scheduled tasks on the local computer using schtasks.exe. All property names have spaces and colons removed.

EXAMPLESโ€‹

EXAMPLE 1โ€‹

Get-SchedulerTask

To display a list of all scheduled task properties.

EXAMPLE 2โ€‹

Get-SchedulerTask | Out-GridView

To display a grid view of all scheduled task properties.

EXAMPLE 3โ€‹

Get-SchedulerTask | Select-Object -Property TaskName

To display a list of all scheduled task names.

PARAMETERSโ€‹

-TaskNameโ€‹

Specify the name of the scheduled task to retrieve details for. Uses regex match to find scheduled task.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ContinueOnErrorโ€‹

Continue if an error is encountered. Default: $true.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: True
Accept pipeline input: False
Accept wildcard characters: False

CommonParametersโ€‹

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

INPUTSโ€‹

Noneโ€‹

You cannot pipe objects to this function.โ€‹

OUTPUTSโ€‹

PSOjbect. This function returns a PSObject with all scheduled task properties.โ€‹

NOTESโ€‹

This function has an alias: Get-ScheduledTask if Get-ScheduledTask is not defined

https://psappdeploytoolkit.com