Export (0) Print
Expand All

Get-ScheduledTask

Updated: October 30, 2012

Applies To: Windows Server 2012

Get-ScheduledTask

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

Syntax

Parameter Set: ByPath
Get-ScheduledTask [[-TaskName] <String[]> ] [[-TaskPath] <String[]> ] [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]




Detailed Description

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


Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

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


Aliases

Session

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-TaskName<String[]>

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


Aliases

none

Required?

false

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

true

-TaskPath<String[]>

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.


Aliases

none

Required?

false

Position?

2

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

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

Outputs

The output type is the type of the objects that the cmdlet emits.

  • Microsoft.Management.Infrastructure.CimInstance#MSFT_ScheduledTask[]

Examples

Example 1: Get a scheduled task definition object

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


PS C:\> Get-ScheduledTask -TaskName "SystemScan"
TaskPath                          TaskName                        State
-------- -------- --------
\ SystemScan Ready

Example 2: Get an array of scheduled task definition objects

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


PS C:\> Get-ScheduledTask -TaskPath "\UpdateTasks\"
TaskPath                          TaskName                        State
-------- -------- --------
\UpdateTasks UpdateApps Ready
\UpdateTasks UpdateDrivers Ready
\UpdateTasks UpdateOS Disabled

\UpdateTasks UpdateSignatures Running

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft