Table of contents
TLS
TOC
Collapse the table of content
Expand the table of content

Get-ScheduledTask

Last Updated: 4/3/2017

SYNOPSIS

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

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.

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

PARAMETERS

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
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[]
Parameter Sets: (All)
Aliases: Session

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

-TaskName

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

Type: String[]
Parameter Sets: (All)
Aliases: 

Required: False
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-TaskPath

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.

Type: String[]
Parameter Sets: (All)
Aliases: 

Required: False
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
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
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
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

OUTPUTS

Microsoft.Management.Infrastructure.CimInstance#MSFT_ScheduledTask[]

NOTES

Disable-ScheduledTask

Enable-ScheduledTask

Export-ScheduledTask

New-ScheduledTask

Register-ScheduledTask

Set-ScheduledTask

Start-ScheduledTask

Stop-ScheduledTask

Unregister-ScheduledTask

© 2017 Microsoft