Page History
...
Get-JS7TaskHistory [[-Job] <String>] [[-WorkflowPath] <String>] [[-OrderId] <String>] [[-Position] <String>] [[-Folder] <String>] [-Recursive] [[-ExcludeJob] <Hashtable>] [[-RegularExpressionJobName] <String>] [[-DateFrom] <DateTime>] [[-DateTo] <DateTime>] [[-RelativeDateFrom] <String>] [[-RelativeDateTo] <String>] [[-Timezone] <TimeZoneInfo>] [[-TaskId] <Int32>] [[-Limit] <Int32>] [-NormalCriticality] [-MinorCriticality] [-MajorCriticality] [-Successful] [-Failed] [-InProgress] [<CommonParameters>]
...
History information is returned for jobs from a JS7 Controller.
Task executions can be selected by job name, workflow, folder, history status etc.
The history information retured includes start time, end time, return code etc.
The following REST Web Service API resources are used:
* /tasks/history
PARAMETERS
Job
-Job <String>
Optionally specifies the name of a job for which task execution results are reported.
This parameter requires use of the -WorkflowPath parameter to specify the workflow
that includes the job.
...
| Required? | false |
| Position? | 2 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
Folder
-OrderId Folder <String>
Optionally specifies the identifier of an order to limit results to jobs that
have been executed for the given order.
...
Position
-Position <String>
Optionally specifies the position in a workflow to limit results to jobs that
correspond to the given position in a workflow. This parameter requires use of the -OrderId parameter.
...
Folder
-Folder <String>
Optionally specifies the folder that includes workflows for which the task folder that includes workflows for which the task history should be returned.
| Required? | false |
| Position? | 53 |
| Default value | / |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
-ExcludeJob <Hashtable>
This parameter accepts a hashmap of job names and optionally workflow paths that are excluded from the results.
If a workflow path is specified then all jobs of the given workflow are excluded.
| Required? | false |
| Position? | 64 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
JobName
-RegularExpression JobName <String>
Specifies the name of a regular expression that filters the jobs to be returned.
The regular expression is applied to the job name. job that is looked up by use of * and ? wildcard characters:
* : match zero or more characters
? : match any single character
| Required? | false |
| Position? | 75 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
-DateFrom <DateTime>
Specifies the date starting from which history items should be returned.
Consider that a UTC date has to be provided.
Default: Begin Beginning of the current day as a UTC date
| Required? | false |
| Position? | 86 |
| 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? | 97 |
| Default value | (Get-Date -Hour 0 -Minute 0 -Second 0).AddDays(1).ToUniversalTime() |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
-RelativeDateFrom <String>
Specifies a relative date starting from which history items should be returned, e.g.
* -1s, -2s: one second ago, two seconds ago
* -1m, -2m: one minute ago, two minutes ago
* -1h, -2h: one hour ago, two hours ago
* -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
Optionally a time offset can be specified, e.g. -1d+02:00, as otherwise midnight UTC is assumed.
Alternatively a timezone offset can be added, e.g. by using -1d+TZ, that . This is calculated by the cmdlet
for the timezone that is specified with the -Timezone parameter.
This parameter takes precedence over the -DateFrom parameter.
| Required? | false |
| Position? | 108 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
-RelativeDateTo <String>
Specifies a relative date until which history items should be returned, e.g.
* -1s, -2s: one second ago, two seconds ago
* -1m, -2m: one minute ago, two minutes ago
* -1h, -2h: one hour ago, two hours ago
* -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
Optionally a time offset can be specified, e.g. -1d+02:00, as otherwise midnight UTC is assumed.
Alternatively a timezone offset can be added, e.g. by using -1d+TZ, that . This is calculated by the cmdlet
for the timezone that is specified with the -Timezone parameter.
This parameter takes precedence over the -DateFrom parameter.
| Required? | false |
| Position? | 119 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
-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 JS7 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? | 1210 |
| Default value | (Get-Timezone -Id 'UTC') |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
TaskId
-TaskId <Int32>
Specifies to report that the execution history history should only be reported for the given task ID only.
| Required? | false |
| Position? | 1311 |
| Default value | 0 |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
-Limit <Int32>
Specifies the max. number of history items for 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? | 1412 |
| Default value | 0 |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
-NormalCriticality <SwitchParameter>
Specifies to return that the task history should only be returned for jobs only that are assigned a "normal" criticality.
...
-MinorCriticality <SwitchParameter>
Specifies to return that the task history should only be returned for jobs only that are assigned a "minor" criticality.
...
-MajorCriticality <SwitchParameter>
Specifies to return that the task history should only be returned for jobs only that are assigned a "major" criticality.
...
PS > $items = Get-JS7TaskHistory -RegularExpression JobName "sos$*sos*"
Returns today's task execution history for any all jobs with a job name that ends with includes "sos".
-------------------------- EXAMPLE 3 --------------------------
...
Returns today's task execution history for any all jobs with dates being converted to the local timezone.
...
Returns today's task execution history for any all jobs with dates being converted to the GMT timezone.
...
Returns today's task execution history for any all jobs excluding the specified workflow paths and job names.
...
Returns the task execution history for any all failed jobs for the last seven days.
...
Returns the task execution history for any all jobs for the last seven days. The history is reported starting from midnight in the same timezone that is used with the -Timezone parameter.
...
Returns today's task execution history for any all completed tasks from the "/sos" directory folder and any sub-folders recursively.
Overview
Content Tools