...
Get-JobSchedulerTaskHistory [[-Job] <String>] [[-JobChain] <String>] [[-OrderId] <String>] [[-Directory] <String>] [-Recursive] [[-State] <String>] [[-ExcludeJob] <String[]>] [[-RegEx] <String>] [[-DateFrom] <DateTime>] [[-DateTo] <DateTime>] [[-RelativeDateFrom] <String>] [[-RelativeDateTo] <String>] [[-Timezone] <TimeZoneInfo>] [[-Limit] <Int32>] [-Successful] [-Failed] [-Incomplete] [<CommonParameters>]
...
| Required? | false |
| Position? | 5 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
ExcludeJob
-ExcludeJob <String[]>
This parameter accepts a single job path or an array of job paths that are excluded from the results.
| Required? | false |
| Position? | 6 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
RegEx
-RegEx <String>
Specifies a regular expression that filters the job paths to be returned.
| Required? | false |
| Position? | 7 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
DateFrom
-DateFrom <DateTime>
Specifies the date starting from which history items should be returned.
Consider that a UTC date has to be provided.
Default: Begin of the current day as a UTC date
| Required? | false |
| Position? | 68 |
| Default value | (Get-Date -Hour 0 -Minute 0 -Second 0).ToUniversalTime() |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
-DateTo <DateTime>
Specifies the date until which history items should be returned.
Consider that a UTC date has to be provided.
Default: End of the current day as a UTC date
| Required? | false |
| Position? | 79 |
| Default value | (Get-Date -Hour 0 -Minute 0 -Second 0).AddDays(1).ToUniversalTime() |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
RelativeDateFrom
-RelativeDateFrom <String>
Specifies a relative date starting from which history items should be returned, e.g.
* -1d, -2d: one day ago, two days ago
* -1w, -2w: one week ago, two weeks ago
* -1M, -2M: one month ago, two months ago
* -1y, -2y: one year ago, two years ago
This parameter takes precedence over the -DateFrom parameter.
| Required? | false |
| Position? | 10 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
RelativeDateTo
-RelativeDateTo <String>
Specifies a relative date until which history items should be returned, e.g.
* -1d, -2d: one day ago, two days ago
* -1w, -2w: one week ago, two weeks ago
* -1M, -2M: one month ago, two months ago
* -1y, -2y: one year ago, two years ago
This parameter takes precedence over the -DateTo parameter.
| Required? | false |
| Position? | 11 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Timezone
-Timezone <TimeZoneInfo>
Specifies the timezone to which dates should be converted in the history information.
A timezone can e.g. be specified like this:
Get-JSTaskHistory -Timezone (Get-Timezone -Id 'GMT Standard Time')
All dates in JobScheduler are UTC and can be converted e.g. to the local time zone like this:
Get-JSTaskHistory -Timezone (Get-Timezone)
Default: Dates are returned in UTC.
| Required? | false |
| Position? | 812 |
| Default value | (Get-Timezone -Id 'UTC') |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
-Limit <Int32>
Specifies the max. number of history items of task executions to be returned.
The default value is 10000, for an unlimited number of items the value -1 can be specified.
| Required? | false |
| Position? | 913 |
| Default value | 0 |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
PS > $items = Get-JobSchedulerTaskHistory -RegEx '^/sos'
Returns today's task execution history for any jobs from the /sos folder.
-------------------------- EXAMPLE 3 --------------------------
PS > $items = Get-JobSchedulerTaskHistory -RegEx 'report'
Returns today's task execution history for jobs that contain the string 'report' in the job path.
-------------------------- EXAMPLE 4 --------------------------
PS > $items = Get-JobSchedulerTaskHistory -Timezone (Get-Timezone)
Returns today's task execution history for any jobs with dates being converted to the local timezone.
-------------------------- EXAMPLE 3 5 --------------------------
...
-------------------------- EXAMPLE 4 6 --------------------------
...
-------------------------- EXAMPLE 5 7 --------------------------
...
Returns today's task execution history for jobs in the given job chain.
-------------------------- EXAMPLE 8 --------------------------
PS > $items = Get-JobSchedulerTaskHistory -ExcludeJob /sos/dailyplan/CreateDailyPlan, /sos/housekeeping/scheduler_rotate_log
Returns today's task execution history for any jobs excluding the specified job paths.
-------------------------- EXAMPLE 9 --------------------------
PS > $items = Get-JobSchedulerTaskHistory -Successful -DateFrom "2020-08-11 14:00:00Z"
Returns the task execution history for successfully completed jobs that started after the specified UTC date and time.
-------------------------- EXAMPLE 6 10 --------------------------
...
Returns the task execution history for any failed jobs for the last seven days.
-------------------------- EXAMPLE 11 --------------------------
PS > $items = Get-JobSchedulerTaskHistory -RelativeDateFrom -7d
Returns the task execution history for any jobs for the last seven days.
-------------------------- EXAMPLE 12 --------------------------
PS > $items = Get-JobSchedulerTaskHistory -RelativeDateFrom -1w
Returns the task execution history for any jobs during last week.
-------------------------- EXAMPLE 7 13 --------------------------
...