Export (0) Print
Expand All

Get-ScheduledTaskInfo

Updated: October 30, 2012

Applies To: Windows Server 2012

Get-ScheduledTaskInfo

Gets run-time information for a scheduled task.

Syntax

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

Parameter Set: Object
Get-ScheduledTaskInfo [-InputObject] <CimInstance> [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]




Detailed Description

The Get-ScheduledTaskInfo cmdlet gets the last run-time information for a scheduled task. You can use the TaskName parameter to specify a scheduled task, or you can use the InputObject parameter to specify the scheduled task.

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

-InputObject<CimInstance>

Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-TaskName<String>

Specifies a name of a scheduled task.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-TaskPath<String>

Specifies a path for a scheduled task in Task Scheduler namespace.

The root folder in the file path is described as \. If you do not specify a file path, the cmdlet uses the root folder.


Aliases

none

Required?

false

Position?

2

Default Value

none

Accept Pipeline Input?

false

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_TaskDynamicInfo

Examples

Example 1: Get run-time information by using a task name

This command gets run-time information for the scheduled task that is names \Sample\SchedTask01.


PS C:\> Get-ScheduledTaskInfo -TaskName "\Sample\SchedTask01"

Example 2: Get run-time information by using an input object

In this example, the Get-ScheduledTask cmdlet gets all the scheduled tasks in the path \Sample\, and pipes the results to the Get-ScheduledTaskInfo cmdlet.

In the second part of the command, the Get-ScheduledTaskInfo cmdlet gets the run-time information for all the scheduled tasks in the path \Sample\.


PS C:\> Get-ScheduledTask -TaskPath "\Sample\" | Get-ScheduledTaskInfo

Related topics

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