< Back
Get-ScheduledTaskInfo
Post
NAME Get-ScheduledTaskInfo
SYNOPSIS
Gets run-time information for a scheduled task.
SYNTAX
Get-ScheduledTaskInfo [-TaskName] <String> [[-TaskPath] <String>] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [<CommonParameters>]
Get-ScheduledTaskInfo [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [<CommonParameters>]
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
-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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-TaskName <String>
Specifies a name of a scheduled task.
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 the 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.
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.
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, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
Microsoft.Management.Infrastructure.CimInstance#MSFT_TaskDynamicInfo
Example 1: Get run-time information by using a task name
PS C:\\> Get-ScheduledTaskInfo -TaskName "\\Sample\\SchedTask01"
This command gets run-time information for the scheduled task named \\Sample\\SchedTask01.
Example 2: Get run-time information by using an input object
PS C:\\>Get-ScheduledTask -TaskPath "\\Sample\\" | Get-ScheduledTaskInfo
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\\.
RELATED LINKS
Online Version:
Get-ScheduledTaskInfo
New-ScheduledTask
Enable-ScheduledTask
Register-ScheduledTask
Start-ScheduledTask
Set-ScheduledTask
SYNOPSIS
Gets run-time information for a scheduled task.
SYNTAX
Get-ScheduledTaskInfo [-TaskName] <String> [[-TaskPath] <String>] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [<CommonParameters>]
Get-ScheduledTaskInfo [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [<CommonParameters>]
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
-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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-TaskName <String>
Specifies a name of a scheduled task.
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 the 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.
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.
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, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
Microsoft.Management.Infrastructure.CimInstance#MSFT_TaskDynamicInfo
Example 1: Get run-time information by using a task name
PS C:\\> Get-ScheduledTaskInfo -TaskName "\\Sample\\SchedTask01"
This command gets run-time information for the scheduled task named \\Sample\\SchedTask01.
Example 2: Get run-time information by using an input object
PS C:\\>Get-ScheduledTask -TaskPath "\\Sample\\" | Get-ScheduledTaskInfo
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\\.
RELATED LINKS
Online Version:
Get-ScheduledTaskInfo
New-ScheduledTask
Enable-ScheduledTask
Register-ScheduledTask
Start-ScheduledTask
Set-ScheduledTask